Finalise an Invoice Batch

post/public/v1/invoice-batches/{invoiceBatch}/finalise

post/public/v1/invoice-batches/{invoiceBatch}/finalise

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/invoice-batches/{invoiceBatch}/finalise' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoice_sending_behaviour": "do_not_send_automatically"
}'

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"
  }
}

Authorization

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

Path parameters

invoiceBatchstringrequired
The invoice batch UUID

Body

application/json

invoice_sending_behaviourenum<string>
Available options:do_not_send_automaticallysend_automatically

Response

200application/json

InvoiceBatchResource

dataobjectrequired
▶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

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error

Command Palette

Authorization

Path parameters

Body

Response

Errors