Skip to main content
POST
Extract recurring-invoice terms from a contract

Authorizations

x-dolfin-api-key
string
header
required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Headers

x-dolfin-organisation-id
string<uuid>

Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).

Body

multipart/form-data
file
file

Response

OK

customerName
null | string

The party being billed, exactly as named on the contract.

customerEmail
null | string

Billing contact email if the contract states one; helps disambiguate the customer.

currency
null | string

Billing currency as an ISO 4217 code, e.g. "GBP", "USD", "EUR". Null if the contract is silent.

memo
null | string

Short free-text note for each generated invoice, e.g. the contract or PO reference.

startDate
null | string<date-time>

Date of the first invoice, as an ISO 8601 calendar date (YYYY-MM-DD).

cadence
null | enum<string>

How often an invoice is raised.

Available options:
Weekly,
Monthly,
Quarterly,
Annually
totalOccurrences

Total number of invoices to generate, e.g. 12 for a 12-month contract. Null if open-ended.

lineItems
object[]

One entry per recurring charge on the contract.

sourceQuotes
object

Per-field provenance, keyed by field name: the exact contract text each value came from.

confidence
object

Per-field confidence 0-1, keyed by field name: your confidence in each value you filled.

missingFields
string[]