finaX Logo
API Reference
Release Notes

Changelog

Latest updates and changes to the finaX API.

1.8.6

  • We fixed a validation error for BR-DE-27 and BR-DE-28 when no phone number or email address for a seller contact is provided an error occured.

1.8.5

  • We added x-finax-cius - None to disable CIUS validation for the UBL endpoint. This is useful for users who want to create UBL invoices which do not conform to PEPPOL EN16931.

1.8.4

  • We fixed an issue that caused french ZUGFeRD invoices to not be generated correctly.

1.8.3

  • Bumps a dependency for PDF generation to fix memory seg faults.

1.8.2

  • New feature: Generate PDF invoices also in English and French. We added a language parameter to the PDF generation endpoint payloads. Supported values are de (default), en and fr.
  • We added a text endpoint in the documentation to retrieve the api's version: https://docs.finax.dev/api-version

1.8.1

  • We added the display of invoice line invoicing period to PDF generation endpoints

1.8.0

  • New feature: Added support for Peppol BIS Billing invoices. Create UBL Peppol BIS Billing 3.0 compliant invoices using the /v1/xml/ubl endpoint. It is also possible to read UBL Peppol BIS Billing 3.0. Set x-finax-cius header set to Peppol BIS Billing 3.0. More information can be found in the documentation.
  • We fixed a bug where CreditNote documents would not be recognized in /v1/json/xml/.

1.7.9

  • We fixed a redirect error for the /v1/json/xml/ endpoint.

1.7.8

  • We fixed an error with indexing lists in tax error messages. This lead to HTTP 500 errors in some cases.

1.7.7

  • We fixed some minor issues with json path error formatting.
  • It was possible to set an empty string for payment_terms (BT-20) which caused issues in BR-CO-25 validation. Now an empty string is treated as not set.

1.7.6

  • We fixed another issue that caused server errors for BR-CO-14 and BR-CO-18.

1.7.5

  • We fixed an issue where BR-CO-17 could cause a server error.

1.7.4

  • We fixed an issue where "None" was displayed as namespace in HTTP 422 xpath error messages.
  • We fixed an issue that caused a server error when BR-CO-14 validation failed.

1.7.3

  • We fixed an issue where validation_mode=lax still validated strict (UBL and CII endpoints).
  • The default validation_mode is not explicitly set to lax for backwards compatibility.

1.7.2

  • We added some more German HTTP 422 error message translations.
  • We added XPath selectors also for business rule errors (HTTP 422).
  • The dotted json paths in HTTP 422 error field have been improved.
  • The message in HTTP 422 errors are now more humane.
  • Currency codes have been updated.
  • We fixed minor display issues in the PDF footer.

1.7.1

  • Fix for validation of inputs for JSON extracting endpoints. XMLs with encoding definitions caused an error.

1.7.0

This minor release, again, improves the error messages for HTTP 422 validation failures.

  • Endpoints with XML input (XRechnung and ZUGFeRD) return the XPath for the given document in field in case the validation failed with HTTP 422.
  • UBL XML inputs are now verified for PEPPOL-EN16931-R008 (empty tags).
  • HTTP 422 errors now contain a field business_term the caused the validation failure.
  • We fixed a typo in tax validation messages.

1.6.1

  • We fixed an issue with the tax validation for VAT category "E" - buyer identifiers were required which was wrong.

1.6.0

This minor version release contains a couple of changes concerning error messages. We extended the validation error messages, which are returned with HTTP 422. We recommend this update for users which want to make use of more detailed error messages.

  • We added Accept-Header functionality to switch the language error messages.
  • If a business rule was violated a field in the error message displays the name of the business rule.

1.5.23

  • Fix issue when logo file field for PDF generation is empty. Now returns pdf without logo.
  • Fix issue when reading CII - BG-4 (seller) with multiple identifiers and first one has no scheme identifier.

1.5.22

  • We fixed some missing validation rules for PDF from JSON endpoint (/v1/pdf/json/).

1.5.21

  • We restructured PDF endpoints in the documentation and removed the "experimental" label from the visualization endpoints.
  • We added 2 new endpoints - one to extract pdf xml metadata from a ZUGFeRD file and one to extract the invoice xml from a ZUGFeRD file.

1.5.20

  • We fixed a minor internal bug with the tracing middleware. No user was impacted.
  • We fixed an issue with mixed structured and unstructured content in BT-20. Users using BT-20 are now able to mix content.

1.5.19

  • We added a new header x-finax-trace-id. If set it will be returned in the response headers.

1.5.18

  • We now automatically replace depcreated electronic address scheme identifiers (9917, 9956, 9958).
  • We fixed an issue for ZUGFeRD generation when only some lines are discounted.
  • We removed unwanted linebreaks between currencies and amounts in ZUGFeRD generation.

1.5.17

  • We tweaked the error handler extracting invoice JSON from ZUGFeRD PDFs.

1.5.16

  • We added an error message for Comfort Profile (ZUGFeRD 1).
  • We improved the search for conformance level indicators in ZUGFeRD.

1.5.15

  • We improved the error handling / message for PDFs with an undeterminable conformance level.

1.5.14

  • We refactored the error message for missing files in PDFs.
  • We fixed a bug which caused peppol_en16931_r120 to be applied in CII.

