Create an entry
Create a new silo entry idempotently with the given UUID.
Use UUID versions 1 or 7 for documents with a specific lifespan like invoices or payment receipts, or versions 3, 4, and 5 for long-lived data like contacts or products. The rules for UUID versions are enforced by specific folder configurations.
The data
field may contain either a GOBL Envelope or Object, and
will be validated before being persisted.
New entries may also be created based on a previous entry using the previous_id
field. Using a previous entry allows you to provide patch data instead of a new full document by setting the patch type in the content_type
field to either:
application/json-patch+json
- for JSON Patch (RFC 6902)application/merge-patch+json
- for JSON Merge Patch (RFC 7396)
The previous_id
field can also be used to make corrective documents by adding the corrective option data in the correct
field. For more details on this, see the GOBL documentation for correction options.
Path Parameters
UUID of the silo entry to create.
Body
When true, the envelope's contents are allowed to be invalid.
The content type of the data being uploaded.
JSON object containing the GOBL correction option data.
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.
The UUID of the previous silo entry to copy.
Response
List of attachments for this entry.
When entry provided within a related query, this is the context within the document.
The date and time the silo entry was created.
JSON envelope contents when specifically requested.
Schema URL for the envelope's payload.
Deprectated. When true, indicates that the envelope is not signed.
Schema URL for the envelope.
List of faults that occurred during the processing of the job associated with the last state.
Key for the folder where the entry is located.
UUID of the silo entry.
When true, the envelope's contents are invalid and need to be reviewed.
Additional meta fields associated with the entry.
When true, the envelope has been signed and should not be modified.
JSON object containing a snippet of the document.
Current state of the silo entry if not a draft.
Copy of tags stored in the envelope header.
The date and time the silo entry was last updated.