Document
A generated document created by rendering a Template_Document with data from a specific CRM record. Represents the output of a document generation operation — for example, a PDF invoice or a signed contract. Stores the rendered content and the source template reference.
Endpoints
List
GET
/v1/odata/DocumentGet by ID
GET
/v1/odata/Document({id})Create
POST
/v1/odata/DocumentUpdate
PUT
/v1/odata/Document({id})Delete
DELETE
/v1/odata/Document({id})Fields
| Field | Type | Description |
|---|---|---|
Name | String | Name |
Version | Double | Version |
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| Emails | Activity_Email | 1:N | Emails |
| DigitalSignatures | DigitalSignature | 1:N | Digital Signatures |
| FinalizedDocument | File | N:1 | Finalized Document |
Expanding Relationships
GET
/v1/odata/Document({id})?$expand=EmailsNavigating Relationships
GET
/v1/odata/Document({id})/EmailsCustom Query
Build your own OData query against Document. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.
GET
/v1/odata/Document?$top=10