POST
/
accounts

Authorizations

Authorization
string
headerrequired

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

Body

application/json

Payload to create account

id
string
required

Identifier of the account

Maximum length: 50
name
string
required

Name of the Account

Required string length: 3 - 255
customerId
string
required

Customer Identifier for whom the account is being created

Required string length: 1 - 255
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.

accountAliases
object[]

Aliases which effective range

address
object

billing address of the customer

primaryEmail
string

Primary email of the account

Maximum length: 320
settings
object[]
netTermDays
integer

Net term for the invoices of the account

metadata
object

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

tags
string[]

Tag for accounts are stored in lowercase

status
enum<string>

Status of the created account defaults to ACTIVE

Available options:
ACTIVE,
DRAFT

Response

201 - application/json

Structure of an account

id
string
required

Identifier of the account

Maximum length: 50
togaiAccountId
string
required

Unique identifier of the account

togaiCustomerId
string
required

Unique identifier of the customer

name
string
required

Name of the Account

Required string length: 3 - 255
customerId
string
required

Identifier of the customer

status
enum<string>
required

Status of the account

Available options:
ACTIVE,
DRAFT,
ARCHIVED
invoiceCurrency
string

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

Required string length: 3
aliases
object[]

list of aliases of the account

netTermDays
integer
address
object

billing address of the customer

primaryEmail
string

Primary email of the customer

Maximum length: 320
settings
object[]
invoiceGroupDetails
object

Invoice group details

metadata
object

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

tags
string[]

Tag for accounts are stored in lowercase