Get an invoice

Get an invoice

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.togai.com/invoices/{invoice_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.togai.com/invoices/{invoice_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.togai.com/invoices/{invoice_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/invoices/{invoice_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "inv.hkgkgyh.ghg",
  "sequenceId": "2020-07-2958",
  "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"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

GET

invoices

{invoice_id}

Get an invoice

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.togai.com/invoices/{invoice_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.togai.com/invoices/{invoice_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.togai.com/invoices/{invoice_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/invoices/{invoice_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "inv.hkgkgyh.ghg",
  "sequenceId": "2020-07-2958",
  "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"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

{
  "message": "<Reason message>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoice_id

string

required

Example:

"ACC001"

Response

Response for Get invoice requests

Structure of invoice

string

required

Identifier of invoice

Maximum string length: 50

status

enum<string>

required

Status of the invoice

Available options:

DRAFT,

DUE,

PAID,

VOID,

UN_COLLECTIBLE,

INITIATE_REFUND,

REFUND_COMPLETED,

MERGED,

PARTIALLY_PAID

Example:

"DUE"

invoiceClass

enum<string>

required

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

Available options:

INVOICE,

ORDER,

BILLABLE

Example:

"INVOICE"

invoiceType

enum<string>

required

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

Available options:

STANDARD,

AD_HOC,

COMPOSITE

Example:

"STANDARD"

invoiceDate

string<date-time>

required

Invoice date of the invoice

Example:

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

updatedAt

string<date-time>

required

customerId

string

ownerId

string

pricePlanId

string

usageInfo

object[]

Show child attributes

revenueInfo

object

Show child attributes

invoiceDetails

object

Show child attributes

startDate

string<date-time>

Start date of the invoice

Example:

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

endDate

string<date-time>

End date of the invoice

Example:

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

endDateInclusive

string<date-time>

Inclusive end date of the invoice

Example:

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

dueDate

string<date-time>

Due date of the invoice

Example:

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

generatedAt

string<date-time>

metadata

object

info

object[]

Show child attributes

sequenceId

string

Sequence id of the invoice

pdfUrl

string

Download URL of the pdf file corresponding to the invoice

List invoices Add or update miscellaneous charges in Invoice

Introduction

APIs

Authorizations

Path Parameters

Response