Create Credit Memo

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
reasonstringRequired

Optional: Reason for credit memo - max 2000 chars - “Billing error on original invoice”

invoice_idstringRequired

Optional: Related invoice ID - must exist in invoices - “{{invoice_id}}

customer_idstringRequired

Required: Customer ID - must exist in customers table - “{{customer_id}}

internal_notesstringRequired

Optional: Internal notes - max 2000 chars - “Approved by manager”

line_items[0][notes]stringRequired

Optional: Line item notes - max 2000 chars - “Overcharged for labor”

line_items[0][quantity]stringRequired

Required: Quantity - numeric min:0.0001 - 1

line_items[0][tax_amount]stringRequired

Optional: Tax amount for this line - numeric min:0 - 4.13

line_items[0][unit_price]stringRequired

Required: Unit price - numeric min:0 - 50.00

line_items[0][description]stringRequired

Required: Line item description - max 500 chars - “Credit for overcharge”

line_items[0][reason_code]stringRequired

Required: Reason code - billing_error|warranty|goodwill|return|price_adjustment|duplicate_charge|service_complaint|other - “billing_error”

line_items[0][original_line_item_id]stringRequired

Optional: Original invoice line item ID - must exist in invoice_line_items

Response

Successful response