1.5.13

  • We improved the file name recognition for ZUGFeRD files.
  • We fixed the optional input for BT-41 for EN16931 ZUGFeRD files.
  • We improved the error message for unrecognized attachments in ZUGFeRD files.
  • We made BT-132 for reading CII XML optional.

1.5.12

  • We fixed an issue concerning BT-48, which should be optional in UBL syntax.

1.5.11

  • We added rate limit headers to responses.

1.5.10

  • We fixed the error message for BR-DE-25.
  • We added the buyer vat id to zugferd visualization.

1.5.9

  • We added a description for the 415 HTTP error code to the docs.
  • We relaxed the Content-Type header check slighty to accept values like application/json; charset=utf-8.

1.5.8

  • We added an improved IBAN validation.
  • For logos in the pdf creation endpoints - invalid base64 strings now raise an error.

1.5.7

  • We added an option to insert a logo into PDF generated files.
  • Generated "reverse charge invoices" will automatically have an added hint concerning reverse charge.

1.5.6

  • We fixed an issue with the visualization of line items without vat rate.
  • We fixed a line break issue in the invoice line item description for pdf generation.

1.5.5

  • We fixed an issue with PDF generation for UBL files. The transformation of random tax scheme identifiers, which can be used in UBL potentially failed here.
  • We disabled the currency for Sierra Leone, since it it rejected by the KoSIT validation (request in progress).

1.5.4

  • We fixed a floating point bug (rounding) for the validation rule PEPPOL EN16931 R040.

1.5.3

  • We fixed a bug for the validation of the summation of charges and allowances on the document total level.
  • We added an endpoint which takes UBL or CII and converts it to JSON.

1.5.2

  • We fixed a bug for the summation of charges and allowances on the document total level for VAT category S.

1.5.1

  • We fixed an issue with the payment terms visualization (days have been cut off).
  • We added more ZUGFeRD CII invoice type codes.
  • We fixed a bug for corrected invoices (CII only).

1.5.0

  • We added support for ZUGFeRD EN-16931 (Comfort) profile.
  • We added the Content-Type header to the programming samples.

1.4.23

  • We fixed the error message for vat exemption reason codes and vat exemption reason texts.
  • We updated the Postman collection to contain trailing slashes. This avoids a redirect.
  • We updated the examples for the experimental pdf endpoints.

1.4.22

  • We fixed an issue with delivery addresses in the experimental template rendering of invoices.

1.4.21

  • We fixed an issue with date parsing.
  • We added samples in many programming languages to our documentation.

1.4.20

  • We fixed the missing "Basisbetrag" in the payment_terms (BT-20) validation (BR-DE-18).
  • We fixed a typo in the tax validation error messages.
  • We added a hint for "Leitweg-ID" / BT-10 in the docs.

1.4.19

  • We added endpoints for pdf rendering from UBL, CII and JSON.

1.4.18

  • We added a validation for minimum length for mandatory string fields.

1.4.17

  • We added validation_mode to XML generation. Read more in our docs. Furthermore BT-130 and BT-150 allow now also arbitrary strings for XML2JSON endpoints. The changes are backwards compatible.
  • We removed version and extension from XML2JSON API responses, since these always just displayed the default values.

1.4.16

  • We removed the validation for BR-DE-12 since this is not officially enforced by the schema. This now allows for foreign post codes for delivery addresses.
  • We added a more clear error message for unprocessable PDF files.

1.4.15

  • We made enums in the documentation collapsible and default collapsed for less scrolling.
  • We fixed the decimal places for BT-148 and >= condition for BT-146 and BT-148.

1.4.14

  • We added a metrics exporter for how often which endpoint gets called. This should help us improve finaX SaaS offering.

1.4.13

1.4.12

  • We now provide a more clear error message for unprocessable XML attachments in pdf files.
  • We fixed an issue in the peppol en16931 r046 rule validation. If discounts have been provided explictly as null this caused the rule to fail.
  • We improved JSON decode error messages for invalid JSON payloads.
  • The credit note invoice type is now allowed for UBL. We recommend using CII for credit notes.

1.4.11

  • We fixed a rounding issue in the vat breakdown validation.

1.4.10

  • We exclude unset fields now in JSON from XML (XML2JSON) as they are not needed.
  • We improved the error messages for tax validation (BR-AE-8, BR-E-8, BR-G-8, BR-IC-8, BR-IG-8, BR-IP-8 BR-O-8, BR-S-8, BR-Z-8).

1.4.9

  • We fixed tax values for the examples in our docs.
  • Added a better error message for XML parsing errors.

1.4.8

  • We fixed documenation example values and added tests for those.

1.4.7

  • Added a better error message for wrong content-type header

1.4.6

  • Added X-FINAX-API-VERSION response HTTP header to all API endpoints
  • Internal Rework exceptions for missing values
  • Add Business Terms information to docs

1.4.5

  • We updated the docs and incorporated the CII test payloads from https://github.com/itplr-kosit/xrechnung-testsuite/.
  • This release contains some bugfixes for CII invoice generation.
  • The Postman collection was updated with the latest examples.
  • The docs now include a cURL example.
  • Tests were extended to Postman collection as well as PDF/Zugferd API endpoints.

1.4.4

Unfortunately previous release notes are not available.

Business Rules

e-invoice validation rules for different CIUS