Referencia de APIAccounting / Beneficiary
Create Beneficiary
← Back to full API reference
POST
/v1/beneficiaryAuth required- Validated by Zod schema: postBeneficiary.
Request details
Body fields
| Field | Required | Description |
|---|---|---|
| name | Yes | Type: string |
| type | Yes | Enum-like validator generated by zodFromObj |
| taxId | No | Type: string |
| reference | No | Type: string |
| labels | No | Type: arrayExample: |
| labels[] | Yes | Type: string |
| contact | No | Type: arrayExample: |
| contact[] | Yes | Type: object |
| contact[].type | Yes | Type: string |
| contact[].data | Yes | Type: string |
| contact[].dataType | No | Type: enumExample: string |
| lat | No | Type: number |
| lon | No | Type: number |
| metadata | No | Type: object |
| metadata.adquisitionChannel | No | Type: string |
| creditLimit | No | Type: number |
Default payloads
Path params
json
{}Query
json
{}Body
json
{
"name": "string",
"type": "string"
}Sample response
json
{
"beneficiaryId": "<beneficiaryId>"
}