ConstCategorizes a customer invoice.
This endpoint is not applicable for draft invoices.
Possible errors:
CategorizeCustomerInvoiceBadRequest (400): Missing or invalid request parametersCategorizeCustomerInvoiceUnauthorized (401): Invalid or missing API keyCategorizeCustomerInvoiceForbidden (403): Insufficient permissions for this operationCategorizeCustomerInvoiceNotFound (404): Invoice not foundCategorizeCustomerInvoiceUnprocessableEntity (422): Request rejected by business validationCreates a draft or finalized customer invoice (or credit note).
Possible errors:
CreateCustomerInvoiceBadRequest (400): Missing or invalid request bodyCreateCustomerInvoiceUnauthorized (401): Invalid or missing API keyCreateCustomerInvoiceForbidden (403): Insufficient permissions for this operationCreateCustomerInvoiceNotFound (404): Related resource not foundCreateCustomerInvoiceUnprocessableEntity (422): Request rejected by business validationCreates a customer invoice from an existing quote.
The invoice will inherit the quote's data (customer, lines, etc.).
Possible errors:
CreateCustomerInvoiceFromQuoteBadRequest (400): Missing or invalid request parametersCreateCustomerInvoiceFromQuoteUnauthorized (401): Invalid or missing API keyCreateCustomerInvoiceFromQuoteForbidden (403): Insufficient permissions for this operationCreateCustomerInvoiceFromQuoteNotFound (404): Quote not foundCreateCustomerInvoiceFromQuoteUnprocessableEntity (422): Request rejected by business validationDeletes a draft customer invoice or draft credit note.
Possible errors:
DeleteCustomerInvoiceBadRequest (400): Bad requestDeleteCustomerInvoiceUnauthorized (401): Invalid or missing API keyDeleteCustomerInvoiceForbidden (403): Insufficient permissionsDeleteCustomerInvoiceNotFound (404): Resource not foundDeleteCustomerInvoiceUnprocessableEntity (422): Unprocessable contentTurns a draft customer invoice or credit note into a finalized one.
Once finalized, the resource can no longer be edited.
Possible errors:
FinalizeCustomerInvoiceBadRequest (400): Missing or invalid request parametersFinalizeCustomerInvoiceUnauthorized (401): Invalid or missing API keyFinalizeCustomerInvoiceForbidden (403): Insufficient permissions for this operationFinalizeCustomerInvoiceNotFound (404): Invoice not foundFinalizeCustomerInvoiceUnprocessableEntity (422): Request rejected by business validationRetrieves a single customer invoice or credit note by ID.
Possible errors:
GetCustomerInvoiceBadRequest (400): Missing or invalid query parametersGetCustomerInvoiceUnauthorized (401): Invalid or missing API keyGetCustomerInvoiceForbidden (403): Insufficient permissions for this operationGetCustomerInvoiceNotFound (404): Invoice not foundRetrieves a list of appendices for a specific customer invoice.
Uses cursor-based pagination.
Possible errors:
GetCustomerInvoiceAppendicesBadRequest (400): Missing or invalid query parametersGetCustomerInvoiceAppendicesUnauthorized (401): Invalid or missing API keyGetCustomerInvoiceAppendicesForbidden (403): Insufficient permissions for this operationGetCustomerInvoiceAppendicesNotFound (404): Invoice not foundRetrieves a list of categories for a specific customer invoice.
Uses cursor-based pagination.
Possible errors:
GetCustomerInvoiceCategoriesBadRequest (400): Missing or invalid query parametersGetCustomerInvoiceCategoriesUnauthorized (401): Invalid or missing API keyGetCustomerInvoiceCategoriesForbidden (403): Insufficient permissions for this operationGetCustomerInvoiceCategoriesNotFound (404): Invoice not foundLists custom header fields for a customer invoice.
Possible errors:
GetCustomerInvoiceCustomHeaderFieldsBadRequest (400): Missing or invalid query parametersGetCustomerInvoiceCustomHeaderFieldsUnauthorized (401): Invalid or missing API keyGetCustomerInvoiceCustomHeaderFieldsForbidden (403): Insufficient permissions for this operationGetCustomerInvoiceCustomHeaderFieldsNotFound (404): Invoice not foundRetrieves a list of invoice lines for a specific customer invoice.
Uses cursor-based pagination.
Possible errors:
GetCustomerInvoiceInvoiceLinesBadRequest (400): Missing or invalid query parametersGetCustomerInvoiceInvoiceLinesUnauthorized (401): Invalid or missing API keyGetCustomerInvoiceInvoiceLinesForbidden (403): Insufficient permissions for this operationGetCustomerInvoiceInvoiceLinesNotFound (404): Invoice not foundRetrieves a list of invoice line sections for a specific customer invoice.
Uses cursor-based pagination.
Possible errors:
GetCustomerInvoiceInvoiceLineSectionsBadRequest (400): Missing or invalid query parametersGetCustomerInvoiceInvoiceLineSectionsUnauthorized (401): Invalid or missing API keyGetCustomerInvoiceInvoiceLineSectionsForbidden (403): Insufficient permissions for this operationGetCustomerInvoiceInvoiceLineSectionsNotFound (404): Invoice not found// Get first page of invoice line sections
yield* CustomerInvoicesApi.getCustomerInvoiceInvoiceLineSections(1234, { limit: 20 })
// Get next page using cursor
yield* CustomerInvoicesApi.getCustomerInvoiceInvoiceLineSections(1234, {
cursor: "MjAyNS0wMS0wOVQwODoyNDozOC44MTI0NTha"
})
// Sort by ID in descending order
yield* CustomerInvoicesApi.getCustomerInvoiceInvoiceLineSections(1234, { sort: "-id" })
Retrieves a list of matched transactions for a specific customer invoice.
Uses cursor-based pagination.
Possible errors:
GetCustomerInvoiceMatchedTransactionsBadRequest (400): Missing or invalid query parametersGetCustomerInvoiceMatchedTransactionsUnauthorized (401): Invalid or missing API keyGetCustomerInvoiceMatchedTransactionsForbidden (403): Insufficient permissions for this operationGetCustomerInvoiceMatchedTransactionsNotFound (404): Invoice not foundRetrieves a list of payments for a specific customer invoice.
Uses cursor-based pagination.
Possible errors:
GetCustomerInvoicePaymentsBadRequest (400): Missing or invalid query parametersGetCustomerInvoicePaymentsUnauthorized (401): Invalid or missing API keyGetCustomerInvoicePaymentsForbidden (403): Insufficient permissions for this operationGetCustomerInvoicePaymentsNotFound (404): Invoice not foundRetrieves a list of customer invoices and credit notes.
Uses v2026 cursor-based pagination.
Possible errors:
GetCustomerInvoicesBadRequest (400): Missing or invalid query parametersGetCustomerInvoicesUnauthorized (401): Invalid or missing API keyGetCustomerInvoicesForbidden (403): Insufficient permissions for this operationGetCustomerInvoicesNotFound (404): Not found// Get first page of invoices
yield* CustomerInvoicesApi.getCustomerInvoices({ limit: 20 })
// Get next page using cursor
yield* CustomerInvoicesApi.getCustomerInvoices({ cursor: "MjAyNS0wMS0wOVQwODoyNDozOC44MTI0NTha" })
// Filter invoices by customer and status
yield* CustomerInvoicesApi.getCustomerInvoices({
filter: [
{ field: "customer_id", operator: "eq", value: "123" },
{ field: "draft", operator: "eq", value: "false" }
]
})
Imports a customer invoice with a previously uploaded attached file.
Possible errors:
ImportCustomerInvoiceBadRequest (400): Missing or invalid request bodyImportCustomerInvoiceUnauthorized (401): Invalid or missing API keyImportCustomerInvoiceForbidden (403): Insufficient permissions for this operationImportCustomerInvoiceNotFound (404): Related resource not foundImportCustomerInvoiceConflict (409): Conflict with current resource stateImportCustomerInvoiceUnprocessableEntity (422): Request rejected by business validationLinks a credit note to a customer invoice.
Possible errors:
LinkCreditNoteBadRequest (400): Missing or invalid request parametersLinkCreditNoteUnauthorized (401): Invalid or missing API keyLinkCreditNoteForbidden (403): Insufficient permissions for this operationLinkCreditNoteNotFound (404): Invoice or credit note not foundLinkCreditNoteUnprocessableEntity (422): Request rejected by business validationMarks a customer invoice as paid. No automatic reconciliation will be done once the invoice is marked as paid.
Sends a customer invoice or credit note by email.
Possible errors:
SendCustomerInvoiceByEmailBadRequest (400): Missing or invalid request bodySendCustomerInvoiceByEmailUnauthorized (401): Invalid or missing API keySendCustomerInvoiceByEmailForbidden (403): Insufficient permissions for this operationSendCustomerInvoiceByEmailNotFound (404): Invoice not foundSendCustomerInvoiceByEmailConflict (409): Invoice PDF is not ready yet, retry laterSendCustomerInvoiceByEmailUnprocessableEntity (422): Request rejected by business validationUpdates a customer invoice.
Supports two modes depending on the invoice state:
Possible errors:
UpdateCustomerInvoiceBadRequest (400): Missing or invalid request bodyUpdateCustomerInvoiceUnauthorized (401): Invalid or missing API keyUpdateCustomerInvoiceForbidden (403): Insufficient permissions for this operationUpdateCustomerInvoiceNotFound (404): Invoice not foundUpdateCustomerInvoiceUnprocessableEntity (422): Request rejected by business validationUpdates an imported customer invoice or credit note.
This endpoint is not applicable for draft invoices.
Possible errors:
UpdateImportedCustomerInvoiceBadRequest (400): Missing or invalid request bodyUpdateImportedCustomerInvoiceUnauthorized (401): Invalid or missing API keyUpdateImportedCustomerInvoiceForbidden (403): Insufficient permissions for this operationUpdateImportedCustomerInvoiceNotFound (404): Invoice not foundUpdateImportedCustomerInvoiceUnprocessableEntity (422): Request rejected by business validationUploads an appendix file for a specific customer invoice.
Possible errors:
UploadCustomerInvoiceAppendixBadRequest (400): Missing or invalid request bodyUploadCustomerInvoiceAppendixUnauthorized (401): Invalid or missing API keyUploadCustomerInvoiceAppendixForbidden (403): Insufficient permissions for this operationUploadCustomerInvoiceAppendixNotFound (404): Invoice not foundUploadCustomerInvoiceAppendixUnprocessableEntity (422): Upload rejected by business validationUpdates the categories assigned to a customer. The sum of weights for each category group must equal 1.
Creates a new company customer.
Creates a new individual customer.
Retrieves a company customer by its unique identifier.
Retrieves a customer (company or individual) by its unique identifier.
Retrieves categories of a customer.
Retrieves contacts of a customer.
Retrieves a list of customers (company and individual).
Retrieves an individual customer by its unique identifier.
Updates an existing company customer.
Updates an existing individual customer.
Creates a new journal.
Possible errors:
CreateJournalBadRequest (400): Missing or invalid request parametersCreateJournalUnauthorized (401): Invalid or missing API keyCreateJournalForbidden (403): Insufficient permissions for this operationCreateJournalUnprocessableEntity (422): Request data is invalid (e.g., code already exists)Retrieves a single journal by its unique identifier.
Uses v2026 behavior only.
Retrieves a list of journals.
Uses only v2026 pagination and query options.
// Get first page with new pagination
yield* JournalsApi.getJournals({ limit: 10 })
// Get next page using cursor
yield* JournalsApi.getJournals({ cursor: "MjAyNS0wMS0wOVQwODoyNDozOC44MTI0NTha" })
// Filter journals of type "sale"
yield* JournalsApi.getJournals({
filter: [{ field: "type", operator: "eq", value: "sale" }],
})
Creates a new product.
Retrieves a single product by its unique identifier.
Retrieves a list of products.
Updates an existing product.
The main API object grouped by resource.