Skip to main content
GET
/
api
/
v1
/
Finances
/
invoices
Gets a list of Invoices based on a query
curl --request GET \
  --url https://api.example.com/api/v1/Finances/invoices \
  --header 'Authorization: <api-key>'
{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    {
      "invoiceNumber": "<string>",
      "customerName": "<string>",
      "accountNumber": "<string>",
      "invoiceType": "<string>",
      "orderCount": 123,
      "invoiceDate": "2023-11-07T05:31:56Z",
      "classInvoiceAmount": 123,
      "totalInvoiceAmount": 123,
      "paymentsReceived": 123,
      "balanceDue": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Query Parameters

​
accountNumber
string
required

The customer's account number

​
invoiceType
string

The invoice type to search for

DIRECT 
    STORAGE 
    RETURNS 
    CARRIER 
    OUT
​
invoiceNumber
string

A specific invoice number

​
searchStartDate
string<date-time>
required

The beginning date of the search range

YYYY-MM-DD
​
searchEndDate
string<date-time>
required

The ending date of the search range

YYYY-MM-DD

Response

200 - application/json

Returns the list of Invoices

Generic container for all service responses

​
isSuccess
boolean

Was the request successful. If not, the message will have more information.

​
message
string | null

Any error message

​
payload
object[] | null

The payload object of the response