How to create a Workflow

Configure a workflow in Invopop to process documents.

Although workflows can be created via the API, we strongly recommend using the Invopop Console for an easier set up.

In the Workflows section click on + Create workflow. You will see a template selection screen. The first two items are blank workflows for each document type:

• Empty Invoice workflow: for sales or expenses.
• Empty Party workflow: for suppliers or customers.

Choose Empty Invoice workflow for this example and then click Load Template.

Give your workflow a name and description by filling the fields on the right sidebar.

Add steps to your new workflow by tapping on the + Add step button and selecting an action from the right. Some steps will require configuration in order to function correctly.

The “developer mode” switch at the top right of the canvas can be used to display the JSON representation of the workflow. This makes it easy to copy and paste workflows from examples or other workspaces. Make sure to return to the visual editor view to ensure the document is validated.

Creating conditions

Conditions create blocks that execute when a given status and code (optional) match the response of a workflow step. There are two status signals (OK and KO) plus Any, which matches regardless of the status.

• OK: when a workflow step completes as expected.
• KO: when there was an error in the step’s execution.
• Any: will match both OK and KO.

Codes are generally text or numbers returned by providers. Only some steps will return codes along with their status signals. For example, the Send VERI*FACTU (Spain) step will return the error code as specified by the AEAT along with the KO status signal. Since GOBL already handles many of the validations in tax authorities lists, we recommend only implementing conditions which happen in your workflow with certain regularity and which should be handled automatically.

As an example, we will handle the case where a supplier is not registered in the taxpayer census by the AEAT:

1. Add a condition on the step

   On the desired step, click on the menu button ... and select Add condition.

   
2. Configure the condition

   

   Configure the matching conditions in the popover:

   1. Status: KO.
   2. Code: 4107 (Tax ID not identified in the taxpayer census).
   3. End workflow here: ✔ (the workflow will stop executing after this block).
3. Add an action to the condition block

   

   Click on “Select an action” and handle the condition as you wish. In this case, we are choosing to send a Slack message (e.g. for manual intervention).

Running a workflow

Workflows in Invopop can be executed through the following methods:

• Manually via the Invopop Console
• Via API calls to the create job endpoint
• Automatically by an embedded application.

Workflows are executed on silo entries (such as invoices or suppliers), this action creates a job. When a job is run, the silo entry will be updated with any changes or attachments generated during processing. The status of a job can be seen in the silo entry’s activity tab, or in the Workflows → History section accessible from the left sidebar.

Error handling

Any step that causes an error (KO) from which the job can’t recover, and is not handled through a condition, will trigger the error handling flow. To enable this section, tap on Handle Errors at the bottom of the workflow creation screen, then add steps into this area which you want to execute when the job fails (often times setting the entry’s state to Error and possibly sending a notification).

FAQ

How do I update deprecated workflow steps?

If your step conditions displays a This step contains deprecated conditions warning, your workflow will continue working normally, but we recommend updating your workflow so that you can modify it without unexpected behavior.

Steps under deprecated conditions will display with a warning symbol ⚠️ with the label “Go to [action name]”. Click on the menu button ... and select “Replace”, and then select the replacement action from the sidebar. So, for example, if the deprecated step is labelled “Go to Set State”, replace this step with “Set State” and choose the same configuration as the original step (which you should find further down within the same workflow).

Once all deprecated steps are replaced, locate the the referenced action(s) and delete.

Related resources

API Reference	Create a workflow Fetch all workflows Create a job (POST) Create a job (PUT)
Related Guides	Workflows Guide