Agreement

An agreement [Agreement]is a contract or a statement of work (SOW) that is used to track budget balance for a specific customer.

Review the Usage Guidelines for the Agreement object.

For more information about agreements, see Agreements.

—	XML	SOAP	REST	Database table
Object	`Agreement`	`oaAgreement`	—	`agreement`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

Agreement

oaAgreement

—

agreement

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

—

The Agreement object has the following standard properties:

Note:

Agreement object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP	Database	Description
`acct_date`	`acct_date`	The accounting period date of the agreement. See Date Fields
`active`	`active`	A 1/0 field indicating whether this is an active agreement. Defaults to `1` if not set when adding an agreement.
`code`	`acct_code`	Optional accounting system code for integration with external accounting systems.
`created`	`created`	[Read-only] Time the record was created. See Date Fields
`currency`	`currency`	Currency for the money fields in the record.
`customerid`	`customerid`	[Required] Customer ID.
`date`	`date`	[Required] The date of the agreement. See Date Fields
`externalid`	`externalid`	External ID.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by OpenAir.
`name`	`name`	[Required] The name of the agreement.
`notes`	`notes`	Notes.
`number`	`number`	The agreement number.
`picklist_label`	—	Label as shown on form picklist.
`total`	`total`	The agreement total. Dated by the date field.
`updated`	`updated`	[Read-only] Time the record was last modified. See Date Fields

XML / SOAP

Database

Description

acct_date

The accounting period date of the agreement.

See Date Fields

active

A 1/0 field indicating whether this is an active agreement. Defaults to 1 if not set when adding an agreement.

code

acct_code

Optional accounting system code for integration with external accounting systems.

created

[Read-only] Time the record was created.

See Date Fields

currency

Currency for the money fields in the record.

customerid

[Required] Customer ID.

date

[Required] The date of the agreement.

See Date Fields

externalid

External ID.

id

[Read-only] Unique ID. Automatically assigned by OpenAir.

name

[Required] The name of the agreement.

notes

Notes.

number

The agreement number.

picklist_label

—

Label as shown on form picklist.

total

The agreement total. Dated by the date field.

updated

[Read-only] Time the record was last modified.

See Date Fields

Usage Guidelines

You cannot delete an Agreement object if this object is referenced by an object of any of the following type. Delete any dependent objects first before you delete an Agreement object.