Invoices
List invoices
List invoices
GET
/
invoices
curl --request GET \
--url https://api.togai.com/invoices \
--header 'Authorization: <authorization>'
{
"data": [
{
"id": "inv.hkgkgyh.ghg",
"customerId": "7VcRw9xZDIqsC5E",
"accountId": "ACC001",
"status": "DUE",
"startDate": "2020-07-04T12:00:00.000Z",
"endDate": "2020-07-04T12:00:00.000Z",
"invoiceDate": "2020-07-04T12:00:00.000Z",
"generatedAt": "2020-07-04T12:00:00.000Z",
"updatedAt": "2020-07-04T12:00:00.000Z"
}
],
"nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
nextToken
string
Pagination token used as a marker to get records from next page.
status
string
Filter option to filter by status.
owner_id
string
Filter option to filter based on owner id.
customer_id
string
Filter option to filter based on customer id.
pageSize
integer
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_time
integer
Start time filter in epoch milli seconds
end_time
integer
End time filter in epoch milli seconds
Response
200 - application/json
data
object[]
requirednextToken
string
curl --request GET \
--url https://api.togai.com/invoices \
--header 'Authorization: <authorization>'
{
"data": [
{
"id": "inv.hkgkgyh.ghg",
"customerId": "7VcRw9xZDIqsC5E",
"accountId": "ACC001",
"status": "DUE",
"startDate": "2020-07-04T12:00:00.000Z",
"endDate": "2020-07-04T12:00:00.000Z",
"invoiceDate": "2020-07-04T12:00:00.000Z",
"generatedAt": "2020-07-04T12:00:00.000Z",
"updatedAt": "2020-07-04T12:00:00.000Z"
}
],
"nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="
}