# Rename Favorite Renames an existing custom favorite and/or replaces its filters (favorite.filters). Endpoint: PUT /api/v3/favorites/{uid} Version: 3.1.0 Security: apiKeyAuth ## Query parameters: - `api_key` (string, required) Your API Key. Example: "YOUR_API_KEY" ## Path parameters: - `uid` (string, required) Favorite uid ## Request fields (application/json): - `tab` (string, required) Example: "Invoices" - `favorite` (object, required) - `favorite.name` (string) New name. Kept when absent or blank. Example: "new favorite" - `favorite.filters` (object) When present (not blank), replaces the stored filters entirely. - `favorite.filters.page` (integer) Example: 1 - `favorite.filters.itemsPerPage` (string) Example: "10" - `favorite.filters.showTotalWithIVA` (boolean) - `favorite.filters.text` (string) - `favorite.filters.type` (object) - `favorite.filters.type.invoice` (boolean) Example: true - `favorite.filters.type.invoiceReceipt` (boolean) Example: true - `favorite.filters.type.simplifiedInvoice` (boolean) Example: true - `favorite.filters.type.cashInvoice` (boolean) Example: true - `favorite.filters.type.debitNote` (boolean) Example: true - `favorite.filters.type.vatMossInvoice` (boolean) Example: true - `favorite.filters.type.creditNote` (boolean) Example: true - `favorite.filters.type.vatMossCreditNote` (boolean) Example: true - `favorite.filters.type.receipt` (boolean) Example: true - `favorite.filters.type.vatMossReceipt` (boolean) Example: true - `favorite.filters.status` (object) - `favorite.filters.status.draft` (boolean) Example: true - `favorite.filters.status.sent` (boolean) Example: true - `favorite.filters.status.settled` (boolean) Example: true - `favorite.filters.status.canceled` (boolean) Example: true - `favorite.filters.status.second_copy` (boolean) Example: true - `favorite.filters.archived` (boolean) - `favorite.filters.nonArchived` (boolean) Example: true - `favorite.filters.documentTotalRange` (object) - `favorite.filters.documentTotalRange.from` (string,null) - `favorite.filters.documentTotalRange.to` (string,null) - `favorite.filters.sort` (string) Example: "document_date" - `favorite.filters.sortOrder` (string) Example: "desc" - `favorite.filters.series` (array) Example: [] - `favorite.filters.plugins` (array) Example: [] - `favorite.filters.clientList` (array) Example: [] - `favorite.filters.batchId` (string) - `favorite.filters.registration` (object) - `favorite.filters.registration.registered` (boolean) Example: true - `favorite.filters.registration.notRegistered` (boolean) Example: true - `favorite.filters.registration.partiallyRegistered` (boolean) Example: true - `favorite.filters.issueDate` (object) - `favorite.filters.issueDateLabel` (string) - `favorite.filters.dueDate` (object) - `favorite.filters.dueDateLabel` (string) ## Response 200 fields (application/json): - `favorite` (object) - `favorite.filters` (object) Opaque client-side state. The API stores the object as sent and returns it unchanged; it does not validate or interpret any key. The keys below are the ones the web app uses. - `favorite.filters.page` (integer) Example: 1 - `favorite.filters.itemsPerPage` (string) Example: "10" - `favorite.filters.showTotalWithIVA` (boolean) - `favorite.filters.text` (string) - `favorite.filters.type` (object) - `favorite.filters.type.invoice` (boolean) Example: true - `favorite.filters.type.invoiceReceipt` (boolean) Example: true - `favorite.filters.type.simplifiedInvoice` (boolean) Example: true - `favorite.filters.type.cashInvoice` (boolean) Example: true - `favorite.filters.type.debitNote` (boolean) Example: true - `favorite.filters.type.vatMossInvoice` (boolean) Example: true - `favorite.filters.type.creditNote` (boolean) Example: true - `favorite.filters.type.vatMossCreditNote` (boolean) Example: true - `favorite.filters.type.receipt` (boolean) Example: true - `favorite.filters.type.vatMossReceipt` (boolean) Example: true - `favorite.filters.status` (object) - `favorite.filters.status.draft` (boolean) Example: true - `favorite.filters.status.sent` (boolean) Example: true - `favorite.filters.status.settled` (boolean) Example: true - `favorite.filters.status.canceled` (boolean) Example: true - `favorite.filters.status.second_copy` (boolean) Example: true - `favorite.filters.archived` (boolean) - `favorite.filters.nonArchived` (boolean) Example: true - `favorite.filters.documentTotalRange` (object) - `favorite.filters.documentTotalRange.from` (string,null) - `favorite.filters.documentTotalRange.to` (string,null) - `favorite.filters.sort` (string) Example: "document_date" - `favorite.filters.sortOrder` (string) Example: "desc" - `favorite.filters.series` (array) Example: [] - `favorite.filters.plugins` (array) Example: [] - `favorite.filters.clientList` (array) Example: [] - `favorite.filters.batchId` (string) - `favorite.filters.registration` (object) - `favorite.filters.registration.registered` (boolean) Example: true - `favorite.filters.registration.notRegistered` (boolean) Example: true - `favorite.filters.registration.partiallyRegistered` (boolean) Example: true - `favorite.filters.issueDate` (object) - `favorite.filters.issueDateLabel` (string) - `favorite.filters.dueDate` (object) - `favorite.filters.dueDateLabel` (string) - `favorite.name` (string) Example: "new favorite" - `favorite.uid` (string) Example: "72b0b781-f7f3-40fb-ae44-3762611fc0a8" - `favorite.AccountID_UserID_Tab` (string) Internal composite key: account ID, user ID, and tab, joined by :: Example: "148306::147436::Invoices" ## Response 401 fields (application/json): - `errors` (array) Example: [{"error":"Authentication Error"}] - `errors.error` (string) ## Response 404 fields (application/json): - `errors` (array) Example: [{"error":"An unexpected error occurred"}] - `errors.error` (string) ## Response 422 fields (application/json): - `errors` (array) Example: [{"error":"An unexpected error occurred"}] - `errors.error` (string) ## Response 500 fields (application/json): - `errors` (array) Example: [{"error":"An unexpected error occurred"}] - `errors.error` (string)