fatoora-cli 0.6.0

Command-line interface for the fatoora ZATCA SDK
fatoora-cli-0.6.0 is not a library.

fatoority is an open-source SDK and CLI for Saudi e-invoicing. Build standard and simplified invoices from application data, including credit notes, debit notes, and prepayment invoices. Calculate totals and VAT, generate UBL XML, then sign and validate invoices locally before submitting them through the ZATCA APIs.

With bindings and support for many programming languages:

  • πŸ¦€ Rust

  • 🐍 Python

  • πŸ‡―β€ŒπŸ‡Έβ€Œ JavaScript / TypeScript

  • 🟣 C# / .NET

  • β˜• Kotlin / Java / Android

  • πŸŒ€ C/C++ (through the C FFI see releases)

  • πŸ”Œ Also, a Command Line Interface (CLI) Tool

Disclaimer: fatoority is not affiliated, associated, authorized, endorsed by, or in any way officially connected with ZATCA (Zakat, Tax and Customs Authority), or any of its subsidiaries or its affiliates. The official ZATCA website can be found at https://zatca.gov.sa.

πŸ—‚οΈ Documentation

Follow the complete sandbox walkthrough in Python, C#, or TypeScript: create an invoice, sign it, validate it, report it, and handle the response. The guide includes a ZATCA journey diagram and production changes.

For local XML output, start with invoice creation, browse the guides, or read the Rust API reference.

⚑ Features

Build into your application What fatoority provides
🧾 Invoice creation Typed builders for standard and simplified tax invoices, credit/debit notes, and prepayments; UBL XML output.
πŸ’° Pricing and VAT Exact decimal calculations, mixed VAT categories and rates, exemptions, line and document discounts/charges, price-base quantities, and payable totals.
πŸ’Ό Business document data Purchase orders, contracts, delivery dates, payment accounts/instructions, repeated references, and party/item identifiers.
</> XML import Read supported invoice fields into structured data. Signed import checks signature, digest, and QR consistency and retains the original XML.
βœ… Local validation UBL schemas and all 257 business-rule assertions in the pinned SDK 238-R3.4.8 profile, with structured findings and explicit stage coverage.
✍️ Invoice Signing Sign XML with a matching certificate and key, and compute invoice hashes.
π–£― QR Generation Generate base64 QR payloads or read them from signed XML.
πŸ“© CSR Generation Generate signing keys and certificate requests for device onboarding.
πŸ“¨ API Requests Obtain and renew credentials, check compliance, report simplified invoices, and request standard-invoice clearance.

Local invoice processing needs no official SDK installation or network access. The Rust core has no Java dependency. Use the JavaScript WebAssembly package in Node.js or a browser, and the Android artifact in mobile applications. API calls require network access; prepared requests let you use your own HTTP transport.

πŸš€ The recorded .NET benchmarks measured hashing at 8.5–14.1Γ—, signing at 11.3–15.6Γ—, and validation at about 44Γ— the speed of the official .NET SDK on the tested fixtures. The separate CLI hashing benchmark measured about 187Γ—, including process startup. See benchmarks for hardware, versions, timings, and reproduction instructions.

βš™οΈ The test suite includes property tests, fuzzing, and recorded comparisons with the official SDK. See SDK compatibility for the tested scope. Local validation does not establish certificate issuer trust or ZATCA gateway acceptance.

πŸ“₯ Installation

cargo add fatoora-core
pip install fatoority
npm install fatoority
dotnet add package Fatoority

Install a published release from Maven Central.

Gradle (build.gradle.kts):

repositories { mavenCentral() }
dependencies {
    implementation("com.fatoority:fatoority:0.6.0")
}

Maven (pom.xml):

<dependency>
  <groupId>com.fatoority</groupId>
  <artifactId>fatoority</artifactId>
  <version>0.6.0</version>
</dependency>

For Android, use com.fatoority:fatoority-android:0.6.0 instead of the desktop artifact. Java/Kotlin imports remain com.fatoora.

Download the fatoora-ffi-* archive for your platform from releases and extract it. The shared library is at the archive root. The C API header is include/fatoora.h, with its adapter in src/fatoora.c and generated headers in include/generated; C++ headers are in include/diplomat-cpp and expose types in namespace fatoora.

