Recurring documents

A recurring document contains the transaction header, line item details, and recurring schedule information that the system uses to create a recurring transaction

List recurring documents

get/objects/order-entry/recurring-document

Returns a collection with a key, ID, and link for each recurring document.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/2"
      },
    • {
      • "key": "6",
      • "id": "6",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/6"
      },
    • {
      • "key": "14",
      • "id": "14",
      • "href": "/objects/order-entry/recurring-document::Sales%20Order/14"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a recurring document
get/objects/order-entry/recurring-document/{key}
Returns detailed information for a specified order entry recurring document.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the recurring document.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "14",
    • "key": "14",
    • "txnDefinition": {
      • "key": "86",
      • "id": "Sales Invoice",
      • "href": "/objects/order-entry/txn-definition::Sales%20Invoice/86"
      },
    • "status": "active",
    • "contacts": {
      • "primary": {
        },
      • "shipTo": {
        },
      • "billTo": {
        }
      },
    • "referenceNumber": "1012",
    • "paymentTerm": {
      • "key": "5",
      • "id": "N15",
      • "href": "/objects/accounts-receivable/term/5"
      },
    • "shippingMethod": {
      • "id": "Air",
      • "key": "2",
      • "href": "/objects/accounts-receivable/shipping-method/2"
      },
    • "memo": "End of season clearance sale",
    • "subtotal": "11001.32000000000000",
    • "total": "11611.21000000000000",
    • "recurringSchedule": {
      • "id": "15",
      • "key": "15",
      • "href": "/objects/core/schedule/15"
      },
    • "documentType": "Sales Invoice",
    • "schedule": {
      • "startDate": "2024-07-01",
      • "nextExecutionDate": "2024-07-01",
      • "recurringDueDate": "2024-07-16",
      • "frequency": "weeks",
      • "executionCount": "0",
      • "repeatCount": "2",
      • "repeatBy": "weeks",
      • "repeatInterval": "1"
      },
    • "customer": {
      • "key": "22",
      • "id": "CAR",
      • "name": "Berkeley Technology Inc",
      • "href": "/objects/accounts-receivable/customer/22"
      },
    • "baseCurrency": "USD",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2024-08-08",
      • "rate": "1.0000000000"
      },
    • "subtotalInTxnCurrency": "11001.32000000000000",
    • "totalInTxnCurrency": "11611.21000000000000",
    • "state": "active",
    • "audit": {
      • "createdDateTime": "2024-08-08T09:19:34Z",
      • "modifiedDateTime": "2024-08-08T10:46:15Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "lines": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "subtotals": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
List named recurring documents
get/objects/order-entry/recurring-document::{documentName}
Returns a collection with a key, ID, and link for each order entry document with the specified name. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "171",
      • "id": "171",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/171"
      },
    • {
      • "key": "172",
      • "id": "172",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/172"
      },
    • {
      • "key": "155",
      • "id": "155",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/155"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create an order entry recurring document
post/objects/order-entry/recurring-document::{documentName}
Creates a new order entry recurring document.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
Request Body schema: application/json
required
state
string
 Default:  "active"
State of the Order Entry recurring document.


 Enum: "active" "ended" "inactive"  
 Example:  "active"
object
Contacts associated with the Order Entry recurring document.


 
object
Primary contact


 
id
string
Identifier for the primary contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
Ship-to contact.


 
id
string
Identifier for the ship-to contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
Bill-to contact.


 
id
string
Identifier for the bill-to contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
Shipping method for the document.


 
key
string
System-assigned key for the shipping method.


 
 Example:  "77"
id
string
Identifier for the shipping method.


 
 Example:  "Air"
href
string
URL for the shipping method.


 
 Example:  "/objects/accounts-receivable/shipping-method/77"
referenceNumber
string
Reference number for the Order Entry recurring document.


 
 Example:  "SALES-100"
contractId
string
Sales contract ID associated with the transaction.


 
 Example:  "CN100123"
contractDescription
string
Sales contract description.


 
 Example:  "Sales & Service"
baseCurrency
string
Base currency for the transaction.


 
 Example:  "USD"
txnCurrency
string
Currency used for the transaction.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2021-01-23"
rate
string <decimal-precision-10> 
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1.0789"
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
typeName
string
The name of exchange rate type.


 
 Example:  "Intacct Daily Rate"
object
Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices.


 
key
string
System-assigned key for the AR term.


 
 Example:  "75"
id
string
The name of AR term.


 
 Example:  "10 Days"
notes
string
Notes about the Order Entry document.


 
 Example:  "Fast order"
memo
string
Text printed on the Order Entry document.


 
 Example:  "Lowry solutions"
customerPONumber
string
Customer PO number associated with the transaction.


 
 Example:  "ABOTT-1001"
object
Customer associated with the Order Entry recurring document.


 
 Example:  "IBN"
id
required
string
Customer ID


 
 Example:  "CR1001"
key
string
System-assigned key for the customer.


 
 Example:  "15"
name
string
Customer Name


 
 Example:  "Berkeley Technology Inc"
object
Defines the scheduling details for the Order Entry recurring document, including start date, frequency, next execution date, and end conditions. The schedule provides a comprehensive view of when and how often the recurring document will be generated.


 
 Example:  "{ \"startDate\": \"2024-07-01\", \"frequency\": \"weeks\", \"repeatCount\": \"2\", \"repeatBy\": \"weeks\", \"repeatInterval\": \"1\" }"
startDate
required
string <date> 
Specifies the initial date for generating the recurring document. It remains editable until the first document is processed.


 
 Example:  "2021-01-01"
frequency
required
string or null
 Default:  null
The frequency at which the document recurs. This interacts with the repeat interval.


 Enum: "days" "endOfMonth" "months" "none" null "weeks" "years"  
 Example:  "days"
repeatCount
required
string
The number of times the recurring document is set to repeat.


 
 Example:  "10"
repeatBy
required
string or null
 Default:  null
Specifies the regular interval at which the recurring document should repeat. This setting works in conjunction with the repeatInterval field, where you specify the number of intervals. For example, if you set repeatBy to months and set the repeatInterval to 3, the schedule will run every 3 months.


 Enum: "days" "endOfMonth" "months" "none" null "weeks" "years"  
 Example:  "days"
repeatInterval
required
string
 Default:  "1"
The interval at which the document repeats, based on the scheduler.


 
 Example:  "1"
endDate
string <date> 
End date for the scheduled execution of the recurring document.


 
 Example:  "2022-01-01"
recurringDueDate
string <date> 
Due date for the scheduled execution of the recurring document.


 
 Example:  "2021-06-01"
object
Transaction definition that is associated with this recurring transaction.


 
key
string
System-assigned key for the transaction definition.


 
 Example:  "11"
id
string
Name for the Order Entry transaction definition.


 
 Example:  "Sales Invoice"
Array of objects
Lines of the Order Entry recurring document.


 
 Array 
unit
required
string
Unit associated with this document line item.


 
 Example:  "Each"
unitQuantity
required
string <decimal-precision-10> 
Unit quantity associated with this document line item.


 
 Example:  "10.10"
unitPrice
required
string <decimal-precision-10> 
Unit price associated with this line item.


 
 Example:  "10.50"
object
Item associated with the recurring document line.


 
memo
string
Memo about the document line item.


 
 Example:  "Payment ACH"
object
 
 Example:  "{ \"item\": { \"id\": \"1\" }, \"warehouse\": { \"id\": \"1\" }, \"location\": { \"id\": \"1\" }}"
discountPercent
string <decimal-precision-10> 
Discount percentage for the document line item.


 
 Example:  "10.50"
discountMemo
string
Discount memo for any discounts taken.


 
 Example:  "Festival discount"
revenueRecognitionStartDate
string <date> 
The date on which the either revenue recognition schedule and/or renewal schedule get started.


 
 Example:  "2023-04-04"
revenueRecognitionEndDate
string <date> 
The date on which the either revenue recognition schedule and/or renewal schedule ends.


 
 Example:  "2023-04-04"
isPriceProrated
boolean
 Default:  true
Indicates whether the price is prorated.


 
 Example:  true
isBillable
boolean
 Default:  true
Indicates whether the line is billable.


 
 Example:  true
enableTax
boolean
 Default:  false
Indicates whether the line item is taxable.


 
 Example:  false
conversionType
string
 Default:  "quantity"
Conversion type used for the transaction.


 Enum: "price" "quantity"  
 Example:  "quantity"
object
Alternative name for the Item for a specific customer.


 
recurringStatus
string
 Default:  "active"
Status.


 Enum: "active" "ended" "inactive"  
 Example:  "active"
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"
object
Header lever details for the document line items.


 
Array of objects
Lines of the Order Entry recurring document subtotal.


 
 Array 
description
string
Description about the subtotal.


 
 Example:  "Tax"
absoluteValue
string <decimal-precision-2> 
Non negative base amount calculated across all other lines of the document.


 
 Example:  "40.50"
percentValue
string <decimal-precision-10> 
Percentage value that is calculated on the total of all line items of the recurring document.


 
 Example:  "10.50"
txnAbsoluteValue
string <decimal-precision-2> 
Non negative transaction amount calculated across all other lines of the recurring document.


 
 Example:  "44.78"
object
 
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"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "referenceNumber": "RMF-001",
  • "memo": "Discounted order",
  • "txnCurrency": "USD",
  • "baseCurrency": "USD",
  • "shippingMethod": {
    • "id": "Air"
    },
  • "paymentTerm": {
    • "id": "N15"
    },
  • "customer": {
    • "id": "22"
    },
  • "schedule": {
    • "startDate": "2024-07-01",
    • "nextExecutionDate": "2024-07-01",
    • "recurringDueDate": "2024-07-16",
    • "frequency": "weeks",
    • "repeatCount": "2",
    • "repeatBy": "weeks",
    • "repeatInterval": "1"
    },
  • "lines": [
    • {
      • "unit": "10 Pack",
      • "unitQuantity": "1",
      • "unitPrice": "1000.12",
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "13977",
    • "id": "13977",
    • "documentType": "Sales Invoice",
    • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/13977"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a named recurring document
get/objects/order-entry/recurring-document::{documentName}/{key}
Returns detailed information for a specified order entry recurring document.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
key
required
string
System-assigned key for the order entry recurring document.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "14",
    • "key": "14",
    • "txnDefinition": {
      • "key": "86",
      • "id": "Sales Invoice",
      • "href": "/objects/order-entry/txn-definition::Sales%20Invoice/86"
      },
    • "status": "active",
    • "contacts": {
      • "primary": {
        },
      • "shipTo": {
        },
      • "billTo": {
        }
      },
    • "referenceNumber": "1012",
    • "paymentTerm": {
      • "key": "5",
      • "id": "N15",
      • "href": "/objects/accounts-receivable/term/5"
      },
    • "shippingMethod": {
      • "id": "Air",
      • "key": "2",
      • "href": "/objects/accounts-receivable/shipping-method/2"
      },
    • "memo": "End of season clearance sale",
    • "subtotal": "11001.32000000000000",
    • "total": "11611.21000000000000",
    • "recurringSchedule": {
      • "id": "15",
      • "key": "15",
      • "href": "/objects/core/schedule/15"
      },
    • "documentType": "Sales Invoice",
    • "schedule": {
      • "startDate": "2024-07-01",
      • "nextExecutionDate": "2024-07-01",
      • "recurringDueDate": "2024-07-16",
      • "frequency": "weeks",
      • "executionCount": "0",
      • "repeatCount": "2",
      • "repeatBy": "weeks",
      • "repeatInterval": "1"
      },
    • "customer": {
      • "key": "22",
      • "id": "CAR",
      • "name": "Berkeley Technology Inc",
      • "href": "/objects/accounts-receivable/customer/22"
      },
    • "baseCurrency": "USD",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2024-08-08",
      • "rate": "1.0000000000"
      },
    • "subtotalInTxnCurrency": "11001.32000000000000",
    • "totalInTxnCurrency": "11611.21000000000000",
    • "state": "active",
    • "audit": {
      • "createdDateTime": "2024-08-08T09:19:34Z",
      • "modifiedDateTime": "2024-08-08T10:46:15Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "lines": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "subtotals": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a recurring document
patch/objects/order-entry/recurring-document::{documentName}/{key}
Updates an existing recurring document by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
key
required
string
System-assigned key for the order entry recurring document.


 
 Example:  99
Request Body schema: application/json
state
string
 Default:  "active"
State of the Order Entry recurring document.


 Enum: "active" "ended" "inactive"  
 Example:  "active"
object
Contacts associated with the Order Entry recurring document.


 
object
Primary contact


 
id
string
Identifier for the primary contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
Ship-to contact.


 
id
string
Identifier for the ship-to contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
Bill-to contact.


 
id
string
Identifier for the bill-to contact.


 
 Example:  "Power Aerospace Materials(C1)"
object
Shipping method for the document.


 
key
string
System-assigned key for the shipping method.


 
 Example:  "77"
id
string
Identifier for the shipping method.


 
 Example:  "Air"
href
string
URL for the shipping method.


 
 Example:  "/objects/accounts-receivable/shipping-method/77"
referenceNumber
string
Reference number for the Order Entry recurring document.


 
 Example:  "SALES-100"
contractId
string
Sales contract ID associated with the transaction.


 
 Example:  "CN100123"
contractDescription
string
Sales contract description.


 
 Example:  "Sales & Service"
baseCurrency
string
Base currency for the transaction.


 
 Example:  "USD"
txnCurrency
string
Currency used for the transaction.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2021-01-23"
rate
string <decimal-precision-10> 
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1.0789"
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
typeName
string
The name of exchange rate type.


 
 Example:  "Intacct Daily Rate"
object
Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices.


 
key
string
System-assigned key for the AR term.


 
 Example:  "75"
id
string
The name of AR term.


 
 Example:  "10 Days"
notes
string
Notes about the Order Entry document.


 
 Example:  "Fast order"
memo
string
Text printed on the Order Entry document.


 
 Example:  "Lowry solutions"
customerPONumber
string
Customer PO number associated with the transaction.


 
 Example:  "ABOTT-1001"
object
Customer associated with the Order Entry recurring document.


 
key
string
System-assigned key for the customer.


 
 Example:  "15"
id
string
Customer ID


 
 Example:  "CR1001"
name
string
Customer Name


 
 Example:  "Berkeley Technology Inc"
object
Defines the scheduling details for the Order Entry recurring document, including start date, frequency, next execution date, and end conditions. The schedule provides a comprehensive view of when and how often the recurring document will be generated.


 
startDate
string <date> 
Specifies the initial date for generating the recurring document. It remains editable until the first document is processed.


 
 Example:  "2021-01-01"
endDate
string <date> 
End date for the scheduled execution of the recurring document.


 
 Example:  "2022-01-01"
recurringDueDate
string <date> 
Due date for the scheduled execution of the recurring document.


 
 Example:  "2021-06-01"
frequency
string or null
 Default:  null
The frequency at which the document recurs. This interacts with the repeat interval.


 Enum: "days" "endOfMonth" "months" "none" null "weeks" "years"  
 Example:  "days"
repeatCount
string
The number of times the recurring document is set to repeat.


 
 Example:  "10"
repeatBy
string or null
 Default:  null
Specifies the regular interval at which the recurring document should repeat. This setting works in conjunction with the repeatInterval field, where you specify the number of intervals. For example, if you set repeatBy to months and set the repeatInterval to 3, the schedule will run every 3 months.


 Enum: "days" "endOfMonth" "months" "none" null "weeks" "years"  
 Example:  "days"
repeatInterval
string
 Default:  "1"
The interval at which the document repeats, based on the scheduler.


 
 Example:  "1"
object
Transaction definition that is associated with this recurring transaction.


 
key
string
System-assigned key for the transaction definition.


 
 Example:  "11"
id
string
Name for the Order Entry transaction definition.


 
 Example:  "Sales Invoice"
Array of objects
Lines of the Order Entry recurring document.


 
 Array 
object
Item associated with the recurring document line.


 
memo
string
Memo about the document line item.


 
 Example:  "Payment ACH"
unit
string
Unit associated with this document line item.


 
 Example:  "Each"
unitQuantity
string <decimal-precision-10> 
Unit quantity associated with this document line item.


 
 Example:  "10.10"
unitPrice
string <decimal-precision-10> 
Unit price associated with this line item.


 
 Example:  "10.50"
object
 
discountPercent
string <decimal-precision-10> 
Discount percentage for the document line item.


 
 Example:  "10.50"
discountMemo
string
Discount memo for any discounts taken.


 
 Example:  "Festival discount"
revenueRecognitionStartDate
string <date> 
The date on which the either revenue recognition schedule and/or renewal schedule get started.


 
 Example:  "2023-04-04"
revenueRecognitionEndDate
string <date> 
The date on which the either revenue recognition schedule and/or renewal schedule ends.


 
 Example:  "2023-04-04"
isPriceProrated
boolean
 Default:  true
Indicates whether the price is prorated.


 
 Example:  true
isBillable
boolean
 Default:  true
Indicates whether the line is billable.


 
 Example:  true
enableTax
boolean
 Default:  false
Indicates whether the line item is taxable.


 
 Example:  false
conversionType
string
 Default:  "quantity"
Conversion type used for the transaction.


 Enum: "price" "quantity"  
 Example:  "quantity"
object
Alternative name for the Item for a specific customer.


 
recurringStatus
string
 Default:  "active"
Status.


 Enum: "active" "ended" "inactive"  
 Example:  "active"
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"
object
Header lever details for the document line items.


 
Array of objects
Lines of the Order Entry recurring document subtotal.


 
 Array 
description
string
Description about the subtotal.


 
 Example:  "Tax"
absoluteValue
string <decimal-precision-2> 
Non negative base amount calculated across all other lines of the document.


 
 Example:  "40.50"
percentValue
string <decimal-precision-10> 
Percentage value that is calculated on the total of all line items of the recurring document.


 
 Example:  "10.50"
txnAbsoluteValue
string <decimal-precision-2> 
Non negative transaction amount calculated across all other lines of the recurring document.


 
 Example:  "44.78"
object
 
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"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "value": {
    • "referenceNumber": "1012",
    • "lines": [
      • {
        },
      • {
        }
      ]
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "52",
    • "id": "52",
    • "documentType": "Sales Invoice",
    • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/52"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a recurring document
delete/objects/order-entry/recurring-document::{documentName}/{key}
Deletes a recurring document.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
key
required
string
System-assigned key for the order entry recurring document.


 
 Example:  99
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 recurring documents
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:  "order-entry/recurring-document"
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 has (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 result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "order-entry/recurring-document",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "id",
    • "href",
    • "status",
    • "customer.id",
    • "totalInTxnCurrency"
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "6",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/6",
      • "status": "active",
      • "customer.id": "MI",
      • "totalInTxnCurrency": "7200.00000000000000"
      },
    • {
      • "id": "7",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/7",
      • "status": "active",
      • "customer.id": "BigSmalls",
      • "totalInTxnCurrency": "1800.00000000000000"
      },
    • {
      • "id": "9",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/9",
      • "status": "active",
      • "customer.id": "WestSnack",
      • "totalInTxnCurrency": "2100.00000000000000"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}