Create a customer

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 customer

address

object

required

billing address of the customer

string

required

Customer identifier

Maximum length: 50

name

string

required

Name of the Customer

Required string length: 3 - 255

primaryEmail

string

required

Primary email of the customer

Maximum length: 320

account

object

Payload to create account

account.id

string

required

Identifier of the account

Maximum length: 50

account.name

string

required

Name of the Account

Required string length: 3 - 255

account.accountAliases

object[]

Aliases which effective range

account.address

object

billing address of the customer

account.aliases

string[]

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

account.billingInformation

object

Billing information of an account

account.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

account.metadata

object

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

account.netTermDays

integer

Net term for the invoices of the account

account.primaryEmail

string

Primary email of the account

Maximum length: 320

account.settings

object[]

account.status

enum<string>

Status of the created account defaults to ACTIVE

Available options:

ACTIVE,

DRAFT

account.tags

string[]

Tag for accounts are stored in lowercase

settings

object[]

Response

201 - application/json

string

required

Identifier of customer

Maximum length: 50

name

string

required

Name of the Customer

Required string length: 3 - 255

primaryEmail

string

required

Primary email of the customer

Maximum length: 320

togaiCustomerId

string

required

Unique identifier of customer

account

object

Structure of an account

account.customerId

string

required

Identifier of the customer

account.id

string

required

Identifier of the account

Maximum length: 50

account.name

string

required

Name of the Account

Required string length: 3 - 255

account.status

enum<string>

required

Status of the account

Available options:

ACTIVE,

DRAFT,

ARCHIVED

account.togaiAccountId

string

required

Unique identifier of the account

account.togaiCustomerId

string

required

Unique identifier of the customer

account.address

object

billing address of the customer

account.aliases

object[]

list of aliases of the account

account.billingInformation

object

Billing information of an account

account.invoiceCurrency

string

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

Required string length: 3

account.invoiceGroupDetails

object

Invoice group details

account.metadata

object

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

account.netTermDays

integer

account.primaryEmail

string

Primary email of the customer

Maximum length: 320

account.settings

object[]

account.tags

string[]

Tag for accounts are stored in lowercase

address

object

billing address of the customer

billingAddress

string

settings

object[]

Introduction

APIs

Authorizations

Body

Response