Skip to main content
GET
/
invoice_groups
/
{invoice_group_id}
Get information of an invoice group
curl --request GET \
  --url https://api.togai.com/invoice_groups/{invoice_group_id} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
  },
  "accountsCount": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "accounts": [
    "<string>"
  ],
  "netTermDays": 123,
  "nextToken": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

invoice_group_id
string
required
Maximum string length: 512
Example:

"inv_grp.20rqjgFJf2O.ejl25"

Response

Response to get invoice group request

Invoice group details

id
string
required
name
string
required
email
string
required
Maximum string length: 320
dailyInvoiceConsolidation
boolean
required
invoiceCurrency
string
required
billingAddress
object
required

billing address of the customer

accountsCount
integer<int32>
required
Required range: x >= 0
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
accounts
string[]
required
netTermDays
integer<int32>
nextToken
string