Gestiono
Referencia de APIAccounting / Beneficiary

Create Beneficiary bulk

POST /v1/beneficiary/bulk • validated by `postBeneficiaryBulk`

← Back to full API reference
POST/v1/beneficiary/bulkAuthentication required
  • Validated by Zod schema: postBeneficiaryBulk.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • [] (required)

    Type: object

  • [].name (required)

    Type: string

  • [].type (required)

    Enum-like validator generated by zodFromObj

  • [].taxId

    Type: string

  • [].reference

    Type: string

  • [].labels

    Type: array

    Example:

  • [].labels[] (required)

    Type: string

  • [].contact

    Type: array

    Example:

  • [].contact[] (required)

    Type: object

  • [].contact[].type (required)

    Type: string

  • [].contact[].data (required)

    Type: string

  • [].contact[].dataType

    Type: enum

    Example: string

  • [].lat

    Type: number

  • [].lon

    Type: number

  • [].metadata

    Type: object

  • [].metadata.adquisitionChannel

    Type: string

  • [].creditLimit

    Type: number

Default payloads

Path params

json
{}

Query

json
{}

Body

json
[
  {
    "name": "string",
    "type": "string"
  }
]

Sample response

json
{
  "success": true,
  "message": "<value>",
  "count": "<value>"
}

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

POST/v1/beneficiary/bulkAuthentication required

Group: Accounting / Beneficiary

POST /v1/beneficiary/bulk • validated by `postBeneficiaryBulk`

  • Validated by Zod schema: postBeneficiaryBulk.

Body fields

  • []required
    Type: object
  • [].namerequired
    Type: string
  • [].typerequired
    Enum-like validator generated by zodFromObj
  • [].taxId
    Type: string
  • [].reference
    Type: string
  • [].labels
    Type: array
    Ejemplo:
  • [].labels[]required
    Type: string
  • [].contact
    Type: array
    Ejemplo:
  • [].contact[]required
    Type: object
  • [].contact[].typerequired
    Type: string
  • [].contact[].datarequired
    Type: string
  • [].contact[].dataType
    Type: enum
    Ejemplo: string
  • [].lat
    Type: number
  • [].lon
    Type: number
  • [].metadata
    Type: object
  • [].metadata.adquisitionChannel
    Type: string
  • [].creditLimit
    Type: number

3. Prepare request payload

4. Server response

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