API Docs

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

Request

# Base URL: https://api-sandbox.ae.marmin.ai
# GET /api/proforma-invoices/{uuid}

curl "https://api-sandbox.ae.marmin.ai/api/proforma-invoices/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer <access_token>"

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "org_id": "org-456",
  "profile_execution_id": "00000000",
  "document_number": "INV-001",
  "document_sequence": 1,
  "issue_date": "2025-05-24",
  "issue_time": "10:30:00",
  "invoice_type_code": "380",
  "due_date": "2025-06-24",
  "note": "Thank you for your business",
  "tax_point_date": "2025-05-24",
  "document_currency_code": "AED",
  "tax_currency_code": "AED",
  "accounting_cost": "COST-001",
  "buyer_reference": "BR-REF-001",
  "invoice_period": {
    "start_date": "2025-05-01",
    "end_date": "2025-05-31",
    "description": "Monthly"
  },
  "order_reference": {
    "id": "ORD-001",
    "sales_order_id": "SO-001"
  },
  "billing_reference": [
    {
      "id": "INV-PRE-001",
      "issue_date": "2025-04-15"
    }
  ],
  "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"
  },
  "project_reference": {
    "id": "PRJ-001"
  },
  "accounting_supplier_party": {
    "endpoint_id": "0199:265627835",
    "endpoint_scheme_id": "0235",
    "party_name": "Seller Business",
    "profile_id": "SELLER-PROFILE-001",
    "postal_address": {
      "street_name": "123 Seller St",
      "additional_street_name": null,
      "city_name": "Dubai",
      "postal_zone": "12345",
      "country_subentity": "DXB",
      "address_line": null,
      "country": "United Arab Emirates",
      "country_code": "AE"
    },
    "party_tax_scheme": {
      "company_id": "123456789",
      "tax_scheme": "VAT"
    },
    "tin": null,
    "scheme_agency_id": "TL",
    "company_id": "265627835",
    "company_scheme_id": null,
    "authority_name": "Dubai Department of Economy and Tourism",
    "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": "0235",
    "party_name": "Buyer Business LLC",
    "profile_id": null,
    "postal_address": {
      "street_name": "100 Buyer Street",
      "additional_street_name": null,
      "city_name": "Dubai",
      "postal_zone": "00000",
      "country_subentity": "DXB",
      "address_line": null,
      "country": "United Arab Emirates",
      "country_code": "AE"
    },
    "party_tax_scheme": {
      "company_id": "100123456789003",
      "tax_scheme": "VAT"
    },
    "tin": null,
    "scheme_agency_id": "TL",
    "company_id": "265627835",
    "company_scheme_id": "002",
    "authority_name": "Dubai Department of Economy and Tourism",
    "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_means": [{
    "id": null,
    "payment_means_code": "30",
    "payment_id": ["PAY-REF-001"],
    "card_account": null,
    "payee_financial_account": {
      "id": "IBAN123",
      "name": "Account Name",
      "financial_institution_branch_id": null,
      "address": null
    },
    "payment_mandate": null
  }],
  "payment_terms": null,
  "charges": [],
  "allowances": [],
  "tax_exchange_rate": null,
  "tax_breakdown": [
    {
      "tax_category_id": "S",
      "taxable_amount": 200.0,
      "tax_amount": 10.0,
      "percent": 5.0
    }
  ],
  "allowance_total_amount": 10.0,
  "charge_total_amount": 50.0,
  "line_extension_amount": 200.0,
  "tax_exclusive_amount": 240.0,
  "tax_amount": 12.0,
  "tax_amount_in_aed": 12.0,
  "tax_inclusive_amount": 252.0,
  "prepaid_amount": 0.0,
  "payable_rounding_amount": 0.0,
  "payable_amount": 252.0,
  "payable_amount_in_aed": 252.0,
  "total_item_allowances": 0.0,
  "total_item_charges": 0.0,
  "total_taxable_amount": 240.0,
  "total_non_taxable_amount": 0.0,
  "document_lines": [
    {
      "note": null,
      "quantity": 2.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 description",
      "name": "Product A",
      "buyer_item_identification": null,
      "seller_item_identification": null,
      "standard_item_identification": null,
      "additional_item_identification": null,
      "origin_country": null,
      "commodity_classification": null,
      "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": { "base_amount": 100.0, "base_quantity": 1.0, "allowance": null },
      "line_object_identifier": null,
      "net_amount": 200.0,
      "base_amount": 200.0,
      "total_amount": 210.0,
      "total_amount_in_aed": 210.0,
      "tax_amount": 10.5,
      "tax_amount_in_aed": 10.5
    }
  ],
  "document_source": "API",
  "meta_info": null,
  "is_phase2_document": false
}