API reference › Finance › Payment statements

Delete a payment statement

DELETE /v1/finance/payment-statements/{payment_statement}

Scope
finance:delete
Roles
admin, scheduler

Parameters

Path parameters

NameTypeDescription
payment_statement requiredstring

Payment statement ID

Example PS-ABC123.

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

Example request

Shell
curl -X DELETE "https://api.fetchfido.ai/v1/finance/payment-statements/{payment_statement}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Payment statement deleted successfully

Payment statement deleted successfully

JSON
{
  "success": true,
  "message": "Payment statement deleted successfully."
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Payment statement deleted successfully..

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:delete' 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:delete' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Payment statement not found

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

Example false.

messagestring

Example Payment statement 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,
  "errors": "Payment statement deletion failed",
  "message": "An unexpected error occurred — please try again."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Payment statement deletion failed.

messagestring

Example An unexpected error occurred — please try again..