POST /billing/{tenantLocator}/invoices/earlyInvoicing

Request

Base URL
https://docs.socotra.com
Auth
none declared
TypeScript
https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/billing/:tenantLocator/invoices/earlyInvoicing/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenantLocatorstring uuid required

Request body

accountLocatorstring ulid

invoiceThroughTimestring date-time

installmentLocatorsstring[] required

invoiceDueTimestring date-time

timezonestring

ignoreHoldsboolean required

policyLocatorstring ulid

aggregateInvoicesboolean required

Defaults to false. When true, the job creates an aggregate invoice for each account and currency, containing the regular invoices that were generated.

includeExistingInvoicesboolean required

Defaults to false. When true, that aggregate invoice also includes the other open regular invoices for the account in the same currency that are not already on an aggregate invoice. Requires aggregateInvoices: true.

Response

jobLocatorstring ulid required

candidateInstallmentsCountinteger required

Changes

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