cURL
curl --request PUT \
--url https://api.invopop.com/silo/v1/entries/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"allow_invalid": true,
"content_type": "application/json",
"correct": {
"type": "credit-note"
},
"data": {},
"folder": "<string>",
"key": "invoice-101",
"previous_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sign": false
}
'import requests
url = "https://api.invopop.com/silo/v1/entries/{id}"
payload = {
"allow_invalid": True,
"content_type": "application/json",
"correct": { "type": "credit-note" },
"data": {},
"folder": "<string>",
"key": "invoice-101",
"previous_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sign": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
allow_invalid: true,
content_type: 'application/json',
correct: {type: 'credit-note'},
data: {},
folder: '<string>',
key: 'invoice-101',
previous_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sign: false
})
};
fetch('https://api.invopop.com/silo/v1/entries/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'allow_invalid' => true,
'content_type' => 'application/json',
'correct' => [
'type' => 'credit-note'
],
'data' => [
],
'folder' => '<string>',
'key' => 'invoice-101',
'previous_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sign' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.invopop.com/silo/v1/entries/{id}"
payload := strings.NewReader("{\n \"allow_invalid\": true,\n \"content_type\": \"application/json\",\n \"correct\": {\n \"type\": \"credit-note\"\n },\n \"data\": {},\n \"folder\": \"<string>\",\n \"key\": \"invoice-101\",\n \"previous_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sign\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.invopop.com/silo/v1/entries/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"allow_invalid\": true,\n \"content_type\": \"application/json\",\n \"correct\": {\n \"type\": \"credit-note\"\n },\n \"data\": {},\n \"folder\": \"<string>\",\n \"key\": \"invoice-101\",\n \"previous_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sign\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.invopop.com/silo/v1/entries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allow_invalid\": true,\n \"content_type\": \"application/json\",\n \"correct\": {\n \"type\": \"credit-note\"\n },\n \"data\": {},\n \"folder\": \"<string>\",\n \"key\": \"invoice-101\",\n \"previous_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sign\": false\n}"
response = http.request(request)
puts response.read_body{
"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"
}
]
}Entries
Create an entry with ID
Create a new silo entry with the given UUID.
PUT
/
silo
/
v1
/
entries
/
{id}
cURL
curl --request PUT \
--url https://api.invopop.com/silo/v1/entries/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"allow_invalid": true,
"content_type": "application/json",
"correct": {
"type": "credit-note"
},
"data": {},
"folder": "<string>",
"key": "invoice-101",
"previous_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sign": false
}
'import requests
url = "https://api.invopop.com/silo/v1/entries/{id}"
payload = {
"allow_invalid": True,
"content_type": "application/json",
"correct": { "type": "credit-note" },
"data": {},
"folder": "<string>",
"key": "invoice-101",
"previous_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sign": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
allow_invalid: true,
content_type: 'application/json',
correct: {type: 'credit-note'},
data: {},
folder: '<string>',
key: 'invoice-101',
previous_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sign: false
})
};
fetch('https://api.invopop.com/silo/v1/entries/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'allow_invalid' => true,
'content_type' => 'application/json',
'correct' => [
'type' => 'credit-note'
],
'data' => [
],
'folder' => '<string>',
'key' => 'invoice-101',
'previous_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sign' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.invopop.com/silo/v1/entries/{id}"
payload := strings.NewReader("{\n \"allow_invalid\": true,\n \"content_type\": \"application/json\",\n \"correct\": {\n \"type\": \"credit-note\"\n },\n \"data\": {},\n \"folder\": \"<string>\",\n \"key\": \"invoice-101\",\n \"previous_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sign\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.invopop.com/silo/v1/entries/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"allow_invalid\": true,\n \"content_type\": \"application/json\",\n \"correct\": {\n \"type\": \"credit-note\"\n },\n \"data\": {},\n \"folder\": \"<string>\",\n \"key\": \"invoice-101\",\n \"previous_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sign\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.invopop.com/silo/v1/entries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allow_invalid\": true,\n \"content_type\": \"application/json\",\n \"correct\": {\n \"type\": \"credit-note\"\n },\n \"data\": {},\n \"folder\": \"<string>\",\n \"key\": \"invoice-101\",\n \"previous_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sign\": false\n}"
response = http.request(request)
puts response.read_body{
"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"
}
]
}New Documents
The fastest way to upload data to Invopop is by creating an entry with thedata property containing the GOBL JSON of either a pre-built Envelope or a partial document like an Invoice or Party.
The key property can be used to ensure idempotency, preventing the creation of duplicate entries with the same key within the workspace.
A 409 Conflict response will be provided if either the entry ID or key have been used in an existing document.
Invoice Body Example
{
"data": {
"$schema": "https://gobl.org/draft-0/bill/invoice",
"series": "DEMO",
"code": "001",
"currency": "USD",
"supplier": {
"name": "Provide One Inc.",
"tax_id": {
"country": "US"
},
"addresses": [
{
"num": "16",
"street": "Jessie Street",
"locality": "San Francisco",
"region": "CA",
"code": "94105",
"country": "US"
}
],
"emails": [
{
"addr": "billing@provideone.com"
}
]
},
"customer": {
"name": "Sample Consumer",
"emails": [
{
"addr": "email@sample.com"
}
]
},
"lines": [
{
"quantity": "20",
"item": {
"name": "Development services",
"price": "90.00",
"unit": "h"
},
"discounts": [
{
"percent": "10%",
"reason": "Special discount"
}
],
"taxes": [
{
"cat": "ST",
"percent": "8.5%"
}
]
}
]
}
}
folder field in the request.
If there are any validation issues with the uploaded data, the service will respond with an error message including a key and message. Additionally, the fields property may include a nested structure to help identify the specific property with a validation fault.
Use UUID versions 1 or 7 for documents with a specific lifespan, such as
invoices or payment receipts. For long-lived data, like parties or items, use
versions 3, 4, or 5. The rules for UUID versions are enforced by specific
folder configurations.
Creating Entries from Previous Documents
You can create new entries based on a previous entry by using theprevious_id field. This allows you to provide patch data instead of a full new document by setting the patch type in the content_type field to one of the following:
application/json-patch+json- for JSON Patch (RFC 6902)application/merge-patch+json- for JSON Merge Patch (RFC 7396)
previous_id field can be used to create corrective documents by including corrective option data in the correct field. For more details, refer to the GOBL documentation on correction options.Authorizations
Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>
Path Parameters
UUID of the silo entry to create.
Example:
"347c5b04-cde2-11ed-afa1-0242ac120002"
Body
application/json
When true, the envelope's contents are allowed to be invalid.
Example:
true
The content type of the data being uploaded.
Example:
"application/json"
JSON object containing the GOBL correction option data.
Example:
{ "type": "credit-note" }
Data contents to upload which may either be a GOBL Envelope or Object. Any partial data will be calculated and validated automatically.
In which folder the entry should be associated, leave empty to use the automatic rules.
Key used to identify the entry idempotently within a workspace.
Example:
"invoice-101"
The UUID of the previous silo entry to copy.
When true, the GOBL envelope will be signed automatically.
Example:
false
Response
200 - application/json
OK
List of files for this entry.
Show child attributes
Show child attributes
When entry provided within a related query, this is the context within the document.
Example:
"line.item"
The date and time the silo entry was created.
Example:
"2018-01-01T00:00:00.000Z"
JSON envelope contents. Included when fetching, creating or updating an entry and in entry lists.
Show child attributes
Show child attributes
Schema URL for the envelope's payload.
Example:
"https://gobl.org/draft-0/bill/invoice"
Deprecated. When true, indicates that the envelope is not signed.
Example:
true
Schema URL for the envelope.
Example:
"https://gobl.org/draft-0/envelope"
List of faults that occurred during the processing of the job associated with the last state.
Show child attributes
Show child attributes
Key for the folder where the entry is located.
Example:
"sales"
UUID of the silo entry.
Example:
"347c5b04-cde2-11ed-afa1-0242ac120002"
When true, the envelope's contents are invalid and need to be reviewed.
Example:
true
Key used to identify the entry idempotently within a workspace.
Example:
"invoice-101"
Additional meta fields associated with the entry.
Show child attributes
Show child attributes
When true, the envelope has been signed and should not be modified.
Example:
true
JSON object containing a snippet of the document.
Example:
{ "title": "Sample Title" }
Current state of the silo entry if not a draft.
Example:
"sent"
Copy of tags stored in the envelope header.
The date and time the silo entry was last updated.
Example:
"2018-01-01T00:00:00.000Z"
Version of the latest envelope data.
Example:
"76f845c125"
Available envelope data versions, newest first.
Show child attributes
Show child attributes
Was this page helpful?