Gestiono
Referencia de APIResources / Return

Create Return

POST /v1/resource/return • validated by `postReturn`

← Back to full API reference
POST/v1/resource/returnAuthentication required
  • Requires organization permissions for this resource.
  • Validated by Zod schema: postReturn.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • returnedOnDivisionId (required)

    Type: number

  • availableToRedeem

    Type: number

  • reason

    Type: string

  • isDiscountOnly

    Type: boolean

  • creditNoteType

    Type: enum

    Example: RETURN

  • elements

    Type: array

    Example:

  • elements[] (required)

    Type: object

  • elements[].resourceId (required)

    Type: number

  • elements[].quantity (required)

    Type: number

  • elements[].pricePerUnit (required)

    Type: number

  • elements[].taxes

    Type: array

    Example:

  • elements[].taxes[] (required)

    Type: object

  • elements[].taxes[].taxRateId (required)

    Type: number

  • elements[].taxes[].isIncludedInPrice

    Type: boolean

  • elements[].serialNumbers

    Type: array

    Example:

  • elements[].serialNumbers[] (required)

    Type: string

  • invoiceId (required)

    Type: number

Default payloads

Path params

json
{}

Query

json
{}

Body

json
{
  "returnedOnDivisionId": 1,
  "invoiceId": 1
}

Sample response

json
"<result>"

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/resource/returnAuthentication required

Group: Resources / Return

POST /v1/resource/return • validated by `postReturn`

  • Requires organization permissions for this resource.
  • Validated by Zod schema: postReturn.

Body fields

  • returnedOnDivisionIdrequired
    Type: number
  • availableToRedeem
    Type: number
  • reason
    Type: string
  • isDiscountOnly
    Type: boolean
  • creditNoteType
    Type: enum
    Ejemplo: RETURN
  • elements
    Type: array
    Ejemplo:
  • elements[]required
    Type: object
  • elements[].resourceIdrequired
    Type: number
  • elements[].quantityrequired
    Type: number
  • elements[].pricePerUnitrequired
    Type: number
  • elements[].taxes
    Type: array
    Ejemplo:
  • elements[].taxes[]required
    Type: object
  • elements[].taxes[].taxRateIdrequired
    Type: number
  • elements[].taxes[].isIncludedInPrice
    Type: boolean
  • elements[].serialNumbers
    Type: array
    Ejemplo:
  • elements[].serialNumbers[]required
    Type: string
  • invoiceIdrequired
    Type: number

3. Prepare request payload

4. Server response

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

GET /v1/resource/delivery/:deliveryId

Previous Page

GET /v1/resource/return

Next Page