Create 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": "[email protected]",
  "address": {
    "phoneNumber": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>"
  },
  "settings": [
    {
      "id": "<string>",
      "value": "<string>",
      "namespace": "<string>",
      "name": "<string>",
      "dataType": "STRING"
    }
  ],
  "account": {
    "id": "ACC00001",
    "name": "Primary Account",
    "invoiceCurrency": "<string>",
    "aliases": "acme_primary",
    "accountAliases": [
      {
        "value": "<string>",
        "effectiveFrom": "2023-11-07T05:31:56Z",
        "effectiveUntil": "2023-11-07T05:31:56Z"
      }
    ],
    "address": {
      "phoneNumber": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>"
    },
    "primaryEmail": "[email protected]",
    "billingInformation": {
      "emailRecipients": [
        "<string>"
      ],
      "additionalEmailRecipients": [
        "<string>"
      ]
    },
    "settings": [
      {
        "id": "<string>",
        "value": "<string>",
        "namespace": "<string>",
        "name": "<string>",
        "dataType": "STRING"
      }
    ],
    "netTermDays": 45,
    "metadata": {},
    "tags": [
      "<string>"
    ],
    "status": "ACTIVE"
  }
}
'

{
  "id": "<string>",
  "togaiCustomerId": "<string>",
  "name": "<string>",
  "primaryEmail": "<string>",
  "billingAddress": "<string>",
  "address": {
    "phoneNumber": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>"
  },
  "settings": [
    {
      "id": "<string>",
      "value": "<string>",
      "namespace": "<string>",
      "name": "<string>",
      "dataType": "STRING"
    }
  ],
  "account": {
    "id": "<string>",
    "togaiAccountId": "<string>",
    "togaiCustomerId": "<string>",
    "name": "<string>",
    "customerId": "<string>",
    "status": "ACTIVE",
    "invoiceCurrency": "USD",
    "aliases": [
      {
        "alias": "<string>"
      }
    ],
    "netTermDays": 123,
    "address": {
      "phoneNumber": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>"
    },
    "primaryEmail": "[email protected]",
    "billingInformation": {
      "emailRecipients": [
        "<string>"
      ],
      "additionalEmailRecipients": [
        "<string>"
      ]
    },
    "settings": [
      {
        "id": "<string>",
        "value": "<string>",
        "namespace": "<string>",
        "name": "<string>",
        "dataType": "STRING"
      }
    ],
    "invoiceGroupDetails": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "dailyInvoiceConsolidation": true,
      "invoiceCurrency": "<string>",
      "billingAddress": {
        "phoneNumber": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      },
      "netTermDays": 123
    },
    "metadata": {},
    "tags": [
      "<string>"
    ]
  }
}

POST

customers

Create 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": "[email protected]",
  "address": {
    "phoneNumber": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>"
  },
  "settings": [
    {
      "id": "<string>",
      "value": "<string>",
      "namespace": "<string>",
      "name": "<string>",
      "dataType": "STRING"
    }
  ],
  "account": {
    "id": "ACC00001",
    "name": "Primary Account",
    "invoiceCurrency": "<string>",
    "aliases": "acme_primary",
    "accountAliases": [
      {
        "value": "<string>",
        "effectiveFrom": "2023-11-07T05:31:56Z",
        "effectiveUntil": "2023-11-07T05:31:56Z"
      }
    ],
    "address": {
      "phoneNumber": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>"
    },
    "primaryEmail": "[email protected]",
    "billingInformation": {
      "emailRecipients": [
        "<string>"
      ],
      "additionalEmailRecipients": [
        "<string>"
      ]
    },
    "settings": [
      {
        "id": "<string>",
        "value": "<string>",
        "namespace": "<string>",
        "name": "<string>",
        "dataType": "STRING"
      }
    ],
    "netTermDays": 45,
    "metadata": {},
    "tags": [
      "<string>"
    ],
    "status": "ACTIVE"
  }
}
'

