PATCH
/
accounts
/
{account_id}

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

Body

application/json

Payload to update account

address
object

billing address of the customer

billingInformation
object

Billing information of an account

invoiceCurrency
string

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

Required string length: 3
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

name
string

Name of the Account

Required string length: 3 - 255
netTermDays
integer
primaryEmail
string

Primary email of the account

Maximum length: 320
status
enum<string>
Available options:
ACTIVE,
DRAFT
tags
string[]

Tag for accounts are stored in lowercase

Response

200 - application/json

Structure of an account

customerId
string
required

Identifier of the customer

id
string
required

Identifier of the account

Maximum length: 50
name
string
required

Name of the Account

Required string length: 3 - 255
status
enum<string>
required

Status of the account

Available options:
ACTIVE,
DRAFT,
ARCHIVED
togaiAccountId
string
required

Unique identifier of the account

togaiCustomerId
string
required

Unique identifier of the customer

address
object

billing address of the customer

aliases
object[]

list of aliases of the account

billingInformation
object

Billing information of an account

invoiceCurrency
string

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

Required string length: 3
invoiceGroupDetails
object

Invoice group details

metadata
object

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

netTermDays
integer
primaryEmail
string

Primary email of the customer

Maximum length: 320
settings
object[]
tags
string[]

Tag for accounts are stored in lowercase