POST
/
accounts
curl --request POST \
  --url https://api.togai.com/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "ACC00001",
  "name": "Primary Account",
  "customerId": "C1234qwd",
  "aliases": [
    "acme_primary",
    "acme_1"
  ],
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "primaryEmail": "admin@example.com",
  "settings": [
    {
      "id": "accountSettingId",
      "value": "INR",
      "namespace": "USER",
      "name": "Settings Name",
      "dataType": "STRING"
    }
  ],
  "netTermDays": 45
}'
{
  "id": "G234DZZKBKACATFFGVGEMERFI",
  "togaiAccountId": "account.safdla.c234ds",
  "customerId": "ACME",
  "togaiCustomerId": "customer.savass.11e1a",
  "name": "ACME Enterprise - Account2",
  "invoiceCurrency": "USD",
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "primaryEmail": "admin@example.com",
  "aliases": [
    {
      "alias": "account2@acme.com"
    },
    {
      "alias": "+1234567890"
    }
  ],
  "status": "ACTIVE"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
id
string
required

Identifier of the account

name
string
required

Name of the Account

invoiceCurrency
string

Use ISO 4217 currency code in which the account must be invoiced.
For example: AED is the currency code for United Arab Emirates dirham.

aliases
string[]

Aliases are tags that are associated with an account. Multiple aliases are allowed for a single account.

accountAliases
object[]

Aliases which effective range

address
object

billing address of the customer

primaryEmail
string

Primary email of the account

settings
object[]
netTermDays
integer

Net term for the invoices of the account

metadata
object

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

tags
string[]

Tag for accounts are stored in lowercase

status
enum<string>

Status of the created account defaults to ACTIVE

Available options:
ACTIVE,
DRAFT
customerId
string
required

Customer Identifier for whom the account is being created

Response

201 - application/json
id
string
required

Identifier of the account

togaiAccountId
string
required

Unique identifier of the account

togaiCustomerId
string
required

Unique identifier of the customer

name
string
required

Name of the Account

customerId
string
required

Identifier of the customer

invoiceCurrency
string

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

aliases
object[]

list of aliases of the account

netTermDays
integer
address
object

billing address of the customer

primaryEmail
string

Primary email of the customer

status
enum<string>
required

Status of the account

Available options:
ACTIVE,
DRAFT,
ARCHIVED
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