API Docs

List sales credit notes

Retrieves a paginated list of sales credit notes. See the right panel for the request and response examples.

Query parameters

Parameter	Type	Required	Description
`document_number`	string	Optional	Filter by credit note document number.
`invoice_number`	string	Optional	Filter by referenced invoice number.
`billed_by_name`	string	Optional	Filter by supplier name.
`billed_to_name`	string	Optional	Filter by customer name.
`billed_to_vat`	string	Optional	Filter by customer VAT number.
`billed_by_vat`	string	Optional	Filter by supplier VAT number.
`status`	string	Optional	Filter by credit note status.
`document_date`	string	Optional	Filter by credit note issue date. Format: `yyyy-MM-dd`.
`page`	integer	Optional	Page number (0-indexed). Default: 0.
`size`	integer	Optional	Number of items per page. Default: 10.

Response

Status code: 200 OK

Returns a paginated response containing an array of credit note objects.

Error responses

Status	Description
400 Bad Request	Invalid request parameters or validation failed. For validation errors, the response includes field-specific errors.
401 Unauthorized	Authentication required or invalid token.
500 Internal Server Error	An error occurred while processing the request.

Request

# Base URL: https://api-sandbox.ae.marmin.ai
# GET /api/sales-credit-notes

curl "https://api-sandbox.ae.marmin.ai/api/sales-credit-notes?page=0&size=10" \
  -H "Authorization: Bearer <access_token>"

Response

{
  "content": [
    {
      "id": "11112222-3333-4444-5555-666677778888",
      "org_id": "org-456",
      "profile_execution_id": "00000000",
      "document_number": "CRN-001",
      "document_sequence": 1,
      "issue_date": "2025-05-24",
      "issue_time": "10:30:00",
      "credit_note_type_code": "381",
      "discrepancy_response": "AAI",
      "reason": "Invoice fully accepted",
      "note": "Credit for returned goods",
      "tax_point_date": "2025-05-24",
      "document_currency_code": "AED",
      "tax_currency_code": "AED",
      "accounting_cost": "COST-001",
      "buyer_reference": "BR-REF-001",
      "accounting_supplier_party": {
        "party_name": "Seller Business",
        "profile_id": "SELLER-PROFILE-001"
      },
      "accounting_customer_party": {
        "party_name": "Buyer Business LLC",
        "profile_id": null
      },
      "line_extension_amount": 100.0,
      "tax_exclusive_amount": 140.0,
      "tax_amount": 7.0,
      "tax_inclusive_amount": 147.0,
      "payable_amount": 147.0,
      "document_source": "API",
      "is_phase2_document": false
    }
  ],
  "page_number": 0,
  "total_pages": 1,
  "total_elements": 1
}