List Invoice Groups

curl --request GET \
  --url https://api.togai.com/invoice_groups \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "inv_group.20rvWRxQcQK.0ZwPG",
      "name": "Invoice Group 1",
      "email": "[email protected]",
      "dailyInvoiceConsolidation": true,
      "accountsCount": 2,
      "gracePeriod": 3,
      "netTermDays": 45,
      "invoiceCurrency": "USD",
      "billingAddress": {
        "phoneNumber": "+919876543210",
        "line1": "2281 Broadway Street",
        "line2": "G-31",
        "postalCode": "29501",
        "city": "Florence",
        "state": "South Carolina",
        "country": "US"
      },
      "createdAt": "2023-07-26T12:36:56.58015Z",
      "updatedAt": "2023-07-26T12:36:56.58015Z"
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

GET

invoice_groups

List Invoice Groups

curl --request GET \
  --url https://api.togai.com/invoice_groups \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "inv_group.20rvWRxQcQK.0ZwPG",
      "name": "Invoice Group 1",
      "email": "[email protected]",
      "dailyInvoiceConsolidation": true,
      "accountsCount": 2,
      "gracePeriod": 3,
      "netTermDays": 45,
      "invoiceCurrency": "USD",
      "billingAddress": {
        "phoneNumber": "+919876543210",
        "line1": "2281 Broadway Street",
        "line2": "G-31",
        "postalCode": "29501",
        "city": "Florence",
        "state": "South Carolina",
        "country": "US"
      },
      "createdAt": "2023-07-26T12:36:56.58015Z",
      "updatedAt": "2023-07-26T12:36:56.58015Z"
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

Authorizations

Authorization

string

header

required

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

Response

Response to get invoice group request

data

object[]

Show child attributes

data.id

string

required

data.name

string

required

data.email

string

required

Maximum string length: 320

data.dailyInvoiceConsolidation

boolean

required

data.invoiceCurrency

string

required

data.billingAddress

object

required

billing address of the customer

Show child attributes

data.billingAddress.phoneNumber

string

Contact number

data.billingAddress.line1

string

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

data.billingAddress.line2

string

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

data.billingAddress.postalCode

string

ZIP or postal code

data.billingAddress.city

string

City, district, suburb, town or village

data.billingAddress.state

string

State, county, province or region

data.billingAddress.country

string

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

data.accountsCount

integer<int32>

required

Required range: x >= 0

data.createdAt

string<date-time>

required

data.updatedAt

string<date-time>

required

data.netTermDays

integer<int32>

nextToken

string

Wallet entries for Account Create an invoice group

⌘I

Introduction

APIs

List Invoice Groups

Authorizations

Response