API Docs

Parameter	Type	Required	Description
`document_number`	string	Optional	Filter by invoice document 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 invoice status.
`document_date`	string	Optional	Filter by invoice 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 proforma invoice documents. Each item uses the same field shape as Create a Proforma invoice.

See the right panel for complete response examples.

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/proforma-invoices

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

Response

{
  "content": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "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",
      "document_currency_code": "AED",
      "tax_currency_code": "AED",
      "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": 200.0,
      "tax_exclusive_amount": 240.0,
      "tax_amount": 12.0,
      "tax_inclusive_amount": 252.0,
      "payable_amount": 252.0,
      "document_source": "API",
      "is_phase2_document": false
    }
  ],
  "page_number": 0,
  "total_pages": 1,
  "total_elements": 1
}