Deposit API

Create, read, update, and delete bank deposits for undeposited funds using the NetSuite REST API.

---

Endpoints

Method	Endpoint	Description
GET	/record/v1/deposit	List all deposits
GET	/record/v1/deposit/{id}	Get specific deposit
POST	/record/v1/deposit	Create new deposit
PATCH	/record/v1/deposit/{id}	Update deposit
DELETE	/record/v1/deposit/{id}	Delete deposit

---

Key Fields

Header Fields

Field	Type	Description	Required
id	string	Internal ID (read-only)	-
tranId	string	Deposit number	Auto-generated
account	object	Bank account	Yes
tranDate	string	Deposit date (ISO 8601)	Yes
postingPeriod	object	Accounting period	Auto-calculated
subsidiary	object	Subsidiary	Yes (OneWorld)
currency	object	Transaction currency	Yes
exchangeRate	number	Exchange rate	Auto-calculated
memo	string	Memo/description	No
tranStatus	object	Transaction status	Read-only

Financial Fields

Field	Type	Description	Required
total	number	Total deposit amount (read-only)	-

Classification Fields

Field	Type	Description	Required
department	object	Default department	No
class	object	Default classification	No
location	object	Default location	No

Sublists

Field	Type	Description	Required
payment	collection	Payments to deposit	Yes (min 1)
cashback	collection	Cash back lines	No
other	collection	Other deposit lines	No

---

Example: Create Deposit

POST /record/v1/deposit
Content-Type: application/json

{
  "account": {
    "id": "10"
  },
  "tranDate": "2025-12-25",
  "subsidiary": {
    "id": "1"
  },
  "currency": {
    "id": "1"
  },
  "memo": "Daily deposit - December 25, 2025",
  "payment": {
    "items": [
      {
        "deposit": {
          "id": "7001"
        },
        "depositdate": "2025-12-25",
        "amount": 5000.00
      },
      {
        "deposit": {
          "id": "7002"
        },
        "depositdate": "2025-12-25",
        "amount": 3000.00
      },
      {
        "deposit": {
          "id": "7003"
        },
        "depositdate": "2025-12-25",
        "amount": 2500.00
      }
    ]
  }
}

Response

{
  "links": [
    {
      "rel": "self",
      "href": "https://1234567.suitetalk.api.netsuite.com/services/rest/record/v1/deposit/6001"
    }
  ],
  "id": "6001",
  "refName": "Deposit #DEP-6001",
  "tranId": "DEP-6001",
  "account": {
    "id": "10",
    "refName": "Operating Account"
  },
  "tranDate": "2025-12-25",
  "postingPeriod": {
    "id": "12",
    "refName": "Dec 2025"
  },
  "subsidiary": {
    "id": "1",
    "refName": "Parent Company"
  },
  "currency": {
    "id": "1",
    "refName": "USA"
  },
  "total": 10500.00,
  "memo": "Daily deposit - December 25, 2025",
  "tranStatus": {
    "id": "DEPOSITED",
    "refName": "Deposited"
  }
}

---

Example: Create Deposit with Cash Back

POST /record/v1/deposit
Content-Type: application/json

{
  "account": {
    "id": "10"
  },
  "tranDate": "2025-12-25",
  "subsidiary": {
    "id": "1"
  },
  "currency": {
    "id": "1"
  },
  "memo": "Deposit with cash back for petty cash",
  "payment": {
    "items": [
      {
        "deposit": {
          "id": "7001"
        },
        "amount": 5000.00
      }
    ]
  },
  "cashback": {
    "items": [
      {
        "account": {
          "id": "105"
        },
        "amount": 200.00,
        "memo": "Petty cash replenishment"
      }
    ]
  }
}

---

Example: Create Deposit with Other Deposits

POST /record/v1/deposit
Content-Type: application/json

{
  "account": {
    "id": "10"
  },
  "tranDate": "2025-12-25",
  "subsidiary": {
    "id": "1"
  },
  "currency": {
    "id": "1"
  },
  "memo": "Mixed deposit - customer payments and interest income",
  "payment": {
    "items": [
      {
        "deposit": {
          "id": "7001"
        },
        "amount": 5000.00
      }
    ]
  },
  "other": {
    "items": [
      {
        "account": {
          "id": "450"
        },
        "amount": 125.50,
        "memo": "Interest income - December 2025",
        "entity": {
          "id": "456"
        }
      }
    ]
  }
}

