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.
輸入參數pagesortlimitfiltersresource必填
fawtar_get
Fetch one record
Fetch a single record by id. For invoices this also returns the line items and the public share link.
輸入參數id必填resource必填
fawtar_create
Create a record
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: orders, customers, products, categories, product_unit_types, vendors, inventories, accounts, pos_tables.
輸入參數data必填resource必填
fawtar_create_invoice
Issue an 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).
輸入參數type必填buyerlines必填notesdueDatetaxTreatment必填pricesIncludeVat
fawtar_outstanding
What is owed to this business
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.
輸入參數limitoverdueOnly
fawtar_vat_summary
VAT for a period
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.
輸入參數to必填from必填
