Recurring document lines

Line items in a recurring document represent recurring transactions.

List recurring document lines

get/objects/order-entry/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 the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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:  "6"
id
string or null
Warehouse ID


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


 
key
string or null
Location key


 
 Example:  "22"
id
string or null
Location ID


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


 
id
string or null
Department ID


 
 Example:  "Sales"
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"
revenueRecognitionStartDate
string <date> 
The date on which either the revenue recognition schedule and/or the renewal schedule are started.


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


 
 Example:  "2023-04-04"
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 customer.


 
key
string
Unique key for the item alias.


 
 Example:  "10"
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:  "22"
key
required
string
Unique key for the recurring document.


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


 
 Example:  "55"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "recurringDocumentHeader": {
    • "key": "469"
    },
  • "dimensions": {
    • "item": {
      • "id": "1"
      },
    • "warehouse": {
      • "id": "1"
      },
    • "location": {
      • "id": "1"
      }
    },
  • "unit": "Each",
  • "unitQuantity": "1",
  • "unitPrice": "650"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "807",
    • "href": "/objects/order-entry/recurring-document-line::Sales%20Invoice/807"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a recurring document line
get/objects/order-entry/recurring-document-line/{key}
Returns detailed information for a specified recurring document line.


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


 
 Example:  807
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "735",
    • "key": "735",
    • "recurringDocumentHeader": {
      • "id": "6",
      • "key": "6",
      • "documentType": "Sales Invoice",
      • "href": "/objects/order-entry/recurring-document::Sales%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",
    • "revenueRecognitionStartDate": null,
    • "revenueRecognitionEndDate": null,
    • "isPriceProrated": null,
    • "retailPrice": "0.0000000000",
    • "discountMemo": null,
    • "currency": "USD",
    • "priceInTxnCurrency": "1000.1200000000",
    • "discountPercent": null,
    • "isBillable": null,
    • "conversionType": "quantity",
    • "enableTax": false,
    • "href": "/objects/order-entry/recurring-document-line/735"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a recurring document line
delete/objects/order-entry/recurring-document-line/{key}
Deletes a recurring document line.


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


 
 Example:  807
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
    }
}