PaperTotal API

The PaperTotal API. Send a key as Authorization: Bearer ptk_live_.... A key reaches one workspace and only the scopes it was given. An OAuth access token (pta_...) goes on the same header and reaches the same routes, within the scopes the person granted.

Requests are limited per workspace, across all of its keys and tokens: 600 a minute on Business, 120 on Pro, 60 on Starter and 30 with no plan. Past that the API answers 429 with code RATE_LIMITED and a Retry-After header.

Money is an integer in minor units with a currency code, dates are YYYY-MM-DD, and every error has the same body with a stable code and a message written for a person.

Sending a file. Ask POST /v1/uploads for a ticket, saying what the file is for (purpose), its type and its size in bytes. PUT exactly that many bytes to the ticket's url, with its headers and no others: the file goes straight to storage and never through this API. Then call the route the file is for with JSON naming uploadId where it would otherwise take a multipart file: POST /v1/documents or any other route that reads a document, such as POST /v1/documents/classify, POST /v1/parse or POST /v1/split, for document, POST /v1/expenses/{id}/receipts for expense_receipt, POST /v1/mileage/{id}/odometer-photos for odometer_photo, POST /v1/approvals/policy for policy_document, the statement imports under /v1/payment-accounts for statement, and POST /v1/attachments for attachment. Nothing counts until that route has checked the stored file: its bytes decide its type, and a file that is not acceptable is refused there and deleted. The ticket stops working at expiresAt, and a failed PUT is treated as an expired one: ask for a new ticket and try once more. A multipart file on the same routes still works, and is the simple way for a script.

A key can require signed requests. Send X-PaperTotal-Request-Timestamp with the Unix time and X-PaperTotal-Request-Signature with the hex HMAC-SHA256 of "<timestamp>.<METHOD>.<path and query>.<raw body>", using the key's client secret. A signature is good for 30 minutes either way, and one that is sent is always checked. It covers a JSON body or none, so send a file as file_data when signing.

Base URL: https://api.papertotal.com

Need help with the API? Write to [email protected] with the X-Request-Id of the call. A person answers by email.

Try a call from the web app, with your own session or a key you paste.

analytics

GET /v1/analytics/by-category Spending by category

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`limit`	query	integer
`interval`	query	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	query	string

Response

200 Success.

application/json Breakdown

GET /v1/analytics/by-department Spending by department

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`limit`	query	integer
`interval`	query	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	query	string

Response

200 Success.

application/json Breakdown

GET /v1/analytics/by-member Spending by member

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`limit`	query	integer
`interval`	query	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	query	string

Response

200 Success.

application/json Breakdown

GET /v1/analytics/by-merchant Spending by merchant

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`limit`	query	integer
`interval`	query	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	query	string

Response

200 Success.

application/json Breakdown

GET /v1/analytics/by-project Spending by project

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`limit`	query	integer
`interval`	query	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	query	string

Response

200 Success.

application/json Breakdown

GET /v1/analytics/by-tag Spending by tag

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`limit`	query	integer
`interval`	query	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	query	string

Response

200 Success.

application/json Breakdown

GET /v1/analytics/summary Spending totals for a period, with the period before it

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`limit`	query	integer
`interval`	query	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	query	string

Response

200 Success.

application/json AnalyticsSummary

GET /v1/analytics/trend Spending over time

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`limit`	query	integer
`interval`	query	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	query	string

Response

200 Success.

application/json Trend

api keys

GET /v1/api-keys/verify See what the calling key grants

Any key may call this about itself, whatever its scopes. It says what the key can reach, in which workspace, and until when. Every other route under /v1/api-keys takes a person, so a key cannot mint a stronger key.

Any API key can call this, whatever its scopes. Try it

Response

200 Success.

application/json ApiKeyVerification

attachments

POST /v1/attachments Make a file a comment or a message can carry

From a finished upload with the purpose attachment. Name its id in attachmentIds on a comment or a message. A file nothing names is deleted after a week.

Needs the expenses:write scope. Needs a live plan. Try it

Request body

application/json CreateAttachmentInput

Response

201 Success.

application/json Attachment

automation rules

GET /v1/automation-rules List automation rules

The workspace's rules, top to bottom. The first rule to set a field wins it.

Needs the rules:read scope. Try it

Response

200 Success.

application/json AutomationRuleList

POST /v1/automation-rules Add an automation rule

Conditions match on the expense, its line items, its tags and flags, the words on its document, or a question for Claude.

Needs the rules:write scope. Needs the policies.manage permission. Needs the automation_rules plan feature. Needs a live plan. Try it

Request body

application/json AutomationRuleInput

Response

201 Success.

application/json AutomationRule

DELETE /v1/automation-rules/{id} Delete an automation rule

Needs the rules:write scope. Needs the policies.manage permission. Needs the automation_rules plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

PATCH /v1/automation-rules/{id} Change an automation rule

Needs the rules:write scope. Needs the policies.manage permission. Needs the automation_rules plan feature. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateAutomationRuleInput

Response

200 Success.

application/json AutomationRule

POST /v1/automation-rules/{id}/apply Run a rule over expenses not yet submitted

A field a person set keeps their value. Running it twice changes nothing more.

Needs the rules:write scope. Needs the policies.manage permission. Needs the automation_rules plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json AutomationApply

POST /v1/automation-rules/{id}/test Count what a saved rule would match

Changes nothing.

Needs the rules:write scope. Needs the policies.manage permission. Try it

Parameters

id required path string

Response

200 Success.

application/json AutomationPreview

GET /v1/automation-rules/export Export automation rules as a file

Every workspace rule, in order, with names in place of ids, so another workspace can import it. Needs policies.manage.

Needs the rules:read scope. Needs the policies.manage permission. Try it

Response

200 Success.

application/json RulesDocument

POST /v1/automation-rules/import Import automation rules from CSV

Needs the rules:write scope. Needs the policies.manage permission. Needs the automation_rules plan feature. Needs a live plan. Try it

Request body

application/json CatalogImportInput

Response

200 Success.

application/json CatalogImportResult

POST /v1/automation-rules/import-file Import automation rules from a file

Takes what the export route gives. Each name is looked up in this workspace, and a rule that names something it does not have comes back in errors, with the reason. A rule already here is skipped.

Needs the rules:write scope. Needs the policies.manage permission. Needs the automation_rules plan feature. Needs a live plan. Try it

Request body

application/json RulesDocument

Response

200 Success.

application/json CatalogImportResult

POST /v1/automation-rules/preview Count what some conditions would match

Changes nothing. The sample shows expenses, so it needs rules:write and policies.manage.

Needs the rules:write scope. Needs the policies.manage permission. Try it

Request body

application/json AutomationPreviewInput

Response

200 Success.

application/json AutomationPreview

POST /v1/automation-rules/reorder Put the rules in a new order

Needs the rules:write scope. Needs the policies.manage permission. Needs the automation_rules plan feature. Needs a live plan. Try it

Request body

application/json ReorderAutomationRulesInput

Response

200 Success.

application/json AutomationRuleOrder

bank statements

POST /v1/bank-statements Read a bank statement

POST /v1/documents/url with the type fixed: the same body, wait and answer. Bank and tax numbers are masked; POST /v1/documents/{id}/reveal opens them.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Replaying a key returns the first record instead of creating, and charging for, a second. While the first request is still running, a retry answers 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After, and is not charged. The same key on a different request answers 409 IDEMPOTENCY_CONFLICT.

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

202 Accepted. The document is still being read.

application/json DocumentUpload

POST /v1/bank-statements/async Read a bank statement in the background

POST /v1/documents/url with the type fixed: the same body, wait and answer. Bank and tax numbers are masked; POST /v1/documents/{id}/reveal opens them.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

bank statements set

GET /v1/bank-statements-set List bank statement sets

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json DocumentSetPage

POST /v1/bank-statements-set Split a PDF of bank statements and read each one

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Up to 250 pages and 50 MB. Answers at once. bank_statement_set.created says when every statement is read, and bank_statement_set.failed why not. Account numbers are masked in every view.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`external_id`	string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string

Response

202 Success.

application/json DocumentSet

GET /v1/bank-statements-set/{id} Get a bank statement set

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json DocumentSet

billing

GET /v1/billing Get the plan, seats and this month's usage

Needs the billing:read scope. Try it

Response

200 Success.

application/json Billing

POST /v1/billing/cancel Cancel the subscription

It ends when the period already paid for does, as cancelling in the billing portal does. Asking twice changes nothing. Needs billing.manage.

Needs the billing:write scope. Needs the billing.manage permission. Try it

Response

200 Success.

application/json Billing

GET /v1/billing/invoices List invoices

Newest first, from Stripe, with Stripe's own links to each invoice's page and PDF. A plan bought in a store has its invoices there.

Needs the billing:read scope. Needs the billing.manage permission. Try it

Response

200 Success.

application/json BillingInvoicePage

blueprints

GET /v1/blueprints List blueprints

This workspace's own, then the built-in catalogue.

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

documentType query RECEIPT INVOICE BILL BANK_STATEMENT CHECK TAX_FORM BUSINESS_CARD OTHER UNKNOWN PURCHASE_ORDER CONTRACT PACKING_SLIP REMITTANCE_ADVICE CREDIT_NOTE STATEMENT

Response

200 Success.

application/json BlueprintList

POST /v1/blueprints Create a blueprint

A strict subset of JSON schema: object, array, string, number, integer and boolean, nested up to four levels and up to 150 fields. A keyword outside it, such as $ref, pattern or anyOf, is refused by name. Needs settings.manage.

Needs the documents:write scope. Needs the settings.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Request body

application/json CreateBlueprintInput

Response

201 Success.

application/json Blueprint

DELETE /v1/blueprints/{name} Delete a blueprint

Results it made stay, and its name can be used again.

Needs the documents:write scope. Needs the settings.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

name required path string

Response

204 Done, with no content.

GET /v1/blueprints/{name} Get a blueprint

Asks for an older version with version.

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

`name` required	path	string
`version`	query	integer

Response

200 Success.

application/json Blueprint

PATCH /v1/blueprints/{name} Change a blueprint

A new schema or new field guidance adds a version. Results keep the version that made them.

Needs the documents:write scope. Needs the settings.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

name required path string

Request body

application/json UpdateBlueprintInput

Response

200 Success.

application/json Blueprint

POST /v1/blueprints/draft Propose a blueprint from a sample

Multipart, or JSON naming an uploadId from POST /v1/uploads. Reads one sample and proposes fields. Nothing is saved until it is sent to POST /v1/blueprints. Costs one scan.

Needs the documents:write scope. Needs the settings.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Request body

multipart/form-data

file required string (binary)

application/json

uploadId required

string

From POST /v1/uploads, once the file has been sent to the URL it answered with.

Response

201 Success.

application/json BlueprintDraft

GET /v1/blueprints/draft/{documentId} Get a proposed blueprint

The document id from proposing one. Answers READING until it has been read.

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

documentId required path string

Response

200 Success.

application/json BlueprintDraft

budgets

GET /v1/budgets List budgets

Needs the expenses:read scope. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json BudgetPage

GET /v1/budgets/{id} Get a budget and how it stands

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json Budget

business cards

POST /v1/business-cards Read a business card

POST /v1/documents/url with the type fixed: the same body, wait and answer. Bank and tax numbers are masked; POST /v1/documents/{id}/reveal opens them.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

202 Accepted. The document is still being read.

application/json DocumentUpload

check with document

POST /v1/check-with-document Read a check with its remittance

Two documents, read apart: the check, and what came with it.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json CheckWithDocumentInput

Response

201 Success.

application/json CheckWithDocument

202 Accepted. One or both are still being read.

application/json CheckWithDocument

checks

POST /v1/checks Read a bank check

POST /v1/documents/url with the type fixed: the same body, wait and answer. Bank and tax numbers are masked; POST /v1/documents/{id}/reveal opens them.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

202 Accepted. The document is still being read.

application/json DocumentUpload

POST /v1/checks/async Read a bank check in the background

POST /v1/documents/url with the type fixed: the same body, wait and answer. Bank and tax numbers are masked; POST /v1/documents/{id}/reveal opens them.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

clients

GET /v1/clients GET /v1/clients

Needs the expenses:read scope. Try it

Response

POST /v1/clients POST /v1/clients

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Response

DELETE /v1/clients/{id} DELETE /v1/clients/:id

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

id required path string

Response

GET /v1/clients/{id} GET /v1/clients/:id

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

PATCH /v1/clients/{id} PATCH /v1/clients/:id

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

id required path string

Response

contacts

GET /v1/contacts List contacts

Needs the contacts:read scope. Try it

Parameters

`q`	query	string
`documentId`	query	string
`name`	query	string
`company`	query	string
`email`	query	string
`phone`	query	string
`website`	query	string
`city`	query	string
`region`	query	string
`postalCode`	query	string
`country`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ContactPage

GET /v1/contacts/{id} Get a contact

Needs the contacts:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json Contact

GET /v1/contacts/{id}/vcard Download a contact as a vCard

Needs the contacts:read scope. Try it

Parameters

id required path string

Response

200 Success.

text/vcard string (binary)

POST /v1/contacts/export Export contacts as vCard or CSV

Needs the contacts:read scope. Try it

Request body

application/json ContactExportInput

Response

200 Success.

text/vcard string (binary)

text/csv string (binary)

custom fields

GET /v1/custom-fields List custom fields

Needs the expenses:read scope. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json CustomFieldPage

GET /v1/custom-fields/{id} Get a custom field

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json CustomField

documents

GET /v1/documents List documents

Ranges take __gt, __gte, __lt and __lte on created, updated, issued, total and tax: created__gte=2026-01-01, total__lt=5000. Issued, total and tax are what the document's expense holds, with whatever a person corrected, and a document with no expense has none. A day covers all of itself. order_by sorts, and a leading minus sorts down: -total. A document with no value comes last either way. A cursor resumes the created order only, so any other order pages with offset or page. is_empty names fields that must be empty. q searches the title, file name, notes, OCR text and extracted fields in any case; with an asterisk it searches the OCR text and extracted fields, case sensitive, and returns at most the newest 5,000 matches.

Needs the documents:read scope. Try it

Parameters

`type`	query	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`status`	query	`UPLOADED` `PROCESSING` `PROCESSED` `FAILED`
`source`	query	`WEB` `IOS` `ANDROID` `EMAIL` `API` `MAIL_IN` `INTEGRATION`
`source_id`	query	string
`external_id`	query	string
`blueprint_name`	query	string
`owner`	query	string
`device_id`	query	string
`device_user_uuid`	query	string
`viewed`	query	boolean
`trashed`	query	boolean
`envelope`	query	string
`created__gt`	query	string or string (date-time)
`created__gte`	query	string or string (date-time)
`created__lt`	query	string or string (date-time)
`created__lte`	query	string or string (date-time)
`updated__gt`	query	string or string (date-time)
`updated__gte`	query	string or string (date-time)
`updated__lt`	query	string or string (date-time)
`updated__lte`	query	string or string (date-time)
`issued`	query	string
`issued__gt`	query	string
`issued__gte`	query	string
`issued__lt`	query	string
`issued__lte`	query	string
`total`	query	integer
`total__gt`	query	integer
`total__gte`	query	integer
`total__lt`	query	integer
`total__lte`	query	integer
`tax`	query	integer
`tax__gt`	query	integer
`tax__gte`	query	integer
`tax__lt`	query	integer
`tax__lte`	query	integer
`currency`	query	string
`category`	query	string
`vendor`	query	string
`notes`	query	string
`payment_type`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`last_four_digits`	query	string
`first_name`	query	string
`last_name`	query	string
`work_phone`	query	string
`cell_phone`	query	string
`company`	query	string
`email`	query	string
`website`	query	string
`country`	query	string
`state`	query	string
`city`	query	string
`zip`	query	string
`name`	query	string
`is_empty`	query	string
`order_by`	query	`created` `updated` `issued` `total` `tax` `-created` `-updated` `-issued` `-total` `-tax`
`folderId`	query	string
`mailInBatchId`	query	string
`setId`	query	string
`externalId`	query	string
`tag`	query	string
`archived`	query	boolean
`unviewed`	query	boolean
`q`	query	string
`from`	query	string
`to`	query	string
`fraudColor`	query	`GREEN` `YELLOW` `RED`
`fraudSignal`	query	`digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`fraudReview`	query	`PENDING` `FRAUD` `NOT_FRAUD` `UNKNOWN`
`limit`	query	integer
`cursor`	query	string
`offset`	query	integer
`page`	query	integer
`page_size`	query	integer
`track_total_results`	query	boolean

Response

200 Success.

application/json DocumentList

POST /v1/documents Upload a file

Multipart, or JSON naming an uploadId from POST /v1/uploads. The file's type comes from its bytes. Use a JPEG, PNG, WebP, HEIC, TIFF, PDF, DOCX, XLSX, CSV, TXT, HTML, EML or ZIP file. Up to 25 MB, or 50 MB for a PDF sent to be split into a set of documents. Reads best at 300 DPI for a PDF and 1000 pixels on the shorter side of an image. A ZIP unpacks into one document per file, up to 200 files and 200 MB, and each file counts against the plan. A ZIP inside a ZIP is refused. With a key this waits for the reading and answers with it, unless async is set. Name a type, or leave it out and the classifier says what it is.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

`client`	query	`ios` `android` The app sending the file. Leave it out in a browser.
`Idempotency-Key`	header	string Replaying a key returns the first record instead of creating, and charging for, a second. While the first request is still running, a retry answers 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After, and is not charged. The same key on a different request answers 409 IDEMPOTENCY_CONFLICT.

Request body

multipart/form-data

`file` required	string (binary)
`tags`	array of string
`categories`	array of string
`taxonomy`	array of string
`allowed_async_enrichments`	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`bounding_boxes`	boolean
`confidence_details`	boolean
`compute`	boolean
`parse_address`	boolean
`country`	string
`max_pages_to_process`	integer
`boost_mode`	boolean
`auto_delete`	boolean
`stitch`	boolean
`crop_document`	boolean
`blueprint_name`	string
`blueprint_version`	integer
`async`	boolean
`line_item_expansion`	boolean
`tiff_dpi`	number
`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`clientId`	string
`externalId`	string
`folderId`	string
`notes`	string
`capturedAt`	string (date-time)
`latitude`	number
`longitude`	number
`locationAccuracyM`	number
`deviceId`	string
`merchantName`	string
`date`	string
`totalMinor`	integer
`taxMinor`	integer
`category`	string

application/json

`uploadId` required	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`tags`	array of string
`categories`	array of string
`taxonomy`	array of string
`allowed_async_enrichments`	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`bounding_boxes`	boolean
`confidence_details`	boolean
`compute`	boolean
`parse_address`	boolean
`country`	string
`max_pages_to_process`	integer
`boost_mode`	boolean
`auto_delete`	boolean
`stitch`	boolean
`crop_document`	boolean
`blueprint_name`	string
`blueprint_version`	integer
`async`	boolean
`line_item_expansion`	boolean
`tiff_dpi`	number
`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`clientId`	string
`externalId`	string
`folderId`	string
`notes`	string
`capturedAt`	string (date-time)
`latitude`	number
`longitude`	number
`locationAccuracyM`	number
`deviceId`	string
`merchantName`	string
`date`	string
`totalMinor`	integer
`taxMinor`	integer
`category`	string

Response

201 Success.

application/json DocumentUpload

DELETE /v1/documents/{id} Delete a document

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/documents/{id} Get a document and its extraction

Links are signed again on every read, with no new reading. detailed=true adds the reading with each field wrapped as value, score, ocrScore, rotation, boundingBox, boundingRegion and enriched. with_scores=true adds lineItemsWithScores and taxLinesWithScores. recordStatus says processed, reviewed or archived. bounding_boxes=true adds every line read with its box and four corners, and where each field was read from: boundingBox as [page, x1, y1, x2, y2] and boundingRegion as [x1, y1, x2, y2, x3, y3, x4, y4], both as fractions of the page. confidence_details=true adds how sure the read of each field was. Both can be sent on a submission too.

Needs the documents:read scope. Try it

Parameters

`id` required	path	string
`bounding_boxes`	query	boolean
`confidence_details`	query	boolean
`detailed`	query	boolean
`with_scores`	query	boolean

Response

200 Success.

application/json DocumentDetail

PATCH /v1/documents/{id} Change a document

status REVIEWED marks it checked, approved sets your own flag, fraudReview records a decision, and billable, merchantName and the totals change its expense, under the rules of PATCH /v1/expenses/{id}. What can be refused is checked first, so nothing changes when any of it is.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateDocumentInput

Response

200 Success.

application/json Document

PUT /v1/documents/{id} Change a document, for a client written for PUT

The same as PATCH: it changes what the body names and nothing else.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateDocumentInput

Response

200 Success.

application/json Document

POST /v1/documents/{id}/cancel Stop reading a document

For filling in the details by hand. The file stays, and it can be read again.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json Document

POST /v1/documents/{id}/crop Crop a photo

A box as fractions of the page as it shows now. The original stays as it came: a new page is drawn from it and read again, and it stays cropped through every later read. Only images can be cropped.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json CropDocumentInput

Response

200 Success.

application/json Document

POST /v1/documents/{id}/fraud-review Record a person's decision on a document

Fraud, not fraud or unknown, with the signals they agree with. A re-read replaces the evidence and leaves this alone. Nobody decides on their own upload except the workspace owner.

Needs the documents:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Request body

application/json FraudReviewInput

Response

200 Success.

application/json Document

DELETE /v1/documents/{id}/line-items Delete every line item

The total stays as the receipt printed it.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/documents/{id}/line-items List a document's line items

Needs the documents:read scope. Try it

Parameters

`id` required	path	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ExpenseLinePage

POST /v1/documents/{id}/line-items Add a line item

The lines of the document's expense. When they added up to its total, a change to one moves the total and the converted amount with it. Refused once the expense is on a submitted report.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json ExpenseLineInput

Response

201 Success.

application/json ExpenseLine

DELETE /v1/documents/{id}/line-items/{lineId} Delete a line item

The lines of the document's expense. When they added up to its total, a change to one moves the total and the converted amount with it. Refused once the expense is on a submitted report.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`lineId` required	path	string

Response

204 Done, with no content.

GET /v1/documents/{id}/line-items/{lineId} Get a line item

Needs the documents:read scope. Try it

Parameters

`id` required	path	string
`lineId` required	path	string

Response

200 Success.

application/json ExpenseLine

PATCH /v1/documents/{id}/line-items/{lineId} Change a line item

The lines of the document's expense. When they added up to its total, a change to one moves the total and the converted amount with it. Refused once the expense is on a submitted report.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`lineId` required	path	string

Request body

application/json UpdateExpenseLineInput

Response

200 Success.

application/json ExpenseLine

GET /v1/documents/{id}/ofx Download a bank statement as OFX

OFX 1.0.2, the file accounting software and personal finance programs import, from the latest reading of a bank statement: the rules' reading, Claude's, or the bank_statement blueprint's. Each account on the statement gets its own transactions, with FITIDs that stay the same each time. Account and routing numbers are masked, so match the file to an account when importing it. A document that is not a statement, or one with nothing read from it, answers 409 saying which.

Needs the documents:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/x-ofx string (binary)

GET /v1/documents/{id}/original Get a short-lived link to the original file

Needs the documents:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json DocumentOriginal

GET /v1/documents/{id}/pdf Download a document as a PDF

A file that already is a PDF answers 302 to a short-lived link on storage, so follow the redirect, without your Authorization header. Anything else is built on the spot and comes back here.

Needs the documents:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/pdf string (binary)

POST /v1/documents/{id}/reprocess Read a document again

Fields a person changed are left alone.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

201 Success.

application/json Document

POST /v1/documents/{id}/reveal Open the bank and tax numbers read from a document

Needs the documents.reveal permission and, for a key, the documents:reveal scope. Every call writes an audit row. Also returns a link to the original file and, for a check, its TIFF images. Nothing else hands these out.

Needs the documents:reveal scope. Needs the documents.reveal permission. Try it

Parameters

id required path string

Request body (optional)

application/json RevealDocumentInput

Response

200 Success.

application/json RevealedDocument

POST /v1/documents/{id}/rotate Turn a page

A quarter turn, counter-clockwise by default. The original stays as it came: a new page is drawn from it and read again, and it stays turned through every later read.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body (optional)

application/json RotateDocumentInput

Response

200 Success.

application/json Document

POST /v1/documents/{id}/split Split a PDF already uploaded

Every page, or the ranges given. Each part is a document and counts as a scan, and the whole goes to the trash once the parts exist.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`client`	query	`ios` `android` The app sending the file. Leave it out in a browser.

Request body

application/json SplitDocumentInput

Response

202 Success.

application/json DocumentSet

DELETE /v1/documents/{id}/tags Take every tag off a document

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/documents/{id}/tags List a document's tags

Any type of document: receipts, checks, bank statements, business cards, contracts, tax forms and the rest.

Needs the documents:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json DocumentTagList

POST /v1/documents/{id}/tags Add several tags to a document

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json DocumentTagsInput

Response

200 Success.

application/json DocumentTagList

PUT /v1/documents/{id}/tags Add a tag to a document

By name. A name the workspace does not have makes the tag. Adding one it already has changes nothing.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json DocumentTagInput

Response

200 Success.

application/json DocumentTagList

DELETE /v1/documents/{id}/tags/{tagId} Take a tag off a document

The tag stays in the workspace.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`tagId` required	path	string

Response

204 Done, with no content.

GET /v1/documents/{id}/tax-lines List a document's tax lines

Needs the documents:read scope. Try it

Parameters

`id` required	path	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ExpenseTaxLinePage

POST /v1/documents/{id}/tax-lines Add a tax line

The expense's tax is the sum of its tax lines. When its total was what is under the tax and on top of it, the total moves with the tax. Refused once the expense is on a submitted report.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json ExpenseTaxLineInput

Response

201 Success.

application/json ExpenseTaxLine

DELETE /v1/documents/{id}/tax-lines/{taxLineId} Delete a tax line

The expense's tax is the sum of its tax lines. When its total was what is under the tax and on top of it, the total moves with the tax. Refused once the expense is on a submitted report.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`taxLineId` required	path	string

Response

204 Done, with no content.

GET /v1/documents/{id}/tax-lines/{taxLineId} Get a tax line

Needs the documents:read scope. Try it

Parameters

`id` required	path	string
`taxLineId` required	path	string

Response

200 Success.

application/json ExpenseTaxLine

PATCH /v1/documents/{id}/tax-lines/{taxLineId} Change a tax line

The expense's tax is the sum of its tax lines. When its total was what is under the tax and on top of it, the total moves with the tax. Refused once the expense is on a submitted report.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`taxLineId` required	path	string

Request body

application/json UpdateExpenseTaxLineInput

Response

200 Success.

application/json ExpenseTaxLine

GET /v1/documents/{id}/text Get the text read from a document

Needs the documents:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json DocumentText

POST /v1/documents/any Read a document with a blueprint

Multipart with a field named file, or JSON with uploadId, file_url or file_data. The answer is in blueprint.result. Without a Claude key on the server, blueprint.error says so and the text is still read. 20 pages by default and 50 at most.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`blueprint_name` required	string
`blueprint_version`	integer
`max_pages_to_process`	integer

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`blueprint_name` required	string
`blueprint_version`	integer
`max_pages_to_process`	integer

Response

201 Success.

application/json Document

POST /v1/documents/any/async Read a document with a blueprint, in the background

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Answers at once. document.processed says when it is done.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`blueprint_name` required	string
`blueprint_version`	integer
`max_pages_to_process`	integer

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`blueprint_name` required	string
`blueprint_version`	integer
`max_pages_to_process`	integer

Response

202 Success.

application/json Document

POST /v1/documents/batch Submit up to 100 addresses at once

Answers at once with a set. Each address becomes a document with its own webhook, and an address that fails is listed under refused without stopping the rest.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json BatchDocumentsInput

Response

202 Success.

application/json DocumentSet

POST /v1/documents/bulk Act on many documents

Send ids, or a filter to act on everything that matches. With a filter, call again with nextCursor until it is null.

Needs the documents:write scope. Needs a live plan. Try it

Request body

application/json BulkDocumentInput

Response

200 Success.

application/json BulkDocumentResult

POST /v1/documents/classify Say what a document is

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Answers with a value and a score, from the built-in list or from document_types. It works with no Claude key for the common types, and Claude only decides what the rules cannot.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`document_types`	array of string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`document_types`	array of string

Response

201 Success.

application/json Classification

GET /v1/documents/count Count the documents a filter matches

Needs the documents:read scope. Try it

Parameters

`type`	query	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`status`	query	`UPLOADED` `PROCESSING` `PROCESSED` `FAILED`
`source`	query	`WEB` `IOS` `ANDROID` `EMAIL` `API` `MAIL_IN` `INTEGRATION`
`source_id`	query	string
`external_id`	query	string
`blueprint_name`	query	string
`owner`	query	string
`device_id`	query	string
`device_user_uuid`	query	string
`viewed`	query	boolean
`trashed`	query	boolean
`envelope`	query	string
`created__gt`	query	string or string (date-time)
`created__gte`	query	string or string (date-time)
`created__lt`	query	string or string (date-time)
`created__lte`	query	string or string (date-time)
`updated__gt`	query	string or string (date-time)
`updated__gte`	query	string or string (date-time)
`updated__lt`	query	string or string (date-time)
`updated__lte`	query	string or string (date-time)
`issued`	query	string
`issued__gt`	query	string
`issued__gte`	query	string
`issued__lt`	query	string
`issued__lte`	query	string
`total`	query	integer
`total__gt`	query	integer
`total__gte`	query	integer
`total__lt`	query	integer
`total__lte`	query	integer
`tax`	query	integer
`tax__gt`	query	integer
`tax__gte`	query	integer
`tax__lt`	query	integer
`tax__lte`	query	integer
`currency`	query	string
`category`	query	string
`vendor`	query	string
`notes`	query	string
`payment_type`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`last_four_digits`	query	string
`first_name`	query	string
`last_name`	query	string
`work_phone`	query	string
`cell_phone`	query	string
`company`	query	string
`email`	query	string
`website`	query	string
`country`	query	string
`state`	query	string
`city`	query	string
`zip`	query	string
`name`	query	string
`is_empty`	query	string
`order_by`	query	`created` `updated` `issued` `total` `tax` `-created` `-updated` `-issued` `-total` `-tax`
`folderId`	query	string
`mailInBatchId`	query	string
`setId`	query	string
`externalId`	query	string
`tag`	query	string
`archived`	query	boolean
`unviewed`	query	boolean
`q`	query	string
`from`	query	string
`to`	query	string
`fraudColor`	query	`GREEN` `YELLOW` `RED`
`fraudSignal`	query	`digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`fraudReview`	query	`PENDING` `FRAUD` `NOT_FRAUD` `UNKNOWN`

Response

200 Success.

application/json DocumentCount

POST /v1/documents/extract Say what a document is and read it, in one call

Multipart with a field named file, or JSON with uploadId, file_url or file_data. document_types may name built-in types and blueprints. Answers with extraction, or extraction_error when it could not be read.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`document_types`	array of string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`document_types`	array of string

Response

201 Success.

application/json Extraction

POST /v1/documents/split Split a PDF on storage into documents

The PDF named by uploadId, from POST /v1/uploads with purpose document_set, up to 50 MB. mode says where it is cut, and detect is the default. Each part is a document, counts as a scan and is held to 25 MB: a part past that is listed under refused, and the rest are filed.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

client

query

ios android

The app sending the file. Leave it out in a browser.

Request body

application/json SplitUploadInput

Response

202 Success.

application/json DocumentSet

GET /v1/documents/trash List deleted documents

Each can be restored for 30 days.

Needs the documents:read scope. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json TrashedDocumentPage

POST /v1/documents/trash Restore deleted documents, or delete them for good

Needs the documents:write scope. Needs a live plan. Try it

Request body

application/json TrashActionInput

Response

200 Success.

application/json TrashActionResult

POST /v1/documents/url Submit a file by URL or base64

By default the call waits up to 30 seconds and returns the extraction with 201. With async: true, or if reading takes longer, it answers 202 and the document.processed webhook says when it is done. file_url must be public https; redirects are not followed. file_urls reads several images as one document, in order. bucket and package_path read from your own S3 bucket, with keys saved in document settings. Use a JPEG, PNG, WebP, HEIC, TIFF, PDF, DOCX, XLSX, CSV, TXT, HTML, EML or ZIP file. Up to 25 MB, or 50 MB for a PDF sent to be split into a set of documents. Reads best at 300 DPI for a PDF and 1000 pixels on the shorter side of an image. A ZIP unpacks into one document per file, up to 200 files and 200 MB, and each file counts against the plan. A ZIP inside a ZIP is refused.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

202 Accepted. The document is still being read.

application/json DocumentUpload

documents set

GET /v1/documents-set List sets of documents

Includes ZIPs and batches of addresses.

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json DocumentSetPage

POST /v1/documents-set Split a PDF and read each document in it

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Up to 250 pages and 50 MB. Answers at once. Each part fires document.processed and counts as a scan, and document_set.completed says when all are read.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`external_id`	string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string

Response

202 Success.

application/json DocumentSet

GET /v1/documents-set/{id} Get a set and the documents it made

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json DocumentSet

expenses

GET /v1/expenses List expenses

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`sort`	query	`date:asc` `date:desc` `merchant:asc` `merchant:desc` `category:asc` `category:desc` `status:asc` `status:desc` `amount:asc` `amount:desc`
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ExpensePage

POST /v1/expenses Create an expense

Needs the expenses:write scope. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json CreateExpenseInput

Response

201 Success.

application/json ExpenseDetail

DELETE /v1/expenses/{id} Void an expense

A voided expense stays for audit and leaves every total.

Needs the expenses:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/expenses/{id} Get an expense

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json ExpenseDetail

PATCH /v1/expenses/{id} Change an expense

Send If-Match with the updatedAt you last read to make this conditional: if someone changed the expense since, it answers 409 CONFLICT with details.reason STALE_WRITE and changes nothing.

Needs the expenses:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`If-Match`	header	string The expense's updatedAt, as read.

Request body

application/json UpdateExpenseInput

Response

200 Success.

application/json ExpenseDetail

GET /v1/expenses/{id}/comments List comments on an expense

Needs the expenses:read scope. Try it

Parameters

`id` required	path	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json CommentPage

POST /v1/expenses/{id}/comments Comment on an expense

Needs the expenses:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`Idempotency-Key`	header	string Replaying a key returns the first record instead of creating, and charging for, a second. While the first request is still running, a retry answers 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After, and is not charged. The same key on a different request answers 409 IDEMPOTENCY_CONFLICT.

Request body (optional)

application/json CommentInput

Response

201 Success.

application/json PostedComment

POST /v1/expenses/{id}/comments/{commentId}/reach Reach someone a comment on this expense could not

An expense has no participants of its own, so they join the report it is on, and then they are told. Refused when it is on no report.

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

`id` required	path	string
`commentId` required	path	string

Request body (optional)

application/json ReachMentionedInput

Response

200 Success.

application/json Reached

GET /v1/expenses/{id}/comments/mentionable List who a comment on this expense can mention

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json MentionablePeople

POST /v1/expenses/{id}/duplicate Copy an expense, dated today, with no receipt

Needs the expenses:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

201 Success.

application/json CreatedId

GET /v1/expenses/{id}/duplicates List an expense and its possible duplicates

Every copy in the group, not just a pair. hidden counts any the caller cannot read.

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json ExpenseDuplicateGroup

POST /v1/expenses/{id}/flags/{code}/dismiss Dismiss a flag on an expense

For whoever has it for approval, or someone who manages expenses. The flag goes from the expense and stays in the audit log. Not for a hold.

Needs the expenses:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

`id` required	path	string
`code` required	path	string

Request body (optional)

application/json DismissFlagInput

Response

200 Success.

application/json Hold

POST /v1/expenses/{id}/hold Put an expense on hold

Needs the expenses:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Request body (optional)

application/json HoldExpenseInput

Response

200 Success.

application/json Hold

POST /v1/expenses/{id}/receipts Attach a receipt to an expense

Multipart, or JSON naming an uploadId from POST /v1/uploads. add files it beside what is there, and a first receipt on a receipt expense is read onto it. replace takes the current ones to the trash and reads the new one. Fields a person changed are left alone.

Needs the documents:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`client`	query	`ios` `android` The app sending the file. Leave it out in a browser.

Request body

multipart/form-data

`file` required	string (binary)
`mode`	`add` `replace`
`clientId`	string
`deviceId`	string

application/json

`uploadId` required	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`mode`	`add` `replace`
`clientId`	string
`deviceId`	string

Response

201 Success.

application/json Document

POST /v1/expenses/{id}/settle-duplicates Answer a duplicate question

keep all takes the hold off every one of them. keep selected keeps this one, discards the others and can take values from them, all in one step. The submitter and whoever holds the open approval can do this on an outstanding report.

Needs the expenses:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json SettleDuplicatesInput

Response

200 Success.

application/json ExpenseDetail

POST /v1/expenses/{id}/unhold Take an expense off hold

Needs the expenses:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Response

200 Success.

application/json Hold

POST /v1/expenses/bulk Change many expenses

Needs the expenses:write scope. Needs a live plan. Try it

Request body

application/json BulkExpenseInput

Response

201 Success.

application/json BulkExpenseResult

GET /v1/expenses/totals Total the expenses that match a filter, or the ones selected, in any currency

Needs the expenses:read scope. Try it

Parameters

`status`	query	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	query	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	query	string
`scope`	query	`mine` `all`
`categoryId`	query	string
`merchantId`	query	string
`projectId`	query	string
`clientId`	query	string
`tagId`	query	string
`department`	query	string
`reportId`	query	string
`externalId`	query	string
`unreported`	query	boolean
`needsReview`	query	boolean
`billable`	query	boolean
`reimbursable`	query	boolean
`moneyFlow`	query	`IN` `OUT`
`dateField`	query	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	query	string
`to`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`q`	query	string
`ids`	query	string or array of string
`currency`	query	string

Response

200 Success.

application/json ExpenseTotals

export history

GET /v1/export-history List which documents went where

Files from exports, postings to connected services, and what programs recorded, with the id each has there. Needs expenses.read_all.

Needs the documents:read scope. Needs the expenses.read_all permission. Try it

Parameters

`documentId`	query	string
`target`	query	string
`externalId`	query	string
`via`	query	`EXPORT` `SYNC` `API`
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ExportRecordPage

POST /v1/export-history Record that documents went somewhere

For an export a program made itself. A record already held is not written again, so a retry is safe.

Needs the documents:write scope. Needs a live plan. Try it

Request body

application/json ExportRecordInput

Response

201 Success.

application/json ExportRecordsAppended

exports

GET /v1/exports List exports

Needs the expenses:read scope. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ExportJobPage

POST /v1/exports Start an export

Filters select by expense, or by report with reportState, reportIds, startDate and endDate (one year at most), approvedAfter and exported. policyIds takes workspace ids, and a key can only name its own. template is the file's whole layout as text, with ${expense.merchant}, <#list reports as report> and <#if report.exported>, and takes CSV, TXT, JSON or XML: a mistake in it answers 422 with the line. onFinish can email the file, mark the reports it covers as exported, which needs reports:write, and upload it by SFTP. SFTP needs the host key fingerprint of the server, refuses a private address, and never returns the credentials.

Needs the expenses:read scope. Try it

Request body

application/json CreateExportInput

Response

201 Success.

application/json ExportJob

GET /v1/exports/{id} Get an export and, when ready, its link

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json ExportJob

folders

GET /v1/folders List folders

Needs the documents:read scope. Try it

Parameters

`q`	query	string
`parentId`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json FolderPage

POST /v1/folders Create a folder

Needs the documents:write scope. Needs the expenses.write_all permission. Needs a live plan. Try it

