Invoices - Nitro APIs

POST

extractions

Expense analysis

curl --request POST \
  --url https://api.gonitro.dev/extractions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form method=extract-expense-data \
  --form 'file=<string>' \
  --form file.0='@example-file'

{
  "file": {
    "URL": "<string>",
    "contentType": "application/json",
    "metadata": {
      "fileSizeBytes": 123,
      "pageCount": 123
    }
  }
}

Scanned documents are automatically processed using OCR.

What gets extracted

The response returns a structured representation of the invoice or receipt, including:

Field	Description
Vendor	Merchant or supplier name and address
Date	Transaction or invoice date
Line items	Individual expense entries with descriptions and amounts
Subtotal	Pre-tax total
Tax	Tax amount and rate, where present
Total	Final charged amount
Currency	Detected currency code (e.g. `USD`, `EUR`)

Response fields

Field	Type	Description
`vendor_name`	`string \| null`	Name of the merchant or vendor
`vendor_address`	`string \| null`	Vendor’s address as it appears on the document
`date`	`string \| null`	Transaction or invoice date (ISO 8601 format when parseable)
`due_date`	`string \| null`	Payment due date, if present
`invoice_number`	`string \| null`	Invoice or receipt reference number
`currency`	`string \| null`	ISO 4217 currency code (e.g. `USD`, `EUR`)
`subtotal`	`number \| null`	Pre-tax subtotal amount
`tax`	`number \| null`	Tax amount
`total`	`number \| null`	Final total amount charged
`line_items`	`array`	Individual line items extracted from the document
`line_items[].description`	`string \| null`	Description of the line item
`line_items[].quantity`	`number \| null`	Quantity for the line item
`line_items[].unit_price`	`number \| null`	Price per unit
`line_items[].amount`	`number \| null`	Total amount for the line item

Fields that cannot be identified in the document are returned as null. Always handle null values in your integration — not all documents include every field.

Supported document types

This endpoint works best with:

Receipts (retail, travel, dining)
Invoices and purchase orders
Expense report PDFs

Handwritten or heavily stylised receipts may yield lower confidence scores on individual fields. Check the confidence property on each extracted field when accuracy is critical to your workflow.

Notes

Amounts are returned as raw numeric values; currency is indicated separately in the currency field.
Line item extraction works best on structured invoice layouts. Handwritten or informal receipts may yield fewer line items.
Date fields are returned as strings. When the date format is unambiguous, the value conforms to ISO 8601 (YYYY-MM-DD); otherwise the raw string from the document is preserved.

Output File Format

The endpoint can return output either as JSON or as a binary file. The format depends on the Accept header (details below), which defaults to application/json.

Processing

When requesting JSON, you can run the operation synchronously or asynchronously. This is determined by the Prefer header (details below).

In sync mode, the response includes a URL pointing to the processed file.
In async mode, the request creates a Job, and the response contains the Job ID and status so you can track progress.

Binary (octet-stream) responses are only available for synchronous operations.

Custom File Delivery

The endpoint supports custom file-delivery destinations through the optional delivery parameter. You can provide an upload target, such as your own PUT endpoint or a pre-signed S3 URL, and Nitro will upload the resulting file there. This works for both synchronous and asynchronous processing.

Sync delivery
In synchronous calls, the delivery parameter lets you direct Nitro to upload the output file to a custom URL endpoint or a pre-signed URL (e.g S3), by providing an upload url in the uploadResultTo or uploadResultsTo properties.

Custom endpoint

If implementing the upload endpoint by yourself, make sure your code or middleware configuration accepts requests without content-type headers.

S3 delivery
If you are using S3 to manage delivery uploads, follow this AWS documentation to generate a pre-signed PUT URL.
If using the AWS provided Python script, omit the Content-Type in Params to get the pre-signed url. For example:
```
    url = generate_presigned_url(
        s3_client,
        "put_object",
        { 
            "Bucket": args.bucket, 
            "Key": args.key,
            # Content-Type: "application/octet-stream" => Omit!
        },
    1000)
```
Async delivery
In asynchronous flows, you can also provide a custom URL or pre-signed S3 object via uploadResultTo or uploadResultsTo, to upload your file(s) once the Job is done processing.

