SOsocotra

POST /billing/{tenantLocator}/invoices

Request

Path parameters

tenantLocatorstring uuid required

Request body

accountLocatorstring ulid required

The account associated with the aggregate invoice.

invoiceLocatorsstring[] required

Up to 100, no duplicates. Each must belong to the account, share one currency, and not already be on an aggregate invoice. May be empty or omitted.

startTimestring date-time

Defaults to the earliest startTime of the included invoices, or the creation time if not present. Must be before endTime.

endTimestring date-time

Defaults to the latest endTime of the included invoices, or the creation time if not present.

dueTimestring date-time

Defaults to the earliest dueTime of the included invoices, or the creation time if not present.

currencystring

Must match the included invoices. Defaults to their currency, then the tenant default.

timezonestring

Defaults to the shared timezone of the included invoices, then the account timezone, then the tenant default.

Response

OK

locatorstring ulid required
accountLocatorstring ulid required
invoiceState'building' | 'open' | 'settled' | 'discarded' required
generatedTimestring date-time required
dueTimestring date-time required
currencystring required
startTimestring date-time required
endTimestring date-time required
unsettledTimestring date-time
timezonestring required
invoiceNumberstring
autopayTimestring date-time
settledTimestring date-time
aggregateInvoiceLocatorstring ulid
invoiceType'normal' | 'aggregate' required
totalAmountnumber
totalRemainingAmountnumber

Changes

No recorded changes to this operation across all 2 revisions of this API.