Documents API
Fetch
GET /document/{tenantLocator}/documents/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:DocumentInstanceResponse
Security Group:documents  Permission:read
DocumentInstanceResponse
¶requiredlocator locatorreferenceLocator locatordocumentInstanceState Enum draft | dataReady | ready | dataError | renderError | conversionErrorexternal booleanreferenceType Enum quote | policy | invoice | transaction | segment | termcreatedAt datetimemetadata map<string,object>renderingData map<string,object>optionalpolicyLocator locator?termLocator locator?transactionLocator locator?segmentLocator locator?referenceDocumentLocator locator?staticName string?name string?category string?documentFormat Enum? text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | zipprocessingErrors string?readyAt datetime?createdBy uuid?
GET /document/{tenantLocator}/documents/{locator}/document
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:StreamingResponseBody<string>
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/{locator}/source
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:StreamingResponseBody<string>
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/segment/{locator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DocumentListResponse
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/transaction/{locator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DocumentListResponse
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/quote/{locator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DocumentListResponse
Security Group:documents  Permission:read
DocumentListResponse
¶requiredlistCompleted booleanitems DocumentInstanceResponse[]
GET /document/{tenantLocator}/documents/invoices/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:DocumentInstanceResponse
Security Group:documents  Permission:read
Modification
POST /document/{tenantLocator}/documents/attach
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
referenceLocator | query | locator | required |
referenceType | query | Enum quote | policy | invoice | transaction | segment | term | required |
name | query | string | required |
staticName | query | string? | optional |
documentFormat | query | Enum text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | zip | required |
metadata | query | string? | optional |
transactionLocator | query | locator? | optional |
segmentLocator | query | locator? | optional |
category | query | string? | optional |
Request:file
Response:DocumentInstanceResponse
Security Group:documents  Permission:upload-external
PATCH /document/{tenantLocator}/documents/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
metadata | query | string? | optional |
category | query | string? | optional |
Request:file
Response:DocumentInstanceResponse
Security Group:documents  Permission:replace-external
Ad-hoc Rendering
POST /document/{tenantLocator}/documents/render
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
referenceType | query | Enum quote | policy | invoice | transaction | segment | term | required |
referenceLocator | query | locator | required |
productName | query | string? | optional |
templateFormat | query | Enum? liquid | velocity | optional |
documentConfig | query | string? | optional |
staticName | query | string? | optional |
templateName | query | string? | optional |
Request:TemplateResponse
Response:StreamingResponseBody<string>
Security Group:documents  Permission:render-external