API Docs

Retrieve a sales credit note

Retrieves the details of a specific sales credit note. See the right panel for the request and response examples.

Path parameters

GET /api/sales-invoices/{id}

Parameter	Type	Required	Description
`id`	string	Required	The ID of the credit note to retrieve.

Response

Status code: 200 OK

Returns the credit note object with all fields populated.

Error responses

Status	Description
401 Unauthorized	Authentication required or invalid token.
404 Not Found	Credit note not found.
500 Internal Server Error	An error occurred while processing the request.

Request

# Base URL: https://api-sandbox.om.marmin.ai
# GET /api/sales-credit-notes/{id}

curl "https://api-sandbox.om.marmin.ai/api/sales-credit-notes/11112222-3333-4444-5555-666677778888" \
  -H "Authorization: Bearer <access_token>"

Response

{
  "id": "11112222-3333-4444-5555-666677778888",
  "org_id": "org-456",
  "transaction_type": "1XXXXXXXXXXXXXXXXXXX",
  "document_number": "CRN-001",
  "document_sequence": 1,
  "issue_date": "2025-05-24",
  "issue_time": "10:30:00",
  "credit_note_type_code": "381",
  "discrepancy_response": "CAN",
  "reason": "Invoice fully accepted",
  "note": "Credit for returned goods",
  "tax_point_date": "2025-05-24",
  "document_currency_code": "OMR",
  "tax_currency_code": "OMR",
  "accounting_cost": "COST-001",
  "buyer_reference": "BR-REF-001",
  "invoice_period": {
    "start_date": "2025-05-01",
    "end_date": "2025-05-31",
    "description": "May 2025"
  },
  "order_reference": {
    "id": "ORD-001",
    "sales_order_id": "SO-001"
  },
  "billing_reference": [
    {
      "id": "INV-ORIG-001",
      "issue_date": "2025-05-10"
    }
  ],
  "despatch_document_reference": {
    "id": "DESP-001"
  },
  "receipt_document_reference": {
    "id": "REC-001"
  },
  "statement_document_reference": {
    "id": "STMT-001"
  },
  "originator_document_reference": {
    "id": "ORIG-001"
  },
  "contract_document_reference": {
    "id": "CONTRACT-001",
    "document_description": "Master agreement"
  },
  "accounting_supplier_party": {
    "endpoint_id": "0199:265627835",
    "endpoint_scheme_id": "0088",
    "party_name": "Seller Business",
    "profile_id": "SELLER-PROFILE-001",
    "postal_address": {
      "street_name": "123 Seller St",
      "additional_street_name": null,
      "city_name": "Muscat",
      "postal_zone": "12345",
      "country_subentity": "MO",
      "address_line": null,
      "country": "Oman",
      "country_code": "OM"
    },
    "party_tax_scheme": {
      "company_id": "123456789",
      "tax_scheme": "VAT"
    },
    "tin": null,
    "scheme_agency_id": "TL",
    "company_id": "265627835",
    "company_scheme_id": null,
    "passport_issuing_country_code": null,
    "company_legal_form": null,
    "name": "Seller Party",
    "email": "seller@example.com",
    "telephone": null,
    "logo_url": null
  },
  "accounting_customer_party": {
    "endpoint_id": "0199:265627835",
    "endpoint_scheme_id": "0088",
    "party_name": "Buyer Business LLC",
    "profile_id": null,
    "postal_address": {
      "street_name": "100 Buyer Street",
      "additional_street_name": null,
      "city_name": "Muscat",
      "postal_zone": "00000",
      "country_subentity": "MO",
      "address_line": null,
      "country": "Oman",
      "country_code": "OM"
    },
    "party_tax_scheme": {
      "company_id": "100123456789003",
      "tax_scheme": "VAT"
    },
    "tin": null,
    "scheme_agency_id": "TL",
    "company_id": "265627835",
    "company_scheme_id": "002",
    "passport_issuing_country_code": null,
    "company_legal_form": null,
    "name": "Buyer Party",
    "email": "buyer@example.com",
    "telephone": null,
    "logo_url": null
  },
  "payee_party": null,
  "buyer_customer_party": null,
  "seller_supplier_party": null,
  "tax_representative_party": null,
  "delivery": null,
  "payment_terms": null,
  "charges": [],
  "allowances": [],
  "tax_exchange_rate": null,
  "tax_breakdown": [
    {
      "tax_category_id": "S",
      "taxable_amount": 100.0,
      "tax_amount": 5.0,
      "percent": 5.0
    }
  ],
  "allowance_total_amount": 10.0,
  "charge_total_amount": 50.0,
  "line_extension_amount": 100.0,
  "tax_exclusive_amount": 140.0,
  "tax_amount": 7.0,
  "tax_amount_in_omr": 7.0,
  "tax_inclusive_amount": 147.0,
  "prepaid_amount": 0.0,
  "payable_rounding_amount": 0.0,
  "payable_amount": 147.0,
  "payable_amount_in_omr": 147.0,
  "total_item_allowances": 0.0,
  "total_item_charges": 0.0,
  "total_taxable_amount": 140.0,
  "total_non_taxable_amount": 0.0,
  "document_lines": [
    {
      "note": null,
      "quantity": 1.0,
      "unit_code": "EA",
      "accounting_cost": null,
      "invoice_period": null,
      "order_line_reference": null,
      "despatch_line_reference": null,
      "document_reference": null,
      "charges": null,
      "allowances": null,
      "description": "Product A return",
      "name": "Product A",
      "buyer_item_identification": null,
      "seller_item_identification": null,
      "standard_item_identification": null,
      "additional_item_identification": [{ "nature_code": "493001" }],
      "item_specification_document_reference": {
        "commodity_code": "70000000",
        "item_type": "S"
      },
      "origin_country": null,
      "commodity_classification": {
        "item_classification_code": "500200000000",
        "item_classification_list_id": "HS"
      },
      "classified_tax_category": {
        "id": "S",
        "percent": 5.0,
        "tax_exemption_reason_code": null,
        "tax_exemption_reason": null,
        "tax_scheme": "VAT"
      },
      "additional_item_property": null,
      "lot_number_id": null,
      "price": {
        "price_amount": 100.0,
        "base_quantity": 1.0,
        "allowance": null
      },
      "line_object_identifier": null,
      "net_amount": 100.0,
      "base_amount": 100.0,
      "total_amount": 105.0,
      "total_amount_in_omr": 105.0,
      "tax_amount": 5.0,
      "tax_amount_in_omr": 5.0
    }
  ],
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "meta_info": {
    "peppol_status": {
      "participant_status": "TRANSMITTED",
      "ota_status": "ACCEPTED",
      "overall_status": "APPROVED",
      "validation_results": []
    }
  },
  "document_source": "API"
}