Sign in
Billing

Get bulk invoice run details

Returns the details of the specified bulk invoice run

get/invoices/bulk/{bulkInvoiceRunId}

Path parameters

bulkInvoiceRunIdstring required

id of the run

Response

successful operation

entityIdstring
namestring
descriptionstring
targetDateinteger
invoiceDateinteger
chargeInclusionOption'INCLUDE_USAGE' | 'EXCLUDE_USAGE' | 'ONLY_USAGE'
isHistoricalboolean
idstring
bulkInvoiceRunIdstring
automatedInvoiceRuleIdstring
status'QUEUED' | 'CREATED' | 'PROCESSING' | 'FAILED' | 'COMPLETED' | 'RUNNING'
phase'INVOICE_GENERATION_NOT_STARTED' | 'NO_INVOICES_FOUND' | 'INVOICES_GENERATING' | 'INVOICES_GENERATED' | 'INVOICES_POSTING' | 'INVOICES_POSTED' | 'INVOICES_EMAILING' | 'INVOICES_EMAILED'
failureReasonstring
createdOninteger
updatedOninteger

Changes

No recorded changes to this endpoint across all 1 revision of this API.