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

• addressClientName string
• addressStreet string
• addressStreetPoBox string
• addressZipCode string
• addressCity string
• addressCountryCode string
• addressRegionCode string
• addressToTheAttentionOf string
• salesInvoiceLineId string
• invoiceLineDescription string
• invoiceLineSaleAccountId string
• invoiceLineTotalNet
• invoiceLineVat
• invoiceLineTotalPrice
• invoiceLineNetPrice
• invoiceLineDepartmentId

  Invoice Line Department IDs filter.
  
  Supported values:

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

  Examples:

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

  Allocation rule name

• invoiceLineOfficeId string
• paymentId string
• paymentReceivableByAccountId string
• paymentRequestedDate

  Payment requested date filter.
  
  Supported operators:

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

  Examples:

  • 01/01/2026..31/21/2025
  • >=01/01/2026
  • <=01/01/2026
• paymentOverdueDate

  Payment overdue date filter.
  
  Supported operators:

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

  Examples:

  • 01/01/2026..31/21/2025
  • >=01/01/2026
  • <=01/01/2026
• paymentValueDate

  Payment value date filter.
  
  Supported operators:

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

  Examples:

  • 01/01/2026..31/21/2025
  • >=01/01/2026
  • <=01/01/2026
• paymentPaidAmount
• paymentBankCharges
• paymentLossOnDebtors
• paymentBvrQrNumber string
• specificBalanceSheetAccountId string
• excludedFromVat boolean
• yourReference string
• ourContactId string
• id string
• number string
• date

  Date filter.
  
  Supported operators:

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

  Examples:

  • 01/01/2026..31/21/2025
  • >=01/01/2026
  • <=01/01/2026
• clientId string
• reference string
• description string
• currency string
• netAmount

  Net amount filter.
  
  Supports comparison operators (for example: >100, <1000, <>0). Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• totalAmount

  Total amount filter.
  
  Supports comparison operators (for example: >100, <1000, <>0). Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• receivable

  Receivable amount filter.
  
  Supports comparison operators (for example: >100, <1000, <>0). Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• status string

  Multi-value supported. Example: value1;value2
  
  

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

• ourContactName string
• clientEmail string
• clientECorrespondence boolean
• hasWarnings boolean
• qrGenerationAvailability boolean
• validated boolean
• hasComments boolean
• isInWorkflow boolean
• clientBillingEmail string
• hasShipments boolean
• isDocSent boolean
• 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

  • count integer(int64)
  • totals object
    Hide totals attributes Show totals 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