Quickstart

Sign up instructions and getting your first sandbox working

In this tutorial, you will:

1. Sign up for an Invopop account and get your first sandbox workspace working.
2. Invite your colleagues to join your workspace.
3. Create a simple workflow to issue an invoice.
4. Upload the invoice to the workflow and process it.

Let your coding agent run the API half of this quickstart against your sandbox.

CopiedCopy promptOpen in Cursor

Signing up

1. Sign up for an Invopop account

   Go to console.invopop.com and select your sign-up method: continue with Google, or enter your email address. The same form is used to sign in and to create a new account.

   
2. Fill in your information

   Fill in the form with your name, company, and position. The company will become your organization in Invopop, more on that later.

3. Create a first sandbox workspace

   You’ll be prompted to create a first sandbox workspace: give it a name and a handle, and keep Sandbox selected as the environment. Don’t worry, you can always create more workspaces later.

   
4. Congratulations, you've just created your first sandbox workspace

   You will be redirected to the Invopop console. Congratulations, you’ve just created your first sandbox workspace!

   

Inviting colleagues

Now that you’ve signed up, you can invite your colleagues to join your organization.

1. Go to Admin

   Within the Invopop console, click on the workspace name in the top left corner and select Admin. You may be prompted to log in again, and you’ll be redirected to the Invopop Admin area.

   
2. Go to the members' page

   Click on the Members tab on the left. You’ll see a list of all the members in your organization.

   
3. Click on the 'Invite member' button on the top right corner

   Fill in the form with your colleagues’ email addresses and position and click on Send.

   Inviting members is only available on Pro and Enterprise accounts. On other plans the Invite member button is disabled until you add multi-user access to your subscription — see pricing for details.

4. All done

   Your colleagues will receive an email with a link to join your organization and will be able to access any workspace associated with your organization.

Creating a workflow

Now let’s create your first workflow. We’ll start with a simple workflow that generates a PDF invoice.

1. Go to Console

   Go back to the workspace by clicking on the Workspaces tab in the Admin area and selecting your workspace, or simply opening a new tab in https://console.invopop.com.

   
2. Go to Workflows

   Click on Workflows on the left sidebar. You’ll see a list of all the workflows in your workspace.

   
3. Create a workflow

   Click on the Create workflow button on the top right corner. A new draft workflow opens in the workflow editor.

4. Select a template

   Click on Load template, find the “PDF invoice” template in the list, and click on Load Template.

   
5. Modify the workflow

   Let’s add a step that sets the document state to Sent after the PDF is generated. Click on Click to add action below the last step and select Set State under Core in the right sidebar.

   
6. Configure the step

   You should now see the configuration of the Set State step, otherwise click on the step you’ve just added. Select Sent in the State dropdown.

   
7. Save and Publish

   Click on the Save draft button to save your draft workflow. Now click on Publish so you can start using it in your workspace.

Uploading an invoice

Now let’s upload an invoice to your workspace that we’ll later send to the ‘PDF invoice’ workflow. You can upload document manually from the Console or by using the API.

Console

1. In the Console, click on Invoices on the left sidebar.
2. Click on the New invoice button on the top right corner. You’ll be redirected to the document editor.
3. The document editor has two modes: the visual view and the code view. Switch to the code view by clicking on the </> toggle below the Save button.

4. Copy the invoice example below and paste it in the code view.

Example invoice

  {
      "$schema": "https://gobl.org/draft-0/bill/invoice",
      "$regime": "GB",
      "uuid": "01975e35-426f-760e-aab8-a30b942fee07",
      "type": "credit-note",
      "series": "SAMPLE",
      "code": "000002",
      "issue_date": "2025-06-11",
      "currency": "GBP",
      "preceding": [
          {
              "uuid": "019035bd-4524-73ab-bf44-6037841ce5d9",
              "type": "standard",
              "issue_date": "2024-07-31",
              "series": "SAMPLE",
              "code": "001"
          }
      ],
      "supplier": {
          "name": "Test Company Ltd.",
          "tax_id": {
              "country": "GB",
              "code": "000472631"
          },
          "addresses": [
              {
                  "num": "12",
                  "street": "Main Street",
                  "locality": "Hull",
                  "code": "HU17 7PQ",
                  "country": "GB"
              }
          ],
          "emails": [
              {
                  "addr": "[e-mail]"
              }
          ]
      },
      "customer": {
          "name": "Random Company Ltd.",
          "tax_id": {
              "country": "GB",
              "code": "350983637"
          },
          "addresses": [
              {
                  "num": "45",
                  "street": "Some Street",
                  "locality": "London",
                  "code": "SW1A 1AA",
                  "country": "GB"
              }
          ],
          "emails": [
              {
                  "addr": "[e-mail]"
              }
          ]
      },
      "lines": [
          {
              "i": 1,
              "quantity": "20",
              "item": {
                  "name": "Development services",
                  "price": "90.00",
                  "unit": "h"
              },
              "sum": "1800.00",
              "discounts": [
                  {
                      "reason": "Special discount",
                      "percent": "10%",
                      "amount": "180.00"
                  }
              ],
              "taxes": [
                  {
                      "cat": "VAT",
                      "rate": "standard",
                      "percent": "20.0%"
                  }
              ],
              "total": "1620.00"
          }
      ],
      "totals": {
          "sum": "1620.00",
          "total": "1620.00",
          "taxes": {
              "categories": [
                  {
                      "code": "VAT",
                      "rates": [
                          {
                              "key": "standard",
                              "base": "1620.00",
                              "percent": "20.0%",
                              "amount": "324.00"
                          }
                      ],
                      "amount": "324.00"
                  }
              ],
              "sum": "324.00"
          },
          "tax": "324.00",
          "total_with_tax": "1944.00",
          "payable": "1944.00"
      }
  }