Request body

application/json FolderInput

Response

201 Success.

application/json Folder

DELETE /v1/folders/{id} Delete a folder

Needs the documents:write scope. Needs the expenses.write_all permission. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/folders/{id} Get a folder

Needs the documents:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json Folder

PATCH /v1/folders/{id} Change a folder

Needs the documents:write scope. Needs the expenses.write_all permission. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateFolderInput

Response

200 Success.

application/json Folder

forwarding

GET /v1/forwarding/emails List email sent to the caller's forwarding addresses

Every message, filed or not, with the sender, subject, received time, whether it carried a file, and any file left out and why.

Needs the documents:read scope. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json InboundEmailPage

fraud

GET /v1/fraud/blocklist List blocked devices

Needs the documents:read scope. Needs the expenses.read_all permission. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json DeviceBlockPage

POST /v1/fraud/blocklist Block a device

A blocked device still captures. Its documents read red, with the reason stated, for a reviewer.

Needs the documents:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Request body

application/json BlockDeviceInput

Response

201 Success.

application/json DeviceBlock

DELETE /v1/fraud/blocklist/{deviceId} Remove a device from the blocklist

Needs the documents:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

deviceId required path string

Response

204 Done, with no content.

GET /v1/fraud/blocklist/{deviceId} Check whether a device is blocked

A device nobody blocked answers blocked: false, not 404.

Needs the documents:read scope. Needs the expenses.read_all permission. Try it

Parameters

deviceId required path string

Response

200 Success.

application/json DeviceBlockStatus

GET /v1/fraud/export Download the evidence on documents that match a filter

The same filter as listing documents. Needs expenses.read_all.

Needs the documents:read scope. Needs the expenses.read_all permission. Try it

Parameters

`type`	query	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`status`	query	`UPLOADED` `PROCESSING` `PROCESSED` `FAILED`
`source`	query	`WEB` `IOS` `ANDROID` `EMAIL` `API` `MAIL_IN` `INTEGRATION`
`source_id`	query	string
`external_id`	query	string
`blueprint_name`	query	string
`owner`	query	string
`device_id`	query	string
`device_user_uuid`	query	string
`viewed`	query	boolean
`trashed`	query	boolean
`envelope`	query	string
`created__gt`	query	string or string (date-time)
`created__gte`	query	string or string (date-time)
`created__lt`	query	string or string (date-time)
`created__lte`	query	string or string (date-time)
`updated__gt`	query	string or string (date-time)
`updated__gte`	query	string or string (date-time)
`updated__lt`	query	string or string (date-time)
`updated__lte`	query	string or string (date-time)
`issued`	query	string
`issued__gt`	query	string
`issued__gte`	query	string
`issued__lt`	query	string
`issued__lte`	query	string
`total`	query	integer
`total__gt`	query	integer
`total__gte`	query	integer
`total__lt`	query	integer
`total__lte`	query	integer
`tax`	query	integer
`tax__gt`	query	integer
`tax__gte`	query	integer
`tax__lt`	query	integer
`tax__lte`	query	integer
`currency`	query	string
`category`	query	string
`vendor`	query	string
`notes`	query	string
`payment_type`	query	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`last_four_digits`	query	string
`first_name`	query	string
`last_name`	query	string
`work_phone`	query	string
`cell_phone`	query	string
`company`	query	string
`email`	query	string
`website`	query	string
`country`	query	string
`state`	query	string
`city`	query	string
`zip`	query	string
`name`	query	string
`is_empty`	query	string
`order_by`	query	`created` `updated` `issued` `total` `tax` `-created` `-updated` `-issued` `-total` `-tax`
`folderId`	query	string
`mailInBatchId`	query	string
`setId`	query	string
`externalId`	query	string
`tag`	query	string
`archived`	query	boolean
`unviewed`	query	boolean
`q`	query	string
`from`	query	string
`to`	query	string
`fraudColor`	query	`GREEN` `YELLOW` `RED`
`fraudSignal`	query	`digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`fraudReview`	query	`PENDING` `FRAUD` `NOT_FRAUD` `UNKNOWN`

Response

200 Success.

text/csv string (binary)

integrations

GET /v1/integrations List connected services and what can be connected

Needs the integrations:read scope. Try it

Response

200 Success.

application/json IntegrationList

GET /v1/integrations/{provider}/health See how a connection stands

Needs the integrations:read scope. Needs the integrations.manage permission. Try it

Parameters

provider required

path

string

The service, by its slug: quickbooks-online, quickbooks-desktop, xero, freshbooks, wave, zoho-books, sage, microsoft-dynamics, myob, oracle, sap, netsuite, gusto, hr, gmail, google-drive, dropbox, box, onedrive, slack, zapier.

Response

200 Success.

application/json IntegrationHealth

GET /v1/integrations/{provider}/records List what was sent to a service

Each record names the expense and the id it has in the other system.

Needs the integrations:read scope. Needs the integrations.manage permission. Try it

Parameters

`provider` required	path	string The service, by its slug: quickbooks-online, quickbooks-desktop, xero, freshbooks, wave, zoho-books, sage, microsoft-dynamics, myob, oracle, sap, netsuite, gusto, hr, gmail, google-drive, dropbox, box, onedrive, slack, zapier.
`state`	query	`PENDING` `SYNCED` `FAILED` `SKIPPED` `VOIDED`
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json SyncRecordPage

invitations

GET /v1/invitations List invitations

Needs the members:read scope. Needs the members.manage permission. Try it

Parameters

`status`	query	`PENDING` `EXPIRED` `ACCEPTED` `REVOKED`
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json InvitationPage

POST /v1/invitations Invite someone to this workspace

They join when they accept, signed in with this address. An open invitation holds a seat.

Needs the members:write scope. Needs the members.manage permission. Needs a live plan. Try it

Request body

application/json CreateInvitationInput

Response

201 Success.

application/json InvitationSent

DELETE /v1/invitations/{id} Withdraw an invitation

Works on a lapsed plan.

Needs the members:write scope. Needs the members.manage permission. Try it

Parameters

id required path string

Response

204 Done, with no content.

POST /v1/invitations/{id}/resend Send an invitation again

A new link. The old one stops working.

Needs the members:write scope. Needs the members.manage permission. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json InvitationSent

POST /v1/invitations/import Invite many people from CSV

Send the CSV as text/plain, or as JSON with a csv field, with an Email column and an optional Role column.

Needs the members:write scope. Needs the members.manage permission. Needs a live plan. Try it

Request body

application/json CatalogImportInput

Response

201 Success.

application/json CatalogImportResult

mail in

GET /v1/mail-in List mail-in batches

A member sees the batches they asked for.

Needs the mailin:read scope. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json MailInBatchPage

POST /v1/mail-in Request envelopes and a mail-in batch

envelopes is how many to send, and the answer says how many can still be requested this week. The estimate holds that many documents of this month's allowance. Both holds commit with the batch, or not at all. Left out, afterScan follows the workspace's shredding setting.

Needs the mailin:write scope. Needs the mail_in plan feature. Needs a live plan. Try it

Request body

application/json CreateMailInInput

Response

201 Success.

application/json MailInRequested

GET /v1/mail-in/{id} Get a mail-in batch

Needs the mailin:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json MailInBatch

PATCH /v1/mail-in/{id} Change the address on a batch

For the person who asked or a manager, until the batch finishes. A batch's code cannot be changed.

Needs the mailin:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json ChangeMailInAddressInput

Response

200 Success.

application/json MailInBatch

GET /v1/mail-in/{id}/barcode Get a batch's barcode

A Code 128 image of the batch reference.

Needs the mailin:read scope. Try it

Parameters

id required path string

Response

200 Success.

image/png string (binary)

POST /v1/mail-in/{id}/cancel Cancel a batch nobody has started on

Needs the mailin:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json MailInBatch

GET /v1/mail-in/{id}/cover-sheet Get a batch's cover sheet

Needs the mailin:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/pdf string (binary)

GET /v1/mail-in/{id}/documents List what came out of a batch

Needs the mailin:read scope. Try it

Parameters

`id` required	path	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json MailInDocumentPage

GET /v1/mail-in/allowance See this month's paper allowance

Needs the mailin:read scope. Try it

Response

200 Success.

application/json MailInAllowance

GET /v1/mail-in/barcode Get the workspace's barcode

A Code 128 image of the workspace reference.

Needs the mailin:read scope. Try it

Response

200 Success.

image/png string (binary)

GET /v1/mail-in/cover-sheet Get the workspace's cover sheet

One page to put on top of a stack of paper, with the barcode on it.

Needs the mailin:read scope. Try it

Response

200 Success.

application/pdf string (binary)

GET /v1/mail-in/settings See your saved mail-in address

One person's own, in this workspace. Nobody else reads it.

Needs the mailin:read scope. Try it

Response

200 Success.

application/json MailInSettings

PUT /v1/mail-in/settings Save your mail-in address

Envelopes and returned paper go here when a request names no address. Null forgets it. Batches already requested keep theirs: change those one at a time.

Needs the mailin:write scope. Needs a live plan. Try it

Request body

application/json MailInSettingsInput

Response

200 Success.

application/json MailInSettings

me

DELETE /v1/me/forwarding-address Give up the chosen forwarding address

The random address keeps working. Only the chosen one stops.

Needs the documents:write scope. Try it

Response

204 Done, with no content.

POST /v1/me/forwarding-address Choose a forwarding address

Beside the random one, which keeps working. A name someone else holds is refused.

Needs the documents:write scope. Try it

Request body

application/json ForwardingAliasInput

Response

200 Success.

application/json ForwardingAlias

POST /v1/me/forwarding-address/rotate Issue a new forwarding address

The old address stops working the moment this one is issued.

Needs the documents:write scope. Try it

Response

201 Success.

application/json Me

members

GET /v1/members List the members of this workspace

Pay-adjacent fields stay empty unless the caller has members.manage.

Needs the members:read scope. Try it

Parameters

`q`	query	string
`status`	query	`ACTIVE` `SUSPENDED`
`role`	query	`OWNER` `ADMIN` `APPROVER` `ACCOUNTANT` `AUDITOR` `MEMBER` `EDITOR` `CARD_ADMIN` `PEOPLE_ADMIN` `PAYMENTS_ADMIN`
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json MemberPage

DELETE /v1/members/{id} Remove a member

Their expenses stay. Anyone may remove their own membership. Taking access away works on a lapsed plan.

Needs the members:write scope. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/members/{id} Get a member

Needs the members:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json Member

PATCH /v1/members/{id} Change a member

Only an owner can change an owner, or make someone an owner.

Needs the members:write scope. Needs the members.manage permission. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateMemberInput

Response

200 Success.

application/json Member

POST /v1/members/bulk Change many members at once

A member the rules refuse stays as they were, and the rest still change.

Needs the members:write scope. Needs the members.manage permission. Needs a live plan. Try it

Request body

application/json BulkMemberInput

Response

200 Success.

application/json BulkMemberResult

POST /v1/members/provision Provision and remove people from a list

From a request body or an https address, with a dry run. Answers with who was added, updated and removed, and who was skipped and why. A change of address needs a domain this workspace verified. SFTP is not offered.

Needs the members:write scope. Needs the members.manage permission. Try it

Request body

application/json ProvisionInput

Response

200 Success.

application/json ProvisionResult

GET /v1/members/seats See seats in use against the plan

Needs the members:read scope. Try it

Response

200 Success.

application/json SeatUsage

merchants

GET /v1/merchants List merchants

Needs the expenses:read scope. Try it

Parameters

`q`	query	string
`archived`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json MerchantPage

POST /v1/merchants Create a merchant

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Request body

application/json CreateMerchantInput

Response

201 Success.

application/json Merchant

GET /v1/merchants/{id} Get a merchant

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json Merchant

PATCH /v1/merchants/{id} Change a merchant

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json MerchantInput

Response

200 Success.

application/json Merchant

DELETE /v1/merchants/{id}/aliases/{aliasId} Remove a spelling from a merchant

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

`id` required	path	string
`aliasId` required	path	string

Response

200 Success.

application/json Merchant

POST /v1/merchants/{id}/merge Merge another merchant into this one

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json MergeMerchantInput

Response

200 Success.

application/json Merchant

mileage

POST /v1/mileage Record a trip

Needs the expenses:write scope. Needs the mileage plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json CreateTripInput

Response

201 Success.

application/json Trip

PUT /v1/mileage/{id} Replace a trip

Needs the expenses:write scope. Needs the mileage plan feature. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json CreateTripInput

Response

200 Success.

application/json Trip

POST /v1/mileage/{id}/odometer-photos Attach an odometer photo to a trip

Needs the expenses:write scope. Needs the mileage plan feature. Needs a live plan. Try it

Parameters

`id` required	path	string
`client`	query	`ios` `android` The app sending the file. Leave it out in a browser.

Request body

multipart/form-data

`file` required	string (binary)
`reading` required	`START` `END`

application/json

`uploadId` required	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`reading` required	`START` `END`

Response

201 Success.

application/json Trip

GET /v1/mileage/log Read the mileage log

Needs the expenses:read scope. Try it

Parameters

`from`	query	string
`to`	query	string
`scope`	query	`mine` `all`
`ownerId`	query	string
`vehicleId`	query	string
`purpose`	query	`business` `medical` `charity`

Response

200 Success.

application/json MileageLog

GET /v1/mileage/log/export Export the mileage log

The file comes back as JSON, with its content as text.

Needs the expenses:read scope. Try it

Parameters

`from`	query	string
`to`	query	string
`scope`	query	`mine` `all`
`ownerId`	query	string
`vehicleId`	query	string
`purpose`	query	`business` `medical` `charity`

Response

200 Success.

application/json DownloadableFile

GET /v1/mileage/routes List saved routes

Needs the expenses:read scope. Try it

Parameters

q query string

Response

200 Success.

application/json TripRoutes

mileage rates

GET /v1/mileage-rates List mileage rates

Needs the expenses:read scope. Try it

Parameters

`q`	query	string
`archived`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json MileageRatePage

GET /v1/mileage-rates/{id} Get a mileage rate

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json MileageRate

parse

GET /v1/parse List documents turned into Markdown

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

`details`	query	boolean
`tag`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ParsedDocumentPage

POST /v1/parse Turn a document into Markdown

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Tables and reading order are kept. details adds a box for each line, and meta holds pages, sharpness and OCR scores. Up to 50 pages.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`details`	boolean

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`details`	boolean

Response

201 Success.

application/json ParsedDocument

DELETE /v1/parse/{id} Delete one

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/parse/{id} Get a document as Markdown

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

`id` required	path	string
`details`	query	boolean
`tag`	query	string

Response

200 Success.

application/json ParsedDocument

PATCH /v1/parse/{id} Change the title, notes or tags of one

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json ParseUpdateInput

Response

200 Success.

application/json ParsedDocument

POST /v1/parse/async Turn a document into Markdown, in the background

Answers at once. document.processed says when it is done.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`details`	boolean

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`details`	boolean

Response

202 Success.

application/json ParsedDocument

parse set

GET /v1/parse-set List Markdown sets

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json DocumentSetPage

POST /v1/parse-set Split a PDF and turn each document in it into Markdown

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Up to 50 MB. Answers at once.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`external_id`	string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string

Response

202 Success.

application/json DocumentSet

GET /v1/parse-set/{id} Get a Markdown set

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json DocumentSet

payment accounts

GET /v1/payment-accounts List cards and bank accounts

A member sees their own and those of the people reporting to them. Numbers are last four only.

Needs the cards:read scope. Try it

Parameters

`archived`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json PaymentAccountPage

GET /v1/payment-accounts/{id} Get a card or bank account

Needs the cards:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json PaymentAccount

GET /v1/payment-accounts/{id}/statements List a card's statement periods

Needs the cards:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json CardStatements

GET /v1/payment-accounts/export Export the card table

The file comes back as JSON, with its content as text.

Needs the cards:read scope. Try it

Response

200 Success.

application/json DownloadableFile

per diem

POST /v1/per-diem Record a per diem

Meals and lodging file as separate expenses, so each deducts at its own percentage.

Needs the expenses:write scope. Needs the per_diem plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json CreatePerDiemInput

Response

201 Success.

application/json ExpenseDetails

per diem rates

GET /v1/per-diem-rates List per diem rates

Needs the expenses:read scope. Try it

Parameters

`q`	query	string
`archived`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json PerDiemRatePage

GET /v1/per-diem-rates/{id} Get a per diem rate

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json PerDiemRate

personal rules

GET /v1/personal-rules List a person's rules

The caller's own, or with ownerId, an employee's. Naming someone else needs policies.manage.

Needs the rules:read scope. Try it

Parameters

ownerId query string

Response

200 Success.

application/json AutomationRuleList

POST /v1/personal-rules Add a rule for a person

For the caller, or with ownerId, for an employee. It runs on what that person spends, and can set tags and billable.

Needs the rules:write scope. Needs a live plan. Try it

Request body

application/json PersonalRuleInput

Response

201 Success.

application/json AutomationRule

DELETE /v1/personal-rules/{id} Delete a person's rule

Name the person with ownerId when the rule is not the caller's.

Needs the rules:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`ownerId`	query	string

Response

204 Done, with no content.

PATCH /v1/personal-rules/{id} Change a person's rule

Name the person with ownerId when the rule is not the caller's.

Needs the rules:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json PersonalRuleInput

Response

200 Success.

application/json AutomationRule

POST /v1/personal-rules/reorder Put the caller's own rules in a new order

Needs the rules:write scope. Needs a live plan. Try it

Request body

application/json ReorderAutomationRulesInput

Response

200 Success.

application/json AutomationRuleOrder

projects

GET /v1/projects List projects

Needs the expenses:read scope. Try it

Parameters

`q`	query	string
`archived`	query	string
`clientId`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ProjectPage

POST /v1/projects Create a project

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Request body

application/json ProjectInput

Response

201 Success.

application/json Project

DELETE /v1/projects/{id} Delete a project

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/projects/{id} Get a project

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json Project

PATCH /v1/projects/{id} Change a project

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateProjectInput

Response

200 Success.

application/json Project

POST /v1/projects/import Import projects from CSV

Send the CSV as text/plain, or as JSON with a csv field. Rows that match an existing project update it.

Needs the expenses:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Request body

application/json CatalogImportInput

Response

201 Success.

application/json CatalogImportResult

reference

GET /v1/reference/countries List country codes and the currency each prints

Needs the expenses:read scope. Try it

Response

200 Success.

application/json ReferenceCountryPage

GET /v1/reference/currencies List currency codes

Needs the expenses:read scope. Try it

Response

200 Success.

application/json ReferenceCurrencyPage

GET /v1/reference/locales List the locales offered in a picker

A workspace can hold any language tag; these are the usual ones.

Needs the expenses:read scope. Try it

Response

200 Success.

application/json ReferenceLocalePage

GET /v1/reference/system-categories List the categories a new workspace starts with

A workspace's own are at GET /v1/categories.

Needs the expenses:read scope. Try it

Response

200 Success.

application/json ReferenceSystemCategoryPage

release notifications

GET /v1/release-notifications List release notes

Versioned notes on what changed, newest first. Any key or token may read them, whatever its scopes.

Any API key or OAuth token can call this, whatever it holds. Try it

Parameters

`product`	query	`app_web` `api` `mcp` `model_document_extraction` `model_bank_statements` `model_checks` `model_fraud_detection`
`environment`	query	`production` `sandbox`
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ReleaseNotePage

report fields

GET /v1/report-fields List report fields

Needs the workspace:read scope. Try it

Response

200 Success.

application/json ReportFieldList

POST /v1/report-fields Add a report field

TEXT, DATE, LIST for a dropdown, or FORMULA.

Needs the workspace:write scope. Needs the settings.manage permission. Needs the custom_fields plan feature. Needs a live plan. Try it

Request body

application/json ReportFieldInput

Response

201 Success.

application/json ReportField

DELETE /v1/report-fields/{id} Delete a report field

Needs the workspace:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

PATCH /v1/report-fields/{id} Change a report field

Name and type stay as they were created, since reports already hold values by them.

Needs the workspace:write scope. Needs the settings.manage permission. Needs the custom_fields plan feature. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateReportFieldInput

Response

200 Success.

application/json ReportField

POST /v1/report-fields/turn-off Turn report fields off

Lists are kept and turned off, and the rest are deleted.

Needs the workspace:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Response

200 Success.

application/json ReportFieldsOff

reports

GET /v1/reports List reports

Needs the reports:read scope. Try it

Parameters

`status`	query	`DRAFT` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `EXPORTED` `CLOSED` or array of `DRAFT` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `EXPORTED` `CLOSED`
`scope`	query	`mine` `all` `assigned`
`ownerId`	query	string
`q`	query	string
`from`	query	string
`to`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ReportPage

POST /v1/reports Create a report

Needs the reports:write scope. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body (optional)

application/json CreateReportInput

Response

201 Success.

application/json ReportDetail

DELETE /v1/reports/{id} Delete a draft report

Needs the reports:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/reports/{id} Get a report

Needs the reports:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json ReportDetail

PATCH /v1/reports/{id} Change a report

Needs the reports:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateReportInput

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/accept-findings Accept what the receipt checks found

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/approve Approve a report

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Request body (optional)

application/json ApproveReportInput

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/close Close a report

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Response

200 Success.

application/json ReportDetail

GET /v1/reports/{id}/comments List comments on a report

Needs the reports:read scope. Try it

Parameters

`id` required	path	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json CommentPage

POST /v1/reports/{id}/comments Comment on a report

Needs the reports:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`Idempotency-Key`	header	string Replaying a key returns the first record instead of creating, and charging for, a second. While the first request is still running, a retry answers 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After, and is not charged. The same key on a different request answers 409 IDEMPOTENCY_CONFLICT.

Request body (optional)

application/json CommentInput

Response

201 Success.

application/json PostedComment

POST /v1/reports/{id}/comments/{commentId}/reach Reach someone a comment on this report could not

The author adds them to the report, and then they are told.

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

`id` required	path	string
`commentId` required	path	string

Request body (optional)

application/json ReachMentionedInput

Response

200 Success.

application/json Reached

GET /v1/reports/{id}/comments/mentionable List who a comment on this report can mention

Needs the reports:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json MentionablePeople

POST /v1/reports/{id}/duplicate Start a new report from this one

Needs the reports:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

201 Success.

application/json ReportDetail

POST /v1/reports/{id}/expenses Add expenses to a report

Needs the reports:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json ReportExpensesInput

Response

200 Success.

application/json ReportDetail

DELETE /v1/reports/{id}/expenses/{expenseId} Take an expense off a report

Needs the reports:write scope. Needs a live plan. Try it

Parameters

`id` required	path	string
`expenseId` required	path	string

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/expenses/{expenseId}/reject Reject one expense on a report

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

`id` required	path	string
`expenseId` required	path	string

Request body (optional)

application/json RejectExpenseInput

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/mark-exported Mark a report as exported

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/mark-reimbursed Mark a report as reimbursed

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/participants Add a person to a report

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Request body (optional)

application/json ReportParticipantInput

Response

200 Success.

application/json ReportDetail

DELETE /v1/reports/{id}/participants/{userId} Take a person off a report

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

`id` required	path	string
`userId` required	path	string

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/reassign Hand a report to another approver

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Request body (optional)

application/json ReassignReportInput

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/reject Send a report back

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Parameters

id required path string

Request body (optional)

application/json RejectReportInput

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/reopen Reopen a report

Needs the reports:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/retract Take a submitted report back

Needs the reports:write scope. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json ReportDetail

POST /v1/reports/{id}/submit Submit a report

Needs the reports:write scope. Needs a live plan. Try it

Parameters

id required path string

Request body (optional)

application/json SubmitReportInput

Response

200 Success.

application/json ReportDetail

POST /v1/reports/bulk-reassign Hand many reports to another approver

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Request body

application/json BulkReassignInput

Response

200 Success.

application/json BulkReportResult

POST /v1/reports/bulk-submit Submit many reports

Needs the reports:write scope. Needs a live plan. Try it

Request body

application/json BulkReportsInput

Response

200 Success.

application/json BulkReportResult

POST /v1/reports/mark-reimbursed Mark many reports as reimbursed

Answers 200 when all of them went through, and 207 when some did not. A report that is not approved yet, already paid or in a batch is skipped. One the caller cannot find or mark has failed.

Needs the reports:write scope. Needs a live plan. Refuses a delegate on limited access. Try it

Request body

application/json BulkReportsInput

Response

200 Success.

application/json BulkReimbursed

207 Some went through. The body says what became of each.

application/json BulkReimbursed

split

GET /v1/split List splits

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json DocumentSetPage

POST /v1/split Find the documents in a PDF

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Returns page ranges and extracts nothing. Up to 250 pages and 50 MB. split_by_blank_page cuts on blank pages instead of detected boundaries.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`external_id`	string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string

Response

201 Success.

application/json DocumentSet

GET /v1/split/{id} Get a split

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json DocumentSet

POST /v1/split/async Find the documents in a PDF, in the background

Answers at once with the id. split.completed and split.created deliver the ranges, and split.failed says why not.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`external_id`	string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string

Response

202 Success.

application/json DocumentSet

split and classify

POST /v1/split-and-classify Find the documents in a PDF and say what each one is

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Each range has a type and a score, optionally from your own document_types.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`external_id`	string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string

Response

201 Success.

application/json DocumentSet

POST /v1/split-and-classify/async Find and classify the documents in a PDF, in the background

Answers at once. split.completed and split_and_classify.created deliver the same result, and split.failed and split_and_classify.failed say why not.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`external_id`	string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string

Response

202 Success.

application/json DocumentSet

tax

GET /v1/tax/summary Totals by tax line for a year

Needs the expenses:read scope. Try it

Parameters

year query integer

Response

200 Success.

application/json TaxSummary

time

POST /v1/time Record time

Needs the expenses:write scope. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json CreateTimeInput

Response

201 Success.

application/json ExpenseDetail

tls certificates

GET /v1/tls-certificates List the client certificates this workspace trusts

Needs the workspace:read scope. Needs the developer.manage permission. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json ClientCertificatePage

POST /v1/tls-certificates Add a client certificate

PEM, and never a private key. Only its SHA-256 fingerprint decides anything, and adding the same one twice is one row. Mutual TLS ends at the edge, and has to be set up for this server before a workspace can require it.

Needs the workspace:write scope. Needs the developer.manage permission. Needs a live plan. Try it

Request body

application/json CreateClientCertificateInput

Response

201 Success.

application/json ClientCertificate

DELETE /v1/tls-certificates/{id} Stop trusting a client certificate

The last one cannot go while the workspace requires one.

Needs the workspace:write scope. Needs the developer.manage permission. Try it

Parameters

id required path string

Response

204 Done, with no content.

transactions

GET /v1/transactions List card transactions

Needs the cards:read scope. Try it

Parameters

`state`	query	`UNMATCHED` `MATCHED` `IGNORED` `EXPENSED` `PENDING`
`paymentAccountId`	query	string
`paymentAccountIds`	query	string
`from`	query	string
`to`	query	string
`q`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`missingReceipt`	query	string
`unreported`	query	string
`currency`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json TransactionPage

GET /v1/transactions/{id} Get a card transaction

Needs the cards:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json Transaction

GET /v1/transactions/export Export card data

By date range and card, with unreported=true for lines on no report. Leave it out for all of them. The file comes back as JSON, with its content as text.

Needs the cards:read scope. Try it

Parameters

`state`	query	`UNMATCHED` `MATCHED` `IGNORED` `EXPENSED` `PENDING`
`paymentAccountId`	query	string
`paymentAccountIds`	query	string
`from`	query	string
`to`	query	string
`q`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`missingReceipt`	query	string
`unreported`	query	string
`currency`	query	string

Response

200 Success.

application/json DownloadableFile

GET /v1/transactions/reconciliation Reconcile card data for a date range

Imported, approved and what is stuck, by where it is stuck.

Needs the cards:read scope. Try it

Parameters

`from` required	query	string
`to` required	query	string
`paymentAccountId`	query	string
`feed`	query	string
`currency`	query	string

Response

200 Success.

application/json Reconciliation

GET /v1/transactions/summary Total the card transactions that match a filter

Needs the cards:read scope. Try it

Parameters

`state`	query	`UNMATCHED` `MATCHED` `IGNORED` `EXPENSED` `PENDING`
`paymentAccountId`	query	string
`paymentAccountIds`	query	string
`from`	query	string
`to`	query	string
`q`	query	string
`minMinor`	query	integer
`maxMinor`	query	integer
`missingReceipt`	query	string
`unreported`	query	string
`currency`	query	string

Response

200 Success.

application/json TransactionSummary

travel

GET /v1/travel/trips List travel trips

Trips filed from itineraries, newest first. Your own, or everyone's with scope=all when your role reads everyone's expenses. Trips driven are in the mileage log.

Needs the expenses:read scope. Try it

Parameters

`scope`	query	`mine` `all`
`from`	query	string
`to`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json TravelTripPage

GET /v1/travel/trips/{id} Get a travel trip

One trip, with its segments and the documents filed against it.

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json TravelTrip

uploads

POST /v1/uploads Sign an upload straight to storage

The way to send a file: its bytes do not pass through this API. Say what it is for and how big it is, PUT the file to the URL in the answer, then name the uploadId on that feature's route in place of a multipart file. The file's own bytes decide what it is. Video goes to an attachment, up to 500 MiB, and is never read.

Needs the documents:write scope. Needs a live plan. Try it

Request body

application/json CreateUploadInput

Response

201 Success.

application/json UploadTicket

vehicles

GET /v1/vehicles List vehicles

Needs the expenses:read scope. Try it

Parameters

`q`	query	string
`archived`	query	string
`userId`	query	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json VehiclePage

GET /v1/vehicles/{id} Get a vehicle

Needs the expenses:read scope. Try it

Parameters

id required path string

Response

200 Success.

application/json Vehicle

w 8ben e

POST /v1/w-8ben-e Read a Form W-8BEN-E

POST /v1/documents/url with the type fixed: the same body, wait and answer. Bank and tax numbers are masked; POST /v1/documents/{id}/reveal opens them.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

202 Accepted. The document is still being read.

application/json DocumentUpload

w2s

POST /v1/w2s Read a Form W-2

POST /v1/documents/url with the type fixed: the same body, wait and answer. Bank and tax numbers are masked; POST /v1/documents/{id}/reveal opens them.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

202 Accepted. The document is still being read.

application/json DocumentUpload

w2s set

GET /v1/w2s-set List W-2 sets

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json DocumentSetPage

POST /v1/w2s-set Split a PDF of W-2s and read each one

Multipart with a field named file, or JSON with uploadId, file_url or file_data. Up to 100 pages and 50 MB. Answers at once. w2_set.created says when every form is read, and w2_set.failed why not. Social security and employer numbers are masked in every view.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

multipart/form-data

`file` required	string (binary)
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`external_id`	string

application/json

Name the file with one of uploadId, file_url or file_data.

`uploadId`	string From POST /v1/uploads, once the file has been sent to the URL it answered with.
`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string A public https address to fetch the file from. Redirects are not followed.
`file_data`	string The file itself in base64, raw or as a data URI.
`file_name`	string What to call a file sent as file_url or file_data.
`external_id`	string

Response

202 Success.

application/json DocumentSet

GET /v1/w2s-set/{id} Get a W-2 set

Needs the documents:read scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

200 Success.

application/json DocumentSet

w9s

POST /v1/w9s Read a Form W-9

POST /v1/documents/url with the type fixed: the same body, wait and answer. Bank and tax numbers are masked; POST /v1/documents/{id}/reveal opens them.

Needs the documents:write scope. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json SubmitDocumentInput

Response

201 Success.

application/json DocumentUpload

202 Accepted. The document is still being read.

application/json DocumentUpload

webhooks

GET /v1/webhooks List webhook endpoints

Pending and confirmed alike. Endpoints that belong to one API key are left out unless you ask: send apiKeyId for one key, or include=keys for all of them.

Needs the webhooks:manage scope. Needs the developer.manage permission. Try it

Parameters

`apiKeyId`	query	string
`include`	query	`keys`
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json WebhookEndpointPage

POST /v1/webhooks Add a webhook endpoint

Step one of the handshake. The URL must be public https, and not on papertotal.com. The endpoint starts PENDING, and PaperTotal sends it one signed subscription event holding a one-time token in data.token. Confirm it with POST /v1/webhooks/confirm within a day. Until then it receives nothing else, and after that it is deleted. An address on hooks.zapier.com is confirmed at once, because a catch hook cannot run a handshake. Send apiKeyId to make this one key's own endpoint: documents that key submits report here and not to the workspace's endpoints, it takes document events only, and a key has one. Changing the URL later goes through the handshake again. The signing secret is in this response and the rotate response, and nowhere else.

Needs the webhooks:manage scope. Needs the developer.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Request body

application/json CreateWebhookInput

Response

201 Success.

application/json WebhookEndpointWithSecret

DELETE /v1/webhooks/{id} Delete a webhook endpoint

Needs the webhooks:manage scope. Needs the developer.manage permission. Try it

Parameters

id required path string

Response

204 Done, with no content.

GET /v1/webhooks/{id} Get a webhook endpoint

Needs the webhooks:manage scope. Needs the developer.manage permission. Try it

Parameters

id required path string

Response

200 Success.

application/json WebhookEndpoint

PATCH /v1/webhooks/{id} Change a webhook endpoint

Needs the webhooks:manage scope. Needs the developer.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Request body

application/json UpdateWebhookInput

Response

200 Success.

application/json WebhookEndpoint

GET /v1/webhooks/{id}/deliveries List an endpoint's deliveries

Needs the webhooks:manage scope. Needs the developer.manage permission. Try it

Parameters

`id` required	path	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json WebhookDeliveryPage

POST /v1/webhooks/{id}/rotate-secret Issue a new signing secret

Needs the webhooks:manage scope. Needs the developer.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

201 Success.

application/json WebhookEndpointWithSecret

POST /v1/webhooks/{id}/test Send a test event

Needs the webhooks:manage scope. Needs the developer.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

201 Success.

application/json WebhookDelivery

POST /v1/webhooks/confirm Confirm a webhook endpoint

Step three of the handshake. Send the token from the subscription event that went to the address. It works once, and expires after a day.

Needs the webhooks:manage scope. Needs the developer.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Request body

application/json ConfirmWebhookInput

Response

200 Success.

application/json WebhookEndpoint

POST /v1/webhooks/deliveries/{id}/retry Send a delivery again

Needs the webhooks:manage scope. Needs the developer.manage permission. Needs the developer_api plan feature. Needs a live plan. Try it

Parameters

id required path string

Response

201 Success.

application/json WebhookDelivery

workflows

GET /v1/workflows/{id}/runs List a workflow's runs

Needs the documents:read scope. Needs the settings.manage permission. Try it

Parameters

