List accounts of customer

Query Parameters

account_id

string

Unique identifier of the account

customer_id

string

Unique identifier of the customer corresponding to the account

status

enum

Status of the account (`ACTIVE`, `ARCHIVED`)

invoice_currency

string

Currency in which the account is invoiced (`USD`, `EUR`, `INR`…)

Filterable Fields

account_id

string

customer_id

string

status

string

invoice_currency

string

Allowed filter combinations

account_id
customer_id
status
invoice_currency
customer_id, status

Searchable Fields

Fields that can be searched on using _search query param

account_id

string

name

string

primary_email

string

Sortable Fields

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

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

pageSize

number

Example:

10

Response

Response for list customers request

data

object[]

Show child attributes

data.id

string

required

Identifier of the account

Maximum string length: 50

data.togaiAccountId

string

required

Unique identifier of the account

data.togaiCustomerId

string

required

Unique identifier of the customer

data.name

string

required

Name of the Account

Required string length: 3 - 255

data.customerId

string

required

Identifier of the customer

data.status

enum<string>

required

Status of the account

Available options:

ACTIVE,

DRAFT,

ARCHIVED

Example:

"ACTIVE"

data.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"

data.aliases

AccountAliases · object[]

list of aliases of the account

Maximum array length: 10

Show child attributes

data.aliases.alias

string

Maximum string length: 50

data.netTermDays

integer<int32>

data.address

object

billing address of the customer

Show child attributes

data.address.phoneNumber

string

Contact number

data.address.line1

string

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

data.address.line2

string

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

data.address.postalCode

string

ZIP or postal code

data.address.city

string

City, district, suburb, town or village

data.address.state

string

State, county, province or region

data.address.country

string

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

data.primaryEmail

string

Primary email of the customer

Maximum string length: 320

Example:

"[email protected]"

data.billingInformation

object

Billing information of an account

Show child attributes

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

data.billingInformation.additionalEmailRecipients

string[]

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

Maximum string length: 320

data.settings

object[]

Maximum array length: 10

Show child attributes

data.settings.id

string

required

data.settings.value

string

required

data.settings.namespace

string

required

data.settings.name

string

required

data.settings.dataType

enum<string>

required

Available options:

STRING,

NUMERIC,

JSON,

JSON_LOGIC

data.invoiceGroupDetails

object

Invoice group details

Show child attributes

data.invoiceGroupDetails.id

string

required

data.invoiceGroupDetails.name

string

required

data.invoiceGroupDetails.email

string

required

Maximum string length: 320

data.invoiceGroupDetails.dailyInvoiceConsolidation

boolean

required

data.invoiceGroupDetails.invoiceCurrency

string

required

data.invoiceGroupDetails.billingAddress

object

required

billing address of the customer

Show child attributes

data.invoiceGroupDetails.billingAddress.phoneNumber

string

Contact number

data.invoiceGroupDetails.billingAddress.line1

string

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

data.invoiceGroupDetails.billingAddress.line2

string

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

data.invoiceGroupDetails.billingAddress.postalCode

string

ZIP or postal code

data.invoiceGroupDetails.billingAddress.city

string

City, district, suburb, town or village

data.invoiceGroupDetails.billingAddress.state

string

State, county, province or region

data.invoiceGroupDetails.billingAddress.country

string

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

data.invoiceGroupDetails.netTermDays

integer<int32>

data.metadata

object

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

Show child attributes

data.metadata.{key}

string

data.tags

string[]

Tag for accounts are stored in lowercase

nextToken

string

context

object

Show child attributes

context.pageSize

integer

context.sortOrder

enum<string>

Available options:

ASC,

DESC

Introduction

APIs

Allowed filter combinations

Authorizations

Query Parameters

Response