Create a customer

POST

customers

curl --request POST \
  --url https://api.togai.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
  "name": "ACME Enterprise",
  "primaryEmail": "admin@example.com",
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "settings": [
    {
      "id": "customerSettingId",
      "value": "INR",
      "namespace": "USER",
      "name": "Settings Name",
      "dataType": "STRING"
    }
  ],
  "account": {
    "id": "ACC00001",
    "name": "Primary Account",
    "invoiceCurrency": "USD",
    "aliases": [
      "acme_primary",
      "admin@example.com"
    ],
    "settings": [
      {
        "id": "accountSettingId",
        "value": "INR",
        "namespace": "USER",
        "name": "Settings Name",
        "dataType": "STRING"
      }
    ]
  }
}'

{
  "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
  "togaiCustomerId": "customer.dsvvre314.dcs314",
  "name": "ACME Enterprise",
  "primaryEmail": "admin@example.com",
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "settings": [
    {
      "id": "customerSettingId",
      "value": "INR",
      "namespace": "USER",
      "name": "Settings Name",
      "dataType": "STRING"
    }
  ],
  "account": {
    "id": "G234DZZKBKACATFFGVGEMERFH",
    "togaiAccountId": "account.safdla.c234ds",
    "customerId": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
    "togaiCustomerId": "customer.savass.11e1a",
    "name": "ACME Enterprise - Account",
    "invoiceCurrency": "USD",
    "status": "ACTIVE",
    "aliases": [
      {
        "alias": "G234DZZKBKACATFFGVGEMERFH",
        "status": "ACTIVE"
      }
    ],
    "settings": [
      {
        "id": "accountSettingId",
        "value": "INR",
        "namespace": "USER",
        "name": "Settings Name",
        "dataType": "STRING"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Payload to create customer

string

required

Customer identifier

Maximum length: 50

name

string

required

Name of the Customer

Required string length: 3 - 255

primaryEmail

string

required

Primary email of the customer

Maximum length: 320

address

object

required

billing address of the customer

settings

object[]

account

object

Payload to create account

account.id

string

required

Identifier of the account

Maximum length: 50

account.name

string

required

Name of the Account

Required string length: 3 - 255

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.

Required string length: 3

account.aliases

string[]

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

account.accountAliases

object[]

Aliases which effective range

account.address

object

billing address of the customer

account.primaryEmail

string

Primary email of the account

Maximum length: 320

account.billingInformation

object

Billing information of an account

account.settings

object[]

account.netTermDays

integer

Net term for the invoices of the account

account.metadata

object

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

account.tags

string[]

Tag for accounts are stored in lowercase

account.status

enum<string>

Status of the created account defaults to ACTIVE

Available options:

ACTIVE,

DRAFT

Response

201

application/json

Response for Create customer request

string

required

Identifier of customer

Maximum length: 50

togaiCustomerId

string

required

Unique identifier of customer

name

string

required

Name of the Customer

Required string length: 3 - 255

primaryEmail

string

required

Primary email of the customer

Maximum length: 320

billingAddress

string

address

object

billing address of the customer

settings

object[]

account

object

Structure of an account

account.id

string

required

Identifier of the account

Maximum length: 50

account.togaiAccountId

string

required

Unique identifier of the account

account.togaiCustomerId

string

required

Unique identifier of the customer

account.name

string

required

Name of the Account

Required string length: 3 - 255

account.customerId

string

required

Identifier of the customer

account.status

enum<string>

required

Status of the account

Available options:

ACTIVE,

DRAFT,

ARCHIVED

account.invoiceCurrency

string

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

Required string length: 3

account.aliases

object[]

list of aliases of the account

account.netTermDays

integer

account.address

object

billing address of the customer

account.primaryEmail

string

Primary email of the customer

Maximum length: 320

account.billingInformation

object

Billing information of an account

account.settings

object[]

account.invoiceGroupDetails

object

Invoice group details

account.metadata

object

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

account.tags

string[]

Tag for accounts are stored in lowercase

List customers Get a customer

curl --request POST \
  --url https://api.togai.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
  "name": "ACME Enterprise",
  "primaryEmail": "admin@example.com",
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "settings": [
    {
      "id": "customerSettingId",
      "value": "INR",
      "namespace": "USER",
      "name": "Settings Name",
      "dataType": "STRING"
    }
  ],
  "account": {
    "id": "ACC00001",
    "name": "Primary Account",
    "invoiceCurrency": "USD",
    "aliases": [
      "acme_primary",
      "admin@example.com"
    ],
    "settings": [
      {
        "id": "accountSettingId",
        "value": "INR",
        "namespace": "USER",
        "name": "Settings Name",
        "dataType": "STRING"
      }
    ]
  }
}'

{
  "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
  "togaiCustomerId": "customer.dsvvre314.dcs314",
  "name": "ACME Enterprise",
  "primaryEmail": "admin@example.com",
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "settings": [
    {
      "id": "customerSettingId",
      "value": "INR",
      "namespace": "USER",
      "name": "Settings Name",
      "dataType": "STRING"
    }
  ],
  "account": {
    "id": "G234DZZKBKACATFFGVGEMERFH",
    "togaiAccountId": "account.safdla.c234ds",
    "customerId": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
    "togaiCustomerId": "customer.savass.11e1a",
    "name": "ACME Enterprise - Account",
    "invoiceCurrency": "USD",
    "status": "ACTIVE",
    "aliases": [
      {
        "alias": "G234DZZKBKACATFFGVGEMERFH",
        "status": "ACTIVE"
      }
    ],
    "settings": [
      {
        "id": "accountSettingId",
        "value": "INR",
        "namespace": "USER",
        "name": "Settings Name",
        "dataType": "STRING"
      }
    ]
  }
}

Introduction

APIs

Authorizations

Body

Response