ConstCreates a bank account.
Possible errors:
CreateBankAccountBadRequest (400): Missing or invalid request bodyCreateBankAccountUnauthorized (401): Invalid or missing API keyCreateBankAccountForbidden (403): Insufficient permissions (bank_accounts:all scope required)CreateBankAccountNotFound (404): Bank establishment not foundCreateBankAccountUnprocessableEntity (422): Request rejected by business validationRetrieves a single bank account by its identifier.
Possible errors:
GetBankAccountBadRequest (400): Invalid requestGetBankAccountUnauthorized (401): Invalid or missing API keyGetBankAccountForbidden (403): Insufficient permissions for this operationGetBankAccountNotFound (404): Bank account not foundRetrieves a list of bank accounts.
Uses cursor-based pagination.
Possible errors:
GetBankAccountsBadRequest (400): Missing or invalid query parametersGetBankAccountsUnauthorized (401): Invalid or missing API keyGetBankAccountsForbidden (403): Insufficient permissions (bank_accounts:readonly scope required)GetBankAccountsNotFound (404): Resource not foundCategorizes 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.
Matches a bank transaction to a customer invoice (justifies the transaction).
Possible errors:
MatchCustomerInvoiceTransactionBadRequest (400): Missing or invalid request bodyMatchCustomerInvoiceTransactionUnauthorized (401): Invalid or missing API keyMatchCustomerInvoiceTransactionForbidden (403): Insufficient permissions (customer_invoices:all scope required)MatchCustomerInvoiceTransactionNotFound (404): Invoice or transaction not foundMatchCustomerInvoiceTransactionUnprocessableEntity (422): Matching rejected by business validationSends 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 validationUnmatches a bank transaction from a customer invoice.
Possible errors:
UnmatchCustomerInvoiceTransactionBadRequest (400): Invalid requestUnmatchCustomerInvoiceTransactionUnauthorized (401): Invalid or missing API keyUnmatchCustomerInvoiceTransactionForbidden (403): Insufficient permissions (customer_invoices:all scope required)UnmatchCustomerInvoiceTransactionNotFound (404): Invoice or matched transaction not foundUnmatchCustomerInvoiceTransactionUnprocessableEntity (422): Unmatching 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.
Uploads a file (max 100MB) and returns a file attachment.
The returned id can be used as file_attachment_id, for example to import a
supplier invoice that will then be matched to a bank transaction.
The file is not added to the Pennylane DMS (GED).
Possible errors:
UploadFileAttachmentBadRequest (400): Missing or invalid fileUploadFileAttachmentUnauthorized (401): Invalid or missing API keyUploadFileAttachmentForbidden (403): Insufficient permissions for this operationUploadFileAttachmentNotFound (404): Resource not foundUploadFileAttachmentUnprocessableEntity (422): Upload rejected by business validationCreates 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.
Retrieves a single supplier invoice by its identifier.
Possible errors:
GetSupplierInvoiceBadRequest (400): Invalid requestGetSupplierInvoiceUnauthorized (401): Invalid or missing API keyGetSupplierInvoiceForbidden (403): Insufficient permissions for this operationGetSupplierInvoiceNotFound (404): Supplier invoice not foundRetrieves the bank transactions matched to a supplier invoice.
Uses cursor-based pagination.
Possible errors:
GetSupplierInvoiceMatchedTransactionsBadRequest (400): Missing or invalid query parametersGetSupplierInvoiceMatchedTransactionsUnauthorized (401): Invalid or missing API keyGetSupplierInvoiceMatchedTransactionsForbidden (403): Insufficient permissions for this operationGetSupplierInvoiceMatchedTransactionsNotFound (404): Supplier invoice not foundRetrieves a list of supplier invoices.
Uses cursor-based pagination.
Possible errors:
GetSupplierInvoicesBadRequest (400): Missing or invalid query parametersGetSupplierInvoicesUnauthorized (401): Invalid or missing API keyGetSupplierInvoicesForbidden (403): Insufficient permissions for this operationGetSupplierInvoicesNotFound (404): Resource not foundImports a supplier invoice with a previously uploaded file attached.
Upload the file first with FileAttachmentsApi.uploadFileAttachment, then pass its id
as file_attachment_id.
Possible errors:
ImportSupplierInvoiceBadRequest (400): Missing or invalid request bodyImportSupplierInvoiceUnauthorized (401): Invalid or missing API keyImportSupplierInvoiceForbidden (403): Insufficient permissions (supplier_invoices:all scope required)ImportSupplierInvoiceNotFound (404): Supplier or file attachment not foundImportSupplierInvoiceConflict (409): File attachment not available yet, retry after a few secondsImportSupplierInvoiceUnprocessableEntity (422): Request rejected by business validationMatches a bank transaction to a supplier invoice (justifies the transaction).
Possible errors:
MatchSupplierInvoiceTransactionBadRequest (400): Missing or invalid request bodyMatchSupplierInvoiceTransactionUnauthorized (401): Invalid or missing API keyMatchSupplierInvoiceTransactionForbidden (403): Insufficient permissions (supplier_invoices:all scope required)MatchSupplierInvoiceTransactionNotFound (404): Supplier invoice or transaction not foundMatchSupplierInvoiceTransactionUnprocessableEntity (422): Matching rejected by business validationUnmatches a bank transaction from a supplier invoice.
Possible errors:
UnmatchSupplierInvoiceTransactionBadRequest (400): Invalid requestUnmatchSupplierInvoiceTransactionUnauthorized (401): Invalid or missing API keyUnmatchSupplierInvoiceTransactionForbidden (403): Insufficient permissions (supplier_invoices:all scope required)UnmatchSupplierInvoiceTransactionNotFound (404): Supplier invoice or matched transaction not foundUnmatchSupplierInvoiceTransactionUnprocessableEntity (422): Unmatching rejected by business validationReplaces the categories of a supplier.
Categories can belong to different category groups; the sum of weights within
a same group must equal 1.
Possible errors:
CategorizeSupplierBadRequest (400): Missing or invalid request bodyCategorizeSupplierUnauthorized (401): Invalid or missing API keyCategorizeSupplierForbidden (403): Insufficient permissions (suppliers:all scope required)CategorizeSupplierNotFound (404): Supplier or category not foundCategorizeSupplierUnprocessableEntity (422): Request rejected by business validationCreates a supplier.
Possible errors:
CreateSupplierBadRequest (400): Missing or invalid request bodyCreateSupplierUnauthorized (401): Invalid or missing API keyCreateSupplierForbidden (403): Insufficient permissions (suppliers:all scope required)CreateSupplierNotFound (404): Resource not foundCreateSupplierConflict (409): Conflict with an existing supplierCreateSupplierUnprocessableEntity (422): Request rejected by business validationRetrieves a single supplier by its identifier.
Possible errors:
GetSupplierBadRequest (400): Invalid requestGetSupplierUnauthorized (401): Invalid or missing API keyGetSupplierForbidden (403): Insufficient permissions for this operationGetSupplierNotFound (404): Supplier not foundRetrieves the categories of a supplier.
Uses cursor-based pagination.
Possible errors:
GetSupplierCategoriesBadRequest (400): Missing or invalid query parametersGetSupplierCategoriesUnauthorized (401): Invalid or missing API keyGetSupplierCategoriesForbidden (403): Insufficient permissions (suppliers:readonly scope required)GetSupplierCategoriesNotFound (404): Supplier not foundRetrieves supplier change events (insert / update / delete).
Changes are retained for 4 weeks. Uses cursor-based pagination.
Possible errors:
GetSupplierChangesBadRequest (400): Missing or invalid query parametersGetSupplierChangesUnauthorized (401): Invalid or missing API keyGetSupplierChangesForbidden (403): Insufficient permissions (suppliers:readonly scope required)GetSupplierChangesNotFound (404): Resource not foundGetSupplierChangesUnprocessableEntity (422): start_date older than 4 weeks or combined with cursorRetrieves a list of suppliers.
Uses cursor-based pagination.
Possible errors:
GetSuppliersBadRequest (400): Missing or invalid query parametersGetSuppliersUnauthorized (401): Invalid or missing API keyGetSuppliersForbidden (403): Insufficient permissions (suppliers:readonly scope required)GetSuppliersNotFound (404): Resource not foundUpdates an existing supplier.
Possible errors:
UpdateSupplierBadRequest (400): Missing or invalid request bodyUpdateSupplierUnauthorized (401): Invalid or missing API keyUpdateSupplierForbidden (403): Insufficient permissions (suppliers:all scope required)UpdateSupplierNotFound (404): Supplier not foundUpdateSupplierUnprocessableEntity (422): Request rejected by business validationCreates a bank transaction.
Possible errors:
CreateTransactionBadRequest (400): Missing or invalid request bodyCreateTransactionUnauthorized (401): Invalid or missing API keyCreateTransactionForbidden (403): Insufficient permissions (transactions:all scope required)CreateTransactionNotFound (404): Bank account not foundCreateTransactionUnprocessableEntity (422): Request rejected by business validationRetrieves a single bank transaction by its identifier.
Possible errors:
GetTransactionBadRequest (400): Invalid requestGetTransactionUnauthorized (401): Invalid or missing API keyGetTransactionForbidden (403): Insufficient permissions for this operationGetTransactionNotFound (404): Transaction not foundRetrieves the invoices (customer or supplier) matched to a bank transaction.
Uses cursor-based pagination.
Possible errors:
GetTransactionMatchedInvoicesBadRequest (400): Missing or invalid query parametersGetTransactionMatchedInvoicesUnauthorized (401): Invalid or missing API keyGetTransactionMatchedInvoicesForbidden (403): Insufficient permissions for this operationGetTransactionMatchedInvoicesNotFound (404): Transaction not foundRetrieves a list of bank transactions.
Uses cursor-based pagination.
Possible errors:
GetTransactionsBadRequest (400): Missing or invalid query parametersGetTransactionsUnauthorized (401): Invalid or missing API keyGetTransactionsForbidden (403): Insufficient permissions (transactions:readonly scope required)GetTransactionsNotFound (404): Resource not foundUpdates a bank transaction by assigning it to a customer or to a supplier.
Possible errors:
UpdateTransactionBadRequest (400): Missing or invalid request bodyUpdateTransactionUnauthorized (401): Invalid or missing API keyUpdateTransactionForbidden (403): Insufficient permissions (transactions:all scope required)UpdateTransactionNotFound (404): Transaction not foundUpdateTransactionUnprocessableEntity (422): Request rejected by business validation
The main API object grouped by resource.