Document lines

Line items in a purchasing document represent purchasing transactions.

List document lines

get/objects/purchasing/document-line

Returns a collection with a key, ID, and link for each 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": "43",
      • "id": "43",
      • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/43"
      },
    • {
      • "key": "46",
      • "id": "46",
      • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/46"
      },
    • {
      • "key": "52",
      • "id": "52",
      • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/52"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a document line
get/objects/purchasing/document-line/{key}
Returns detailed information for a specified purchasing 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 key for the purchasing document line.


 
 Example:  52
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "43",
    • "key": "43",
    • "documentHeader": {
      • "key": "66",
      • "id": "PO Receiver Invoice-Po-0201-Rec",
      • "documentType": "PO Receiver Invoice",
      • "href": "/objects/purchasing/document::PO%20Receiver%20Invoice/66"
      },
    • "documentType": "PO Receiver Invoice",
    • "lineNumber": 0,
    • "dimensions": {
      • "item": {
        },
      • "warehouse": {
        },
      • "location": {
        }
      },
    • "item": {
      • "key": "15",
      • "id": "Car_Battery",
      • "href": "/objects/inventory-control/item/15"
      },
    • "unit": "10 Pack",
    • "quantity": "1.0000000000",
    • "quantityConverted": "1.0000000000",
    • "retailPrice": "0.0000000000",
    • "price": "100.0000000000",
    • "audit": {
      • "createdDateTime": "2024-05-22T00:00:00Z",
      • "modifiedDateTime": "2024-05-27T06:31:46Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "status": "active",
    • "costMethod": "standard",
    • "unitQuantity": "1.0000000000",
    • "multiplier": 1,
    • "unitPrice": "100.0000000000",
    • "txnCurrency": "USD",
    • "baseCurrency": "USD",
    • "priceInTxnCurrency": "100.0000000000",
    • "priceConverted": "0.0000000000",
    • "conversionType": "quantity",
    • "quantityRemaining": "0.0000000000",
    • "trackingDetail": [ ],
    • "lineSubtotals": [ ],
    • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/43"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
List lines for named documents
get/objects/purchasing/document-line::{documentName}
Returns a collection with a key, ID, and link for each line that exists in purchasing documents with the specified name. For example, to list all lines within documents that are based on the Purchase Order transaction definition, specify Purchase Order 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



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Purchasing documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "43",
      • "id": "43",
      • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/43"
      },
    • {
      • "key": "46",
      • "id": "46",
      • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/46"
      },
    • {
      • "key": "52",
      • "id": "52",
      • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/52"
      }
    ],
  • "ia::meta": {
    • "totalCount": 13,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a document line
post/objects/purchasing/document-line::{documentName}
Creates a new purchasing document line.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Add Purchasing documents







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
Unique key for the item.


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


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


 
 Example:  "Payment ACH"
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
Source purchasing document.


 
key
string
Unique key for the purchasing document.


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


 
 Example:  "Purchase Order-PO0022"
object
Source document line that needs to be converted.


 
key
string
Unique key for the purchasing document line item.


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


 
 Example:  "2234"
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:  "Arizona"
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"
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"
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"
deliveryDueDate
string <date> 
Promised by date


 
 Example:  "2023-04-04"
orderConfirmationDate
string <date> 
Date the order was confirmed.


 
 Example:  "2023-04-04"
object
Transaction allocation template for the line item, which distributes the amount across specified dimensions.


 
key
string or null
Unique key for the allocation.


 
 Example:  "14"
id
string or null
ID for the allocation.


 
 Example:  "Alloc1-WBS-US"
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 item.


 
 Example:  "22"
key
required
string
Unique key for the purchasing document.


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


 
 Example:  "Purchase Invoice-PO0066"
Array of objects
Lines of the purchasing 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": "356"
    },
  • "dimensions": {
    • "item": {
      • "id": "1"
      },
    • "warehouse": {
      • "id": "42"
      },
    • "location": {
      • "id": "5"
      }
    },
  • "unit": "Each",
  • "unitQuantity": "1",
  • "unitPrice": "650"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "61",
    • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/61"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a line in a named document
get/objects/purchasing/document-line::{documentName}/{key}
Returns detailed information for a specified purchasing document line. For example, to get a line within a document that is based on the PO Receiver Invoice transaction definition, specify PO Receiver Invoice for the documentName in the request URL.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Purchasing documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
key
required
string
System-assigned unique key for the document line.


 
 Example:  52
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "43",
    • "key": "43",
    • "documentHeader": {
      • "key": "66",
      • "id": "PO Receiver Invoice-Po-0201-Rec",
      • "documentType": "PO Receiver Invoice",
      • "href": "/objects/purchasing/document::PO%20Receiver%20Invoice/66"
      },
    • "documentType": "PO Receiver Invoice",
    • "lineNumber": 0,
    • "dimensions": {
      • "item": {
        },
      • "warehouse": {
        },
      • "location": {
        }
      },
    • "item": {
      • "key": "15",
      • "id": "Car_Battery",
      • "href": "/objects/inventory-control/item/15"
      },
    • "unit": "10 Pack",
    • "quantity": "1.0000000000",
    • "quantityConverted": "1.0000000000",
    • "retailPrice": "0.0000000000",
    • "price": "100.0000000000",
    • "audit": {
      • "createdDateTime": "2024-05-22T00:00:00Z",
      • "modifiedDateTime": "2024-05-27T06:31:46Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "status": "active",
    • "costMethod": "standard",
    • "unitQuantity": "1.0000000000",
    • "multiplier": 1,
    • "unitPrice": "100.0000000000",
    • "txnCurrency": "USD",
    • "baseCurrency": "USD",
    • "priceInTxnCurrency": "100.0000000000",
    • "priceConverted": "0.0000000000",
    • "conversionType": "quantity",
    • "quantityRemaining": "0.0000000000",
    • "trackingDetail": [ ],
    • "lineSubtotals": [ ],
    • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/43"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a document line
patch/objects/purchasing/document-line::{documentName}/{key}
Updates an existing purchasing document line by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Edit Purchasing documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
key
required
string
System-assigned unique key for the document line.


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


 
key
string
Unique key for the item.


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


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


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


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


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


 
 Example:  "10.50"
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
Source purchasing document.


 
key
string
Unique key for the purchasing document.


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


 
 Example:  "Purchase Order-PO0022"
object
Source document line that needs to be converted.


 
key
string
Unique key for the purchasing document line item.


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


 
 Example:  "2234"
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:  "Arizona"
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"
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"
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"
deliveryDueDate
string <date> 
Promised by date


 
 Example:  "2023-04-04"
orderConfirmationDate
string <date> 
Date the order was confirmed.


 
 Example:  "2023-04-04"
object
Transaction allocation template for the line item, which distributes the amount across specified dimensions.


 
key
string or null
Unique key for the allocation.


 
 Example:  "14"
id
string or null
ID for the allocation.


 
 Example:  "Alloc1-WBS-US"
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 item.


 
key
string
Unique key for the purchasing document.


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


 
 Example:  "Purchase Invoice-PO0066"
Array of objects
Lines of the purchasing 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": "61",
    • "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/61"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a document line
delete/objects/purchasing/document-line::{documentName}/{key}
Deletes a purchasing document line.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Delete Purchasing documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
key
required
string
System-assigned unique key for the document line.


 
 Example:  52
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


Request samples