MarminDeveloper Docs
BusinessesPartnersProduct Wiki

Sale credit note examples

This page provides ready-to-use sales credit note payloads for common UAE scenarios. All examples target POST /api/sales-credit-notes/{business_profile_id} and should reference an existing sales invoice.

How to use these examples

  • Replace identifiers (document_number, billing_reference.id, party IDs) with your own values.

  • Ensure billing_reference points to the original invoice being adjusted.

  • Keep discrepancy_response aligned with your business reason and profile rules.

  • For profile_execution_id flags and mandatory fields per scenario, use the same rules as for invoices; see Profile execution ID (sales invoice object).

Example 1: Minimal standard credit note

Use this when issuing a straightforward credit note for returned items with standard VAT. See Example 1: Minimal sales credit note in the right-side code samples panel.

Example 2: Sales credit note with document-level charges and allowances

Use this when crediting line items while also adjusting freight, fees, or discounts. See Example 2: Sales credit note with document-level charges + allowances in the right-side code samples panel.

Example 3: Sales credit note with line-level charges and allowances

Use this when a specific credited line needs per-line charge and allowance adjustments. See Example 3: Sales credit note with line-level charges + allowances in the right-side code samples panel.

Example 4: Sales credit note with multiple payment modes

Use this when refund or settlement can be processed through multiple payment modes. See Example 4: Multiple payment modes in the right-side code samples panel.

Example 5: Free Trade Zone

Use when the Free Trade Zone flag is set in profile_execution_id. Includes buyer_customer_party.id (beneficiary TRN/TIN placeholder). See Example 5: Free Trade Zone (profile_execution_id) in the right-side code samples panel.

Example 6: Summary invoice

Use when the summary-invoice flag is set. Includes invoice_period with start_date, end_date, and description (billing frequency). See Example 6: Summary invoice (profile_execution_id) in the right-side code samples panel.

Example 7: Disclosed agent billing

Use when the disclosed-agent-billing flag is set. Includes seller_supplier_party.id (Principle ID TRN placeholder). See Example 7: Disclosed agent billing (profile_execution_id) in the right-side code samples panel.

Example 8: Export transaction

Use when the export flag is set. Includes a full delivery object. Example line uses zero-rated VAT (Z) where applicable. For a non-UAE buyer, accounting_customer_party.party_tax_scheme is optional. See Example 8: Export transaction (profile_execution_id) in the right-side code samples panel.

  1. Validate with Example 1 in sandbox.

  2. Add document-level adjustments using Example 2.

  3. Use Example 3 when your adjustments are applied at line level.

  4. Review Example 4 for multi-mode payment payloads.

  5. Use Examples 5–8 when your profile_execution_id requires beneficiary ID, summary period, principal TRN, or export delivery.

Next