Set up profiles, code mappings, partner endpoints and policies

Maintain the country profiles, code lists, buyer endpoints, retry policies and retention policies that shape every e-invoice.

Required permission: einvoicing.configure; einvoicing.activate (review and activate)

Before you begin

  • Most items begin as a Draft. Profiles, providers, retry and outage policies and retention policies need a second person to Review and Activate. Code mappings, rejection codes and partner endpoints can be activated by the person who configures them.
  • A used profile is not edited. Make a new version.

Country profiles

A profile decides which document a posted invoice becomes: country, customer type (Business, Consumer, Government), documents (Invoice, Credit note), format (PINT AE or ZATCA UBL 2.1), flow, provider and dates. Four profiles are supplied and Active in Test after the sandbox start.

  1. Open E-invoicing > Configuration > Country profiles.
  2. Click New and enter Code, Name, Country, Customer type, Documents, Format (it must match the country), Flow, Issue order, Provider and Environment.
  3. Choose the Flow: Exchange and report (UAE), Clearance before issue (KSA standard) or Reporting after issue (KSA simplified). A clearance profile must clear before it issues.
  4. Set Effective from, Effective to and Priority. A submission uses the profile whose dates cover the invoice date. Lower priority numbers win. Two active profiles cannot cover the same country, customer type, document and dates at the same priority.
  5. Tick Signed if a signing key is required before anything is sent.
  6. Add Extra required fields as canonical paths if you want stricter checks.
  7. Save. A second person clicks Review, then Activate.

Click Run conformance to check a profile against local sample invoices and credit notes: required elements, totals carried exactly, and for ZATCA the hash, signature and QR. The result is stored with that exact version. A production profile needs Certified ticked, at least 10 characters of acceptance evidence and a passed conformance run for that version.

To change a profile that has submissions, click New version. It is a Draft copy. Activating it archives the old version. New invoices use it; old submissions keep the version they were built with.

Note:

The conformance run is the module's own reading of the formats. It is not the official PINT AE schematron or ZATCA SDK validation.

Code mappings

Mappings translate your codes into the external code list of the profile.

  1. Open Configuration > Code mappings and click New.
  2. Choose the List (Unit of measure, Tax category, Payment means, Document type, Exemption reason code).
  3. Enter Our code and Their code, and optionally a profile. A profile's own row beats the generic row.
  4. Save and click Activate. A draft mapping is not used.

Example: mapping unit carton to CT makes lines in cartons carry CT. Unknown units fall back to C62.

Partner endpoints

An endpoint is a customer's e-invoicing address and registration.

  1. Open Configuration > Partner endpoints and click New.
  2. Choose the Partner.
  3. Choose the Endpoint scheme: 0235 (UAE TIN), 0088 (GLN) or 9957 (Peppol participant), and enter the Endpoint identifier. A 0235 identifier is 15 digits starting with 1. A 0088 identifier is a 13-digit GLN with a valid check digit.
  4. Optionally set the Registration (UAE TRN, KSA VAT, commercial registration or national ID) and number. A UAE TRN is 15 digits starting with 1. A KSA VAT number is 15 digits starting and ending with 3. These override the partner's tax id on e-invoices.
  5. Enter the address: building number (4 digits), street, district, city, postal code, additional number, country. These override the partner's invoice address.
  6. Set Active from and Active to if needed, save and click Activate.
  7. Click Verify endpoint. Against the sandbox the result is "verified" or "failed"; a real directory lookup is not built yet.

A Saudi standard invoice needs the buyer's building number, street, district, postal code and city, or it is blocked.

Retry and outage policies

Open Configuration > Retry and outage policies. Set Maximum attempts (1 to 20), First retry after and Longest wait (seconds), Jitter % (0 to 50), Ask before resending, Deadline (hours from issue) and Escalate after (hours). A policy with no profile applies to every profile; a profile-specific policy wins. The Saudi simplified policy has a 24-hour deadline.

The May issue while the provider is down option needs a named official rule of at least 10 characters. In this release the setting is recorded only; it does not change how documents are issued.

Rejection codes and retention

  • Rejection codes explain a provider code (field, meaning, who repairs, how). They fill the Issues tab when the provider returns only a code.
  • Retention policies record how many years evidence is kept (1 to 30; supplied drafts are 5 years for the UAE and 6 for Saudi Arabia), legal hold and archive location. No automatic deletion exists yet; the policy is a record.

Good to know

  • Production profile and provider checks are strict by design; read the message to see which gate is missing.
  • Edits to a Reviewed record send it back to Draft.