API reference › Finance › Payment statements

Update payment statement inline fields

PUT /v1/finance/payment-statements/{id}

Scope
finance:edit
Roles
admin, scheduler

Update specific payment statement fields (financial status) for inline editing.

Parameters

Path parameters

NameTypeDescription
id requiredstring

Payment statement ID

Example PS-EWDM3W.

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

Request body required

FieldTypeDescription
override_locksboolean or null

Edit a paid document past its locks. Send on the retry after a save asks.

override_reasonobject
override_reason.idinteger or string

Example 1.

override_reason.labelstring or null

Example Example.

override_reason_textstring or null

max length 1000.

override_deliverystring or null

One of: internal_only, send_updated.

confirmationboolean or null

Confirms the resend prompt a save on a sent document raises.

resend_deliverystring or null

One of: send_updated, internal_only, send_now, save_only.

overpayment_confirmationboolean or null

Accept a payment that exceeds the balance due.

payment_termsobject or null
payment_terms.idinteger

Example 1.

payment_terms.labelstring

Example Net 15.

payment_terms.isCustomboolean or null

Example false.

statusobject or null

Financial status to update

status.idinteger

Financial status ID

Example 4.

status.labelstring

Financial status label

Example Sent.

status.isCustomboolean

Whether status is custom

Example false.

is_publishedboolean

Whether the payment statement is published (inline toggle)

Example false.

Example

JSON
{
  "override_locks": true,
  "override_reason": {
    "id": 1,
    "label": "Example"
  },
  "override_reason_text": "string",
  "override_delivery": "internal_only",
  "confirmation": true,
  "resend_delivery": "send_updated",
  "overpayment_confirmation": true,
  "payment_terms": {
    "id": 1,
    "label": "Net 15",
    "isCustom": false
  },
  "status": {
    "id": 4,
    "label": "Sent",
    "isCustom": false
  },
  "is_published": false
}

Example request

Shell
curl -X PUT "https://api.fetchfido.ai/v1/finance/payment-statements/{id}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"override_locks":true,"override_reason":{"id":1,"label":"Example"},"override_reason_text":"string","override_delivery":"internal_only","confirmation":true,"resend_delivery":"send_updated","overpayment_confirmation":true,"payment_terms":{"id":1,"label":"Net 15","isCustom":false},"status":{"id":4,"label":"Sent","isCustom":false},"is_published":false}'

Try it

Responses

200 Payment statement updated successfully

Payment statement updated successfully

JSON
{
  "success": true,
  "message": "Payment statement updated successfully.",
  "data": {
    "id": "PS-EWDM3W",
    "status": {
      "id": 2,
      "label": "Sent"
    },
    "is_published": false
  }
}
Response fields (8)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Payment statement updated successfully..

dataobject
data.idstring

Example PS-EWDM3W.

data.statusobject
data.status.idinteger

Example 2.

data.status.labelstring

Example Sent.

data.is_publishedboolean

Whether the payment statement is published

Example false.

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

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..

422 Validation failed

Validation error

JSON
{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "status": [
      "Status is invalid."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Validation failed.

errorsobject
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 update 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 update failed.

messagestring

Example An unexpected error occurred — please try again..