Recurring document lines

Line items in a recurring document represent recurring transactions.

List recurring document lines

get/objects/purchasing/recurring-document-line

Returns a collection with a key, ID, and link for each recurring document line. 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
SubscriptionPurchasing
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Purchasing documents
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "19",
      • "id": "19",
      • "href": "/objects/purchasing/recurring-document-line/19"
      },
    • {
      • "key": "24",
      • "id": "24",
      • "href": "/objects/purchasing/recurring-document-line/24"
      },
    • {
      • "key": "25",
      • "id": "25",
      • "href": "/objects/purchasing/recurring-document-line/25"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a recurring document line
post/objects/purchasing/recurring-document-line
Creates a new recurring document line.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Add Purchasing documents







SecurityOAuth2 
Request 
Request Body schema: application/json
required
unit
required
string
Unit of measure associated with the recurring document line item.


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


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


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


 
key
string
Unique key for the item.


 
 Example:  "10"
memo
string
Memo about the recurring document line item.


 
 Example:  "Payment ACH"
object
 
 Example:  "{ \"item\": { \"id\": \"1\" }, \"warehouse\": { \"id\": \"1\" }, \"location\": { \"id\": \"1\" }}"
required
object
 
key
string or null
Item key


 
 Example:  "13"
id
string or null
Item ID


 
 Example:  "Case 13"
required
object
Warehouse associated with the recurring document line.


 
key
string or null
Warehouse key


 
 Example:  "19'"
id
string or null
Warehouse ID


 
 Example:  "WareHouse10004"
required
object
Location associated with the recurring document line.


 
key
string or null
Location key


 
 Example:  "22"
id
string or null
Location ID


 
 Example:  "India"
object
Department associated with the recurring document line.


 
id
string or null
Department ID


 
 Example:  "Accounting"
object
 
key
string or null
Employee key


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
 
key
string or null
Project key


 
 Example:  "2"
id
string or null
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string or null
Customer key


 
 Example:  "13"
id
string or null
Customer ID


 
 Example:  "CUST-13"
object
 
key
string or null
Vendor key


 
 Example:  "357"
id
string or null
Vendor ID


 
 Example:  "1605212096809"
object
 
key
string or null
Class key


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string or null
Task ID


 
 Example:  "1"
key
string or null
Task key


 
 Example:  "1"
object
 
id
string or null
Cost Type ID


 
 Example:  "2"
key
string or null
Cost Type key


 
 Example:  "2"
object
 
id
string or null
Asset ID


 
 Example:  "A001"
key
string or null
Asset key


 
 Example:  "1"
object
 
id
string or null
Contract ID


 
 Example:  "CON-0045-1"
key
string or null
Contract key


 
 Example:  "12"
object
 
key
string or null
Affiliate entity key


 
 Example:  "23"
id
string or null
Affiliate entity ID


 
 Example:  "AFF-23"
discountPercent
string <decimal-precision-10> 
Discount percentage to apply to the document line item.


 
 Example:  "10.50"
discountMemo
string
Memo about any discounts taken.


 
 Example:  "Festival discount"
isPriceProrated
boolean
 Default:  true
Indicates whether the line item price is prorated.


 
 Example:  true
isBillable
boolean
 Default:  true
Indicates whether the line item 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 vendor.


 
key
string
Unique key for the item alias.


 
 Example:  "18"
id
string
ID for the item alias.


 
 Example:  "IXN"
recurringStatus
string
 Default:  "active"
Recurrence status for the line item.


 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 item.


 
 Example:  "44"
key
required
string
Unique key for the recurring document.


 
 Example:  "55"
id
string
ID for the recurring document.


 
 Example:  "55"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "recurringDocumentHeader": {
    • "key": "469"
    },
  • "dimensions": {
    • "item": {
      • "id": "1357--Miscellaneous Services - Customization"
      },
    • "warehouse": {
      • "id": "WH10003"
      },
    • "location": {
      • "id": "1"
      }
    },
  • "unit": "Each",
  • "unitQuantity": "1",
  • "unitPrice": "650"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "112",
    • "href": "/objects/purchasing/recurring-document-line::Purchase%20Order/807"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a recurring document line
get/objects/purchasing/recurring-document-line/{key}
Returns detailed information for a specified recurring document line.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Purchasing documents







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


 
 Example:  19
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "735",
    • "key": "735",
    • "recurringDocumentHeader": {
      • "id": "6",
      • "key": "6",
      • "documentType": "Purchase Invoice",
      • "href": "/objects/purchasing/recurring-document::Purchase%20Invoice/6"
      },
    • "lineNumber": 1,
    • "item": {
      • "key": "15",
      • "id": "Car_Battery",
      • "href": "/objects/inventory-control/item/15"
      },
    • "dimensions": {
      • "item": {
        },
      • "warehouse": {
        },
      • "location": {
        },
      • "department": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "project": {
        },
      • "class": {
        }
      },
    • "itemAlias": {
      • "key": null,
      • "id": null
      },
    • "unit": "10 Pack",
    • "memo": null,
    • "status": "inactive",
    • "recurringStatus": "active",
    • "unitQuantity": "10.0000000000",
    • "unitPrice": "1000.1200000000",
    • "isPriceProrated": null,
    • "retailPrice": "0.0000000000",
    • "discountMemo": null,
    • "currency": "USD",
    • "priceInTxnCurrency": "1000.1200000000",
    • "discountPercent": null,
    • "isBillable": null,
    • "conversionType": "quantity",
    • "enableTax": false,
    • "href": "/objects/purchasing/recurring-document-line/735"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a recurring document line
delete/objects/purchasing/recurring-document-line/{key}
Deletes a recurring document line.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Delete Purchasing documents







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


 
 Example:  19
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 document lines
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:  "purchasing/recurring-document-line"
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": "purchasing/recurring-document-line",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "id",
    • "href",
    • "lineNumber",
    • "recurringDocumentHeader.key",
    • "item.id"
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "9",
      • "href": "/objects/purchasing/recurring-document-line/9",
      • "lineNumber": "1",
      • "recurringDocumentHeader.key": "3",
      • "item.id": "S2-Widget"
      },
    • {
      • "id": "13",
      • "href": "/objects/purchasing/recurring-document-line/13",
      • "lineNumber": "5",
      • "recurringDocumentHeader.key": "1",
      • "item.id": "S3-Widget"
      },
    • {
      • "id": "3",
      • "href": "/objects/purchasing/recurring-document-line/3",
      • "lineNumber": "3",
      • "recurringDocumentHeader.key": "2",
      • "item.id": "S2-Widget"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}