Invoices
Get an invoice
Get invoice
GET
/
invoices
/
{invoice_id}
curl --request GET \
--url https://api.togai.com/invoices/{invoice_id} \
--header 'Authorization: <authorization>'
{
"id": "inv.hkgkgyh.ghg",
"customerId": "7VcRw9xZDIqsC5E",
"accountId": "ACC001",
"usageInfo": [
{
"description": "rides - local",
"type": "USAGE_METER_USAGE",
"value": 15,
"units": "USAGE_UNITS"
},
{
"description": "rides - pro",
"type": "USAGE_METER_USAGE",
"value": 5,
"units": "USAGE_UNITS"
}
],
"revenueInfo": {
"description": "Total amount due",
"type": "NET_REVENUE",
"units": "USD",
"value": 881.94,
"lineItems": [
{
"description": "Sum Total",
"type": "GROSS_REVENUE",
"units": "USD",
"value": 981.94,
"lineItems": [
{
"description": "Payout_NEFT",
"type": "USAGE_RATE_CARD_REVENUE",
"units": "USD",
"value": 392.1,
"lineItems": [
{
"description": "Slab 1",
"type": "USAGE_RATE_CARD_SLAB_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 10000,
"units": "USD",
"value": 10
},
{
"description": "Slab 2",
"type": "USAGE_RATE_CARD_SLAB_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 10000,
"units": "USD",
"value": 10
}
]
},
{
"description": "Payout IMPS",
"type": "USAGE_RATE_CARD_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 32109,
"units": "USD",
"value": 589.94,
"lineItems": [
{
"description": "Slab 1",
"type": "USAGE_RATE_CARD_SLAB_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 10000,
"units": "USD",
"value": 10
},
{
"description": "Slab 2",
"type": "USAGE_RATE_CARD_SLAB_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 10000,
"units": "USD",
"value": 10
}
]
}
]
}
]
},
"invoiceDetails": {
"customer": {
"name": "John Doe",
"primaryEmail": "john@togai.com",
"billingAddress": {
"line1": "2281 Broadway Street",
"line2": "G-31",
"postalCode": "29501",
"city": "Florence",
"state": "South Carolina",
"country": "US"
}
},
"account": {
"name": "Togai",
"invoiceCurrency": "USD"
},
"pricePlanName": "Togai Basic"
},
"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"
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
invoice_id
string
requiredResponse
200 - application/json
id
string
requiredIdentifier of customer
customerId
string
ownerId
string
pricePlanId
string
usageInfo
object[]
revenueInfo
object
invoiceDetails
object
status
enum<string>
requiredStatus of the invoice
Available options:
DRAFT
, DUE
, PAID
, VOID
, UN_COLLECTIBLE
, INITIATE_REFUND
, REFUND_COMPLETED
, MERGED
invoiceClass
enum<string>
requiredRepresents the class of entity( INVOICE/ORDER/BILLABLE)
Available options:
INVOICE
, ORDER
, BILLABLE
invoiceType
enum<string>
requiredRepresents the type of entity(STANDARD/AD_HOC/COMPOSITE)
Available options:
STANDARD
, AD_HOC
, COMPOSITE
startDate
string
Start date of the invoice
endDate
string
End date of the invoice
invoiceDate
string
requiredInvoice date of the invoice
dueDate
string
Due date of the invoice
generatedAt
string
updatedAt
string
requiredmetadata
object
curl --request GET \
--url https://api.togai.com/invoices/{invoice_id} \
--header 'Authorization: <authorization>'
{
"id": "inv.hkgkgyh.ghg",
"customerId": "7VcRw9xZDIqsC5E",
"accountId": "ACC001",
"usageInfo": [
{
"description": "rides - local",
"type": "USAGE_METER_USAGE",
"value": 15,
"units": "USAGE_UNITS"
},
{
"description": "rides - pro",
"type": "USAGE_METER_USAGE",
"value": 5,
"units": "USAGE_UNITS"
}
],
"revenueInfo": {
"description": "Total amount due",
"type": "NET_REVENUE",
"units": "USD",
"value": 881.94,
"lineItems": [
{
"description": "Sum Total",
"type": "GROSS_REVENUE",
"units": "USD",
"value": 981.94,
"lineItems": [
{
"description": "Payout_NEFT",
"type": "USAGE_RATE_CARD_REVENUE",
"units": "USD",
"value": 392.1,
"lineItems": [
{
"description": "Slab 1",
"type": "USAGE_RATE_CARD_SLAB_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 10000,
"units": "USD",
"value": 10
},
{
"description": "Slab 2",
"type": "USAGE_RATE_CARD_SLAB_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 10000,
"units": "USD",
"value": 10
}
]
},
{
"description": "Payout IMPS",
"type": "USAGE_RATE_CARD_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 32109,
"units": "USD",
"value": 589.94,
"lineItems": [
{
"description": "Slab 1",
"type": "USAGE_RATE_CARD_SLAB_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 10000,
"units": "USD",
"value": 10
},
{
"description": "Slab 2",
"type": "USAGE_RATE_CARD_SLAB_REVENUE",
"valuePerQuantity": 0.001,
"quantity": 10000,
"units": "USD",
"value": 10
}
]
}
]
}
]
},
"invoiceDetails": {
"customer": {
"name": "John Doe",
"primaryEmail": "john@togai.com",
"billingAddress": {
"line1": "2281 Broadway Street",
"line2": "G-31",
"postalCode": "29501",
"city": "Florence",
"state": "South Carolina",
"country": "US"
}
},
"account": {
"name": "Togai",
"invoiceCurrency": "USD"
},
"pricePlanName": "Togai Basic"
},
"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"
}