{
  "id": "<string>",
  "togaiCustomerId": "<string>",
  "name": "<string>",
  "primaryEmail": "<string>",
  "billingAddress": "<string>",
  "address": {
    "phoneNumber": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>"
  },
  "settings": [
    {
      "id": "<string>",
      "value": "<string>",
      "namespace": "<string>",
      "name": "<string>",
      "dataType": "STRING"
    }
  ],
  "account": {
    "id": "<string>",
    "togaiAccountId": "<string>",
    "togaiCustomerId": "<string>",
    "name": "<string>",
    "customerId": "<string>",
    "status": "ACTIVE",
    "invoiceCurrency": "USD",
    "aliases": [
      {
        "alias": "<string>"
      }
    ],
    "netTermDays": 123,
    "address": {
      "phoneNumber": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>"
    },
    "primaryEmail": "[email protected]",
    "billingInformation": {
      "emailRecipients": [
        "<string>"
      ],
      "additionalEmailRecipients": [
        "<string>"
      ]
    },
    "settings": [
      {
        "id": "<string>",
        "value": "<string>",
        "namespace": "<string>",
        "name": "<string>",
        "dataType": "STRING"
      }
    ],
    "invoiceGroupDetails": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "dailyInvoiceConsolidation": true,
      "invoiceCurrency": "<string>",
      "billingAddress": {
        "phoneNumber": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      },
      "netTermDays": 123
    },
    "metadata": {},
    "tags": [
      "<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 string length: 50

Example:

"01BX5ZZKBKACTAV9WEVGEMMVRZ"

name

string

required

Name of the Customer

Required string length: 3 - 255

Example:

"ACME Enterprise"

primaryEmail

string

required

Primary email of the customer

Maximum string length: 320

Example:

"[email protected]"

address

object

required

billing address of the customer

Show child attributes

address.phoneNumber

string

Contact number

address.line1

string

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

address.line2

string

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

address.postalCode

string

ZIP or postal code

address.city

string

City, district, suburb, town or village

address.state

string

State, county, province or region

address.country

string

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

settings

object[]

Maximum array length: 10

Show child attributes

settings.id

string

required

settings.value

string

required

settings.namespace

string

required

settings.name

string

required

settings.dataType

enum<string>

required

Available options:

STRING,

NUMERIC,

JSON,

JSON_LOGIC

account

object

Payload to create account

Show child attributes

account.id

string

required

Identifier of the account

Maximum string length: 50

Example:

"ACC00001"

account.name

string

required

Name of the Account

Required string length: 3 - 255

Example:

"Primary Account"

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.

Maximum array length: 10

Required string length: 3 - 50

Example:

"acme_primary"

account.accountAliases

object[]

Aliases which effective range

Show child attributes

account.accountAliases.value

string

required

Required string length: 1 - 50

account.accountAliases.effectiveFrom

string<date-time>

Effective from date, if not provided, it will be set to -infinity

account.accountAliases.effectiveUntil

string<date-time>

Effective until date, if not provided, it will be set to +infinity

account.address

object

billing address of the customer

Show child attributes

account.address.phoneNumber

string

Contact number

account.address.line1

string

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

account.address.line2

string

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

account.address.postalCode

string

ZIP or postal code

account.address.city

string

City, district, suburb, town or village

account.address.state

string

State, county, province or region

account.address.country

string

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

account.primaryEmail

string

Primary email of the account

Maximum string length: 320

Example:

"[email protected]"

account.billingInformation

object

Billing information of an account

Show child attributes

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

account.billingInformation.additionalEmailRecipients

string[]

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

Maximum string length: 320

account.settings

object[]

Maximum array length: 10

Show child attributes

account.settings.id

string

required

account.settings.value

string

required

account.settings.namespace

string

required

account.settings.name

string

required

account.settings.dataType

enum<string>

required

Available options:

STRING,

NUMERIC,

JSON,

JSON_LOGIC

account.netTermDays

integer<int32>

Net term for the invoices of the account

Example:

45

account.metadata

object

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

Show child attributes

account.metadata.{key}

string

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

Response for Create customer request

string

required

Identifier of customer

Maximum string 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 string length: 320

billingAddress

string

address

object

billing address of the customer

Show child attributes

address.phoneNumber

string

Contact number

address.line1

string

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

address.line2

string

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

address.postalCode

string

ZIP or postal code

address.city

string

City, district, suburb, town or village

address.state

string

State, county, province or region

address.country

string

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

settings

object[]

Maximum array length: 10

Show child attributes

settings.id

string

required

settings.value

string

required

settings.namespace

string

required

settings.name

string

required

settings.dataType

enum<string>

required

Available options:

STRING,

NUMERIC,

JSON,

JSON_LOGIC

account

object

Structure of an account

Show child attributes

account.id

string

required

Identifier of the account

Maximum string 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

Example:

"ACTIVE"

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

account.aliases

AccountAliases · object[]

list of aliases of the account

Maximum array length: 10

Show child attributes

account.aliases.alias

string

Maximum string length: 50

account.netTermDays

integer<int32>

account.address

object

billing address of the customer

Show child attributes

account.address.phoneNumber

string

Contact number

account.address.line1

string

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

account.address.line2

string

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

account.address.postalCode

string

ZIP or postal code

account.address.city

string

City, district, suburb, town or village

account.address.state

string

State, county, province or region

account.address.country

string

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

account.primaryEmail

string

Primary email of the customer

Maximum string length: 320

Example:

"[email protected]"

account.billingInformation

object

Billing information of an account

Show child attributes

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

account.billingInformation.additionalEmailRecipients

string[]

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

Maximum string length: 320

account.settings

object[]

Maximum array length: 10

Show child attributes

account.settings.id

string

required

account.settings.value

string

required

account.settings.namespace

string

required

account.settings.name

string

required

account.settings.dataType

enum<string>

required

Available options:

STRING,

NUMERIC,

JSON,

JSON_LOGIC

account.invoiceGroupDetails

object

Invoice group details

Show child attributes

account.invoiceGroupDetails.id

string

required

account.invoiceGroupDetails.name

string

required

account.invoiceGroupDetails.email

string

required

Maximum string length: 320

account.invoiceGroupDetails.dailyInvoiceConsolidation

boolean

required

account.invoiceGroupDetails.invoiceCurrency

string

required

account.invoiceGroupDetails.billingAddress

object

required

billing address of the customer

Show child attributes

account.invoiceGroupDetails.billingAddress.phoneNumber

string

Contact number

account.invoiceGroupDetails.billingAddress.line1

string

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

account.invoiceGroupDetails.billingAddress.line2

string

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

account.invoiceGroupDetails.billingAddress.postalCode

string

ZIP or postal code

account.invoiceGroupDetails.billingAddress.city

string

City, district, suburb, town or village

account.invoiceGroupDetails.billingAddress.state

string

State, county, province or region

account.invoiceGroupDetails.billingAddress.country

string

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

account.invoiceGroupDetails.netTermDays

integer<int32>

account.metadata

object

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

Show child attributes

account.metadata.{key}

string

account.tags

string[]

Tag for accounts are stored in lowercase

List customers Get a customer

⌘I

Introduction

APIs

Create a customer

Authorizations

Body

Response