Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Invoice

List invoices

Returns a collection with all invoices.

get/api/v1/invoices

Query parameters

key'search' | 'id' | 'invoice' | 'date' | 'status' | 'customerName' | 'customerNumber' | 'country' | 'projectId' | 'projectName' | 'projectAbbr' | 'paymentMethod' | 'paymentStatus' | 'debit' | 'balance' | 'currency' | 'shippingMethod' | 'amountNet' | 'salesOrder' | 'dunningLevel' | 'updatedAt'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'

The following filter key values are available:

id (string): Invoice ID

invoice (string): Invoice Number

date (date): accepted format: Y-m-d, example 2024-10-15

status (string): created released sent canceled completed partialCancellation

customerName (string): first and last name of the Customer

customerNumber (string): Customer Number

country (string): Country Codes Alpha-2

projectId (string): Project ID

projectName (string): Project Name

projectAbbr (string): Project Abbreviation

paymentMethod (string): Payment Method

paymentStatus (string): pending paid partlyPaid canceled partialCancellation badDebt debited

debit (numeric): Debit, example: 10.50

balance (numeric): Balance, example: 10.50

currency (string): Currency ISO 4217 format, example EUR

shippingMethod (string): Shipping Method

amountNet (numeric): net amount of the Invoice, example: 10.50

salesOrder (string): Sales Order ID

updatedAt (string): format: date-time : Sales updatedat, example: 2022-09-13T12:41:18+02:00

[
  {
    "key": "date"
  }
]
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'invoice' | 'date' | 'customerName' | 'customerNumber' | 'country' | 'project' | 'paymentMethod' | 'debit' | 'currency' | 'paymentStatus' | 'balance' | 'status' | 'shippingMethod' | 'amountNet' | 'dunningDate'
dir'asc' | 'desc'

Response

Operation completed successfully.