Zatca | Fatoora - Integeration Helper

This project helps in integertation of systems to Zatca systems. Currently tested using their sandbox APIs.

🚀 Check Pro feature list for the Pro version, we already have more than 10 clients using our pro version.

NOTE: We have implemented similar solutions for many of our B2B clients in KSA, if you have similar requirements feel free to reach me at +91 - 9003095635

🔗 Contact

Write to me at [email protected]

🔗 NuGet Package

Follow below shell commands to generate CSR

we need a csr token to initiate compliance API request , more about what is CSR here -> https://en.wikipedia.org/wiki/Certificate_signing_request

#generate private key using below command
openssl ecparam -name secp256k1 -genkey -noout -out privatekey.pem

#generate csr using below command
openssl req -new -sha256 -key privatekey.pem -extensions v3_req -config cert.cnf -out generatedCSR.csr

#convert to base64
echo -n `cat generatedCSR.csr` | openssl enc -base64 -a -A >> csr_Output.txt

NOTE: Above script is bash/shell script, if you are running from windows cmd setup openssl and execute the commands or simply dowload the git bash (https://git-scm.com/download/win) which can help in execution

API Reference

Note: Global variables is a dependecy for all the classes , its parameters are described below

Parameter	Type	Description
BaseUrl	string	Required. Base url of zatca [Eg: https://gw-apic-gov.gazt.gov.sa]
ComplianceCsidEndpoint	string	Required. Compliance Csid endpoint [Eg: /e-invoicing/developer-portal/compliance]
ProdCsidEndpoint	string	Required. Prod csid endpoint [Eg : /e-invoicing/developer-portal/production/csids]
InvoiceClearanceEndPoint	string	Required. clearance endpoint [Eg: /e-invoicing/developer-portal/invoices/clearance/single]

Get Compliance CSR token

 ComplianceCsrApiClient(GlobalVariables).GetToken(ComplianceCsrRequest)

ComplianceCsrRequest Parameter	Type	Description
Otp	string	Required. OTP obatined from tax portal
Csr	string	Required. CSR token generated using above mentioned step

Get Prod CSID

  ProdCsidApiClient(GlobalVariables).GetToken(ProdCsidOnboardingRequest)

ProdCsidOnboardingRequest Parameter	Type	Description
ComplianceRequestId	string	Required. RequestId from the response of above endpoint
CsrBinaryToken	string	Required. Binary token from the response of above endpoint
CsrSecret	string	Required. Secret from the response of above endpoint

Generate xml

  StandardInvoiceXmlGenerator.Generate(StandardInvoice)

For parameters refer -> https://github.com/fasilmarshooq/Zatca_Integration_Helper/blob/main/Zatca-Standard-Invoice-Integration-Client/Model/StandardInvoice.cs

Clear Invoice

  StandardInvoiceClearanceApiClient(GlobalVariables).ClearInvoice(InvoiceClearanceRequest)

InvoiceClearanceRequest Parameter	Type	Description
Body	string	Required. response of above endpoint
BinaryToken	string	Required. Binary token from the response of Get Prod CSID endpoint
Secret	string	Required. Secret from the response of Get Prod CSID endpoint

Generate xml for Debit Note

  StandardInvoiceXmlGenerator.GenerateForDebitNote(StandardInvoiceAdjustment)

For parameters refer -> https://github.com/fasilmarshooq/Zatca_Integration_Helper/blob/main/Zatca-Standard-Invoice-Integration-Client/Model/StandardInvoiceAdjustment.cs

NOTE: use above clear Invoice endpoint to clear Debit Note

Generate xml for Credit Note

  StandardInvoiceXmlGenerator.GenerateForCreditNote(StandardInvoiceAdjustment)

For parameters refer -> https://github.com/fasilmarshooq/Zatca_Integration_Helper/blob/main/Zatca-Standard-Invoice-Integration-Client/Model/StandardInvoiceAdjustment.cs

NOTE: use above clear Invoice endpoint to clear Credit Note

Roadmap

• implement Allowance charge / Discount

• implement reporting api for simplified tax invoices

License

MIT

Trouble Shooting

• If you facing Schema validation execption without any error message please refer -> https://stackoverflow.com/questions/73388407/schema-validation-failed-xml-does-not-comply-with-ubl-2-1-standards-in-line-wit

• UBL Schema repo -> http://www.datypic.com/sc/ubl21/e-ns39_Invoice.html