For example, on Linux, compile your application from the extracted directory:

cc -std=c11 -Iinclude app.c src/fatoora.c -L. -lfatoora_ffi -Wl,-rpath,'$ORIGIN' -o app
c++ -std=c++17 -Iinclude/diplomat-cpp app.cpp -L. -lfatoora_ffi -Wl,-rpath,'$ORIGIN' -o app-cpp

Include fatoora.h in C or fatoora/Config.hpp in C++. Keep the shared library beside these executables. On Windows, link the supplied import library and keep the DLLs from the archive beside your executable.

To build the library from a source checkout:

cargo build -p fatoora-ffi --release --locked

The C API provides one fatoora.h, plain strings, shared errors, and named-field options. Compile bindings/c/fatoora.c once with your application, add bindings/c to your include path, and link fatoora_ffi. Release archives also include the C examples under examples/c.

The library is written to target/release/. The generated headers are checked in under bindings/c/generated and bindings/cpp; raw ABI callers use those include paths and -Ltarget/release when compiling against a source build. Cargo does not regenerate headers. After changing bridge declarations, follow the Diplomat generation workflow.

The cli tool can also be installed with cargo:

cargo install fatoora-cli

Alternatively, you can grab the precompiled binary for your platform on the repo's releases (fatoora-cli-*). Extract the archive and run fatoora.

πŸ’‘ Examples

Build a simplified invoice with two SAR 50 items and 15% VAT. The library calculates SAR 15 VAT and a SAR 115 payable total, then writes invoice.xml. This example uses demonstration identity and invoice-history data; replace them for your integration. Running it replaces invoice.xml in the working folder.

Install with pip install fatoority, save as creation.py, and run python creation.py.

from datetime import datetime, timezone
from pathlib import Path
from uuid import UUID
from fatoora import (Address, InvoiceBuilder, InvoiceSubType, InvoiceTypeKind,
                     PaymentMeans, VatCategory)

seller_address = Address(
    "SA", "Riyadh", "King Fahd Road", "1234", "12222",
    additional_number="5678", district="Olaya",
)
invoice = (
    InvoiceBuilder(
        InvoiceTypeKind.TAX, InvoiceSubType.SIMPLIFIED,
        id="INV-1001",
        uuid=UUID("8e6000cf-1a98-4174-b3e7-b5d5954bc10d"),
        issue_datetime=datetime(2026, 10, 26, 9, 0, tzinfo=timezone.utc),
        currency="SAR",
        # Demonstration predecessor; use your own invoice history in production.
        previous_invoice_hash="NWZlY2ViNjZmZmM4NmYzOGQ5NTI3ODZjNmQ2OTZjNzljMmRiYzIzOWRkNGU5MWI0NjcyOWQ3M2EyN2ZiNTdlOQ==",
        invoice_counter=1,
        vat_category=VatCategory.STANDARD,
    )
    .set_seller("Example Store", address=seller_address, vat_id="399999999900003",
                other_id="7003339333", other_id_scheme="CRN")
    .add_payment_means(PaymentMeans("10"))
    .add_line_item(description="Notebook", quantity="2", unit_code="PCE", unit_price="50",
                   vat_rate="15", vat_category=VatCategory.STANDARD)
    .build()
)
Path("invoice.xml").write_text(invoice.xml, encoding="utf-8")
totals = invoice.totals
print(f"VAT: {totals.tax_amount} SAR")
print(f"Payable: {totals.payable_amount} SAR")
print("Saved invoice.xml")

See invoice creation for the Rust example and next steps. Building checks model fields and arithmetic; run local validation separately before submission.

Rust

use fatoora_core::config::Environment;
use fatoora_core::csr::{CsrProperties, SigningKey};

let props = CsrProperties::from_file("csr.properties")?;
let key = SigningKey::generate();
let csr = props.build(&key, Environment::NonProduction)?;
let csr_pem = csr.to_pem()?;
let key_pem = key.to_pem()?;

Python

from fatoora import CsrProperties, Environment, SigningKey

props = CsrProperties.from_file("csr.properties")
key = SigningKey.generate()
csr = props.build(key, Environment.NON_PRODUCTION)
csr_pem = csr.to_pem_base64()
key_pem = key.to_pem()

