API reference
All public endpoints of API v1, generated from the OpenAPI description (version 2026-11-01). Paths are relative to
/api/v1.Account
Signed-in user, company and invoicing master data.
- GET
/company-profileRetrieve company and invoicing master data - PATCH
/company-profileUpdate company and invoicing master data - GET
/company-profile/letterhead-previewLetterhead preview as PDF - GET
/company-profile/logoDownload logo - PUT
/company-profile/logoUpload or replace logo - DELETE
/company-profile/logoRemove logo - GET
/meRetrieve signed-in user - GET
/notificationsList notifications - POST
/notifications/{id}/readMark notification as read - POST
/notifications/read-allMark all notifications as read - GET
/notifications/summaryAlerts: overdue debts and upcoming instalments - GET
/settingsRetrieve settings - PATCH
/settingsUpdate settings
Contacts
Customers and debtors (shared contact base).
Clients
Clients of collection agencies and law firms.
Debts
Debts, costs, interest and phases (dunning, court, enforcement).
- GET
/contacts/{id}/financesFinancial analysis of a contact - GET
/debtsList debts - POST
/debtsCreate debt - GET
/debts/{id}Retrieve debt - PATCH
/debts/{id}Update debt - DELETE
/debts/{id}Delete debt - GET
/debts/{id}/costsCosts of a debt - POST
/debts/{id}/costsRecord costs - DELETE
/debts/{id}/costs/{costId}Remove costs - GET
/debts/{id}/historyHistory of a debt - POST
/debts/{id}/mark-paidMark as paid - POST
/debts/{id}/mark-unpaidRemove paid mark - GET
/debts/{id}/messagesCommunication log - POST
/debts/{id}/messagesLog communication - POST
/debts/{id}/phaseChange phase - GET
/debts/{id}/statementStatement of debt - POST
/interest-calculationsCalculate interest (interest calculator) - GET
/reports/receivablesDebt overview (key figures)
Payments
Incoming payments and instalment plans for debts.
- GET
/installment-plansList instalment plans - POST
/installment-plansCreate instalment plan - GET
/installment-plans/{id}Retrieve instalment plan - PATCH
/installment-plans/{id}Update instalment plan - DELETE
/installment-plans/{id}Delete instalment plan - GET
/installment-plans/{id}/paymentsInstalments of an instalment plan - POST
/installment-plans/{id}/paymentsRecord instalment - DELETE
/installment-plans/{id}/payments/{paymentId}Delete instalment - GET
/paymentsList payments - POST
/paymentsRecord payment - GET
/payments/{id}Retrieve individual payment - PATCH
/payments/{id}Update individual payment - DELETE
/payments/{id}Delete individual payment
Letters
Letters sent by post and their delivery status.
Research
Address research, residents’ registration office requests (Melderegisteranfragen) and social media profiles for contacts.
- GET
/contacts/{id}/address-researchAddress research results - GET
/contacts/{id}/residence-registry-inquiriesResidents’ registration office requests for a contact - POST
/contacts/{id}/residence-registry-inquiriesOrder residents’ registration office request (paid) - GET
/contacts/{id}/residence-registry-inquiries/{inquiryId}Retrieve residents’ registration office request - DELETE
/contacts/{id}/residence-registry-inquiries/{inquiryId}Delete residents’ registration office request - GET
/contacts/{id}/social-profilesSocial media profiles of a contact - POST
/contacts/{id}/social-profilesAdd social media profile - PATCH
/contacts/{id}/social-profiles/{profileId}Update social media profile - DELETE
/contacts/{id}/social-profiles/{profileId}Remove social media profile
Creditor AI
AI recommendations for debts (limited quota).
Activities
Activity log across contacts, debts and other objects.
Documents
Files attached to contacts, debts and receipts.
Invoices
Invoices, credit notes and cancellation invoices, including e-invoicing and sending.
- GET
/invoice-settingsInvoice and quote settings - PATCH
/invoice-settingsUpdate invoice and quote settings - GET
/invoicesList invoices - POST
/invoicesCreate draft invoice - GET
/invoices/{id}Retrieve invoice - PATCH
/invoices/{id}Update draft invoice - DELETE
/invoices/{id}Delete draft invoice - GET
/invoices/{id}/audit-logAudit log of an invoice - POST
/invoices/{id}/cancelCancel invoice - GET
/invoices/{id}/dispatchesDispatch log of an invoice - POST
/invoices/{id}/duplicateCopy invoice as new draft - GET
/invoices/{id}/e-invoiceE-invoice of a finalised invoice - POST
/invoices/{id}/finalizeFinalise invoice - POST
/invoices/{id}/hand-overHand invoice over to dunning - GET
/invoices/{id}/paymentsPayments of an invoice - POST
/invoices/{id}/paymentsRecord payment - DELETE
/invoices/{id}/payments/{paymentId}Delete payment - GET
/invoices/{id}/pdfInvoice as PDF - POST
/invoices/{id}/sendSend invoice (email or post) - GET
/invoices/summaryOpen invoices overview - GET
/recurring-invoicesList recurring invoices - POST
/recurring-invoicesCreate recurring invoice - GET
/recurring-invoices/{id}Retrieve recurring invoice - PATCH
/recurring-invoices/{id}Update recurring invoice - DELETE
/recurring-invoices/{id}Delete recurring invoice - POST
/recurring-invoices/{id}/runGenerate next invoice now
E-invoicing
Create XRechnung and ZUGFeRD files, validate and read incoming e-invoices.
Quotes
Quotes and order confirmations.
- GET
/offersList quotes - POST
/offersCreate draft quote - GET
/offers/{id}Retrieve quote - PATCH
/offers/{id}Update draft quote - DELETE
/offers/{id}Delete draft quote - POST
/offers/{id}/acceptMark quote as accepted - GET
/offers/{id}/audit-logAudit log of a quote - POST
/offers/{id}/convertConvert quote to invoice or order confirmation - GET
/offers/{id}/dispatchesDispatch log of a quote - POST
/offers/{id}/duplicateCopy quote as new draft - POST
/offers/{id}/finalizeFinalise quote - GET
/offers/{id}/pdfQuote as PDF - POST
/offers/{id}/rejectMark quote as rejected - POST
/offers/{id}/sendSend quote (email or post)
Articles
Product and service catalogue for quotes and invoices.
Number ranges
Number ranges for documents, customers and projects.
Receipts
Incoming receipts with OCR, inbound email address and import.
- GET
/importsList imports - POST
/importsUpload import file - GET
/imports/{id}Retrieve import - DELETE
/imports/{id}Discard import - POST
/imports/{id}/commitRun import - POST
/imports/{id}/previewImport preview - GET
/receipt-categoriesExpense categories with accounts (SKR03/SKR04) - GET
/receipt-inboxRetrieve inbound email address for receipts - PATCH
/receipt-inboxSet up or update inbound email address - POST
/receipt-inbox/rotateGenerate new inbound email address - GET
/receiptsList receipts - POST
/receiptsUpload receipt - GET
/receipts/{id}Retrieve receipt - PATCH
/receipts/{id}Update receipt - DELETE
/receipts/{id}Delete receipt - POST
/receipts/{id}/bookPost receipt (finalise) - GET
/receipts/{id}/fileDownload receipt file - PUT
/receipts/{id}/fileReplace or add receipt file - POST
/receipts/{id}/processRe-run receipt recognition - POST
/receipts/photosUpload receipt photo from the app
Bank
Bank accounts, transaction import (CSV/CAMT) and matching.
- GET
/bank-accountsList bank accounts - POST
/bank-accountsCreate bank account - GET
/bank-accounts/{id}Retrieve bank account - PATCH
/bank-accounts/{id}Update bank account - DELETE
/bank-accounts/{id}Delete bank account - GET
/bank-import-presetsBank CSV templates - GET
/bank-import-profilesList CSV import profiles - POST
/bank-import-profilesSave CSV import profile - GET
/bank-import-profiles/{id}Retrieve CSV import profile - PATCH
/bank-import-profiles/{id}Update CSV import profile - DELETE
/bank-import-profiles/{id}Delete CSV import profile - GET
/bank-importsList imports - POST
/bank-importsImport bank transactions - GET
/bank-imports/{id}Retrieve import - POST
/bank-imports/{id}/revertRevert import - POST
/bank-imports/previewCheck import (preview) - GET
/bank-rulesList learned counter accounts - DELETE
/bank-rules/{id}Delete learned counter account - GET
/bank-transactionsList bank transactions - POST
/bank-transactionsSubmit bank transactions - GET
/bank-transactions/{id}Retrieve bank transaction - PATCH
/bank-transactions/{id}Update bank transaction - GET
/bank-transactions/{id}/candidatesOpen items for a transaction - POST
/bank-transactions/{id}/matchMatch transaction - POST
/bank-transactions/{id}/unmatchUnmatch transaction - POST
/bank-transactions/auto-matchCalculate match suggestions - POST
/bank-transactions/confirm-suggestionsConfirm reliable suggestions
Projects
Projects and budgets.
- GET
/projectsList projects - POST
/projectsCreate project - GET
/projects/{id}Retrieve project - PATCH
/projects/{id}Update project - DELETE
/projects/{id}Delete project - GET
/projects/{id}/summaryProject report - POST
/projects/{id}/tasksAdd task to project - PATCH
/projects/{id}/tasks/{taskId}Update task - DELETE
/projects/{id}/tasks/{taskId}Delete task
Time tracking
Time entries and timers.
- GET
/time-entriesList time entries - POST
/time-entriesRecord time entry manually - GET
/time-entries/{id}Retrieve time entry - PATCH
/time-entries/{id}Update time entry - DELETE
/time-entries/{id}Delete time entry - POST
/time-entries/{id}/stopStop running time entry - POST
/time-entries/invoiceCreate draft invoice from time entries - POST
/time-entries/invoice-previewPreview: invoice from time entries - POST
/time-entries/releaseRelease invoiced time entries - GET
/time-entries/summaryTime report - GET
/time-entries/timerRetrieve running timer - POST
/time-entries/timerStart timer - POST
/time-entries/timer/stopStop running timer
Reports
Cash-basis income statement (EÜR), advance VAT return (Umsatzsteuer-Voranmeldung) boxes and DATEV export.
- GET
/exportsList exports - POST
/exportsCreate DATEV export - GET
/exports/{id}Retrieve export - GET
/exports/{id}/downloadDownload export file (ZIP) - GET
/reports/euerCash-basis income statement (Anlage EÜR) - GET
/reports/euer/pdfCash-basis income statement (EÜR) as PDF - GET
/reports/open-itemsOpen items - GET
/reports/summaryRevenue and costs - GET
/reports/trial-balanceTrial balance - GET
/reports/vat-returnAdvance VAT return (boxes) - GET
/reports/vat-return/pdfAdvance VAT return as PDF - GET
/tax-reportsList saved reports - POST
/tax-reportsSave report as immutable - GET
/tax-reports/{id}Retrieve saved report - GET
/tax-reports/{id}/pdfSaved report as PDF
Accounting
Charts of accounts SKR03/SKR04, journal, manual journal entries and period locks (GoBD, German bookkeeping rules).
- GET
/accounting-settingsRetrieve accounting settings - PATCH
/accounting-settingsUpdate accounting settings - GET
/accountsList accounts in the chart of accounts - GET
/journal-entriesList journal - POST
/journal-entriesCreate manual journal entry - GET
/journal-entries/{id}Retrieve journal entry - PATCH
/journal-entries/{id}Update manual journal entry - DELETE
/journal-entries/{id}Delete manual journal entry - GET
/journal-entries/pendingAccounting open issues - GET
/period-closingsList period locks - POST
/period-closingsLock period - GET
/period-closings/previewCheck period lock
Webhooks
Webhook endpoints, deliveries and events.
- GET
/event-typesList event types - GET
/eventsList events - GET
/events/{id}Retrieve event - GET
/webhook-deliveriesDelivery log - GET
/webhook-deliveries/{id}Retrieve delivery - POST
/webhook-deliveries/{id}/retryRetry delivery - GET
/webhook-endpointsList webhook endpoints - POST
/webhook-endpointsCreate webhook endpoint - GET
/webhook-endpoints/{id}Retrieve webhook endpoint - PATCH
/webhook-endpoints/{id}Update webhook endpoint - DELETE
/webhook-endpoints/{id}Delete webhook endpoint - POST
/webhook-endpoints/{id}/rotate-secretRotate signing secret - POST
/webhook-endpoints/{id}/testSend test event
Developers
API keys and OAuth applications (dashboard only).
Security
Passkeys and two-factor sign-in (dashboard only).
Online payments
Connect your own Stripe account (Stripe Connect) and create payment links for invoices and debts.
- GET
/payment-linksList payment links - POST
/payment-linksCreate payment link - GET
/payment-links/{id}Retrieve payment link - POST
/payment-links/{id}/checkoutStart checkout - POST
/payment-links/{id}/deactivateDeactivate payment link - GET
/payment-links/{id}/publicRetrieve payment link (public) - GET
/stripe-accountRetrieve connected Stripe account - PATCH
/stripe-accountUpdate payment link settings - POST
/stripe-account/refreshRefresh Stripe account status