Document lines

Line items in an Order Entry document represent Order Entry transactions.

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.

Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Order Entry documents







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the Order Entry document line.


 
 Example:  19
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": "6",
      • "id": "6",
      • "href": "/objects/inventory-control/item/6"
      },
    • "unit": "Each",
    • "quantity": "10",
    • "quantityConverted": "1",
    • "retailPrice": "222",
    • "price": "333",
    • "audit": {
      • "createdDateTime": "2024-12-18T00:00:00Z",
      • "modifiedDateTime": "2024-12-18T10:27:15Z",
      • "createdBy": "5",
      • "modifiedBy": "5"
      },
    • "status": "active",
    • "unitQuantity": "1",
    • "multiplier": 1,
    • "unitPrice": "333",
    • "txnCurrency": "USD",
    • "baseCurrency": "USD",
    • "priceInTxnCurrency": "333",
    • "conversionType": "quantity",
    • "allowDropship": false,
    • "allowBuyToOrder": false,
    • "quantityRemaining": "10",
    • "trackingDetail": [ ],
    • "lineSubtotals": [ ],
    • "href": "/objects/order-entry/document-line::Sales%20Order/925"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
List lines for named documents
get/objects/order-entry/document-line::{documentName}
Returns a collection with a key, ID, and link for each line that exists in documents with the specified name. For example, to list all lines within documents that are based on the Sales Invoice transaction definition, specify Sales Invoice as the documentName in the request URL.


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



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
 Example:  Sales Invoice
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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Add Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
 Example:  Sales Invoice
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
Unique key for the item.


 
 Example:  "10"
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"
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
This field is only applicable if for companies subscribed to Contracts. This field displays the Multiplier value from the contract line. Defaults to 1 if no Multiplier was used on the contract line.


 
 Example:  1
object
Source Order Entry document.


 
key
string
Unique 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
Source document line that needs to be converted.


 
key
string
Unique 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 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
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 revenue recognition schedule and/or renewal schedule get started.


 
 Example:  "2023-04-04"
revenueRecognitionEndDate
string <date> 
The date on which the 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 drop-ship 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.


 
 Example:  "10"
quantity
string
Revised quantity.


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


 
unitQuantity
string
Draft unit quantity change.


 
 Example:  "10"
quantity
string
Draft quantity change.


 
 Example:  "10"
price
string <decimal-precision-10> 
Draft price change.


 
 Example:  "20.00"
object
Line-level posted details post change order. (Construction subscription)


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


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


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


 
externalReferenceNumber
string
Project contract line external reference number.


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


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


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


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


 
 Example:  "500.00"
storedMaterialsAmount
string <decimal-precision-10> 
Stored materials amount.


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


 
percentage
string <decimal-precision-2> 
Retainage percentage.


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


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


 
 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.


 
 Example:  "1000.00"
isReverseConversion
boolean
 Default:  false
Indicates whether the document line is reverse converted.


 
 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
Unique key for the Order Entry document.


 
 Example:  "5151"
id
string or null
Name or other unique ID for the Order Entry document.


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


 
key
string or null
Unique key for the document line.


 
 Example:  "13965"
id
string or null
Name or other unique ID for the for the document line.


 
 Example:  "13965"
object
Reference to the project contract. (Construction subscription)


 
key
string
Unique key for the project contract.


 
 Example:  "1"
id
string
Unique ID for the project contract.


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


 
key
string
Unique key for the project contract line.


 
 Example:  "4"
id
string
Unique ID for the project contract line.


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


 
key
string
Unique key for the tax schedule.


 
 Example:  "19"
id
string
Unique ID of the tax schedule.


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


 
id
string
ID 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
Unique key for the document.


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


 
 Example:  "Sales Invoice-SO0066"
Array of objects
Lines of the Order Entry document line subtotal.


 
 Array 
absoluteValue
string <decimal-precision-8> 
A non-negative base amount for the document subtotal line.


 
 Example:  "100.00"
txnAbsoluteValue
string <decimal-precision-8> 
A non-negative amount for the subtotal line.


 
 Example:  "100.00"
enableOverrideTax
boolean
 Default:  false
Enabling this field allows the user to override both tax detail (taxDetail) and the tax value (txnAbsoluteValue).


 
 Example:  false
