curl --request GET \
--url https://api.invopop.com/silo/v1/entries/query \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.invopop.com/silo/v1/entries/query"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.invopop.com/silo/v1/entries/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.invopop.com/silo/v1/entries/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.invopop.com/silo/v1/entries/query"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.invopop.com/silo/v1/entries/query")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.invopop.com/silo/v1/entries/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"count": 42,
"count_capped": true,
"count_unavailable": true,
"cursor": "<string>",
"filter": "<string>",
"limit": 20,
"list": [
{
"attachments": [
{
"category": "version",
"created_at": "2018-01-01T00:00:00.000Z",
"desc": "Invoice for January 2021.",
"embeddable": true,
"entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"id": "<string>",
"key": "pdf",
"meta": {},
"mime": "application/pdf",
"name": "invoice.pdf",
"previous": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"hash": "<string>",
"id": "<string>",
"size": 123
}
],
"private": true,
"size": 12345,
"stored": true,
"url": "<string>"
}
],
"context": "line.item",
"created_at": "2018-01-01T00:00:00.000Z",
"data": {},
"digest": {
"alg": "<string>",
"val": "<string>"
},
"doc_schema": "https://gobl.org/draft-0/bill/invoice",
"draft": true,
"env_schema": "https://gobl.org/draft-0/envelope",
"faults": [
{
"code": "<string>",
"message": "<string>",
"paths": [
"<string>"
],
"provider": "pdf"
}
],
"folder": "sales",
"id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"invalid": true,
"key": "invoice-101",
"meta": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"id": "347c5b04-cde2-11ed-afa1-0242ac120002:source:key",
"indexed": true,
"key": "service-id",
"link_scope": "public",
"link_url": "https://example.com/info",
"owned": true,
"owner_id": "<string>",
"ref": "<string>",
"secure": true,
"shared": true,
"src": "source",
"updated_at": "2018-01-01T00:00:00.000Z",
"value": {
"key": "value"
}
}
],
"signed": true,
"snippet": {
"title": "Sample Title"
},
"state": "sent",
"tags": [
"<string>"
],
"updated_at": "2018-01-01T00:00:00.000Z",
"version": "76f845c125",
"versions": [
{
"at": "2018-01-01T00:00:00.000Z",
"invalid": true,
"signed": true,
"src": "api",
"src_id": "<string>",
"version": "76f845c125"
}
]
}
],
"next_cursor": "<string>",
"notes": [
"<string>"
],
"order_by": "<string>",
"schema": "bill/invoice",
"watermark": "2026-01-01T00:00:00.000Z"
}Query entries
Search the documents of one GOBL type using a filter expression.
Unlike the other entry endpoints, this reads an indexed copy of your documents rather than the documents themselves, which is what makes filtering and sorting on document fields possible. Two consequences are worth knowing:
- Results are eventually consistent. A document created a moment ago may not appear yet. Each response carries a “watermark” giving the time of the most recent change reflected in it.
- The fields you may filter and sort on depend on the document type. They are listed in full under “Fields” below.
Set “schema” to the document type to search: bill/delivery, bill/invoice, bill/order, bill/payment, bill/status, note/message, org/item, org/party.
Filter terms are combined with AND. OR is accepted only between values of a single field, which is how a set membership test is written. For free-text searching across documents, use the search endpoint instead.
“AND” and “OR” are keywords and must be written in capitals; “and”, ”&&” and ”||” are not accepted. The whole filter must be URL-encoded, because an unencoded ”&” ends the parameter and the rest of the filter would be silently dropped — a request carrying the leftovers is rejected rather than answered with a wider result set than was asked for.
For example, invoices for one customer in the sales folder. Note that curl’s -G with —data-urlencode does the encoding for you:
curl -G https://api.invopop.com/silo/v1/entries/query -H “Authorization: Bearer $TOKEN” —data-urlencode ‘schema=bill/invoice’ —data-urlencode ‘filter=customer_tax_code = “X3157928M” AND folder = “sales”’
A tax code is stored without its country prefix, which is held separately as supplier_country or customer_country. Filter on “X3157928M”, not on “ESX3157928M”.
Page through results by passing the previous response’s “next_cursor” as “cursor”. A cursor is only valid for the same schema, filter and order_by, and only in the workspace that produced it.
Fields
Fields available to filter, order_by and fields, for each of the 8 document types.
Indexed means the field has a database index behind it. Several of those indexes also lead with folder, so a filter that names only the indexed field cannot always use one — if a response comes back with a note about index coverage, adding folder to the filter will usually resolve it. Filtering on a field with no index at all is still allowed, but runs under a shorter time limit.
Common to every document type
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
id | uuid | = != in | yes | yes |
rev | string | not filterable | — | — |
rev_num | int | not filterable | — | — |
folder | key | = != in | yes | yes |
state | key | = != in | yes | yes |
state_at | timestamp | = != < <= > >= in | yes | — |
doc_schema | string | = != in | — | — |
env_schema | string | = != in | — | — |
entry_key | string | = != in | — | — |
version | string | = != in | — | — |
digest_alg | string | not filterable | — | — |
digest_val | string | = != in starts_with | — | — |
tags | strings | : | — | — |
signed | bool | = != | yes | — |
invalid | bool | = != | yes | — |
relations_hash | int | not filterable | — | — |
files | json | not filterable | — | — |
faults | json | not filterable | — | — |
snippet | json | not filterable | — | — |
created_at | timestamp | = != < <= > >= in | yes | yes |
updated_at | timestamp | = != < <= > >= in | yes | yes |
synced_at | timestamp | = != < <= > >= in | yes | — |
doc_uuid | uuid | = != in | — | — |
related | uuid | : | — | — |
related.self | uuid | : | — | — |
folderandstateaccept values defined by your own workspace: the folders you have created, and any custom states you have added to the built-in ones. Those values are workspace data rather than part of this schema, so they are not listed here.
bill/delivery
Default order: created_at desc.
In addition to the common fields above:
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
type | key | = != in | yes | — |
series | string | = != in starts_with contains | yes | — |
code | string | = != in starts_with contains | yes | yes |
currency | string | = != in | yes | — |
issue_date | date | = != < <= > >= in | yes | yes |
despatch_date | date | = != < <= > >= in | yes | — |
order_code | string | = != in starts_with contains | — | — |
supplier_uuid | uuid | = != in | — | yes |
supplier_name | string | = != in starts_with contains | yes | — |
supplier_alias | string | = != in starts_with contains | — | — |
supplier_country | string | = != in | yes | — |
supplier_tax_code | string | = != in starts_with contains | — | yes |
customer_uuid | uuid | = != in | — | yes |
customer_name | string | = != in starts_with contains | yes | — |
customer_alias | string | = != in starts_with contains | — | — |
customer_country | string | = != in | yes | — |
customer_tax_code | string | = != in starts_with contains | — | yes |
total | decimal | = != < <= > >= in | yes | — |
tax | decimal | = != < <= > >= in | yes | — |
total_with_tax | decimal | = != < <= > >= in | yes | — |
related.supplier | uuid | : | — | — |
related.customer | uuid | : | — | — |
related.lines | uuid | : | — | — |
related.lines.item | uuid | : | — | — |
bill/invoice
Default order: created_at desc.
In addition to the common fields above:
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
type | key | = != in | yes | — |
series | string | = != in starts_with contains | yes | — |
code | string | = != in starts_with contains | yes | yes |
currency | string | = != in | yes | — |
issue_date | date | = != < <= > >= in | yes | yes |
order_code | string | = != in starts_with contains | — | — |
supplier_uuid | uuid | = != in | — | yes |
supplier_name | string | = != in starts_with contains | yes | — |
supplier_alias | string | = != in starts_with contains | — | — |
supplier_country | string | = != in | yes | — |
supplier_tax_code | string | = != in starts_with contains | — | yes |
customer_uuid | uuid | = != in | — | yes |
customer_name | string | = != in starts_with contains | yes | — |
customer_alias | string | = != in starts_with contains | — | — |
customer_country | string | = != in | yes | — |
customer_tax_code | string | = != in starts_with contains | — | yes |
total | decimal | = != < <= > >= in | yes | — |
tax | decimal | = != < <= > >= in | yes | — |
total_with_tax | decimal | = != < <= > >= in | yes | — |
payable | decimal | = != < <= > >= in | yes | — |
preceding_series | string | = != in starts_with contains | — | — |
preceding_code | string | = != in starts_with contains | — | — |
preceding_uuid | uuid | = != in | — | yes |
related.supplier | uuid | : | — | — |
related.customer | uuid | : | — | — |
related.lines | uuid | : | — | — |
related.lines.item | uuid | : | — | — |
related.preceding | uuid | : | — | — |
bill/order
Default order: created_at desc.
In addition to the common fields above:
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
type | key | = != in | yes | — |
series | string | = != in starts_with contains | yes | — |
code | string | = != in starts_with contains | yes | yes |
currency | string | = != in | yes | — |
issue_date | date | = != < <= > >= in | yes | yes |
supplier_uuid | uuid | = != in | — | yes |
supplier_name | string | = != in starts_with contains | yes | — |
supplier_alias | string | = != in starts_with contains | — | — |
supplier_country | string | = != in | yes | — |
supplier_tax_code | string | = != in starts_with contains | — | yes |
customer_uuid | uuid | = != in | — | yes |
customer_name | string | = != in starts_with contains | yes | — |
customer_alias | string | = != in starts_with contains | — | — |
customer_country | string | = != in | yes | — |
customer_tax_code | string | = != in starts_with contains | — | yes |
total | decimal | = != < <= > >= in | yes | — |
tax | decimal | = != < <= > >= in | yes | — |
total_with_tax | decimal | = != < <= > >= in | yes | — |
related.supplier | uuid | : | — | — |
related.customer | uuid | : | — | — |
related.lines | uuid | : | — | — |
related.lines.item | uuid | : | — | — |
bill/payment
Default order: created_at desc.
In addition to the common fields above:
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
type | key | = != in | yes | — |
series | string | = != in starts_with contains | yes | — |
code | string | = != in starts_with contains | yes | yes |
method_keys | strings | : | — | — |
currency | string | = != in | yes | — |
issue_date | date | = != < <= > >= in | yes | yes |
value_date | date | = != < <= > >= in | yes | — |
supplier_uuid | uuid | = != in | — | yes |
supplier_name | string | = != in starts_with contains | yes | — |
supplier_alias | string | = != in starts_with contains | — | — |
supplier_country | string | = != in | yes | — |
supplier_tax_code | string | = != in starts_with contains | — | yes |
customer_uuid | uuid | = != in | — | yes |
customer_name | string | = != in starts_with contains | yes | — |
customer_alias | string | = != in starts_with contains | — | — |
customer_country | string | = != in | yes | — |
customer_tax_code | string | = != in starts_with contains | — | yes |
total | decimal | = != < <= > >= in | yes | — |
related.supplier | uuid | : | — | — |
related.customer | uuid | : | — | — |
bill/status
Default order: created_at desc.
In addition to the common fields above:
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
type | key | = != in | yes | — |
series | string | = != in starts_with contains | yes | — |
code | string | = != in starts_with contains | yes | yes |
issue_date | date | = != < <= > >= in | yes | yes |
issue_time | time | = != < <= > >= in | yes | — |
supplier_uuid | uuid | = != in | — | yes |
supplier_name | string | = != in starts_with contains | yes | — |
supplier_alias | string | = != in starts_with contains | — | — |
supplier_country | string | = != in | yes | — |
supplier_tax_code | string | = != in starts_with contains | — | yes |
customer_uuid | uuid | = != in | — | yes |
customer_name | string | = != in starts_with contains | yes | — |
customer_alias | string | = != in starts_with contains | — | — |
customer_country | string | = != in | yes | — |
customer_tax_code | string | = != in starts_with contains | — | yes |
related.supplier | uuid | : | — | — |
related.customer | uuid | : | — | — |
note/message
Default order: created_at desc.
In addition to the common fields above:
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
title | string | = != in starts_with contains | yes | — |
org/item
Default order: created_at desc.
In addition to the common fields above:
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
name | string | = != in starts_with contains | yes | yes |
currency | string | = != in | yes | — |
price | decimal | = != < <= > >= in | yes | — |
org/party
Default order: created_at desc.
In addition to the common fields above:
| Field | Type | Operators | Sortable | Indexed |
|---|---|---|---|---|
name | string | = != in starts_with contains | yes | yes |
alias | string | = != in starts_with contains | yes | — |
country | string | = != in | yes | — |
tax_code | string | = != in starts_with contains | yes | yes |
curl --request GET \
--url https://api.invopop.com/silo/v1/entries/query \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.invopop.com/silo/v1/entries/query"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.invopop.com/silo/v1/entries/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.invopop.com/silo/v1/entries/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.invopop.com/silo/v1/entries/query"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.invopop.com/silo/v1/entries/query")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.invopop.com/silo/v1/entries/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"count": 42,
"count_capped": true,
"count_unavailable": true,
"cursor": "<string>",
"filter": "<string>",
"limit": 20,
"list": [
{
"attachments": [
{
"category": "version",
"created_at": "2018-01-01T00:00:00.000Z",
"desc": "Invoice for January 2021.",
"embeddable": true,
"entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"id": "<string>",
"key": "pdf",
"meta": {},
"mime": "application/pdf",
"name": "invoice.pdf",
"previous": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"hash": "<string>",
"id": "<string>",
"size": 123
}
],
"private": true,
"size": 12345,
"stored": true,
"url": "<string>"
}
],
"context": "line.item",
"created_at": "2018-01-01T00:00:00.000Z",
"data": {},
"digest": {
"alg": "<string>",
"val": "<string>"
},
"doc_schema": "https://gobl.org/draft-0/bill/invoice",
"draft": true,
"env_schema": "https://gobl.org/draft-0/envelope",
"faults": [
{
"code": "<string>",
"message": "<string>",
"paths": [
"<string>"
],
"provider": "pdf"
}
],
"folder": "sales",
"id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"invalid": true,
"key": "invoice-101",
"meta": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"id": "347c5b04-cde2-11ed-afa1-0242ac120002:source:key",
"indexed": true,
"key": "service-id",
"link_scope": "public",
"link_url": "https://example.com/info",
"owned": true,
"owner_id": "<string>",
"ref": "<string>",
"secure": true,
"shared": true,
"src": "source",
"updated_at": "2018-01-01T00:00:00.000Z",
"value": {
"key": "value"
}
}
],
"signed": true,
"snippet": {
"title": "Sample Title"
},
"state": "sent",
"tags": [
"<string>"
],
"updated_at": "2018-01-01T00:00:00.000Z",
"version": "76f845c125",
"versions": [
{
"at": "2018-01-01T00:00:00.000Z",
"invalid": true,
"signed": true,
"src": "api",
"src_id": "<string>",
"version": "76f845c125"
}
]
}
],
"next_cursor": "<string>",
"notes": [
"<string>"
],
"order_by": "<string>",
"schema": "bill/invoice",
"watermark": "2026-01-01T00:00:00.000Z"
}Authorizations
Query Parameters
Response
OK
Was this page helpful?