Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Create a new silo entry without an explicit UUID.

post/silo/v1/entries

Request body

allow_invalidboolean

When true, the envelope's contents are allowed to be invalid.

content_typestring

The content type of the data being uploaded.

correctobject

JSON object containing the GOBL correction option data.

dataobject

Data contents to upload which may either be a GOBL Envelope or Object. Any partial data will be calculated and validated automatically.

folderstring

In which folder the entry should be associated, leave empty to use the automatic rules.

keystring

Key used to identify the entry idempotently within a workspace.

previous_idstring uuid

The UUID of the previous silo entry to copy.

signboolean

When true, the GOBL envelope will be signed automatically.

Example request

{
  "allow_invalid": true,
  "content_type": "application/json",
  "correct": {
    "credit": true
  },
  "key": "invoice-101"
}

Response

OK

contextstring

When entry provided within a related query, this is the context within the document.

created_atstring

The date and time the silo entry was created.

dataobject

JSON envelope contents when specifically requested.

doc_schemastring

Schema URL for the envelope's payload.

draftboolean

Deprecated. When true, indicates that the envelope is not signed.

env_schemastring

Schema URL for the envelope.

folderstring

Key for the folder where the entry is located.

idstring

UUID of the silo entry.

invalidboolean

When true, the envelope's contents are invalid and need to be reviewed.

keystring

Key used to identify the entry idempotently within a workspace.

signedboolean

When true, the envelope has been signed and should not be modified.

snippetobject

JSON object containing a snippet of the document.

statestring

Current state of the silo entry if not a draft.

tagsstring[]

Copy of tags stored in the envelope header.

updated_atstring

The date and time the silo entry was last updated.

Example response

{
  "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",
      "key": "pdf",
      "mime": "application/pdf",
      "name": "invoice.pdf",
      "previous": [
        {
          "created_at": "2018-01-01T00:00:00.000Z"
        }
      ],
      "size": 12345,
      "stored": true
    }
  ],
  "context": "line.item",
  "created_at": "2018-01-01T00:00:00.000Z",
  "doc_schema": "https://gobl.org/draft-0/bill/invoice",
  "draft": true,
  "env_schema": "https://gobl.org/draft-0/envelope",
  "faults": [
    {
      "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,
      "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",
  "updated_at": "2018-01-01T00:00:00.000Z"
}