API reference › Finance › Documents

Acknowledge receipt or payment on a portal finance document

POST /v1/finance/acknowledge

Scope
finance:write

Portal-only (client/provider). kind=receipt for invoice/pro_forma; kind=payment for payable. Idempotent: already-acknowledged returns 200 with existing fields. Wrong owner returns 404; admin/scheduler returns 403.

Parameters

None of its own.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
type requiredstring

One of: invoice, pro_forma, payable. Example invoice.

document_id requiredstring

Example INV-001.

kind requiredstring

One of: receipt, payment. Example receipt.

Example

JSON
{
  "type": "invoice",
  "document_id": "INV-001",
  "kind": "receipt"
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/finance/acknowledge" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"type":"invoice","document_id":"INV-001","kind":"receipt"}'

Try it

Responses

200 Acknowledged (or already acknowledged)

Acknowledged (or already acknowledged)

JSON
{
  "success": true,
  "message": "Receipt acknowledged.",
  "data": {
    "already_acknowledged": false,
    "acknowledged_at": "2026-01-15 09:00:00",
    "acknowledged_by": "USR-1"
  }
}
Response fields (6)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Receipt acknowledged..

dataobject
data.already_acknowledgedboolean

Example false.

data.acknowledged_atstring (date-time)

Example 2026-01-15 09:00:00.

data.acknowledged_bystring

Example USR-1.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Non-portal role

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'finance:write' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'finance:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Not found or not owned

JSON
{
  "success": false,
  "message": "The requested resource could not be found.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The requested resource could not be found..

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

Example .

422 Validation failed

Not eligible

JSON
{
  "status": "error",
  "message": "Unable to save. Please check the highlighted fields",
  "errors": {
    "name": [
      "Please enter a name."
    ],
    "email": [
      "The email has already been taken."
    ]
  }
}
429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.