Get an unassigned company bill
Retrieve a single bill waiting in the company’s inbox, including the candidate organisations it might belong to. Once assigned, retrieve it from GET /bills/ instead.
Authentication. An API key (x-dolfin-api-key) or a JWT Bearer token. When your credential grants access to more than one client, select one with the x-dolfin-client-id header.
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 client. Required when your credential grants access to more than one client; omit when it resolves a single client.
Response
OK
Identifier of the bill. It does not change when the bill is routed: the same id retrieves the bill from GET /bills/{billId} afterwards.
Where the bill is in the inbox. AwaitingOrganisation means it needs routing; ExtractionFailed means the document could not be read; Discarded means someone rejected it.
Extracting, ExtractionFailed, AwaitingOrganisation, Discarded How the bill arrived — an API upload, or the company's bill-forwarding email address.
Upload, Email, Webhook Why the bill was not routed automatically. Tells you what needs deciding: for example, that the delivery address matched several sites, that it was delivered to head office, or that no address could be read.
AutoAssigned, BelowThreshold, Ambiguous, HeadOffice, MultipleDeliveryAddresses, NoDeliveryAddress, NoOrganisations, AutoAssignDisabled, null The organisation the bill most likely belongs to, if one stood out. Present even when confidence was too low to route automatically.
How confident the address match was, from 0 to 1.
The candidate organisations, best match first, so a reviewer can pick rather than search.
The delivery address exactly as printed on the document.
The delivery address as components — what the bill is matched against when deciding which organisation it belongs to.
ISO 4217 currency code (e.g. GBP, USD, EUR)
Extraction confidence reported by the document reader, from 0 to 1.
Why extraction failed, when it did.