`id` required	path	string
`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json WorkflowRunPage

POST /v1/workflows/{id}/runs Start a run

Sends a file named by uploadId from POST /v1/uploads, or documents already in this workspace, to the workflow's API import. nodeId starts it at another input instead: a Document aggregator gathers what has come in, and Business insights runs its query. An upload, or an Idempotency-Key, makes a repeat answer with the first run.

Needs the documents:write scope. Needs the settings.manage permission. Needs the automation_rules plan feature. Needs a live plan. Try it

Parameters

`id` required	path	string
`Idempotency-Key`	header	string Replaying a key returns the first record instead of creating, and charging for, a second. While the first request is still running, a retry answers 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After, and is not charged. The same key on a different request answers 409 IDEMPOTENCY_CONFLICT.

Request body (optional)

application/json StartWorkflowRunInput

Response

201 Success.

application/json WorkflowRunSummary

GET /v1/workflows/{id}/runs/{runId} Get a run and each of its steps

Each step says what happened. A file comes with a signed link that lasts 15 minutes, and an approval says who was asked and who answered.

Needs the documents:read scope. Needs the settings.manage permission. Try it

Parameters

`id` required	path	string
`runId` required	path	string

Response

200 Success.

application/json WorkflowRun

workspace

DELETE /v1/workspace Close this workspace

Needs the workspace:delete scope, which no preset holds, on a key an owner made. Send the name of the workspace to confirm. Its data is purged after the grace period.

Needs the workspace:delete scope. Needs the workspace.delete permission. Try it

Request body

application/json CloseWorkspaceInput

Response

200 Success.

application/json WorkspaceClosed

GET /v1/workspace Get this workspace, its plan and its usage

Needs the workspace:read scope. Try it

Response

200 Success.

application/json Workspace

PATCH /v1/workspace Change this workspace

Needs the workspace:write scope. Needs the settings.manage permission. Needs a live plan. Try it

Request body

application/json UpdateWorkspaceInput

Response

200 Success.

application/json Workspace

GET /v1/workspace/counts Count what is waiting on the caller

Needs the workspace:read scope. Try it

Response

200 Success.

application/json WorkspaceCounts

workspaces

GET /v1/workspaces List the workspaces this credential reaches

A key or an app is bound to one workspace, so it lists that one. A person lists all of theirs.

Needs the workspace:read scope. Try it

Parameters

`limit`	query	integer
`cursor`	query	string

Response

200 Success.

application/json WorkspacePage

POST /v1/workspaces Create a workspace

The caller's person owns it. It starts with what their one trial has left, or with no plan: reading and exporting work, and capture waits on a plan. A plan cannot be bought by an API call, so naming one returns the billing link where a person pays for it. A key stays bound to its own workspace, so the new one needs a key of its own.

Needs the workspace:write scope. Try it

Parameters

Idempotency-Key

header

string

Request body

application/json CreateWorkspaceInput

Response

201 Success.

application/json WorkspaceCreated

Webhook events

Answer with any 2xx within 10 seconds. A 410 turns the endpoint off. Anything else is retried with exponential backoff, 8 attempts over about 24 hours. Redirects are not followed. Delivery is at least once, so use the event id to ignore repeats.

X-PaperTotal-Signature HMAC-SHA256 of "<t>.<body>" with the endpoint's signing secret, in hex, sent as t=<unix seconds>,v1=<hex>. Compute it over the raw bytes, and refuse a timestamp more than five minutes old.

X-PaperTotal-Event The event type.

document.created
document.processed
document.failed
document.enriched
document.enrichment_failed
document_set.completed
document_set.failed
split.completed
split.created
split.failed
split_and_classify.created
split_and_classify.failed
w2_set.created
w2_set.failed
bank_statement_set.created
bank_statement_set.failed
expense.created
expense.updated
expense.deleted
report.submitted
report.approved
report.rejected
report.reimbursed
integration.posted
integration.failed
subscription

Each one posts WebhookEventPayload.

Schemas

TravelTripListQuery

`scope`	`mine` `all`
`from`	string
`to`	string

CreateClientCertificateInput

`name` required	string
`certificate` required	string

ReleaseNotificationQuery

`product`	`app_web` `api` `mcp` `model_document_extraction` `model_bank_statements` `model_checks` `model_fraud_detection`
`environment`	`production` `sandbox`

CreateAttachmentInput

uploadId required string

CreateUploadInput

`filename` required	string
`contentType` required	string
`sizeBytes` required	integer
`purpose` required	`document` `document_set` `expense_receipt` `odometer_photo` `policy_document` `statement` `attachment` `catalog_import` `iif_lists` `people_list` `profile_photo`
`clientId`	string

ExportRecordInput

`documentIds` required	array of string
`target` required	string
`externalId`	string

ExportRecordQuery

`documentId`	string
`target`	string
`externalId`	string
`via`	`EXPORT` `SYNC` `API`

DocumentReadQuery

`bounding_boxes`	boolean
`confidence_details`	boolean
`detailed`	boolean
`with_scores`	boolean

DocumentTagInput

name required string

DocumentTagsInput

tags required array of string

ExpenseLineInput

`description` required	string
`sku`	string or null
`quantity`	number,null
`unitPriceMinor`	integer or null
`amountMinor` required	integer
`taxMinor`	integer or null
`categoryId`	string,null

ExpenseTaxLineInput

`name`	string or null
`code`	string or null
`ratePct`	number or null
`baseMinor`	integer or null
`amountMinor` required	integer

UpdateExpenseLineInput

`description`	string
`sku`	string or null
`quantity`	number,null
`unitPriceMinor`	integer or null
`amountMinor`	integer
`taxMinor`	integer or null
`categoryId`	string,null

UpdateExpenseTaxLineInput

`name`	string or null
`code`	string or null
`ratePct`	number or null
`baseMinor`	integer or null
`amountMinor`	integer

CategoryImportQuery

mode merge replace

CloseWorkspaceInput

confirmName required string

ProvisionInput

employees

array of object

Fields

`employeeEmail` required	string (email)
`managerEmail`	string (email)
`employeeID`	string
`policyID`	string
`approvalLimit`	integer
`overLimitApprover`	string (email)
`workerStatus`	string
`isTerminated`	boolean
`domainGroupID`	string
`approvesTo`	string (email)
`role`	string
`additionalPolicyIDs`	array of string
`defaultTags`	array of string
`firstName`	string
`lastName`	string
`customField1`	string
`customField2`	string
`payrollCode`	string
`title`	string
`department`	string
`costCenter`	string
`officeLocation`	string
`legalEntity`	string
`workerType`	string

url string (uri)

dryRun boolean

shouldFixApprovalChains boolean

removeMissing boolean

AutomationPreviewInput

conditions required

array of object

Fields

field required merchantName description amountMinor currency cardLast4 paymentType categoryId merchantType date notes invoiceNumber ocrText subtotalMinor taxMinor tipMinor confidence billable reimbursable documentType source tags flags lineItems.description lineItems.sku lineItems.amountMinor lineItems.quantity ai

op required equals contains contains_case starts_with gte lte not_equals not_contains gt lt is_empty is_not_empty matches_regex not_matches_regex between within_days_before_today within_days_after_date within_days_before_date ask

value

string or number or boolean or object or object

Fields

`from` required	string
`to` required	string

fallback no_match match

AutomationRuleInput

name required string

enabled boolean

conditions required

array of object

Fields

value

string or number or boolean or object or object

Fields

`from` required	string
`to` required	string

fallback no_match match

actions required

object

Fields

categoryId string

projectId string

clientId string

tagIds array of string

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

description string

merchantName string

taxBasisPoints integer

vendorId string (uuid)

postToBooks true

clear array of categoryId tagIds taxMinor

reportId string

autoApprove true

reject

object

Fields

reason required string

flagForReview

object

Fields

reason required string

setStatus NEEDS_REVIEW READY

group

object

Fields

report required string

setCustomFields map of string or number or boolean

extract

array of object or object

Fields

`kind` required	`regex`
`field` required	string
`pattern` required	string

llmExtract

array of object

Fields

field required string

prompt required string

examples

array of object

Fields

`input` required	string
`output` required	string

fallback required

object or object or object

Fields

action required none

BulkMemberInput

`ids` required	array of string
`role`	`OWNER` `ADMIN` `APPROVER` `ACCOUNTANT` `AUDITOR` `MEMBER` `EDITOR` `CARD_ADMIN` `PEOPLE_ADMIN` `PAYMENTS_ADMIN`
`status`	`ACTIVE` `SUSPENDED`
`managerId`	string,null

CreateInvitationInput

`email` required	string (email)
`name`	string
`role`	`OWNER` `ADMIN` `APPROVER` `ACCOUNTANT` `AUDITOR` `MEMBER` `EDITOR` `CARD_ADMIN` `PEOPLE_ADMIN` `PAYMENTS_ADMIN`
`message`	string

ChangeMailInAddressInput

shippingAddress required

object

Fields

`name` required	string
`company`	string or null
`line1` required	string
`line2`	string or null
`city` required	string
`region` required	string
`postalCode` required	string
`country`	string

MailInSettingsInput

address required

object or null

Fields

`name` required	string
`company`	string or null
`line1` required	string
`line2`	string or null
`city` required	string
`region` required	string
`postalCode` required	string
`country`	string

CreateMailInInput

envelopes integer

expectedDocuments required integer

afterScan RETURN SHRED

shippingAddress

object

Fields

`name` required	string
`company`	string or null
`line1` required	string
`line2`	string or null
`city` required	string
`region` required	string
`postalCode` required	string
`country`	string

folderId string,null

notes string or null

CreateWorkspaceInput

`name` required	string
`baseCurrency`	string
`country`	string
`timezone`	string
`copyFromId`	string
`copySections`	array of `categories` `tags` `customFields` `reportFields` `distanceRates` `perDiem` `workflows` `rules` `merchantRules` `policies` `members` `accountingConnection` `overview`
`plan`	`STARTER` `PRO` `BUSINESS`
`interval`	`MONTH` `YEAR`

InvitationListQuery

status PENDING EXPIRED ACCEPTED REVOKED

MemberListQuery

`q`	string
`status`	`ACTIVE` `SUSPENDED`
`role`	`OWNER` `ADMIN` `APPROVER` `ACCOUNTANT` `AUDITOR` `MEMBER` `EDITOR` `CARD_ADMIN` `PEOPLE_ADMIN` `PAYMENTS_ADMIN`

PaymentAccountListQuery

archived string

PersonalRuleInput

name required string

enabled boolean

merchantContains required string

actions required

object

Fields

categoryId string

projectId string

clientId string

tagIds array of string

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

description string

merchantName string

taxBasisPoints integer

vendorId string (uuid)

postToBooks true

clear array of categoryId tagIds taxMinor

reportId string

autoApprove true

reject

object

Fields

reason required string

flagForReview

object

Fields

reason required string

setStatus NEEDS_REVIEW READY

group

object

Fields

report required string

setCustomFields map of string or number or boolean

extract

array of object or object

Fields

`kind` required	`regex`
`field` required	string
`pattern` required	string

llmExtract

array of object

Fields

field required string

prompt required string

examples

array of object

Fields

`input` required	string
`output` required	string

fallback required

object or object or object

Fields

action required none

ownerId string

PersonalRuleQuery

ownerId string

ReconciliationQuery

`from` required	string
`to` required	string
`paymentAccountId`	string
`feed`	string
`currency`	string

ReorderAutomationRulesInput

ids required array of string

RulesDocument

format required papertotal.rules

version required 1

exportedAt string

rules required

array of object

Fields

name required string

enabled boolean

conditions required

array of object

Fields

value

string or number or boolean or object or object

Fields

`from` required	string
`to` required	string

fallback no_match match

actions required

object

Fields

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

description string

merchantName string

taxBasisPoints integer

postToBooks true

clear array of categoryId tagIds taxMinor

autoApprove true

reject

object

Fields

reason required string

flagForReview

object

Fields

reason required string

setStatus NEEDS_REVIEW READY

group

object

Fields

report required string

setCustomFields map of string or number or boolean

extract

array of object or object

Fields

`kind` required	`regex`
`field` required	string
`pattern` required	string

llmExtract

array of object

Fields

`field` required	string
`prompt` required	string
`examples`	array of object
`fallback` required	object or object or object

category string

project string

client string

vendor string

tags

array of object

Fields

`name` required	string
`group`	string or null

ReportFieldInput

`name` required	string
`type` required	`TEXT` `DATE` `LIST` `FORMULA`
`options`	array of string
`formula`	string or null
`required`	boolean
`enabled`	boolean
`position`	integer

SyncRecordQuery

state PENDING SYNCED FAILED SKIPPED VOIDED

TransactionListQuery

`state`	`UNMATCHED` `MATCHED` `IGNORED` `EXPENSED` `PENDING`
`paymentAccountId`	string
`paymentAccountIds`	string
`from`	string
`to`	string
`q`	string
`minMinor`	integer
`maxMinor`	integer
`missingReceipt`	string
`unreported`	string
`currency`	string

UpdateAutomationRuleInput

name string

enabled boolean

conditions

array of object

Fields

value

string or number or boolean or object or object

Fields

`from` required	string
`to` required	string

fallback no_match match

actions

object

Fields

categoryId string

projectId string

clientId string

tagIds array of string

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

description string

merchantName string

taxBasisPoints integer

vendorId string (uuid)

postToBooks true

clear array of categoryId tagIds taxMinor

reportId string

autoApprove true

reject

object

Fields

reason required string

flagForReview

object

Fields

reason required string

setStatus NEEDS_REVIEW READY

group

object

Fields

report required string

setCustomFields map of string or number or boolean

extract

array of object or object

Fields

`kind` required	`regex`
`field` required	string
`pattern` required	string

llmExtract

array of object

Fields

field required string

prompt required string

examples

array of object

Fields

`input` required	string
`output` required	string

fallback required

object or object or object

Fields

action required none

UpdateMemberInput

`role`	`OWNER` `ADMIN` `APPROVER` `ACCOUNTANT` `AUDITOR` `MEMBER` `EDITOR` `CARD_ADMIN` `PEOPLE_ADMIN` `PAYMENTS_ADMIN`
`status`	`ACTIVE` `SUSPENDED`
`developer`	boolean
`managerId`	string,null
`title`	string or null
`department`	string or null
`employeeId`	string or null
`approvalLimitMinor`	integer or null
`overLimitApproverId`	string,null
`forwardToId`	string,null
`workerStatus`	string or null
`defaultTags`	array of string
`customField1`	string or null
`customField2`	string or null
`payrollCode`	string or null
`legalEntity`	string or null
`tier`	string or null
`officeLocation`	string or null
`costCenter`	string or null
`accountingCode`	string or null
`workerType`	string or null

UpdateReportFieldInput

`options`	array of string
`formula`	string or null
`required`	boolean
`enabled`	boolean
`position`	integer
`disabledOptions`	array of string

UpdateWorkspaceInput

`name`	string
`baseCurrency`	string
`country`	string
`timezone`	string
`fiscalYearStartMonth`	integer
`distanceUnit`	`mi` `km`
`retentionDays`	integer or null
`callLogRetentionDays`	integer or null
`readingModel`	`standard` `rules_only` `always_second_reading`
`locale`	string or null
`showDefaultCategories`	boolean
`shredDocuments`	boolean
`vatBasisPoints`	integer or null
`reimbursableTracking`	boolean
`calculateMissingTax`	boolean
`dateFormat`	`YYYY-MM-DD` `MM/DD/YYYY` `DD/MM/YYYY` `DD.MM.YYYY` `MMM D, YYYY`

ForwardingAliasInput

alias required string

UploadSourceQuery

client

ios android

The app sending the file. Leave it out in a browser.

AnyDocumentInput

`file_url`	string
`file_data`	string
`file_name`	string
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`blueprint_name` required	string
`blueprint_version`	integer
`max_pages_to_process`	integer

BatchDocumentsInput

`file_urls` required	array of string
`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`external_id`	string

BlueprintListQuery

documentType RECEIPT INVOICE BILL BANK_STATEMENT CHECK TAX_FORM BUSINESS_CARD OTHER UNKNOWN PURCHASE_ORDER CONTRACT PACKING_SLIP REMITTANCE_ADVICE CREDIT_NOTE STATEMENT

BlueprintVersionQuery

version integer

ClassifyDocumentInput

`file_url`	string
`file_data`	string
`file_name`	string
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`document_types`	array of string

CreateBlueprintInput

name required string

title required string

description string

schema required

object

Fields

`type` required	`object`
`description`	string
`properties` required	__schema0

fields

array of object

Fields

path required string

label string

example string

box

object

Fields

`page` required	integer
`x` required	number
`y` required	number
`width` required	number
`height` required	number

CropDocumentInput

`page`	integer
`x` required	number
`y` required	number
`width` required	number
`height` required	number

ExtractDocumentInput

`file_url`	string
`file_data`	string
`file_name`	string
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`document_types`	array of string

ParseDocumentInput

`file_url`	string
`file_data`	string
`file_name`	string
`external_id`	string
`async`	boolean
`tags`	array of string
`auto_delete`	boolean
`details`	boolean

ParseQuery

`details`	boolean
`tag`	string

ParseUpdateInput

`title`	string or null
`notes`	string or null
`tags`	array of string

RotateDocumentInput

`page`	integer
`degrees`	`90` or `180` or `270` or `-90`

SettleDuplicatesInput

object or object

`keep` required	`all`
`others`	array of string

SplitDocumentInput

`mode` required	`every_page` `custom` `detect` `blank_pages`
`ranges`	string

SplitOptions

`split_by_blank_page`	boolean
`every_page`	boolean
`ranges`	string
`document_types`	array of string
`blueprint_name`	string
`file_url`	string
`file_data`	string
`file_name`	string
`external_id`	string

SplitUploadInput

`uploadId` required	string
`mode`	`every_page` `custom` `detect` `blank_pages`
`ranges`	string

UpdateBlueprintInput

title string

description string or null

schema

object

Fields

`type` required	`object`
`description`	string
`properties` required	__schema0

fields

array of object

Fields

path required string

label string

example string

box

object

Fields

`page` required	integer
`x` required	number
`y` required	number
`width` required	number
`height` required	number

StartWorkflowRunInput

`uploadId`	string
`documentIds`	array of string
`nodeId`	string

AnalyticsQuery

`status`	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	string
`scope`	`mine` `all`
`categoryId`	string
`merchantId`	string
`projectId`	string
`clientId`	string
`tagId`	string
`department`	string
`reportId`	string
`externalId`	string
`unreported`	boolean
`needsReview`	boolean
`billable`	boolean
`reimbursable`	boolean
`moneyFlow`	`IN` `OUT`
`dateField`	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	string
`to`	string
`minMinor`	integer
`maxMinor`	integer
`q`	string
`limit`	integer
`interval`	`day` `week` `month` `quarter` `year` `running`
`groupCurrency`	string

ApproveReportInput

`comment`	string
`held`	`move` `approve`
`bypass`	boolean
`expectedTotalMinor`	integer

AttachReceiptInput

`mode`	`add` `replace`
`clientId`	string
`deviceId`	string

BulkDocumentInput

ids array of string

filter

object

Fields

`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`status`	`UPLOADED` `PROCESSING` `PROCESSED` `FAILED`
`source`	`WEB` `IOS` `ANDROID` `EMAIL` `API` `MAIL_IN` `INTEGRATION`
`source_id`	string
`external_id`	string
`blueprint_name`	string
`owner`	string
`device_id`	string
`device_user_uuid`	string
`viewed`	boolean
`trashed`	boolean
`envelope`	string
`created__gt`	string or string (date-time)
`created__gte`	string or string (date-time)
`created__lt`	string or string (date-time)
`created__lte`	string or string (date-time)
`updated__gt`	string or string (date-time)
`updated__gte`	string or string (date-time)
`updated__lt`	string or string (date-time)
`updated__lte`	string or string (date-time)
`issued`	string
`issued__gt`	string
`issued__gte`	string
`issued__lt`	string
`issued__lte`	string
`total`	integer
`total__gt`	integer
`total__gte`	integer
`total__lt`	integer
`total__lte`	integer
`tax`	integer
`tax__gt`	integer
`tax__gte`	integer
`tax__lt`	integer
`tax__lte`	integer
`currency`	string
`category`	string
`vendor`	string
`notes`	string
`payment_type`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`last_four_digits`	string
`first_name`	string
`last_name`	string
`work_phone`	string
`cell_phone`	string
`company`	string
`email`	string
`website`	string
`country`	string
`state`	string
`city`	string
`zip`	string
`name`	string
`is_empty`	string
`order_by`	`created` `updated` `issued` `total` `tax` `-created` `-updated` `-issued` `-total` `-tax`
`folderId`	string
`mailInBatchId`	string
`setId`	string
`externalId`	string
`tag`	string
`archived`	boolean
`unviewed`	boolean
`q`	string
`from`	string
`to`	string
`fraudColor`	`GREEN` `YELLOW` `RED`
`fraudSignal`	`digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`fraudReview`	`PENDING` `FRAUD` `NOT_FRAUD` `UNKNOWN`

cursor string

action required

object or object or object or object

Fields

`type` required	`move`
`folderId` required	string,null

TrashActionInput

`ids`	array of string
`all`	boolean
`action` required	`restore` `purge`

BulkExpenseInput

ids required array of string

action required

object or object or object or object or object or object or object or object or object

Fields

`type` required	`set_category`
`categoryId` required	string,null

BulkReassignInput

`reportIds` required	array of string
`approverId` required	string
`mode`	`replace` `insert`

BulkReportsInput

reportIds required array of string

CatalogImportInput

csv required string

CatalogQuery

`q`	string
`archived`	string

CategoryInput

`name` required	string
`parentId`	string,null
`glCode`	string or null
`taxLine`	string or null
`deductiblePct`	integer
`enabled`	boolean
`position`	integer
`type`	`EXPENSE` `COGS` `INCOME` `REFUND`
`payrollCode`	string or null
`descriptionHint`	string or null
`approverId`	string,null
`commentRequired`	boolean
`maxExpenseMinor`	integer or null
`headerOnly`	boolean

CategoryQuery

`q`	string
`enabled`	string
`type`	`EXPENSE` `COGS` `INCOME` `REFUND`
`origin`	`SYSTEM` `CUSTOM` `ACCOUNTING`
`headers`	string

CommentInput

`body`	string
`mentions`	array of string
`attachmentIds`	array of string

ContactExportInput

`format` required	`vcard` `google` `outlook` `csv`
`ids`	array of string

ContactListQuery

`q`	string
`documentId`	string
`name`	string
`company`	string
`email`	string
`phone`	string
`website`	string
`city`	string
`region`	string
`postalCode`	string
`country`	string

CreateDocumentInput

`tags`	array of string
`categories`	array of string
`taxonomy`	array of string
`allowed_async_enrichments`	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`bounding_boxes`	boolean
`confidence_details`	boolean
`compute`	boolean
`parse_address`	boolean
`country`	string
`max_pages_to_process`	integer
`boost_mode`	boolean
`auto_delete`	boolean
`stitch`	boolean
`crop_document`	boolean
`blueprint_name`	string
`blueprint_version`	integer
`async`	boolean
`line_item_expansion`	boolean
`tiff_dpi`	number
`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`clientId`	string
`externalId`	string
`folderId`	string
`notes`	string
`capturedAt`	string (date-time)
`latitude`	number
`longitude`	number
`locationAccuracyM`	number
`deviceId`	string
`merchantName`	string
`date`	string
`totalMinor`	integer
`taxMinor`	integer
`category`	string

CreateExpenseInput

merchantName string,null

description string or null

notes string or null

date required string

currency string

amountMinor required integer

subtotalMinor integer or null

taxMinor integer or null

tipMinor integer or null

discountMinor integer or null

shippingMinor integer or null

baseAmountMinor integer or null

fxRate number or null

categoryId string,null

projectId string,null

clientId string,null

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

paymentAccountId string,null

cardLast4 string or null

invoiceNumber string or null

poNumber string or null

dueDate string or null

mcc string or null

taxDeductible boolean

moneyFlow IN OUT

alsoCategoryIds array of string

tagIds array of string

attendees

array of object

Fields

`name` required	string
`email`	string (email)
`phone`	string

customFields map of any

lines

array of object

Fields

`description` required	string
`sku`	string or null
`quantity`	number,null
`unitPriceMinor`	integer or null
`amountMinor` required	integer
`taxMinor`	integer or null
`categoryId`	string,null

kind MANUAL MILEAGE PER_DIEM TIME

quantity number

rateMinor integer

unit string

trip map of any

vehicleId string

externalId string

ownerId string

reportId string

CreateExportInput

kind required expenses report tax mileage receipts documents

format required CSV XLSX PDF ZIP QBO_CSV XERO_CSV SAGE_CSV DYNAMICS_CSV MYOB_TXT ORACLE_CSV SAP_CSV IIF OFX JSON XML TXT XLS

filters

object

Fields

`status`	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	string
`scope`	`mine` `all`
`categoryId`	string
`merchantId`	string
`projectId`	string
`clientId`	string
`tagId`	string
`department`	string
`reportId`	string
`externalId`	string
`unreported`	boolean
`needsReview`	boolean
`billable`	boolean
`reimbursable`	boolean
`moneyFlow`	`IN` `OUT`
`dateField`	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	string
`to`	string
`minMinor`	integer
`maxMinor`	integer
`q`	string
`ids`	array of string
`year`	integer
`reportState`	`DRAFT` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `EXPORTED` `CLOSED` or array of `DRAFT` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `EXPORTED` `CLOSED`
`reportIds`	array of string
`startDate`	string
`endDate`	string
`approvedAfter`	string
`exported`	boolean
`categoryIds`	array of string
`documentIds`	array of string
`documentTypes`	array of `RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`policyIds`	array of string

templateId string

fullPageReceipts boolean

template string

onFinish

object

Fields

email

object

Fields

`recipients` required	array of string (email)
`message`	string

markAsExported boolean

sftpUpload

object

Fields

`host` required	string
`port`	integer
`username` required	string
`password`	string
`privateKey`	string
`passphrase`	string
`hostKeySha256` required	string
`path`	string

delimiter , ; |

bom boolean

recipients array of string (email)

columnSet simple detailed

preset basic all_data_expense all_data_report canadian_multiple_tax category per_diem tag tax_report

view

object

Fields

level expense report

columns required

array of object

Fields

`key` required	string
`label`	string

sort date:asc date:desc merchant:asc merchant:desc category:asc category:desc status:asc status:desc amount:asc amount:desc

groupBy category merchant member project status month

groupsOnly boolean

CreateMerchantInput

`name` required	string
`defaultCategoryId`	string,null
`website`	string or null
`phone`	string or null
`address`	string or null
`taxId`	string or null
`is1099`	boolean
`merchantType`	`airline` `lodging` `car_rental` `ground_transport` `fuel` `dining` `grocery` `office` `software` `utilities` `supplies` `other` or null

CreatePerDiemInput

perDiemRateId string

mieRateId string

subRates

array of object

Fields

`rateId` required	string
`quantity` required	integer

lodgingRateId string

startDate required string

endDate required string

startTime string

endTime string

partialDays boolean

destination string

description string or null

mealsCategoryId string or null

tagIds array of string

categoryId string or null

projectId string or null

clientId string or null

billable boolean

reimbursable boolean

notes string or null

CreateReportInput

`title`	string
`purpose`	string or null
`currency`	string
`expenseIds`	array of string
`ownerId`	string

CreateTimeInput

`date` required	string
`hours` required	number
`rateMinor` required	integer
`currency`	string
`description` required	string
`categoryId`	string or null
`projectId`	string or null
`clientId`	string or null
`billable`	boolean
`reimbursable`	boolean
`notes`	string or null

CreateTripInput

`date` required	string
`distance`	number
`odometerStart`	number
`odometerEnd`	number
`routeDistance`	number or null
`roundTrip`	boolean
`origin` required	string
`destination` required	string
`stops`	array of string
`departed`	string or null
`arrived`	string or null
`purpose` required	string
`vehicleId`	string or null
`rateId`	string or null
`routeToken`	string or null
`categoryId`	string or null
`projectId`	string or null
`clientId`	string or null
`billable`	boolean
`reimbursable`	boolean
`notes`	string or null

CreateWebhookInput

`url` required	string
`description`	string
`events` required	array of `document.created` `document.processed` `document.failed` `document.enriched` `document.enrichment_failed` `document_set.completed` `document_set.failed` `split.completed` `split.created` `split.failed` `split_and_classify.created` `split_and_classify.failed` `w2_set.created` `w2_set.failed` `bank_statement_set.created` `bank_statement_set.failed` `expense.created` `expense.updated` `expense.deleted` `report.submitted` `report.approved` `report.rejected` `report.reimbursed` `integration.posted` `integration.failed`
`apiKeyId`	string

ConfirmWebhookInput

token required string

WebhookListQuery

`apiKeyId`	string
`include`	`keys`

DocumentListQuery

`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`status`	`UPLOADED` `PROCESSING` `PROCESSED` `FAILED`
`source`	`WEB` `IOS` `ANDROID` `EMAIL` `API` `MAIL_IN` `INTEGRATION`
`source_id`	string
`external_id`	string
`blueprint_name`	string
`owner`	string
`device_id`	string
`device_user_uuid`	string
`viewed`	boolean
`trashed`	boolean
`envelope`	string
`created__gt`	string or string (date-time)
`created__gte`	string or string (date-time)
`created__lt`	string or string (date-time)
`created__lte`	string or string (date-time)
`updated__gt`	string or string (date-time)
`updated__gte`	string or string (date-time)
`updated__lt`	string or string (date-time)
`updated__lte`	string or string (date-time)
`issued`	string
`issued__gt`	string
`issued__gte`	string
`issued__lt`	string
`issued__lte`	string
`total`	integer
`total__gt`	integer
`total__gte`	integer
`total__lt`	integer
`total__lte`	integer
`tax`	integer
`tax__gt`	integer
`tax__gte`	integer
`tax__lt`	integer
`tax__lte`	integer
`currency`	string
`category`	string
`vendor`	string
`notes`	string
`payment_type`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`last_four_digits`	string
`first_name`	string
`last_name`	string
`work_phone`	string
`cell_phone`	string
`company`	string
`email`	string
`website`	string
`country`	string
`state`	string
`city`	string
`zip`	string
`name`	string
`is_empty`	string
`order_by`	`created` `updated` `issued` `total` `tax` `-created` `-updated` `-issued` `-total` `-tax`
`folderId`	string
`mailInBatchId`	string
`setId`	string
`externalId`	string
`tag`	string
`archived`	boolean
`unviewed`	boolean
`q`	string
`from`	string
`to`	string
`fraudColor`	`GREEN` `YELLOW` `RED`
`fraudSignal`	`digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`fraudReview`	`PENDING` `FRAUD` `NOT_FRAUD` `UNKNOWN`

ExpenseListPageQuery

`status`	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	string
`scope`	`mine` `all`
`categoryId`	string
`merchantId`	string
`projectId`	string
`clientId`	string
`tagId`	string
`department`	string
`reportId`	string
`externalId`	string
`unreported`	boolean
`needsReview`	boolean
`billable`	boolean
`reimbursable`	boolean
`moneyFlow`	`IN` `OUT`
`dateField`	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	string
`to`	string
`minMinor`	integer
`maxMinor`	integer
`q`	string
`sort`	`date:asc` `date:desc` `merchant:asc` `merchant:desc` `category:asc` `category:desc` `status:asc` `status:desc` `amount:asc` `amount:desc`

ExpenseTotalsQuery

`status`	`PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID` or array of `PROCESSING` `NEEDS_REVIEW` `READY` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `VOID`
`kind`	`RECEIPT` `MANUAL` `MILEAGE` `PER_DIEM` `TIME` `CARD`
`paymentType`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER`
`ownerId`	string
`scope`	`mine` `all`
`categoryId`	string
`merchantId`	string
`projectId`	string
`clientId`	string
`tagId`	string
`department`	string
`reportId`	string
`externalId`	string
`unreported`	boolean
`needsReview`	boolean
`billable`	boolean
`reimbursable`	boolean
`moneyFlow`	`IN` `OUT`
`dateField`	`date` `createdAt` `updatedAt` `submittedAt` `approvedAt`
`from`	string
`to`	string
`minMinor`	integer
`maxMinor`	integer
`q`	string
`ids`	string or array of string
`currency`	string

FolderInput

`name` required	string
`parentId`	string,null

FolderQuery

`q`	string
`parentId`	string

DismissFlagInput

reason string

HoldExpenseInput

reason required string

ReachMentionedInput

userIds required array of string

MergeMerchantInput

intoId required string

MerchantInput

`name`	string
`defaultCategoryId`	string,null
`website`	string or null
`phone`	string or null
`address`	string or null
`taxId`	string or null
`is1099`	boolean
`merchantType`	`airline` `lodging` `car_rental` `ground_transport` `fuel` `dining` `grocery` `office` `software` `utilities` `supplies` `other` or null

MileageLogQuery

`from`	string
`to`	string
`scope`	`mine` `all`
`ownerId`	string
`vehicleId`	string
`purpose`	`business` `medical` `charity`

OdometerPhotoInput

reading required START END

ProjectInput

`name` required	string
`code`	string or null
`clientId`	string,null
`budgetMinor`	integer or null
`archived`	boolean

ProjectQuery

`q`	string
`archived`	string
`clientId`	string

ReassignReportInput

`approverId` required	string
`mode`	`replace` `insert`

RejectExpenseInput

reason required string

RejectReportInput

`reason` required	string
`to`	string

ReportExpensesInput

ids required array of string

ReportListQuery

`status`	`DRAFT` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `EXPORTED` `CLOSED` or array of `DRAFT` `SUBMITTED` `APPROVED` `REJECTED` `REIMBURSED` `EXPORTED` `CLOSED`
`scope`	`mine` `all` `assigned`
`ownerId`	string
`q`	string
`from`	string
`to`	string

ReportParticipantInput

userId required string

SubmitReportInput

`memo`	string
`cc`	array of string
`to`	string
`ccEmails`	array of string (email)
`attachPdf`	boolean
`approverEmail`	string (email)

SubmitDocumentInput

`tags`	array of string
`categories`	array of string
`taxonomy`	array of string
`allowed_async_enrichments`	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`bounding_boxes`	boolean
`confidence_details`	boolean
`compute`	boolean
`parse_address`	boolean
`country`	string
`max_pages_to_process`	integer
`boost_mode`	boolean
`auto_delete`	boolean
`stitch`	boolean
`crop_document`	boolean
`blueprint_name`	string
`blueprint_version`	integer
`async`	boolean
`line_item_expansion`	boolean
`tiff_dpi`	number
`file_url`	string
`file_urls`	array of string
`file_data`	string
`file_name`	string
`external_id`	string
`device_id`	string
`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`bucket`	string
`package_path`	string

TagInput

`name` required	string
`groupName`	string or null
`glCode`	string or null
`color`	string or null
`archived`	boolean
`approverId`	string or null
`parentId`	string or null

TaxSummaryQuery

year integer

TripRouteQuery

q string

UpdateCategoryInput

`name`	string
`parentId`	string,null
`glCode`	string or null
`taxLine`	string or null
`deductiblePct`	integer
`enabled`	boolean
`position`	integer
`type`	`EXPENSE` `COGS` `INCOME` `REFUND`
`payrollCode`	string or null
`descriptionHint`	string or null
`approverId`	string,null
`commentRequired`	boolean
`maxExpenseMinor`	integer or null
`headerOnly`	boolean

UpdateDocumentInput

type RECEIPT INVOICE BILL BANK_STATEMENT CHECK TAX_FORM BUSINESS_CARD OTHER UNKNOWN PURCHASE_ORDER CONTRACT PACKING_SLIP REMITTANCE_ADVICE CREDIT_NOTE STATEMENT

folderId string,null

title string or null

notes string or null

tags array of string

status PROCESSED REVIEWED

approved boolean

fraudReview

object

Fields

`decision` required	`FRAUD` `NOT_FRAUD` `UNKNOWN`
`types`	array of `digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`note`	string

billable boolean

merchantName string or null

totalMinor integer

subtotalMinor integer or null

taxMinor integer or null

tipMinor integer or null

customFields map of string or array of string or null

corrections map of string or null

UpdateExpenseInput

merchantName string,null

description string or null

notes string or null

date string

currency string

amountMinor integer

subtotalMinor integer or null

taxMinor integer or null

tipMinor integer or null

discountMinor integer or null

shippingMinor integer or null

baseAmountMinor integer or null

fxRate number or null

categoryId string,null

projectId string,null

clientId string,null

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

paymentAccountId string,null

cardLast4 string or null

invoiceNumber string or null

poNumber string or null

dueDate string or null

mcc string or null

taxDeductible boolean

moneyFlow IN OUT

alsoCategoryIds array of string

tagIds array of string

attendees

array of object

Fields

`name` required	string
`email`	string (email)
`phone`	string

customFields map of any

lines

array of object

Fields

`description` required	string
`sku`	string or null
`quantity`	number,null
`unitPriceMinor`	integer or null
`amountMinor` required	integer
`taxMinor`	integer or null
`categoryId`	string,null

UpdateFolderInput

`name`	string
`parentId`	string,null

UpdateProjectInput

`name`	string
`code`	string or null
`clientId`	string,null
`budgetMinor`	integer or null
`archived`	boolean

UpdateReportInput

`title`	string
`purpose`	string or null
`currency`	string
`fields`	map of string or null

UpdateTagInput

`name`	string
`groupName`	string or null
`glCode`	string or null
`color`	string or null
`archived`	boolean
`approverId`	string or null
`parentId`	string or null

UpdateWebhookInput

`url`	string
`description`	string or null
`events`	array of `document.created` `document.processed` `document.failed` `document.enriched` `document.enrichment_failed` `document_set.completed` `document_set.failed` `split.completed` `split.created` `split.failed` `split_and_classify.created` `split_and_classify.failed` `w2_set.created` `w2_set.failed` `bank_statement_set.created` `bank_statement_set.failed` `expense.created` `expense.updated` `expense.deleted` `report.submitted` `report.approved` `report.rejected` `report.reimbursed` `integration.posted` `integration.failed`
`enabled`	boolean

VehicleQuery

`q`	string
`archived`	string
`userId`	string

BlockDeviceInput

`deviceId` required	string
`reason`	string

FraudReviewInput

`decision` required	`FRAUD` `NOT_FRAUD` `UNKNOWN`
`types`	array of `digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`note`	string

RevealDocumentInput

`kinds`	array of `ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`reason`	string

CheckWithDocumentInput

check required

object

Fields

`tags`	array of string
`categories`	array of string
`taxonomy`	array of string
`allowed_async_enrichments`	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`bounding_boxes`	boolean
`confidence_details`	boolean
`compute`	boolean
`parse_address`	boolean
`country`	string
`max_pages_to_process`	integer
`boost_mode`	boolean
`auto_delete`	boolean
`stitch`	boolean
`crop_document`	boolean
`blueprint_name`	string
`blueprint_version`	integer
`async`	boolean
`line_item_expansion`	boolean
`tiff_dpi`	number
`file_url`	string
`file_urls`	array of string
`file_data`	string
`file_name`	string
`external_id`	string
`device_id`	string
`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`bucket`	string
`package_path`	string

document required

object

Fields

`tags`	array of string
`categories`	array of string
`taxonomy`	array of string
`allowed_async_enrichments`	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`bounding_boxes`	boolean
`confidence_details`	boolean
`compute`	boolean
`parse_address`	boolean
`country`	string
`max_pages_to_process`	integer
`boost_mode`	boolean
`auto_delete`	boolean
`stitch`	boolean
`crop_document`	boolean
`blueprint_name`	string
`blueprint_version`	integer
`async`	boolean
`line_item_expansion`	boolean
`tiff_dpi`	number
`file_url`	string
`file_urls`	array of string
`file_data`	string
`file_name`	string
`external_id`	string
`device_id`	string
`type`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`bucket`	string
`package_path`	string

BillingInvoicePage

data required

array of object

Fields

`id` required	string
`number` required	string,null
`status` required	string,null
`currency` required	string
`totalMinor` required	number
`amountPaidMinor` required	number
`amountDueMinor` required	number
`createdAt` required	string
`periodStart` required	string,null
`periodEnd` required	string,null
`hostedUrl` required	string,null Stripe's page for the invoice.
`pdfUrl` required	string,null Stripe's PDF of it.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ExportRecordPage

data required

array of object

Fields

`id` required	string
`documentId` required	string,null
`expenseId` required	string,null
`target` required	string A service, such as QUICKBOOKS_ONLINE, a file format, such as CSV, or what a program named.
`externalId` required	string,null The id it has there.
`exportJobId` required	string,null
`via` required	`EXPORT` `SYNC` `API`
`createdAt` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ExportRecordsAppended

data required

array of object

Fields

`id` required	string
`documentId` required	string,null
`expenseId` required	string,null
`target` required	string A service, such as QUICKBOOKS_ONLINE, a file format, such as CSV, or what a program named.
`externalId` required	string,null The id it has there.
`exportJobId` required	string,null
`via` required	`EXPORT` `SYNC` `API`
`createdAt` required	string

alreadyRecorded required

number

Already recorded, so left as they were.

DocumentDetail

id required string

type required RECEIPT INVOICE BILL BANK_STATEMENT CHECK TAX_FORM BUSINESS_CARD OTHER UNKNOWN PURCHASE_ORDER CONTRACT PACKING_SLIP REMITTANCE_ADVICE CREDIT_NOTE STATEMENT

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

status required UPLOADED PROCESSING PROCESSED FAILED

originalFilename required string,null

mimeType required string

sizeBytes required number

pageCount required number

externalId required string,null

folderId required string,null

expenseId required string,null

mailInBatchId required string,null

title required string,null

notes required string,null

latitude required

number,null

Where the device said it was when the photo was taken.

longitude required number,null

locationAccuracyM required number,null

duplicateOfId required string,null

processingError required string,null

processingErrorCode required

FILE_ENCRYPTED or null

Set when the failure is one the file's owner can fix. processingError says what to do.

verification required string

capturedAt required string,null

processedAt required string,null

viewedAt required string,null

archivedAt required string,null

createdAt required string

uploadedBy required

object or null

Fields

`id` required	string
`name` required	string,null

pages required

array of object

Fields

index required number

url required string,null

thumbnailUrl required string,null

width required number,null

height required number,null

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Blank for a caller without expenses.read_all.

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Null when the page is not one, and for a caller without expenses.read_all.

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Blank for a caller without expenses.read_all. Value null means nothing could say.

Fields

`value` required	boolean,null
`score` required	number,null

language required string,null

languages required

array of object

Fields

`tag` required	string
`score` required	number

ocrScore required number,null

isFront required

boolean,null

A check: the front or the back.

tiffRejectScore required

number,null

A check: 0 is a clean clearing image and 1 is one a bank would send back.

tiffUpscaled required

boolean,null

A check: the photo was under 240 DPI, so the clearing image was enlarged.

classification required

object or null

What the classifier decided, when it was asked.

Fields

value required

string

A document class, or one of the labels the caller named.

score required

number

0..1.

engine required rules claude

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

blueprint required

object or null

The blueprint this was read with, and what came out of it.

Fields

`name` required	string
`version` required	number,null Null for a built-in, which has no versions.
`result` required	map of any or null The fields the blueprint defines. Null when the run failed.
`offsets`	map of object Where each value sits in the text, for a blueprint that asks.
`unmatched`	array of string Fields where a value was read and did not fit, such as words where a number belongs or a choice off the list. Each is left empty. An empty field not named here was not on the document.
`error` required	string,null Why the run gave nothing back.

tags required array of string

tagRefs required

array of object

The same tags with their ids, which a tag route takes.

Fields

`id` required	string
`name` required	string

recordStatus required

processed reviewed archived or null

Where a read document stands: reviewedAt and archivedAt in one word. Null until it has been read.

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

setId required

string,null

The upload this came out of: a ZIP, a split PDF or a batch of addresses.

customFields required

map of string or array of string or null

Values the workspace custom field rules read out of the text.

enrichment required

object or null

Work still running after the first answer.

Fields

