Document lines

Line items in an order entry document represent order entry transactions.

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 document lines

get/objects/order-entry/document-line

Returns a collection with a key, ID, and link for each order entry 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.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "19",
      • "id": "19",
      • "href": "/objects/order-entry/document-line::Sales%20Invoice/19"
      },
    • {
      • "key": "24",
      • "id": "24",
      • "href": "/objects/order-entry/document-line::Sales%20Invoice/24"
      },
    • {
      • "key": "25",
      • "id": "25",
      • "href": "/objects/order-entry/document-line::Sales%20Quote/25"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Get a document line
get/objects/order-entry/document-line/{key}
Returns detailed information for a specified order entry document line.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the order entry document line.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "925",
    • "key": "925",
    • "documentHeader": {
      • "key": "599",
      • "id": "Sales Order-SO0066",
      • "documentType": "Sales Order",
      • "href": "/objects/order-entry-document::Sales%20Order/599"
      },
    • "documentType": "Sales Order",
    • "lineNumber": 0,
    • "dimensions": {
      • "item": {
        },
      • "warehouse": {
        },
      • "location": {
        },
      • "customer": {
        }
      },
    • "item": {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/inventory-control/item/1"
      },
    • "unit": "Each",
    • "quantity": "10",
    • "quantityConverted": "1",
    • "retailPrice": "222",
    • "price": "333",
    • "audit": {
      • "createdDateTime": "2023-12-18T00:00:00Z",
      • "modifiedDateTime": "2023-12-18T10:27:15Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "status": "active",
    • "unitQuantity": "1",
    • "multiplier": 1,
    • "unitPrice": "333",
    • "txnCurrency": "USD",
    • "baseCurrency": "USD",
    • "priceInTxnCurrency": "333",
    • "conversionType": "quantity",
    • "allowDropship": false,
    • "allowBuyToOrder": false,
    • "quantityRemaining": "0",
    • "trackingDetail": [ ],
    • "href": "/objects/order-entry/document-line::Sales%20Order/925"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
List named document lines
get/objects/order-entry/document-line::{documentName}
Returns a collection with a key, ID, and link for each named order entry 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.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
Responses 
200
OK


400
Bad Request


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


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
Request Body schema: application/json
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 document line.


 
key
string
System-assigned key for the item.


 
 Example:  "10"
object
Alternative name for the Item for a specific customer.


 
key
string
System-assigned key for the item alias.


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


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


 
 Example:  "Payment ACH"
priceCalculationMemo
string
Memo about price calculation used for the document line item.


 
 Example:  "Fair value price list"
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"
discountPercent
string <decimal-precision-10> 
Discount percentage for the document line item.


 
 Example:  "10.50"
multiplier
number
Multiplier


 
 Example:  1
object
Parent/Source document


 
key
string
System-assigned key for the Order Entry document.


 
 Example:  "77"
id
string
The source transaction from which the Order Entry document was created.


 
 Example:  "Sales Order-SO0022"
object
Parent/Source document line that needs to be converted.


 
key
string
System-assigned key for the Order Entry document line item.


 
 Example:  "2234"
id
string
ID for the for the Order Entry document line item.


 
 Example:  "2234"
isPriceProrated
boolean
 Default:  true
Indicates whether the price is prorated.


 
 Example:  true
discountMemo
string
Discount memo for any discounts taken.


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


 
 Example:  true
taxRate
string <decimal-precision-2> 
Tax rate for the document line item.


 
 Example:  "10.05"
discount
string <decimal-precision-2> 
Discount applied to the line item.


 
 Example:  "10.25"
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
 
 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 document line.


 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


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


 
key
string or null
Location key


 
 Example:  "22"
id
string or null
Location


 
 Example:  "LOC-22"
object
A dimension that allows you to create a hierarchy of departments to reflect how your company is organized.


 
id
string or null
Department


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


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
Project associated with the document line.


 
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
Task associated with the document line.


 
id
string or null
Task ID


 
 Example:  "TSK01"
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"
object
The template used for renewal schedules.


 
key
string
The key of renewal template.


 
 Example:  "45"
id
string
The ID of renewal template.


 
 Example:  "Sales Renewal Template"
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"
requestedShippingDate
string <date> 
The date the customer requests the goods to arrive on their premises. The default is the due date.


 
 Example:  "2023-04-04"
shipByDate
string <date> 
The date the goods should be shipped so they arrive when the customer needs them.


 
 Example:  "2023-04-04"
pickTicketPrintedDate
string <date> 
The date on which the pick ticket is printed.


 
 Example:  "2023-04-04"
cancelAfterDate
string <date> 
Indicates the date after which the order can be canceled.


 
 Example:  "2023-04-04"
doNotShipBeforeDate
string <date> 
Do not ship before this date.


 
 Example:  "2023-04-04"
doNotShipAfterDate
string <date> 
Do not ship after this date.


 
 Example:  "2023-04-04"
shippedDate
string <date> 
The date that the order was shipped.


 
 Example:  "2023-04-04"
allowDropship
boolean
 Default:  false
Indicates whether dropship is allowed for the line.


 
 Example:  true
allowBuyToOrder
boolean
 Default:  false
Indicates whether buy-to-order is allowed for the line.


 
 Example:  true
object
Line-level revised details post Change Order (Construction subscription).


 
unitQuantity
string
Revised unit quantity (Construction subscription).


 
 Example:  "10"
quantity
string
Revised quantity (Construction subscription).


 
 Example:  "10"
object
Line-level draft details post Change Order (Construction subscription).


 
unitQuantity
string
Draft unit quantity change (Construction subscription).


 
 Example:  "10"
quantity
string
Draft quantity change (Construction subscription).


 
 Example:  "10"
price
string <decimal-precision-10> 
Draft change price (Construction subscription).


 
 Example:  "10.00"
object
Line-level posted details post Change Order (Construction subscription).


 
servicePeriodStartDate
string or null <date> 
Service period start date.


 
 Example:  "2022-04-01"
servicePeriodEndDate
string or null <date> 
Service period end date.


 
 Example:  "2022-04-30"
object
Line-level project contract billing details (Construction subscription).


 
externalReferenceNumber
string
Project contract line external reference (Construction subscription).


 
 Example:  "HGS-1024"
description
string  <= 4000 characters 
Project contract line description (Construction subscription).


 
 Example:  "Construction of clubhouse and offices"
contractLineValue
string <decimal-precision-10> 
Contract line value (Construction subscription).


 
 Example:  "1000.00"
priorApplicationAmount
string <decimal-precision-10> 
Amount from prior application (Construction subscription).


 
 Example:  "1000.00"
completedThisPeriodAmount
string <decimal-precision-10> 
Completed this period amount (Construction subscription).


 
 Example:  "1000.00"
storedMaterialsAmount
string <decimal-precision-10> 
Stored materials amount (Construction subscription).


 
 Example:  "1000.00"
object
Line-level retainage details (Construction subscription).


 
percentage
string <decimal-precision-2> 
Retainage percentage (Construction subscription).


 
 Example:  "10.00"
baseAmountRetained
string <decimal-precision-2> 
Base amount retained (Construction subscription).


 
 Example:  "10.00"
txnAmountRetained
string <decimal-precision-2> 
Transaction amount retained (Construction subscription).


 
 Example:  "10.00"
previousBalanceAmount
string <decimal-precision-10> 
Sum of all the pending retainage amounts from the project contract lines matching the previous invoices for the project contract (Construction subscription).


 
 Example:  "1000.00"
isReverseConversion
boolean
 Default:  false
Whether the entry is reverse converted (Construction subscription).


 
 Example:  false
object
Line-level reverse conversion details (Construction subscription).


 
object
Reference to the source transaction when creating a change order (Construction subscription).


 
key
string or null
System-assigned key for the Order Entry document (Construction subscription).


 
 Example:  "5151"
id
string or null
Name or other unique identifier for the Order Entry document (Construction subscription).


 
 Example:  "Sales Order-SD-SO0550"
object
Reference to the source transaction line when creating a change order (Construction subscription).


 
key
string or null
System-assigned key for the Order Entry document line (Construction subscription).


 
 Example:  "13965"
id
string or null
Name or other unique identifier for the for the Order Entry document line (Construction subscription).


 
 Example:  "1--Design"
object
Reference to the project contract (Construction subscription).


 
key
string
System-assigned key for the project contract (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the project contract (Construction subscription).


 
 Example:  "BTI-01"
object
Reference to the specific project contract line (Construction subscription).


 
key
string
System-assigned key for the project contract line (Construction subscription).


 
 Example:  "4"
id
string
Unique identifier for the project contract line (Construction subscription).


 
 Example:  "Project-Contract-Line-04"
object
In tax enabled companies tax schedule used to capture tax details in the sales transaction (Construction subscription).


 
key
string
System-assigned key for the tax schedule (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier of the tax schedule (Construction subscription).


 
 Example:  "Sale Goods Standard"
object
Contacts for delivering the buy-to-order.


 
id
string
Identifier for the contact.


 
 Example:  "contact"
Array of objects
List of warehouse inventory details including serial number, aisle, bin, and row per item.


 
 Array 
quantity
string <decimal-precision-10> 
The quantity of the units being built for the combination of the tracking attributes specified for the line.


 
 Example:  "10"
serialNumber
string
Serial number of the line item.


 
 Example:  "S1001"
lotNumber
string
The lot numbers for the units being built and the quantity being built for each lot.


 
 Example:  "L1001"
expirationDate
string <date> 
The expiration date for the units being built and the quantity being built.


 
 Example:  "2023-04-04"
object
Aisle associated with the line details.


 
object
The bin associated with the line details.


 
object
The row associated with the line details.


 
object
Item associated with the line details.


 
object
Header lever details for the document line items.


 
 Example:  "22"
key
required
string
System-assigned key for the order entry document.


 
 Example:  "55"
id
string
ID for the order entry document.


 
 Example:  "Sales Invoice-SO0066"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "documentHeader": {
    • "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/document-line::Sales%20Invoice/807"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a named document line
get/objects/order-entry/document-line::{documentName}/{key}
Returns detailed information for a specified order entry document line.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


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


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "925",
    • "key": "925",
    • "documentHeader": {
      • "key": "599",
      • "id": "Sales Order-SO0066",
      • "documentType": "Sales Order",
      • "href": "/objects/order-entry-document::Sales%20Order/599"
      },
    • "documentType": "Sales Order",
    • "lineNumber": 0,
    • "dimensions": {
      • "item": {
        },
      • "warehouse": {
        },
      • "location": {
        },
      • "customer": {
        }
      },
    • "item": {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/inventory-control/item/1"
      },
    • "unit": "Each",
    • "quantity": "1",
    • "quantityConverted": "1",
    • "retailPrice": "222",
    • "price": "333",
    • "audit": {
      • "createdDateTime": "2023-12-18T00:00:00Z",
      • "modifiedDateTime": "2023-12-18T10:27:15Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "status": "active",
    • "unitQuantity": "1",
    • "multiplier": 1,
    • "unitPrice": "333",
    • "txnCurrency": "USD",
    • "baseCurrency": "USD",
    • "priceInTxnCurrency": "333",
    • "conversionType": "quantity",
    • "allowDropship": false,
    • "allowBuyToOrder": false,
    • "quantityRemaining": "0",
    • "trackingDetail": [ ],
    • "href": "/objects/order-entry/document-line::Sales%20Order/925"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a document line
patch/objects/order-entry/document-line::{documentName}/{key}
Updates an existing order entry document line 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 document line.


 
Request Body schema: application/json
object
Item associated with the document line.


 
key
string
System-assigned key for the item.


 
 Example:  "10"
object
Alternative name for the Item for a specific customer.


 
key
string
System-assigned key for the item alias.


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


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


 
 Example:  "Payment ACH"
priceCalculationMemo
string
Memo about price calculation used for the document line item.


 
 Example:  "Fair value price list"
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"
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"
discountPercent
string <decimal-precision-10> 
Discount percentage for the document line item.


 
 Example:  "10.50"
multiplier
number
Multiplier


 
 Example:  1
object
Parent/Source document


 
key
string
System-assigned key for the Order Entry document.


 
 Example:  "77"
id
string
The source transaction from which the Order Entry document was created.


 
 Example:  "Sales Order-SO0022"
object
Parent/Source document line that needs to be converted.


 
key
string
System-assigned key for the Order Entry document line item.


 
 Example:  "2234"
id
string
ID for the for the Order Entry document line item.


 
 Example:  "2234"
isPriceProrated
boolean
 Default:  true
Indicates whether the price is prorated.


 
 Example:  true
discountMemo
string
Discount memo for any discounts taken.


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


 
 Example:  true
taxRate
string <decimal-precision-2> 
Tax rate for the document line item.


 
 Example:  "10.05"
discount
string <decimal-precision-2> 
Discount applied to the line item.


 
 Example:  "10.25"
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
 
object
Location associated with the document line.


 
key
string or null
Location key


 
 Example:  "22"
id
string or null
Location


 
 Example:  "LOC-22"
object
A dimension that allows you to create a hierarchy of departments to reflect how your company is organized.


 
id
string or null
Department


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


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
Project associated with the document line.


 
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
Item key


 
 Example:  "13"
id
string or null
Item ID


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


 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


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


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
Task associated with the document line.


 
id
string or null
Task ID


 
 Example:  "TSK01"
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"
object
The template used for renewal schedules.


 
key
string
The key of renewal template.


 
 Example:  "45"
id
string
The ID of renewal template.


 
 Example:  "Sales Renewal Template"
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"
requestedShippingDate
string <date> 
The date the customer requests the goods to arrive on their premises. The default is the due date.


 
 Example:  "2023-04-04"
shipByDate
string <date> 
The date the goods should be shipped so they arrive when the customer needs them.


 
 Example:  "2023-04-04"
pickTicketPrintedDate
string <date> 
The date on which the pick ticket is printed.


 
 Example:  "2023-04-04"
cancelAfterDate
string <date> 
Indicates the date after which the order can be canceled.


 
 Example:  "2023-04-04"
doNotShipBeforeDate
string <date> 
Do not ship before this date.


 
 Example:  "2023-04-04"
doNotShipAfterDate
string <date> 
Do not ship after this date.


 
 Example:  "2023-04-04"
shippedDate
string <date> 
The date that the order was shipped.


 
 Example:  "2023-04-04"
allowDropship
boolean
 Default:  false
Indicates whether dropship is allowed for the line.


 
 Example:  true
allowBuyToOrder
boolean
 Default:  false
Indicates whether buy-to-order is allowed for the line.


 
 Example:  true
object
Line-level revised details post Change Order (Construction subscription).


 
unitQuantity
string
Revised unit quantity (Construction subscription).


 
 Example:  "10"
quantity
string
Revised quantity (Construction subscription).


 
 Example:  "10"
object
Line-level draft details post Change Order (Construction subscription).


 
unitQuantity
string
Draft unit quantity change (Construction subscription).


 
 Example:  "10"
quantity
string
Draft quantity change (Construction subscription).


 
 Example:  "10"
price
string <decimal-precision-10> 
Draft change price (Construction subscription).


 
 Example:  "10.00"
object
Line-level posted details post Change Order (Construction subscription).


 
servicePeriodStartDate
string or null <date> 
Service period start date.


 
 Example:  "2022-04-01"
servicePeriodEndDate
string or null <date> 
Service period end date.


 
 Example:  "2022-04-30"
object
Line-level project contract billing details (Construction subscription).


 
externalReferenceNumber
string
Project contract line external reference (Construction subscription).


 
 Example:  "HGS-1024"
description
string  <= 4000 characters 
Project contract line description (Construction subscription).


 
 Example:  "Construction of clubhouse and offices"
contractLineValue
string <decimal-precision-10> 
Contract line value (Construction subscription).


 
 Example:  "1000.00"
priorApplicationAmount
string <decimal-precision-10> 
Amount from prior application (Construction subscription).


 
 Example:  "1000.00"
completedThisPeriodAmount
string <decimal-precision-10> 
Completed this period amount (Construction subscription).


 
 Example:  "1000.00"
storedMaterialsAmount
string <decimal-precision-10> 
Stored materials amount (Construction subscription).


 
 Example:  "1000.00"
object
Line-level retainage details (Construction subscription).


 
percentage
string <decimal-precision-2> 
Retainage percentage (Construction subscription).


 
 Example:  "10.00"
baseAmountRetained
string <decimal-precision-2> 
Base amount retained (Construction subscription).


 
 Example:  "10.00"
txnAmountRetained
string <decimal-precision-2> 
Transaction amount retained (Construction subscription).


 
 Example:  "10.00"
previousBalanceAmount
string <decimal-precision-10> 
Sum of all the pending retainage amounts from the project contract lines matching the previous invoices for the project contract (Construction subscription).


 
 Example:  "1000.00"
isReverseConversion
boolean
 Default:  false
Whether the entry is reverse converted (Construction subscription).


 
 Example:  false
object
Line-level reverse conversion details (Construction subscription).


 
object
Reference to the source transaction when creating a change order (Construction subscription).


 
key
string or null
System-assigned key for the Order Entry document (Construction subscription).


 
 Example:  "5151"
id
string or null
Name or other unique identifier for the Order Entry document (Construction subscription).


 
 Example:  "Sales Order-SD-SO0550"
object
Reference to the source transaction line when creating a change order (Construction subscription).


 
key
string or null
System-assigned key for the Order Entry document line (Construction subscription).


 
 Example:  "13965"
id
string or null
Name or other unique identifier for the for the Order Entry document line (Construction subscription).


 
 Example:  "1--Design"
object
Reference to the project contract (Construction subscription).


 
key
string
System-assigned key for the project contract (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the project contract (Construction subscription).


 
 Example:  "BTI-01"
object
Reference to the specific project contract line (Construction subscription).


 
key
string
System-assigned key for the project contract line (Construction subscription).


 
 Example:  "4"
id
string
Unique identifier for the project contract line (Construction subscription).


 
 Example:  "Project-Contract-Line-04"
object
In tax enabled companies tax schedule used to capture tax details in the sales transaction (Construction subscription).


 
key
string
System-assigned key for the tax schedule (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier of the tax schedule (Construction subscription).


 
 Example:  "Sale Goods Standard"
object
Contacts for delivering the buy-to-order.


 
id
string
Identifier for the contact.


 
 Example:  "contact"
Array of objects
List of warehouse inventory details including serial number, aisle, bin, and row per item.


 
 Array 
quantity
string <decimal-precision-10> 
The quantity of the units being built for the combination of the tracking attributes specified for the line.


 
 Example:  "10"
serialNumber
string
Serial number of the line item.


 
 Example:  "S1001"
lotNumber
string
The lot numbers for the units being built and the quantity being built for each lot.


 
 Example:  "L1001"
expirationDate
string <date> 
The expiration date for the units being built and the quantity being built.


 
 Example:  "2023-04-04"
object
Aisle associated with the line details.


 
object
The bin associated with the line details.


 
object
The row associated with the line details.


 
object
Item associated with the line details.


 
object
Header lever details for the document line items.


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


 
 Example:  "55"
id
string
ID for the order entry document.


 
 Example:  "Sales Invoice-SO0066"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "unitQuantity": "10"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "52",
    • "href": "/objects/order-entry/document-line::Sales%20Invoice/52"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a document line
delete/objects/order-entry/document-line::{documentName}/{key}
Deletes an order entry document line.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


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


 
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 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:  "order-entry/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 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
    }
}