fawtar_list

List records from any Fawtar resource, with filtering, sorting and paging. Resources: - invoices: إصدار الفواتير الضريبية وقراءتها. - credit_notes: تصحيح فاتورة صادرة بالخصم. - debit_notes: تصحيح فاتورة صادرة بالزيادة. - quotes: عروض الأسعار قبل تحوّلها إلى فواتير. - orders: طلبات المتجر قبل الفوترة. - customers: بيانات العملاء وأرقامهم الضريبية والعنوان الوطني. - products: المنتجات والخدمات وأسعارها. - categories: تصنيفات المنتجات. - product_unit_types: وحدات بيع المنتجات. - vendors: بيانات الموردين. - bills: فواتير الموردين ببنودها. - simple_bills: مصروف بمبلغ واحد دون بنود. - bill_payments: سداد فواتير الموردين. - inventories: المستودعات والفروع. - inventory_levels: الكميات المتاحة لكل منتج في كل مستودع. - inventory_adjustments: زيادة أو إنقاص كمية بسبب جرد أو تلف. - inventory_transfers: نقل كمية بين مستودعين. - invoice_payments: تسجيل دفعة على فاتورة. - receipts: الدفعات نفسها بصيغة سند القبض. - accounts: شجرة الحسابات وأنواعها. - journal_entries: القيود المرحّلة إلى دفتر الأستاذ. - recurring_journals: جدولة القيود التي تتكرر كل فترة. - employees: بيانات الموظفين ورواتبهم وبدلاتهم. - payroll_runs: المسيّرات الشهرية وإجمالياتها. - payslips: قسيمة كل موظف داخل المسيّر. - assets: سجل الأصول وإهلاكها. - pos_tables: طاولات صالة المطعم. - pos_orders: طلبات نقاط البيع المفتوحة والمحصّلة. Filters use the form {"field_predicate": "value"} — for example {"status_eq": "issued"} or {"issued_at_gteq": "2026-01-01"}. Predicates: eq, not_eq, cont, start, end, gt, gteq, lt, lteq, in, null. Only fields the resource allows are honoured; anything else is ignored.

Parameters5

resource	string	required	Which resource to list.
filters	object	optional	Ransack-style filters, e.g. {"status_eq":"issued"}.
sort	string	optional	Sort as "field asc" or "field desc".
page	integer	optional
limit	integer	optional

Raw schema

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "invoices",
        "credit_notes",
        "debit_notes",
        "quotes",
        "orders",
        "customers",
        "products",
        "categories",
        "product_unit_types",
        "vendors",
        "bills",
        "simple_bills",
        "bill_payments",
        "inventories",
        "inventory_levels",
        "inventory_adjustments",
        "inventory_transfers",
        "invoice_payments",
        "receipts",
        "accounts",
        "journal_entries",
        "recurring_journals",
        "employees",
        "payroll_runs",
        "payslips",
        "assets",
        "pos_tables",
        "pos_orders"
      ],
      "description": "Which resource to list."
    },
    "filters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Ransack-style filters, e.g. {\"status_eq\":\"issued\"}."
    },
    "sort": {
      "type": "string",
      "description": "Sort as \"field asc\" or \"field desc\"."
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "default": 1
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 25
    }
  },
  "required": [
    "resource"
  ]
}

fawtar_get

Fetch a single record by id. For invoices this also returns the line items and the public share link.

Parameters2

resource	string	required
id	string	required	The record's uuid.

Raw schema

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "invoices",
        "credit_notes",
        "debit_notes",
        "quotes",
        "orders",
        "customers",
        "products",
        "categories",
        "product_unit_types",
        "vendors",
        "bills",
        "simple_bills",
        "bill_payments",
        "inventories",
        "inventory_levels",
        "inventory_adjustments",
        "inventory_transfers",
        "invoice_payments",
        "receipts",
        "accounts",
        "journal_entries",
        "recurring_journals",
        "employees",
        "payroll_runs",
        "payslips",
        "assets",
        "pos_tables",
        "pos_orders"
      ]
    },
    "id": {
      "type": "string",
      "description": "The record's uuid."
    }
  },
  "required": [
    "resource",
    "id"
  ]
}

