API reference › Finance › Provider expenses

Upload or replace provider expense receipt

POST /v1/finance/provider-expenses/upload-receipt

Scope
finance:write
Roles
admin, scheduler

Uploads or replaces a receipt for a provider expense. Allowed only for pending or changes_required expenses. Providers can upload for their own expenses; admin/scheduler/super-admin can upload for any provider.

Parameters

None of its own.

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

Request body required

FieldTypeDescription
receipt requiredstring (binary)

Receipt file (PDF, JPG, JPEG, max 2MB)

expense_id requiredinteger

Provider expense record id

Example 123.

type requiredstring

Work item type for this expense

One of: assignment, shift.

Example

JSON
{
  "receipt": "string",
  "expense_id": 123,
  "type": "assignment"
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/finance/provider-expenses/upload-receipt" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"receipt":"string","expense_id":123,"type":"assignment"}'

Try it

Responses

200 Receipt uploaded successfully

Receipt uploaded successfully

JSON
{
  "success": true,
  "message": "Receipt uploaded successfully.",
  "data": {
    "expense_id": 123,
    "type": "assignment",
    "uploadReceipt": "https://s3.example.com/.../receipt.pdf",
    "status": "pending"
  }
}
Response fields (7)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Receipt uploaded successfully..

dataobject
data.expense_idinteger

Example 123.

data.typestring

Example assignment.

data.uploadReceiptstring

Example https://s3.example.com/.../receipt.pdf.

data.statusstring

Example pending.

401 Not signed in

Unauthorized

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

Forbidden

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

Expense not found

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

Invalid state or validation error

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.

500 Server error

Internal Server Error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..

errorsstring or null

Null in production. The exception message only when the application runs with debug on, so nothing is leaked to an integrator.

codestring

Always empty: the server-error response carries no error code.

Example .