Documents API

Fetch

Fetch a Document instance

fetchDocument

GET /document/{tenantLocator}/documents/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:DocumentInstanceResponse
Security Group:documents   Permission:read

DocumentInstanceResponse

required
locator string
referenceLocator string
documentInstanceState Enum draft | dataReady | ready | dataError | renderError | conversionError
external boolean
referenceType Enum quote | policy | invoice | transaction | segment | term
createdAt datetime
metadata map<string,object>
renderingData map<string,object>

optional
policyLocator string?
termLocator string?
transactionLocator string?
segmentLocator string?
referenceDocumentLocator string?
staticName string?
name string?
category string?
documentFormat Enum? text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | zip
processingErrors string?
readyAt datetime?
createdBy uuid?

Fetch the Rendered artifact for a Document

fetchDocumentResource

GET /document/{tenantLocator}/documents/{locator}/document

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:StreamingResponseBody<string>
Security Group:documents   Permission:read

Fetch the Source for a Document

fetchSourceForDocument

GET /document/{tenantLocator}/documents/{locator}/source

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:StreamingResponseBody<string>
Security Group:documents   Permission:read

Fetch Documents for a Policy Segment

fetchDocumentsForSegment

GET /document/{tenantLocator}/documents/segment/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DocumentListResponse
Security Group:documents   Permission:read

Fetch Documents for a Policy Transaction

fetchDocumentsForTransaction

GET /document/{tenantLocator}/documents/transaction/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DocumentListResponse
Security Group:documents   Permission:read

Fetch Documents for a Quote

fetchDocumentsForQuote

GET /document/{tenantLocator}/documents/quote/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DocumentListResponse
Security Group:documents   Permission:read

DocumentListResponse

required
listCompleted boolean
items DocumentInstanceResponse[]

Fetch Document for an Invoice

fetchInvoiceDocument

GET /document/{tenantLocator}/documents/invoices/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:DocumentInstanceResponse
Security Group:documents   Permission:read

Modification

Attach Document

attachDocument

POST /document/{tenantLocator}/documents/attach

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
referenceLocator	query	string	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	string?	optional
segmentLocator	query	string?	optional
category	query	string?	optional

Request:file
Response:DocumentInstanceResponse
Security Group:documents   Permission:upload-external

Replace Document

replaceDocument

PATCH /document/{tenantLocator}/documents/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
metadata	query	string?	optional
category	query	string?	optional

Request:file
Response:DocumentInstanceResponse
Security Group:documents   Permission:replace-external

Ad-hoc Rendering

Render Document

renderDocument

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	string	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

See Also

• Documents Configuration Guide

• Document Resources API