Other receipts

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.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List other receipt objects

get/objects/cash-management/other-receipt

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.

Permissions and other requirements
SubscriptionCash Management
User typeBusiness
PermissionsList, View Other receipts
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create an other receipts object
post/objects/cash-management/other-receipt
Creates a new other receipts object.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness


PermissionsAdd Other receipts







SecurityOAuth2 
Request 
Request Body schema: application/json
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.


 Enum: "cash" "creditCard" "eft" "printedCheck"  
 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.


 
key
string
System-assigned key for the bank account.


 
 Example:  "1002"
id
string
Account number or other unique identifier for the bank account.


 
 Example:  "BOA"
name
string
Name of the bank account.


 
 Example:  "Bank of America"
currency
string
Currency for the bank account.


 
 Example:  "USD"
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.


 
key
string
System-assigned key for the AR summary.


 
 Example:  "100"
id
string
Identifier for the AR summary.


 
 Example:  "100"
date
string <date> 
Summary date.


 
 Example:  "2023-10-10"
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 object.


 Enum: "approved" "deposited" "reconciled" "reversal" "reversed"  
 Example:  "approved"
reconciliationState
string
 Default:  "uncleared"
Indicates whether the receipts have been cleared or matched.


 Enum: "cleared" "matched" "uncleared"  
 Example:  "cleared"
object
Parent deposit payment.


 
key
string
System-assigned key for the parent deposit.


 
 Example:  "3319"
id
string
Identifier for the parent deposit.


 
 Example:  "3319"
isInclusiveTax
boolean
 Default:  false
Set to true if the amount for each line item already includes taxes.


 
 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.


 
key
string
System-assigned key for the undeposited funds account.


 
 Example:  "19"
id
string
General ledger undeposited funds account number.


 
 Example:  "1020--Undeposited Funds"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2021-01-23"
rate
number
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
object
Tax solution used to calculate taxes on the transaction.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "123"
id
string
Unique identifier for the tax solution.


 
 Example:  "CATAXSOLUTIONID"
enableMultilineTax
boolean
 Default:  false
Set to true to enable multiple taxes per line.


 
 Example:  false
taxCalculationMethod
string
Method used to apply sales tax during transaction entry, such as Advanced or Simple.


 
 Example:  "Simple"
Array of objects
Line items of the other receipts transaction.


 
 Array 
txnAmount
required
string <decimal-precision-2> 
For multi-currency companies, amount of the line item receipt.


 
 Example:  "100.99"
required
object
GL account for the line item.


 
amount
string <decimal-precision-2> 
For single-currency companies, amount of the line item receipt.


 
 Example:  "100.99"
totalTxnAmount
string <decimal-precision-2> 
For multi-currency companies, amount of the line item receipt.


 
 Example:  "100.99"
description
string
Description of the other receipts line item.


 
 Example:  "Cash receipt for rental invoice account 101"
object
Exchange rate used to calculate the base amount.


 
lineNumber
integer
Line number for the other receipts line item.


 
 Example:  1
isTax
boolean
 Default:  false
Indicates whether the line item amount includes taxes.


 
 Example:  false
object
Label for the account associated with the line item.


 
object
 
object
Header level details for the other receipts object's line entries.


 
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"
Array of objects
Tax Entries of the other receipt


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "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": {
        },
      • "glAccount": {
        },
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "500",
    • "id": "500",
    • "href": "/objects/cash-management/other-receipt/500"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an other receipts object
get/objects/cash-management/other-receipt/{key}
Returns detailed information for a specified other receipts object.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness


PermissionsList, View Other receipts







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the other receipts object.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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": [
      • {
        }
      ],
    • "href": "/objects/cash-management/other-receipt/557"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an other receipts object
patch/objects/cash-management/other-receipt/{key}
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.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness


PermissionsList, Edit Other receipts







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the other receipts object.


 
Request Body schema: application/json
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.


 
key
string
System-assigned key for the AR summary.


 
 Example:  "100"
id
string
Identifier for the AR summary.


 
 Example:  "100"
date
string <date> 
Summary date.


 
 Example:  "2023-10-10"
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 object.


 Enum: "approved" "deposited" "reconciled" "reversal" "reversed"  
 Example:  "approved"
