Simple Fatoora API

{
  "status": true,
  "response": {
    "registration_intent": "registration-intent-token",
    "expires_in": 86400
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "OTP sent successfully",
    "is_register": false
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "OTP verify successfully",
    "is_register": false
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "Welcome to Simple Fatoora",
    "activation_method": "email_otp",
    "email_id": "developer@example.com",
    "first_name": "Developer",
    "last_name": "Account",
    "uuid": "session-uuid",
    "api_key": "live_api_key_example",
    "production_api_key": "live_api_key_example",
    "sandbox_api_key": "sandbox_api_key_example"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "api_key": "live_api_key_example",
  "production_api_key": "live_api_key_example",
  "sandbox_api_key": "sandbox_api_key_example",
  "response": "Validated successfully"
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "api_key": "live_api_key_example",
  "production_api_key": "live_api_key_example",
  "sandbox_api_key": "sandbox_api_key_example",
  "active_environment": "live",
  "response": "Validated successfully"
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "Password updated successfully",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "user_id": 123,
    "company_name": "Example Company",
    "email_id": "developer@example.com",
    "address": "Riyadh",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "tax_setup_status": "vat_registered",
    "tax_registration_status": "vat_registered",
    "is_vat_registered": true,
    "environment": "live",
    "is_sandbox": false,
    "production_api_key": "live_api_key_example",
    "sandbox_api_key": "sandbox_api_key_example",
    "send_mail": 1,
    "client_send_mail": 1
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "Profile updated successfully",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "url": "https://example.com/company-logo.png"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "categories": [
      {
        "id": 1,
        "title": "Retail",
        "ar_title": "التجزئة",
        "position": 1,
        "status": 1
      }
    ]
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "User created successfully",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "User updated successfully",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "id": 123,
    "user_id": 123,
    "first_name": "Example Customer",
    "email_id": "customer@example.com",
    "mobile_number": "500000000",
    "country_code": "+966",
    "address": "Riyadh",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "status": 1
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "users": [
      {
        "id": 123,
        "full_name": "Example Customer",
        "email_id": "customer@example.com",
        "mobile_number": "500000000",
        "country_code": "+966",
        "address": "Riyadh",
        "client_type": 2
      }
    ],
    "pagination_meta": {
      "current_page": 1,
      "pages": 1,
      "per_page": 20,
      "total": 1
    }
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "User deleted successfully"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "products": [
      {
        "id": 123,
        "product_id": "P0001",
        "description": "Example item",
        "unit_price": 100,
        "vat_percent": 15,
        "last_used_on": "2026-08-30T20:41:45"
      }
    ]
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "products": [
      {
        "id": 123,
        "product_id": "P0001",
        "description": "Example item",
        "unit_price": 100,
        "vat_percent": 15,
        "last_used_on": "2026-08-30T20:41:45"
      }
    ]
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "id": 123,
    "invoice_number": "ST123-456",
    "invoice_type_code": 0,
    "document_label": "Simplified Tax Invoice",
    "document_label_ar": "فاتورة ضريبية مبسطة",
    "seller_tax_status": "vat_registered",
    "is_tax_document": true,
    "vat": 22.5,
    "total": 172.5,
    "date_time": "2026-10-15 12:00:00",
    "transaction_date": null,
    "environment": "sandbox",
    "pdf_ready": false,
    "xml_available": false
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": false,
  "message": "This request is processing or requires review. Check its document before retrying.",
  "response": {
    "invoice_id": 123
  }
}

{
  "status": true,
  "response": {
    "invoices": [
      {
        "id": 123,
        "invoice_number": "ST123-456",
        "invoice_type": 0,
        "date_time": "2026-08-30 23:41:18",
        "reference_number": "POS-1001",
        "total": 115,
        "invoice": "https://example.com/invoices/ST123-456.pdf",
        "pdf_ready": true,
        "pdf_download_url": "https://api.example.com/v1/invoice/pdf/123",
        "xml_available": true,
        "xml_archive_state": "reported",
        "xml_download_url": "https://api.example.com/v1/invoice/xml/123",
        "environment": "live",
        "is_test": false
      }
    ],
    "pagination_meta": {
      "current_page": 1,
      "pages": 1,
      "per_page": 20,
      "total": 1
    }
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "id": 123,
    "invoice_number": "ST123-456",
    "invoice_type": 0,
    "date_time": "2026-08-30 23:41:18",
    "reference_number": "POS-1001",
    "seller_name": "Example Company",
    "seller_vat_number": "300000000000003",
    "buyer_name": "Example Customer",
    "buyer_email_id": "customer@example.com",
    "sub_total": 100,
    "vat": 15,
    "total": 115,
    "invoice": "https://example.com/invoices/ST123-456.pdf",
    "qrcode": "https://example.com/invoices/ST123-456-qr.png",
    "pdf_ready": true,
    "pdf_download_url": "https://api.example.com/v1/invoice/pdf/123",
    "xml_available": true,
    "xml_archive_state": "reported",
    "xml_download_url": "https://api.example.com/v1/invoice/xml/123",
    "environment": "live",
    "invoice_details": [
      {
        "description": "Example item",
        "unit_price": 100,
        "quantity": 1,
        "vat_percent": 15,
        "vat": 15,
        "total": 115
      }
    ],
    "document_label": "Simplified Tax Invoice",
    "document_label_ar": "فاتورة ضريبية مبسطة",
    "seller_tax_status": "vat_registered",
    "is_tax_document": true,
    "transaction_date": "2026-09-15"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

%PDF binary document

{
  "status": false,
  "response": "Invalid API key"
}

<?xml version="1.0"?><Invoice>...</Invoice>

{
  "status": false,
  "response": "Invalid API key"
}

X-SF-Archive-Next: رمز متابعة الجزء التالي؛ يكون فارغًا في الجزء الأخير.

X-SF-Archive-Part: رقم الجزء.

X-SF-Archive-Exported: عدد الملفات المضمنة في هذا الجزء.

X-SF-Archive-Skipped: عدد الملفات غير المتاحة التي تم تجاوزها في هذا الجزء.

Binary ZIP archive with documents and manifest.csv

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "id": 123,
  "invoice_number": "ST123-456",
  "status": 1,
  "invoice_type": 0,
  "environment": "live"
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "Draft created successfully",
    "id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "Draft updated successfully"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "drafts": [
      {
        "id": 123,
        "environment": "sandbox",
        "created_on": "2026-08-30 20:41:45",
        "json_data": "{\"document_kind\":\"quotation\",\"client_name\":\"Example Customer\",\"invoice_detail\":[{\"description\":\"Example item\",\"unit_price\":100,\"quantity\":1}]}"
      }
    ],
    "pagination_meta": {
      "current_page": 1,
      "pages": 1,
      "per_page": 20,
      "total": 1
    }
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "id": 123,
    "environment": "sandbox",
    "status": 1,
    "created_on": "2026-08-30 20:41:45",
    "json_data": "{\"document_kind\":\"quotation\",\"client_name\":\"Example Customer\",\"invoice_detail\":[{\"description\":\"Example item\",\"unit_price\":100,\"quantity\":1}]}",
    "quotation_summary": {
      "quotation_reference": "Q-00123",
      "document_kind": "quotation",
      "invoice_issued": false,
      "currency": "SAR",
      "items": [
        {
          "description": "Example item",
          "quantity": 1,
          "unit_price": 100,
          "discount_percent": 0,
          "discount": 0,
          "vat_percent": 0,
          "vat": 0,
          "total": 100
        }
      ],
      "sub_total": 100,
      "discount": 0,
      "taxable_amount": 100,
      "vat": 0,
      "total": 100
    }
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

%PDF-1.7 (binary PDF content)

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "message": "Draft deleted successfully"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "sale_report": [
      {
        "month_name": "September 2026",
        "company_name": "Example Company",
        "total": 460,
        "vat": 60,
        "net": 400,
        "sale_net": 400,
        "sale_vat": 60,
        "sale_total": 460,
        "credit_net": 0,
        "credit_vat": 0,
        "credit_total": 0
      }
    ]
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "sale_sub_total": 1000,
    "sale_vat": 150,
    "sale_discount": 0,
    "purchase_sub_total": 200,
    "purchase_vat": 30,
    "purchase_discount": 0,
    "credit_total": 0,
    "debit_total": 0,
    "vat_out": 150,
    "vat_in": 30,
    "vat_payable": 120
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

Binary XLSX workbook

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

Binary XLSX workbook

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "status": "draft",
    "status_label": "Draft",
    "next_step": "review_info",
    "environment": "sandbox",
    "is_sandbox": true,
    "is_integrated": false,
    "is_renewal_flow": false,
    "can_manage": true,
    "can_refresh": true,
    "can_renew": false,
    "can_retry_compliance_checks": false,
    "company_name": "Example Company",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "source": "api",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "status": "draft",
    "status_label": "Draft",
    "next_step": "review_info",
    "environment": "sandbox",
    "is_sandbox": true,
    "is_integrated": false,
    "is_renewal_flow": false,
    "can_manage": true,
    "can_refresh": true,
    "can_renew": false,
    "can_retry_compliance_checks": false,
    "company_name": "Example Company",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "source": "api",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "status": "awaiting_otp",
    "status_label": "Awaiting OTP",
    "next_step": "enter_otp",
    "environment": "sandbox",
    "is_sandbox": true,
    "is_integrated": false,
    "is_renewal_flow": false,
    "can_manage": true,
    "can_refresh": true,
    "can_renew": false,
    "can_retry_compliance_checks": false,
    "company_name": "Example Company",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "source": "api",
    "user_id": 123,
    "csr_generated_on": "2026-08-30T20:42:00Z",
    "csr_expires_on": "2026-08-31T20:42:00Z"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "status": "production_issued",
    "status_label": "Integrated",
    "next_step": "completed",
    "environment": "sandbox",
    "is_sandbox": true,
    "is_integrated": true,
    "is_renewal_flow": false,
    "can_manage": true,
    "can_refresh": true,
    "can_renew": true,
    "can_retry_compliance_checks": false,
    "company_name": "Example Company",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "source": "api",
    "user_id": 123,
    "activated_on": "2026-08-30T20:48:00Z",
    "production_issued_on": "2026-08-30T20:48:00Z"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "status": "production_issued",
    "status_label": "Integrated",
    "next_step": "completed",
    "environment": "sandbox",
    "is_sandbox": true,
    "is_integrated": true,
    "is_renewal_flow": false,
    "can_manage": true,
    "can_refresh": true,
    "can_renew": true,
    "can_retry_compliance_checks": false,
    "company_name": "Example Company",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "source": "api",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "status": "awaiting_otp",
    "status_label": "Awaiting OTP",
    "next_step": "enter_otp",
    "environment": "sandbox",
    "is_sandbox": true,
    "is_integrated": false,
    "is_renewal_flow": false,
    "can_manage": true,
    "can_refresh": true,
    "can_renew": false,
    "can_retry_compliance_checks": false,
    "company_name": "Example Company",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "source": "api",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "status": "awaiting_otp",
    "status_label": "Awaiting OTP",
    "next_step": "enter_otp",
    "environment": "sandbox",
    "is_sandbox": true,
    "is_integrated": false,
    "is_renewal_flow": true,
    "can_manage": true,
    "can_refresh": true,
    "can_renew": false,
    "can_retry_compliance_checks": false,
    "company_name": "Example Company",
    "company_registration_number": "1010000000",
    "company_vat_number": "300000000000003",
    "source": "api",
    "user_id": 123
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "status": "Not configured",
    "active": false,
    "verified": false,
    "revision": 0,
    "domain": "",
    "records": [],
    "test_status": "not_sent",
    "sandbox": false,
    "draft": null,
    "details": {
      "sender_name": "",
      "sender_email": "",
      "reply_to": [],
      "subject": "Invoice {invoice_number}",
      "body_html": "<p>Your invoice is ready.</p>"
    },
    "provider_ready": true,
    "error": "",
    "deliveries": []
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}

{
  "status": true,
  "response": {
    "subject": "Invoice TEST-001",
    "html": "<!doctype html><html><body><p>Your invoice is ready.</p></body></html>"
  }
}

{
  "status": false,
  "response": [
    "Invalid request data."
  ]
}

{
  "status": false,
  "response": "Invalid API key"
}