Skip to main content
POST
/
accounts
Create an account
curl --request POST \
  --url https://api.togai.com/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "ACC00001",
  "name": "Primary Account",
  "customerId": "C1234qwd",
  "aliases": [
    "acme_primary",
    "acme_1"
  ],
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "primaryEmail": "admin@example.com",
  "settings": [
    {
      "id": "accountSettingId",
      "value": "INR",
      "namespace": "USER",
      "name": "Settings Name",
      "dataType": "STRING"
    }
  ],
  "netTermDays": 45
}
'
{
  "id": "G234DZZKBKACATFFGVGEMERFI",
  "name": "ACME Enterprise - Account2",
  "invoiceCurrency": "USD",
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "primaryEmail": "admin@example.com",
  "aliases": [
    {
      "alias": "account2@acme.com",
      "status": "ACTIVE"
    },
    {
      "alias": "+1234567890",
      "status": "ACTIVE"
    }
  ],
  "status": "ACTIVE"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Payload to create account

Payload to create account

​
id
string
required

Identifier of the account

Maximum string length: 50
Example:

"ACC00001"

​
name
string
required

Name of the Account

Required string length: 3 - 255
Example:

"Primary Account"

​
customerId
string
required

Customer Identifier for whom the account is being created

Required string length: 1 - 255
Example:

"C1234ewf"

​
invoiceCurrency
string

Use ISO 4217 currency code in which the account must be invoiced.
For example: AED is the currency code for United Arab Emirates dirham.

Required string length: 3
​
aliases
string[]

Aliases are tags that are associated with an account. Multiple aliases are allowed for a single account.

Maximum array length: 10
Required string length: 3 - 50
Example:

"acme_primary"

​
accountAliases
object[]

Aliases which effective range

​
address
object

billing address of the customer

​
primaryEmail
string

Primary email of the account

Maximum string length: 255
Example:

"admin@example.com"

​
settings
object[]
Maximum array length: 10
​
netTermDays
integer<int32>

Net term for the invoices of the account

Example:

45

​
metadata
object

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

Response

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
​
address
object

billing address of the customer

​
primaryEmail
string

Primary email of the customer

Maximum string length: 255
Example:

"admin@example.com"

​
settings
object[]
Maximum array length: 10
​
invoiceGroupDetails
object

Invoice group details

​
metadata
object

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