Document Service

NovatusDocument Object

The NovatusDocument class contains the metadata for a document.
The id of the document can be used to retrieve the actual file through the Document service's getDocumentContents method.
One id is required in objects, which is the object to link the document to (Company, Contract, etc.)

Production WSDL: https://app1.novatuscontracts.com/Contracts/wsapi/v1/Document?Wsdl

Field Name	Type	Description	Queryable	Required
id	String	A unique identifier of this document	Yes	-
type	String	Document Type	Yes	Yes
familyId	String	A unique identifier for this document family	Yes	-
revisionNumber	int	Revision Number	Yes	-
fileName	String	File Name	Yes	-
fileType	String	File Type (MIME)	Yes	-
fileSize	int	File Size (bytes)	Yes	-
author	String	Author Name	Yes	-
description	String	Document Description	Yes	-
effectiveDate	XML Gregorian Calendar Date	Effective Date	Yes	-
expirationDate	XML Gregorian Calendar Date	Expiration Date	Yes	-
objects	List<String>	The object IDs that the document is linked to	-	Yes, must be a get call
createdOn	XML Gregorian Calendar Date	Date that document was originally uploaded	Yes	-
createdBy	String	Person that uploaded the document originally	Yes	-
lastUpdatedOn	XML Gregorian Calendar Date	Most recent date the document profile was changed	Yes	-
lastUpdatedBy	String	Person that made the most recent changes to the document profile	Yes	-

NovatusDocument Object Methods

NovatusDocument NQL Statements

These are list of items that can be placed into an NQL statement to filter Document queries. This is different from the above chart in that these are not methods that can return data but rather NQL statements that can allow you to filter query results.

Filter Name	Description
id	A unique identifier for the document
companygroup	Group of the company that the document is associated with
contractgroup	Group of the contract that the document is associated with
filename	Filename of the document
filesize	File size of the document
author	Document Author
revision	Document Revision Number
type	Document Type
filetype	Document File Type
familyid	Document Family Id
lastupdatedBy	Last person that updated the Document
lastupdatedOn	Last date that the document profile was updated on
createdon	Date that the document was created/uploaded
createdby	Person that uploaded the document originally
description	Document Description
effectivedate	Document Effective Date
expirationdate	Document Expiration Date
objectid	UUID of the object (contract or company) that the document is associated with