Endpoints
All Account API operations grouped by domain. Pick an endpoint on the left or start in a category below.
389Endpoints44Areas
Account
10 endpoints- getGet current account information/api/account
- patchUpdate current account information/api/account
- getGet current account configuration/api/account/configuration
- getGet accounting settings for the settings editor/api/account/configuration/accounting
- getGet current account AI configuration/api/account/configuration/ai
- getGet contact number range configuration/api/account/configuration/contact
- getGet document settings for the settings editor/api/account/configuration/document
- getGet current account email configuration/api/account/configuration/email
- getGet inbound mail address for receipt drafts/api/account/configuration/inbound-mail
- getGet service area configuration (number formats for projects and service contracts)/api/account/configuration/service
AI Assistant
1 endpointsComments
5 endpointsMediaFiles
4 endpointsContacts
9 endpoints- getList account contacts/api/account/contacts
- postCreate contact/api/account/contacts
- deleteDelete account contact/api/account/contacts/{id}
- getGet account contact/api/account/contacts/{id}
- patchUpdate contact/api/account/contacts/{id}
- postCheck contact VAT ID via VIES/api/account/contacts/{id}/vat-id-checks
- postAttach contacts to groups/api/account/contacts/groups/attach
- postDetach contacts from groups/api/account/contacts/groups/remove
- getGet next Contact/api/account/contacts/next
ContactGroups
5 endpointsContactFields
5 endpointsFileFolders
6 endpoints- getList file folders/api/account/file-folders
- postCreate file folder/api/account/file-folders
- deleteDelete file folder/api/account/file-folders/{id}
- getGet file folder/api/account/file-folders/{id}
- patchUpdate file folder/api/account/file-folders/{id}
- getGet file folders tree/api/account/file-folders/tree
Files
8 endpoints- getList files/api/account/files
- postCreate File/api/account/files
- deleteDelete File/api/account/files/{id}
- getGet file/api/account/files/{id}
- patchUpdate File/api/account/files/{id}
- getGet file/api/account/files/{id}/base64
- getGet download link for a file/api/account/files/{id}/download-link
- getList file categories/api/account/files/categories
CostCenters
5 endpointsBookingAccountCatalog
1 endpointsCustomLedgerAccounts
2 endpointsProjects
6 endpointsService objects
6 endpoints- getList service objects/api/account/service-objects
- postCreate service object/api/account/service-objects
- deleteDelete service object/api/account/service-objects/{id}
- getGet service object/api/account/service-objects/{id}
- patchUpdate service object/api/account/service-objects/{id}
- getGet next suggested service object number and formatted string/api/account/service-objects/next
Service orders
6 endpoints- getList service orders/api/account/service-orders
- postCreate service order/api/account/service-orders
- deleteDelete service order/api/account/service-orders/{id}
- getGet service order/api/account/service-orders/{id}
- patchUpdate service order/api/account/service-orders/{id}
- getGet next suggested service order number and formatted string/api/account/service-orders/next
Service order appointments
5 endpoints- getList service order appointments/api/account/service-order-appointments
- postCreate a service order appointment (schedule slice for Gantt)/api/account/service-order-appointments
- deleteDelete a service order appointment/api/account/service-order-appointments/{id}
- getGet a service order appointment/api/account/service-order-appointments/{id}
- patchUpdate a service order appointment/api/account/service-order-appointments/{id}
Service protocols
6 endpoints- getList service protocols/api/account/service-protocols
- postCreate service protocol/api/account/service-protocols
- deleteDelete service protocol/api/account/service-protocols/{id}
- getGet service protocol/api/account/service-protocols/{id}
- patchUpdate service protocol/api/account/service-protocols/{id}
- getGet next suggested service protocol number and formatted string/api/account/service-protocols/next
Service protocol templates
5 endpoints- getList service protocol templates/api/account/service-protocol-templates
- postCreate service protocol template/api/account/service-protocol-templates
- deleteDelete service protocol template/api/account/service-protocol-templates/{id}
- getGet service protocol template/api/account/service-protocol-templates/{id}
- patchUpdate service protocol template/api/account/service-protocol-templates/{id}
TaskGroups
5 endpointsTasks
8 endpoints- getList Tasks/api/account/tasks
- postCreate Tasks/api/account/tasks
- deleteDelete Tasks/api/account/tasks/{id}
- getGet Tasks/api/account/tasks/{id}
- patchUpdate Tasks/api/account/tasks/{id}
- postAttach Tasks to Group/api/account/tasks/groups/{groupId}/attach
- postDetach Tasks from Group/api/account/tasks/groups/{groupId}/remove
- postSort Tasks in Group/api/account/tasks/groups/{groupId}/sort
TextTemplates
5 endpointsPrintLayouts
6 endpoints- getList PrintLayouts/api/account/print-layouts
- postCreate PrintLayouts/api/account/print-layouts
- deleteDelete PrintLayouts/api/account/print-layouts/{id}
- getGet PrintLayouts/api/account/print-layouts/{id}
- patchUpdate PrintLayouts/api/account/print-layouts/{id}
- getGet PrintLayout template/api/account/print-layouts/templates/{layout_name}
PrintBackgrounds
5 endpointsProducts
5 endpointsProductCatalogs
5 endpointsCustom Documents
19 endpoints- getList custom documents/api/account/custom-documents
- postCreate custom document/api/account/custom-documents
- deleteDelete custom documents/api/account/custom-documents/{id}
- getGet custom documents/api/account/custom-documents/{id}
- patchUpdate custom documents/api/account/custom-documents/{id}
- getList extra PDF attachments (merged into visual PDF)/api/account/custom-documents/{id}/attachments
- postAttach a file (or a signed related document) before the document is finalized/api/account/custom-documents/{id}/attachments
- deleteRemove an attachment before the document is finalized/api/account/custom-documents/{id}/attachments/{attachmentId}
- postLink custom-documents to another document (manual related)/api/account/custom-documents/{id}/document-links
- postReset custom document/api/account/custom-documents/{id}/reset
- postSave custom document/api/account/custom-documents/{id}/save
- postMark custom document as sent/api/account/custom-documents/{id}/send
- getGet the latest online signature request for this document/api/account/custom-documents/{id}/signature-requests
- postSend this document for online signature (SES). Does not return the raw token./api/account/custom-documents/{id}/signature-requests
- postCancel the open signature request/api/account/custom-documents/{id}/signature-requests/cancel
- postRotate the token and resend the signature email/api/account/custom-documents/{id}/signature-requests/resend
- postReset the signature process/api/account/custom-documents/{id}/signature-requests/reset
- postSign this document yourself without sending an email link./api/account/custom-documents/{id}/signature-requests/self-sign
- getGet next custom document/api/account/custom-documents/next
Quotes
22 endpoints- getList Quotes/api/account/quotes
- postCreate Quotes/api/account/quotes
- deleteDelete Quotes/api/account/quotes/{id}
- getGet Quote/api/account/quotes/{id}
- patchUpdate Quote/api/account/quotes/{id}
- postAccept Quote/api/account/quotes/{id}/accept
- getList extra PDF attachments (merged into visual PDF)/api/account/quotes/{id}/attachments
- postAttach a file (or a signed related document) before the document is finalized/api/account/quotes/{id}/attachments
- deleteRemove an attachment before the document is finalized/api/account/quotes/{id}/attachments/{attachmentId}
- postLink quotes to another document (manual related)/api/account/quotes/{id}/document-links
- postOpen Quote/api/account/quotes/{id}/open
- postReject Quote/api/account/quotes/{id}/reject
- postReset Quote/api/account/quotes/{id}/reset
- postSave Quote/api/account/quotes/{id}/save
- postMark Quote as sent/api/account/quotes/{id}/send
- getGet the latest online signature request for this document/api/account/quotes/{id}/signature-requests
- postSend this document for online signature (SES). Does not return the raw token./api/account/quotes/{id}/signature-requests
- postCancel the open signature request/api/account/quotes/{id}/signature-requests/cancel
- postRotate the token and resend the signature email/api/account/quotes/{id}/signature-requests/resend
- postReset the signature process/api/account/quotes/{id}/signature-requests/reset
- postSign this document yourself without sending an email link./api/account/quotes/{id}/signature-requests/self-sign
- getGet next Quote/api/account/quotes/next
Order Confirmations
22 endpoints- getList Order Confirmations/api/account/order-confirmations
- postCreate Order Confirmation/api/account/order-confirmations
- deleteDelete Order Confirmation/api/account/order-confirmations/{id}
- getGet Order Confirmation/api/account/order-confirmations/{id}
- patchUpdate Order Confirmation/api/account/order-confirmations/{id}
- postAccept Order Confirmation/api/account/order-confirmations/{id}/accept
- getList extra PDF attachments (merged into visual PDF)/api/account/order-confirmations/{id}/attachments
- postAttach a file (or a signed related document) before the document is finalized/api/account/order-confirmations/{id}/attachments
- deleteRemove an attachment before the document is finalized/api/account/order-confirmations/{id}/attachments/{attachmentId}
- postLink order-confirmations to another document (manual related)/api/account/order-confirmations/{id}/document-links
- postOpen Order Confirmation/api/account/order-confirmations/{id}/open
- postReject Order Confirmation/api/account/order-confirmations/{id}/reject
- postReset Order Confirmation/api/account/order-confirmations/{id}/reset
- postSave Order Confirmation/api/account/order-confirmations/{id}/save
- postMark Order Confirmation as sent/api/account/order-confirmations/{id}/send
- getGet the latest online signature request for this document/api/account/order-confirmations/{id}/signature-requests
- postSend this document for online signature (SES). Does not return the raw token./api/account/order-confirmations/{id}/signature-requests
- postCancel the open signature request/api/account/order-confirmations/{id}/signature-requests/cancel
- postRotate the token and resend the signature email/api/account/order-confirmations/{id}/signature-requests/resend
- postReset the signature process/api/account/order-confirmations/{id}/signature-requests/reset
- postSign this document yourself without sending an email link./api/account/order-confirmations/{id}/signature-requests/self-sign
- getGet next Order Confirmation/api/account/order-confirmations/next
Delivery Notes
22 endpoints- getList Delivery Notes/api/account/delivery-notes
- postCreate Delivery Note/api/account/delivery-notes
- deleteDelete Delivery Note/api/account/delivery-notes/{id}
- getGet Delivery Note/api/account/delivery-notes/{id}
- patchUpdate Delivery Note/api/account/delivery-notes/{id}
- postAccept Delivery Note/api/account/delivery-notes/{id}/accept
- getList extra PDF attachments (merged into visual PDF)/api/account/delivery-notes/{id}/attachments
- postAttach a file (or a signed related document) before the document is finalized/api/account/delivery-notes/{id}/attachments
- deleteRemove an attachment before the document is finalized/api/account/delivery-notes/{id}/attachments/{attachmentId}
- postLink delivery-notes to another document (manual related)/api/account/delivery-notes/{id}/document-links
- postOpen Delivery Note/api/account/delivery-notes/{id}/open
- postReject Delivery Note/api/account/delivery-notes/{id}/reject
- postReset Delivery Note/api/account/delivery-notes/{id}/reset
- postSave Delivery Note/api/account/delivery-notes/{id}/save
- postMark Delivery Note as sent/api/account/delivery-notes/{id}/send
- getGet the latest online signature request for this document/api/account/delivery-notes/{id}/signature-requests
- postSend this document for online signature (SES). Does not return the raw token./api/account/delivery-notes/{id}/signature-requests
- postCancel the open signature request/api/account/delivery-notes/{id}/signature-requests/cancel
- postRotate the token and resend the signature email/api/account/delivery-notes/{id}/signature-requests/resend
- postReset the signature process/api/account/delivery-notes/{id}/signature-requests/reset
- postSign this document yourself without sending an email link./api/account/delivery-notes/{id}/signature-requests/self-sign
- getGet next Delivery Note/api/account/delivery-notes/next
Invoices
32 endpoints- getList Invoices/api/account/invoices
- postCreate Invoice/api/account/invoices
- deleteDelete Invoice/api/account/invoices/{id}
- getGet Invoice/api/account/invoices/{id}
- patchUpdate Invoice/api/account/invoices/{id}
- getList extra PDF attachments (merged into visual PDF / e-invoice BG-24)/api/account/invoices/{id}/attachments
- postAttach a file (or a signed related document) before the document is finalized/api/account/invoices/{id}/attachments
- deleteRemove an attachment before the document is finalized/api/account/invoices/{id}/attachments/{attachmentId}
- postCancel invoice via credit note/api/account/invoices/{id}/cancel
- deleteReverse a cash discount (Skonto) or uncollectible write-off on an invoice (reverts amount_open)/api/account/invoices/{id}/cash-discounts/{settlementId}
- postLink invoice to another document (manual related)/api/account/invoices/{id}/document-links
- postCreate dunning from invoice/api/account/invoices/{id}/dunning
- getGet invoice ZUGFeRD XML/api/account/invoices/{id}/e-invoice-xml
- postSettle the difference between the invoice total and its payments/api/account/invoices/{id}/open-amount-settlements
- deleteRemove all removable payment allocations from an invoice/api/account/invoices/{id}/payments
- postRecord a payment for an invoice/api/account/invoices/{id}/payments
- deleteDelete a payment from an invoice (reverts amount_open)/api/account/invoices/{id}/payments/{paymentId}
- postReset Invoice/api/account/invoices/{id}/reset
- postSave Invoice/api/account/invoices/{id}/save
- postMark Invoice as sent/api/account/invoices/{id}/send
- postSet invoice status to cancelled/api/account/invoices/{id}/set-cancelled
- postSet invoice status to open/api/account/invoices/{id}/set-open
- postSet invoice status to paid/api/account/invoices/{id}/set-paid
- postSet invoice status to partially paid/api/account/invoices/{id}/set-partially-paid
- getGet the latest online signature request for this document/api/account/invoices/{id}/signature-requests
- postSend this document for online signature (SES). Does not return the raw token./api/account/invoices/{id}/signature-requests
- postCancel the open signature request/api/account/invoices/{id}/signature-requests/cancel
- postRotate the token and resend the signature email/api/account/invoices/{id}/signature-requests/resend
- postReset the signature process/api/account/invoices/{id}/signature-requests/reset
- postSign this document yourself without sending an email link./api/account/invoices/{id}/signature-requests/self-sign
- getBuild an XRechnung for an invoice/api/account/invoices/{id}/xrechnung
- getGet next Invoice/api/account/invoices/next
Dunnings
23 endpoints- getList Dunnings/api/account/dunnings
- postCreate Dunning/api/account/dunnings
- deleteDelete Dunning/api/account/dunnings/{id}
- getGet Dunning/api/account/dunnings/{id}
- patchUpdate Dunning/api/account/dunnings/{id}
- getList extra PDF attachments (merged into visual PDF)/api/account/dunnings/{id}/attachments
- postAttach a file (or a signed related document) before the document is finalized/api/account/dunnings/{id}/attachments
- deleteRemove an attachment before the document is finalized/api/account/dunnings/{id}/attachments/{attachmentId}
- deleteRemove all removable payment allocations from a dunning/api/account/dunnings/{id}/payments
- postRecord a payment for a dunning/api/account/dunnings/{id}/payments
- deleteDelete a payment from a dunning/api/account/dunnings/{id}/payments/{paymentId}
- postReset Dunning/api/account/dunnings/{id}/reset
- postSave Dunning/api/account/dunnings/{id}/save
- postMark Dunning as sent/api/account/dunnings/{id}/send
- postSet dunning status to closed/api/account/dunnings/{id}/set-closed
- postSet dunning status to open/api/account/dunnings/{id}/set-open
- getGet the latest online signature request for this document/api/account/dunnings/{id}/signature-requests
- postSend this document for online signature (SES). Does not return the raw token./api/account/dunnings/{id}/signature-requests
- postCancel the open signature request/api/account/dunnings/{id}/signature-requests/cancel
- postRotate the token and resend the signature email/api/account/dunnings/{id}/signature-requests/resend
- postReset the signature process/api/account/dunnings/{id}/signature-requests/reset
- postSign this document yourself without sending an email link./api/account/dunnings/{id}/signature-requests/self-sign
- getGet next Dunning/api/account/dunnings/next
Credit Notes
30 endpoints- getList Credit Notes/api/account/credit-notes
- postCreate Credit Note/api/account/credit-notes
- deleteDelete Credit Note/api/account/credit-notes/{id}
- getGet Credit Note/api/account/credit-notes/{id}
- patchUpdate Credit Note/api/account/credit-notes/{id}
- postApply credit note to invoice (offset)/api/account/credit-notes/{id}/apply-to-invoice
- getList extra PDF attachments (merged into visual PDF / e-invoice BG-24)/api/account/credit-notes/{id}/attachments
- postAttach a file (or a signed related document) before the document is finalized/api/account/credit-notes/{id}/attachments
- deleteRemove an attachment before the document is finalized/api/account/credit-notes/{id}/attachments/{attachmentId}
- postLink credit-notes to another document (manual related)/api/account/credit-notes/{id}/document-links
- getGet credit note ZUGFeRD XML/api/account/credit-notes/{id}/e-invoice-xml
- postSettle the difference between the credit note total and its payments/api/account/credit-notes/{id}/open-amount-settlements
- deleteRemove all removable payment allocations from a credit note/api/account/credit-notes/{id}/payments
- postRecord a payment (outgoing) for a credit note/api/account/credit-notes/{id}/payments
- deleteDelete a payment from a credit note/api/account/credit-notes/{id}/payments/{paymentId}
- postReset Credit Note/api/account/credit-notes/{id}/reset
- postSave Credit Note/api/account/credit-notes/{id}/save
- postMark Credit Note as sent/api/account/credit-notes/{id}/send
- postSet credit note status to open/api/account/credit-notes/{id}/set-open
- postSet credit note status to paid/api/account/credit-notes/{id}/set-paid
- postSet credit note status to partially paid/api/account/credit-notes/{id}/set-partially-paid
- deleteDelete credit note settlement/api/account/credit-notes/{id}/settlements/{settlementId}
- getGet the latest online signature request for this document/api/account/credit-notes/{id}/signature-requests
- postSend this document for online signature (SES). Does not return the raw token./api/account/credit-notes/{id}/signature-requests
- postCancel the open signature request/api/account/credit-notes/{id}/signature-requests/cancel
- postRotate the token and resend the signature email/api/account/credit-notes/{id}/signature-requests/resend
- postReset the signature process/api/account/credit-notes/{id}/signature-requests/reset
- postSign this document yourself without sending an email link./api/account/credit-notes/{id}/signature-requests/self-sign
- getBuild an XRechnung for a credit note/api/account/credit-notes/{id}/xrechnung
- getGet next Credit Note/api/account/credit-notes/next
Receipts
20 endpoints- getList receipts/api/account/receipts
- postCreate receipt/api/account/receipts
- deleteDelete receipt/api/account/receipts/{id}
- getGet receipt/api/account/receipts/{id}
- patchUpdate receipt/api/account/receipts/{id}
- getGet receipt document analysis status/api/account/receipts/{id}/analysis
- postAnalyze receipt document/api/account/receipts/{id}/analyze
- deleteReverse a cash discount (Skonto) settlement on a receipt (reverts amount_open)/api/account/receipts/{id}/cash-discounts/{settlementId}
- getGet receipt ZUGFeRD XML/api/account/receipts/{id}/e-invoice-xml
- postSettle the difference between the receipt total and its payments/api/account/receipts/{id}/open-amount-settlements
- deleteRemove all removable payment allocations from a receipt/api/account/receipts/{id}/payments
- postRecord payment on receipt/api/account/receipts/{id}/payments
- deleteDelete a payment from a receipt (reverts amount_open)/api/account/receipts/{id}/payments/{paymentId}
- postReset receipt to draft/api/account/receipts/{id}/reset
- postSet receipt status to cancelled/api/account/receipts/{id}/set-cancelled
- postSet receipt status to open/api/account/receipts/{id}/set-open
- postSet receipt status to paid/api/account/receipts/{id}/set-paid
- postSet receipt status to partially paid/api/account/receipts/{id}/set-partially-paid
- postIngest a receipt file as a draft expense/api/account/receipts/ingest-file
- postStage receipt document file/api/account/receipts/stage-file
Depreciations
2 endpointsRecurring Receipts
6 endpoints- getList recurring receipts/api/account/recurring-receipts
- postCreate recurring receipt/api/account/recurring-receipts
- deleteDelete recurring receipt/api/account/recurring-receipts/{id}
- getGet recurring receipt/api/account/recurring-receipts/{id}
- patchUpdate recurring receipt/api/account/recurring-receipts/{id}
- postCreate the next due receipt from a recurring receipt/api/account/recurring-receipts/{id}/next-receipt
DocumentLinks
1 endpointsPostalShipments
3 endpointsBank Accounts
5 endpointsBank Transactions
13 endpoints- getList Bank Transactions/api/account/bank-transactions
- postCreate Bank Transaction/api/account/bank-transactions
- deleteDelete Bank Transaction/api/account/bank-transactions/{id}
- getGet Bank Transaction/api/account/bank-transactions/{id}
- patchUpdate Bank Transaction/api/account/bank-transactions/{id}
- postLink a payable (invoice, credit note, dunning) to this bank transaction/api/account/bank-transactions/{id}/link-payable
- postLink two bank transactions as internal account transfer (Umbuchung)/api/account/bank-transactions/{id}/link-transfer
- getList payables linked to a bank transaction/api/account/bank-transactions/{id}/linked-payables
- getList payable document suggestions for a bank transaction/api/account/bank-transactions/{id}/payable-suggestions
- getList candidate transactions for internal account transfer linking/api/account/bank-transactions/{id}/transfer-candidates
- deleteRemove internal account transfer link (Umbuchung)/api/account/bank-transactions/{id}/unlink-transfer
- getList automatic assignment suggestions for open bank transactions/api/account/bank-transactions/assignment-suggestions
- getList automatic transfer suggestions for open bank transactions/api/account/bank-transactions/transfer-suggestions
Service Contracts
8 endpoints- getList Service Contracts/api/account/service-contracts
- postCreate Service Contract/api/account/service-contracts
- deleteDelete Service Contract/api/account/service-contracts/{id}
- getGet Service Contract/api/account/service-contracts/{id}
- patchUpdate Service Contract/api/account/service-contracts/{id}
- postCreate next invoice (draft) for Service Contract/api/account/service-contracts/{id}/next-invoice
- postCreate next service order for Service Contract/api/account/service-contracts/{id}/next-order
- getGet next suggested service contract number and formatted string/api/account/service-contracts/next
Locations
5 endpointsWarehouses
5 endpointsPersonnel
5 endpointsTimeRecords
12 endpoints- getList time records/api/account/time-records
- postCreate a time record/api/account/time-records
- deleteDelete a time record/api/account/time-records/{id}
- getGet a time record/api/account/time-records/{id}
- patchUpdate a time record/api/account/time-records/{id}
- postStop a running time record/api/account/time-records/{id}/stop
- postCreate a draft delivery note from time records/api/account/time-records/delivery-note
- postExport selected time records as CSV or PDF/api/account/time-records/export
- postCreate a draft invoice from time records/api/account/time-records/invoice
- postReopen billed or cancelled time records/api/account/time-records/reopen
- postStart a running time record/api/account/time-records/start
- getTime tracking dashboard summary/api/account/time-records/summary