POST /billing/{tenantLocator}/invoices/{locator}/transfer

Request

Path parameters

tenantLocatorstring uuid required
locatorstring ulid required

Request body

targetAggregateInvoiceLocatorstring ulid required

The destination aggregate invoice. Must differ from the source and belong to the same account.

invoiceLocatorsstring[] required

1 to 100, no duplicates, and each must currently be on the source.

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.