Line items in an other receipts object represent transactions that are not associated with a customer or invoice.
Returns a collection with a key, ID, and link for each other receipts line item. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Cash Management |
---|---|
User ype | Business |
Permissions | List, View Other receipts |
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "1",
- "href": "/objects/cash-management/other-receipt-line/1"
}, - {
- "key": "3",
- "id": "3",
- "href": "/objects/cash-management/other-receipt-line/3"
}, - {
- "key": "5",
- "id": "5",
- "href": "/objects/cash-management/other-receipt-line/5"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100
}
}
Returns detailed information for a specified other receipts line item.
Subscription | Cash Management |
---|---|
User ype | Business |
Permissions | List, View Other receipts |
key required | string System-assigned key for the other receipts line item. |
OK
Bad Request
{- "ia::result": {
- "key": "821",
- "id": "821",
- "otherReceipts": {
- "key": "415",
- "id": "415",
- "recordType": "cr",
- "href": "/objects/cash-management/other-receipt/415"
}, - "glAccount": {
- "key": "194",
- "id": "4000",
- "title": "Accounts Payable",
- "href": "/objects/general-ledger/account/194"
}, - "arAccountLabel": {
- "key": "35",
- "id": "35",
- "label": "Sales",
- "href": "/objects/accounts-receivable/account-label/35"
}, - "amount": "101.11",
- "txnAmount": "101.11",
- "dimensions": {
- "department": {
- "key": null,
- "id": null,
- "number": null,
- "name": null,
- "href": null
}, - "location": {
- "number": "1",
- "id": "1",
- "name": "United States of America",
- "key": "1",
- "href": "/objects/company-config/location/1"
}
}, - "description": "Refund for overpayment",
- "exchangeRate": {
- "date": "2021-01-15",
- "typeId": null,
- "rate": 1
}, - "lineNumber": 1,
- "currency": "USD",
- "baseCurrency": "USD",
- "status": "active",
- "audit": {
- "createdDateTime": "2022-10-25T22:38:22Z",
- "modifiedDateTime": "2022-10-25T22:38:22Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "isTax": false,
- "orderEntryTaxDetail": {
- "key": null,
- "taxRate": null,
- "id": null
}, - "href": "/objects/cash-management/other-receipt-line/821"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "cash-management/other-receipt-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": "cash-management/other-receipt-line",
- "filters": [
- {
- "$eq": {
- "status": "active"
}
}
], - "fields": [
- "key",
- "id",
- "amount",
- "glAccount.title",
- "isTax"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "6104",
- "id": "6104",
- "amount": "25.00",
- "glAccount.title": "Accounts Payable",
- "isTax": false
}, - {
- "key": "6975",
- "id": "6975",
- "amount": "1200.00",
- "glAccount.title": "Advertising",
- "isTax": false
}, - {
- "key": "6977",
- "id": "6977",
- "amount": "200.00",
- "glAccount.title": "Other Income",
- "isTax": false
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}