Create Vendor Credit From Return
POST/api/vendor-returns/:vendorReturn/create-credit
Create the financial vendor credit from a SHIPPED (or completed) vendor return - use this once the supplier's credit memo arrives. Returns the newly created draft vendor credit.
The credit's lines link to the return's lines at the line level, so each return line tracks how much of it has been credited (credited_quantity). Crediting the un-invoiced portion settles the vendor-returns clearing account. Only the remaining un-credited quantity of each return line is included; lines already fully credited are skipped.
Authentication: Requires Bearer token.
Body fields (all optional):
- vendor_credit_number (string, max 255, must be unique; auto-generated when omitted)
- supplier_reference (string, max 255; defaults to the return's vendor RMA number)
- credit_date (date, YYYY-MM-DD; defaults to today)
Fails with 422 when the return is not shipped/completed, or when it is already fully credited.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.