List accounts of customer

Fields that can be searched on using _search query param

account_id

string

name

string

primary_email

string

Fields with which the list response can be sorted using _sort query param

account_id

string

updated_at

string

Default sort order:updated_at DESC, account_id ASC

Authorizations

Authorization

string

header

required

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

Query Parameters

nextToken

string

pageSize

number

Response

200 - application/json

context

object

data

object[]

data.customerId

string

required

Identifier of the customer

data.id

string

required

Identifier of the account

Maximum length: 50

data.name

string

required

Name of the Account

Required string length: 3 - 255

data.status

enum<string>

required

Status of the account

Available options:

ACTIVE,

DRAFT,

ARCHIVED

data.togaiAccountId

string

required

Unique identifier of the account

data.togaiCustomerId

string

required

Unique identifier of the customer

data.address

object

billing address of the customer

data.aliases

object[]

list of aliases of the account

data.billingInformation

object

Billing information of an account

data.invoiceCurrency

string

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

Required string length: 3

data.invoiceGroupDetails

object

Invoice group details

data.metadata

object

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

data.netTermDays

integer

data.primaryEmail

string

Primary email of the customer

Maximum length: 320

data.settings

object[]

data.tags

string[]

Tag for accounts are stored in lowercase

nextToken

string

Introduction

APIs

Allowed filter combinations

Authorizations

Query Parameters

Response