List Invoice Batches

get/public/v1/invoice-batches

get/public/v1/invoice-batches

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/invoice-batches' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "b1a2t3c4-f5a6-47b8-9c0d-1e2f3a4b5c6d",
      "reference": "BATCH-2024-001",
      "status": "draft",
      "invoice_sending_behaviour": "send_all",
      "finalised_at": "2024-01-15T10:30:00+00:00",
      "created_at": "2024-01-15T10:30:00+00:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of InvoiceBatchResource

dataobject[]required
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:b1a2t3c4-f5a6-47b8-9c0d-1e2f3a4b5c6d
- referencestringrequired
  Example:BATCH-2024-001
- statusenum<string>required
  Available options:draftfinalisedprocessingqueued
- invoice_sending_behaviourstringrequired
  Example:send_all
- finalised_atstring | nullrequired
  Example:2024-01-15T10:30:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error

Command Palette

Authorization

Query parameters

Response

Errors