---

Example: Update Deposit

PATCH /record/v1/deposit/6001
Content-Type: application/json

{
  "memo": "Updated: Daily deposit - December 25, 2025 (corrected)"
}

---

Payment Line Fields

Each item in the payment.items array supports:

Field	Type	Description	Required
deposit	object	Customer payment or cash sale reference	Yes
depositdate	string	Deposit date	No
amount	number	Deposit amount	Yes
currency	object	Payment currency	Auto from payment

Undeposited Funds

The payment sublist includes customer payments and cash sales that were recorded with "Undeposited Funds" as the account. These transactions are waiting to be deposited to the bank.

---

Cash Back Line Fields

Each item in the cashback.items array supports:

Field	Type	Description	Required
account	object	Cash back account (typically Petty Cash)	Yes
amount	number	Cash back amount	Yes
memo	string	Cash back memo	No

Cash Back

Cash back reduces the net deposit amount. If you deposit $5,000 but take $200 cash back, only $4,800 is deposited to the bank account.

---

Other Deposits Line Fields

Each item in the other.items array supports:

Field	Type	Description	Required
account	object	Credit account (e.g., Interest Income, Other Income)	Yes
amount	number	Deposit amount	Yes
memo	string	Line memo	No
entity	object	Customer/Vendor (if applicable)	No
department	object	Department	No
class	object	Classification	No
location	object	Location	No

Other Deposits

Use the other sublist for miscellaneous deposits like interest income, refunds, or other receipts that aren't customer payments.

---

Query Filters

Find by Date Range

GET /record/v1/deposit?q=tranDate BETWEEN '2025-01-01' AND '2025-12-31'

Find by Bank Account

GET /record/v1/deposit?q=account='10'

Find by Subsidiary

GET /record/v1/deposit?q=subsidiary='1'

Find by Amount Range

GET /record/v1/deposit?q=total > 5000

Find Recent Deposits

GET /record/v1/deposit?q=tranDate >= '2025-12-01'

Find by Posting Period

GET /record/v1/deposit?q=postingPeriod='12'

---

Important Notes

Accounting Impact

Standard Deposit:

• Debit: Bank Account (specified in account field)
• Credit: Undeposited Funds (for customer payments in payment sublist)
• Credit: Other accounts (for items in other sublist)

Deposit with Cash Back:

• Debit: Bank Account (net amount after cash back)
• Debit: Petty Cash or Cash account (cash back amount)
• Credit: Undeposited Funds / Other accounts

Undeposited Funds Account

• Customer payments and cash sales can be initially recorded to "Undeposited Funds"
• This holds funds until they are physically deposited to the bank
• Deposit transaction moves funds from Undeposited Funds to Bank Account
• Useful for batching multiple payments into one bank deposit

Bank Reconciliation

• Deposits appear in bank reconciliation as uncleared until marked cleared
• Deposit date (tranDate) should match the actual bank deposit date
• Helps match NetSuite records to bank statement
• Important for accurate cash flow reporting

Multi-Currency Deposits

• All payments in a deposit must be in the same currency
• Currency must match the bank account's currency
• Exchange rates applied at the payment level, not deposit level
• Use currency-specific bank accounts for foreign currency deposits

Deposit Restrictions

• Cannot delete deposits that have been reconciled
• Cannot modify deposits in closed accounting periods
• All payments in deposit must be from same subsidiary (OneWorld)
• Cannot include payments that are already deposited

Cash Back Considerations

• Cash back is typically used for petty cash replenishment
• Reduces the actual amount deposited to the bank
• Must be recorded in a cash/petty cash account
• Requires proper documentation for audit purposes

---

Common Use Cases

1. Daily Cash Sales Deposit

Deposit multiple cash sales from the day:

{
  "account": {"id": "10"},
  "tranDate": "2025-12-25",
  "subsidiary": {"id": "1"},
  "memo": "Daily cash sales deposit - December 25",
  "payment": {
    "items": [
      {"deposit": {"id": "8001"}, "amount": 250.00},
      {"deposit": {"id": "8002"}, "amount": 175.50},
      {"deposit": {"id": "8003"}, "amount": 320.00},
      {"deposit": {"id": "8004"}, "amount": 425.75}
    ]
  }
}

