PATCH
/
accounts
/
{account_id}

Authorizations

Authorization
string
headerrequired

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 length: 50

Body

application/json

Payload to update account

name
string

Name of the Account

Required string length: 3 - 255
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
netTermDays
integer
primaryEmail
string

Primary email of the account

Maximum length: 320
address
object

billing address of the customer

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

tags
string[]

Tag for accounts are stored in lowercase

Response

200 - 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