Referencia de APIAccounting / Beneficiary
Update Beneficiary
← Back to full API reference
PATCH
/v1/beneficiaryAuth required- Validated by Zod schema: patchBeneficiary.
Request details
Body fields
| Field | Required | Description |
|---|---|---|
| id | Yes | Type: number |
| name | No | Type: string |
| type | No | Enum-like validator generated by zodFromObj |
| taxId | No | Type: string |
| reference | No | Type: string |
| labels | No | Type: arrayExample: |
| labels[] | Yes | Type: string |
| image | No | Type: string |
| metadata | No | Type: unknown |
| assignedDivisionId | No | Type: number |
| referredBy | No | Type: number |
| stripeCustomerId | No | Type: string |
| cardnetCustomerId | No | Type: string |
| lat | No | Type: number |
| lon | No | Type: number |
| creditLimit | No | Type: number |
| archived | No | Type: boolean |
Default payloads
Path params
json
{}Query
json
{}Body
json
{
"id": 1
}Sample response
json
{
"beneficiaryId": "<beneficiaryId>"
}