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 the query service to find objects that meet certain criteria and to specify properties that are returned.

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.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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
Unique identifier for the deposit. This value is the same as the key for this object.


 
 Example:  "1234"
depositId
string
Identifier 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"
postingDate
string <date> 
Date the deposit was posted.


 
 Example:  "2021-09-23"
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.


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


 
 Example:  134
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
    }
}
Reverse a deposit
post/workflows/cash-management/deposit/reverse
When a deposit has been issued and is in a posted state, it can be reversed.


 When a deposit is reversed, the original posted transaction immediately enters the reversal state. It transitions to the reversed state once the reversal date is reached. 


 A reversal transaction is also created in the reversal state when you reverse a deposit. The state of the reversal transaction does not change.


 For more information, see Reverse a deposit in the Sage Intacct Help Center.


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


 
 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 deposit.


 
 Example:  "Reversed the deposit  for duplicate entry"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "49",
  • "reversedDate": "2024-04-15",
  • "notes": "Reversed the deposit  for duplicate entry"
}
Response samples 
application/json
{
  • "key": "50",
  • "id": "50",
  • "href": "/objects/cash-management/deposit/50",
  • "state": "reversed"
}