List invoices

GET

invoices

curl --request GET \
  --url https://api.togai.com/invoices \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "inv.hkgkgyh.ghg",
      "customerId": "7VcRw9xZDIqsC5E",
      "ownerId": "ACC001",
      "invoiceClass": "INVOICE",
      "invoiceType": "AD_HOC",
      "status": "DUE",
      "finalizingStatus": "FINALIZED",
      "totalAmount": 100,
      "paidAmount": 0,
      "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=="
}

Fields that can be searched on using _search query param

string

customer_id

string

account_id

string

customer_name

string

account_name

string

Fields with which the list response can be sorted using _sort query param

created_at

string

Default sort order:created_at DESC, id ASC

Authorizations

Authorization

string

header

required

Bearer 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.

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="

status

string

Filter option to filter by status.

owner_id

string

Filter option to filter based on owner id.

Example:

"ACC001"

customer_id

string

Filter option to filter based on customer id.

Example:

"1234"

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.

Example:

10

start_time

integer

Start time filter in epoch milli seconds

Example:

1650110402000

end_time

integer

End time filter in epoch milli seconds

Example:

1650110402000

Response

200

application/json

Success response

List invoices response

data

object[]

required

Structure of invoice response

data.id

string

required

Identifier of invoice

Maximum length: 50

data.status

enum<string>

required

Status of the invoice

Available options:

DRAFT,

DUE,

PAID,

VOID,

UN_COLLECTIBLE,

REFUND_INITIATED,

REFUND_COMPLETED,

MERGED,

PARTIALLY_PAID

data.invoiceClass

enum<string>

required

Represents the class of entity( INVOICE/ORDER/BILLABLE)

Available options:

INVOICE,

ORDER,

BILLABLE

data.invoiceType

enum<string>

required

Represents the type of entity(STANDARD/AD_HOC/COMPOSITE)

Available options:

STANDARD,

AD_HOC,

CUSTOM,

COMPOSITE,

STANDARD_ADVANCED,

ADHOC_ADVANCED

data.invoiceDate

string

required

Invoice date of the invoice

Example:

"2020-07-04T12:00:00.000Z"

data.updatedAt

string

required

data.totalAmount

number

required

data.paidAmount

number

required

data.netTermDays

integer

required

Number of days from the invoice date after which an invoice is considered overdue.

data.customerId

string

data.ownerId

string

data.pricePlanId

string

data.finalizingStatus

enum<string>

Available options:

FINALIZING,

FINALIZED

data.startDate

string

Start date of the invoice

Example:

"2020-07-04T12:00:00.000Z"

data.endDate

string

End date of the invoice

Example:

"2020-07-04T12:00:00.000Z"

data.endDateInclusive

string

Inclusive end date of the invoice

Example:

"2020-07-03T11:59:59.999Z"

data.dueDate

string

Due date of the invoice

Example:

"2020-07-04T12:00:00.000Z"

data.generatedAt

string

data.sequenceId

string

Sequence id of the invoice

data.pdfUrl

string

Download URL of the pdf file corresponding to the invoice

data.invoiceDetails

object

data.invoiceDetails.customer

object

data.invoiceDetails.account

object

data.invoiceDetails.pricePlanName

string

data.invoiceDetails.invoiceGroup

object

data.invoiceDetails.organization

object

data.invoiceDetails.logoUrl

string

nextToken

string

Maximum length: 500

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="

Credit balance for Account Get an invoice

curl --request GET \
  --url https://api.togai.com/invoices \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "inv.hkgkgyh.ghg",
      "customerId": "7VcRw9xZDIqsC5E",
      "ownerId": "ACC001",
      "invoiceClass": "INVOICE",
      "invoiceType": "AD_HOC",
      "status": "DUE",
      "finalizingStatus": "FINALIZED",
      "totalAmount": 100,
      "paidAmount": 0,
      "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=="
}

Introduction

APIs

Allowed filter combinations

Authorizations

Query Parameters

Response