Skip to main content

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.

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​

Successful response