5. Click on the Build button to build the invoice. This will normalize and validate fields and add any calculated fields.

6. Click on the Save button on the top right corner to save the invoice. You’ll be redirected to the invoice detail view.

API

Use the Create an entry API endpoint with a request body that wraps your invoice in the required structure.

Your request body should look like this:

{
  "content_type": "application/json",
  "data": {}
}

Populate the data field with your complete invoice object. You can use the example below:

  {
    "$schema": "https://gobl.org/draft-0/bill/invoice",
    "$regime": "GB",
    "uuid": "029035bd-4524-73ab-bf44-6037841ce5d9",
    "type": "standard",
    "series": "SAMPLE",
    "code": "001",
    "issue_date": "2024-07-31",
    "currency": "GBP",
    "supplier": {
        "name": "Test Company Ltd.",
        "tax_id": {
            "country": "GB",
            "code": "000472631"
        },
        "addresses": [
            {
                "num": "12",
                "street": "Main Street",
                "locality": "Hull",
                "code": "HU17 7PQ",
                "country": "GB"
            }
        ],
        "emails": [
            {
                "addr": "[e-mail]"
            }
        ]
    },
    "customer": {
        "name": "Random Company Ltd.",
        "tax_id": {
            "country": "GB",
            "code": "350983637"
        },
        "addresses": [
            {
                "num": "45",
                "street": "Some Street",
                "locality": "London",
                "code": "SW1A 1AA",
                "country": "GB"
            }
        ],
        "emails": [
            {
                "addr": "[e-mail]"
            }
        ]
    },
    "lines": [
        {
            "i": 1,
            "quantity": "20",
            "item": {
                "name": "Development services",
                "price": "90.00",
                "unit": "h"
            },
            "sum": "1800.00",
            "discounts": [
                {
                    "reason": "Special discount",
                    "percent": "10%",
                    "amount": "180.00"
                }
            ],
            "taxes": [
                {
                    "cat": "VAT",
                    "rate": "standard",
                    "percent": "20.0%"
                }
            ],
            "total": "1620.00"
        }
    ],
    "totals": {
        "sum": "1620.00",
        "total": "1620.00",
        "taxes": {
            "categories": [
                {
                    "code": "VAT",
                    "rates": [
                        {
                            "key": "standard",
                            "base": "1620.00",
                            "percent": "20.0%",
                            "amount": "324.00"
                        }
                    ],
                    "amount": "324.00"
                }
            ],
            "sum": "324.00"
        },
        "tax": "324.00",
        "total_with_tax": "1944.00",
        "payable": "1944.00"
    }
  }

If everything goes well, you’ll get a 200 OK response along with the JSON for your newly registered invoice.

You’ve just created your first invoice! You can click on Preview to see what it’d look like as a PDF.

Processing an invoice

Next, we’ll process the invoice by sending it to the ‘PDF invoice’ workflow we set up earlier. You can do this manually from the Console or by using the API.

Console

1. In the Console, click on Invoices in the left sidebar.

Select the invoice you just uploaded. This will open the document editor.

2. Click Run Workflow in the top-right corner to open the workflow selection panel.

3. Select the workflow you want to run — in this case, PDF invoice — and click Run Workflow.

4. You’ll see the State of the invoice update to Sent and the generated PDF appear under Files, confirming it’s been processed.

API

Use the Create a Job API endpoint with the following request body:

  {
    "workflow_id": "186522a6-e697-4e34-8498-eee961bcb845",
    "silo_entry_id": "03836750-461b-11f0-a07f-051acfb70532"
  }

• silo_entry_id should reference the Silo Entry ID of the uploaded invoice.
• workflow_id should reference the ID of the workflow you created.

If everything goes smoothly, you’ll receive a 202 Accepted response confirming the job was accepted. The workflow runs asynchronously: fetch the job to follow its steps, or the entry to see the resulting state and files. Add ?wait=30 to the request to block until the job completes, in which case the response is 200 OK with the finished job.

That’s it! You’ve successfully processed your first invoice.