`status` required	`PENDING` `DONE` `FAILED`
`steps` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`failed` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`

extraction required

object or null

Fields

fields required

object

What was read, as the extraction contract types it. fieldConfidence holds per-field confidence, 0..1.

Fields

merchantName string,null

merchantAddress string,null

merchantPhone string,null

merchantWebsite string,null

merchantTaxId string,null

date string or null

time string,null

dueDate string or null

currency AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BZD CAD CDF CHF CLP CNY COP CRC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLE SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VES VND VUV WST XAF XCD XCG XOF XPF YER ZAR ZMW ZWG CUC HRK SLL ZWL XDR XSU or null

currencyGuessed boolean

totalMinor integer or null

subtotalMinor integer or null

taxMinor integer or null

taxLines

array of object

Fields

`name`	string,null
`ratePct`	number,null
`amountMinor` required	integer
`order`	integer or null
`baseMinor`	integer or null
`code`	string,null
`totalInclusive`	boolean,null

tipMinor integer or null

discountMinor integer or null

shippingMinor integer or null

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

cardBrand string,null

cardLast4 string,null

receiptNumber string,null

invoiceNumber string,null

poNumber string,null

lineItems

array of object

Fields

`description` required	string
`sku`	string,null
`quantity`	number,null
`unitPriceMinor`	integer or null
`amountMinor` required	integer
`taxMinor`	integer or null
`id`	string,null
`order`	integer or null
`text`	string,null
`type`	`room` `tax` `parking` `service` `fee` `delivery` `product` `food` `alcohol` `tobacco` `transportation` `fuel` `refund` `discount` `payment` `giftcard` `donation` `toll` `lottery` or null
`fullDescription`	string,null
`normalizedDescription`	string,null
`section`	string,null
`reference`	string,null
`upc`	string,null
`hsn`	string,null
`lot`	string,null
`tags`	array of string or null
`unitOfMeasure`	string,null
`discountMinor`	integer or null
`discountRatePct`	number,null
`discountPriceMinor`	integer or null
`taxRatePct`	number,null
`taxCode`	string,null
`subtotalMinor`	integer or null
`grossTotalMinor`	integer or null
`netTotalMinor`	integer or null
`date`	string or null
`startDate`	string or null
`endDate`	string or null
`category`	string,null
`customCategories`	array of string or null
`customFields`	map of any or null
`countryOfOrigin`	string,null
`manufacturer`	string,null
`weight`	string,null
`brand`	string,null
`hsaFsaEligible`	boolean,null
`productInfo`	object or null

suggestedCategory string,null

documentTitle string,null

documentReferenceNumber string,null

isDocument boolean,null

isTransaction boolean,null

isMoneyIn boolean,null

accountingEntryType debit credit or null

vendor

object or null

Fields

`name`	string,null
`rawName`	string,null
`type`	string,null
`logo`	string,null
`logoName`	string,null
`externalId`	string,null
`category`	string,null
`orderNumber`	string,null
`countryCode`	string,null
`address`	string,null
`rawAddress`	string,null
`parsedAddress`	object or null
`phoneNumber`	string,null
`faxNumber`	string,null
`email`	string,null
`web`	string,null
`lat`	number,null
`lng`	number,null
`mapUrl`	string,null
`vatNumber`	string,null
`isValidatedVatNumber`	boolean,null
`regNumber`	string,null
`abnNumber`	string,null
`isRegisteredForGst`	boolean,null
`bank`	object or null

vendors

array of object or null

Fields

`name`	string,null
`rawName`	string,null
`type`	string,null
`logo`	string,null
`logoName`	string,null
`externalId`	string,null
`category`	string,null
`orderNumber`	string,null
`countryCode`	string,null
`address`	string,null
`rawAddress`	string,null
`parsedAddress`	object or null
`phoneNumber`	string,null
`faxNumber`	string,null
`email`	string,null
`web`	string,null
`lat`	number,null
`lng`	number,null
`mapUrl`	string,null
`vatNumber`	string,null
`isValidatedVatNumber`	boolean,null
`regNumber`	string,null
`abnNumber`	string,null
`isRegisteredForGst`	boolean,null
`bank`	object or null

bankBreakdown

array of object or null

Fields

`accountName`	string,null
`accountNumber`	string,null
`accountCurrency`	string,null
`bankName`	string,null
`bankNames`	array of string or null
`bankAddress`	string,null
`bankAddresses`	array of string or null
`bankNumber`	string,null
`bankNumbers`	array of string or null
`bankSwift`	string,null
`iban`	string,null
`billerCode`	string,null

billTo

object or null

Fields

`name`	string,null
`address`	string,null
`parsedAddress`	object or null
`vatNumber`	string,null
`regNumber`	string,null
`phoneNumber`	string,null
`email`	string,null

shipTo

object or null

Fields

`name`	string,null
`address`	string,null
`parsedAddress`	object or null

insuranceMinor integer or null

cashbackMinor integer or null

roundingMinor integer or null

balanceMinor integer or null

finalBalanceMinor integer or null

previousBalanceMinor integer or null

totalQuantity number,null

totalWeight string,null

payment

object or null

Fields

`cardNumber`	string,null
`displayName`	string,null
`terms`	string,null
`type`	`none` `visa` `master_card` `cash` `american_express` `interac` `other` `maestro` `discover` `bancontact` `girocard` `applepay` `paypal` `bancomat` `giftcard` `card` `check` `bankaxept` `bank-to-bank_transfer_bacs` `octopus` `pix` `jcb` `waon` `mada` `wechat` `alipay` `unionpay` `googlepay` `rupay` `bpay` `shopeepay` `mir` `giropay` `food_stamp` `diners_club` `paypay` or null

orderDate string or null

shipDate string or null

deliveryDate string or null

serviceStartDate string or null

serviceEndDate string or null

exchangeRate number,null

countryCode string,null

deliveryNoteNumber string,null

trackingNumber string,null

trackingNumbers array of string or null

incoterms string,null

weights array of string or null

licensePlateNumber string,null

vinNumber string,null

guestCount integer or null

serverName string,null

storeNumber string,null

vendingPerson string,null

vendingPersonNumber string,null

customerAccountNumber string,null

category string,null

defaultCategory string,null

barcodes

array of object or null

Fields

`data` required	string
`type` required	`QR_CODE` `PDF417` `EAN_13` `EAN_8` `UPC_A` `UPC_E` `CODE_128` `CODE_39` `ITF` `DATA_MATRIX` `AZTEC` `OTHER`
`page` required	integer
`boundingRegion`	array of number or null

paymentLinks

array of object or null

Fields

`url` required	string
`source` required	`text` `hyperlink` `qr_code` `barcode`

folio

object or null

Fields

`arrivalDate`	string or null
`departureDate`	string or null
`roomNumber`	string,null
`guestName`	string,null
`nights`	integer or null
`confirmationNumber`	string,null

enrichedFields array of string or null

check

object or null

Fields

`amountMinor`	integer or null
`amountText`	string,null
`amountsAgree`	boolean,null
`bankName`	string,null
`bankAddress`	string,null
`checkNumber`	string,null
`checkType`	`bank_draft` `bill_pay_draft` `business_check` `cashiers_check` `government_check` `money_order` `personal_check` `starter_check` `teller_check` or null
`currency`	string or null
`date`	string or null
`memo`	string,null
`payerName`	string,null
`payerAddress`	string,null
`receiverName`	string,null
`receiverAddress`	string,null
`isSigned`	boolean,null
`endorsement`	object or null
`micr`	object or null
`fractionalRoutingNumber`	string,null
`routingFromFractional`	string,null
`voidTerms`	string,null

statement

object or null

Fields

`accountHolderName`	string,null
`accountHolderAddress`	string,null
`accountType`	string,null
`accountNumber`	string,null
`bankName`	string,null
`bankAddress`	string,null
`bankWebsite`	string,null
`bankVatNumber`	string,null
`accountVatNumber`	string,null
`periodStartDate`	string or null
`periodEndDate`	string or null
`statementDate`	string or null
`statementNumber`	string,null
`currency`	string or null
`beginningBalanceMinor`	integer or null
`endingBalanceMinor`	integer or null
`minimumDueMinor`	integer or null
`dueDate`	string or null
`routingNumber`	string,null
`swift`	string,null
`iban`	string,null
`accounts`	array of object
`balancesAgree`	boolean,null

taxForm

object or null

Fields

`kind` required	`W2` `W9` `W8BEN_E`
`w2`	object or null
`w9`	object or null
`w8BenE`	map of string,boolean,null or null

itinerary

object or null

Fields

`travelerName`	string,null
`bookingReference`	string,null
`origin`	string,null
`destination`	string,null
`departsOn`	string or null
`returnsOn`	string or null
`segments`	array of object

fieldConfidence map of number

fieldBoxes map of object

confidence required number,null

flags required array of string

warnings required

array of object

Integrity findings. A caller without expenses.read_all sees the arithmetic and dates only.

Fields

`code` required	`tax_rate_mismatch` `item_counts_mismatch` `totals_mismatch` `line_item_amount_mismatch` `line_item_repeats` `barcode_decoding_issue` `barcode_code_missing_in_ocr` `logo_vendor_mismatch` `malware` `weekend_transaction` `time_and_currency_mismatch` `exif_creation_modified_date_mismatch` `missing_date` `suspicious_document_aspect_ratio` `generic_placeholder_content`
`message` required	string
`page`	number,null

fraud required

object or null

Fields

version required string

score required

number

0 to 1, from the signals that fired. Evidence, never a verdict.

color required

green yellow red

Under the workspace yellow threshold is green. Over its red threshold is red.

types required

array of digital_tampering fraudulent_pdf fraudulent_image generated_document ai_generated lcd_photo screenshot digital_background not_a_document duplicate similar_documents handwritten_characters invalid_qr_data invalid_mrz_data suspicious_content data_inconsistency vendor_layout_mismatch total_in_words_mismatch aspect_ratio_mismatch high_velocity critical_velocity multiple_profiles_or_devices fraud_history blocked_device other

Signals that fired, most important first.

details required

map of object

By signal: a description, a confidence and typed reasons.

attribution required

string,null

One sentence naming the strongest evidence.

decision required

clear review fraud not_fraud unknown

clear or review until a person decides. Only a person can say fraud.

review required

object or null

Fields

decision required FRAUD NOT_FRAUD UNKNOWN

types required array of digital_tampering fraudulent_pdf fraudulent_image generated_document ai_generated lcd_photo screenshot digital_background not_a_document duplicate similar_documents handwritten_characters invalid_qr_data invalid_mrz_data suspicious_content data_inconsistency vendor_layout_mismatch total_in_words_mismatch aspect_ratio_mismatch high_velocity critical_velocity multiple_profiles_or_devices fraud_history blocked_device other

note required string,null

reviewedBy required

object or null

Fields

`id` required	string
`name` required	string,null

reviewedAt required string

deviceId required

string,null

The id the client sent for its device, when it sent one.

submissions required

object or null

Documents from this uploader in this workspace, by window.

Fields

`lastMinutes` required	number
`lastDay` required	number
`lastWeek` required	number
`last2Weeks` required	number
`lastMonth` required	number

deviceProfiles required

array of object

Over 30 days, inside this workspace only.

Fields

`deviceId` required	string
`profileId` required	string
`documentCount` required	number

digitalTamperingFields required array of string

handwriting required

object

What Claude saw written by hand, in dot notation, when a key is set and the handwriting signal is on. With no key, the lists are empty and the flags null: skipped says why.

Fields

`handwrittenFields` required	array of string
`fullyHandwrittenFields` required	array of string
`handwrittenTamperedFields` required	array of string
`handwritingDetected` required	boolean,null
`handwritingTamperingPresent` required	boolean,null

notADocument required

object

Fields

`value` required	boolean,null
`score` required	number,null

digitalBackground required

object

Fields

`value` required	boolean,null
`score` required	number,null

fraudulentPdf required

object or null

Fields

fraudulentPdfCreator required number,null

textOverlay required number,null

fontMismatch required number,null

hasDigitalSignature required boolean,null

pdfModified required number,null

incrementalUpdates required number,null

incrementalChanges required array of string

incrementalEdits required

array of object

Fields

`page` required	number
`before` required	string,null
`after` required	string,null

signatureCreationTools required array of string

dateInversion required number,null

producerContentMismatch required number,null

writerMismatch required number,null

nullMetadata required number,null

xmpInfoMismatch required number,null

futureMetadataDate required number,null

rasterProfileMismatch required number,null

uncompressedRaster required number,null

splicedPage required number,null

splicedPageNumber required number,null

valueFontSplice required number,null

valueFontSplicePage required number,null

headlessDesktopRender required number,null

headlessRenderPlatform required string,null

doubleJpeg required number,null

firstQuantizationQuality required number,null

scrubbedProvenance required number,null

score required number,null

fraudulentImage required

object or null

Fields

`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`editorSignature` required	number,null
`editorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`editorSignatureValue` required	string,null
`generatorSignature` required	number,null
`generatorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`generatorSignatureValue` required	string,null
`generatorWriterProfile` required	number,null
`generatorWriterProfileValue` required	string,null
`syntheticRaster` required	number,null
`syntheticRasterFingerprints` required	array of string
`unprofiledPng` required	number,null
`unprofiledWebp` required	number,null
`source` required	`original` `render` or null
`sourceFormats` required	array of string
`unreadableSource` required	number,null
`score` required	number,null

pages required

array of object

Fields

index required number

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Value null means nothing could say: no pixel model runs, only metadata can answer.

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

skipped required

array of object

Checks that could not run on this file, so a clean result is not read as more than it is.

Fields

`check` required	string
`reason` required	string

sealed required

array of object

Bank and tax numbers read from this document, as masks. POST /v1/documents/{id}/reveal opens them.

Fields

`kind` required	`ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`masked` required	string All but the last few characters are stars. Punctuation stays where it was.
`field` required	string,null
`page` required	number

updatedAt required string

extractor required

string,null

What read it: rules, claude, a blueprint, business-card, or none.

ocrText required

string,null

Everything read off the page. Card, bank and tax numbers are masked.

pdfUrl required

string,null

The PDF as uploaded, signed for 15 minutes. Null for an image, and for a PDF that prints a number only a reveal hands out.

meta required

object

Fields

totalPages required number

processedPages required number

ocrScore required

number,null

The average character confidence of the reading, which doubles as a measure of the image.

originalFileName required string,null

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

language required

string,null

BCP-47.

languages required

array of object

Every language found, best first.

Fields

`tag` required	string
`score` required	number

deviceId required string,null

deviceUserUuid required

string,null

The signed-in person the device was capturing for. Null when no device was named.

latitude required number,null

longitude required number,null

sourceDocuments required

array of map of any

Each file as submitted: name, type, size in KB, width, height and EXIF.

owner required

object or null

Who uploaded it.

Fields

`id` required	string
`name` required	string,null

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

reviewedAt required

string,null

A person checked what was read.

approvedAt required

string,null

A developer's own approved flag. An expense's approval is a different thing.

reading

object or null

Null when nothing has been read yet.

Fields

lines

array of object

With bounding_boxes: every line read, with where it is.

Fields

`text` required	string
`confidence` required	number
`box`	tuple [x, y, width, height] in pixels of the page.
`quad`	array of number The four corners as x, y pairs, for a line read at an angle.
`page` required	number

fieldDetail

map of any

With confidence_details: where each field was read from and how sure the read was.

detailed

any

With detailed: the reading with each field wrapped as value, score, ocrScore, rotation, boundingBox, boundingRegion and enriched.

lineItemsWithScores

array of map of any

With with_scores: the same lines, with a value and its confidence on every sub-field.

taxLinesWithScores

array of map of any

With with_scores: the same tax lines, with a value and its confidence on every sub-field.

DocumentTagList

data required

array of object

Fields

`id` required	string
`name` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ExpenseLine

`id` required	string
`position` required	number
`description` required	string
`sku` required	string,null
`quantity` required	number,null
`unitPriceMinor` required	number,null
`amountMinor` required	number
`taxMinor` required	number,null
`categoryId` required	string,null

ExpenseLinePage

data required

array of object

Fields

`id` required	string
`position` required	number
`description` required	string
`sku` required	string,null
`quantity` required	number,null
`unitPriceMinor` required	number,null
`amountMinor` required	number
`taxMinor` required	number,null
`categoryId` required	string,null

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ExpenseTaxLine

`id` required	string
`position` required	number
`name` required	string,null
`code` required	string,null
`ratePct` required	number,null
`baseMinor` required	number,null
`amountMinor` required	number

ExpenseTaxLinePage

data required

array of object

Fields

`id` required	string
`position` required	number
`name` required	string,null
`code` required	string,null
`ratePct` required	number,null
`baseMinor` required	number,null
`amountMinor` required	number

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

WorkspaceClosed

status required closed

purgeAfter required

string

Records are erased after this moment.

storeSubscriptions required

array of object

Non-empty when a store goes on billing until someone cancels there.

Fields

`workspaceId` required	string
`workspaceName` required	string
`store` required	`APP_STORE` `PLAY_STORE`

ReferenceCurrencyPage

data required

array of object

Fields

`code` required	string
`name` required	string
`minorDigits` required	number Decimal places in the minor unit: 2 for USD, 0 for JPY.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ReferenceCountryPage

data required

array of object

Fields

`code` required	string
`name` required	string
`currency` required	string The currency its receipts print.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ReferenceLocalePage

data required

array of object

Fields

`code` required	string
`name` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ReferenceSystemCategoryPage

data required

array of object

Fields

`key` required	string Stays when a workspace renames its copy.
`name` required	string
`glCode` required	string,null
`taxLine` required	string,null
`deductiblePct` required	number

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

BulkReimbursed

reimbursed required array of string

skipped required

array of object

Not in a state to mark: not approved yet, already paid, in a batch, or nothing on it is reimbursable. Left as it was.

Fields

`id` required	string
`reference` required	string,null
`code` required	string
`message` required	string

failed required

array of object

Not found, or not the caller's to mark.

Fields

`id` required	string
`reference` required	string,null
`code` required	string
`message` required	string

DocumentList

data required

array of object

Fields

id required string

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

status required UPLOADED PROCESSING PROCESSED FAILED

originalFilename required string,null

mimeType required string

sizeBytes required number

pageCount required number

externalId required string,null

folderId required string,null

expenseId required string,null

mailInBatchId required string,null

title required string,null

notes required string,null

latitude required

number,null

Where the device said it was when the photo was taken.

longitude required number,null

locationAccuracyM required number,null

duplicateOfId required string,null

processingError required string,null

processingErrorCode required

FILE_ENCRYPTED or null

Set when the failure is one the file's owner can fix. processingError says what to do.

verification required string

capturedAt required string,null

processedAt required string,null

viewedAt required string,null

archivedAt required string,null

createdAt required string

uploadedBy required

object or null

Fields

`id` required	string
`name` required	string,null

pages required

array of object

Fields

index required number

url required string,null

thumbnailUrl required string,null

width required number,null

height required number,null

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Blank for a caller without expenses.read_all.

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Null when the page is not one, and for a caller without expenses.read_all.

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Blank for a caller without expenses.read_all. Value null means nothing could say.

Fields

`value` required	boolean,null
`score` required	number,null

language required string,null

languages required

array of object

Fields

`tag` required	string
`score` required	number

ocrScore required number,null

isFront required

boolean,null

A check: the front or the back.

tiffRejectScore required

number,null

A check: 0 is a clean clearing image and 1 is one a bank would send back.

tiffUpscaled required

boolean,null

A check: the photo was under 240 DPI, so the clearing image was enlarged.

classification required

object or null

What the classifier decided, when it was asked.

Fields

value required

string

A document class, or one of the labels the caller named.

score required

number

0..1.

engine required rules claude

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

blueprint required

object or null

The blueprint this was read with, and what came out of it.

Fields

`name` required	string
`version` required	number,null Null for a built-in, which has no versions.
`result` required	map of any or null The fields the blueprint defines. Null when the run failed.
`offsets`	map of object Where each value sits in the text, for a blueprint that asks.
`unmatched`	array of string Fields where a value was read and did not fit, such as words where a number belongs or a choice off the list. Each is left empty. An empty field not named here was not on the document.
`error` required	string,null Why the run gave nothing back.

tags required array of string

tagRefs required

array of object

The same tags with their ids, which a tag route takes.

Fields

`id` required	string
`name` required	string

recordStatus required

processed reviewed archived or null

Where a read document stands: reviewedAt and archivedAt in one word. Null until it has been read.

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

setId required

string,null

The upload this came out of: a ZIP, a split PDF or a batch of addresses.

customFields required

map of string or array of string or null

Values the workspace custom field rules read out of the text.

enrichment required

object or null

Work still running after the first answer.

Fields

`status` required	`PENDING` `DONE` `FAILED`
`steps` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`failed` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`

extraction required

object or null

Fields

fields required

object

What was read, as the extraction contract types it. fieldConfidence holds per-field confidence, 0..1.

Fields

`documentType`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`merchantName`	string,null
`merchantAddress`	string,null
`merchantPhone`	string,null
`merchantWebsite`	string,null
`merchantTaxId`	string,null
`date`	string or null
`time`	string,null
`dueDate`	string or null
`currency`	`AED` `AFN` `ALL` `AMD` `ANG` `AOA` `ARS` `AUD` `AWG` `AZN` `BAM` `BBD` `BDT` `BGN` `BHD` `BIF` `BMD` `BND` `BOB` `BRL` `BSD` `BTN` `BWP` `BYN` `BZD` `CAD` `CDF` `CHF` `CLP` `CNY` `COP` `CRC` `CUP` `CVE` `CZK` `DJF` `DKK` `DOP` `DZD` `EGP` `ERN` `ETB` `EUR` `FJD` `FKP` `GBP` `GEL` `GHS` `GIP` `GMD` `GNF` `GTQ` `GYD` `HKD` `HNL` `HTG` `HUF` `IDR` `ILS` `INR` `IQD` `IRR` `ISK` `JMD` `JOD` `JPY` `KES` `KGS` `KHR` `KMF` `KPW` `KRW` `KWD` `KYD` `KZT` `LAK` `LBP` `LKR` `LRD` `LSL` `LYD` `MAD` `MDL` `MGA` `MKD` `MMK` `MNT` `MOP` `MRU` `MUR` `MVR` `MWK` `MXN` `MYR` `MZN` `NAD` `NGN` `NIO` `NOK` `NPR` `NZD` `OMR` `PAB` `PEN` `PGK` `PHP` `PKR` `PLN` `PYG` `QAR` `RON` `RSD` `RUB` `RWF` `SAR` `SBD` `SCR` `SDG` `SEK` `SGD` `SHP` `SLE` `SOS` `SRD` `SSP` `STN` `SVC` `SYP` `SZL` `THB` `TJS` `TMT` `TND` `TOP` `TRY` `TTD` `TWD` `TZS` `UAH` `UGX` `USD` `UYU` `UZS` `VES` `VND` `VUV` `WST` `XAF` `XCD` `XCG` `XOF` `XPF` `YER` `ZAR` `ZMW` `ZWG` `CUC` `HRK` `SLL` `ZWL` `XDR` `XSU` or null
`currencyGuessed`	boolean
`totalMinor`	integer or null
`subtotalMinor`	integer or null
`taxMinor`	integer or null
`taxLines`	array of object
`tipMinor`	integer or null
`discountMinor`	integer or null
`shippingMinor`	integer or null
`paymentType`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER` or null
`cardBrand`	string,null
`cardLast4`	string,null
`receiptNumber`	string,null
`invoiceNumber`	string,null
`poNumber`	string,null
`lineItems`	array of object
`suggestedCategory`	string,null
`documentTitle`	string,null
`documentReferenceNumber`	string,null
`isDocument`	boolean,null
`isTransaction`	boolean,null
`isMoneyIn`	boolean,null
`accountingEntryType`	`debit` `credit` or null
`vendor`	object or null
`vendors`	array of object or null
`bankBreakdown`	array of object or null
`billTo`	object or null
`shipTo`	object or null
`insuranceMinor`	integer or null
`cashbackMinor`	integer or null
`roundingMinor`	integer or null
`balanceMinor`	integer or null
`finalBalanceMinor`	integer or null
`previousBalanceMinor`	integer or null
`totalQuantity`	number,null
`totalWeight`	string,null
`payment`	object or null
`orderDate`	string or null
`shipDate`	string or null
`deliveryDate`	string or null
`serviceStartDate`	string or null
`serviceEndDate`	string or null
`exchangeRate`	number,null
`countryCode`	string,null
`deliveryNoteNumber`	string,null
`trackingNumber`	string,null
`trackingNumbers`	array of string or null
`incoterms`	string,null
`weights`	array of string or null
`licensePlateNumber`	string,null
`vinNumber`	string,null
`guestCount`	integer or null
`serverName`	string,null
`storeNumber`	string,null
`vendingPerson`	string,null
`vendingPersonNumber`	string,null
`customerAccountNumber`	string,null
`category`	string,null
`defaultCategory`	string,null
`barcodes`	array of object or null
`paymentLinks`	array of object or null
`folio`	object or null
`enrichedFields`	array of string or null
`check`	object or null
`statement`	object or null
`taxForm`	object or null
`itinerary`	object or null
`fieldConfidence`	map of number
`fieldBoxes`	map of object

confidence required number,null

flags required array of string

warnings required

array of object

Integrity findings. A caller without expenses.read_all sees the arithmetic and dates only.

Fields

`code` required	`tax_rate_mismatch` `item_counts_mismatch` `totals_mismatch` `line_item_amount_mismatch` `line_item_repeats` `barcode_decoding_issue` `barcode_code_missing_in_ocr` `logo_vendor_mismatch` `malware` `weekend_transaction` `time_and_currency_mismatch` `exif_creation_modified_date_mismatch` `missing_date` `suspicious_document_aspect_ratio` `generic_placeholder_content`
`message` required	string
`page`	number,null

fraud required

object or null

Fields

version required string

score required

number

0 to 1, from the signals that fired. Evidence, never a verdict.

color required

green yellow red

Under the workspace yellow threshold is green. Over its red threshold is red.

types required

Signals that fired, most important first.

details required

map of object

By signal: a description, a confidence and typed reasons.

attribution required

string,null

One sentence naming the strongest evidence.

decision required

clear review fraud not_fraud unknown

clear or review until a person decides. Only a person can say fraud.

review required

object or null

Fields

`decision` required	`FRAUD` `NOT_FRAUD` `UNKNOWN`
`types` required	array of `digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`note` required	string,null
`reviewedBy` required	object or null
`reviewedAt` required	string

deviceId required

string,null

The id the client sent for its device, when it sent one.

submissions required

object or null

Documents from this uploader in this workspace, by window.

Fields

`lastMinutes` required	number
`lastDay` required	number
`lastWeek` required	number
`last2Weeks` required	number
`lastMonth` required	number

deviceProfiles required

array of object

Over 30 days, inside this workspace only.

Fields

`deviceId` required	string
`profileId` required	string
`documentCount` required	number

digitalTamperingFields required array of string

handwriting required

object

What Claude saw written by hand, in dot notation, when a key is set and the handwriting signal is on. With no key, the lists are empty and the flags null: skipped says why.

Fields

`handwrittenFields` required	array of string
`fullyHandwrittenFields` required	array of string
`handwrittenTamperedFields` required	array of string
`handwritingDetected` required	boolean,null
`handwritingTamperingPresent` required	boolean,null

notADocument required

object

Fields

`value` required	boolean,null
`score` required	number,null

digitalBackground required

object

Fields

`value` required	boolean,null
`score` required	number,null

fraudulentPdf required

object or null

Fields

`fraudulentPdfCreator` required	number,null
`textOverlay` required	number,null
`fontMismatch` required	number,null
`hasDigitalSignature` required	boolean,null
`pdfModified` required	number,null
`incrementalUpdates` required	number,null
`incrementalChanges` required	array of string
`incrementalEdits` required	array of object
`signatureCreationTools` required	array of string
`dateInversion` required	number,null
`producerContentMismatch` required	number,null
`writerMismatch` required	number,null
`nullMetadata` required	number,null
`xmpInfoMismatch` required	number,null
`futureMetadataDate` required	number,null
`rasterProfileMismatch` required	number,null
`uncompressedRaster` required	number,null
`splicedPage` required	number,null
`splicedPageNumber` required	number,null
`valueFontSplice` required	number,null
`valueFontSplicePage` required	number,null
`headlessDesktopRender` required	number,null
`headlessRenderPlatform` required	string,null
`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`score` required	number,null

fraudulentImage required

object or null

Fields

`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`editorSignature` required	number,null
`editorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`editorSignatureValue` required	string,null
`generatorSignature` required	number,null
`generatorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`generatorSignatureValue` required	string,null
`generatorWriterProfile` required	number,null
`generatorWriterProfileValue` required	string,null
`syntheticRaster` required	number,null
`syntheticRasterFingerprints` required	array of string
`unprofiledPng` required	number,null
`unprofiledWebp` required	number,null
`source` required	`original` `render` or null
`sourceFormats` required	array of string
`unreadableSource` required	number,null
`score` required	number,null

pages required

array of object

Fields

`index` required	number
`isBlurry` required	object
`isLcd` required	object
`screenshot` required	object or null
`aiGenerated` required	object Value null means nothing could say: no pixel model runs, only metadata can answer.
`glare` required	object

skipped required

array of object

Checks that could not run on this file, so a clean result is not read as more than it is.

Fields

`check` required	string
`reason` required	string

sealed required

array of object

Bank and tax numbers read from this document, as masks. POST /v1/documents/{id}/reveal opens them.

Fields