reconciliationState
string
 Default:  "uncleared"
Indicates whether the receipts have been cleared or matched.


 Enum: "cleared" "matched" "uncleared"  
 Example:  "cleared"
object
Parent deposit payment.


 
key
string
System-assigned key for the parent deposit.


 
 Example:  "3319"
id
string
Identifier for the parent deposit.


 
 Example:  "3319"
isInclusiveTax
boolean
 Default:  false
Set to true if the amount for each line item already includes taxes.


 
 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.


 
key
string
System-assigned key for the bank account.


 
 Example:  "1002"
id
string
Account number or other unique identifier for the bank account.


 
 Example:  "BOA"
name
string
Name of the bank account.


 
 Example:  "Bank of America"
currency
string
Currency for the bank account.


 
 Example:  "USD"
object
The GL undeposited funds account to use when accumulating receipts for deposit. This account is required if a  'bankAccount' is not specified.


 
key
string
System-assigned key for the undeposited funds account.


 
 Example:  "19"
id
string
General ledger undeposited funds account number.


 
 Example:  "1020--Undeposited Funds"
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.


 
date
string <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2021-01-23"
rate
number
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
paymentMethod
string
Payment method for the transaction.


 Enum: "cash" "creditCard" "eft" "printedCheck"  
 Example:  "eft"
object
Tax solution used to calculate taxes on the transaction.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "123"
id
string
Unique identifier for the tax solution.


 
 Example:  "CATAXSOLUTIONID"
enableMultilineTax
boolean
 Default:  false
Set to true to enable multiple taxes per line.


 
 Example:  false
taxCalculationMethod
string
Method used to apply sales tax during transaction entry, such as Advanced or Simple.


 
 Example:  "Simple"
Array of objects
Line items of the other receipts transaction.


 
 Array 
amount
string <decimal-precision-2> 
For single-currency companies, amount of the line item receipt.


 
 Example:  "100.99"
totalTxnAmount
string <decimal-precision-2> 
For multi-currency companies, amount of the line item receipt.


 
 Example:  "100.99"
txnAmount
string <decimal-precision-2> 
For multi-currency companies, amount of the line item receipt.


 
 Example:  "100.99"
description
string
Description of the other receipts line item.


 
 Example:  "Cash receipt for rental invoice account 101"
object
Exchange rate used to calculate the base amount.


 
lineNumber
integer
Line number for the other receipts line item.


 
 Example:  1
isTax
boolean
 Default:  false
Indicates whether the line item amount includes taxes.


 
 Example:  false
object
Label for the account associated with the line item.


 
object
GL account for the line item.


 
object
 
object
Header level details for the other receipts object's line entries.


 
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"
Array of objects
Tax Entries of the other receipt


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "2023 Conference booth fee"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "500",
    • "id": "500",
    • "href": "/objects/cash-management/other-receipt/500"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an other receipts object
delete/objects/cash-management/other-receipt/{key}
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.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness


PermissionsList, View, Delete Other receipts







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the other receipts object.


 
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
    }
}
Reverse an other receipts object
post/workflows/cash-management/other-receipt/reverse
Reverse an other receipts object to maintain an audit trail from the bank register. After you reverse an other receipts object, you cannot undo the reversal. However, you can create a new other receipts object to replace the original.


SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned key for the other receipt.


 
 Example:  "49"
reversedDate
required
string <date> 
Date this transaction is reversed.


 
 Example:  "2024-04-15"
notes
string
Notes or comments about the reason for the reverse of other receipt.


 
 Example:  "Reversed the other receipt due to duplicate entry"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "49",
  • "reversedDate": "2024-04-15",
  • "notes": "Reversed the other receipt due to duplicate entry"
}
Response samples 
application/json
{
  • "key": "50",
  • "id": "50",
  • "href": "/objects/cash-management/other-receipt/50",
  • "state": "reversed"
}
Query other receipts
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "cash-management/other-receipt"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 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 asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
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 
property name*
additional property
string
 Enum: "asc" "desc"  
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
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "cash-management/other-receipt",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "payer",
    • "description",
    • "reconciliationState"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "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
    }
}