ZATCA e-invoicing in Ruby on Rails
One HTTP request from Ruby on Rails (Net::HTTP + ActiveRecord): Matheel builds the invoice, signs it, files it with ZATCA and returns ZATCA's answer, the legal XML and the PDF with the QR.
1. Try it now (no key)
require "net/http"; require "json"
r = Net::HTTP.post(URI("https://matheel.app/api/v1/invoices"),
{ environment: "sandbox", pdf: true, invoice: {
type: "simplified", line_items: [{ name: "قهوة", quantity: 2, price: "50.00" }] } }.to_json,
"Content-Type" => "application/json")
puts JSON.parse(r.body)["status"] # reported
2. The ready function, after payment
It locks the device row (so two payments at once never fork the chain), files the invoice with "pdf": true and saves the new device_token. Any non-200 rolls the transaction back and the old token stays valid.
# ActiveRecord: `lock` is SELECT … FOR UPDATE; any exception rolls the transaction back.
def matheel_invoice(items)
MatheelDevice.transaction do
device = MatheelDevice.lock.find(1)
r = Net::HTTP.post(URI("https://matheel.app/api/v1/invoices"),
{ device_token: device.token, pdf: true, invoice: { type: "simplified", line_items: items } }.to_json,
"Content-Type" => "application/json", "Authorization" => "Bearer #{ENV.fetch("MATHEEL_KEY")}")
res = JSON.parse(r.body)
raise "matheel #{r.code}: #{res}" unless r.code == "200"
device.update!(token: res["device_token"])
res # Base64.decode64(res["pdf"]) is the PDF
end
end
3. For production
- Register your device once (device token or an activation link) and put its
device_tokenin thematheel_devicetable. - If your amount includes VAT, send
"prices_include_vat": true. - Keep
invoice_xml(the legal copy) andpdfwith the order; your app shows the PDF from your server.
FAQ
Do I need a ZATCA library for Ruby on Rails?
No. Matheel is a plain JSON API: one HTTP request. Signing, the XML, the certificate and filing with ZATCA all happen at Matheel.
Where do I keep the device token?
One row in your database (a matheel_device table). After every 200, save the new device_token in the same transaction.
Can I try before subscribing?
Yes, on the developer sandbox without a key: the request below returns ZATCA's real answer and the PDF.