Update an account

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"

Body

application/json

Payload to update account

name

string

Name of the Account

Required string length: 3 - 255

Example:

"ACME Enterprise"

status

enum<string>

Available options:

ACTIVE,

DRAFT

invoiceCurrency

string

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

Required string length: 3

Example:

"USD"

netTermDays

integer<int32>

primaryEmail

string

Primary email of the account

Maximum string length: 320

Example:

"[email protected]"

billingInformation

object

Billing information of an account

Show child attributes

billingInformation.emailRecipients

string[]

Emails in this array will be added in to: in mail. Primary email will be added if left blank.

Maximum string length: 320

billingInformation.additionalEmailRecipients

string[]

Emails in this array will be added in cc: in mail.

Maximum string length: 320

address

object

billing address of the customer

Show child attributes

address.phoneNumber

string

Contact number

address.line1

string

Address line 1 (eg. Street, PO Box, Company Name)

address.line2

string

Address line 2 (eg. apartment, suite, unit or building)

address.postalCode

string

ZIP or postal code

address.city

string

City, district, suburb, town or village

address.state

string

State, county, province or region

address.country

string

Two letter country code ISO-3166-1 Alpha-2

metadata

object

Additional information associated with the account. Example: GSTN, VATN NOTE: This replaces the existing metadata if the metadata in the request is not null. To remove all existing metadata, use empty object

Show child attributes

metadata.{key}

string

Response

Response for Create and Get account requests

Structure of an account

string

required

Identifier of the account

Maximum string 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

Example:

"ACTIVE"

invoiceCurrency

string

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

Required string length: 3

Example:

"USD"

aliases

AccountAliases · object[]

list of aliases of the account

Maximum array length: 10

Show child attributes

aliases.alias

string

Maximum string length: 50

netTermDays

integer<int32>

address

object

billing address of the customer

Show child attributes

address.phoneNumber

string

Contact number

address.line1

string

Address line 1 (eg. Street, PO Box, Company Name)

address.line2

string

Address line 2 (eg. apartment, suite, unit or building)

address.postalCode

string

ZIP or postal code

address.city

string

City, district, suburb, town or village

address.state

string

State, county, province or region

address.country

string

Two letter country code ISO-3166-1 Alpha-2

primaryEmail

string

Primary email of the customer

Maximum string length: 320

Example:

"[email protected]"

billingInformation

object

Billing information of an account

Show child attributes

billingInformation.emailRecipients

string[]

Emails in this array will be added in to: in mail. Primary email will be added if left blank.

Maximum string length: 320

billingInformation.additionalEmailRecipients

string[]

Emails in this array will be added in cc: in mail.

Maximum string length: 320

settings

object[]

Maximum array length: 10

Show child attributes

settings.id

string

required

settings.value

string

required

settings.namespace

string

required

settings.name

string

required

settings.dataType

enum<string>

required

Available options:

STRING,

NUMERIC,

JSON,

JSON_LOGIC

invoiceGroupDetails

object

Invoice group details

Show child attributes

invoiceGroupDetails.id

string

required

invoiceGroupDetails.name

string

required

invoiceGroupDetails.email

string

required

Maximum string length: 320

invoiceGroupDetails.dailyInvoiceConsolidation

boolean

required

invoiceGroupDetails.invoiceCurrency

string

required

invoiceGroupDetails.billingAddress

object

required

billing address of the customer

Show child attributes

invoiceGroupDetails.billingAddress.phoneNumber

string

Contact number

invoiceGroupDetails.billingAddress.line1

string

Address line 1 (eg. Street, PO Box, Company Name)

invoiceGroupDetails.billingAddress.line2

string

Address line 2 (eg. apartment, suite, unit or building)

invoiceGroupDetails.billingAddress.postalCode

string

ZIP or postal code

invoiceGroupDetails.billingAddress.city

string

City, district, suburb, town or village

invoiceGroupDetails.billingAddress.state

string

State, county, province or region

invoiceGroupDetails.billingAddress.country

string

Two letter country code ISO-3166-1 Alpha-2

invoiceGroupDetails.netTermDays

integer<int32>

metadata

object

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

Show child attributes

metadata.{key}

string

Introduction

APIs

Authorizations

Path Parameters

Body

Response