API reference › Finance › Invoices
Update invoice inline fields
PUT /v1/finance/invoices/{id}
- Scope
finance:edit- Roles
- admin, scheduler
Updates one or more fields from the list or detail screen without a full save: payment terms, financial status, due date, published flag, or a partial payment. Every field is optional; only the ones sent change.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Invoice ID Example |
Headers
| Name | Type | Description |
|---|---|---|
Idempotency-Key | string | Retry key for a partial payment, max 255 characters. Wins over the body's idempotency_key. A partial payment needs this or transaction_id. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
17 top-level fields; 3 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
override_locks | boolean or null | Edit a paid document past its locks. Send on the retry after a save asks. |
override_reason | object (2 nested) | |
override_reason_text | string or null | max length 1000. |
override_delivery | string or null | One of: |
confirmation | boolean or null | Confirms the resend prompt a save on a sent document raises. |
resend_delivery | string or null | One of: |
overpayment_confirmation | boolean or null | Accept a payment that exceeds the balance due. |
payment_terms | object or null (3 nested) | |
status | object or null (3 nested) | Target financial status. A move that needs confirmation returns 422 with requires_confirmation=true. |
due_date | string (date) | Example |
reason | string or null | Why the status changed, such as a rejection reason. max length 500. |
is_published | boolean | Example |
partial_payment_amount | number or null | Records a partial payment. Requires the Idempotency-Key header, idempotency_key or transaction_id. min 0. Example |
payment_amount | number or null | min 0. |
payment_method | string or null | max length 50. Example |
transaction_id | string or null | max length 255. Example |
idempotency_key | string or null | Body fallback for the Idempotency-Key header. max length 255. |
Nested fields
override_reason 2 fields
| Field | Type | Description |
|---|---|---|
override_reason.id | integer or string | Example |
override_reason.label | string or null | Example |
payment_terms 3 fields
| Field | Type | Description |
|---|---|---|
payment_terms.id | integer | Example |
payment_terms.label | string | Example |
payment_terms.isCustom | boolean or null | Example |
status 3 fields
| Field | Type | Description |
|---|---|---|
status.id | integer | Example |
status.label | string | Example |
status.isCustom | boolean or null | Example |
Example
{
"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": "Paid",
"isCustom": false
},
"due_date": "2025-03-15",
"reason": "string",
"is_published": false,
"partial_payment_amount": 50,
"payment_amount": 0,
"payment_method": "check",
"transaction_id": "CHK-10042",
"idempotency_key": "string"
}Example request
curl -X PUT "https://api.fetchfido.ai/v1/finance/invoices/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Idempotency-Key: b2f6c1d4-8e0a-4b8b-9c1d-2a7e5f3c9d10" \
-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":"Paid","isCustom":false},"due_date":"2025-03-15","reason":"string","is_published":false,"partial_payment_amount":50,"payment_amount":0,"payment_method":"check","transaction_id":"CHK-10042","idempotency_key":"string"}'Try it
Responses
200 Invoice updated successfully
Invoice updated successfully. Each field is present only when it applies.
{
"success": true,
"message": "Invoice updated successfully.",
"data": {
"id": "INV-EWDM3W",
"payment_terms": {
"id": 1,
"label": "Net 15"
},
"status": {
"id": 2,
"name": "Sent"
},
"due_date": "2025-03-15",
"is_published": false
}
}Response fields (12)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | string | Example |
data.payment_terms | object | Echo of the payment_terms sent. |
data.payment_terms.id | integer | Example |
data.payment_terms.label | string | Example |
data.status | object | The status after the change, when it changed. |
data.status.id | integer | Example |
data.status.name | string | Example |
data.due_date | string | Example |
data.is_published | boolean | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
404 Not found
Invoice not found
{
"success": false,
"message": "Invoice not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
422 Validation failed
Validation error
{
"success": false,
"message": "Validation failed",
"errors": {
"payment_terms": [
"Payment terms are invalid."
]
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Unexpected error
{
"success": false,
"errors": "Invoice update failed",
"message": "An unexpected error occurred ? please try again."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |
message | string | Example |