Common ModelsInvoices

/invoices/bulk/{batch_id}

Returns the status and results of an Invoice bulk create batch.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

batch_idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Response

batch_idstringformat: "uuid"
The ID of the batch.
statusenum

Possible overall statuses:

  • ENQUEUED - The request has been received and a task has been enqueued for processing
  • IN_PROGRESS - The enqueued task is being processed
  • PARTIAL_SUCCESS - The task has been processed, but not all objects were written successfully
  • SUCCESS - The task has been processed, and all objects were written successfully
  • FAILED - The task has been processed, but ran into an error while processing
  • RATE_LIMITED - The request was received but ran into rate limits while processing. The rate limited objects are being retried.
total_countinteger
The total number of objects in the batch.
objectslist of objects