`kind` required	`ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`masked` required	string All but the last few characters are stars. Punctuation stays where it was.
`field` required	string,null
`page` required	number

updatedAt required string

extractor required

string,null

What read it: rules, claude, a blueprint, business-card, or none.

ocrText required

string,null

Everything read off the page. Card, bank and tax numbers are masked.

pdfUrl required

string,null

The PDF as uploaded, signed for 15 minutes. Null for an image, and for a PDF that prints a number only a reveal hands out.

meta required

object

Fields

totalPages required number

processedPages required number

ocrScore required

number,null

The average character confidence of the reading, which doubles as a measure of the image.

originalFileName required string,null

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

language required

string,null

BCP-47.

languages required

array of object

Every language found, best first.

Fields

`tag` required	string
`score` required	number

deviceId required string,null

deviceUserUuid required

string,null

The signed-in person the device was capturing for. Null when no device was named.

latitude required number,null

longitude required number,null

sourceDocuments required

array of map of any

Each file as submitted: name, type, size in KB, width, height and EXIF.

owner required

object or null

Who uploaded it.

Fields

`id` required	string
`name` required	string,null

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

reviewedAt required

string,null

A person checked what was read.

approvedAt required

string,null

A developer's own approved flag. An expense's approval is a different thing.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

offset

number

Where this page starts, when paging by offset or page.

nextOffset

number,null

Send this as offset for the next page. Null on the last one.

page

number

When paging by page number.

pageSize number

totalCount

number

With track_total_results: every document the caller can reach.

filteredCount

number

With track_total_results: what the filters leave of those.

ProvisionResult

dryRun required boolean

added required

array of object

Fields

`email` required	string
`invited` required	boolean

updated required

array of object

Fields

`email` required	string
`fields` required	array of string

removed required

array of object

Fields

email required string

skipped required

array of object

Fields

`email` required	string
`reason` required	string

AutomationApply

`matched` required	number
`updated` required	number

AutomationPreview

matched required

number

Expenses the conditions match, voided ones aside.

applicable required

number

Of those, the ones still unsubmitted, which is what applying the rule changes.

sample required

array of object

Fields

`id` required	string
`reference` required	string
`merchantName` required	string,null
`date` required	string
`currency` required	string
`amountMinor` required	number
`status` required	string

aiSkipped required

boolean

A question for Claude was left out of this count: it is asked when a document is read, not here.

AutomationRule

id required string

name required string

enabled required boolean

position required number

conditions required

array of object

Fields

value

string or number or boolean or object or object

Fields

`from` required	string
`to` required	string

fallback no_match match

actions required

object

Fields

categoryId string

projectId string

clientId string

tagIds array of string

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

description string

merchantName string

taxBasisPoints integer

vendorId string (uuid)

postToBooks true

clear array of categoryId tagIds taxMinor

reportId string

autoApprove true

reject

object

Fields

reason required string

flagForReview

object

Fields

reason required string

setStatus NEEDS_REVIEW READY

group

object

Fields

report required string

setCustomFields map of string or number or boolean

extract

array of object or object

Fields

`kind` required	`regex`
`field` required	string
`pattern` required	string

llmExtract

array of object

Fields

field required string

prompt required string

examples

array of object

Fields

`input` required	string
`output` required	string

fallback required

object or object or object

Fields

action required none

matchCount required number

createdAt required string

updatedAt required string

AutomationRuleOrder

data required

array of object

Fields

id required string

name required string

enabled required boolean

position required number

conditions required

array of object

Fields

value

string or number or boolean or object or object

Fields

`from` required	string
`to` required	string

fallback no_match match

actions required

object

Fields

categoryId string

projectId string

clientId string

tagIds array of string

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

description string

merchantName string

taxBasisPoints integer

vendorId string (uuid)

postToBooks true

clear array of categoryId tagIds taxMinor

reportId string

autoApprove true

reject

object

Fields

reason required string

flagForReview

object

Fields

reason required string

setStatus NEEDS_REVIEW READY

group

object

Fields

report required string

setCustomFields map of string or number or boolean

extract

array of object or object

Fields

`kind` required	`regex`
`field` required	string
`pattern` required	string

llmExtract

array of object

Fields

`field` required	string
`prompt` required	string
`examples`	array of object
`fallback` required	object or object or object

matchCount required number

createdAt required string

updatedAt required string

AutomationRuleList

data required

array of object

Fields

id required string

name required string

enabled required boolean

position required number

conditions required

array of object

Fields

value

string or number or boolean or object or object

Fields

`from` required	string
`to` required	string

fallback no_match match

actions required

object

Fields

categoryId string

projectId string

clientId string

tagIds array of string

billable boolean

reimbursable boolean

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

description string

merchantName string

taxBasisPoints integer

vendorId string (uuid)

postToBooks true

clear array of categoryId tagIds taxMinor

reportId string

autoApprove true

reject

object

Fields

reason required string

flagForReview

object

Fields

reason required string

setStatus NEEDS_REVIEW READY

group

object

Fields

report required string

setCustomFields map of string or number or boolean

extract

array of object or object

Fields

`kind` required	`regex`
`field` required	string
`pattern` required	string

llmExtract

array of object

Fields

`field` required	string
`prompt` required	string
`examples`	array of object
`fallback` required	object or object or object

matchCount required number

createdAt required string

updatedAt required string

aiAvailable required

boolean

Whether a question for Claude can be asked right now. When it cannot, each rule that needs one takes its fallback.

Billing

plan required STARTER PRO BUSINESS or null

status required TRIALING ACTIVE PAST_DUE EXPIRED NONE

source required STRIPE APP_STORE PLAY_STORE TRIAL COMP or null

active required boolean

interval required MONTH YEAR or null

seats required

number

Seats the workspace holds.

seatsUsed required

number

Members now plus open invitations, which hold a seat each. Above seats after a downgrade.

seatsIncluded required number,null

maxSeats required

number,null

Null is unlimited, or no plan.

trialEndsAt required string,null

currentPeriodEnd required string,null

cancelAtPeriodEnd required boolean

storeManaged required

boolean

A live App Store or Google Play subscription owns this workspace, so the web cannot sell to it.

store required APP_STORE PLAY_STORE or null

hasStripeSubscription required boolean

canOpenPortal required boolean

usage required

array of object

The plan's counters for this month.

Fields

`metric` required	`scans` `api_documents`
`used` required	number
`limit` required	number

stripeConfigured required boolean

cashsdkConfigured required boolean

BulkMemberResult

succeeded required array of string

failed required

array of object

Members the rules refused. They stay as they were, and the rest still change.

Fields

`id` required	string
`message` required	string

CardStatements

array of object

`from` required	string
`to` required	string
`open` required	boolean True for the period still open today.
`count` required	number
`spentMinor` required	number
`creditedMinor` required	number
`netMinor` required	number
`currency` required	string

IntegrationHealth

provider required QUICKBOOKS_ONLINE XERO FRESHBOOKS WAVE ZOHO_BOOKS SAGE NETSUITE GUSTO GOOGLE_DRIVE DROPBOX BOX ONEDRIVE GMAIL SLACK ZAPIER QUICKBOOKS_DESKTOP INTUIT_ENTERPRISE CAMPFIRE DUALENTRY RILLET ACCELO CERTINIA SAGE_BUSINESS_CLOUD SAASU BAMBOOHR HIBOB WORKDAY GOOGLE_WORKSPACE GREENHOUSE EVERNOTE QUICKBOOKS_TIME RIGHTSIGNATURE HR_SYNC BILL_COM SAP_CONCUR MICROSOFT_DYNAMICS MYOB ORACLE SAP_ERP

slug required string

name required string

status required CONNECTED NEEDS_ATTENTION DISCONNECTED

organisationName required string,null

synced required number

pending required number

failed required number

skipped required number

voided required number

waiting required

number

Approved expenses with no record yet.

lastSyncedAt required string,null

tokenExpiresAt required string,null

refreshTokenExpiresAt required string,null

endsOnDate boolean

pausedUntil required string,null

pulledAt required string,null

postingPaused

object or null

Fields

`since` required	string
`code` required	string
`message` required	string

IntegrationList

array of object

slug required string

name required string

group required ACCOUNTING PAYROLL HR CAPTURE STORAGE CHAT AUTOMATION

availability required NOT_CONFIGURED AVAILABLE CONNECTED NEEDS_ATTENTION EXPORT_AVAILABLE NOT_CONNECTED

label required

string

The short status, as printed on the card.

description required string

export required

object or null

The file that works today, with this provider or without it.

Fields

`format` required	`CSV` `XLSX` `PDF` `ZIP` `QBO_CSV` `XERO_CSV` `SAGE_CSV` `DYNAMICS_CSV` `MYOB_TXT` `ORACLE_CSV` `SAP_CSV` `IIF` `OFX` `JSON` `XML` `TXT` `XLS`
`label` required	string
`payroll`	boolean

organisationName required string,null

organisationChoices required

array of object

Fields

`id` required	string
`name` required	string

lastSyncedAt required string,null

lastError required string,null

links required

array of object

Fields

`label` required	string
`href` required	string

customerApp boolean

blockedBy string

InvitationPage

data required

array of object

Fields

id required string

email required string

name required string,null

role required OWNER ADMIN APPROVER ACCOUNTANT AUDITOR MEMBER EDITOR CARD_ADMIN PEOPLE_ADMIN PAYMENTS_ADMIN

status required PENDING EXPIRED ACCEPTED REVOKED

invitedBy required

object or null

Fields

`id` required	string
`name` required	string,null

expiresAt required string

acceptedAt required string,null

revokedAt required string,null

createdAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

InvitationSent

id required string

email required string

name required string,null

role required OWNER ADMIN APPROVER ACCOUNTANT AUDITOR MEMBER EDITOR CARD_ADMIN PEOPLE_ADMIN PAYMENTS_ADMIN

status required PENDING EXPIRED ACCEPTED REVOKED

invitedBy required

object or null

Fields

`id` required	string
`name` required	string,null

expiresAt required string

acceptedAt required string,null

revokedAt required string,null

createdAt required string

acceptUrl required

string

The link the email carries. It works only for someone signed in with this address.

MailInAllowance

period required

string

YYYY-MM.

limit required

number

Documents a month on this plan.

used required

number

Held by this month's batches. It can pass the limit: paper that has arrived is scanned regardless.

remaining required number

included required

boolean

False when the plan does not include mail-in at all.

available required

boolean

False until there is a mailroom to send paper to, whatever the plan says.

mailroomAddress required

string,null

Where own-packaging paper goes. Null until a mailroom has one.

envelopes required

object

Fields

`week` required	string 2026-W44. A week starts on Monday, UTC.
`weekLimit` required	number Envelopes a workspace can have sent in a week.
`used` required	number
`remaining` required	number Envelopes that can still be requested this week.

MailInSettings

address required

object or null

Fields

`name` required	string
`company`	string or null
`line1` required	string
`line2`	string or null
`city` required	string
`region` required	string
`postalCode` required	string
`country`	string

updatedAt required string,null

MailInBatch

id required string

reference required

string

Printed on the packing slip and on the cover sheet.

workspaceReference required string

status required REQUESTED ENVELOPE_SENT IN_TRANSIT RECEIVED SCANNING COMPLETED RETURNED LOST CANCELLED

envelopes required number

expectedDocuments required number

documentCount required number

afterScan required RETURN SHRED

shippingAddress required

object

Fields

`name` required	string
`company`	string or null
`line1` required	string
`line2`	string or null
`city` required	string
`region` required	string
`postalCode` required	string
`country`	string

folderId required string,null

trackingNumber required string,null

notes required string,null

requestedById required string

requestedByName required

string,null

Who this paper belongs to, as printed on the slip and the cover sheet.

requestedByEmail required string,null

envelopeSentAt required string,null

receivedAt required string,null

completedAt required string,null

createdAt required string

updatedAt required string

MailInBatchPage

data required

array of object

Fields

id required string

reference required

string

Printed on the packing slip and on the cover sheet.

workspaceReference required string

status required REQUESTED ENVELOPE_SENT IN_TRANSIT RECEIVED SCANNING COMPLETED RETURNED LOST CANCELLED

envelopes required number

expectedDocuments required number

documentCount required number

afterScan required RETURN SHRED

shippingAddress required

object

Fields

`name` required	string
`company`	string or null
`line1` required	string
`line2`	string or null
`city` required	string
`region` required	string
`postalCode` required	string
`country`	string

folderId required string,null

trackingNumber required string,null

notes required string,null

requestedById required string

requestedByName required

string,null

Who this paper belongs to, as printed on the slip and the cover sheet.

requestedByEmail required string,null

envelopeSentAt required string,null

receivedAt required string,null

completedAt required string,null

createdAt required string

updatedAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

MailInRequested

id required string

reference required

string

Printed on the packing slip and on the cover sheet.

workspaceReference required string

status required REQUESTED ENVELOPE_SENT IN_TRANSIT RECEIVED SCANNING COMPLETED RETURNED LOST CANCELLED

envelopes required number

expectedDocuments required number

documentCount required number

afterScan required RETURN SHRED

shippingAddress required

object

Fields

`name` required	string
`company`	string or null
`line1` required	string
`line2`	string or null
`city` required	string
`region` required	string
`postalCode` required	string
`country`	string

folderId required string,null

trackingNumber required string,null

notes required string,null

requestedById required string

requestedByName required

string,null

Who this paper belongs to, as printed on the slip and the cover sheet.

requestedByEmail required string,null

envelopeSentAt required string,null

receivedAt required string,null

completedAt required string,null

createdAt required string

updatedAt required string

envelopeAllowance required

object

Fields

`week` required	string 2026-W44. A week starts on Monday, UTC.
`weekLimit` required	number Envelopes a workspace can have sent in a week.
`used` required	number
`remaining` required	number Envelopes that can still be requested this week.

MailInDocumentPage

data required

array of object

Fields

`id` required	string
`type` required	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`status` required	`UPLOADED` `PROCESSING` `PROCESSED` `FAILED`
`originalFilename` required	string,null
`thumbnailUrl` required	string,null
`createdAt` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Member

id required

string

The membership: the id PATCH and DELETE /v1/members/:id take.

userId required string

email required string

name required string,null

photoUrl required string,null

pronouns required string,null

personStatus required

object or null

The note they set beside their name, until it clears. status is their membership.

Fields

`text` required	string
`clearsAt` required	string,null

role required OWNER ADMIN APPROVER ACCOUNTANT AUDITOR MEMBER EDITOR CARD_ADMIN PEOPLE_ADMIN PAYMENTS_ADMIN

status required ACTIVE SUSPENDED

developer required

boolean

Whether this person can reach API keys and webhooks: always for an owner, and for an admin only with the grant. False unless the caller has members.manage.

managerId required

string,null

The manager's user id.

managerName required string,null

title required string,null

department required string,null

employeeId required

string,null

Null unless the caller has members.manage.

approvalLimitMinor required

number,null

Null unless the caller has members.manage.

overLimitApproverId required

string,null

Null unless the caller has members.manage.

forwardToId required

string,null

Null unless the caller has members.manage.

workerStatus required

string,null

Null unless the caller has members.manage.

defaultTags required

array of string

Empty unless the caller has members.manage.

customField1 required string,null

customField2 required string,null

payrollCode required

string,null

Goes out with payroll files. Null unless the caller manages members.

legalEntity required

string,null

The company the person is employed by. Null unless the caller manages members.

tier required

string,null

Their travel tier. Null unless the caller manages members.

officeLocation required

string,null

The office they work from. Null unless the caller manages members.

costCenter required

string,null

Where their costs are charged. Null unless the caller manages members.

accountingCode required

string,null

Their code in the books. Null unless the caller manages members.

workerType required

string,null

Employee, contractor or the like. Null unless the caller manages members.

createdAt required string

MemberPage

data required

array of object

Fields

id required

string

The membership: the id PATCH and DELETE /v1/members/:id take.

userId required string

email required string

name required string,null

photoUrl required string,null

pronouns required string,null

personStatus required

object or null

The note they set beside their name, until it clears. status is their membership.

Fields

`text` required	string
`clearsAt` required	string,null

role required OWNER ADMIN APPROVER ACCOUNTANT AUDITOR MEMBER EDITOR CARD_ADMIN PEOPLE_ADMIN PAYMENTS_ADMIN

status required ACTIVE SUSPENDED

developer required

boolean

Whether this person can reach API keys and webhooks: always for an owner, and for an admin only with the grant. False unless the caller has members.manage.

managerId required

string,null

The manager's user id.

managerName required string,null

title required string,null

department required string,null

employeeId required

string,null

Null unless the caller has members.manage.

approvalLimitMinor required

number,null

Null unless the caller has members.manage.

overLimitApproverId required

string,null

Null unless the caller has members.manage.

forwardToId required

string,null

Null unless the caller has members.manage.

workerStatus required

string,null

Null unless the caller has members.manage.

defaultTags required

array of string

Empty unless the caller has members.manage.

customField1 required string,null

customField2 required string,null

payrollCode required

string,null

Goes out with payroll files. Null unless the caller manages members.

legalEntity required

string,null

The company the person is employed by. Null unless the caller manages members.

tier required

string,null

Their travel tier. Null unless the caller manages members.

officeLocation required

string,null

The office they work from. Null unless the caller manages members.

costCenter required

string,null

Where their costs are charged. Null unless the caller manages members.

accountingCode required

string,null

Their code in the books. Null unless the caller manages members.

workerType required

string,null

Employee, contractor or the like. Null unless the caller manages members.

createdAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

PaymentAccount

id required string

name required string

kind required CREDIT_CARD DEBIT_CARD BANK_ACCOUNT CASH

brand required string,null

last4 required string,null

isCompany required boolean

feedSource required MANUAL FILE_IMPORT PLAID

owner required

object or null

Fields

`id` required	string
`name` required	string,null
`email` required	string

institutionName required string,null

archived required boolean

transactionCount required number

unmatchedCount required number

lastPostedDate required string,null

lastImportedAt required

string,null

When a line last arrived, from a file or the bank.

transactionStartDate required string,null

statementCloseDay required number,null

liability required PERSONAL CORPORATE

reimbursable required boolean,null

allowDeletingTransactions required boolean

glAccount required string,null

createExpenses required boolean

assigneeEmail required

string,null

Invited and not yet in: the card is theirs when they join.

balance required

object or null

What the bank last reported, when it reports these at all.

Fields

`currentMinor` required	number,null
`limitMinor` required	number,null
`remainingMinor` required	number,null
`currency` required	string
`asOf` required	string

createdAt required string

PaymentAccountPage

data required

array of object

Fields

id required string

name required string

kind required CREDIT_CARD DEBIT_CARD BANK_ACCOUNT CASH

brand required string,null

last4 required string,null

isCompany required boolean

feedSource required MANUAL FILE_IMPORT PLAID

owner required

object or null

Fields

`id` required	string
`name` required	string,null
`email` required	string

institutionName required string,null

archived required boolean

transactionCount required number

unmatchedCount required number

lastPostedDate required string,null

lastImportedAt required

string,null

When a line last arrived, from a file or the bank.

transactionStartDate required string,null

statementCloseDay required number,null

liability required PERSONAL CORPORATE

reimbursable required boolean,null

allowDeletingTransactions required boolean

glAccount required string,null

createExpenses required boolean

assigneeEmail required

string,null

Invited and not yet in: the card is theirs when they join.

balance required

object or null

What the bank last reported, when it reports these at all.

Fields

`currentMinor` required	number,null
`limitMinor` required	number,null
`remainingMinor` required	number,null
`currency` required	string
`asOf` required	string

createdAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Reconciliation

from required string

to required string

currency required

string

What every figure here is in. Ask for another with currency.

currencies required

array of object

Every currency posted in these dates, each with its own count and net.

Fields

`currency` required	string
`count` required	number
`netMinor` required	number

importedMinor required

number

What to hold against the card statement.

importedCount required number

approvedMinor required

number

What to hold against the liability account.

approvedCount required number

unapprovedMinor required

number

What is left to accrue at month end, by where it is stuck.

unapprovedCount required number

pendingMinor required

number

Charges the bank has not posted, which are on no statement yet.

buckets required

object

Fields

unreported required

object

Fields

count required number

amountMinor required number

rows required

array of object

Fields

`transactionId` required	string
`postedDate` required	string
`description` required	string
`amountMinor` required	number
`currency` required	string
`account` required	object
`expense` required	object or null
`ownerId` required	string,null

draft required

object

Fields

count required number

amountMinor required number

rows required

array of object

Fields

`transactionId` required	string
`postedDate` required	string
`description` required	string
`amountMinor` required	number
`currency` required	string
`account` required	object
`expense` required	object or null
`ownerId` required	string,null

outstanding required

object

Fields

count required number

amountMinor required number

rows required

array of object

Fields

`transactionId` required	string
`postedDate` required	string
`description` required	string
`amountMinor` required	number
`currency` required	string
`account` required	object
`expense` required	object or null
`ownerId` required	string,null

deleted required

object

Fields

count required number

amountMinor required number

rows required

array of object

Fields

`transactionId` required	string
`postedDate` required	string
`description` required	string
`amountMinor` required	number
`currency` required	string
`account` required	object
`expense` required	object or null
`ownerId` required	string,null

noExpense required

object

Fields

count required number

amountMinor required number

rows required

array of object

Fields

`transactionId` required	string
`postedDate` required	string
`description` required	string
`amountMinor` required	number
`currency` required	string
`account` required	object
`expense` required	object or null
`ownerId` required	string,null

ignored required

object

Fields

count required number

amountMinor required number

rows required

array of object

Fields

`transactionId` required	string
`postedDate` required	string
`description` required	string
`amountMinor` required	number
`currency` required	string
`account` required	object
`expense` required	object or null
`ownerId` required	string,null

cards required

array of object

Fields

account required

object

Fields

`id` required	string
`name` required	string
`last4` required	string,null

count required number

importedMinor required number

unapprovedMinor required number

duplicates required

array of object

Fields

`postedDate` required	string
`amountMinor` required	number
`description` required	string
`count` required	number

ReportField

`id` required	string
`name` required	string
`type` required	`TEXT` `DATE` `LIST` `FORMULA`
`options` required	array of string
`formula` required	string,null
`required` required	boolean
`enabled` required	boolean
`position` required	number
`disabledOptions`	array of string List values turned off: kept on reports that hold them, and not offered for new ones.
`imported`	boolean Came from the connected books, so it cannot be deleted and its values only turn on and off.

ReportFieldList

data required

array of object

Fields

`id` required	string
`name` required	string
`type` required	`TEXT` `DATE` `LIST` `FORMULA`
`options` required	array of string
`formula` required	string,null
`required` required	boolean
`enabled` required	boolean
`position` required	number
`disabledOptions`	array of string List values turned off: kept on reports that hold them, and not offered for new ones.
`imported`	boolean Came from the connected books, so it cannot be deleted and its values only turn on and off.

ReportFieldsOff

`deleted` required	number Fields removed. Lists take work to build, so they are kept.
`disabled` required	number Lists turned off and kept.

SeatUsage

active required number

invited required

number

Open invitations hold a seat until they are accepted, revoked or expire.

included required number,null

paid required

number,null

Seats the workspace holds, which is what stops an invitation. Null with no plan.

max required

number,null

The most seats this plan can hold. Null is unlimited.

full required

object or null

Set once every seat is taken or invited, with what to do about it.

Fields

metric required seats

limit required number

used required number

addSeats required

object or null

Fields

`seats` required	number
`added` required	number
`priceMinor` required	number
`interval` required	`MONTH` `YEAR`

askName required string,null

appMessage required

string

The refusal with no price and no way to buy in it, which an app in a store can show as written.

message required string

SyncRecordPage

data required

array of object

Fields

`id` required	string
`expenseId` required	string
`reference` required	string
`merchantName` required	string,null
`date` required	string
`amountMinor` required	number
`currency` required	string
`state` required	`PENDING` `SYNCED` `FAILED` `SKIPPED` `VOIDED`
`externalType` required	string,null
`externalId` required	string,null The record in the other system.
`errorCode` required	string,null
`message` required	string,null
`attempts` required	number
`syncedAt` required	string,null
`nextAttemptAt` required	string,null
`paidAt`	string,null
`paidBy`	`PROVIDER` `PAPERTOTAL` or null
`paymentError`	string,null
`resends`	number

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Transaction

id required string

paymentAccount required

object

Fields

`id` required	string
`name` required	string
`last4` required	string,null

postedDate required string

amountMinor required

number

Positive is money spent. Negative is a refund or a payment to the card.

currency required string

description required string

merchantName required string,null

state required UNMATCHED MATCHED IGNORED EXPENSED PENDING

matchScore required number,null

missingReceipt required

boolean

Older than three days with no expense: a receipt is owed.

expense required

object or null

Fields

`id` required	string
`reference` required	string
`merchantName` required	string,null
`date` required	string
`amountMinor` required	number
`currency` required	string
`status` required	string

suggestions required

array of object

Fields

expense required

object

Fields

`id` required	string
`reference` required	string
`merchantName` required	string,null
`date` required	string
`amountMinor` required	number
`currency` required	string
`status` required	string

score required number

amountGapMinor required number

dayGap required number

TransactionPage

data required

array of object

Fields

id required string

paymentAccount required

object

Fields

`id` required	string
`name` required	string
`last4` required	string,null

postedDate required string

amountMinor required

number

Positive is money spent. Negative is a refund or a payment to the card.

currency required string

description required string

merchantName required string,null

state required UNMATCHED MATCHED IGNORED EXPENSED PENDING

matchScore required number,null

missingReceipt required

boolean

Older than three days with no expense: a receipt is owed.

expense required

object or null

Fields

`id` required	string
`reference` required	string
`merchantName` required	string,null
`date` required	string
`amountMinor` required	number
`currency` required	string
`status` required	string

suggestions required

array of object

Fields

expense required

object

Fields

`id` required	string
`reference` required	string
`merchantName` required	string,null
`date` required	string
`amountMinor` required	number
`currency` required	string
`status` required	string

score required number

amountGapMinor required number

dayGap required number

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

TransactionSummary

currency required

string

What every figure here is in: the one asked for with currency, or the workspace currency when it has lines, or the commonest.

currencies required

array of object

Every currency these lines are in, each with its own count and net.

Fields

`currency` required	string
`count` required	number
`netMinor` required	number

count required number

spentMinor required number

creditedMinor required number

missingReceipts required number

byState required

array of object

Fields

`state` required	`UNMATCHED` `MATCHED` `IGNORED` `EXPENSED` `PENDING`
`count` required	number
`amountMinor` required	number

Workspace

id required string

name required string

kind required PERSONAL TEAM

baseCurrency required string

role required OWNER ADMIN APPROVER ACCOUNTANT AUDITOR MEMBER EDITOR CARD_ADMIN PEOPLE_ADMIN PAYMENTS_ADMIN

country required string

timezone required string

fiscalYearStartMonth required number

distanceUnit required string

claimedDomain required string,null

requireMfa required boolean

retentionDays required

number,null

Documents are deleted this many days after they are read. Null keeps them until someone deletes them.

callLogRetentionDays required

number,null

Days the API call log is kept. Null is the default of 365.

preferences required

object

Fields

`locale` required	string,null How this workspace's findings write money. Null is the person's own.
`showDefaultCategories` required	boolean False takes the built-in categories out of everyone's list but a manager's, and out of what reading a document suggests.
`shredDocuments` required	boolean Paper from a mail-in batch is shredded after scanning, unless the batch says otherwise.
`reimbursableTracking` required	boolean False takes reimbursing out of the workspace: nothing new is flagged.
`calculateMissingTax` required	boolean Works out a missing tax on a captured document at vatBasisPoints, and says so on the expense.
`dateFormat` required	`YYYY-MM-DD` `MM/DD/YYYY` `DD/MM/YYYY` `DD.MM.YYYY` `MMM D, YYYY` How dates read across the app. The API always sends YYYY-MM-DD.
`vatBasisPoints` required	number,null VAT within the total on a typed expense that gives no tax, in hundredths of a percent. 2000 is 20%.

permissions required

array of expenses.read_all expenses.write_all reports.read_all reports.approve reimbursements.manage members.manage settings.manage policies.manage billing.manage integrations.manage exports.all developer.manage audit.read documents.reveal cards.manage security.manage workspace.delete

What this caller may do here, from the role of the person the key belongs to.

entitlement required

object

Fields

plan required STARTER PRO BUSINESS or null

lastPlan

STARTER PRO BUSINESS or null

With no plan in force, the one the workspace held last. What it could read stays readable.

status required TRIALING ACTIVE PAST_DUE EXPIRED NONE

source required STRIPE APP_STORE PLAY_STORE TRIAL COMP or null

active required

boolean

Capture and edits stop when this is false. Reading and exporting never do.

trialEndsAt required string,null

currentPeriodEnd required string,null

cancelAtPeriodEnd required boolean

interval required MONTH YEAR or null

seats required number

features required array of receipt_capture email_capture mileage expense_reports tax_reports standard_exports multi_currency business_cards mail_in automation_rules card_feeds accounting_sync approvals policies reimbursements custom_fields per_diem human_verification developer_api multi_level_approvals sso audit_log scheduled_reports

limits required

object or null

Fields

`scansPerMonth` required	number
`seatsIncluded` required	number
`maxSeats` required	number,null
`apiDocumentsPerMonth` required	number
`mailInDocumentsPerMonth` required	number

services required

object

Fields

`mailIn` required	boolean
`humanVerification` required	boolean

usage required map of number

memberCount required number

sandboxOfId required

string,null

The workspace this is the sandbox of. Null for a live workspace.

readingModel required

standard rules_only always_second_reading

What reads this workspace's documents.

actingFor

object or null

Fields

`userId` required	string
`name` required	string
`access` required	`FULL` `LIMITED`

WorkspaceCounts

`needsReview` required	number
`processing` required	number
`pendingApprovals` required	number
`holdsApprovals` required	boolean
`unmatchedTransactions` required	number
`unreadNotifications` required	number

WorkspaceCreated

id required string

name required string

kind required PERSONAL TEAM

baseCurrency required string

role required OWNER ADMIN APPROVER ACCOUNTANT AUDITOR MEMBER EDITOR CARD_ADMIN PEOPLE_ADMIN PAYMENTS_ADMIN

entitlement required

object

Fields

`plan` required	`STARTER` `PRO` `BUSINESS` or null What the workspace holds now: what the trial of its owner has left, or nothing. Naming a plan does not buy it.
`status` required	`TRIALING` `ACTIVE` `PAST_DUE` `EXPIRED` `NONE`
`active` required	boolean
`trialEndsAt` required	string,null

checkout required

object or null

Set when a plan was named.

Fields

`plan` required	`STARTER` `PRO` `BUSINESS`
`interval` required	`MONTH` `YEAR`
`url` required	string The billing page, for a person to pay for the plan. A plan cannot be bought by an API call.

WorkspacePage

data required

array of object

Fields

`id` required	string
`name` required	string
`kind` required	`PERSONAL` `TEAM`
`baseCurrency` required	string
`role` required	`OWNER` `ADMIN` `APPROVER` `ACCOUNTANT` `AUDITOR` `MEMBER` `EDITOR` `CARD_ADMIN` `PEOPLE_ADMIN` `PAYMENTS_ADMIN`

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Me

id required string

email required string

emailVerified required boolean

displayName required string,null

photoUrl required string,null

phone required string,null

language required

en es fr de el it ja nl pl pt-BR zh-Hans

The language the interface is written in. locale only sets how figures print.

highContrast required boolean

pronouns required string,null

personStatus required

object or null

A note beside their name, until it clears.

Fields

`text` required	string
`clearsAt` required	string,null

hasPrivateDetails required

boolean

Whether anything is kept under the emailed code. The details never come back from here.

locale required string

timezone required string

distanceUnit required string

onboarded required boolean

onboardingIntent required

string,null

What they said they came for on first run.

emailBounced required

boolean

Their address bounced, so mail to it stopped until they fix it.

phoneVerified required

boolean

Firebase proved the number with a code.

hasEmail required

boolean

False for someone who came in with a phone number and has not added an address yet. email then holds an address nothing can be sent to.

locked required

boolean

Locked after a report of suspicious activity. Only support can undo it.

canChangeEmail required

boolean

A domain group can keep the sign-in address where the company put it.

canManageWorkspaces required

boolean

A domain group can stop someone creating or closing workspaces.

defaultWorkspaceId required string,null

forwardingAddress required string

workspaces required

array of object

Fields

`id` required	string
`name` required	string
`kind` required	`PERSONAL` `TEAM`
`baseCurrency` required	string
`role` required	`OWNER` `ADMIN` `APPROVER` `ACCOUNTANT` `AUDITOR` `MEMBER` `EDITOR` `CARD_ADMIN` `PEOPLE_ADMIN` `PAYMENTS_ADMIN`

ForwardingAlias

`alias` required	string
`address` required	string

Blueprint

id required string

name required

string

What blueprint_name takes.

title required string

description required string,null

documentType required RECEIPT INVOICE BILL BANK_STATEMENT CHECK TAX_FORM BUSINESS_CARD OTHER UNKNOWN PURCHASE_ORDER CONTRACT PACKING_SLIP REMITTANCE_ADVICE CREDIT_NOTE STATEMENT

builtIn required

boolean

Ships with PaperTotal, and can be used and not changed.

version required

number

Changing a blueprint adds a version, and results keep the one that made them.

schema required

object

Fields

`type` required	`object`
`description`	string
`properties` required	__schema0

fields required

array of object

Fields

path required string

label string

example string

box

object

Fields

`page` required	integer
`x` required	number
`y` required	number
`width` required	number
`height` required	number

createdAt required string,null

updatedAt required string,null

BlueprintList

data required

array of object

Fields

`id` required	string
`name` required	string What blueprint_name takes.
`title` required	string
`documentType` required	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`builtIn` required	boolean Ships with PaperTotal, and can be used and not changed.
`version` required	number Changing a blueprint adds a version, and results keep the one that made them.

nextCursor required null

BlueprintDraft

documentId required string

status required READING READY FAILED

draft required

object or null

A starting point. Nothing is saved until it is sent to POST /v1/blueprints.

Fields

name required string

title required string

schema required

object

Fields

`type` required	`object`
`description`	string
`properties` required	__schema0

fields required

array of object

Fields

path required string

label string

example string

box

object

Fields

`page` required	integer
`x` required	number
`y` required	number
`width` required	number
`height` required	number

engine required rules claude

error required string,null

Classification

id required string

status required UPLOADED PROCESSING PROCESSED FAILED

document_type required

object or null

Null until it has been read.

Fields

`value` required	string
`score` required	number

engine required rules claude or null

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

Extraction

id required string

status required UPLOADED PROCESSING PROCESSED FAILED

document_type required

object or null

Null until it has been read.

Fields

`value` required	string
`score` required	number

engine required rules claude or null

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

extraction required map of any or null

extraction_error required string,null

document required

object

Fields

id required string

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

status required UPLOADED PROCESSING PROCESSED FAILED

originalFilename required string,null

mimeType required string

sizeBytes required number

pageCount required number

externalId required string,null

folderId required string,null

expenseId required string,null

mailInBatchId required string,null

title required string,null

notes required string,null

latitude required

number,null

Where the device said it was when the photo was taken.

longitude required number,null

locationAccuracyM required number,null

duplicateOfId required string,null

processingError required string,null

processingErrorCode required

FILE_ENCRYPTED or null

Set when the failure is one the file's owner can fix. processingError says what to do.

verification required string

capturedAt required string,null

processedAt required string,null

viewedAt required string,null

archivedAt required string,null

createdAt required string

uploadedBy required

object or null

Fields

`id` required	string
`name` required	string,null

pages required

array of object

Fields

index required number

url required string,null

thumbnailUrl required string,null

width required number,null

height required number,null

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Blank for a caller without expenses.read_all.

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Null when the page is not one, and for a caller without expenses.read_all.

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Blank for a caller without expenses.read_all. Value null means nothing could say.

Fields

`value` required	boolean,null
`score` required	number,null

language required string,null

languages required

array of object

Fields

`tag` required	string
`score` required	number

ocrScore required number,null

isFront required

boolean,null

A check: the front or the back.

tiffRejectScore required

number,null

A check: 0 is a clean clearing image and 1 is one a bank would send back.

tiffUpscaled required

boolean,null

A check: the photo was under 240 DPI, so the clearing image was enlarged.

classification required

object or null

What the classifier decided, when it was asked.

Fields

value required

string

A document class, or one of the labels the caller named.

score required

number

0..1.

engine required rules claude

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

blueprint required

object or null

The blueprint this was read with, and what came out of it.

Fields

`name` required	string
`version` required	number,null Null for a built-in, which has no versions.
`result` required	map of any or null The fields the blueprint defines. Null when the run failed.
`offsets`	map of object Where each value sits in the text, for a blueprint that asks.
`unmatched`	array of string Fields where a value was read and did not fit, such as words where a number belongs or a choice off the list. Each is left empty. An empty field not named here was not on the document.
`error` required	string,null Why the run gave nothing back.

tags required array of string

tagRefs required

array of object

The same tags with their ids, which a tag route takes.

Fields

`id` required	string
`name` required	string

recordStatus required

processed reviewed archived or null

Where a read document stands: reviewedAt and archivedAt in one word. Null until it has been read.

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

setId required

string,null

The upload this came out of: a ZIP, a split PDF or a batch of addresses.

customFields required

map of string or array of string or null

Values the workspace custom field rules read out of the text.

enrichment required

object or null

Work still running after the first answer.

Fields

`status` required	`PENDING` `DONE` `FAILED`
`steps` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`failed` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`

extraction required

object or null

Fields

fields required

object

What was read, as the extraction contract types it. fieldConfidence holds per-field confidence, 0..1.

Fields

`documentType`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`merchantName`	string,null
`merchantAddress`	string,null
`merchantPhone`	string,null
`merchantWebsite`	string,null
`merchantTaxId`	string,null
`date`	string or null
`time`	string,null
`dueDate`	string or null
`currency`	`AED` `AFN` `ALL` `AMD` `ANG` `AOA` `ARS` `AUD` `AWG` `AZN` `BAM` `BBD` `BDT` `BGN` `BHD` `BIF` `BMD` `BND` `BOB` `BRL` `BSD` `BTN` `BWP` `BYN` `BZD` `CAD` `CDF` `CHF` `CLP` `CNY` `COP` `CRC` `CUP` `CVE` `CZK` `DJF` `DKK` `DOP` `DZD` `EGP` `ERN` `ETB` `EUR` `FJD` `FKP` `GBP` `GEL` `GHS` `GIP` `GMD` `GNF` `GTQ` `GYD` `HKD` `HNL` `HTG` `HUF` `IDR` `ILS` `INR` `IQD` `IRR` `ISK` `JMD` `JOD` `JPY` `KES` `KGS` `KHR` `KMF` `KPW` `KRW` `KWD` `KYD` `KZT` `LAK` `LBP` `LKR` `LRD` `LSL` `LYD` `MAD` `MDL` `MGA` `MKD` `MMK` `MNT` `MOP` `MRU` `MUR` `MVR` `MWK` `MXN` `MYR` `MZN` `NAD` `NGN` `NIO` `NOK` `NPR` `NZD` `OMR` `PAB` `PEN` `PGK` `PHP` `PKR` `PLN` `PYG` `QAR` `RON` `RSD` `RUB` `RWF` `SAR` `SBD` `SCR` `SDG` `SEK` `SGD` `SHP` `SLE` `SOS` `SRD` `SSP` `STN` `SVC` `SYP` `SZL` `THB` `TJS` `TMT` `TND` `TOP` `TRY` `TTD` `TWD` `TZS` `UAH` `UGX` `USD` `UYU` `UZS` `VES` `VND` `VUV` `WST` `XAF` `XCD` `XCG` `XOF` `XPF` `YER` `ZAR` `ZMW` `ZWG` `CUC` `HRK` `SLL` `ZWL` `XDR` `XSU` or null
`currencyGuessed`	boolean
`totalMinor`	integer or null
`subtotalMinor`	integer or null
`taxMinor`	integer or null
`taxLines`	array of object
`tipMinor`	integer or null
`discountMinor`	integer or null
`shippingMinor`	integer or null
`paymentType`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER` or null
`cardBrand`	string,null
`cardLast4`	string,null
`receiptNumber`	string,null
`invoiceNumber`	string,null
`poNumber`	string,null
`lineItems`	array of object
`suggestedCategory`	string,null
`documentTitle`	string,null
`documentReferenceNumber`	string,null
`isDocument`	boolean,null
`isTransaction`	boolean,null
`isMoneyIn`	boolean,null
`accountingEntryType`	`debit` `credit` or null
`vendor`	object or null
`vendors`	array of object or null
`bankBreakdown`	array of object or null
`billTo`	object or null
`shipTo`	object or null
`insuranceMinor`	integer or null
`cashbackMinor`	integer or null
`roundingMinor`	integer or null
`balanceMinor`	integer or null
`finalBalanceMinor`	integer or null
`previousBalanceMinor`	integer or null
`totalQuantity`	number,null
`totalWeight`	string,null
`payment`	object or null
`orderDate`	string or null
`shipDate`	string or null
`deliveryDate`	string or null
`serviceStartDate`	string or null
`serviceEndDate`	string or null
`exchangeRate`	number,null
`countryCode`	string,null
`deliveryNoteNumber`	string,null
`trackingNumber`	string,null
`trackingNumbers`	array of string or null
`incoterms`	string,null
`weights`	array of string or null
`licensePlateNumber`	string,null
`vinNumber`	string,null
`guestCount`	integer or null
`serverName`	string,null
`storeNumber`	string,null
`vendingPerson`	string,null
`vendingPersonNumber`	string,null
`customerAccountNumber`	string,null
`category`	string,null
`defaultCategory`	string,null
`barcodes`	array of object or null
`paymentLinks`	array of object or null
`folio`	object or null
`enrichedFields`	array of string or null
`check`	object or null
`statement`	object or null
`taxForm`	object or null
`itinerary`	object or null
`fieldConfidence`	map of number
`fieldBoxes`	map of object

confidence required number,null

flags required array of string

warnings required

array of object

Integrity findings. A caller without expenses.read_all sees the arithmetic and dates only.

Fields

`code` required	`tax_rate_mismatch` `item_counts_mismatch` `totals_mismatch` `line_item_amount_mismatch` `line_item_repeats` `barcode_decoding_issue` `barcode_code_missing_in_ocr` `logo_vendor_mismatch` `malware` `weekend_transaction` `time_and_currency_mismatch` `exif_creation_modified_date_mismatch` `missing_date` `suspicious_document_aspect_ratio` `generic_placeholder_content`
`message` required	string
`page`	number,null

fraud required

object or null

Fields

version required string

score required

number

0 to 1, from the signals that fired. Evidence, never a verdict.

color required

green yellow red

Under the workspace yellow threshold is green. Over its red threshold is red.

types required

Signals that fired, most important first.

details required

map of object

By signal: a description, a confidence and typed reasons.

attribution required

string,null

One sentence naming the strongest evidence.

decision required

clear review fraud not_fraud unknown

clear or review until a person decides. Only a person can say fraud.

review required

object or null

Fields

`decision` required	`FRAUD` `NOT_FRAUD` `UNKNOWN`
`types` required	array of `digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`note` required	string,null
`reviewedBy` required	object or null
`reviewedAt` required	string

deviceId required

string,null

The id the client sent for its device, when it sent one.

submissions required

object or null

Documents from this uploader in this workspace, by window.

Fields

`lastMinutes` required	number
`lastDay` required	number
`lastWeek` required	number
`last2Weeks` required	number
`lastMonth` required	number

deviceProfiles required

array of object

Over 30 days, inside this workspace only.

Fields

`deviceId` required	string
`profileId` required	string
`documentCount` required	number

digitalTamperingFields required array of string

handwriting required

object

What Claude saw written by hand, in dot notation, when a key is set and the handwriting signal is on. With no key, the lists are empty and the flags null: skipped says why.

Fields

`handwrittenFields` required	array of string
`fullyHandwrittenFields` required	array of string
`handwrittenTamperedFields` required	array of string
`handwritingDetected` required	boolean,null
`handwritingTamperingPresent` required	boolean,null

notADocument required

object

Fields

`value` required	boolean,null
`score` required	number,null

digitalBackground required

object

Fields

`value` required	boolean,null
`score` required	number,null

fraudulentPdf required

object or null

Fields

`fraudulentPdfCreator` required	number,null
`textOverlay` required	number,null
`fontMismatch` required	number,null
`hasDigitalSignature` required	boolean,null
`pdfModified` required	number,null
`incrementalUpdates` required	number,null
`incrementalChanges` required	array of string
`incrementalEdits` required	array of object
`signatureCreationTools` required	array of string
`dateInversion` required	number,null
`producerContentMismatch` required	number,null
`writerMismatch` required	number,null
`nullMetadata` required	number,null
`xmpInfoMismatch` required	number,null
`futureMetadataDate` required	number,null
`rasterProfileMismatch` required	number,null
`uncompressedRaster` required	number,null
`splicedPage` required	number,null
`splicedPageNumber` required	number,null
`valueFontSplice` required	number,null
`valueFontSplicePage` required	number,null
`headlessDesktopRender` required	number,null
`headlessRenderPlatform` required	string,null
`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`score` required	number,null

fraudulentImage required

object or null

Fields

`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`editorSignature` required	number,null
`editorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`editorSignatureValue` required	string,null
`generatorSignature` required	number,null
`generatorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`generatorSignatureValue` required	string,null
`generatorWriterProfile` required	number,null
`generatorWriterProfileValue` required	string,null
`syntheticRaster` required	number,null
`syntheticRasterFingerprints` required	array of string
`unprofiledPng` required	number,null
`unprofiledWebp` required	number,null
`source` required	`original` `render` or null
`sourceFormats` required	array of string
`unreadableSource` required	number,null
`score` required	number,null

pages required

array of object

Fields

`index` required	number
`isBlurry` required	object
`isLcd` required	object
`screenshot` required	object or null
`aiGenerated` required	object Value null means nothing could say: no pixel model runs, only metadata can answer.
`glare` required	object

skipped required

array of object

Checks that could not run on this file, so a clean result is not read as more than it is.

Fields

`check` required	string
`reason` required	string

sealed required

array of object

Bank and tax numbers read from this document, as masks. POST /v1/documents/{id}/reveal opens them.

Fields

`kind` required	`ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`masked` required	string All but the last few characters are stars. Punctuation stays where it was.
`field` required	string,null
`page` required	number

updatedAt required string

extractor required

string,null

What read it: rules, claude, a blueprint, business-card, or none.

ocrText required

string,null

Everything read off the page. Card, bank and tax numbers are masked.

pdfUrl required

string,null

The PDF as uploaded, signed for 15 minutes. Null for an image, and for a PDF that prints a number only a reveal hands out.

meta required

object

Fields

totalPages required number

processedPages required number

ocrScore required

number,null

The average character confidence of the reading, which doubles as a measure of the image.

originalFileName required string,null

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

language required

string,null

BCP-47.

languages required

array of object

Every language found, best first.

Fields

`tag` required	string
`score` required	number

deviceId required string,null

deviceUserUuid required

string,null

The signed-in person the device was capturing for. Null when no device was named.

latitude required number,null

longitude required number,null

sourceDocuments required

array of map of any

Each file as submitted: name, type, size in KB, width, height and EXIF.

owner required

object or null

Who uploaded it.

Fields

`id` required	string
`name` required	string,null

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

reviewedAt required

string,null

A person checked what was read.

approvedAt required

string,null

A developer's own approved flag. An expense's approval is a different thing.

DocumentSet

id required string

kind required ZIP BATCH SPLIT DOCUMENTS W2 BANK_STATEMENT PARSE

status required QUEUED PROCESSING COMPLETED FAILED

originalFilename required string,null

pageCount required number

ranges required

array of object

Pages found, 1-based and inclusive, with a type and score when classified.

Fields

`start` required	number
`end` required	number
`type`	string
`score`	number

refused required

array of object

Fields

`name` required	string
`reason` required	string

error required string,null

documents required

array of object

Fields

`id` required	string
`type` required	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`status` required	`UPLOADED` `PROCESSING` `PROCESSED` `FAILED`
`pageStart` required	number,null
`pageEnd` required	number,null

createdAt required string

completedAt required string,null

DocumentSetPage

data required

array of object

Fields

id required string

kind required ZIP BATCH SPLIT DOCUMENTS W2 BANK_STATEMENT PARSE

status required QUEUED PROCESSING COMPLETED FAILED

originalFilename required string,null

pageCount required number

ranges required

array of object

Pages found, 1-based and inclusive, with a type and score when classified.

Fields

`start` required	number
`end` required	number
`type`	string
`score`	number

refused required

array of object

Fields

`name` required	string
`reason` required	string

error required string,null

documents required

array of object

Fields

`id` required	string
`type` required	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`status` required	`UPLOADED` `PROCESSING` `PROCESSED` `FAILED`
`pageStart` required	number,null
`pageEnd` required	number,null

createdAt required string

completedAt required string,null

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ParsedDocument

id required string

status required UPLOADED PROCESSING PROCESSED FAILED

markdown required string,null

meta required

object or null

Fields

pages required

array of object

Fields

`index` required	number
`width` required	number
`height` required	number
`blurScore` required	number,null Sharpness of a photographed page. Higher is sharper.
`ocrScore` required	number,null

ocrScore required number,null

engine required rules claude

tags required array of string

title required string,null

notes required string,null

externalId required string,null

setId required string,null

createdAt required string

boxes

array of object

With details: every recognized line and where it sits.

Fields

`text` required	string
`confidence` required	number
`page` required	number
`box` required	tuple or null

ParsedDocumentPage

data required

array of object

Fields

id required string

status required UPLOADED PROCESSING PROCESSED FAILED

markdown required string,null

meta required

object or null

Fields

pages required

array of object

Fields

`index` required	number
`width` required	number
`height` required	number
`blurScore` required	number,null Sharpness of a photographed page. Higher is sharper.
`ocrScore` required	number,null

ocrScore required number,null

engine required rules claude

tags required array of string

title required string,null

notes required string,null

externalId required string,null

setId required string,null

createdAt required string

boxes

array of object

With details: every recognized line and where it sits.

Fields

`text` required	string
`confidence` required	number
`page` required	number
`box` required	tuple or null

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

DocumentUpload

id required string

type RECEIPT INVOICE BILL BANK_STATEMENT CHECK TAX_FORM BUSINESS_CARD OTHER UNKNOWN PURCHASE_ORDER CONTRACT PACKING_SLIP REMITTANCE_ADVICE CREDIT_NOTE STATEMENT

source WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

status required string

originalFilename string,null

mimeType string

sizeBytes number

pageCount number

externalId string,null

folderId string,null

expenseId string,null

mailInBatchId string,null

title string,null

notes string,null

latitude

number,null

Where the device said it was when the photo was taken.

longitude number,null

locationAccuracyM number,null

duplicateOfId string,null

processingError string,null

processingErrorCode

FILE_ENCRYPTED or null

Set when the failure is one the file's owner can fix. processingError says what to do.

verification string

capturedAt string,null

processedAt string,null

viewedAt string,null

archivedAt string,null

createdAt string

uploadedBy

object or null

Fields

`id` required	string
`name` required	string,null

pages

array of object

Fields

index required number

url required string,null

thumbnailUrl required string,null

width required number,null

height required number,null

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Blank for a caller without expenses.read_all.

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Null when the page is not one, and for a caller without expenses.read_all.

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Blank for a caller without expenses.read_all. Value null means nothing could say.

Fields

`value` required	boolean,null
`score` required	number,null

language required string,null

languages required

array of object

Fields

`tag` required	string
`score` required	number

ocrScore required number,null

isFront required

boolean,null

A check: the front or the back.

tiffRejectScore required

number,null

A check: 0 is a clean clearing image and 1 is one a bank would send back.

tiffUpscaled required

boolean,null

A check: the photo was under 240 DPI, so the clearing image was enlarged.

classification

object or null

What the classifier decided, when it was asked.

Fields

value required

string

A document class, or one of the labels the caller named.

score required

number

0..1.

engine required rules claude

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

blueprint

object or null

The blueprint this was read with, and what came out of it.

Fields

`name` required	string
`version` required	number,null Null for a built-in, which has no versions.
`result` required	map of any or null The fields the blueprint defines. Null when the run failed.
`offsets`	map of object Where each value sits in the text, for a blueprint that asks.
`unmatched`	array of string Fields where a value was read and did not fit, such as words where a number belongs or a choice off the list. Each is left empty. An empty field not named here was not on the document.
`error` required	string,null Why the run gave nothing back.

tags array of string

tagRefs

array of object

The same tags with their ids, which a tag route takes.

Fields

`id` required	string
`name` required	string

recordStatus

processed reviewed archived or null

Where a read document stands: reviewedAt and archivedAt in one word. Null until it has been read.

duplicates

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

setId

string,null

The upload this came out of: a ZIP, a split PDF or a batch of addresses.

customFields

map of string or array of string or null

Values the workspace custom field rules read out of the text.

enrichment

object or null

Work still running after the first answer.

Fields

`status` required	`PENDING` `DONE` `FAILED`
`steps` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`failed` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`

