Update Sales Credit

PUT 
/api/sales-credits/:sales_credit

Updates a sales credit including its lines. Lines array replaces all existing lines when provided; omit lines to leave them unchanged.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Fields:

• sales_credit_number (optional, max 255): Custom credit number
• credit_date (optional, date): Credit date
• store_id (optional): Store ID
• to_warehouse_id (optional): Return destination warehouse ID
• customer_id (optional): Customer ID
• sales_credit_note (optional): Free-form note
• currency_id (optional): Currency ID
• currency_code (optional): Currency code
• tax_rate_id (optional): Tax rate ID
• is_tax_included (optional, boolean): Whether prices include tax
• is_product (optional, boolean): Whether this is a product return
• tax_lines (optional): Array of tax line objects
• sales_credit_lines (optional): Array of credit lines to sync

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.