Contracts

The contract is the container for the products or services that are provided to a specified customer. It can control settings such as renewals and terms, capture compliance information, and record the transaction history for all contract lines and expenses.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List contracts

get/objects/contracts/contract

Returns up to 100 object references from the collection with a key, ID, and link for each contract. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionContract Core Billing
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList Contracts
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "84",
      • "id": "84",
      • "href": "/objects/contracts/contract/84"
      },
    • {
      • "key": "107",
      • "id": "107",
      • "href": "/objects/contracts/contract/107"
      },
    • {
      • "key": "108",
      • "id": "108",
      • "href": "/objects/contracts/contract/108"
      },
    • {
      • "key": "56",
      • "id": "56",
      • "href": "/objects/contracts/contract/56"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a contract
post/objects/contracts/contract
Creates a new contract.


id is required if document sequencing is not enabled for contracts. If document sequencing is enabled, you can provide an id value to use instead of the document sequence value.



Permissions and other requirements



SubscriptionContract Core Billing


User typeBusiness


PermissionsAdd Contracts







SecurityOAuth2 
Request 
Request Body schema: application/json
id
string
Unique ID for the contract.


 
 Example:  "CON-0045-1"
name
string
Contract name


 
 Example:  "ACME Widgets - Service"
description
string or null
Description of the contract.


 
 Example:  "YMCA of Metro Atlanta - 360 Support"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
state
string
 Default:  "inProgress"
State of the contract. Use draft when creating a contract that is not ready to post to the general ledger.


    

  • draft: The contract was saved as a preliminary version. A draft contract has no effect on the General Ledger.
    • 

  • inProgress: The contract was posted and is considered in effect. A contract keeps this state until it is renewed, ends without being renewed, or is canceled.
    • 

  • canceled: All contract schedules (revenue, expense, and billing) were canceled for all contract lines associated with this contract.
    • 

  • notRenewed: The contract completed its term, but it was not renewed. Only applicable if termType = termed.
    • 

  • renewed: The contract was renewed. Only applicable if termType = termed.
    • 



 Enum: "canceled" "draft" "inProgress" "notRenewed" "renewed"  
 Example:  "inProgress"
application
string
 Default:  "contracts"
Contract Application. Use contracts for standard contracts and orderEntry for order entry contracts.


    

  • contracts: Standard contracts - used for billing and revenue recognition, available for contract module users.
    • 

  • orderEntry: Order entry contracts - used for tracking only, available for contract module users and as dimension.
    • 



 Enum: "contracts" "orderEntry"  
 Example:  "contracts"
startDate
string <date> 
Contract start date.  The start date cannot be changed after a contract line has been posted to the contract.


For evergreen contracts the start date determines the start day of each recurring billing period. The contract line billing frequency (Monthly, Quarterly, or Annually) determines the length of each recurring billing period.


 
 Example:  "2023-01-01"
endDate
string <date> 
Contract end date. The end date drives the renewal process. Required when termType = termed.


 
 Example:  "2024-01-01"
object
Contract contacts


 
object
Contact to ship to. Leave blank to use customer's default.


 
key
string
 
 Example:  "1482"
id
string
 
 Example:  "Gruppen (Estate Europe) Services ABCUS-RT-0010"
object
Contact to bill to. Leave blank to use customer's default.


 
key
string
 
 Example:  "1482"
id
string
 
 Example:  "Gruppen (Estate Europe) Services ABCUS-RT-0010"
object
Additional Contact. Order Entry Specific Field.


 
key
string or null
 
 Example:  "1482"
id
string or null
 
 Example:  "Gruppen (Estate Europe) Services ABCUS-RT-0010"
cancellationDate
string or null <date> 
The effective date for the contract cancellation.


 
 Example:  "2023-04-01"
billingFrequency
string or null
 Default:  null
Billing frequency


 Enum: "annually" "monthly" null "quarterly"  
 Example:  "monthly"
object
AR payment term for this contract.


 
key
string
 
 Example:  "16"
id
string
 
 Example:  "N90"
object
Billing price used for all contract lines.


 
key
string
Billing price list key


 
 Example:  "12"
id
string
 
 Example:  "SoftwarePackages"
object
MEA price list. Only applicable if termType = termed and the company is subscribed to Contract Advanced Revenue Recognition.


 
key
string
MEA price list key


 
 Example:  "12"
id
string
 
 Example:  "Services MEA Price List"
holdBilling
boolean or null
Billing hold


 
 Example:  false
holdRevenue
boolean or null
Revenue hold


 
 Example:  false
holdExpense
boolean or null
Expense hold


 
 Example:  false
object
Currencies used in the contract. Required if company is configured for multi-currency.


 
exchangeRateType
string
Exchange rate type. Leave blank to use Intacct Daily Rate. The exchange rate type cannot be changed after a contract line is posted to the contract.


 
 Example:  "EUR-Rate"
baseCurrency
string
Base currency. Defaults to the base currency associated with the selected location/entity.


 
 Example:  "USD"
txnCurrency
string
Transaction currency. Defaults to the transaction currency associated with the selected customer. All contract lines have the same transaction currency. The transaction currency cannot be changed after a contract line is posted to the contract.


 
 Example:  "USD"
isRenewable
boolean
 Default:  false
Whether the contract is enabled for renewal. Only applicable if termType = termed.


 
 Example:  false
object
 
template
string
Renewal template. Only used if renewal is true.


 
 Example:  "12 months with notifications"
contractTermType
string
 Default:  "termed"
Contract term type:


    

  • termed - a traditional payment term such as Net 30
    • 

  • evergreen - perpetual contract
    • 



 Enum: "evergreen" "termed"  
 Example:  "termed"
termLength
integer or null
How frequently the contract is renewed, counted in renewTermPeriods (days, months, or years). Only applicable if termType = termed.


 
 Example:  12
termPeriod
string
 Default:  "months"
Renewal term period. Only applicable if termType = termed.


 Enum: "days" "months" "years"  
 Example:  "months"
triggerDate
string <date> 
Trigger date.


 
 Example:  "2024-12-01"
date
string <date> 
Renewal date.


 
 Example:  "2024-12-01"
billInAdvanceLength
integer or null
Number of renewalBillInAdvancePeriod units (months or days) before the renewal date to bill the customer. Overrides bill-in-advance settings on the customer.


 
 Example:  2
billInAdvancePeriod
string or null
 Default:  null
Renewal bill in advance time units. Must be set to days or months if using bill in advance for renewals.


 Enum: "days" "months" null  
 Example:  "days"
billInAdvanceLength
integer or null
Number of billInAdvancePeriod units (months or days) before the contract start date to bill the customer. Overrides bill-in-advance settings on the customer.


 
 Example:  1
billInAdvancePeriod
string or null
 Default:  null
Bill in advance time units. Must be set to days or months if using bill in advance.


 Enum: "days" "months" null  
 Example:  "months"
key
string
 
 Example:  "1"
name
string
 
 Example:  "service"
deferEstimatedTimeBasedRevenueBy
string or null
 Default:  null
Specifies how Intacct should combine the timesheet hours associated with a Time & Materials project:


    

  • project: All hours billed from timesheets associated with the project will be used to determine actual revenue for the contract line. There can only be one In progress Project time contract line in the contract linked to a particular project.
    • 

  • projectAndItem: All hours billed from timesheets associated with a particular item and with a particular project will be combined and used to determine the actual revenue for the contract line. Each project/item combination on each Project time contract line within a contract must be unique.
    • 

  • projectAndTask: All hours billed from timesheets associated with a particular task and with a particular project will be combined and used to determine the actual revenue for the contract line. Each project/task combination on each Project time contract line within a contract must be unique.
    • 



 Only applicable if termType = termed and "Enable deferred revenue for Time & Materials projects" is turned on for the company.


 Enum: null "project" "projectAndItem" "projectAndTask"  
 Example:  "projectAndTask"
contractTotalAmount
string
The total flat/fixed amount value of the contract (does not include usage).


 
 Example:  "2300"
billedAmount
string
The total amount invoiced from the contract.


 
 Example:  "1000"
object
Supporting document attached to the contract.


 
key
string
System-assigned key for the supporting document.


 
 Example:  "18"
id
string
System-assigned ID for the supporting document.


 
 Example:  "18"
postMemo
string or null
Post memo.


 
 Example:  "Cash customer"
object
 
object
Location or entity associated with the contract. This field is required in a multi-entity environment. Contract lines are restricted to the specified location or entity or to a child of the location or entity.


 
key
string
Location Key


 
 Example:  "22"
id
string
Location


 
 Example:  "LOC-22"
object
Department associated with the contract.


 
key
string
Department Key


 
 Example:  "11"
id
string
Department


 
 Example:  "DEP-11"
name
string
Department name


 
 Example:  "Human Resources"
object
 
key
string
Class Key


 
 Example:  "731"
id
string
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string
Task ID


 
 Example:  "1"
key
string
Task Key


 
 Example:  "1"
object
 
key
string
Vendor Key


 
 Example:  "357"
id
string
Vendor ID


 
 Example:  "1605212096809"
object
Customer that the contract is associated with. The customer cannot be changed after a contract line has been posted to the contract.


 
key
string
Customer Key


 
 Example:  "250"
id
string
Customer ID


 
 Example:  "CUS-RT-0011"
object
 
key
string
Project Key


 
 Example:  "2"
id
string
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string
Employee Key


 
 Example:  "10"
id
string
Employee ID


 
 Example:  "EMP-10"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "ProjectTime_Completed_Flows34_45_4",
  • "startDate": "2023-01-01",
  • "endDate": "2023-12-31",
  • "name": "ProjectTime_Completed_Flows",
  • "dimensions": {
    • "customer": {
      • "key": "1"
      },
    • "location": {
      • "key": "1"
      },
    • "department": {
      • "key": "1"
      }
    },
  • "currency": {
    • "baseCurrency": "USD",
    • "txnCurrency": "USD",
    • "exchangeRateType": "Intacct Daily Rate"
    },
  • "paymentTerm": {
    • "key": "1"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "124",
    • "id": "ProjectTime_Completed_Flows34_45_4",
    • "href": "/objects/contracts/contract/124"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a contract
get/objects/contracts/contract/{key}
Returns detailed information for a specified contract.



Permissions and other requirements



SubscriptionContract Core Billing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsView Contracts







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the contract.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "parent": {
      • "key": null,
      • "id": null
      },
    • "description": "contract with 2 lines all values",
    • "id": "ProjectTime_Completed_Flows34_45_4",
    • "state": "inProgress",
    • "application": "contracts",
    • "isRenewable": false,
    • "renewedContract": {
      • "key": null,
      • "id": null
      },
    • "renewal": {
      • "contractTermType": "termed",
      • "template": "RC_24M_Price_SO",
      • "termLength": 24,
      • "termPeriod": "months",
      • "billInAdvanceLength": null,
      • "billInAdvancePeriod": "",
      • "triggerDate": null,
      • "date": null
      },
    • "startDate": "2016-01-01",
    • "endDate": "2016-12-31",
    • "cancellationDate": "2016-03-01",
    • "name": "BaseSanity",
    • "dimensions": {
      • "customer": {
        },
      • "location": {
        },
      • "department": {
        },
      • "project": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "class": {
        }
      },
    • "contacts": {},
    • "billingFrequency": "quarterly",
    • "paymentTerm": {
      • "key": "16",
      • "id": "N90",
      • "href": "/objects/accounts-receivable/term/16"
      },
    • "billingPriceList": {
      • "key": "24",
      • "id": "SaaSy Pricing",
      • "href": "/objects/contracts/billing-price-list/24"
      },
    • "meaPriceList": {
      • "id": "2009 VSOE Price List USD_R",
      • "key": "2",
      • "href": "/objects/contracts/mea-price-list/2"
      },
    • "holdBilling": false,
    • "holdRevenue": false,
    • "holdExpense": false,
    • "currency": {
      • "baseCurrency": "INR",
      • "txnCurrency": "INR",
      • "exchangeRateType": "EUR-Rate"
      },
    • "billInAdvanceLength": null,
    • "billInAdvancePeriod": null,
    • "audit": {
      • "createdDateTime": "2022-07-13T04:42:34Z",
      • "modifiedDateTime": "2022-07-13T04:42:34Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "attachment": {
      • "id": null,
      • "key": null
      },
    • "status": "active",
    • "contractType": {
      • "key": null,
      • "name": null
      },
    • "deferEstimatedTimeBasedRevenueBy": null,
    • "postMemo": null,
    • "contractTotalAmount": 1728,
    • "billedAmount": 0,
    • "href": "/objects/contracts/contract/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a contract
patch/objects/contracts/contract/{key}
Updates an existing contract by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionContract Core Billing


User typeBusiness


PermissionsEdit Contract







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the contract.


 
Request Body schema: application/json
name
string
Contract name


 
 Example:  "ACME Widgets - Service"
description
string or null
Description of the contract.


 
 Example:  "YMCA of Metro Atlanta - 360 Support"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
state
string
 Default:  "inProgress"
State of the contract. Use draft when creating a contract that is not ready to post to the general ledger.


    

  • draft: The contract was saved as a preliminary version. A draft contract has no effect on the General Ledger.
    • 

  • inProgress: The contract was posted and is considered in effect. A contract keeps this state until it is renewed, ends without being renewed, or is canceled.
    • 

  • canceled: All contract schedules (revenue, expense, and billing) were canceled for all contract lines associated with this contract.
    • 

  • notRenewed: The contract completed its term, but it was not renewed. Only applicable if termType = termed.
    • 

  • renewed: The contract was renewed. Only applicable if termType = termed.
    • 



 Enum: "canceled" "draft" "inProgress" "notRenewed" "renewed"  
 Example:  "inProgress"
application
string
 Default:  "contracts"
Contract Application. Use contracts for standard contracts and orderEntry for order entry contracts.


    

  • contracts: Standard contracts - used for billing and revenue recognition, available for contract module users.
    • 

  • orderEntry: Order entry contracts - used for tracking only, available for contract module users and as dimension.
    • 



 Enum: "contracts" "orderEntry"  
 Example:  "contracts"
startDate
string <date> 
Contract start date.  The start date cannot be changed after a contract line has been posted to the contract.


For evergreen contracts the start date determines the start day of each recurring billing period. The contract line billing frequency (Monthly, Quarterly, or Annually) determines the length of each recurring billing period.


 
 Example:  "2023-01-01"
endDate
string <date> 
Contract end date. The end date drives the renewal process. Required when termType = termed.


 
 Example:  "2024-01-01"
object
Contract contacts


 
object
Contact to ship to. Leave blank to use customer's default.


 
key
string
 
 Example:  "1482"
id
string
 
 Example:  "Gruppen (Estate Europe) Services ABCUS-RT-0010"
object
Contact to bill to. Leave blank to use customer's default.


 
key
string
 
 Example:  "1482"
id
string
 
 Example:  "Gruppen (Estate Europe) Services ABCUS-RT-0010"
object
Additional Contact. Order Entry Specific Field.


 
key
string or null
 
 Example:  "1482"
id
string or null
 
 Example:  "Gruppen (Estate Europe) Services ABCUS-RT-0010"
cancellationDate
string or null <date> 
The effective date for the contract cancellation.


 
 Example:  "2023-04-01"
billingFrequency
string or null
 Default:  null
Billing frequency


 Enum: "annually" "monthly" null "quarterly"  
 Example:  "monthly"
object
AR payment term for this contract.


 
key
string
 
 Example:  "16"
id
string
 
 Example:  "N90"
object
Billing price used for all contract lines.


 
key
string
Billing price list key


 
 Example:  "12"
id
string
 
 Example:  "SoftwarePackages"
object
MEA price list. Only applicable if termType = termed and the company is subscribed to Contract Advanced Revenue Recognition.


 
key
string
MEA price list key


 
 Example:  "12"
id
string
 
 Example:  "Services MEA Price List"
holdBilling
boolean or null
Billing hold


 
 Example:  false
holdRevenue
boolean or null
Revenue hold


 
 Example:  false
holdExpense
boolean or null
Expense hold


 
 Example:  false
object
Currencies used in the contract. Required if company is configured for multi-currency.


 
exchangeRateType
string
Exchange rate type. Leave blank to use Intacct Daily Rate. The exchange rate type cannot be changed after a contract line is posted to the contract.


 
 Example:  "EUR-Rate"
baseCurrency
string
Base currency. Defaults to the base currency associated with the selected location/entity.


 
 Example:  "USD"
txnCurrency
string
Transaction currency. Defaults to the transaction currency associated with the selected customer. All contract lines have the same transaction currency. The transaction currency cannot be changed after a contract line is posted to the contract.


 
 Example:  "USD"
isRenewable
boolean
 Default:  false
Whether the contract is enabled for renewal. Only applicable if termType = termed.


 
 Example:  false
object
 
template
string
Renewal template. Only used if renewal is true.


 
 Example:  "12 months with notifications"
contractTermType
string
 Default:  "termed"
Contract term type:


    

  • termed - a traditional payment term such as Net 30
    • 

  • evergreen - perpetual contract
    • 



 Enum: "evergreen" "termed"  
 Example:  "termed"
termLength
integer or null
How frequently the contract is renewed, counted in renewTermPeriods (days, months, or years). Only applicable if termType = termed.


 
 Example:  12
termPeriod
string
 Default:  "months"
Renewal term period. Only applicable if termType = termed.


 Enum: "days" "months" "years"  
 Example:  "months"
triggerDate
string <date> 
Trigger date.


 
 Example:  "2024-12-01"
date
string <date> 
Renewal date.


 
 Example:  "2024-12-01"
billInAdvanceLength
integer or null
Number of renewalBillInAdvancePeriod units (months or days) before the renewal date to bill the customer. Overrides bill-in-advance settings on the customer.


 
 Example:  2
billInAdvancePeriod
string or null
 Default:  null
Renewal bill in advance time units. Must be set to days or months if using bill in advance for renewals.


 Enum: "days" "months" null  
 Example:  "days"
billInAdvanceLength
integer or null
Number of billInAdvancePeriod units (months or days) before the contract start date to bill the customer. Overrides bill-in-advance settings on the customer.


 
 Example:  1
billInAdvancePeriod
string or null
 Default:  null
Bill in advance time units. Must be set to days or months if using bill in advance.


 Enum: "days" "months" null  
 Example:  "months"
key
string
 
 Example:  "1"
name
string
 
 Example:  "service"
deferEstimatedTimeBasedRevenueBy
string or null
 Default:  null
Specifies how Intacct should combine the timesheet hours associated with a Time & Materials project:


    

  • project: All hours billed from timesheets associated with the project will be used to determine actual revenue for the contract line. There can only be one In progress Project time contract line in the contract linked to a particular project.
    • 

  • projectAndItem: All hours billed from timesheets associated with a particular item and with a particular project will be combined and used to determine the actual revenue for the contract line. Each project/item combination on each Project time contract line within a contract must be unique.
    • 

  • projectAndTask: All hours billed from timesheets associated with a particular task and with a particular project will be combined and used to determine the actual revenue for the contract line. Each project/task combination on each Project time contract line within a contract must be unique.
    • 



 Only applicable if termType = termed and "Enable deferred revenue for Time & Materials projects" is turned on for the company.


 Enum: null "project" "projectAndItem" "projectAndTask"  
 Example:  "projectAndTask"
contractTotalAmount
string
The total flat/fixed amount value of the contract (does not include usage).


 
 Example:  "2300"
billedAmount
string
The total amount invoiced from the contract.


 
 Example:  "1000"
object
Supporting document attached to the contract.


 
key
string
System-assigned key for the supporting document.


 
 Example:  "18"
id
string
System-assigned ID for the supporting document.


 
 Example:  "18"
postMemo
string or null
Post memo.


 
 Example:  "Cash customer"
object
 
object
Location or entity associated with the contract. This field is required in a multi-entity environment. Contract lines are restricted to the specified location or entity or to a child of the location or entity.


 
key
string
Location Key


 
 Example:  "22"
id
string
Location


 
 Example:  "LOC-22"
object
Department associated with the contract.


 
key
string
Department Key


 
 Example:  "11"
id
string
Department


 
 Example:  "DEP-11"
name
string
Department name


 
 Example:  "Human Resources"
object
 
key
string
Class Key


 
 Example:  "731"
id
string
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string
Task ID


 
 Example:  "1"
key
string
Task Key


 
 Example:  "1"
object
 
key
string
Vendor Key


 
 Example:  "357"
id
string
Vendor ID


 
 Example:  "1605212096809"
object
Customer that the contract is associated with. The customer cannot be changed after a contract line has been posted to the contract.


 
key
string
Customer Key


 
 Example:  "250"
id
string
Customer ID


 
 Example:  "CUS-RT-0011"
object
 
key
string
Project Key


 
 Example:  "2"
id
string
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string
Employee Key


 
 Example:  "10"
id
string
Employee ID


 
 Example:  "EMP-10"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "location": {
    • "key": "6"
    },
  • "contacts": {
    • "billTo": {
      • "key": "2"
      }
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "121",
    • "id": "CON-0045-1",
    • "href": "/objects/contracts/contract/121"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a contract
delete/objects/contracts/contract/{key}
Deletes a contract. You can delete a contract if there are no related records. For example, you can delete a contract if there are no contract lines, no expense lines, no signed-off compliance tasks, no notes, and so on. If there are related records, delete each record and then delete the contract.


If you cannot delete a related record, cancel the contract instead.



Permissions and other requirements



SubscriptionContract Core Billing


User typeBusiness


PermissionsDelete Contracts







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the contract.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query contracts
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "contracts/contract"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}