extraction

object or null

Fields

fields required

object

What was read, as the extraction contract types it. fieldConfidence holds per-field confidence, 0..1.

Fields

merchantName string,null

merchantAddress string,null

merchantPhone string,null

merchantWebsite string,null

merchantTaxId string,null

date string or null

time string,null

dueDate string or null

currencyGuessed boolean

totalMinor integer or null

subtotalMinor integer or null

taxMinor integer or null

taxLines

array of object

Fields

`name`	string,null
`ratePct`	number,null
`amountMinor` required	integer
`order`	integer or null
`baseMinor`	integer or null
`code`	string,null
`totalInclusive`	boolean,null

tipMinor integer or null

discountMinor integer or null

shippingMinor integer or null

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

cardBrand string,null

cardLast4 string,null

receiptNumber string,null

invoiceNumber string,null

poNumber string,null

lineItems

array of object

Fields

`description` required	string
`sku`	string,null
`quantity`	number,null
`unitPriceMinor`	integer or null
`amountMinor` required	integer
`taxMinor`	integer or null
`id`	string,null
`order`	integer or null
`text`	string,null
`type`	`room` `tax` `parking` `service` `fee` `delivery` `product` `food` `alcohol` `tobacco` `transportation` `fuel` `refund` `discount` `payment` `giftcard` `donation` `toll` `lottery` or null
`fullDescription`	string,null
`normalizedDescription`	string,null
`section`	string,null
`reference`	string,null
`upc`	string,null
`hsn`	string,null
`lot`	string,null
`tags`	array of string or null
`unitOfMeasure`	string,null
`discountMinor`	integer or null
`discountRatePct`	number,null
`discountPriceMinor`	integer or null
`taxRatePct`	number,null
`taxCode`	string,null
`subtotalMinor`	integer or null
`grossTotalMinor`	integer or null
`netTotalMinor`	integer or null
`date`	string or null
`startDate`	string or null
`endDate`	string or null
`category`	string,null
`customCategories`	array of string or null
`customFields`	map of any or null
`countryOfOrigin`	string,null
`manufacturer`	string,null
`weight`	string,null
`brand`	string,null
`hsaFsaEligible`	boolean,null
`productInfo`	object or null

suggestedCategory string,null

documentTitle string,null

documentReferenceNumber string,null

isDocument boolean,null

isTransaction boolean,null

isMoneyIn boolean,null

accountingEntryType debit credit or null

vendor

object or null

Fields

`name`	string,null
`rawName`	string,null
`type`	string,null
`logo`	string,null
`logoName`	string,null
`externalId`	string,null
`category`	string,null
`orderNumber`	string,null
`countryCode`	string,null
`address`	string,null
`rawAddress`	string,null
`parsedAddress`	object or null
`phoneNumber`	string,null
`faxNumber`	string,null
`email`	string,null
`web`	string,null
`lat`	number,null
`lng`	number,null
`mapUrl`	string,null
`vatNumber`	string,null
`isValidatedVatNumber`	boolean,null
`regNumber`	string,null
`abnNumber`	string,null
`isRegisteredForGst`	boolean,null
`bank`	object or null

vendors

array of object or null

Fields

`name`	string,null
`rawName`	string,null
`type`	string,null
`logo`	string,null
`logoName`	string,null
`externalId`	string,null
`category`	string,null
`orderNumber`	string,null
`countryCode`	string,null
`address`	string,null
`rawAddress`	string,null
`parsedAddress`	object or null
`phoneNumber`	string,null
`faxNumber`	string,null
`email`	string,null
`web`	string,null
`lat`	number,null
`lng`	number,null
`mapUrl`	string,null
`vatNumber`	string,null
`isValidatedVatNumber`	boolean,null
`regNumber`	string,null
`abnNumber`	string,null
`isRegisteredForGst`	boolean,null
`bank`	object or null

bankBreakdown

array of object or null

Fields

`accountName`	string,null
`accountNumber`	string,null
`accountCurrency`	string,null
`bankName`	string,null
`bankNames`	array of string or null
`bankAddress`	string,null
`bankAddresses`	array of string or null
`bankNumber`	string,null
`bankNumbers`	array of string or null
`bankSwift`	string,null
`iban`	string,null
`billerCode`	string,null

billTo

object or null

Fields

`name`	string,null
`address`	string,null
`parsedAddress`	object or null
`vatNumber`	string,null
`regNumber`	string,null
`phoneNumber`	string,null
`email`	string,null

shipTo

object or null

Fields

`name`	string,null
`address`	string,null
`parsedAddress`	object or null

insuranceMinor integer or null

cashbackMinor integer or null

roundingMinor integer or null

balanceMinor integer or null

finalBalanceMinor integer or null

previousBalanceMinor integer or null

totalQuantity number,null

totalWeight string,null

payment

object or null

Fields

`cardNumber`	string,null
`displayName`	string,null
`terms`	string,null
`type`	`none` `visa` `master_card` `cash` `american_express` `interac` `other` `maestro` `discover` `bancontact` `girocard` `applepay` `paypal` `bancomat` `giftcard` `card` `check` `bankaxept` `bank-to-bank_transfer_bacs` `octopus` `pix` `jcb` `waon` `mada` `wechat` `alipay` `unionpay` `googlepay` `rupay` `bpay` `shopeepay` `mir` `giropay` `food_stamp` `diners_club` `paypay` or null

orderDate string or null

shipDate string or null

deliveryDate string or null

serviceStartDate string or null

serviceEndDate string or null

exchangeRate number,null

countryCode string,null

deliveryNoteNumber string,null

trackingNumber string,null

trackingNumbers array of string or null

incoterms string,null

weights array of string or null

licensePlateNumber string,null

vinNumber string,null

guestCount integer or null

serverName string,null

storeNumber string,null

vendingPerson string,null

vendingPersonNumber string,null

customerAccountNumber string,null

category string,null

defaultCategory string,null

barcodes

array of object or null

Fields

`data` required	string
`type` required	`QR_CODE` `PDF417` `EAN_13` `EAN_8` `UPC_A` `UPC_E` `CODE_128` `CODE_39` `ITF` `DATA_MATRIX` `AZTEC` `OTHER`
`page` required	integer
`boundingRegion`	array of number or null

paymentLinks

array of object or null

Fields

`url` required	string
`source` required	`text` `hyperlink` `qr_code` `barcode`

folio

object or null

Fields

`arrivalDate`	string or null
`departureDate`	string or null
`roomNumber`	string,null
`guestName`	string,null
`nights`	integer or null
`confirmationNumber`	string,null

enrichedFields array of string or null

check

object or null

Fields

`amountMinor`	integer or null
`amountText`	string,null
`amountsAgree`	boolean,null
`bankName`	string,null
`bankAddress`	string,null
`checkNumber`	string,null
`checkType`	`bank_draft` `bill_pay_draft` `business_check` `cashiers_check` `government_check` `money_order` `personal_check` `starter_check` `teller_check` or null
`currency`	string or null
`date`	string or null
`memo`	string,null
`payerName`	string,null
`payerAddress`	string,null
`receiverName`	string,null
`receiverAddress`	string,null
`isSigned`	boolean,null
`endorsement`	object or null
`micr`	object or null
`fractionalRoutingNumber`	string,null
`routingFromFractional`	string,null
`voidTerms`	string,null

statement

object or null

Fields

`accountHolderName`	string,null
`accountHolderAddress`	string,null
`accountType`	string,null
`accountNumber`	string,null
`bankName`	string,null
`bankAddress`	string,null
`bankWebsite`	string,null
`bankVatNumber`	string,null
`accountVatNumber`	string,null
`periodStartDate`	string or null
`periodEndDate`	string or null
`statementDate`	string or null
`statementNumber`	string,null
`currency`	string or null
`beginningBalanceMinor`	integer or null
`endingBalanceMinor`	integer or null
`minimumDueMinor`	integer or null
`dueDate`	string or null
`routingNumber`	string,null
`swift`	string,null
`iban`	string,null
`accounts`	array of object
`balancesAgree`	boolean,null

taxForm

object or null

Fields

`kind` required	`W2` `W9` `W8BEN_E`
`w2`	object or null
`w9`	object or null
`w8BenE`	map of string,boolean,null or null

itinerary

object or null

Fields

`travelerName`	string,null
`bookingReference`	string,null
`origin`	string,null
`destination`	string,null
`departsOn`	string or null
`returnsOn`	string or null
`segments`	array of object

fieldConfidence map of number

fieldBoxes map of object

confidence required number,null

flags required array of string

warnings required

array of object

Integrity findings. A caller without expenses.read_all sees the arithmetic and dates only.

Fields

`code` required	`tax_rate_mismatch` `item_counts_mismatch` `totals_mismatch` `line_item_amount_mismatch` `line_item_repeats` `barcode_decoding_issue` `barcode_code_missing_in_ocr` `logo_vendor_mismatch` `malware` `weekend_transaction` `time_and_currency_mismatch` `exif_creation_modified_date_mismatch` `missing_date` `suspicious_document_aspect_ratio` `generic_placeholder_content`
`message` required	string
`page`	number,null

fraud

object or null

Fields

version required string

score required

number

0 to 1, from the signals that fired. Evidence, never a verdict.

color required

green yellow red

Under the workspace yellow threshold is green. Over its red threshold is red.

types required

Signals that fired, most important first.

details required

map of object

By signal: a description, a confidence and typed reasons.

attribution required

string,null

One sentence naming the strongest evidence.

decision required

clear review fraud not_fraud unknown

clear or review until a person decides. Only a person can say fraud.

review required

object or null

Fields

decision required FRAUD NOT_FRAUD UNKNOWN

note required string,null

reviewedBy required

object or null

Fields

`id` required	string
`name` required	string,null

reviewedAt required string

deviceId required

string,null

The id the client sent for its device, when it sent one.

submissions required

object or null

Documents from this uploader in this workspace, by window.

Fields

`lastMinutes` required	number
`lastDay` required	number
`lastWeek` required	number
`last2Weeks` required	number
`lastMonth` required	number

deviceProfiles required

array of object

Over 30 days, inside this workspace only.

Fields

`deviceId` required	string
`profileId` required	string
`documentCount` required	number

digitalTamperingFields required array of string

handwriting required

object

What Claude saw written by hand, in dot notation, when a key is set and the handwriting signal is on. With no key, the lists are empty and the flags null: skipped says why.

Fields

`handwrittenFields` required	array of string
`fullyHandwrittenFields` required	array of string
`handwrittenTamperedFields` required	array of string
`handwritingDetected` required	boolean,null
`handwritingTamperingPresent` required	boolean,null

notADocument required

object

Fields

`value` required	boolean,null
`score` required	number,null

digitalBackground required

object

Fields

`value` required	boolean,null
`score` required	number,null

fraudulentPdf required

object or null

Fields

fraudulentPdfCreator required number,null

textOverlay required number,null

fontMismatch required number,null

hasDigitalSignature required boolean,null

pdfModified required number,null

incrementalUpdates required number,null

incrementalChanges required array of string

incrementalEdits required

array of object

Fields

`page` required	number
`before` required	string,null
`after` required	string,null

signatureCreationTools required array of string

dateInversion required number,null

producerContentMismatch required number,null

writerMismatch required number,null

nullMetadata required number,null

xmpInfoMismatch required number,null

futureMetadataDate required number,null

rasterProfileMismatch required number,null

uncompressedRaster required number,null

splicedPage required number,null

splicedPageNumber required number,null

valueFontSplice required number,null

valueFontSplicePage required number,null

headlessDesktopRender required number,null

headlessRenderPlatform required string,null

doubleJpeg required number,null

firstQuantizationQuality required number,null

scrubbedProvenance required number,null

score required number,null

fraudulentImage required

object or null

Fields

`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`editorSignature` required	number,null
`editorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`editorSignatureValue` required	string,null
`generatorSignature` required	number,null
`generatorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`generatorSignatureValue` required	string,null
`generatorWriterProfile` required	number,null
`generatorWriterProfileValue` required	string,null
`syntheticRaster` required	number,null
`syntheticRasterFingerprints` required	array of string
`unprofiledPng` required	number,null
`unprofiledWebp` required	number,null
`source` required	`original` `render` or null
`sourceFormats` required	array of string
`unreadableSource` required	number,null
`score` required	number,null

pages required

array of object

Fields

index required number

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Value null means nothing could say: no pixel model runs, only metadata can answer.

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

skipped required

array of object

Checks that could not run on this file, so a clean result is not read as more than it is.

Fields

`check` required	string
`reason` required	string

sealed

array of object

Bank and tax numbers read from this document, as masks. POST /v1/documents/{id}/reveal opens them.

Fields

`kind` required	`ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`masked` required	string All but the last few characters are stars. Punctuation stays where it was.
`field` required	string,null
`page` required	number

updatedAt string

extractor

string,null

What read it: rules, claude, a blueprint, business-card, or none.

ocrText

string,null

Everything read off the page. Card, bank and tax numbers are masked.

pdfUrl

string,null

The PDF as uploaded, signed for 15 minutes. Null for an image, and for a PDF that prints a number only a reveal hands out.

meta

object

Fields

totalPages required number

processedPages required number

ocrScore required

number,null

The average character confidence of the reading, which doubles as a measure of the image.

originalFileName required string,null

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

language required

string,null

BCP-47.

languages required

array of object

Every language found, best first.

Fields

`tag` required	string
`score` required	number

deviceId required string,null

deviceUserUuid required

string,null

The signed-in person the device was capturing for. Null when no device was named.

latitude required number,null

longitude required number,null

sourceDocuments required

array of map of any

Each file as submitted: name, type, size in KB, width, height and EXIF.

owner required

object or null

Who uploaded it.

Fields

`id` required	string
`name` required	string,null

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

reviewedAt

string,null

A person checked what was read.

approvedAt

string,null

A developer's own approved flag. An expense's approval is a different thing.

object

document_set

Set on the answer to a ZIP, which holds kind, documentIds and refused instead of a document.

kind string

documentIds array of string

refused

array of object

Fields

`name` required	string
`reason` required	string

InboundEmailPage

data required

array of object

Fields

id required string

from required string

subject required string,null

status required RECEIVED PROCESSED NO_ATTACHMENT UNKNOWN_SENDER OVER_LIMIT REJECTED FAILED

detail required string,null

documentCount required number

hasAttachment required boolean

refusedFiles required

array of object

Fields

`name` required	string
`reason` required	string

receivedAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ExpenseDuplicateGroup

data required

array of object

Fields

id required string

number required number

reference required string

status required PROCESSING NEEDS_REVIEW READY SUBMITTED APPROVED REJECTED REIMBURSED VOID

kind required RECEIPT MANUAL MILEAGE PER_DIEM TIME CARD

merchantName required string,null

tripTitle required

string,null

For a trip, what to call it in a list.

description required string,null

date required string

currency required string

amountMinor required number

baseAmountMinor required number

taxMinor required number,null

category required

object or null

Fields

`id` required	string
`name` required	string

alsoCategories required

array of object

Further categories it can be found under. Its money stays in category.

Fields

`id` required	string
`name` required	string

project required

object or null

Fields

`id` required	string
`name` required	string
`code` required	string,null

client required

object or null

Fields

`id` required	string
`name` required	string

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

moneyFlow required

IN OUT

Which way the money went.

invoiceNumber required string,null

matched required

boolean

A card charge has been matched to it.

connectedApps required

array of string

Connected services it has been posted to.

reportId required string,null

externalId required

string,null

A developer's own reference, exactly as sent.

billable required boolean

reimbursable required boolean

paymentType required CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

confidence required number,null

flags required

array of object

Fields

`code` required	string
`message` required	string
`severity` required	`info` `warn` `block`
`by`	string Who put it there, where that decides who may take it off.

reviewFields required array of string

thumbnailUrl required string,null

documentId required string,null

tags required

array of object

Fields

`id` required	string
`name` required	string
`color` required	string,null

attendeeCount required number

fxRate required

number

What one unit of the expense currency is worth in the base currency. Zero means no rate is available yet, so baseAmountMinor is zero too and the expense is held in review.

held required

boolean

Held back from its report until someone releases it.

createdAt required string

updatedAt required string

notes required string,null

subtotalMinor required number,null

tipMinor required number,null

discountMinor required number,null

shippingMinor required number,null

paymentAccountId required string,null

cardLast4 required string,null

poNumber required

string,null

The buyer's purchase order number, as an invoice prints it.

dueDate required

string,null

When an invoice falls due.

mcc required

string,null

The merchant category code a card network gave the merchant, four digits.

taxDeductible required boolean

quantity required number,null

rateMinor required number,null

unit required string,null

trip required map of any or null

vehicleId required string,null

attendees required

array of object

Fields

`name` required	string
`email`	string
`phone`	string

customFields required map of any

editedFields required array of string

duplicateOfId required string,null

duplicateReview required

object or null

What the second look at a flagged copy decided, and why.

Fields

`outcome` required	`DISMISSED` `KEPT`
`reason` required	string
`engine` required	`rules` `claude`
`at` required	string

canSettleDuplicate required

boolean

Whether the caller can answer the duplicate question on this expense.

splitParentId required string,null

access required

object

What the caller may do with it.

Fields

`canEdit` required	boolean
`limited` required	boolean Out for approval: only the amount, description, merchant, date, category, tags and attendees can change.
`reason` required	string,null Why it cannot be edited, or how far it can, in words for the person looking at it.
`amountLocked` required	boolean The amount is a card's own figure.
`canDelete` required	boolean
`canRestore` required	boolean
`restoreBlocked` required	string,null Why it cannot be restored: split, or merged, for good.
`canSplit` required	boolean
`canMove` required	boolean

splitInto required

array of object

This expense was divided: its parts now count in its place.

Fields

`id` required	string
`reference` required	string
`amountMinor` required	number

mergedIntoId required

string,null

A merge absorbed this expense. Where it went.

report required

object or null

The report this expense is on, named even where the caller could not list it.

Fields

`id` required	string
`title` required	string
`status` required	string

lines required

array of object

Fields

`id` required	string
`position` required	number
`description` required	string
`sku` required	string,null
`quantity` required	number,null
`unitPriceMinor` required	number,null
`amountMinor` required	number
`taxMinor` required	number,null
`categoryId` required	string,null

documentIds required array of string

hidden required

number

Copies in the group the caller cannot read.

WorkflowRun

id required string

workflowId required string

version required number

status required RUNNING PAUSED COMPLETED FAILED CANCELLED

trigger required API MANUAL SCHEDULE GMAIL GOOGLE_DRIVE DROPBOX EMAIL

startNodeId required string

documents required number

error required string,null

createdAt required string

finishedAt required string,null

steps required

array of object

Fields

id required string

nodeId required string

type required api_import document_aggregator google_drive_import gmail_input dropbox_import email_collector ai_agent convert_csv convert_excel decision document_classifier email_approval extract_data extract_data_set pdf_splitter split_collector business_insights email_file google_drive dropbox google_sheets xero_export

label required string

status required PENDING RUNNING WAITING DONE SKIPPED FAILED

message required string,null

documents required number

files required

array of object

Fields

`exportJobId` required	string
`filename` required	string
`rows` required	number
`url` required	string,null A signed link, or null once the file has expired.

table required

object or null

Fields

`title` required	string
`columns` required	array of string
`rows` required	array of array of string,number,null
`totalRows` required	number

approval required

object or null

Fields

`recipients` required	array of string
`expiresAt` required	string
`decision` required	`approve` `reject` or null
`decidedBy` required	string,null
`decidedAt` required	string,null

startedAt required string,null

finishedAt required string,null

WorkflowRunSummary

`id` required	string
`workflowId` required	string
`version` required	number
`status` required	`RUNNING` `PAUSED` `COMPLETED` `FAILED` `CANCELLED`
`trigger` required	`API` `MANUAL` `SCHEDULE` `GMAIL` `GOOGLE_DRIVE` `DROPBOX` `EMAIL`
`startNodeId` required	string
`documents` required	number
`error` required	string,null
`createdAt` required	string
`finishedAt` required	string,null

WorkflowRunPage

data required

array of object

Fields

`id` required	string
`workflowId` required	string
`version` required	number
`status` required	`RUNNING` `PAUSED` `COMPLETED` `FAILED` `CANCELLED`
`trigger` required	`API` `MANUAL` `SCHEDULE` `GMAIL` `GOOGLE_DRIVE` `DROPBOX` `EMAIL`
`startNodeId` required	string
`documents` required	number
`error` required	string,null
`createdAt` required	string
`finishedAt` required	string,null

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Error

error required

object

Fields

`code` required	string Stable. Safe to branch on.
`message` required	string Written for a person.
`details`	any
`requestId`	string Quote this when you contact support.

Attachment

`id` required	string
`filename` required	string
`contentType` required	string
`sizeBytes` required	integer
`url` required	string A signed link that lasts 15 minutes.

UploadTicket

`uploadId` required	string
`method` required	`PUT`
`url` required	string Send exactly sizeBytes bytes here, with these headers. It goes straight to storage.
`headers` required	map of string The signature covers these, so send them exactly.
`expiresAt` required	string When the URL stops working. If a PUT fails, ask for a new ticket and try once more.

AnalyticsSummary

totalMinor required number

count required number

averageMinor required number

unconverted required

number

Expenses with no exchange rate yet. They are not in these totals.

reimbursableMinor required number

billableMinor required number

previous required

object

Fields

`totalMinor` required	number
`count` required	number
`averageMinor` required	number

changePct required number,null

from required string

to required string

previousFrom required string

previousTo required string

currency required

string

Every amount here is in this currency: the workspace's base, or the one groupCurrency asked for.

convertedFrom required

string,null

Set when groupCurrency converted the amounts: the currency they were in, at the latest rate.

Breakdown

dimension required merchant category project member tag department

totalMinor required number

previousTotalMinor required number

averageMinor required

number

What one row spends on average in this period, over every row and not only those within limit.

rows required

array of object

Fields

`id` required	string,null The category, merchant, member, project, tag or department. Null is the row for expenses with none.
`label` required	string
`totalMinor` required	number
`count` required	number
`previousMinor` required	number
`changePct` required	number,null
`sharePct` required	number Of the period's total, one decimal.

other required

object or null

Everything past limit. Null when every row fits.

Fields

`totalMinor` required	number
`count` required	number
`previousMinor` required	number

overlapping required

boolean

True for tags: one expense can carry several, so rows can add up to more than the total.

from required string

to required string

previousFrom required string

previousTo required string

currency required

string

Every amount here is in this currency: the workspace's base, or the one groupCurrency asked for.

convertedFrom required

string,null

Set when groupCurrency converted the amounts: the currency they were in, at the latest rate.

Trend

interval required day week month quarter year running

points required

array of object

Fields

`totalMinor` required	number Added up from the start of the period when the interval is `running`, like `count` and `sharePct`.
`count` required	number
`sharePct` required	number Of the period's total, one decimal.
`previousLabel` required	string,null The point at the same position in the previous period.
`previousMinor` required	number
`start` required	string The days this point covers, cut to the period at either end.
`end` required	string
`label` required	string
`shortLabel` required	string

totalMinor required number

count required number

averageMinor required

number

What one point spends on average. For a running total, what each step adds on average.

from required string

to required string

previousFrom required string

previousTo required string

currency required

string

Every amount here is in this currency: the workspace's base, or the one groupCurrency asked for.

convertedFrom required

string,null

Set when groupCurrency converted the amounts: the currency they were in, at the latest rate.

Budget

id required string

scope required CATEGORY TAG MEMBER

targetId required string

targetName required string

period required MONTH YEAR

periodKey required

string

2026-03 for a month, 2026 for a fiscal year.

periodStart required string

periodEnd required string

currency required string

totalMinor required number,null

perMemberMinor required number,null

thresholds required array of number

total required

object or null

Everyone together. Null when the budget has no shared limit.

Fields

`limitMinor` required	number
`spentMinor` required	number Approved or paid.
`pendingMinor` required	number Not void or rejected, and not approved yet: what is on its way.
`remainingMinor` required	number Below zero once the limit is passed.
`percentUsed` required	number Of the limit, rounded down.

mine required

object or null

The caller's own share. Null when they have no limit of their own here.

Fields

`limitMinor` required	number
`spentMinor` required	number Approved or paid.
`pendingMinor` required	number Not void or rejected, and not approved yet: what is on its way.
`remainingMinor` required	number Below zero once the limit is passed.
`percentUsed` required	number Of the limit, rounded down.

BudgetPage

data required

array of object

Fields

id required string

scope required CATEGORY TAG MEMBER

targetId required string

targetName required string

period required MONTH YEAR

periodKey required

string

2026-03 for a month, 2026 for a fiscal year.

periodStart required string

periodEnd required string

currency required string

totalMinor required number,null

perMemberMinor required number,null

thresholds required array of number

total required

object or null

Everyone together. Null when the budget has no shared limit.

Fields

`limitMinor` required	number
`spentMinor` required	number Approved or paid.
`pendingMinor` required	number Not void or rejected, and not approved yet: what is on its way.
`remainingMinor` required	number Below zero once the limit is passed.
`percentUsed` required	number Of the limit, rounded down.

mine required

object or null

The caller's own share. Null when they have no limit of their own here.

Fields

`limitMinor` required	number
`spentMinor` required	number Approved or paid.
`pendingMinor` required	number Not void or rejected, and not approved yet: what is on its way.
`remainingMinor` required	number Below zero once the limit is passed.
`percentUsed` required	number Of the limit, rounded down.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

BulkDocumentResult

`updated` required	number
`skipped` required	number Not found, not the caller's to change, or backing an expense on a submitted report.
`nextCursor`	string,null With a filter: send this back as cursor until it is null.

DocumentCount

count required number

TrashActionResult

`updated` required	number
`skipped` required	number
`more` required	boolean With all: there is more to do. Call again.

TrashedDocumentPage

data required

array of object

Fields

`id` required	string
`type` required	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`title` required	string,null
`originalFilename` required	string,null
`sizeBytes` required	number
`thumbnailUrl` required	string,null
`deletedAt` required	string
`purgeOn` required	string YYYY-MM-DD. The day this document and its files are deleted for good.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

BulkExpenseResult

`updated` required	number
`skipped` required	number

BulkReportResult

succeeded required array of string

failed required

array of object

Fields

`id` required	string
`reference` required	string,null
`code` required	string
`message` required	string

CatalogImportResult

created required number

updated required number

skipped required

number

Rows that matched an existing record and changed nothing, or repeated an earlier row.

errors required

array of object

Rows that could not be used. line counts from 1 and includes the header.

Fields

`line` required	number
`message` required	string

removed

number

A replace: categories the file left out and nothing used, now deleted.

disabled

number

A replace: categories the file left out that something still uses, now turned off.

CategoryPage

data required

array of object

Fields

`id` required	string
`parentId` required	string,null
`name` required	string
`glCode` required	string,null
`taxLine` required	string,null
`origin` required	`SYSTEM` `CUSTOM` `ACCOUNTING` Where it came from: the workspace template, a person, or an import from the connected books.
`deductiblePct` required	number
`headerOnly` required	boolean A heading over its subcategories. It groups the list and cannot be chosen on an expense.
`enabled` required	boolean
`system` required	boolean
`position` required	number
`expenseCount` required	number A category on any expense cannot be deleted, only disabled.
`type` required	`EXPENSE` `COGS` `INCOME` `REFUND`
`payrollCode` required	string,null Null unless the caller manages settings or exports: payroll codes are not for everyone.
`descriptionHint` required	string,null Shown under the description while someone fills in an expense.
`approverId` required	string,null Sees any report carrying this category before the usual approvers.
`approverName` required	string,null
`commentRequired` required	boolean An expense here needs a description, or it carries a finding on its report.
`maxExpenseMinor` required	number,null An expense here over this, in the workspace's currency, carries a finding on its report.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

CommentPage

data required

array of object

Fields

id required string

body required string

attachments required

array of object

Fields

`id` required	string
`filename` required	string
`contentType` required	string
`sizeBytes` required	integer
`url` required	string A signed link that lasts 15 minutes.

editedAt required string,null

author required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

system

boolean

PaperTotal wrote this, about something that happened to the report.

actedBy required

object or null

The delegate who really wrote it, when that was not the author.

Fields

`id` required	string
`name` required	string,null
`email` required	string

mentions required

array of object

Fields

`id` required	string
`name` required	string,null
`email` required	string

createdAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

CreatedId

id required string

PostedComment

id required string

body required string

attachments required

array of object

Fields

`id` required	string
`filename` required	string
`contentType` required	string
`sizeBytes` required	integer
`url` required	string A signed link that lasts 15 minutes.

editedAt required string,null

author required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

system

boolean

PaperTotal wrote this, about something that happened to the report.

actedBy required

object or null

The delegate who really wrote it, when that was not the author.

Fields

`id` required	string
`name` required	string,null
`email` required	string

mentions required

array of object

Fields

`id` required	string
`name` required	string,null
`email` required	string

createdAt required string

unreachable required

array of object

Members the comment named who cannot read this, so were not mentioned or told.

Fields

`id` required	string
`name` required	string,null
`email` required	string

MentionablePeople

data required

array of object

Fields

`id` required	string
`name` required	string,null
`email` required	string

Contact

`id` required	string
`name` required	string Always something to show: the name, else the company, else the first address or number.
`firstName` required	string,null
`lastName` required	string,null
`company` required	string,null
`title` required	string,null
`emails` required	array of string
`phones` required	array of string
`mobile` required	string,null
`fax` required	string,null
`website` required	string,null
`address` required	string,null
`city` required	string,null
`region` required	string,null
`postalCode` required	string,null
`country` required	string,null
`notes` required	string,null
`editedFields` required	array of string Fields a person changed, which reading the card again leaves alone.
`documentId` required	string,null
`logoUrl` required	string,null The logo cut from the card, signed for 15 minutes. It stays when the card is deleted.
`faxes` required	array of string Every fax number on the card, the first being fax.
`cardImageUrl` required	string,null
`thumbnailUrl` required	string,null
`createdAt` required	string
`updatedAt` required	string

ContactPage

data required

array of object

Fields

`id` required	string
`name` required	string Always something to show: the name, else the company, else the first address or number.
`firstName` required	string,null
`lastName` required	string,null
`company` required	string,null
`title` required	string,null
`emails` required	array of string
`phones` required	array of string
`mobile` required	string,null
`fax` required	string,null
`website` required	string,null
`address` required	string,null
`city` required	string,null
`region` required	string,null
`postalCode` required	string,null
`country` required	string,null
`notes` required	string,null
`editedFields` required	array of string Fields a person changed, which reading the card again leaves alone.
`documentId` required	string,null
`logoUrl` required	string,null The logo cut from the card, signed for 15 minutes. It stays when the card is deleted.
`faxes` required	array of string Every fax number on the card, the first being fax.
`cardImageUrl` required	string,null
`thumbnailUrl` required	string,null
`createdAt` required	string
`updatedAt` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

CustomField

`id` required	string
`key` required	string
`label` required	string
`type` required	`TEXT` `NUMBER` `DATE` `SELECT` `BOOLEAN`
`options` required	array of string
`required` required	boolean
`position` required	number

CustomFieldPage

data required

array of object

Fields

`id` required	string
`key` required	string
`label` required	string
`type` required	`TEXT` `NUMBER` `DATE` `SELECT` `BOOLEAN`
`options` required	array of string
`required` required	boolean
`position` required	number

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

DeviceBlock

`id` required	string
`deviceId` required	string
`reason` required	string,null
`createdAt` required	string

DeviceBlockPage

data required

array of object

Fields

`id` required	string
`deviceId` required	string
`reason` required	string,null
`createdAt` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

DeviceBlockStatus

deviceId required string

blocked required boolean

block required

object or null

Fields

`id` required	string
`deviceId` required	string
`reason` required	string,null
`createdAt` required	string

Document

id required string

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

status required UPLOADED PROCESSING PROCESSED FAILED

originalFilename required string,null

mimeType required string

sizeBytes required number

pageCount required number

externalId required string,null

folderId required string,null

expenseId required string,null

mailInBatchId required string,null

title required string,null

notes required string,null

latitude required

number,null

Where the device said it was when the photo was taken.

longitude required number,null

locationAccuracyM required number,null

duplicateOfId required string,null

processingError required string,null

processingErrorCode required

FILE_ENCRYPTED or null

Set when the failure is one the file's owner can fix. processingError says what to do.

verification required string

capturedAt required string,null

processedAt required string,null

viewedAt required string,null

archivedAt required string,null

createdAt required string

uploadedBy required

object or null

Fields

`id` required	string
`name` required	string,null

pages required

array of object

Fields

index required number

url required string,null

thumbnailUrl required string,null

width required number,null

height required number,null

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Blank for a caller without expenses.read_all.

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Null when the page is not one, and for a caller without expenses.read_all.

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Blank for a caller without expenses.read_all. Value null means nothing could say.

Fields

`value` required	boolean,null
`score` required	number,null

language required string,null

languages required

array of object

Fields

`tag` required	string
`score` required	number

ocrScore required number,null

isFront required

boolean,null

A check: the front or the back.

tiffRejectScore required

number,null

A check: 0 is a clean clearing image and 1 is one a bank would send back.

tiffUpscaled required

boolean,null

A check: the photo was under 240 DPI, so the clearing image was enlarged.

classification required

object or null

What the classifier decided, when it was asked.

Fields

value required

string

A document class, or one of the labels the caller named.

score required

number

0..1.

engine required rules claude

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

blueprint required

object or null

The blueprint this was read with, and what came out of it.

Fields

`name` required	string
`version` required	number,null Null for a built-in, which has no versions.
`result` required	map of any or null The fields the blueprint defines. Null when the run failed.
`offsets`	map of object Where each value sits in the text, for a blueprint that asks.
`unmatched`	array of string Fields where a value was read and did not fit, such as words where a number belongs or a choice off the list. Each is left empty. An empty field not named here was not on the document.
`error` required	string,null Why the run gave nothing back.

tags required array of string

tagRefs required

array of object

The same tags with their ids, which a tag route takes.

Fields

`id` required	string
`name` required	string

recordStatus required

processed reviewed archived or null

Where a read document stands: reviewedAt and archivedAt in one word. Null until it has been read.

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

setId required

string,null

The upload this came out of: a ZIP, a split PDF or a batch of addresses.

customFields required

map of string or array of string or null

Values the workspace custom field rules read out of the text.

enrichment required

object or null

Work still running after the first answer.

Fields

