Sign in

v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB
Billing

Generate subscription invoices

Generates the invoices for the given subscription

post/invoices/generate

Query parameters

subscriptionIdstring required

id of the subscription

targetDateinteger required

Time in seconds since Epoch (GMT) to generate invoice from

invoiceDateinteger

Time in seconds since Epoch (GMT) to set invoice date to

invoiceChargeInclusionOption'INCLUDE_USAGE' | 'EXCLUDE_USAGE' | 'ONLY_USAGE' required

types of charges to include

Response

successful operation

entityIdstring
invoiceNumberstring
postedDateinteger
invoiceDateinteger
voidedDateinteger
dueDateinteger
currencystring
paymentTermstring
totalDiscountnumber
subTotalnumber
taxTotalnumber
taxTransactionCodestring
totalnumber
subscriptionIdstring
accountIdstring
resellerAccountIdstring
status'DRAFT' | 'POSTED' | 'PAID' | 'CONVERTED' | 'VOIDED'
purchaseOrderNumberstring
purchaseOrderRequiredboolean
notestring
erpIdstring
generationMethod'USER_INITIATED' | 'API_INITIATED' | 'BULK_INVOICE_RUN' | 'AUTOMATED_INVOICE_JOB' | 'RULE_DRIVEN_INVOICE_JOB' | 'UNKNOWN'
generatedBystring
exchangeRateIdstring
exchangeRatenumber
exchangeRateDateinteger
functionalTotalDiscountnumber
functionalSubTotalnumber
functionalTaxTotalnumber
functionalTotalnumber
customFieldsobject