Referencia de APIResources / Return
Create Return
← Back to full API reference
POST
/v1/resource/returnAuth required- Requires organization permissions for this resource.
- Validated by Zod schema: postReturn.
Request details
Body fields
| Field | Required | Description |
|---|---|---|
| vendorTaxId | No | Type: string |
| returnedOnDivisionId | Yes | Type: number |
| availableToRedeem | No | Type: number |
| creditNoteAmount | No | Type: number |
| reason | No | Type: string |
| isDiscountOnly | No | Type: boolean |
| creditNoteType | No | Type: enumExample: RETURN |
| elements | No | Type: arrayExample: |
| elements[] | Yes | Type: object |
| elements[].resourceId | Yes | Type: number |
| elements[].quantity | Yes | Type: number |
| elements[].pricePerUnit | Yes | Type: number |
| elements[].taxes | No | Type: arrayExample: |
| elements[].taxes[] | Yes | Type: object |
| elements[].taxes[].taxRateId | Yes | Type: number |
| elements[].taxes[].isIncludedInPrice | No | Type: boolean |
| elements[].serialNumbers | No | Type: arrayExample: |
| elements[].serialNumbers[] | Yes | Type: string |
| invoiceId | Yes | Type: number |
Default payloads
Path params
json
{}Query
json
{}Body
json
{
"returnedOnDivisionId": 1,
"invoiceId": 1
}Sample response
json
"<result>"