`status` required	`PENDING` `DONE` `FAILED`
`steps` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`failed` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`

extraction required

object or null

Fields

fields required

object

What was read, as the extraction contract types it. fieldConfidence holds per-field confidence, 0..1.

Fields

merchantName string,null

merchantAddress string,null

merchantPhone string,null

merchantWebsite string,null

merchantTaxId string,null

date string or null

time string,null

dueDate string or null

currencyGuessed boolean

totalMinor integer or null

subtotalMinor integer or null

taxMinor integer or null

taxLines

array of object

Fields

`name`	string,null
`ratePct`	number,null
`amountMinor` required	integer
`order`	integer or null
`baseMinor`	integer or null
`code`	string,null
`totalInclusive`	boolean,null

tipMinor integer or null

discountMinor integer or null

shippingMinor integer or null

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

cardBrand string,null

cardLast4 string,null

receiptNumber string,null

invoiceNumber string,null

poNumber string,null

lineItems

array of object

Fields

`description` required	string
`sku`	string,null
`quantity`	number,null
`unitPriceMinor`	integer or null
`amountMinor` required	integer
`taxMinor`	integer or null
`id`	string,null
`order`	integer or null
`text`	string,null
`type`	`room` `tax` `parking` `service` `fee` `delivery` `product` `food` `alcohol` `tobacco` `transportation` `fuel` `refund` `discount` `payment` `giftcard` `donation` `toll` `lottery` or null
`fullDescription`	string,null
`normalizedDescription`	string,null
`section`	string,null
`reference`	string,null
`upc`	string,null
`hsn`	string,null
`lot`	string,null
`tags`	array of string or null
`unitOfMeasure`	string,null
`discountMinor`	integer or null
`discountRatePct`	number,null
`discountPriceMinor`	integer or null
`taxRatePct`	number,null
`taxCode`	string,null
`subtotalMinor`	integer or null
`grossTotalMinor`	integer or null
`netTotalMinor`	integer or null
`date`	string or null
`startDate`	string or null
`endDate`	string or null
`category`	string,null
`customCategories`	array of string or null
`customFields`	map of any or null
`countryOfOrigin`	string,null
`manufacturer`	string,null
`weight`	string,null
`brand`	string,null
`hsaFsaEligible`	boolean,null
`productInfo`	object or null

suggestedCategory string,null

documentTitle string,null

documentReferenceNumber string,null

isDocument boolean,null

isTransaction boolean,null

isMoneyIn boolean,null

accountingEntryType debit credit or null

vendor

object or null

Fields

`name`	string,null
`rawName`	string,null
`type`	string,null
`logo`	string,null
`logoName`	string,null
`externalId`	string,null
`category`	string,null
`orderNumber`	string,null
`countryCode`	string,null
`address`	string,null
`rawAddress`	string,null
`parsedAddress`	object or null
`phoneNumber`	string,null
`faxNumber`	string,null
`email`	string,null
`web`	string,null
`lat`	number,null
`lng`	number,null
`mapUrl`	string,null
`vatNumber`	string,null
`isValidatedVatNumber`	boolean,null
`regNumber`	string,null
`abnNumber`	string,null
`isRegisteredForGst`	boolean,null
`bank`	object or null

vendors

array of object or null

Fields

`name`	string,null
`rawName`	string,null
`type`	string,null
`logo`	string,null
`logoName`	string,null
`externalId`	string,null
`category`	string,null
`orderNumber`	string,null
`countryCode`	string,null
`address`	string,null
`rawAddress`	string,null
`parsedAddress`	object or null
`phoneNumber`	string,null
`faxNumber`	string,null
`email`	string,null
`web`	string,null
`lat`	number,null
`lng`	number,null
`mapUrl`	string,null
`vatNumber`	string,null
`isValidatedVatNumber`	boolean,null
`regNumber`	string,null
`abnNumber`	string,null
`isRegisteredForGst`	boolean,null
`bank`	object or null

bankBreakdown

array of object or null

Fields

`accountName`	string,null
`accountNumber`	string,null
`accountCurrency`	string,null
`bankName`	string,null
`bankNames`	array of string or null
`bankAddress`	string,null
`bankAddresses`	array of string or null
`bankNumber`	string,null
`bankNumbers`	array of string or null
`bankSwift`	string,null
`iban`	string,null
`billerCode`	string,null

billTo

object or null

Fields

`name`	string,null
`address`	string,null
`parsedAddress`	object or null
`vatNumber`	string,null
`regNumber`	string,null
`phoneNumber`	string,null
`email`	string,null

shipTo

object or null

Fields

`name`	string,null
`address`	string,null
`parsedAddress`	object or null

insuranceMinor integer or null

cashbackMinor integer or null

roundingMinor integer or null

balanceMinor integer or null

finalBalanceMinor integer or null

previousBalanceMinor integer or null

totalQuantity number,null

totalWeight string,null

payment

object or null

Fields

`cardNumber`	string,null
`displayName`	string,null
`terms`	string,null
`type`	`none` `visa` `master_card` `cash` `american_express` `interac` `other` `maestro` `discover` `bancontact` `girocard` `applepay` `paypal` `bancomat` `giftcard` `card` `check` `bankaxept` `bank-to-bank_transfer_bacs` `octopus` `pix` `jcb` `waon` `mada` `wechat` `alipay` `unionpay` `googlepay` `rupay` `bpay` `shopeepay` `mir` `giropay` `food_stamp` `diners_club` `paypay` or null

orderDate string or null

shipDate string or null

deliveryDate string or null

serviceStartDate string or null

serviceEndDate string or null

exchangeRate number,null

countryCode string,null

deliveryNoteNumber string,null

trackingNumber string,null

trackingNumbers array of string or null

incoterms string,null

weights array of string or null

licensePlateNumber string,null

vinNumber string,null

guestCount integer or null

serverName string,null

storeNumber string,null

vendingPerson string,null

vendingPersonNumber string,null

customerAccountNumber string,null

category string,null

defaultCategory string,null

barcodes

array of object or null

Fields

`data` required	string
`type` required	`QR_CODE` `PDF417` `EAN_13` `EAN_8` `UPC_A` `UPC_E` `CODE_128` `CODE_39` `ITF` `DATA_MATRIX` `AZTEC` `OTHER`
`page` required	integer
`boundingRegion`	array of number or null

paymentLinks

array of object or null

Fields

`url` required	string
`source` required	`text` `hyperlink` `qr_code` `barcode`

folio

object or null

Fields

`arrivalDate`	string or null
`departureDate`	string or null
`roomNumber`	string,null
`guestName`	string,null
`nights`	integer or null
`confirmationNumber`	string,null

enrichedFields array of string or null

check

object or null

Fields

`amountMinor`	integer or null
`amountText`	string,null
`amountsAgree`	boolean,null
`bankName`	string,null
`bankAddress`	string,null
`checkNumber`	string,null
`checkType`	`bank_draft` `bill_pay_draft` `business_check` `cashiers_check` `government_check` `money_order` `personal_check` `starter_check` `teller_check` or null
`currency`	string or null
`date`	string or null
`memo`	string,null
`payerName`	string,null
`payerAddress`	string,null
`receiverName`	string,null
`receiverAddress`	string,null
`isSigned`	boolean,null
`endorsement`	object or null
`micr`	object or null
`fractionalRoutingNumber`	string,null
`routingFromFractional`	string,null
`voidTerms`	string,null

statement

object or null

Fields

`accountHolderName`	string,null
`accountHolderAddress`	string,null
`accountType`	string,null
`accountNumber`	string,null
`bankName`	string,null
`bankAddress`	string,null
`bankWebsite`	string,null
`bankVatNumber`	string,null
`accountVatNumber`	string,null
`periodStartDate`	string or null
`periodEndDate`	string or null
`statementDate`	string or null
`statementNumber`	string,null
`currency`	string or null
`beginningBalanceMinor`	integer or null
`endingBalanceMinor`	integer or null
`minimumDueMinor`	integer or null
`dueDate`	string or null
`routingNumber`	string,null
`swift`	string,null
`iban`	string,null
`accounts`	array of object
`balancesAgree`	boolean,null

taxForm

object or null

Fields

`kind` required	`W2` `W9` `W8BEN_E`
`w2`	object or null
`w9`	object or null
`w8BenE`	map of string,boolean,null or null

itinerary

object or null

Fields

`travelerName`	string,null
`bookingReference`	string,null
`origin`	string,null
`destination`	string,null
`departsOn`	string or null
`returnsOn`	string or null
`segments`	array of object

fieldConfidence map of number

fieldBoxes map of object

confidence required number,null

flags required array of string

warnings required

array of object

Integrity findings. A caller without expenses.read_all sees the arithmetic and dates only.

Fields

`code` required	`tax_rate_mismatch` `item_counts_mismatch` `totals_mismatch` `line_item_amount_mismatch` `line_item_repeats` `barcode_decoding_issue` `barcode_code_missing_in_ocr` `logo_vendor_mismatch` `malware` `weekend_transaction` `time_and_currency_mismatch` `exif_creation_modified_date_mismatch` `missing_date` `suspicious_document_aspect_ratio` `generic_placeholder_content`
`message` required	string
`page`	number,null

fraud required

object or null

Fields

version required string

score required

number

0 to 1, from the signals that fired. Evidence, never a verdict.

color required

green yellow red

Under the workspace yellow threshold is green. Over its red threshold is red.

types required

Signals that fired, most important first.

details required

map of object

By signal: a description, a confidence and typed reasons.

attribution required

string,null

One sentence naming the strongest evidence.

decision required

clear review fraud not_fraud unknown

clear or review until a person decides. Only a person can say fraud.

review required

object or null

Fields

decision required FRAUD NOT_FRAUD UNKNOWN

note required string,null

reviewedBy required

object or null

Fields

`id` required	string
`name` required	string,null

reviewedAt required string

deviceId required

string,null

The id the client sent for its device, when it sent one.

submissions required

object or null

Documents from this uploader in this workspace, by window.

Fields

`lastMinutes` required	number
`lastDay` required	number
`lastWeek` required	number
`last2Weeks` required	number
`lastMonth` required	number

deviceProfiles required

array of object

Over 30 days, inside this workspace only.

Fields

`deviceId` required	string
`profileId` required	string
`documentCount` required	number

digitalTamperingFields required array of string

handwriting required

object

What Claude saw written by hand, in dot notation, when a key is set and the handwriting signal is on. With no key, the lists are empty and the flags null: skipped says why.

Fields

`handwrittenFields` required	array of string
`fullyHandwrittenFields` required	array of string
`handwrittenTamperedFields` required	array of string
`handwritingDetected` required	boolean,null
`handwritingTamperingPresent` required	boolean,null

notADocument required

object

Fields

`value` required	boolean,null
`score` required	number,null

digitalBackground required

object

Fields

`value` required	boolean,null
`score` required	number,null

fraudulentPdf required

object or null

Fields

fraudulentPdfCreator required number,null

textOverlay required number,null

fontMismatch required number,null

hasDigitalSignature required boolean,null

pdfModified required number,null

incrementalUpdates required number,null

incrementalChanges required array of string

incrementalEdits required

array of object

Fields

`page` required	number
`before` required	string,null
`after` required	string,null

signatureCreationTools required array of string

dateInversion required number,null

producerContentMismatch required number,null

writerMismatch required number,null

nullMetadata required number,null

xmpInfoMismatch required number,null

futureMetadataDate required number,null

rasterProfileMismatch required number,null

uncompressedRaster required number,null

splicedPage required number,null

splicedPageNumber required number,null

valueFontSplice required number,null

valueFontSplicePage required number,null

headlessDesktopRender required number,null

headlessRenderPlatform required string,null

doubleJpeg required number,null

firstQuantizationQuality required number,null

scrubbedProvenance required number,null

score required number,null

fraudulentImage required

object or null

Fields

`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`editorSignature` required	number,null
`editorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`editorSignatureValue` required	string,null
`generatorSignature` required	number,null
`generatorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`generatorSignatureValue` required	string,null
`generatorWriterProfile` required	number,null
`generatorWriterProfileValue` required	string,null
`syntheticRaster` required	number,null
`syntheticRasterFingerprints` required	array of string
`unprofiledPng` required	number,null
`unprofiledWebp` required	number,null
`source` required	`original` `render` or null
`sourceFormats` required	array of string
`unreadableSource` required	number,null
`score` required	number,null

pages required

array of object

Fields

index required number

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Value null means nothing could say: no pixel model runs, only metadata can answer.

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

skipped required

array of object

Checks that could not run on this file, so a clean result is not read as more than it is.

Fields

`check` required	string
`reason` required	string

sealed required

array of object

Bank and tax numbers read from this document, as masks. POST /v1/documents/{id}/reveal opens them.

Fields

`kind` required	`ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`masked` required	string All but the last few characters are stars. Punctuation stays where it was.
`field` required	string,null
`page` required	number

updatedAt required string

extractor required

string,null

What read it: rules, claude, a blueprint, business-card, or none.

ocrText required

string,null

Everything read off the page. Card, bank and tax numbers are masked.

pdfUrl required

string,null

The PDF as uploaded, signed for 15 minutes. Null for an image, and for a PDF that prints a number only a reveal hands out.

meta required

object

Fields

totalPages required number

processedPages required number

ocrScore required

number,null

The average character confidence of the reading, which doubles as a measure of the image.

originalFileName required string,null

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

language required

string,null

BCP-47.

languages required

array of object

Every language found, best first.

Fields

`tag` required	string
`score` required	number

deviceId required string,null

deviceUserUuid required

string,null

The signed-in person the device was capturing for. Null when no device was named.

latitude required number,null

longitude required number,null

sourceDocuments required

array of map of any

Each file as submitted: name, type, size in KB, width, height and EXIF.

owner required

object or null

Who uploaded it.

Fields

`id` required	string
`name` required	string,null

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

reviewedAt required

string,null

A person checked what was read.

approvedAt required

string,null

A developer's own approved flag. An expense's approval is a different thing.

DocumentOriginal

`url` required	string Signed for 15 minutes. Opening it downloads the file as uploaded.
`filename` required	string
`mimeType` required	string

RevealedDocument

documentId required string

values required

array of object

Fields

`kind` required	`ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`masked` required	string All but the last few characters are stars. Punctuation stays where it was.
`field` required	string,null
`page` required	number
`id` required	string
`value` required	string The whole number. Never log or store this.

original required

object or null

Fields

`url` required	string Signed for 15 minutes.
`filename` required	string
`mimeType` required	string

pages required

array of object

Fields

`index` required	number
`tiffUrl` required	string,null A check only: 240 DPI bitonal G4. It prints the MICR line, so it is handed out here and nowhere else.

CheckWithDocument

check required

object

Fields

id required string

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

status required UPLOADED PROCESSING PROCESSED FAILED

originalFilename required string,null

mimeType required string

sizeBytes required number

pageCount required number

externalId required string,null

folderId required string,null

expenseId required string,null

mailInBatchId required string,null

title required string,null

notes required string,null

latitude required

number,null

Where the device said it was when the photo was taken.

longitude required number,null

locationAccuracyM required number,null

duplicateOfId required string,null

processingError required string,null

processingErrorCode required

FILE_ENCRYPTED or null

Set when the failure is one the file's owner can fix. processingError says what to do.

verification required string

capturedAt required string,null

processedAt required string,null

viewedAt required string,null

archivedAt required string,null

createdAt required string

uploadedBy required

object or null

Fields

`id` required	string
`name` required	string,null

pages required

array of object

Fields

index required number

url required string,null

thumbnailUrl required string,null

width required number,null

height required number,null

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Blank for a caller without expenses.read_all.

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Null when the page is not one, and for a caller without expenses.read_all.

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Blank for a caller without expenses.read_all. Value null means nothing could say.

Fields

`value` required	boolean,null
`score` required	number,null

language required string,null

languages required

array of object

Fields

`tag` required	string
`score` required	number

ocrScore required number,null

isFront required

boolean,null

A check: the front or the back.

tiffRejectScore required

number,null

A check: 0 is a clean clearing image and 1 is one a bank would send back.

tiffUpscaled required

boolean,null

A check: the photo was under 240 DPI, so the clearing image was enlarged.

classification required

object or null

What the classifier decided, when it was asked.

Fields

value required

string

A document class, or one of the labels the caller named.

score required

number

0..1.

engine required rules claude

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

blueprint required

object or null

The blueprint this was read with, and what came out of it.

Fields

`name` required	string
`version` required	number,null Null for a built-in, which has no versions.
`result` required	map of any or null The fields the blueprint defines. Null when the run failed.
`offsets`	map of object Where each value sits in the text, for a blueprint that asks.
`unmatched`	array of string Fields where a value was read and did not fit, such as words where a number belongs or a choice off the list. Each is left empty. An empty field not named here was not on the document.
`error` required	string,null Why the run gave nothing back.

tags required array of string

tagRefs required

array of object

The same tags with their ids, which a tag route takes.

Fields

`id` required	string
`name` required	string

recordStatus required

processed reviewed archived or null

Where a read document stands: reviewedAt and archivedAt in one word. Null until it has been read.

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

setId required

string,null

The upload this came out of: a ZIP, a split PDF or a batch of addresses.

customFields required

map of string or array of string or null

Values the workspace custom field rules read out of the text.

enrichment required

object or null

Work still running after the first answer.

Fields

`status` required	`PENDING` `DONE` `FAILED`
`steps` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`failed` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`

extraction required

object or null

Fields

fields required

object

What was read, as the extraction contract types it. fieldConfidence holds per-field confidence, 0..1.

Fields

`documentType`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`merchantName`	string,null
`merchantAddress`	string,null
`merchantPhone`	string,null
`merchantWebsite`	string,null
`merchantTaxId`	string,null
`date`	string or null
`time`	string,null
`dueDate`	string or null
`currency`	`AED` `AFN` `ALL` `AMD` `ANG` `AOA` `ARS` `AUD` `AWG` `AZN` `BAM` `BBD` `BDT` `BGN` `BHD` `BIF` `BMD` `BND` `BOB` `BRL` `BSD` `BTN` `BWP` `BYN` `BZD` `CAD` `CDF` `CHF` `CLP` `CNY` `COP` `CRC` `CUP` `CVE` `CZK` `DJF` `DKK` `DOP` `DZD` `EGP` `ERN` `ETB` `EUR` `FJD` `FKP` `GBP` `GEL` `GHS` `GIP` `GMD` `GNF` `GTQ` `GYD` `HKD` `HNL` `HTG` `HUF` `IDR` `ILS` `INR` `IQD` `IRR` `ISK` `JMD` `JOD` `JPY` `KES` `KGS` `KHR` `KMF` `KPW` `KRW` `KWD` `KYD` `KZT` `LAK` `LBP` `LKR` `LRD` `LSL` `LYD` `MAD` `MDL` `MGA` `MKD` `MMK` `MNT` `MOP` `MRU` `MUR` `MVR` `MWK` `MXN` `MYR` `MZN` `NAD` `NGN` `NIO` `NOK` `NPR` `NZD` `OMR` `PAB` `PEN` `PGK` `PHP` `PKR` `PLN` `PYG` `QAR` `RON` `RSD` `RUB` `RWF` `SAR` `SBD` `SCR` `SDG` `SEK` `SGD` `SHP` `SLE` `SOS` `SRD` `SSP` `STN` `SVC` `SYP` `SZL` `THB` `TJS` `TMT` `TND` `TOP` `TRY` `TTD` `TWD` `TZS` `UAH` `UGX` `USD` `UYU` `UZS` `VES` `VND` `VUV` `WST` `XAF` `XCD` `XCG` `XOF` `XPF` `YER` `ZAR` `ZMW` `ZWG` `CUC` `HRK` `SLL` `ZWL` `XDR` `XSU` or null
`currencyGuessed`	boolean
`totalMinor`	integer or null
`subtotalMinor`	integer or null
`taxMinor`	integer or null
`taxLines`	array of object
`tipMinor`	integer or null
`discountMinor`	integer or null
`shippingMinor`	integer or null
`paymentType`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER` or null
`cardBrand`	string,null
`cardLast4`	string,null
`receiptNumber`	string,null
`invoiceNumber`	string,null
`poNumber`	string,null
`lineItems`	array of object
`suggestedCategory`	string,null
`documentTitle`	string,null
`documentReferenceNumber`	string,null
`isDocument`	boolean,null
`isTransaction`	boolean,null
`isMoneyIn`	boolean,null
`accountingEntryType`	`debit` `credit` or null
`vendor`	object or null
`vendors`	array of object or null
`bankBreakdown`	array of object or null
`billTo`	object or null
`shipTo`	object or null
`insuranceMinor`	integer or null
`cashbackMinor`	integer or null
`roundingMinor`	integer or null
`balanceMinor`	integer or null
`finalBalanceMinor`	integer or null
`previousBalanceMinor`	integer or null
`totalQuantity`	number,null
`totalWeight`	string,null
`payment`	object or null
`orderDate`	string or null
`shipDate`	string or null
`deliveryDate`	string or null
`serviceStartDate`	string or null
`serviceEndDate`	string or null
`exchangeRate`	number,null
`countryCode`	string,null
`deliveryNoteNumber`	string,null
`trackingNumber`	string,null
`trackingNumbers`	array of string or null
`incoterms`	string,null
`weights`	array of string or null
`licensePlateNumber`	string,null
`vinNumber`	string,null
`guestCount`	integer or null
`serverName`	string,null
`storeNumber`	string,null
`vendingPerson`	string,null
`vendingPersonNumber`	string,null
`customerAccountNumber`	string,null
`category`	string,null
`defaultCategory`	string,null
`barcodes`	array of object or null
`paymentLinks`	array of object or null
`folio`	object or null
`enrichedFields`	array of string or null
`check`	object or null
`statement`	object or null
`taxForm`	object or null
`itinerary`	object or null
`fieldConfidence`	map of number
`fieldBoxes`	map of object

confidence required number,null

flags required array of string

warnings required

array of object

Integrity findings. A caller without expenses.read_all sees the arithmetic and dates only.

Fields

`code` required	`tax_rate_mismatch` `item_counts_mismatch` `totals_mismatch` `line_item_amount_mismatch` `line_item_repeats` `barcode_decoding_issue` `barcode_code_missing_in_ocr` `logo_vendor_mismatch` `malware` `weekend_transaction` `time_and_currency_mismatch` `exif_creation_modified_date_mismatch` `missing_date` `suspicious_document_aspect_ratio` `generic_placeholder_content`
`message` required	string
`page`	number,null

fraud required

object or null

Fields

version required string

score required

number

0 to 1, from the signals that fired. Evidence, never a verdict.

color required

green yellow red

Under the workspace yellow threshold is green. Over its red threshold is red.

types required

Signals that fired, most important first.

details required

map of object

By signal: a description, a confidence and typed reasons.

attribution required

string,null

One sentence naming the strongest evidence.

decision required

clear review fraud not_fraud unknown

clear or review until a person decides. Only a person can say fraud.

review required

object or null

Fields

`decision` required	`FRAUD` `NOT_FRAUD` `UNKNOWN`
`types` required	array of `digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`note` required	string,null
`reviewedBy` required	object or null
`reviewedAt` required	string

deviceId required

string,null

The id the client sent for its device, when it sent one.

submissions required

object or null

Documents from this uploader in this workspace, by window.

Fields

`lastMinutes` required	number
`lastDay` required	number
`lastWeek` required	number
`last2Weeks` required	number
`lastMonth` required	number

deviceProfiles required

array of object

Over 30 days, inside this workspace only.

Fields

`deviceId` required	string
`profileId` required	string
`documentCount` required	number

digitalTamperingFields required array of string

handwriting required

object

What Claude saw written by hand, in dot notation, when a key is set and the handwriting signal is on. With no key, the lists are empty and the flags null: skipped says why.

Fields

`handwrittenFields` required	array of string
`fullyHandwrittenFields` required	array of string
`handwrittenTamperedFields` required	array of string
`handwritingDetected` required	boolean,null
`handwritingTamperingPresent` required	boolean,null

notADocument required

object

Fields

`value` required	boolean,null
`score` required	number,null

digitalBackground required

object

Fields

`value` required	boolean,null
`score` required	number,null

fraudulentPdf required

object or null

Fields

`fraudulentPdfCreator` required	number,null
`textOverlay` required	number,null
`fontMismatch` required	number,null
`hasDigitalSignature` required	boolean,null
`pdfModified` required	number,null
`incrementalUpdates` required	number,null
`incrementalChanges` required	array of string
`incrementalEdits` required	array of object
`signatureCreationTools` required	array of string
`dateInversion` required	number,null
`producerContentMismatch` required	number,null
`writerMismatch` required	number,null
`nullMetadata` required	number,null
`xmpInfoMismatch` required	number,null
`futureMetadataDate` required	number,null
`rasterProfileMismatch` required	number,null
`uncompressedRaster` required	number,null
`splicedPage` required	number,null
`splicedPageNumber` required	number,null
`valueFontSplice` required	number,null
`valueFontSplicePage` required	number,null
`headlessDesktopRender` required	number,null
`headlessRenderPlatform` required	string,null
`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`score` required	number,null

fraudulentImage required

object or null

Fields

`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`editorSignature` required	number,null
`editorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`editorSignatureValue` required	string,null
`generatorSignature` required	number,null
`generatorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`generatorSignatureValue` required	string,null
`generatorWriterProfile` required	number,null
`generatorWriterProfileValue` required	string,null
`syntheticRaster` required	number,null
`syntheticRasterFingerprints` required	array of string
`unprofiledPng` required	number,null
`unprofiledWebp` required	number,null
`source` required	`original` `render` or null
`sourceFormats` required	array of string
`unreadableSource` required	number,null
`score` required	number,null

pages required

array of object

Fields

`index` required	number
`isBlurry` required	object
`isLcd` required	object
`screenshot` required	object or null
`aiGenerated` required	object Value null means nothing could say: no pixel model runs, only metadata can answer.
`glare` required	object

skipped required

array of object

Checks that could not run on this file, so a clean result is not read as more than it is.

Fields

`check` required	string
`reason` required	string

sealed required

array of object

Bank and tax numbers read from this document, as masks. POST /v1/documents/{id}/reveal opens them.

Fields

`kind` required	`ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`masked` required	string All but the last few characters are stars. Punctuation stays where it was.
`field` required	string,null
`page` required	number

updatedAt required string

extractor required

string,null

What read it: rules, claude, a blueprint, business-card, or none.

ocrText required

string,null

Everything read off the page. Card, bank and tax numbers are masked.

pdfUrl required

string,null

The PDF as uploaded, signed for 15 minutes. Null for an image, and for a PDF that prints a number only a reveal hands out.

meta required

object

Fields

totalPages required number

processedPages required number

ocrScore required

number,null

The average character confidence of the reading, which doubles as a measure of the image.

originalFileName required string,null

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

language required

string,null

BCP-47.

languages required

array of object

Every language found, best first.

Fields

`tag` required	string
`score` required	number

deviceId required string,null

deviceUserUuid required

string,null

The signed-in person the device was capturing for. Null when no device was named.

latitude required number,null

longitude required number,null

sourceDocuments required

array of map of any

Each file as submitted: name, type, size in KB, width, height and EXIF.

owner required

object or null

Who uploaded it.

Fields

`id` required	string
`name` required	string,null

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

reviewedAt required

string,null

A person checked what was read.

approvedAt required

string,null

A developer's own approved flag. An expense's approval is a different thing.

document required

object

Fields

id required string

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

status required UPLOADED PROCESSING PROCESSED FAILED

originalFilename required string,null

mimeType required string

sizeBytes required number

pageCount required number

externalId required string,null

folderId required string,null

expenseId required string,null

mailInBatchId required string,null

title required string,null

notes required string,null

latitude required

number,null

Where the device said it was when the photo was taken.

longitude required number,null

locationAccuracyM required number,null

duplicateOfId required string,null

processingError required string,null

processingErrorCode required

FILE_ENCRYPTED or null

Set when the failure is one the file's owner can fix. processingError says what to do.

verification required string

capturedAt required string,null

processedAt required string,null

viewedAt required string,null

archivedAt required string,null

createdAt required string

uploadedBy required

object or null

Fields

`id` required	string
`name` required	string,null

pages required

array of object

Fields

index required number

url required string,null

thumbnailUrl required string,null

width required number,null

height required number,null

isBlurry required

object

Fields

`value` required	boolean,null
`score` required	number,null

glare required

object

Fields

`value` required	boolean,null
`score` required	number,null

isLcd required

object

Blank for a caller without expenses.read_all.

Fields

`value` required	boolean,null
`score` required	number,null

screenshot required

object or null

Null when the page is not one, and for a caller without expenses.read_all.

Fields

`type` required	`mobile_screenshot` `other_screenshot` `ai_generated`
`score` required	number,null

aiGenerated required

object

Blank for a caller without expenses.read_all. Value null means nothing could say.

Fields

`value` required	boolean,null
`score` required	number,null

language required string,null

languages required

array of object

Fields

`tag` required	string
`score` required	number

ocrScore required number,null

isFront required

boolean,null

A check: the front or the back.

tiffRejectScore required

number,null

A check: 0 is a clean clearing image and 1 is one a bank would send back.

tiffUpscaled required

boolean,null

A check: the photo was under 240 DPI, so the clearing image was enlarged.

classification required

object or null

What the classifier decided, when it was asked.

Fields

value required

string

A document class, or one of the labels the caller named.

score required

number

0..1.

engine required rules claude

scores required

array of object

The runners-up, best first.

Fields

`value` required	string
`score` required	number

blueprint required

object or null

The blueprint this was read with, and what came out of it.

Fields

`name` required	string
`version` required	number,null Null for a built-in, which has no versions.
`result` required	map of any or null The fields the blueprint defines. Null when the run failed.
`offsets`	map of object Where each value sits in the text, for a blueprint that asks.
`unmatched`	array of string Fields where a value was read and did not fit, such as words where a number belongs or a choice off the list. Each is left empty. An empty field not named here was not on the document.
`error` required	string,null Why the run gave nothing back.

tags required array of string

tagRefs required

array of object

The same tags with their ids, which a tag route takes.

Fields

`id` required	string
`name` required	string

recordStatus required

processed reviewed archived or null

Where a read document stands: reviewedAt and archivedAt in one word. Null until it has been read.

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

setId required

string,null

The upload this came out of: a ZIP, a split PDF or a batch of addresses.

customFields required

map of string or array of string or null

Values the workspace custom field rules read out of the text.

enrichment required

object or null

Work still running after the first answer.

Fields

`status` required	`PENDING` `DONE` `FAILED`
`steps` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`
`failed` required	array of `duplicates` `similar_documents` `line_item_expansion` `line_item_categorization` `line_item_custom_categorization` `xero_line_coding` `address_parsing` `fraud` `rules` `vendor_resolution`

extraction required

object or null

Fields

fields required

object

What was read, as the extraction contract types it. fieldConfidence holds per-field confidence, 0..1.

Fields

`documentType`	`RECEIPT` `INVOICE` `BILL` `BANK_STATEMENT` `CHECK` `TAX_FORM` `BUSINESS_CARD` `OTHER` `UNKNOWN` `PURCHASE_ORDER` `CONTRACT` `PACKING_SLIP` `REMITTANCE_ADVICE` `CREDIT_NOTE` `STATEMENT`
`merchantName`	string,null
`merchantAddress`	string,null
`merchantPhone`	string,null
`merchantWebsite`	string,null
`merchantTaxId`	string,null
`date`	string or null
`time`	string,null
`dueDate`	string or null
`currency`	`AED` `AFN` `ALL` `AMD` `ANG` `AOA` `ARS` `AUD` `AWG` `AZN` `BAM` `BBD` `BDT` `BGN` `BHD` `BIF` `BMD` `BND` `BOB` `BRL` `BSD` `BTN` `BWP` `BYN` `BZD` `CAD` `CDF` `CHF` `CLP` `CNY` `COP` `CRC` `CUP` `CVE` `CZK` `DJF` `DKK` `DOP` `DZD` `EGP` `ERN` `ETB` `EUR` `FJD` `FKP` `GBP` `GEL` `GHS` `GIP` `GMD` `GNF` `GTQ` `GYD` `HKD` `HNL` `HTG` `HUF` `IDR` `ILS` `INR` `IQD` `IRR` `ISK` `JMD` `JOD` `JPY` `KES` `KGS` `KHR` `KMF` `KPW` `KRW` `KWD` `KYD` `KZT` `LAK` `LBP` `LKR` `LRD` `LSL` `LYD` `MAD` `MDL` `MGA` `MKD` `MMK` `MNT` `MOP` `MRU` `MUR` `MVR` `MWK` `MXN` `MYR` `MZN` `NAD` `NGN` `NIO` `NOK` `NPR` `NZD` `OMR` `PAB` `PEN` `PGK` `PHP` `PKR` `PLN` `PYG` `QAR` `RON` `RSD` `RUB` `RWF` `SAR` `SBD` `SCR` `SDG` `SEK` `SGD` `SHP` `SLE` `SOS` `SRD` `SSP` `STN` `SVC` `SYP` `SZL` `THB` `TJS` `TMT` `TND` `TOP` `TRY` `TTD` `TWD` `TZS` `UAH` `UGX` `USD` `UYU` `UZS` `VES` `VND` `VUV` `WST` `XAF` `XCD` `XCG` `XOF` `XPF` `YER` `ZAR` `ZMW` `ZWG` `CUC` `HRK` `SLL` `ZWL` `XDR` `XSU` or null
`currencyGuessed`	boolean
`totalMinor`	integer or null
`subtotalMinor`	integer or null
`taxMinor`	integer or null
`taxLines`	array of object
`tipMinor`	integer or null
`discountMinor`	integer or null
`shippingMinor`	integer or null
`paymentType`	`CASH` `PERSONAL_CARD` `COMPANY_CARD` `BANK_TRANSFER` `CHECK` `PAYPAL` `OTHER` or null
`cardBrand`	string,null
`cardLast4`	string,null
`receiptNumber`	string,null
`invoiceNumber`	string,null
`poNumber`	string,null
`lineItems`	array of object
`suggestedCategory`	string,null
`documentTitle`	string,null
`documentReferenceNumber`	string,null
`isDocument`	boolean,null
`isTransaction`	boolean,null
`isMoneyIn`	boolean,null
`accountingEntryType`	`debit` `credit` or null
`vendor`	object or null
`vendors`	array of object or null
`bankBreakdown`	array of object or null
`billTo`	object or null
`shipTo`	object or null
`insuranceMinor`	integer or null
`cashbackMinor`	integer or null
`roundingMinor`	integer or null
`balanceMinor`	integer or null
`finalBalanceMinor`	integer or null
`previousBalanceMinor`	integer or null
`totalQuantity`	number,null
`totalWeight`	string,null
`payment`	object or null
`orderDate`	string or null
`shipDate`	string or null
`deliveryDate`	string or null
`serviceStartDate`	string or null
`serviceEndDate`	string or null
`exchangeRate`	number,null
`countryCode`	string,null
`deliveryNoteNumber`	string,null
`trackingNumber`	string,null
`trackingNumbers`	array of string or null
`incoterms`	string,null
`weights`	array of string or null
`licensePlateNumber`	string,null
`vinNumber`	string,null
`guestCount`	integer or null
`serverName`	string,null
`storeNumber`	string,null
`vendingPerson`	string,null
`vendingPersonNumber`	string,null
`customerAccountNumber`	string,null
`category`	string,null
`defaultCategory`	string,null
`barcodes`	array of object or null
`paymentLinks`	array of object or null
`folio`	object or null
`enrichedFields`	array of string or null
`check`	object or null
`statement`	object or null
`taxForm`	object or null
`itinerary`	object or null
`fieldConfidence`	map of number
`fieldBoxes`	map of object

confidence required number,null

flags required array of string

warnings required

array of object

Integrity findings. A caller without expenses.read_all sees the arithmetic and dates only.

Fields

`code` required	`tax_rate_mismatch` `item_counts_mismatch` `totals_mismatch` `line_item_amount_mismatch` `line_item_repeats` `barcode_decoding_issue` `barcode_code_missing_in_ocr` `logo_vendor_mismatch` `malware` `weekend_transaction` `time_and_currency_mismatch` `exif_creation_modified_date_mismatch` `missing_date` `suspicious_document_aspect_ratio` `generic_placeholder_content`
`message` required	string
`page`	number,null

fraud required

object or null

Fields

version required string

score required

number

0 to 1, from the signals that fired. Evidence, never a verdict.

color required

green yellow red

Under the workspace yellow threshold is green. Over its red threshold is red.

types required

Signals that fired, most important first.

details required

map of object

By signal: a description, a confidence and typed reasons.

attribution required

string,null

One sentence naming the strongest evidence.

decision required

clear review fraud not_fraud unknown

clear or review until a person decides. Only a person can say fraud.

review required

object or null

Fields

`decision` required	`FRAUD` `NOT_FRAUD` `UNKNOWN`
`types` required	array of `digital_tampering` `fraudulent_pdf` `fraudulent_image` `generated_document` `ai_generated` `lcd_photo` `screenshot` `digital_background` `not_a_document` `duplicate` `similar_documents` `handwritten_characters` `invalid_qr_data` `invalid_mrz_data` `suspicious_content` `data_inconsistency` `vendor_layout_mismatch` `total_in_words_mismatch` `aspect_ratio_mismatch` `high_velocity` `critical_velocity` `multiple_profiles_or_devices` `fraud_history` `blocked_device` `other`
`note` required	string,null
`reviewedBy` required	object or null
`reviewedAt` required	string

deviceId required

string,null

The id the client sent for its device, when it sent one.

submissions required

object or null

Documents from this uploader in this workspace, by window.

Fields

`lastMinutes` required	number
`lastDay` required	number
`lastWeek` required	number
`last2Weeks` required	number
`lastMonth` required	number

deviceProfiles required

array of object

Over 30 days, inside this workspace only.

Fields

`deviceId` required	string
`profileId` required	string
`documentCount` required	number

digitalTamperingFields required array of string

handwriting required

object

What Claude saw written by hand, in dot notation, when a key is set and the handwriting signal is on. With no key, the lists are empty and the flags null: skipped says why.

Fields

`handwrittenFields` required	array of string
`fullyHandwrittenFields` required	array of string
`handwrittenTamperedFields` required	array of string
`handwritingDetected` required	boolean,null
`handwritingTamperingPresent` required	boolean,null

notADocument required

object

Fields

`value` required	boolean,null
`score` required	number,null

digitalBackground required

object

Fields

`value` required	boolean,null
`score` required	number,null

fraudulentPdf required

object or null

Fields

`fraudulentPdfCreator` required	number,null
`textOverlay` required	number,null
`fontMismatch` required	number,null
`hasDigitalSignature` required	boolean,null
`pdfModified` required	number,null
`incrementalUpdates` required	number,null
`incrementalChanges` required	array of string
`incrementalEdits` required	array of object
`signatureCreationTools` required	array of string
`dateInversion` required	number,null
`producerContentMismatch` required	number,null
`writerMismatch` required	number,null
`nullMetadata` required	number,null
`xmpInfoMismatch` required	number,null
`futureMetadataDate` required	number,null
`rasterProfileMismatch` required	number,null
`uncompressedRaster` required	number,null
`splicedPage` required	number,null
`splicedPageNumber` required	number,null
`valueFontSplice` required	number,null
`valueFontSplicePage` required	number,null
`headlessDesktopRender` required	number,null
`headlessRenderPlatform` required	string,null
`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`score` required	number,null

fraudulentImage required

object or null

Fields