fawtar_create

Create a customer, product, vendor, employee, asset or other simple record. Use fawtar_create_invoice for invoices — issuing one claims a sequential number, computes VAT, writes the QR and posts to the ledger, none of which a generic insert does. Creatable resources: quotes, orders, customers, products, categories, product_unit_types, vendors, bills, simple_bills, bill_payments, inventories, inventory_adjustments, inventory_transfers, invoice_payments, accounts, journal_entries, employees, assets, pos_tables.

Parameters2

resource	string	required
data	object	required	The record's fields.

Raw schema

{
  "type": "object",
  "properties": {
    "resource": {
      "type": "string",
      "enum": [
        "quotes",
        "orders",
        "customers",
        "products",
        "categories",
        "product_unit_types",
        "vendors",
        "bills",
        "simple_bills",
        "bill_payments",
        "inventories",
        "inventory_adjustments",
        "inventory_transfers",
        "invoice_payments",
        "accounts",
        "journal_entries",
        "employees",
        "assets",
        "pos_tables"
      ]
    },
    "data": {
      "type": "object",
      "additionalProperties": true,
      "description": "The record's fields."
    }
  },
  "required": [
    "resource",
    "data"
  ]
}

fawtar_create_invoice

Issue a tax or ordinary invoice. This is a real financial document: it takes the next sequential number, computes VAT, generates the ZATCA QR code and posts to the general ledger. It cannot be edited afterwards — correct it with a credit note. Confirm the amounts with the user before calling. Use taxTreatment "tax" for a VAT-registered business, "ordinary" for one that is not registered. Use type "simplified" for individuals, "standard" for businesses (which requires the buyer's VAT number).

Parameters7

taxTreatment	string	required
type	string	required
pricesIncludeVat	boolean	optional
buyer	object	optional
lines	array	required
dueDate	string	optional	YYYY-MM-DD
notes	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "taxTreatment": {
      "type": "string",
      "enum": [
        "tax",
        "ordinary"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "simplified",
        "standard"
      ]
    },
    "pricesIncludeVat": {
      "type": "boolean",
      "default": false
    },
    "buyer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "vatNumber": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      }
    },
    "lines": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "quantity": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "unitPrice": {
            "type": "number",
            "minimum": 0
          },
          "vatRate": {
            "type": "number",
            "minimum": 0,
            "maximum": 1,
            "description": "0.15 for 15%."
          }
        },
        "required": [
          "description",
          "quantity",
          "unitPrice",
          "vatRate"
        ]
      }
    },
    "dueDate": {
      "type": "string",
      "description": "YYYY-MM-DD"
    },
    "notes": {
      "type": "string"
    }
  },
  "required": [
    "taxTreatment",
    "type",
    "lines"
  ]
}

fawtar_outstanding

Every unpaid issued invoice with its remaining balance and how many days it is overdue, newest due first, plus the totals. This is the answer to 'who owes me money' without composing filters by hand.

Parameters2

overdueOnly	boolean	optional	Only invoices past their due date.
limit	integer	optional

Raw schema

{
  "type": "object",
  "properties": {
    "overdueOnly": {
      "type": "boolean",
      "default": false,
      "description": "Only invoices past their due date."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    }
  }
}

fawtar_vat_summary

Output VAT charged on sales, input VAT paid on expenses, and the net payable for a date range — the figures a VAT return is built from. Recoverable input VAT only; expenses marked non-recoverable are excluded, as they must be.

Parameters2

from	string	required	YYYY-MM-DD, inclusive.
to	string	required	YYYY-MM-DD, inclusive.

Raw schema

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "description": "YYYY-MM-DD, inclusive."
    },
    "to": {
      "type": "string",
      "description": "YYYY-MM-DD, inclusive."
    }
  },
  "required": [
    "from",
    "to"
  ]
}

app.fawtar/fawtar

🛠️ Key Features

🚀 Use Cases

⚡ Developer Benefits

⚠️ Limitations

fawtar_list

fawtar_get

fawtar_create

fawtar_create_invoice

fawtar_outstanding

fawtar_vat_summary

Install

Remote endpoint

Related servers