Get an account

Get account information using customer_id and account_id.

GET /accounts/{account_id}

Get an account

cURL

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

200

{
  "id": "G234DZZKBKACATFFGVGEMERFI",
  "name": "ACME Enterprise - Account2",
  "invoiceCurrency": "USD",
  "address": {
    "phoneNumber": "[phone]",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "primaryEmail": "[e-mail]",
  "aliases": [
    {
      "alias": "[e-mail]",
      "status": "ACTIVE"
    },
    {
      "alias": "[phone]",
      "status": "ACTIVE"
    }
  ],
  "status": "ACTIVE"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

account_id · string · required

account_id corresponding to an account

Maximum string length: 50

Example:

"ACC00001"

Query Parameters

effectiveOn · string<date-time>

Example:

"2020-03-30T10:41:10.088499"

includeGroupDetails · boolean

Example:

true

Response

200

application/json

Response for Create and Get account requests

Structure of an account

id · string · required

Identifier of the account

Maximum string length: 50

name · string · required

Name of the Account

Required string length: 3 - 255

customerId · string · required

Identifier of the customer

invoiceCurrency · string · required

ISO_4217 code of the currency in which the account must be invoiced Defaults to Base currency.

Required string length: 3

Example:

"USD"

status · enum<string> · required

Status of the account

Available options: ACTIVE, ARCHIVED

Example:

"ACTIVE"

aliases · AccountAliases · object[]

list of aliases of the account

Maximum array length: 10

Show child attributes

address · object

billing address of the customer

Show child attributes

primaryEmail · string

Primary email of the customer

Maximum string length: 255

Example:

"[e-mail]"

settings · object[]

Maximum array length: 10

Show child attributes

invoiceGroupDetails · object

Invoice group details

Show child attributes

metadata · object

Additional information associated with the account. Example: GSTN, VATN

Show child attributes