Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• id string

  Sales invoice ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• number string

  Invoice number filter

• date string(date)

  Date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• clientId string

  Client contact ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• reference string

  Internal reference filter

• description string

  Free-text description filter

• currency string

  Currency code filter

• netAmount string

  Net amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• totalAmount string

  Total amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• receivable string

  Receivable amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• status string

  Invoice status filter

  Values are OPEN, UNPAID, PAID, PARTIALLY_PAID, OVERDUE, or PRO_FORMA.

• ourContactName string

  Our contact (sales representative) name filter

• clientEmail string

  Client email filter

• clientECorrespondence boolean

  Whether the client uses e-correspondence

• hasWarnings boolean

  Whether the invoice has warnings

• qrGenerationAvailability boolean

  Whether QR-bill generation is available for the invoice

• validated boolean

  Whether the invoice is validated

• hasComments boolean

  Whether the invoice has comments

• isInWorkflow boolean

  Whether the invoice is currently part of an active workflow

• clientBillingEmail string

  Billing email address filter

• hasShipments boolean

  Whether the invoice has shipments

• isDocSent boolean

  Whether the invoice document has been sent to the client

• addressClientName string

  Client address name filter

• addressStreet string

  Client address street filter

• addressStreetPoBox string

  Client address P.O. box / street line 2 filter

• addressZipCode string

  Client address postal code filter

• addressCity string

  Client address city filter

• addressCountryCode string

  Client address ISO 3166-1 alpha-2 country code filter

• addressRegionCode string

  Client address region code filter

• addressToTheAttentionOf string

  Client address 'to the attention of' filter

• salesInvoiceLineId string

  Sales invoice line ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• invoiceLineDescription string

  Invoice line description filter

• invoiceLineSaleAccountId string

  Invoice line sale chart of accounts ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• invoiceLineTotalNet string

  Invoice line net total filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• invoiceLineVat string

  Invoice line VAT amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• invoiceLineTotalPrice string

  Invoice line total price filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• invoiceLineNetPrice string

  Invoice line net unit price filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• invoiceLineDepartmentId string

  Invoice line department ID filter.
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• invoiceLineArticleId string

  Invoice line article ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• invoiceLineAllocationKeys string

  Allocation rule name

• invoiceLineOfficeId string

  Invoice line office ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• paymentId string

  Payment ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• paymentReceivableByAccountId string

  Payment receivable-by chart of accounts ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• paymentRequestedDate string

  Payment requested date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• paymentOverdueDate string

  Payment overdue date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• paymentValueDate string

  Payment value date filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• paymentPaidAmount string

  Payment paid amount filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• paymentBankCharges string

  Payment bank charges filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• paymentLossOnDebtors string

  Payment loss on debtors filter.Supports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• paymentBvrQrNumber string

  Payment BVR-QR number filter

• specificBalanceSheetAccountId string

  Specific balance sheet chart of accounts ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• excludedFromVat boolean

  Whether the invoice is excluded from VAT reporting

• yourReference string

  Client's reference filter

• ourContactId string

  Our contact ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• openDate string(date-time)

  Open date filter.
  
  Used only when showOpenInvoices is set to true.
  
  

• showOpenInvoices boolean

  Show open invoices.
  
  Requires openDate when set to true.
  
  

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • organizationId integer(int64)
  • number string
  • date string(date-time)
  • client string
  • clientId integer(int64)
  • reference string
  • description string
  • referenceAndDescriptionJoined string
  • currency string
  • netAmount number
  • totalAmount number
  • receivable number
  • status string

    Values are OPEN, UNPAID, PAID, PARTIALLY_PAID, OVERDUE, or PRO_FORMA.

  • comments string
  • warnings string
  • ourContactName string
  • clientEmail string
  • clientAdvancedInvoicingNote string
  • clientECorrespondence boolean
  • hasWarnings boolean
  • bvrGenerationAvailability boolean
  • qrGenerationAvailability boolean
  • creatorContactId integer(int64)
  • validated boolean
  • workflowPermissions string
  • hasComments boolean
  • isInWorkflow boolean
  • systemValidated boolean
  • clientBillingEmail string
  • hasShipments boolean
  • isDocSent boolean
  • addressClientName string
  • addressStreet string
  • addressStreetPoBox string
  • addressZipCode string
  • addressCity string
  • addressCountryCode string
  • addressRegionCode string
  • addressToTheAttentionOf string
  • salesInvoiceLineId integer(int64)
  • invoiceLineDescription string
  • invoiceLineSaleAccountId integer(int64)
  • invoiceLineSaleAccountNumber integer(int64)
  • invoiceLineQuantity number
  • invoiceLineTotalNet number
  • invoiceLineVatPercent number
  • invoiceLineVat number
  • invoiceLineTotalPrice number
  • invoiceLineNetPrice number
  • invoiceLineDiscount number
  • invoiceLineDepartmentId integer(int64)
  • invoiceLineDepartmentName string
  • invoiceLineArticleId integer(int64)
  • invoiceLineArticleIdToDisplay string
  • invoiceLineAllocationKeys string
  • invoiceLineOfficeId integer(int64)
  • invoiceLineOfficeName string
  • paymentId integer(int64)
  • paymentReceivableByAccountNumber integer(int64)
  • paymentReceivableByAccountId integer(int64)
  • paymentRequestedDate string(date-time)
  • paymentOverdueDate string(date-time)
  • paymentValueDate string(date-time)
  • paymentRequestedCurrency string
  • paymentRequestedAmount number
  • paymentPaidCurrency string
  • paymentPaidAmount number
  • paymentBankCharges number
  • paymentLossOnDebtors number
  • paymentBvrNumber string
  • paymentQrNumber string
  • paymentBvrQrNumber string
  • specificBalanceSheetAccountId integer(int64)
  • vatCodeEntityId integer(int64)
  • excludedFromVat boolean
  • yourReference string
  • ourContactId integer(int64)
  • flagsAmount integer(int32)
  • inWorkflow boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error