SOsocotra

PATCH /billing/{tenantLocator}/invoices/{locator}/aggregate

Request

Path parameters

tenantLocatorstring uuid required
locatorstring ulid required

Request body

startTimestring date-time

Must be before endTime.

endTimestring date-time
dueTimestring date-time
currencystring

Must match the contained invoices.

timezonestring
addInvoicesstring[] required

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

removeInvoicesstring[] required

Up to 100, no duplicates. Locators not on this aggregate invoice are ignored.

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.