Returns up to 100 object references from the collection with a key, ID, and link for each bill line. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "1",
- "href": "/objects/accounts-payable/bill-line/1"
}, - {
- "key": "3",
- "id": "3",
- "href": "/objects/accounts-payable/bill-line/3"
}, - {
- "key": "5",
- "id": "5",
- "href": "/objects/accounts-payable/bill-line/5"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100
}
}
Creates new bill lines
Line items for an Accounts Payable (AP) bill.
required | object Transaction allocation template for the line item, which distributes the bill amount across specified dimensions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
txnAmount required | string <decimal-precision-2> For multi-currency companies, provide a transaction amount, which is the amount in the transaction currency. Example: "100.00" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object Header level details for the bill's line entries. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object or object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of: General Ledger (GL) account associated with the line item.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
key | string System-assigned key for the line item. Example: "62" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hasForm1099 | string If the vendor is set up for 1099 tracking and enabled for 1009 flag override, you can set to Example: "false" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Form 1099 information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billNumber | string or null Vendor-assigned identifier for the bill. This is the vendor-assigned number provided on the bill. This number is unique and can be used to look up bill details. You must specify a bill number when creating a bill unless document sequencing is configured, in which case the number is auto-generated. Example: "Bill-001" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Vendor to which this bill is linked. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object An alternative account to override the default GL AP account for the bill. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object AP account label associated with the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalTxnAmount | string <decimal-precision-2> For tax inclusive bills, provide a total transaction amount. Example: "100.00" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
memo | string or null Memo about the line item. Example: "Service charges" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Currency details for the bill. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Payment information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
releaseToPay | boolean or null Default: false If Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Project-related information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Asset information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Purchasing document information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Tax Entries of the AP bill | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OK
Bad Request
{- "bill": {
- "key": "11579"
}, - "txnAmount": "2500",
- "totalTxnAmount": "2500",
- "glAccount": {
- "key": "254"
}, - "overrideOffsetGLAccount": {
- "key": "359"
}, - "accountLabel": {
- "key": "28"
}, - "dimensions": {
- "location": {
- "key": "1"
}, - "vendor": {
- "id": "209"
}, - "department": {
- "id": "77"
}, - "project": {
- "key": "27"
}, - "customer": {
- "id": "HC"
}, - "employee": {
- "id": "EMP1-US"
}, - "item": {
- "id": "GAMESUBKEY"
}, - "class": {
- "id": "3"
}, - "warehouse": {
- "id": "33"
}, - "task": {
- "id": "619"
}
}, - "baseLocation": {
- "key": "4"
}, - "hasForm1099": "true",
- "releaseToPay": true,
- "project": {
- "isBillable": true
}, - "form1099": {
- "type": "NEC",
- "box": "7"
}, - "fixedAsset": {
- "nameOfAcquiredAsset": "ergonomic chair",
- "includeTaxInAssetCost": false
}, - "memo": "server charges bill"
}
{- "ia::result": [
- {
- "key": "1",
- "id": "1",
- "href": "/objects/accounts-payable/bill-line/1"
}
], - "ia::meta": {
- "totalCount": 1,
- "start": 1,
- "pageSize": 100
}
}
Returns detailed information for a specified line item in a bill.
key required | string System-assigned unique key for the bill line. Example: 99 |
OK
Bad Request
{- "ia::result": {
- "id": "94",
- "key": "94",
- "bill": {
- "id": "18",
- "key": "18",
- "href": "/objects/accounts-payable/bill/18"
}, - "glAccount": {
- "key": "246",
- "id": "6000",
- "name": "G&A Salaries",
- "href": "/objects/general-ledger/account/246"
}, - "overrideOffsetGLAccount": {
- "key": "109",
- "id": "2000",
- "name": "Accounts Payable",
- "href": "/objects/general-ledger/account/109"
}, - "accountLabel": {
- "key": null,
- "id": null
}, - "createdDate": "2024-02-21",
- "baseAmount": "48550.00",
- "txnAmount": "48550.00",
- "dimensions": {
- "department": {
- "key": "9",
- "id": "11",
- "name": "Accounting",
- "href": "/objects/company-config/department/9"
}, - "location": {
- "key": "4",
- "id": "4",
- "name": "Australia",
- "href": "/objects/company-config/location/4"
}, - "project": {
- "key": "8",
- "id": "8",
- "name": "Client Services - Power Aerospace Materials",
- "href": "/objects/projects/project/8"
}, - "customer": {
- "key": "1",
- "id": "1",
- "name": "Power Aerospace Materials",
- "href": "/objects/accounts-receivable/customer/1"
}, - "vendor": {
- "key": "43",
- "id": "1099 Int",
- "name": "1099 Int",
- "href": "/objects/accounts-payable/vendor/43"
}, - "employee": {
- "key": "1",
- "id": "1",
- "name": "Reser",
- "href": "/objects/company-config/employee/1"
}, - "item": {
- "key": "1",
- "id": "1",
- "name": "PC Computer",
- "href": "/objects/inventory-control/item/1"
}, - "class": {
- "key": "1",
- "id": "3",
- "name": "Health Care",
- "href": "/objects/company-config/class/1"
}, - "warehouse": {
- "key": "2",
- "id": "Distribution",
- "name": "Distribution center",
- "href": "/objects/inventory-control/warehouse/2"
}, - "contract": {
- "key": null,
- "id": null,
- "name": null
}, - "task": {
- "key": null,
- "id": null,
- "name": null
}
}, - "baseLocation": {
- "name": "Australia",
- "key": "4",
- "href": "/objects/company-config/location/4"
}, - "memo": "bill - 001 - vendor 1099",
- "currency": {
- "exchangeRate": {
- "date": "2024-02-21",
- "typeId": "-99",
- "rate": 1.0679
}, - "txnCurrency": "USD",
- "baseCurrency": "AUD"
}, - "allocation": {
- "name": null,
- "id": null,
- "key": null
}, - "hasForm1099": "false",
- "lineNumber": "1",
- "paymentInformation": {
- "totalBaseAmountPaid": "0.00",
- "totalTxnAmountPaid": "0.00",
- "totalBaseAmountSelectedForPayment": "48550.00",
- "totalTxnAmountSelectedForPayment": "48550.00"
}, - "project": {
- "isBillable": false,
- "isBilled": false
}, - "releaseToPay": false,
- "form1099": {
- "type": null,
- "box": null
}, - "retainage": {
- "percentage": null,
- "txnAmountRetained": null,
- "baseAmountRetained": null,
- "hasRetainage": null,
- "txnAmountReleased": null,
- "release": null
}, - "isSubTotal": null,
- "purchasing": {
- "document": {
- "key": null,
- "id": null
}, - "documentLine": {
- "key": null,
- "id": null
}
}, - "fixedAsset": {
- "nameOfAcquiredAsset": null,
- "includeTaxInAssetCost": false
}, - "href": "/objects/accounts-payable/bill-line/94"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing bill line by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned unique key for the bill line. Example: 99 |
key | string System-assigned key for the line item. Example: "62" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hasForm1099 | string If the vendor is set up for 1099 tracking and enabled for 1009 flag override, you can set to Example: "false" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Form 1099 information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billNumber | string or null Vendor-assigned identifier for the bill. This is the vendor-assigned number provided on the bill. This number is unique and can be used to look up bill details. You must specify a bill number when creating a bill unless document sequencing is configured, in which case the number is auto-generated. Example: "Bill-001" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Vendor to which this bill is linked. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object General Ledger (GL) account associated with the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object An alternative account to override the default GL AP account for the bill. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object AP account label associated with the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
txnAmount | string <decimal-precision-2> For multi-currency companies, provide a transaction amount, which is the amount in the transaction currency. Example: "100.00" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalTxnAmount | string <decimal-precision-2> For tax inclusive bills, provide a total transaction amount. Example: "100.00" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
memo | string or null Memo about the line item. Example: "Service charges" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Transaction allocation template for the line item, which distributes the bill amount across specified dimensions. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Currency details for the bill. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Payment information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
releaseToPay | boolean or null Default: false If Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Project-related information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Asset information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Purchasing document information for the line item. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Tax Entries of the AP bill | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Header level details for the bill's line entries. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OK
Bad Request
{- "txnAmount": "2400"
}
{- "ia::result": {
- "key": "63",
- "id": "198376",
- "href": "/objects/accounts-payable/bill-line/63"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a bill line.
key required | string System-assigned unique key for the bill line. Example: 99 |
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
}
}