API reference › Finance › Invoices

Mark invoice as viewed

PATCH /v1/finance/invoices/{id}/mark-viewed

Scope
finance:edit
Roles
admin, scheduler

Updates the invoice status to 'Viewed' when a client views the invoice.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Invoice ID

Example INV-1T4MQI.

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

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/finance/invoices/{id}/mark-viewed" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Invoice marked as viewed successfully

Invoice marked as viewed successfully

JSON
{
  "success": true,
  "message": "Invoice marked as viewed."
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Invoice marked as viewed..

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

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'finance:edit' 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:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Invoice not found

JSON
{
  "success": false,
  "message": "Invoice not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invoice not found..

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.

500 Server error

Unexpected error

JSON
{
  "success": false,
  "message": "An unexpected error occurred."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred..