Extract recurring-invoice terms from a contract
Upload a contract as a PDF or image — PNG, JPEG, GIF, or WebP (multipart/form-data, field name ‘file’) — and get back the recurring-billing terms (customer, currency, cadence, start date, line items) as NAMES — this does not create anything. Resolve the names to ids (customers, products, tax rates) and POST /recurring-invoices to create the schedule. Required fields the contract omits are listed in missingFields; currency falls back to the organisation default. Admin-gated. Max 5 MB.
Authentication. An API key (x-dolfin-api-key) together with the x-dolfin-organisation-id header identifying the organisation, or a JWT Bearer token that carries the organisation in its claims.
Authorizations
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
Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).
Body
Response
OK
The party being billed, exactly as named on the contract.
Billing contact email if the contract states one; helps disambiguate the customer.
Billing currency as an ISO 4217 code, e.g. "GBP", "USD", "EUR". Null if the contract is silent.
Short free-text note for each generated invoice, e.g. the contract or PO reference.
Date of the first invoice, as an ISO 8601 calendar date (YYYY-MM-DD).
How often an invoice is raised.
Weekly, Monthly, Quarterly, Annually Total number of invoices to generate, e.g. 12 for a 12-month contract. Null if open-ended.
One entry per recurring charge on the contract.
Per-field provenance, keyed by field name: the exact contract text each value came from.
Per-field confidence 0-1, keyed by field name: your confidence in each value you filled.