Other receipts are receipts that are not associated with a customer or invoice. Other receipts can include cash, a card charge, a cash transfer, or a check payment.
Returns up to 100 objects from the collection with a key, ID, and link for each other receipts object. 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": "182",
- "id": "182",
- "href": "/objects/cash-management/other-receipt/182"
}, - {
- "key": "193",
- "id": "193",
- "href": "/objects/cash-management/other-receipt/193"
}, - {
- "key": "501",
- "id": "501",
- "href": "/objects/cash-management/other-receipt/501"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new other receipts object.
Subscription | Cash Management |
---|---|
User ype | Business |
Permissions | Add Other receipts |
payer required | string Name of the payer. Example: "Benson Hugo" | ||||||||||||||||||||||||||
txnDate required | string <date> Date of the transaction. Typically, this is the check date, but can be the date of a credit card, record transfer, or cash transaction. Example: "2021-01-23" | ||||||||||||||||||||||||||
depositDate required | string <date> Deposit date for payments deposited to a bank account. Example: "2021-01-23" | ||||||||||||||||||||||||||
txnPaidDate required | string <date> Date the transaction was paid. Example: "2021-01-23" | ||||||||||||||||||||||||||
paymentMethod required | string Payment method for the transaction. Example: "eft" | ||||||||||||||||||||||||||
required | object Bank account into which all payments in the other receipts object are deposited. This account is required if an 'undepositedAccount' is not specified. | ||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
txnNumber | string Transaction number. Example: "22365" | ||||||||||||||||||||||||||
description | string Description of the other receipts object. Example: "Refund for overpayment" | ||||||||||||||||||||||||||
object AR summary in which the other receipts transaction is included. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
baseCurrency | string For multi-currency companies, the company's base currency. Example: "USD" | ||||||||||||||||||||||||||
currency | string For multi-currency companies, the currency for the transaction. Example: "USD" | ||||||||||||||||||||||||||
reconciliationDate | string <date> Reconciliation date for the payment. Example: "2021-01-23" | ||||||||||||||||||||||||||
state | string State of the other receipts. Example: "approved" | ||||||||||||||||||||||||||
reconciliationState | string Default: "uncleared" Indicates whether the receipts have been cleared or matched. Example: "cleared" | ||||||||||||||||||||||||||
object Parent deposit payment. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
isInclusiveTax | boolean Default: false Set to Example: true | ||||||||||||||||||||||||||
object The GL undeposited funds account to use when accumulating receipts for deposit. This account is required if a 'bankAccount' is not specified. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object Exchange rate details used to calculate the base amount. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object Tax solution used to calculate taxes on the transaction. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Array of objects Line items of the other receipts transaction. | |||||||||||||||||||||||||||
Array
|
Created
Bad Request
{- "payer": "Benson Hugo",
- "txnDate": "2022-01-23",
- "txnPaidDate": "2022-01-23",
- "txnNumber": "22365",
- "description": "Refund for overpayment",
- "baseCurrency": "USD",
- "currency": "USD",
- "state": "approved",
- "reconciliationState": "uncleared",
- "isInclusiveTax": false,
- "bankAccount": {
- "id": "BOA-REC-01"
}, - "depositDate": "2022-01-23",
- "exchangeRate": {
- "date": "2022-01-23",
- "typeId": null,
- "rate": 1
}, - "paymentMethod": "eft",
- "reversalDate": "2022-01-23",
- "reversedDate": "2022-01-23",
- "reversedVoidPaymentKey": "1400",
- "voidPaymentKey": "1923",
- "lines": [
- {
- "status": "active",
- "amount": "100.00",
- "txnAmount": "100.00",
- "description": "description",
- "lineNumber": 1,
- "baseCurrency": "USD",
- "currency": "USD",
- "isTax": false,
- "arAccountLabel": {
- "key": "35"
}, - "glAccount": {
- "id": "5008"
}, - "dimensions": {
- "location": {
- "id": "CAG"
}, - "department": {
- "id": "OPEE"
}
}
}
]
}
{- "ia::result": {
- "key": "500",
- "id": "500",
- "href": "/objects/cash-management/other-receipt/500"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified other receipts object.
Subscription | Cash Management |
---|---|
User ype | Business |
Permissions | List, View Other receipts |
key required | string System-assigned unique key for the other receipts object. |
OK
Bad Request
{- "ia::result": {
- "key": "557",
- "id": "557",
- "txnDate": "2022-01-23",
- "recordType": "cr",
- "payer": "Smith Jones",
- "txnPaidDate": "2022-01-23",
- "paymentMethod": "creditCard",
- "txnNumber": "2251",
- "description": "Conference booth fee",
- "bankAccount": {
- "key": "45",
- "id": "BOA-REC-01",
- "name": "BOA-REC",
- "currency": "USD",
- "href": "/objects/cash-management/bank-account/45"
}, - "depositDate": "2022-01-23",
- "arSummary": {
- "key": "315",
- "id": "315",
- "date": "2022-01-01",
- "href": "/objects/accounts-receivable/summary/315"
}, - "baseCurrency": "USD",
- "currency": "USD",
- "exchangeRate": {
- "date": null,
- "typeId": null,
- "rate": null
}, - "totalEntered": "150.00",
- "txnTotalEntered": "150.00",
- "reconciliationDate": null,
- "state": "approved",
- "reconciliationState": "uncleared",
- "parentDeposit": {
- "key": null,
- "id": null
}, - "audit": {
- "createdDateTime": "2023-09-07T21:44:43Z",
- "modifiedDateTime": "2023-09-07T21:44:44Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "isInclusiveTax": false,
- "taxSolution": {
- "key": null,
- "id": null,
- "enableMultilineTax": null,
- "taxCalculationMethod": null
}, - "voidPaymentKey": null,
- "reversalDate": null,
- "reversedVoidPaymentKey": null,
- "reversedDate": null,
- "lines": [
- {
- "key": "1101",
- "id": "1101",
- "otherReceipts": {
- "key": "557",
- "id": "557",
- "recordType": "cr",
- "href": "/objects/cash-management/other-receipt/557"
}, - "glAccount": {
- "key": "222",
- "id": "5008",
- "title": "Payments - Contract",
- "href": "/objects/general-ledger/account/222"
}, - "arAccountLabel": {
- "key": "35",
- "id": "35",
- "label": "Sales",
- "href": "/objects/accounts-receivable/account-label/35"
}, - "amount": "150.00",
- "txnAmount": "150.00",
- "dimensions": {
- "department": {
- "number": "21",
- "id": "OPEE",
- "name": "Operations",
- "key": "21",
- "href": "/objects/company-config/department/21"
}, - "location": {
- "id": "CAG",
- "name": "Calgary",
- "key": "30",
- "href": "/objects/company-config/location/30"
}
}, - "description": "Logo display",
- "exchangeRate": {
- "date": null,
- "typeId": null,
- "rate": 1
}, - "lineNumber": 1,
- "currency": "USD",
- "baseCurrency": "USD",
- "status": "active",
- "audit": {
- "createdDateTime": "2023-09-07T21:44:43Z",
- "modifiedDateTime": "2023-09-07T21:44:44Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "isTax": false,
- "orderEntryTaxDetail": {
- "key": null,
- "taxRate": null,
- "id": null
}, - "href": "/objects/cash-management/other-receipt-line/1101"
}
], - "href": "/objects/cash-management/other-receipt/557"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing other receipts object by setting field values. Any fields not provided remain unchanged. Only transactions in an open sub-ledger period, which have not yet been deposited, can be updated.
Subscription | Cash Management |
---|---|
User ype | Business |
Permissions | List, Edit Other receipts |
key required | string System-assigned unique key for the other receipts object. |
payer | string Name of the payer. Example: "Benson Hugo" | ||||||||||||||||||||||||||
txnDate | string <date> Date of the transaction. Typically, this is the check date, but can be the date of a credit card, record transfer, or cash transaction. Example: "2021-01-23" | ||||||||||||||||||||||||||
txnPaidDate | string <date> Date the transaction was paid. Example: "2021-01-23" | ||||||||||||||||||||||||||
txnNumber | string Transaction number. Example: "22365" | ||||||||||||||||||||||||||
description | string Description of the other receipts object. Example: "Refund for overpayment" | ||||||||||||||||||||||||||
object AR summary in which the other receipts transaction is included. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
baseCurrency | string For multi-currency companies, the company's base currency. Example: "USD" | ||||||||||||||||||||||||||
currency | string For multi-currency companies, the currency for the transaction. Example: "USD" | ||||||||||||||||||||||||||
reconciliationDate | string <date> Reconciliation date for the payment. Example: "2021-01-23" | ||||||||||||||||||||||||||
state | string State of the other receipts. Example: "approved" | ||||||||||||||||||||||||||
reconciliationState | string Default: "uncleared" Indicates whether the receipts have been cleared or matched. Example: "cleared" | ||||||||||||||||||||||||||
object Parent deposit payment. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
isInclusiveTax | boolean Default: false Set to Example: true | ||||||||||||||||||||||||||
object Bank account into which all payments in the other receipts object are deposited. This account is required if an 'undepositedAccount' is not specified. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
object The GL undeposited funds account to use when accumulating receipts for deposit. This account is required if a 'bankAccount' is not specified. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
depositDate | string <date> Deposit date for payments deposited to a bank account. Example: "2021-01-23" | ||||||||||||||||||||||||||
object Exchange rate details used to calculate the base amount. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
paymentMethod | string Payment method for the transaction. Example: "eft" | ||||||||||||||||||||||||||
object Tax solution used to calculate taxes on the transaction. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Array of objects Line items of the other receipts transaction. | |||||||||||||||||||||||||||
Array
|
OK
Bad Request
{- "description": "2023 Conference booth fee"
}
{- "ia::result": {
- "key": "500",
- "id": "500",
- "href": "/objects/cash-management/other-receipt/500"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes an other receipts object. Only those receipts that have not yet been deposited or reconciled that are in an open period can be deleted.
Subscription | Cash Management |
---|---|
User ype | Business |
Permissions | List, View, Delete Other receipts |
key required | string System-assigned unique key for the other receipts object. |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "cash-management/other-receipt" | ||||||||
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",
- "filters": [
- {
- "$eq": {
- "state": "approved"
}
}
], - "fields": [
- "key",
- "id",
- "payer",
- "description",
- "reconciliationState"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "1243",
- "id": "1243",
- "payer": "Dunbar Middlin",
- "description": "Refund for overpayment",
- "reconciliationState": "uncleared"
}, - {
- "key": "1508",
- "id": "1508",
- "payer": "Bryce Businesses",
- "description": "Company kick-off design overpayment",
- "reconciliationState": "uncleared"
}, - {
- "key": "1509",
- "id": "1509",
- "payer": "Manny Jose Jimenez",
- "description": "Employee reimbursement for petty cash use",
- "reconciliationState": "uncleared"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}