Invoice management, recipients, and location settings
Get invoice location settings
Retrieve invoice settings for a specific location. Creates default settings if none exist.
Permissions: 🔵 invoices.read
query Parameters
locationIdLocation ID to fetch settings for (required)
Get invoice location settings › Responses
Default Response
statusUpdate invoice location settings
Update invoice settings for a specific location. Creates settings if they do not exist (upsert). All fields except locationId are optional for partial updates.
Permissions: 🟠invoices.update
Update invoice location settings › Request Body
locationIdLocation ID (required)
defaultPaymentTermsDaysDefault payment terms in days
invoiceNumberPrefixPrefix for invoice numbers
minInvoiceAmountMinimum amount for invoicing
senderNameSender/company name
senderAddressLine1Sender address line 1
senderAddressLine2Sender address line 2
senderPostalCodeSender postal code
senderCitySender city
senderCountrySender country
senderEmailSender email address
senderPhoneSender phone number
senderOrganizationNumberSender organization number
senderVatNumberSender VAT number
bankAccountNumberBank account number
bankNameBank name
swiftBicSWIFT/BIC code
ibanIBAN
paymentReferencePrefixPayment reference prefix
invoiceFooterTextFooter text for invoices
invoiceTermsTextTerms and conditions text
latePaymentFeeLate payment fee amount
latePaymentInterestRateLate payment interest rate (percentage)
autoGenerateEnabledEnable automatic invoice generation
autoSendOnGenerationAutomatically send invoices when generated
collectionPeriodTypeCollection period type for auto-invoicing
reminderEnabledEnable payment reminders
firstReminderDaysAfterDueDays after due date for first reminder
secondReminderDaysAfterDueDays after due date for second reminder
thirdReminderDaysAfterDueDays after due date for third reminder
reminderFeeAmountFee amount added per reminder
autoMarkOverdueDaysDays after due date to auto-mark as overdue
currencyCurrency code (e.g., SEK, EUR)
Update invoice location settings › Responses
Default Response
statusList invoice recipients
List all invoice recipients for a location with optional filtering and pagination.
Permissions: 🔵 invoices.read
query Parameters
locationIdLocation ID (required)
isActiveFilter by active status
pagePage number
limitItems per page
List invoice recipients › Responses
Default Response
statusCreate invoice recipient
Create a new invoice recipient for a location.
Permissions: 🟢 invoices.create
Create invoice recipient › Request Body
locationIdLocation ID (required)
nameRecipient name (required)
emailEmail address (required)
organizationNameOrganization/company name
organizationNumberOrganization number
phonePhone number
billingAddressLine1Address line 1
billingAddressLine2Address line 2
postalCodePostal code
cityCity
countryCountry
referenceReference/PO number
contactPersonContact person name
vatNumberVAT number
Create invoice recipient › Responses
Default Response
statusUpdate invoice recipient
Update an existing invoice recipient. All fields are optional for partial updates.
Permissions: 🟠invoices.update
path Parameters
recipientIdRecipient UUID
Update invoice recipient › Request Body
nameRecipient name
emailEmail address
organizationNameOrganization/company name
organizationNumberOrganization number
phonePhone number
billingAddressLine1Address line 1
billingAddressLine2Address line 2
postalCodePostal code
cityCity
countryCountry
referenceReference/PO number
contactPersonContact person name
vatNumberVAT number
isActiveWhether the recipient is active
Update invoice recipient › Responses
Default Response
statusDelete invoice recipient
Soft-delete an invoice recipient (sets isActive to false).
Permissions: 🔴 invoices.delete
path Parameters
recipientIdRecipient UUID
Delete invoice recipient › Responses
Default Response
statusList recipient rules
List all active eligibility rules for an invoice recipient.
Permissions: 🔵 invoices.read
path Parameters
recipientIdRecipient UUID
List recipient rules › Responses
Default Response
statusCreate recipient rule
Create a new eligibility rule for automatic invoice assignment.
Permissions: 🟢 invoices.create
path Parameters
recipientIdRecipient UUID
Create recipient rule › Request Body
locationIdLocation ID (required)
ruleTypeType of rule (required)
ruleValueRule value - email, pattern (*@company.com), or user ID (required)
maxCreditLimitMaximum credit limit for auto-invoicing
autoApproveAuto-approve invoices matching this rule
Create recipient rule › Responses
Default Response
statusDelete recipient rule
Delete an eligibility rule.
Permissions: 🔴 invoices.delete
path Parameters
recipientIdRecipient UUID
ruleIdRule UUID
Delete recipient rule › Responses
Default Response
statusList invoices
List all invoices for a location with optional filtering and pagination.
Permissions: 🔵 invoices.read
query Parameters
locationIdLocation ID (required)
recipientIdFilter by recipient
statusFilter by status
invoiceTypeFilter by invoice type
startDateFilter by start date
endDateFilter by end date
pagePage number
limitItems per page
List invoices › Responses
Default Response
statusCreate invoice
Create a new invoice. Invoice number is automatically generated.
Permissions: 🟢 invoices.create
Create invoice › Request Body
locationIdLocation ID (required)
recipientIdRecipient UUID (required)
dueDateDue date YYYY-MM-DD (required)
currencyCurrency code (optional - defaults to location currency)
invoiceTypeInvoice type (default: manual)
collectionPeriodStartCollection period start
collectionPeriodEndCollection period end
totalAmountTotal amount
taxAmountTax amount
subtotalAmountSubtotal amount
issuedDateIssue date
paymentReferencePayment reference
notesNotes
purchaseIdsPurchase IDs to link to invoice
Create invoice › Responses
Default Response
statusUpdate invoice
Update an existing invoice. All fields are optional for partial updates.
Permissions: 🟠invoices.update
path Parameters
invoiceIdInvoice UUID
Update invoice › Request Body
statusInvoice status
dueDateDue date
issuedDateIssue date
paidDatePayment date
paymentReferencePayment reference
notesNotes
totalAmountTotal amount
taxAmountTax amount
subtotalAmountSubtotal amount
Update invoice › Responses
Default Response
statusDelete invoice
Delete a draft invoice. Only draft or auto_draft invoices can be deleted.
Permissions: 🔴 invoices.delete
path Parameters
invoiceIdInvoice UUID
Delete invoice › Responses
Default Response
statusMark invoice as paid
Mark an invoice as paid. Cannot mark cancelled invoices as paid.
Permissions: 🟠invoices.update
path Parameters
invoiceIdInvoice UUID
Mark invoice as paid › Responses
Default Response
statusGet invoice PDF data
Get all data needed for PDF generation (invoice, recipient, settings, location, purchases).
Permissions: 🔵 invoices.read
path Parameters
invoiceIdInvoice UUID
Get invoice PDF data › Responses
Default Response
statusAdd purchases to invoice
Add purchases to an invoice. Only draft invoices can have purchases added.
Permissions: 🟠invoices.update
path Parameters
invoiceIdInvoice UUID
Add purchases to invoice › Request Body
purchaseIdsArray of purchase IDs to add to the invoice
Add purchases to invoice › Responses
Default Response
statusRemove purchase from invoice
Remove a purchase from an invoice. Only draft invoices can have purchases removed.
Permissions: 🟠invoices.update
path Parameters
invoiceIdInvoice UUID
purchaseIdPurchase ID to remove
Remove purchase from invoice › Responses
Default Response
statusSend invoice
Send an invoice to the recipient. Only draft invoices can be sent.
Permissions: 🟠invoices.update
path Parameters
invoiceIdInvoice UUID
Send invoice › Responses
Default Response
statusSend invoice reminder
Send a payment reminder for an overdue invoice.
Permissions: 🟠invoices.update
path Parameters
invoiceIdInvoice UUID
Send invoice reminder › Request Body
reminderNumberReminder number (1, 2, or 3)
Send invoice reminder › Responses
Default Response
statusUpload invoice PDF
Upload a generated PDF for an invoice. The PDF should be base64-encoded.
Permissions: 🟠invoices.update
path Parameters
invoiceIdInvoice UUID
Upload invoice PDF › Responses
Default Response
statusCheck invoice eligibility
Check if a user/email is eligible for invoice payment at a location.
Permissions: 🔵 invoices.read
query Parameters
locationIdLocation ID (required)
emailEmail to check eligibility for (required)
userIdUser ID to check eligibility for (optional)
Check invoice eligibility › Responses
Default Response
statusStart invoice purchase (POS)
Start an invoice-based purchase from POS. Creates a tab settlement and initiates payment via the invoice PSP.
Permissions: 🟢 invoices.create
Start invoice purchase (POS) › Request Body
tabIdTab UUID to pay
locationIdLocation ID
recipientIdInvoice recipient UUID
selectedKitchenDispatchItemIdsOptional: specific kitchen dispatch item IDs to pay. If omitted, pays all unpaid items.
voucherCodesOptional: voucher codes to apply to this payment.
Start invoice purchase (POS) › Responses
Default Response
statusGet unclaimed invoice purchases
Get purchases that were made with invoice payment but not yet assigned to an invoice.
Permissions: 🔵 invoices.read
query Parameters
locationIdLocation ID (required)
pagePage number
limitItems per page
Get unclaimed invoice purchases › Responses
Default Response
status