Line items in a purchasing document represent purchasing transactions.
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.
OK
Bad Request
{- "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
}
}
Returns detailed information for a specified purchasing document line.
key required | string System-assigned key for the purchasing document line. |
OK
Bad Request
{- "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": {
- "key": "15",
- "id": "Car_Battery",
- "name": "Battery for Car",
- "href": "/objects/inventory-control/item/15"
}, - "warehouse": {
- "id": "WareHouse10004",
- "key": "4",
- "href": "/objects/inventory-control/warehouse/4"
}, - "location": {
- "id": "1",
- "key": "6",
- "href": "/objects/company-config/location/6"
}
}, - "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": [ ],
- "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/43"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns a collection with a key, ID, and link for each named purchasing 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.
documentName required | string Document Name |
OK
Bad Request
{- "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
}
}
Creates a new purchasing document line.
documentName required | string Document Name |
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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Example: "active" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parent/Source document | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parent/Source document line that needs to be converted. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Example: "quantity" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Example: "{ \"item\": { \"id\": \"1\" }, \"warehouse\": { \"id\": \"1\" }, \"location\": { \"id\": \"1\" }}" | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 confirmed Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Transaction allocation template for the line item, which distributes the amount across specified dimensions. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects List of warehouse inventory details including serial number, aisle, bin, and row per item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Header lever details for the document line items. Example: "22" | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Created
Bad Request
{- "documentHeader": {
- "key": "356"
}, - "dimensions": {
- "item": {
- "id": "1"
}, - "warehouse": {
- "id": "1"
}, - "location": {
- "id": "1"
}
}, - "unit": "Each",
- "unitQuantity": "1",
- "unitPrice": "650"
}
{- "ia::result": {
- "key": "61",
- "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/61"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified purchasing document line.
documentName required | string Document Name |
key required | string System-assigned unique key for the document line. |
OK
Bad Request
{- "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": {
- "key": "15",
- "id": "Car_Battery",
- "name": "Battery for Car",
- "href": "/objects/inventory-control/item/15"
}, - "warehouse": {
- "id": "WareHouse10004",
- "key": "4",
- "href": "/objects/inventory-control/warehouse/4"
}, - "location": {
- "id": "1",
- "key": "6",
- "href": "/objects/company-config/location/6"
}
}, - "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": [ ],
- "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/43"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing purchasing document line by setting field values. Any fields not provided remain unchanged.
documentName required | string Document Name |
key required | string System-assigned unique key for the document line. |
object Item associated with the document line. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Example: "active" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parent/Source document | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parent/Source document line that needs to be converted. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Example: "quantity" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 confirmed Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Transaction allocation template for the line item, which distributes the amount across specified dimensions. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects List of warehouse inventory details including serial number, aisle, bin, and row per item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Header lever details for the document line items. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OK
Bad Request
{- "unitQuantity": "10"
}
{- "ia::result": {
- "key": "61",
- "href": "/objects/purchasing/document-line::PO%20Receiver%20Invoice/61"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a purchasing document line.
documentName required | string Document Name |
key required | string System-assigned unique key for the document line. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "purchasing/document-line" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
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 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "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
}
}