object
Tax details describe a specific type of tax that applies to document lines.


 
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
{
  • "documentHeader": {
    • "key": "469"
    },
  • "dimensions": {
    • "item": {
      • "id": "1"
      },
    • "warehouse": {
      • "id": "42'"
      },
    • "location": {
      • "id": "5"
      }
    },
  • "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 line in a named document
get/objects/order-entry/document-line::{documentName}/{key}
Returns detailed information for a specified document line. For example, to get a line within a document that is based on the Sales Invoice transaction definition, specify Sales Invoice for the documentName in the request URL.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
 Example:  Sales Invoice
key
required
string
System-assigned key for the Order Entry document line.


 
 Example:  63
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": 1,
    • "dimensions": {
      • "item": {
        },
      • "warehouse": {
        },
      • "location": {
        },
      • "customer": {
        }
      },
    • "item": {
      • "key": "11",
      • "id": "11",
      • "href": "/objects/inventory-control/item/11"
      },
    • "unit": "Each",
    • "quantity": "1",
    • "quantityConverted": "1",
    • "retailPrice": "222",
    • "price": "333",
    • "audit": {
      • "createdDateTime": "2024-12-18T00:00:00Z",
      • "modifiedDateTime": "2024-12-18T10:27:15Z",
      • "createdBy": "4",
      • "modifiedBy": "4"
      },
    • "status": "active",
    • "unitQuantity": "1",
    • "multiplier": 1,
    • "unitPrice": "333",
    • "txnCurrency": "USD",
    • "baseCurrency": "USD",
    • "priceInTxnCurrency": "333",
    • "conversionType": "quantity",
    • "allowDropship": false,
    • "allowBuyToOrder": false,
    • "quantityRemaining": "16",
    • "trackingDetail": [ ],
    • "lineSubtotals": [ ],
    • "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 document line by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Edit Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
 Example:  Sales Invoice
key
required
string
System-assigned key for the Order Entry document line.


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


 
key
string
Unique key for the item.


 
 Example:  "10"
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"
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
This field is only applicable if for companies subscribed to Contracts. This field displays the Multiplier value from the contract line. Defaults to 1 if no Multiplier was used on the contract line.


 
 Example:  1
object
Source Order Entry document.


 
key
string
Unique 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
Source document line that needs to be converted.


 
key
string
Unique 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 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
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 revenue recognition schedule and/or renewal schedule get started.


 
 Example:  "2023-04-04"
revenueRecognitionEndDate
string <date> 
The date on which the 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 drop-ship 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.


 
 Example:  "10"
quantity
string
Revised quantity.


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


 
unitQuantity
string
Draft unit quantity change.


 
 Example:  "10"
quantity
string
Draft quantity change.


 
 Example:  "10"
price
string <decimal-precision-10> 
Draft price change.


 
 Example:  "20.00"
object
Line-level posted details post change order. (Construction subscription)


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


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


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


 
externalReferenceNumber
string
Project contract line external reference number.


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


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


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


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


 
 Example:  "500.00"
storedMaterialsAmount
string <decimal-precision-10> 
Stored materials amount.


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


 
percentage
string <decimal-precision-2> 
Retainage percentage.


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


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


 
 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.


 
 Example:  "1000.00"
isReverseConversion
boolean
 Default:  false
Indicates whether the document line is reverse converted.


 
 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
Unique key for the Order Entry document.


 
 Example:  "5151"
id
string or null
Name or other unique ID for the Order Entry document.


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


 
key
string or null
Unique key for the document line.


 
 Example:  "13965"
id
string or null
Name or other unique ID for the for the document line.


 
 Example:  "13965"
object
Reference to the project contract. (Construction subscription)


 
key
string
Unique key for the project contract.


 
 Example:  "1"
id
string
Unique ID for the project contract.


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


 
key
string
Unique key for the project contract line.


 
 Example:  "4"
id
string
Unique ID for the project contract line.


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


 
key
string
Unique key for the tax schedule.


 
 Example:  "19"
id
string
Unique ID of the tax schedule.


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


 
id
string
ID 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
Unique key for the document.


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


 
 Example:  "Sales Invoice-SO0066"
Array of objects
Lines of the Order Entry document line subtotal.


 
 Array 
absoluteValue
string <decimal-precision-8> 
A non-negative base amount for the document subtotal line.


 
 Example:  "100.00"
txnAbsoluteValue
string <decimal-precision-8> 
A non-negative amount for the subtotal line.


 
 Example:  "100.00"
enableOverrideTax
boolean
 Default:  false
Enabling this field allows the user to override both tax detail (taxDetail) and the tax value (txnAbsoluteValue).


 
 Example:  false
object
Tax details describe a specific type of tax that applies to document lines.


 
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
{
  • "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 a document line.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Delete Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
 Example:  Sales Invoice
key
required
string
System-assigned key for the Order Entry document line.


 
 Example:  63
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
Use the query service to find document lines that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}