Callback
For asynchronous processing, you can also include a callback URL within the delivery parameter. This callback is a POST endpoint that Nitro will call once the Job is created and running, providing details about the file-processing job. Example of Nitro’s callback request body:
```
{
    "jobID": "babe2aa7-9b5d-4eb2-a679-5fc12cf0a490",
    "location": "https://api.gonitro.dev/jobs/babe2aa7-9b5d-4eb2-a679-5fc12cf0a490"
}
```

Response behavior Matrix

This matrix shows the expected response behavior based on content type, sync/async mode, and custom file-delivery settings.

	JSON (`application/json`)	Binary (`application/octet-stream`)
Synchronous	Returns a JSON object with a file(s) URL(s).	Returns the processed file directly as binary.
Asynchronous (`respond-async`)	Returns a JSON object with a Job ID and status.	Async preference ignored, returns sync binary.
Synchronous delivery	File delivered to custom endpoint / Bucket, returns success confirmation.	N/A
Asynchronous delivery	Returns a JSON object with a Job ID and status. The file(s) will be uploaded to the provided PUT endpoint / S3 Bucket at the end of process. If `callback` url is provided, Nitro will notify the endpoint with a JOB ID and location.	N/A

Limits

The Platform API has the following limits:

File size: Maximum of 100 MB per request. This applies to single-file and multi-file requests.
Page count: Maximum of 500 pages per individual document. This applies to single-file and multi-file requests. Multiple documents may exceed 500 pages in total.
Retention time: Inputs and outputs are deleted approximately 15 minutes after the operation completes.

Request

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

enum<string>

default:*/*

Controls response format and behavior. See endpoint description above for detailed response combinations.

application/json: Returns JSON response with operation result
application/octet-stream: Returns binary file content
*/*: Defaults to JSON response

Available options:

application/json,

application/octet-stream,

*/*

Prefer

enum<string>

Controls synchronous vs asynchronous operation. See endpoint description above for behavior details.

respond-async: Makes request asynchronous, returns job status for polling
No value: Synchronous response

Available options:

respond-async

Body

multipart/form-data

method

enum<string>

default:extract-expense-data

required

The Extractions' endpoint method: extract-expense-data

Available options:

extract-expense-data

file

required

The file to process. It can be provided as a binary upload or as a JSON remote file reference.

delivery

object

This endpoint lets you supply your own URL to receive the single-file output. The URL may point to a custom API endpoint or a pre-signed S3 URL.

The HTTP method defaults to PUT, but you can change it based on your implementation needs via the verb parameter. You can also provide custom headers, such as authentication headers or any others required by your endpoint.

Show child attributes

Response

Returns either JSON or binary output depending on the Accept header (defaults to JSON). JSON responses include a file URL for synchronous tasks or a job status for asynchronous tasks.

Sync - Single File
Async - Job

file

object

Show child attributes

PDF to MS OfficeConvert PDF to MS Office

Expense analysis

curl --request POST \
  --url https://api.gonitro.dev/extractions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form method=extract-expense-data \
  --form 'file=<string>' \
  --form file.0='@example-file'

{
  "file": {
    "URL": "<string>",
    "contentType": "application/json",
    "metadata": {
      "fileSizeBytes": 123,
      "pageCount": 123
    }
  }
}

​What gets extracted

​Response fields

​Supported document types

​Notes

​Output File Format

​Processing

​Custom File Delivery

​Sync delivery

​Custom endpoint

​S3 delivery

​Async delivery

​Callback

​Response behavior Matrix

​Limits

​Request

Authorizations

Headers

Body

Response

What gets extracted

Response fields

Supported document types

Notes

Output File Format

Processing

Custom File Delivery

Sync delivery

Custom endpoint

S3 delivery

Async delivery

Callback

Response behavior Matrix

Limits

Request