JavaScript

import { CsrProperties, Environment, SigningKey } from 'fatoority';

const key = SigningKey.generate();
const csr = CsrProperties.fromStr(propertiesText).build(key, Environment.NonProduction);
const csrPem = csr.toPem();

CLI

fatoora csr --csr-config csr.properties --generated-csr csr.pem --private-key key.pem --pem

Rust

use fatoora_core::invoice::sign::InvoiceSigner;

let cert_pem = std::fs::read_to_string("cert.pem")?;
let key_pem = std::fs::read_to_string("key.pem")?;
let signer = InvoiceSigner::from_pem(cert_pem.trim(), key_pem.trim())?;
let xml = std::fs::read_to_string("invoice.xml")?;
let signed_xml = signer.sign_xml(&xml)?;

CLI

fatoora sign --invoice invoice.xml --cert cert.pem --key key.pem --signed-invoice signed.xml

Rust

use fatoora_core::invoice::validation::{Validator, ZatcaValidationOptions};

let xml = std::fs::read_to_string("invoice.xml")?;
let options = ZatcaValidationOptions {
    previous_invoice_hash: Some(previous_hash_from_history),
    ..Default::default()
};
let report = Validator::new().validate_zatca(&xml, &options)?;
if !report.is_valid() {
    // Inspect stages and findings; missing predecessor context is incomplete.
}

CLI

fatoora validate --invoice invoice.xml --profile zatca --format json \
  --previous-invoice-hash "$PREVIOUS_INVOICE_HASH"

The local profile implements all 257 business-rule assertions from SDK 238-R3.4.8, plus applicable signature, QR and predecessor checks. It preserves warnings and partial reports. Standard invoices skip signature/QR checks under this SDK profile. Local validation does not establish issuer trust or remote acceptance. Validator::validate_xml and the default CLI profile continue to check XSD only.

Rust

use fatoora_core::invoice::xml::parse::parse_signed_invoice_xml;

let xml = std::fs::read_to_string("signed.xml")?;
let signed = parse_signed_invoice_xml(&xml)?;
let qr = signed.qr_code();

CLI

fatoora qr --invoice invoice.xml
fatoora qr --invoice signed.xml
fatoora qr --invoice signed.xml --fail-on-signed
fatoora qr-read --invoice signed.xml

Rust

use fatoora_core::invoice::xml::parse::parse_finalized_invoice_xml;

let xml = std::fs::read_to_string("invoice.xml")?;
let invoice = parse_finalized_invoice_xml(&xml)?;
let hash = invoice.hash()?;

CLI

fatoora generate-hash --invoice invoice.xml

Rust

use fatoora_core::invoice::xml::parse::parse_signed_invoice_xml;

let xml = std::fs::read_to_string("signed.xml")?;
let signed = parse_signed_invoice_xml(&xml)?;
let payload = serde_json::json!({
    "invoiceHash": signed.invoice_hash(),
    "uuid": signed.uuid(),
    "invoice": signed.to_xml_base64(),
});

CLI

fatoora invoice-request --invoice signed.xml --api-request request.json

For discounts, mixed VAT, credit notes, and prepayments, see the invoice recipes.

🀝 Contributing

Contributions are always welcome! See CONTRIBUTING.md for more details.

πŸͺ§ Roadmap

  • Increase test coverage to 100% (Inshallah)
  • Expand bindings to other languages (subject to demand)
  • PDF invoice generation

Author πŸ€“

This project began as a personal undertaking, and continues to be developed and maintained by me @mqqz.

While this means development happens alongside other commitments, I do my best to keep the project maintained and responsive to issues. Contributions, feedback, and suggestions are always welcome.

If you or your team are working on fintech or ZATCA integrations and need help building reliable scalable infrastructure, feel free to get in touch.

πŸ”— Relevant Links

License

This project's code is licensed under either the MIT License or the Apache License, Version 2.0, at your option.

Third-party schemas, fixtures, templates, and dependencies retain their applicable upstream licenses and notices. The project license does not relicense those materials.

See third-party notices for attribution, applicable terms, and outstanding permission questions.