2. Customer Payment Batch Deposit

Deposit multiple customer payments received:

{
  "account": {"id": "10"},
  "tranDate": "2025-12-25",
  "subsidiary": {"id": "1"},
  "memo": "Customer payments batch - Week of Dec 20-25",
  "payment": {
    "items": [
      {"deposit": {"id": "9001"}, "amount": 5000.00},
      {"deposit": {"id": "9002"}, "amount": 3500.00},
      {"deposit": {"id": "9003"}, "amount": 7500.00},
      {"deposit": {"id": "9004"}, "amount": 2000.00}
    ]
  }
}

3. Deposit with Interest Income

Deposit customer payments plus bank interest:

{
  "account": {"id": "10"},
  "tranDate": "2025-12-25",
  "subsidiary": {"id": "1"},
  "memo": "Deposit with interest income",
  "payment": {
    "items": [
      {"deposit": {"id": "7001"}, "amount": 10000.00}
    ]
  },
  "other": {
    "items": [
      {
        "account": {"id": "450"},
        "amount": 85.50,
        "memo": "Monthly interest income - December"
      }
    ]
  }
}

4. Deposit with Petty Cash Replenishment

Deposit with cash back for petty cash:

{
  "account": {"id": "10"},
  "tranDate": "2025-12-25",
  "subsidiary": {"id": "1"},
  "memo": "Deposit with petty cash withdrawal",
  "payment": {
    "items": [
      {"deposit": {"id": "7001"}, "amount": 5000.00},
      {"deposit": {"id": "7002"}, "amount": 3000.00}
    ]
  },
  "cashback": {
    "items": [
      {
        "account": {"id": "105"},
        "amount": 300.00,
        "memo": "Petty cash replenishment"
      }
    ]
  }
}

5. Refund Deposit

Deposit a refund received:

{
  "account": {"id": "10"},
  "tranDate": "2025-12-25",
  "subsidiary": {"id": "1"},
  "memo": "Vendor refund deposit",
  "other": {
    "items": [
      {
        "account": {"id": "620"},
        "amount": 500.00,
        "memo": "Refund from ABC Supplies - overpayment",
        "entity": {"id": "789"}
      }
    ]
  }
}

6. Insurance Claim Deposit

Deposit insurance claim payment:

{
  "account": {"id": "10"},
  "tranDate": "2025-12-25",
  "subsidiary": {"id": "1"},
  "memo": "Insurance claim payment - Property damage",
  "other": {
    "items": [
      {
        "account": {"id": "480"},
        "amount": 15000.00,
        "memo": "Insurance claim #12345 - Property damage Dec 2025",
        "department": {"id": "1"}
      }
    ]
  }
}

---

Deposit Workflow

Standard Deposit Process

1. Customer payments recorded - Payments recorded to Undeposited Funds
2. Batch payments - Group payments to be deposited together
3. Create deposit - Create deposit transaction with selected payments
4. Prepare deposit slip - Physical deposit prepared for bank
5. Make bank deposit - Deposit made at bank
6. Bank reconciliation - Match deposit to bank statement

End-of-Day Cash Handling

1. Count cash - Count cash register or daily receipts
2. Record cash sales - Enter cash sales to Undeposited Funds
3. Prepare deposit - Physical cash and checks prepared
4. Create deposit in NetSuite - Record deposit transaction
5. Deliver to bank - Make physical deposit at bank
6. Verify next day - Confirm deposit posted to bank account

---

Deposit vs. Customer Payment

When to Use Deposit

• Batching multiple customer payments into one bank deposit
• Recording non-customer receipts (interest, refunds, etc.)
• Matching NetSuite records to actual bank deposits
• Cash back transactions

When to Use Customer Payment

• Recording individual customer payment receipts
• Applying payments to specific invoices
• Direct deposit to bank account (without batching)
• Immediate reconciliation needed

---

See Also

• Customer Payment - Record customer payments
• Cash Sale - Record cash sales
• Customer Deposit - Record customer deposits
• Check - Write checks
• Account - Chart of accounts