Retry reading a company bill's document

const options = {method: 'POST', headers: {'x-dolfin-api-key': '<api-key>'}};

fetch('https://api.dolfinai.co/v1/companies/{companyId}/bills/{billId}/retry-extraction', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dolfinai.co/v1/companies/{companyId}/bills/{billId}/retry-extraction"

headers = {"x-dolfin-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/companies/{companyId}/bills/{billId}/retry-extraction");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suggestedOrganisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suggestedOrganisationConfidence": 123,
  "candidates": [
    {
      "basis": "<string>",
      "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "score": 123
    }
  ],
  "supplierName": "<string>",
  "supplierEmail": "<string>",
  "supplierAddress": "<string>",
  "deliveryAddress": "<string>",
  "deliveryAddressDetail": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "isEmpty": true
  },
  "invoiceNumber": "<string>",
  "invoiceDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "subTotal": 123,
  "taxAmount": 123,
  "totalAmount": 123,
  "confidence": 123,
  "extractionError": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

POST

companies

{companyId}

bills

{billId}

retry-extraction

Retry reading a company bill's document

const options = {method: 'POST', headers: {'x-dolfin-api-key': '<api-key>'}};

fetch('https://api.dolfinai.co/v1/companies/{companyId}/bills/{billId}/retry-extraction', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dolfinai.co/v1/companies/{companyId}/bills/{billId}/retry-extraction"

headers = {"x-dolfin-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/companies/{companyId}/bills/{billId}/retry-extraction");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suggestedOrganisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "suggestedOrganisationConfidence": 123,
  "candidates": [
    {
      "basis": "<string>",
      "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "score": 123
    }
  ],
  "supplierName": "<string>",
  "supplierEmail": "<string>",
  "supplierAddress": "<string>",
  "deliveryAddress": "<string>",
  "deliveryAddressDetail": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "isEmpty": true
  },
  "invoiceNumber": "<string>",
  "invoiceDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "subTotal": 123,
  "taxAmount": 123,
  "totalAmount": 123,
  "confidence": 123,
  "extractionError": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

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-client-id

string<uuid>

Target client. Required when your credential grants access to more than one client; omit when it resolves a single client.

Path Parameters

companyId

string<uuid>

required

billId

string<uuid>

required

Response

Accepted

string<uuid>

Identifier of the bill. It does not change when the bill is routed: the same id retrieves the bill from GET /bills/{billId} afterwards.

companyId

string<uuid>

status

enum<string>

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.

Available options:

Extracting,

ExtractionFailed,

AwaitingOrganisation,

Discarded

source

enum<string>

How the bill arrived — an API upload, or the company's bill-forwarding email address.

Available options:

Upload,

Email,

Webhook

routingOutcome

null | any

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.

Available options:

AutoAssigned,

BelowThreshold,

Ambiguous,

HeadOffice,

MultipleDeliveryAddresses,

NoDeliveryAddress,

NoOrganisations,

AutoAssignDisabled,

null

suggestedOrganisationId

null | string<uuid>

The organisation the bill most likely belongs to, if one stood out. Present even when confidence was too low to route automatically.

suggestedOrganisationConfidence

How confident the address match was, from 0 to 1.

candidates

object[]

The candidate organisations, best match first, so a reviewer can pick rather than search.

Show child attributes

supplierName

null | string

supplierEmail

null | string

supplierAddress

null | string

deliveryAddress

null | string

The delivery address exactly as printed on the document.

deliveryAddressDetail

null | object

The delivery address as components — what the bill is matched against when deciding which organisation it belongs to.

Show child attributes

invoiceNumber

null | string

invoiceDate

null | string<date-time>

dueDate

null | string<date-time>

currency

string

ISO 4217 currency code (e.g. GBP, USD, EUR)

subTotal

taxAmount

totalAmount

confidence

Extraction confidence reported by the document reader, from 0 to 1.

extractionError

null | string

Why extraction failed, when it did.

createdAt

string<date-time>

updatedAt

string<date-time>

Overview

Auth

Users

Organisations

Clients

Agent

MCP

Invoices

Invoice Reminders

Recurring Invoices

Credit Notes

Receivables

Bills

Companies

Purchase Orders

Delivery Notes

Matching

Supplier Credit Notes

Approval Policies

Payables

Bank Payments

Gmail

Suppliers

Payments

Customers

Products

Tax Rates

Currencies

Bank details

Industries

Webhooks

Retry reading a company bill's document

Authorizations

Headers

Path Parameters

Response