`doubleJpeg` required	number,null
`firstQuantizationQuality` required	number,null
`scrubbedProvenance` required	number,null
`editorSignature` required	number,null
`editorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`editorSignatureValue` required	string,null
`generatorSignature` required	number,null
`generatorSignatureField` required	`icc_profile` `exif:Software` `exif:ProcessingSoftware` `xmp:CreatorTool` `png:Software` `jpeg:comment` or null
`generatorSignatureValue` required	string,null
`generatorWriterProfile` required	number,null
`generatorWriterProfileValue` required	string,null
`syntheticRaster` required	number,null
`syntheticRasterFingerprints` required	array of string
`unprofiledPng` required	number,null
`unprofiledWebp` required	number,null
`source` required	`original` `render` or null
`sourceFormats` required	array of string
`unreadableSource` required	number,null
`score` required	number,null

pages required

array of object

Fields

`index` required	number
`isBlurry` required	object
`isLcd` required	object
`screenshot` required	object or null
`aiGenerated` required	object Value null means nothing could say: no pixel model runs, only metadata can answer.
`glare` required	object

skipped required

array of object

Checks that could not run on this file, so a clean result is not read as more than it is.

Fields

`check` required	string
`reason` required	string

sealed required

array of object

Bank and tax numbers read from this document, as masks. POST /v1/documents/{id}/reveal opens them.

Fields

`kind` required	`ROUTING_NUMBER` `ACCOUNT_NUMBER` `MICR_LINE` `SSN` `EIN` `IBAN`
`masked` required	string All but the last few characters are stars. Punctuation stays where it was.
`field` required	string,null
`page` required	number

updatedAt required string

extractor required

string,null

What read it: rules, claude, a blueprint, business-card, or none.

ocrText required

string,null

Everything read off the page. Card, bank and tax numbers are masked.

pdfUrl required

string,null

The PDF as uploaded, signed for 15 minutes. Null for an image, and for a PDF that prints a number only a reveal hands out.

meta required

object

Fields

totalPages required number

processedPages required number

ocrScore required

number,null

The average character confidence of the reading, which doubles as a measure of the image.

originalFileName required string,null

source required WEB IOS ANDROID EMAIL API MAIL_IN INTEGRATION

language required

string,null

BCP-47.

languages required

array of object

Every language found, best first.

Fields

`tag` required	string
`score` required	number

deviceId required string,null

deviceUserUuid required

string,null

The signed-in person the device was capturing for. Null when no device was named.

latitude required number,null

longitude required number,null

sourceDocuments required

array of map of any

Each file as submitted: name, type, size in KB, width, height and EXIF.

owner required

object or null

Who uploaded it.

Fields

`id` required	string
`name` required	string,null

duplicates required

array of object

Near copies past the workspace threshold, best first.

Fields

`id` required	string
`url` required	string
`score` required	number Percent alike.

reviewedAt required

string,null

A person checked what was read.

approvedAt required

string,null

A developer's own approved flag. An expense's approval is a different thing.

DocumentText

`text` required	string,null Everything recognized on the document. Card numbers are already masked.
`language` required	string,null

DownloadableFile

`filename` required	string
`contentType` required	string
`content` required	string

ExpenseDetail

id required string

number required number

reference required string

status required PROCESSING NEEDS_REVIEW READY SUBMITTED APPROVED REJECTED REIMBURSED VOID

kind required RECEIPT MANUAL MILEAGE PER_DIEM TIME CARD

merchantName required string,null

tripTitle required

string,null

For a trip, what to call it in a list.

description required string,null

date required string

currency required string

amountMinor required number

baseAmountMinor required number

taxMinor required number,null

category required

object or null

Fields

`id` required	string
`name` required	string

alsoCategories required

array of object

Further categories it can be found under. Its money stays in category.

Fields

`id` required	string
`name` required	string

project required

object or null

Fields

`id` required	string
`name` required	string
`code` required	string,null

client required

object or null

Fields

`id` required	string
`name` required	string

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

moneyFlow required

IN OUT

Which way the money went.

invoiceNumber required string,null

matched required

boolean

A card charge has been matched to it.

connectedApps required

array of string

Connected services it has been posted to.

reportId required string,null

externalId required

string,null

A developer's own reference, exactly as sent.

billable required boolean

reimbursable required boolean

paymentType required CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

confidence required number,null

flags required

array of object

Fields

`code` required	string
`message` required	string
`severity` required	`info` `warn` `block`
`by`	string Who put it there, where that decides who may take it off.

reviewFields required array of string

thumbnailUrl required string,null

documentId required string,null

tags required

array of object

Fields

`id` required	string
`name` required	string
`color` required	string,null

attendeeCount required number

fxRate required

number

What one unit of the expense currency is worth in the base currency. Zero means no rate is available yet, so baseAmountMinor is zero too and the expense is held in review.

held required

boolean

Held back from its report until someone releases it.

createdAt required string

updatedAt required string

notes required string,null

subtotalMinor required number,null

tipMinor required number,null

discountMinor required number,null

shippingMinor required number,null

paymentAccountId required string,null

cardLast4 required string,null

poNumber required

string,null

The buyer's purchase order number, as an invoice prints it.

dueDate required

string,null

When an invoice falls due.

mcc required

string,null

The merchant category code a card network gave the merchant, four digits.

taxDeductible required boolean

quantity required number,null

rateMinor required number,null

unit required string,null

trip required map of any or null

vehicleId required string,null

attendees required

array of object

Fields

`name` required	string
`email`	string
`phone`	string

customFields required map of any

editedFields required array of string

duplicateOfId required string,null

duplicateReview required

object or null

What the second look at a flagged copy decided, and why.

Fields

`outcome` required	`DISMISSED` `KEPT`
`reason` required	string
`engine` required	`rules` `claude`
`at` required	string

canSettleDuplicate required

boolean

Whether the caller can answer the duplicate question on this expense.

splitParentId required string,null

access required

object

What the caller may do with it.

Fields

`canEdit` required	boolean
`limited` required	boolean Out for approval: only the amount, description, merchant, date, category, tags and attendees can change.
`reason` required	string,null Why it cannot be edited, or how far it can, in words for the person looking at it.
`amountLocked` required	boolean The amount is a card's own figure.
`canDelete` required	boolean
`canRestore` required	boolean
`restoreBlocked` required	string,null Why it cannot be restored: split, or merged, for good.
`canSplit` required	boolean
`canMove` required	boolean

splitInto required

array of object

This expense was divided: its parts now count in its place.

Fields

`id` required	string
`reference` required	string
`amountMinor` required	number

mergedIntoId required

string,null

A merge absorbed this expense. Where it went.

report required

object or null

The report this expense is on, named even where the caller could not list it.

Fields

`id` required	string
`title` required	string
`status` required	string

lines required

array of object

Fields

`id` required	string
`position` required	number
`description` required	string
`sku` required	string,null
`quantity` required	number,null
`unitPriceMinor` required	number,null
`amountMinor` required	number
`taxMinor` required	number,null
`categoryId` required	string,null

documentIds required array of string

ExpensePage

data required

array of object

Fields

id required string

number required number

reference required string

status required PROCESSING NEEDS_REVIEW READY SUBMITTED APPROVED REJECTED REIMBURSED VOID

kind required RECEIPT MANUAL MILEAGE PER_DIEM TIME CARD

merchantName required string,null

tripTitle required

string,null

For a trip, what to call it in a list.

description required string,null

date required string

currency required string

amountMinor required number

baseAmountMinor required number

taxMinor required number,null

category required

object or null

Fields

`id` required	string
`name` required	string

alsoCategories required

array of object

Further categories it can be found under. Its money stays in category.

Fields

`id` required	string
`name` required	string

project required

object or null

Fields

`id` required	string
`name` required	string
`code` required	string,null

client required

object or null

Fields

`id` required	string
`name` required	string

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

moneyFlow required

IN OUT

Which way the money went.

invoiceNumber required string,null

matched required

boolean

A card charge has been matched to it.

connectedApps required

array of string

Connected services it has been posted to.

reportId required string,null

externalId required

string,null

A developer's own reference, exactly as sent.

billable required boolean

reimbursable required boolean

paymentType required CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

confidence required number,null

flags required

array of object

Fields

`code` required	string
`message` required	string
`severity` required	`info` `warn` `block`
`by`	string Who put it there, where that decides who may take it off.

reviewFields required array of string

thumbnailUrl required string,null

documentId required string,null

tags required

array of object

Fields

`id` required	string
`name` required	string
`color` required	string,null

attendeeCount required number

fxRate required

number

What one unit of the expense currency is worth in the base currency.

held required

boolean

Held back from its report until someone releases it.

createdAt required string

updatedAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ExpenseTotals

`count` required	number
`moneyOutMinor` required	number Money out, in the base currency.
`moneyInMinor` required	number Money in, in the base currency: income, refunds and credits, as a positive figure.
`baseAmountMinor` required	number In the workspace's base currency. A credit or a refund is negative, so it brings this down.
`currency` required	string
`unconverted` required	number Counted, but with no exchange rate yet, so they add nothing to the amount.
`totalMinor` required	number `baseAmountMinor` in the currency asked for.
`totalCurrency` required	string
`convertedFrom` required	string,null Set when `totalCurrency` is not the base: the currency it was converted from, at the latest rate.

ExportJob

id required string

kind required expenses report tax mileage receipts documents

format required CSV XLSX PDF ZIP QBO_CSV XERO_CSV SAGE_CSV DYNAMICS_CSV MYOB_TXT ORACLE_CSV SAP_CSV IIF OFX JSON XML TXT XLS

status required EXPIRED FAILED COMPLETED QUEUED RUNNING

filters required

object

Fields

status PROCESSING NEEDS_REVIEW READY SUBMITTED APPROVED REJECTED REIMBURSED VOID or array of PROCESSING NEEDS_REVIEW READY SUBMITTED APPROVED REJECTED REIMBURSED VOID

kind RECEIPT MANUAL MILEAGE PER_DIEM TIME CARD

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

ownerId string

scope mine all

categoryId string

merchantId string

projectId string

clientId string

tagId string

department string

reportId string

externalId string

unreported boolean

needsReview boolean

billable boolean

reimbursable boolean

moneyFlow IN OUT

dateField date createdAt updatedAt submittedAt approvedAt

from string

to string

minMinor integer

maxMinor integer

q string

ids array of string

year integer

reportState DRAFT SUBMITTED APPROVED REJECTED REIMBURSED EXPORTED CLOSED or array of DRAFT SUBMITTED APPROVED REJECTED REIMBURSED EXPORTED CLOSED

reportIds array of string

startDate string

endDate string

approvedAfter string

exported boolean

categoryIds array of string

documentIds array of string

documentTypes array of RECEIPT INVOICE BILL BANK_STATEMENT CHECK TAX_FORM BUSINESS_CARD OTHER UNKNOWN PURCHASE_ORDER CONTRACT PACKING_SLIP REMITTANCE_ADVICE CREDIT_NOTE STATEMENT

policyIds array of string

approvalLinkId string

columns

array of object

Fields

`key` required	string
`label`	string
`formula`	string

columnSet simple detailed

preset basic all_data_expense all_data_report canadian_multiple_tax category per_diem tag tax_report

view

object

Fields

level expense report

columns required

array of object

Fields

`key` required	string
`label`	string

sort date:asc date:desc merchant:asc merchant:desc category:asc category:desc status:asc status:desc amount:asc amount:desc

groupBy category merchant member project status month

groupsOnly boolean

notifyRequester boolean

fullPageReceipts boolean

template string

emailMessage string

delimiter , ; |

bom boolean

recipients array of string (email)

scheduledReportId string

scheduledReportName string

notes array of string

filename required string,null

rowCount required number,null

error required

string,null

Why it failed, written for a person.

notes required

array of string

What a finished file left out, such as credits a bill import cannot take.

requestedBy required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

onFinish required

object or null

How the actions the export asked for went. Null when it asked for none.

Fields

markAsExported required

object or null

Fields

state required PENDING DONE FAILED SKIPPED

marked required

array of string

The reports this export marked, by reference.

skipped required

array of object

The reports it left as they were, and why.

Fields

`reference` required	string
`reason` required	string

error required string,null

sftpUpload required

object or null

Where the file went. The credentials are never returned.

Fields

`state` required	`PENDING` `DONE` `FAILED` `SKIPPED`
`host` required	string
`port` required	number
`path` required	string
`attempts` required	number
`file` required	string,null Where the file landed on the server.
`error` required	string,null
`uploadedAt` required	string,null

createdAt required string

completedAt required string,null

expiresAt required string,null

downloadUrl required

string,null

Signed, valid for 15 minutes. Null until the file is ready and after it expires.

ExportJobPage

data required

array of object

Fields

id required string

kind required expenses report tax mileage receipts documents

format required CSV XLSX PDF ZIP QBO_CSV XERO_CSV SAGE_CSV DYNAMICS_CSV MYOB_TXT ORACLE_CSV SAP_CSV IIF OFX JSON XML TXT XLS

status required EXPIRED FAILED COMPLETED QUEUED RUNNING

filters required

object

Fields

kind RECEIPT MANUAL MILEAGE PER_DIEM TIME CARD

paymentType CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER

ownerId string

scope mine all

categoryId string

merchantId string

projectId string

clientId string

tagId string

department string

reportId string

externalId string

unreported boolean

needsReview boolean

billable boolean

reimbursable boolean

moneyFlow IN OUT

dateField date createdAt updatedAt submittedAt approvedAt

from string

to string

minMinor integer

maxMinor integer

q string

ids array of string

year integer

reportState DRAFT SUBMITTED APPROVED REJECTED REIMBURSED EXPORTED CLOSED or array of DRAFT SUBMITTED APPROVED REJECTED REIMBURSED EXPORTED CLOSED

reportIds array of string

startDate string

endDate string

approvedAfter string

exported boolean

categoryIds array of string

documentIds array of string

policyIds array of string

approvalLinkId string

columns

array of object

Fields

`key` required	string
`label`	string
`formula`	string

columnSet simple detailed

preset basic all_data_expense all_data_report canadian_multiple_tax category per_diem tag tax_report

view

object

Fields

`level`	`expense` `report`
`columns` required	array of object
`sort`	`date:asc` `date:desc` `merchant:asc` `merchant:desc` `category:asc` `category:desc` `status:asc` `status:desc` `amount:asc` `amount:desc`
`groupBy`	`category` `merchant` `member` `project` `status` `month`
`groupsOnly`	boolean

notifyRequester boolean

fullPageReceipts boolean

template string

emailMessage string

delimiter , ; |

bom boolean

recipients array of string (email)

scheduledReportId string

scheduledReportName string

notes array of string

filename required string,null

rowCount required number,null

error required

string,null

Why it failed, written for a person.

notes required

array of string

What a finished file left out, such as credits a bill import cannot take.

requestedBy required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

onFinish required

object or null

How the actions the export asked for went. Null when it asked for none.

Fields

markAsExported required

object or null

Fields

`state` required	`PENDING` `DONE` `FAILED` `SKIPPED`
`marked` required	array of string The reports this export marked, by reference.
`skipped` required	array of object The reports it left as they were, and why.
`error` required	string,null

sftpUpload required

object or null

Where the file went. The credentials are never returned.

Fields

`state` required	`PENDING` `DONE` `FAILED` `SKIPPED`
`host` required	string
`port` required	number
`path` required	string
`attempts` required	number
`file` required	string,null Where the file landed on the server.
`error` required	string,null
`uploadedAt` required	string,null

createdAt required string

completedAt required string,null

expiresAt required string,null

downloadUrl required

string,null

Signed, valid for 15 minutes. Null until the file is ready and after it expires.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Folder

`id` required	string
`parentId` required	string,null
`name` required	string
`documentCount` required	number

FolderPage

data required

array of object

Fields

`id` required	string
`parentId` required	string,null
`name` required	string
`documentCount` required	number

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Hold

id required string

held required boolean

flags required

array of object

Fields

`code` required	string
`message` required	string
`severity` required	`info` `warn` `block`
`by`	string Who put it there, where that decides who may take it off.

Reached

reached required

array of string

Who can read it now and has been told.

Merchant

id required string

name required string

defaultCategoryId required string,null

website required string,null

phone required string,null

address required string,null

taxId required string,null

is1099 required boolean

merchantType required

airline lodging car_rental ground_transport fuel dining grocery office software utilities supplies other or null

What kind of business this is. Null lets a rule work it out from the card code or the name.

expenseCount required number

totalMinor required

number

Non-void expenses, in the workspace's base currency.

aliases required

array of object

Other spellings that file here: left by a merge or a rename.

Fields

`id` required	string
`name` required	string

MerchantPage

data required

array of object

Fields

id required string

name required string

defaultCategoryId required string,null

website required string,null

phone required string,null

address required string,null

taxId required string,null

is1099 required boolean

merchantType required

airline lodging car_rental ground_transport fuel dining grocery office software utilities supplies other or null

What kind of business this is. Null lets a rule work it out from the card code or the name.

expenseCount required number

totalMinor required

number

Non-void expenses, in the workspace's base currency.

aliases required

array of object

Other spellings that file here: left by a merge or a rename.

Fields

`id` required	string
`name` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

MileageLog

from required string

to required string

rows required

array of object

Fields

expenseId required string

reference required string

status required string

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

date required string

purpose required string

origin required string

stops required

array of string

Places along the way.

destination required string

originLabel required

string,null

The name of a saved place at this address, such as Home.

destinationLabel required string,null

departed required

string,null

HH:MM.

arrived required

string,null

HH:MM.

distance required number

unit required string

calculation required

string

How the amount was reached: 8.1 mi x $0.76/mi = $6.16.

purposeKind required

business medical charity

What the trip was for, by the rate it took.

roundTrip required boolean

odometerStart required number,null

odometerEnd required number,null

odometerPhotos required

object

Documents holding a photo of each reading, and the one image they are merged into.

Fields

`start` required	string,null
`end` required	string,null
`merged` required	string,null

receiptDocumentId required

string,null

The generated mileage receipt.

vehicle required

object or null

Fields

`id` required	string
`name` required	string
`plate` required	string,null

rateMinor required

number

A hundredth of a cent per unit.

rateName required string,null

amountMinor required number

currency required string

entry required

MANUAL ODOMETER MAP GPS

How the distance came to be known. Only MAP and GPS were measured.

driven required

number

The whole drive. distance is what is claimed, which is less when a commute came off it.

commuteExcluded required

number,null

The commute taken off this trip, or null if none was.

taxMinor required

number,null

The tax on this trip, when its workspace tracks tax on distance.

currency required string

totals required

object

Fields

trips required number

amountMinor required number

distances required

array of object

Fields

`unit` required	string
`distance` required	number

months required

array of object

Fields

`month` required	string YYYY-MM.
`trips` required	number
`amountMinor` required	number

tally required

object or null

Where the person stands against a yearly limit, for a rate that drops after it.

Fields

`year` required	number
`distance` required	number
`limit` required	number
`unit` required	string
`remaining` required	number

MileageRate

`id` required	string
`name` required	string
`unit` required	`mi` `km`
`rateMinor` required	number A hundredth of a cent per unit, so 72.5 cents is 7250.
`currency` required	string
`effectiveFrom` required	string
`effectiveTo` required	string,null The last day this rate covers. Null runs until a newer rate of the same name.
`isDefault` required	boolean
`archived` required	boolean
`taxBasisPoints` required	number,null Tax on the reclaimable part, in hundredths of a percent. 2000 is 20%. Used while the workspace tracks tax on distance.
`taxReclaimableMinor` required	number,null The fixed part of this rate tax can be reclaimed on, at the same scale as rateMinor.
`autoGenerated` required	boolean The government-rate job added this row, and no admin has changed its amount, start or end.

MileageRatePage

data required

array of object

Fields

`id` required	string
`name` required	string
`unit` required	`mi` `km`
`rateMinor` required	number A hundredth of a cent per unit, so 72.5 cents is 7250.
`currency` required	string
`effectiveFrom` required	string
`effectiveTo` required	string,null The last day this rate covers. Null runs until a newer rate of the same name.
`isDefault` required	boolean
`archived` required	boolean
`taxBasisPoints` required	number,null Tax on the reclaimable part, in hundredths of a percent. 2000 is 20%. Used while the workspace tracks tax on distance.
`taxReclaimableMinor` required	number,null The fixed part of this rate tax can be reclaimed on, at the same scale as rateMinor.
`autoGenerated` required	boolean The government-rate job added this row, and no admin has changed its amount, start or end.

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

PerDiemRate

`id` required	string
`name` required	string
`country` required	string,null
`region` required	string,null
`amountMinor` required	number
`currency` required	string
`archived` required	boolean

PerDiemRatePage

data required

array of object

Fields

`id` required	string
`name` required	string
`country` required	string,null
`region` required	string,null
`amountMinor` required	number
`currency` required	string
`archived` required	boolean

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Project

`id` required	string
`name` required	string
`code` required	string,null
`clientId` required	string,null
`clientName` required	string,null
`budgetMinor` required	number,null
`spentMinor` required	number Non-void expenses, in the workspace's base currency.
`expenseCount` required	number
`archived` required	boolean

ProjectPage

data required

array of object

Fields

`id` required	string
`name` required	string
`code` required	string,null
`clientId` required	string,null
`clientName` required	string,null
`budgetMinor` required	number,null
`spentMinor` required	number Non-void expenses, in the workspace's base currency.
`expenseCount` required	number
`archived` required	boolean

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ReportDetail

purpose required string,null

rejectionReason required string,null

rejectedAt required string,null

reimbursedAt required string,null

exportedAt required string,null

expenses required

array of object

Fields

id required string

number required number

reference required string

status required PROCESSING NEEDS_REVIEW READY SUBMITTED APPROVED REJECTED REIMBURSED VOID

kind required RECEIPT MANUAL MILEAGE PER_DIEM TIME CARD

merchantName required string,null

tripTitle required

string,null

For a trip, what to call it in a list.

description required string,null

date required string

currency required string

amountMinor required number

baseAmountMinor required number

taxMinor required number,null

category required

object or null

Fields

`id` required	string
`name` required	string

alsoCategories required

array of object

Further categories it can be found under. Its money stays in category.

Fields

`id` required	string
`name` required	string

project required

object or null

Fields

`id` required	string
`name` required	string
`code` required	string,null

client required

object or null

Fields

`id` required	string
`name` required	string

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

moneyFlow required

IN OUT

Which way the money went.

invoiceNumber required string,null

matched required

boolean

A card charge has been matched to it.

connectedApps required

array of string

Connected services it has been posted to.

reportId required string,null

externalId required

string,null

A developer's own reference, exactly as sent.

billable required boolean

reimbursable required boolean

paymentType required CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

confidence required number,null

flags required

array of object

Fields

`code` required	string
`message` required	string
`severity` required	`info` `warn` `block`
`by`	string Who put it there, where that decides who may take it off.

reviewFields required array of string

thumbnailUrl required string,null

documentId required string,null

tags required

array of object

Fields

`id` required	string
`name` required	string
`color` required	string,null

attendeeCount required number

fxRate required

number

What one unit of the expense currency is worth in the base currency.

held required

boolean

Held back from its report until someone releases it.

createdAt required string

updatedAt required string

findings required

array of object

Fields

`code` required	`POLICY_VIOLATION`
`ruleId` required	string
`type` required	`MAX_AMOUNT` `DAILY_LIMIT` `RECEIPT_REQUIRED` `MAX_AGE_DAYS` `CATEGORY_REQUIRED` `PROJECT_REQUIRED` `DESCRIPTION_REQUIRED` `ATTENDEES_REQUIRED` `PROHIBITED` `WEEKEND_SPEND` `ITEMIZED_RECEIPT_REQUIRED` `TAG_REQUIRED` `FUTURE_DATE` `COMPANY_CARD_REQUIRED` `PROHIBITED_ITEM` `ATTENDEE_LIMIT` `RECEIPT_MISMATCH` `BILLABLE_NOT_ALLOWED` `CONVERSION_SURCHARGE` `RATE_OUT_OF_POLICY` `DISTANCE_INCREASED` `NO_ROUTE` `INACTIVE_VENDOR` `OVER_AUTO_APPROVAL` `TAG_OUT_OF_POLICY` `TAX_OUT_OF_POLICY` `TAX_REQUIRED` `AI_GENERATED_RECEIPT` `TRIP_LIMIT` `FRINGE_BENEFITS`
`severity` required	`WARN` `BLOCK_SUBMIT` `WAIVE`
`expenseId` required	string
`expenseReference` required	string
`message` required	string
`reviewerOnly`	boolean Evidence for a reviewer. It never reaches the person who uploaded the receipt.

approvals required

array of object

Fields

id required string

level required number

approver required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

actedBy required

object or null

Set when someone else acted for the approver.

Fields

`id` required	string
`name` required	string,null
`email` required	string

state required APPROVED REJECTED PENDING SKIPPED WAITING

comment required string,null

decidedAt required string,null

participants required

array of object

People added to the report. They can read it and comment, nothing more.

Fields

`id` required	string
`name` required	string,null
`email` required	string

fields required

array of object

Fields

`id` required	string
`name` required	string
`type` required	`TEXT` `DATE` `LIST` `FORMULA`
`options` required	array of string
`formula` required	string,null
`required` required	boolean
`enabled` required	boolean
`position` required	number
`disabledOptions`	array of string List values turned off: kept on reports that hold them, and not offered for new ones.
`imported`	boolean Came from the connected books, so it cannot be deleted and its values only turn on and off.
`value` required	string,null

titleLocked required

boolean

True when a title typed here would be refused: the workspace's formula sets it.

noApprovalStep required

boolean

Submitting needs nobody's approval, so it finishes the report.

exportable required

boolean

This person can export this report or share it. Someone added only to read and comment cannot.

ccEmails required

array of string

Addresses outside the workspace copied on each submission.

canPickApprover required

boolean

A draft whose workflow leaves the next approver open, so the person submitting can name one.

canSendOutside required

boolean

A draft in a workspace with nobody else to approve it, which can go to someone outside instead.

outsideApprover required

object or null

Someone with no account has this report, through a link. A null email is a link that went out on a PDF.

Fields

`email` required	string,null
`expiresAt` required	string

expenseColumns required

map of object

What the expense table's optional columns read, by expense id.

customFieldLabels required

object

The workspace's first two custom fields, which the Custom field 1 and 2 columns show.

Fields

`first` required	string,null
`second` required	string,null

withdrawalId required

string,null

The batch that pays this report.

internationalReimbursementId required

string,null

The same, where the batch pays in another currency than the workspace's.

final required

boolean

Nothing more is due: paid, or approved with nothing to pay, or done.

findingsAccepted required

object or null

Someone has reviewed and accepted what the receipt checks found.

Fields

by required

object or null

Fields

`id` required	string
`name` required	string,null
`email` required	string

at required string

auditNote required

string,null

What the receipt audit did on this report, on a plan that has it. There even when it found nothing.

needsAcceptance required

boolean

Receipt checks found something, and approving this report has to wait for someone to accept it.

timeline required

array of object

Fields

id required string

action required string

actor required

object or null

Null when PaperTotal did it on a schedule.

Fields

`id` required	string
`name` required	string,null
`email` required	string

onBehalfOf required

object or null

The person whose name this was done in, when the actor was covering for them.

Fields

`id` required	string
`name` required	string,null
`email` required	string

detail required

string,null

The reason, comment or note that came with the action.

metadata required map of any

at required string

heldExpenseIds required array of string

actions required array of delete approve submit retract reject reopen close mark_exported mark_reimbursed edit reassign duplicate invite accept_findings received_payment

selfApproval required

boolean

True when the caller's approval would be a self-approval the workspace allows.

deciding required

boolean

The caller holds a step that is live now, for themselves or as a delegate. Without one, a workspace admin has to bypass.

id required string

number required number

reference required string

title required string

status required DRAFT SUBMITTED APPROVED REJECTED REIMBURSED EXPORTED CLOSED

stage required DRAFT SUBMITTED OUTSTANDING APPROVED REJECTED PAID EXPORTED DONE

paymentStage required MARKED_AS_PAID WITHDRAWING CONFIRMED or null

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

currency required string

totalMinor required number

reimbursableMinor required number

expenseCount required number

findingCount required number

periodStart required string,null

periodEnd required string,null

autoCreated required boolean

waitingOn required

array of object

Who the report is with right now.

Fields

`id` required	string
`name` required	string,null
`email` required	string

submittedAt required string,null

approvedAt required string,null

createdAt required string

updatedAt required string

ReportPage

data required

array of object

Fields

id required string

number required number

reference required string

title required string

status required DRAFT SUBMITTED APPROVED REJECTED REIMBURSED EXPORTED CLOSED

stage required

DRAFT SUBMITTED OUTSTANDING APPROVED REJECTED PAID EXPORTED DONE

Submitted until someone has acted on it. Outstanding once it is part way: under review, with a hold, or partly approved.

paymentStage required MARKED_AS_PAID WITHDRAWING CONFIRMED or null

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

currency required string

totalMinor required number

reimbursableMinor required number

expenseCount required number

findingCount required number

periodStart required string,null

periodEnd required string,null

autoCreated required boolean

waitingOn required

array of object

Who the report is with right now.

Fields

`id` required	string
`name` required	string,null
`email` required	string

submittedAt required string,null

approvedAt required string,null

createdAt required string

updatedAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Tag

`id` required	string
`name` required	string
`groupName` required	string,null
`glCode` required	string,null
`color` required	string,null
`archived` required	boolean
`expenseCount` required	number
`approverId` required	string,null Reviews any report carrying this tag, after any category approvers and ahead of the workflow.
`approverName` required	string,null
`parentId` required	string,null The tag this one sits under. An expense carrying this one has to carry that one too.
`parentName` required	string,null

TagPage

data required

array of object

Fields

`id` required	string
`name` required	string
`groupName` required	string,null
`glCode` required	string,null
`color` required	string,null
`archived` required	boolean
`expenseCount` required	number
`approverId` required	string,null Reviews any report carrying this tag, after any category approvers and ahead of the workflow.
`approverName` required	string,null
`parentId` required	string,null The tag this one sits under. An expense carrying this one has to carry that one too.
`parentName` required	string,null

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

TaxSummary

year required number

from required string

to required string

fiscalYearStartMonth required number

currency required string

notice required string

mileageNotice required string

lines required

array of object

Fields

line required

string

The Schedule C line: "9", "24b".

label required string

count required number

spentMinor required number

deductibleMinor required number

categories required

array of object

Fields

`id` required	string
`name` required	string
`deductiblePct` required	number
`count` required	number
`spentMinor` required	number
`deductibleMinor` required	number

mileage required

array of object

Fields

`unit` required	string
`trips` required	number
`distance` required	number
`deductionMinor` required	number

unassigned required

object

Spending on a category with no tax line, or on no category.

Fields

`count` required	number
`spentMinor` required	number

excluded required

object

Expenses a person marked as not deductible.

Fields

`count` required	number
`spentMinor` required	number

payees required

object

1099s follow the calendar year whatever the fiscal year, so this has its own dates.

Fields

from required string

to required string

rows required

array of object

Fields

`merchantId` required	string
`name` required	string
`count` required	number
`totalMinor` required	number
`cardMinor` required	number Paid by card. Card payments are reported by the processor, so a preparer usually sets these aside.
`taxIdOnFile` required	boolean Whether a tax id is on file. The number itself is never shown or exported.

needsReview required

number

Counted above, but a person has not confirmed them yet.

unconverted required

number

Expenses with no exchange rate yet. They are not in these figures.

spentMinor required number

deductibleMinor required number

TravelTrip

id required string

ownerId required string

name required string

origin required string,null

destination required string,null

departsOn required

string

YYYY-MM-DD.

returnsOn required

string,null

YYYY-MM-DD.

merchantName required string,null

bookingReference required string,null

currency required string,null

totalMinor required

number,null

In minor units of the currency: 1250 is 12.50.

segments required

array of object

Flights, stays, cars and trains, in order.

Fields

`kind` required	`flight` `hotel` `car` `rail` `other`
`carrier`	string,null
`number`	string,null
`from`	string,null
`to`	string,null
`departsAt`	string,null
`arrivesAt`	string,null
`confirmationNumber`	string,null
`seat`	string,null

documentIds required

array of string

The itinerary and the receipts filed against this trip.

createdAt required string

updatedAt required string

TravelTripPage

data required

array of object

Fields

id required string

ownerId required string

name required string

origin required string,null

destination required string,null

departsOn required

string

YYYY-MM-DD.

returnsOn required

string,null

YYYY-MM-DD.

merchantName required string,null

bookingReference required string,null

currency required string,null

totalMinor required

number,null

In minor units of the currency: 1250 is 12.50.

segments required

array of object

Flights, stays, cars and trains, in order.

Fields

`kind` required	`flight` `hotel` `car` `rail` `other`
`carrier`	string,null
`number`	string,null
`from`	string,null
`to`	string,null
`departsAt`	string,null
`arrivesAt`	string,null
`confirmationNumber`	string,null
`seat`	string,null

documentIds required

array of string

The itinerary and the receipts filed against this trip.

createdAt required string

updatedAt required string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

Trip

expenseId required string

reference required string

status required string

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

date required string

purpose required string

origin required string

stops required

array of string

Places along the way.

destination required string

originLabel required

string,null

The name of a saved place at this address, such as Home.

destinationLabel required string,null

departed required

string,null

HH:MM.

arrived required

string,null

HH:MM.

distance required number

unit required string

calculation required

string

How the amount was reached: 8.1 mi x $0.76/mi = $6.16.

purposeKind required

business medical charity

What the trip was for, by the rate it took.

roundTrip required boolean

odometerStart required number,null

odometerEnd required number,null

odometerPhotos required

object

Documents holding a photo of each reading, and the one image they are merged into.

Fields

`start` required	string,null
`end` required	string,null
`merged` required	string,null

receiptDocumentId required

string,null

The generated mileage receipt.

vehicle required

object or null

Fields

`id` required	string
`name` required	string
`plate` required	string,null

rateMinor required

number

A hundredth of a cent per unit.

rateName required string,null

amountMinor required number

currency required string

entry required

MANUAL ODOMETER MAP GPS

How the distance came to be known. Only MAP and GPS were measured.

driven required

number

The whole drive. distance is what is claimed, which is less when a commute came off it.

commuteExcluded required

number,null

The commute taken off this trip, or null if none was.

taxMinor required

number,null

The tax on this trip, when its workspace tracks tax on distance.

TripRoutes

array of object

`origin` required	string
`stops` required	array of string
`destination` required	string
`distance` required	number One way, as it would be typed.
`unit` required	string
`roundTrip` required	boolean
`lastDriven` required	string
`uses` required	number

ExpenseDetails

array of object

id required string

number required number

reference required string

status required PROCESSING NEEDS_REVIEW READY SUBMITTED APPROVED REJECTED REIMBURSED VOID

kind required RECEIPT MANUAL MILEAGE PER_DIEM TIME CARD

merchantName required string,null

tripTitle required

string,null

For a trip, what to call it in a list.

description required string,null

date required string

currency required string

amountMinor required number

baseAmountMinor required number

taxMinor required number,null

category required

object or null

Fields

`id` required	string
`name` required	string

alsoCategories required

array of object

Further categories it can be found under. Its money stays in category.

Fields

`id` required	string
`name` required	string

project required

object or null

Fields

`id` required	string
`name` required	string
`code` required	string,null

client required

object or null

Fields

`id` required	string
`name` required	string

owner required

object

Fields

`id` required	string
`name` required	string,null
`email` required	string

moneyFlow required

IN OUT

Which way the money went.

invoiceNumber required string,null

matched required

boolean

A card charge has been matched to it.

connectedApps required

array of string

Connected services it has been posted to.

reportId required string,null

externalId required

string,null

A developer's own reference, exactly as sent.

billable required boolean

reimbursable required boolean

paymentType required CASH PERSONAL_CARD COMPANY_CARD BANK_TRANSFER CHECK PAYPAL OTHER or null

confidence required number,null

flags required

array of object

Fields

`code` required	string
`message` required	string
`severity` required	`info` `warn` `block`
`by`	string Who put it there, where that decides who may take it off.

reviewFields required array of string

thumbnailUrl required string,null

documentId required string,null

tags required

array of object

Fields

`id` required	string
`name` required	string
`color` required	string,null

attendeeCount required number

fxRate required

number

What one unit of the expense currency is worth in the base currency. Zero means no rate is available yet, so baseAmountMinor is zero too and the expense is held in review.

held required

boolean

Held back from its report until someone releases it.

createdAt required string

updatedAt required string

notes required string,null

subtotalMinor required number,null

tipMinor required number,null

discountMinor required number,null

shippingMinor required number,null

paymentAccountId required string,null

cardLast4 required string,null

poNumber required

string,null

The buyer's purchase order number, as an invoice prints it.

dueDate required

string,null

When an invoice falls due.

mcc required

string,null

The merchant category code a card network gave the merchant, four digits.

taxDeductible required boolean

quantity required number,null

rateMinor required number,null

unit required string,null

trip required map of any or null

vehicleId required string,null

attendees required

array of object

Fields

`name` required	string
`email`	string
`phone`	string

customFields required map of any

editedFields required array of string

duplicateOfId required string,null

duplicateReview required

object or null

What the second look at a flagged copy decided, and why.

Fields

`outcome` required	`DISMISSED` `KEPT`
`reason` required	string
`engine` required	`rules` `claude`
`at` required	string

canSettleDuplicate required

boolean

Whether the caller can answer the duplicate question on this expense.

splitParentId required string,null

access required

object

What the caller may do with it.

Fields

`canEdit` required	boolean
`limited` required	boolean Out for approval: only the amount, description, merchant, date, category, tags and attendees can change.
`reason` required	string,null Why it cannot be edited, or how far it can, in words for the person looking at it.
`amountLocked` required	boolean The amount is a card's own figure.
`canDelete` required	boolean
`canRestore` required	boolean
`restoreBlocked` required	string,null Why it cannot be restored: split, or merged, for good.
`canSplit` required	boolean
`canMove` required	boolean

splitInto required

array of object

This expense was divided: its parts now count in its place.

Fields

`id` required	string
`reference` required	string
`amountMinor` required	number

mergedIntoId required

string,null

A merge absorbed this expense. Where it went.

report required

object or null

The report this expense is on, named even where the caller could not list it.

Fields

`id` required	string
`title` required	string
`status` required	string

lines required

array of object

Fields

`id` required	string
`position` required	number
`description` required	string
`sku` required	string,null
`quantity` required	number,null
`unitPriceMinor` required	number,null
`amountMinor` required	number
`taxMinor` required	number,null
`categoryId` required	string,null

documentIds required array of string

Vehicle

`id` required	string
`userId` required	string
`ownerName` required	string,null
`name` required	string
`plate` required	string,null
`archived` required	boolean
`expenseCount` required	number

VehiclePage

data required

array of object

Fields

`id` required	string
`userId` required	string
`ownerName` required	string,null
`name` required	string
`plate` required	string,null
`archived` required	boolean
`expenseCount` required	number

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ApiKeyVerification

`id` required	string
`name` required	string
`prefix` required	string The first characters of the key.
`kind` required	`PERSONAL` `WORKSPACE` PERSONAL acts as the person who made it and ends when they leave. WORKSPACE belongs to the workspace and outlives them.
`environment` required	`LIVE` `TEST`
`workspaceId` required	string
`scopes` required	array of string Every scope this key holds right now.
`fullAccess` required	boolean Every scope, present and future.
`role` required	string The role its reach is measured against: a scope opens a route, and the role decides what the route may do.
`signingRequired` required	boolean A request with no valid signature is refused.
`expiresAt` required	string,null

ClientCertificate

`id` required	string
`name` required	string
`fingerprint` required	string SHA-256 of the certificate, lowercase hex.
`subject` required	string,null
`notAfter` required	string,null
`revokedAt` required	string,null
`createdAt` required	string

ClientCertificatePage

data required

array of object

Fields

`id` required	string
`name` required	string
`fingerprint` required	string SHA-256 of the certificate, lowercase hex.
`subject` required	string,null
`notAfter` required	string,null
`revokedAt` required	string,null
`createdAt` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

ReleaseNotePage

data required

array of object

Fields

`id` required	string
`version` required	string
`product` required	`app_web` `api` `mcp` `model_document_extraction` `model_bank_statements` `model_checks` `model_fraud_detection`
`environments` required	array of `production` `sandbox`
`title` required	string
`body` required	string
`publishedAt` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

WebhookDelivery

`id` required	string
`endpointId` required	string
`eventId` required	string
`eventType` required	string
`state` required	`FAILED` `PENDING` `DELIVERED` `ABANDONED`
`attempts` required	number
`responseStatus` required	number,null
`responseBody` required	string,null
`nextAttemptAt` required	string,null
`deliveredAt` required	string,null
`createdAt` required	string
`payload` required	any

WebhookDeliveryPage

data required

array of object

Fields

`id` required	string
`endpointId` required	string
`eventId` required	string
`eventType` required	string
`state` required	`FAILED` `PENDING` `DELIVERED` `ABANDONED`
`attempts` required	number
`responseStatus` required	number,null
`responseBody` required	string,null
`nextAttemptAt` required	string,null
`deliveredAt` required	string,null
`createdAt` required	string
`payload` required	any

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

WebhookEndpoint

`status` required	`PENDING` `CONFIRMED` PENDING receives the subscription event and nothing else, until POST /v1/webhooks/confirm.
`pendingUntil` required	string,null A pending endpoint not confirmed by then is deleted.
`confirmedAt` required	string,null
`apiKeyId` required	string,null Set when this endpoint belongs to one API key rather than the workspace.
`id` required	string
`url` required	string
`description` required	string,null
`events` required	array of string
`enabled` required	boolean
`failureCount` required	number
`disabledAt` required	string,null Set while the endpoint is off.
`createdAt` required	string

WebhookEndpointPage

data required

array of object

Fields

`status` required	`PENDING` `CONFIRMED` PENDING receives the subscription event and nothing else, until POST /v1/webhooks/confirm.
`pendingUntil` required	string,null A pending endpoint not confirmed by then is deleted.
`confirmedAt` required	string,null
`apiKeyId` required	string,null Set when this endpoint belongs to one API key rather than the workspace.
`id` required	string
`url` required	string
`description` required	string,null
`events` required	array of string
`enabled` required	boolean
`failureCount` required	number
`disabledAt` required	string,null Set while the endpoint is off.
`createdAt` required	string

nextCursor required

string,null

Pass as cursor for the next page. Null on the last one.

WebhookEndpointWithSecret

`status` required	`PENDING` `CONFIRMED` PENDING receives the subscription event and nothing else, until POST /v1/webhooks/confirm.
`pendingUntil` required	string,null A pending endpoint not confirmed by then is deleted.
`confirmedAt` required	string,null
`apiKeyId` required	string,null Set when this endpoint belongs to one API key rather than the workspace.
`secret` required	string
`id` required	string
`url` required	string
`description` required	string,null
`events` required	array of string
`enabled` required	boolean
`failureCount` required	number
`disabledAt` required	string,null Set while the endpoint is off.
`createdAt` required	string

WebhookEventPayload

`id` required	string Stable across retries, so a repeat can be ignored.
`type` required	string
`createdAt` required	string
`data` required	map of any