VAT IT eezi v2

Provides integration with VAT IT eezi for organisation-scoped invoices, credit notes, attachments, and invoice-status actions.

Revision History

0.1.0.0 - Initial release for the VAT IT eezi API.
0.1.0.4 - Added Belgium country templates, @Name placeholders in Options.q resolved from Options.CustomParameters, and base64 placeholders for large attachment samples.

Connection

Use this Connection to store the eezi organisation API endpoint and token.

Property Type Description
API Base URL String Versioned eezi API root. It must be an absolute HTTPS URL without a query string or fragment. The default is the UAT URL https://api.uat.eezi.io/v1/.
Access Token Masked Organisation API token sent as the exact Authorization header value.
Timeout (seconds) Integer Timeout applied to each eezi API request. The value must be greater than zero. The default is 30.

Setup Notes

  • Obtain an organisation API access token from VAT IT.
  • Replace the default UAT API Base URL with the versioned production URL supplied by VAT IT before using the Connection in production.
  • Enter the complete value required by eezi in Access Token. The Node does not add a Bearer prefix.
  • Run the Connection test. The Node requests one invoice to validate the endpoint and token.

Methods

Select an embedded template to populate the OperationId, Options, and request shape for the chosen organisation API operation.

In addition to the generic invoice and credit-note templates, country-prefixed templates provide country-specific request shapes, for example Belgium - Invoices - Create Invoice.

Query

Retrieves invoices, credit notes, or document attachments from eezi.

Parameter Type Description
Connection Connection VAT IT eezi Connection.
OperationId String Identifier of the query operation selected by the template.
Options Object Route and query values required by the selected operation. Invoice-list and credit-note-list templates include q and a nested CustomParameters object for @Name references in q.
Return Type Description
Response Array Provider-shaped eezi rows. Invoice and credit-note lists are paged internally, so any limit value in Options is replaced by the Node.

Create

Creates invoices or credit notes through eezi.

Parameter Type Description
Connection Connection VAT IT eezi Connection.
OperationId String Identifier of the create operation selected by the template.
Options Object Route and query values required by the selected operation.
Items Array Invoice or credit-note request objects, processed one at a time. Items is required.
Return Type Description
Response Array Provider response fields with normalized Flowgear mutation metadata.

Action

Executes eezi document actions such as invoice status updates.

Parameter Type Description
Connection Connection VAT IT eezi Connection.
OperationId String Identifier of the action selected by the template.
Options Object Route and query values required by the selected operation.
Items Array Action request objects, processed one at a time. Items is required.
Return Type Description
Response Array Provider response fields with normalized Flowgear mutation metadata.

Usage Notes

  • Templates are available without calling eezi during template discovery.
  • Query rows preserve provider fields and do not include Flowgear mutation metadata.
  • Create and Action rows include Flowgear.IsSuccess, Flowgear.Message, and a copy of the request in Flowgear.Request.
  • Country-specific fields can be added to an invoice or credit-note Items object and are passed to eezi unchanged.
  • In invoice-list and credit-note-list queries, Options.q can reference values such as @Amount. Supply each referenced value in Options.CustomParameters with the exact, case-sensitive @Name key. Values must be strings, numbers, booleans, or null, and are substituted before the request is sent.
  • In country templates, attachment data samples larger than 1 KB are shown as {base64 character string}. Replace the placeholder with the required base64 content.

Known Issues

  • The Node supports the organisation API only. eezi Enterprise API keys and endpoints are not supported.