README

Copy Markdown View Source

VatchexGreece

An Elixir library to easily pull company information from the RgWsPublic2 SOAP web service (new since 2023-04-20) of the Greek General Secretariat of Information Systems for Public Administration (GSIS) using the Tax Identification Number (Αριθμός Φορολογικού Μητρώου, abbreviated as "ΑΦΜ" or "Α.Φ.Μ.").

Note: this project is a volunteer effort and not in any way affiliated with GSIS or the data service providers of the Greek Ministry of Finance.

Installation

The package is available on Hex and can be installed by adding vatchex_greece to your list of dependencies in mix.exs.

def deps do
  [
    {:vatchex_greece, "~> 1.0"},
  ]
end

Usage

Refer to the documentation on HexDocs.

Changelog

v1.0.0

Breaking changes vs. v0.8.0

The legacy pipeline API has been removed for the 1.0 release.

  • VatchexGreece.new/4 and VatchexGreece.get/1 are gone.
  • VatchexGreece.Validate.all_valid/1 is no longer public (internal validation logic remains private).
  • The top-level legacy structs (APIauth, GSISdata, Results, NACEactivity) are now strictly internal (@moduledoc false) and no longer referenced in public documentation.
  • Only the high-level fetch/1 / fetch!/1 API is part of the supported public surface.
  • fetch!/1 now raises VatchexGreece.FetchError.
  • All other modules (VatchexGreece.Request, VatchexGreece.Processing, VatchexGreece.Validate, and the legacy structs) are now strictly internal (@moduledoc false) and hidden from generated documentation.
  • The internal pipeline (accumulator + steps) remains but is not part of the public API.

Improvements

  • Log info, error and debug messages for some situations.
  • Always send as_on_date (today) in requests, to match the reference Java client implementation.
  • Post requests to the service endpoint (without ?wsdl) instead of the WSDL URL.
  • Properly detect and return service errors from the error_rec in responses (previously, errors from the GSIS service would result in {:ok, %{... all nils ...}} with only as_on_date populated, masking the actual error).
  • Removed early string-based auth error check in favor of general service error handling (auth errors now surface with their service_error code and Greek description from the service).

v0.8.0

  • Replaced HTTPoison with Req.
  • New fetch/1 and fetch!/1 functions that deprecate the chaining of new/4 and get/1.

v0.7.0

  • Now compatible with the RgWsPublic2 SOAP web service (new since 2023-04-20).
  • Now possible to make SOAP API calls using different credentials in %Auth{} structs, e.g. for multi-tenant setups.
  • Now needs no application setup in config.exs or mix.exs, thanks to getting rid of the Soap library due to parsing issues, and because it seems abandoned and not particularly robust to begin with.
  • XML parsing is now handled directly with SweetXml.
  • Actual logging of errors in the %Results{} struct means you can find out what went wrong.
  • Actual handling of errors (with {:ok, ...} and {:error, ...} tuples) along the pipeline across all modules means that no API call or parsing of the XML response body is made unless no errors have popped up.

Documentation

The docs can be found at https://hexdocs.pm/vatchex_greece. There's also an Elixir Forum thread.