Skip to main content

Create Sales Credit

POST 
/api/sales-credits

Creates a new sales credit. Must be linked to either a sales_order_id or a customer_id.

Authentication: Requires Bearer token.

Fields:

  • sales_order_id (required if no customer_id): Sales order ID to credit against
  • customer_id (required if no sales_order_id): Customer ID for non-order credits
  • sales_credit_number (optional, max 255): Custom credit number (auto-generated if omitted)
  • credit_date (optional, date): Credit date
  • store_id (optional): Store ID
  • to_warehouse_id (optional): Return destination warehouse ID
  • sales_credit_note (optional): Free-form note
  • currency_id (optional): Currency ID (defaults to account default)
  • currency_code (optional): Currency code (alternative to currency_id)
  • tax_rate_id (optional): Tax rate ID
  • is_tax_included (optional, boolean): Whether prices include tax. Default: false
  • is_product (optional, boolean): Whether this is a product return. Default: false
  • tax_lines (optional): Array of tax line objects
  • sales_credit_lines (optional): Array of credit lines — each with sales_order_line_id, quantity, and price

Request​

Responses​

Successful response