Fetch an entry by key

GET

silo

entries

key

{key}

curl --request GET \
  --url https://api.invopop.com/silo/v1/entries/key/{key}

{
  "attachments": [
    {
      "created_at": "2018-01-01T00:00:00.000Z",
      "desc": "Invoice for January 2021.",
      "entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
      "hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
      "id": "<string>",
      "meta": {},
      "mime": "application/pdf",
      "name": "invoice.pdf",
      "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>",
      "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",
      "key": "service-id",
      "link_scope": "public",
      "link_url": "https://example.com/info",
      "ref": "<string>",
      "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"
}

Path Parameters

key

string

required

Key used to identify the entry idempotently within a workspace.

Example:

"invoice-101"

Response

200 - application/json

attachments

object[]

List of attachments for this entry.

context

string

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

Example:

"line.item"

created_at

string

The date and time the silo entry was created.

Example:

"2018-01-01T00:00:00.000Z"

data

object

JSON envelope contents when specifically requested.

digest

object

doc_schema

string

Schema URL for the envelope's payload.

Example:

"https://gobl.org/draft-0/bill/invoice"

draft

boolean

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

Example:

true

env_schema

string

Schema URL for the envelope.

Example:

"https://gobl.org/draft-0/envelope"

faults

object[]

List of faults that occurred during the processing of the job associated with the last state.

folder

string

Key for the folder where the entry is located.

Example:

"sales"

string

UUID of the silo entry.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

invalid

boolean

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

Example:

true

key

string

Key used to identify the entry idempotently within a workspace.

Example:

"invoice-101"

meta

object[]

Additional meta fields associated with the entry.

meta.created_at

string

Timestamp of when the row was created.

Example:

"2018-01-01T00:00:00.000Z"

meta.entry_id

string

ID of the entry this meta row belongs to

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

meta.id

string

Compound ID of the meta row.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002:source:key"

meta.key

string

Key used to identify the meta entry by the source.

Example:

"service-id"

meta.link_scope

string

Describes the context in which the link should be made available.

Example:

"public"

meta.link_url

string

URL associated with the meta row that may be used to perform additional actions or view more details.

Example:

"https://example.com/info"

meta.ref

string

Indexable value used to locate the meta entry if a silo entry ID is not available.

meta.shared

boolean

When true, the meta entry may be shared with other applications.

Example:

true

meta.src

string

The service or source that create this meta entry.

Example:

"source"

meta.updated_at

string

Timestamp of when the row was last updated.

Example:

"2018-01-01T00:00:00.000Z"

meta.value

object

The JSON data stored with the meta row.

Example:

{ "key": "value" }

signed

boolean

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

Example:

true

snippet

object

JSON object containing a snippet of the document.

Example:

{ "title": "Sample Title" }

state

string

Current state of the silo entry if not a draft.

Example:

"sent"

tags

string[]

Copy of tags stored in the envelope header.

updated_at

string

The date and time the silo entry was last updated.

Example:

"2018-01-01T00:00:00.000Z"

Fetch an entry Update an entry

curl --request GET \
  --url https://api.invopop.com/silo/v1/entries/key/{key}

{
  "attachments": [
    {
      "created_at": "2018-01-01T00:00:00.000Z",
      "desc": "Invoice for January 2021.",
      "entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
      "hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
      "id": "<string>",
      "meta": {},
      "mime": "application/pdf",
      "name": "invoice.pdf",
      "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>",
      "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",
      "key": "service-id",
      "link_scope": "public",
      "link_url": "https://example.com/info",
      "ref": "<string>",
      "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"
}

Introduction

API

Guides

Fetch an entry by key

Path Parameters

Response