Skip to main content
Conga Support

Novatus API Objects

General Considerations

Each object mirrors what is seen in the application.  For example, the Company object will contain all the system default fields and any additional fields that you have created on each profile.  Nearly all of these fields can return the values in them.

Novatus Company

The Novatus Company class mirrors what is seen on the Company Profile of the Novatus application. When creating a Company, the name, group, and status are required.

Below are fields that can be used as search parameters:

  • id
  • name
  • number
  • group
  • tax id
  • status
  • duns
  • type
  • category
  • url
  • address1
  • address2
  • city
  • state
  • postal
  • country
  • description

Novatus Contract

The Novatus Contract class mirrors what is seen on the Contract Profile of the Novatus application. When creating a contract, the Company, Group, Agreement Type, Contract Type, Legal Entity, Status, and Term Type fields are required. If the Term Type is not Perpetual, Original Expiration Date is required. Auto-renewing a term type also requires a Renewal Interval. When updating or creating a contract, only the id field of the company object is used - other company fields will not be updated on the server.

Below are fields that can be used as search parameters:

  • id
  • company name
  • number
  • group
  • company id
  • status
  • value
  • type
  • proposed value
  • legal entity
  • original company
  • agreement type
  • currency
  • term type
  • last updated on
  • created on
  • last updated by
  • created by
  • description
  • effective date
  • original expiration date
  • current expiration date

Novatus Document

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

Below are fields that can be used as search parameters:

  • id
  • company group
  • contract group
  • filename
  • file size
  • author
  • revision
  • type
  • file type
  • family id
  • last updated by
  • last updated on
  • created on
  • created by
  • description
  • effective date
  • expiration date
  • object id

Novatus Dynamic Form

The Novatus Dynamic Form class contains additional forms that are normally found in Admin >> Dynamic Forms. The config id and object id fields are required, and are found in the application.

Dynamic form queries can be run using the form and field names associated with each form.  This makes the queries more diverse.

Novatus Payment

The Novatus Payment class contains payments that appear on a Contract Profile. To create a new payment in an existing payment stream, either the stream id field or both the stream name and contract id fields are required. To create a new payment stream, use the stream name and contract id fields.

Below are fields that can be used as search parameters:

  • id
  • invoice number
  • invoice date
  • invoice due date
  • paid date
  • paid amount
  • reference number
  • transaction id
  • notes
  • stream type
  • stream id
  • contract id
  • stream name

Novatus User

The Novatus User class contains information about system users. When creating a user, the Email Address, Login Name, Password, First Name, and Last Name fields are required. Also, functions must have at least one entry. The Password field can be used to change a user's password, but for security reasons, the field is blank when a Novatus User is retrieved from the server.

Below are fields that can be used as search parameters:

  • id
  • roles
  • prefix
  • first name
  • middle name
  • last name
  • title
  • address1
  • address2
  • mailstop
  • city
  • state
  • postal
  • country
  • email
  • person id
  • work
  • cell
  • home
  • fax
  • notes
  • functions
  • organization

Novatus Company Person

The Novatus Company Person class contains information about company persons. When creating a company person, the First Name and Last Name fields are required. The company field is only for reference, the create or update methods only use the company id field to determine what company the person belongs to.

Below are fields that can be used as search parameters:

  • id
  • prefix
  • first name
  • middle name
  • last name
  • title
  • address1
  • address2
  • mailstop
  • city
  • state
  • postal
  • country
  • email
  • organization
  • work
  • cell
  • home
  • fax number
  • notes
  • company name
  • company id

Novatus Project

The Novatus Project class contains information about projects. The class itself does not contain project items, but rather the data for the project itself. To access the Project menu of Contracts, Companies, etc., you will need to use the separate methods that are provided. Project Team Members are described by the NovatusProjectTeamMember class, and Project Menu Items are described by the NovatusProjectMenuItem class.

Below are fields that can be used as search parameters:

  • id
  • name
  • description
  • status
  • group
  • type
  • start date
  • end date
  • last updated on
  • created on

Novatus Project Menu Item

The Novatus Project Menu Item class describes the contents of a project (contracts, companies, folders). When the menu items have been retrieved, they can be used to retrieve the objects they refer to via the other services.

Novatus Project Team Menu

The Novatus Project Team Member includes a Novatus User object as well as permission information for the user in regards to this project.