Gestiono
Referencia de APIAccounting / Beneficiary

Update Beneficiary

PATCH /v1/beneficiary • validated by `patchBeneficiary`

← Back to full API reference
PATCH/v1/beneficiaryAuthentication required
  • Validated by Zod schema: patchBeneficiary.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • id (required)

    Type: number

  • name

    Type: string

  • type

    Enum-like validator generated by zodFromObj

  • taxId

    Type: string

  • reference

    Type: string

  • labels

    Type: array

    Example:

  • labels[] (required)

    Type: string

  • image

    Type: string

  • metadata

    Type: unknown

  • assignedDivisionId

    Type: number

  • referredBy

    Type: number

  • stripeCustomerId

    Type: string

  • lat

    Type: number

  • lon

    Type: number

  • creditLimit

    Type: number

  • archived

    Type: boolean

Default payloads

Path params

json
{}

Query

json
{}

Body

json
{
  "id": 1
}

Sample response

json
{
  "beneficiaryId": "<beneficiaryId>"
}

Test this endpoint now

Use your own credentials and execute a live request directly from this page.

1. Configure authentication for testing

You can test endpoints with signed API keys, a raw Authorization token, or browser cookies. Select one mode and fill in the required fields.

2. Select endpoint

PATCH/v1/beneficiaryAuthentication required

Group: Accounting / Beneficiary

PATCH /v1/beneficiary • validated by `patchBeneficiary`

  • Validated by Zod schema: patchBeneficiary.

Body fields

  • idrequired
    Type: number
  • name
    Type: string
  • type
    Enum-like validator generated by zodFromObj
  • taxId
    Type: string
  • reference
    Type: string
  • labels
    Type: array
    Ejemplo:
  • labels[]required
    Type: string
  • image
    Type: string
  • metadata
    Type: unknown
  • assignedDivisionId
    Type: number
  • referredBy
    Type: number
  • stripeCustomerId
    Type: string
  • lat
    Type: number
  • lon
    Type: number
  • creditLimit
    Type: number
  • archived
    Type: boolean

3. Prepare request payload

4. Server response

Run a request to inspect the real-time response for your environment.

POST /v1/beneficiary/bulk

Previous Page

PATCH /v1/beneficiary/bulk/archive

Next Page