NovatusPayment Object

  • The NovatusPayment class contains payments which appear on a Contract Profile. 
  • To create a new payment in an existing payment stream, either the streamId field or both the streamName and contractId fields are required.
  •  To create a new payment stream use the streamName, streamType, and contractId fields.
  • For streamType use 1 for incoming streams and 2 for outgoing streams

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

Field Name

Type

Description

Queryable

Required

id

String

A unique identifier of this Novatus Payment

Yes

-

invoiceNumber

String

Invoice Number

Yes

-

invoiceDate

XML Gregorian Calendar Date

Invoice Date

Yes

-

invoiceDueDate

XML Gregorian Calendar Date

Invoice Due Date

Yes

-

paidDate

XML Gregorian Calendar Date

Paid Date

Yes

-

paidAmount

BigDecimal

Paid Amount

Yes

-

referenceNumber

String

Reference Number

Yes

-

transactionId

String

Transaction ID

Yes

-

notes

String

Notes

Yes

-

streamType

Integer

1 = incoming, 2 = outgoing

Yes

Yes

streamId

String

A unique identifier of the payment stream

Yes

-

contractId

String

The ID of a contract that contains the payment

Yes

Yes

streamName

String

The name of the payment stream

Yes

Yes


NovatusPayment Object Methods

NovatusPayment NQL Statements

These are list of items that can be placed into an NQL statement to filter Payment 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.

Field Name

Description

id

A unique identifier of this Novatus Payment

invoicenumber

Invoice Number

invoicedate

Invoice Date

invoiceduedate

Invoice Due Date

paiddate

Paid Date

paidamount

Paid Amount

referencenumber

Reference Number

transactionid

Transaction ID

notes

Notes

streamtype

1 = incoming, 2 = outgoing

streamid

A unique identifier of the payment stream

contractid

The ID of a contract that contains the payment

streamname

The name of the payment stream