Skip to main content
PATCH
/
invoices
/
{invoiceId}
cURL
curl --request PATCH \
  --url https://api.useanima.sh/v1/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {}
}'
{
  "id": "<string>",
  "orgId": "<string>",
  "agentId": "<string>",
  "messageId": "<string>",
  "vendor": "<string>",
  "invoiceNumber": "<string>",
  "amountCents": 123,
  "currency": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "paymentLink": "<string>",
  "confidence": 123,
  "evidence": {},
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

invoiceId
string
required

Invoice identifier to update

Body

application/json

Input for updating an invoice status or metadata

status
enum<string>

New processing status for the invoice

Available options:
detected,
confirmed,
rejected,
paid,
reconciled
metadata
object

Metadata fields to merge into the invoice record

Response

200 - application/json

OK

Detected invoice record with extraction details

id
string
required

Unique invoice identifier

orgId
string
required

Organization the invoice belongs to

agentId
string | null
required

Agent that detected the invoice, if applicable

messageId
string
required

Source message identifier the invoice was extracted from

vendor
string | null
required

Vendor or supplier name

invoiceNumber
string | null
required

Vendor-assigned invoice number

amountCents
integer | null
required

Invoice amount in cents

currency
string
required

ISO 4217 currency code

dueDate
string<date-time> | null
required

Payment due date

URL for online payment, if available

confidence
number
required

Detection confidence score between 0 and 1

evidence
object
required

Structured evidence supporting the invoice detection

status
enum<string>
required

Current invoice processing status

Available options:
detected,
confirmed,
rejected,
paid,
reconciled
metadata
object
required

Additional metadata and extracted fields

createdAt
string<date-time>
required

Timestamp when the invoice was first detected

updatedAt
string<date-time>
required

Timestamp when the invoice was last updated