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.
  
  Multi-value supported. Example: value1;value2
  
  

• number string

  Invoice number filter

• date string

  Invoice date filterSupports 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.
  
  

• reference string

  Invoice reference filter

• netAmount string

  Net amount filterSupports 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 filterSupports 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 filterSupports 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.

• orderId string

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

• type string

  Invoice type filter

  Values are PREPAYMENT, PARTIAL, or FINAL.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • number string
  • date string(date-time)
  • reference string
  • netAmount number
  • totalAmount number
  • receivable number
  • status string

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

  • invoicedPercent number
  • orderId integer(int64)
  • organizationId integer(int64)
  • entityCreatorContactId integer(int64)
  • type string

    Values are PREPAYMENT, PARTIAL, or FINAL.

  • tenantId integer(int64)
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error