v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB

Invoices

List invoices eligible for bill run

get/invoices/bill_runs

Query parameters

nextTokenstring

Example:eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==

Pagination token used as a marker to get records from next page.

statusstring

Filter option to filter by status.

owner_idstring

Example:ACC001

Filter option to filter based on owner id.

customer_idstring

Example:1234

Filter option to filter based on customer id.

pageSizeinteger

Example:10

Maximum page size expected by client to return the record list.

NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

start_timeinteger

Example:1650110402000

Start time filter in epoch milli seconds

end_timeinteger

Example:1650110402000

End time filter in epoch milli seconds

Response

Response for Get invoice requests

nextTokenstring

Example response

{
  "data": [
    {
      "startDate": "2020-07-04T12:00:00.000Z",
      "endDate": "2020-07-04T12:00:00.000Z",
      "endDateInclusive": "2020-07-03T11:59:59.999Z",
      "invoiceDate": "2020-07-04T12:00:00.000Z",
      "dueDate": "2020-07-04T12:00:00.000Z"
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="
}