Deposits

Transaction record for a deposit. A deposit captures the transfer of funds from a company's undeposited funds account to a bank account when collected and held payments are moved to a bank.

To record a deposit, the payment must already be received against an undeposited funds account. For more information, see About deposits.

List deposits

get/objects/cash-management/deposit

Returns a collection with a key, ID, and link for each deposit. 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 ypeBusiness
PermissionsList, View Deposits
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1718",
      • "id": "1718",
      • "href": "/objects/cash-management/deposit/1718"
      },
    • {
      • "key": "1717",
      • "id": "1717",
      • "href": "/objects/cash-management/deposit/1717"
      },
    • {
      • "key": "3228",
      • "id": "3228",
      • "href": "/objects/cash-management/deposit/3228"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a deposit
post/objects/cash-management/deposit
Creates a new deposit.



Permissions and other requirements



SubscriptionCash Management


User ypeBusiness


PermissionsList, Add Deposits







SecurityOAuth2 
Request 
Request Body schema: application/json
txnDate
required
string <date> 
Date when the transaction occurred.


 
 Example:  "2023-09-21"
required
object
Bank account in which to make the deposit.


 
key
string
System-assigned key for the bank account.


 
 Example:  "1"
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"
id
string
Identifier for the deposit object. Same as key for this object.


 
 Example:  "1234"
depositId
string
ID to correlate the deposit transaction record with the actual deposit slip from the bank.


 
 Example:  "Deposit slip 09/21/2023"
description
string
Description of the deposit.


 
 Example:  "Cash deposit for online service"
object
Supporting document attached to the deposit.


 
key
string
System-assigned key for the supporting document.


 
 Example:  "18"
id
string
System-assigned ID for the supporting document.


 
 Example:  "18"
Array of objects
Line items for the deposited receipts.


 
 Array 
object
Currency details for the deposit line item.


 
object
Location assigned to the deposit.


 
object
 
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
Funds that are part of this deposit.


 
 Array 
id
required
string
Deposit details ID.


 
 Example:  "23"
key
string
System-assigned key for the deposit-detail.


 
 Example:  "23"
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"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "txnDate": "2024-01-22",
  • "description": "Monday Deposit 0314-001",
  • "depositId": "Deposit slip 01/22/2023",
  • "bankAccount": {
    • "id": "BOA"
    },
  • "attachment": {
    • "id": "18"
    },
  • "details": [
    • {
      • "id": "123"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "500",
    • "id": "500",
    • "href": "/objects/cash-management/deposit/500"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a deposit
get/objects/cash-management/deposit/{key}
Returns detailed information for a specified deposit.



Permissions and other requirements



SubscriptionCash Management


User ypeBusiness


PermissionsList, View Deposits







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the deposit.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "628",
    • "key": "628",
    • "bankAccount": {
      • "id": "BOA",
      • "name": "Bank of America"
      },
    • "txnDate": "2023-11-15",
    • "depositId": "Deposit Slip 2023-11-15",
    • "description": "Deposit for pay-go online services",
    • "baseCurrency": "USD",
    • "txnCurrency": "USD",
    • "totalEntered": "120.50",
    • "txnTotalEntered": "120.50",
    • "voidPaymentKey": null,
    • "reversalDate": null,
    • "reversedVoidPaymentKey": null,
    • "reversedDate": null,
    • "state": null,
    • "reconciliationState": "uncleared",
    • "audit": {
      • "createdDateTime": "2023-11-15T20:55:20Z",
      • "modifiedDateTime": "2023-11-15T20:55:25Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "attachment": {
      • "key": "18",
      • "id": "Attach-01",
      • "href": "/objects/company-config/attachment/18"
      },
    • "lines": [
      • {
        }
      ],
    • "details": [
      • {
        }
      ],
    • "href": "/objects/cash-management/deposit/628"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query deposits
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/deposit"
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/deposit",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "bankAccount.name",
    • "txnDate",
    • "totalEntered"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "239",
      • "id": "239",
      • "bankAccount.name": "HSBC",
      • "txnDate": "2013-04-11",
      • "totalEntered": "500.00"
      },
    • {
      • "key": "1163",
      • "id": "1163",
      • "bankAccount.name": "HSBC",
      • "txnDate": "2019-10-04",
      • "totalEntered": "500.00"
      },
    • {
      • "key": "1512",
      • "id": "1512",
      • "bankAccount.name": "HSBC",
      • "txnDate": "2023-12-13",
      • "totalEntered": "1999.95"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}