NetSuite REST icon

NetSuite REST

Call NetSuite SuiteTalk REST operations.

Actions979

Deposit → Insert record

AI-generated

Summary

Insert a new Deposit record into NetSuite via its REST API.

Inputs

  • isDebugMode — Whether to include full request and response info in the output.
  • account — Reference to the bank account receiving the deposit, by internal or external ID.
  • accountingBookDetail — Array of accounting book entries for the deposit, each with accounting book, exchange rate, reference name, subsidiary and optional items.
  • total — Total amount of the deposit, including payments, other deposits, and cashback.
  • isBaseCurrency — Indicates if the deposit amount is in the base currency.
  • cashback — Array of cashback line items, each with account, amount, class, department, line, location, memo, and reference name.
  • class — Classification of the deposit.
  • cleared — Whether the deposit has been cleared.
  • creditCardProcessor — Reference to the credit card processor used.
  • currency (required) — Currency of the deposit, by internal or external ID.
  • currencyPrecision — Number of decimal places for the currency amount.
  • customForm — Custom form used for the deposit; supports internal or external ID and reference name.
  • tranDate — Posting date of the deposit; defaults to today if not provided.
  • clearedDate — Date the deposit was cleared.
  • createdDate — Date the deposit record was created.
  • lastModifiedDate — Date the deposit record was last modified.
  • department — Department associated with the deposit.
  • tranId — System-generated transaction number for the deposit.
  • exchangeRate — Exchange rate applied to the deposit amount.
  • externalId — External identifier for the deposit.
  • id — Internal ID of the deposit record.
  • location — Location for the deposit, by internal or external ID.
  • memo — Memo that appears on the deposit transaction report.
  • other — Array of other ledger lines, each with account, amount, class, department, entity, line, location, memo, and reference number.
  • payment — Array of payment line items, each with amount, class, currency, department, entity, memo, payment method, and other details.
  • postingPeriod — Posting period for the deposit, by internal or external ID.
  • Prefer — Client preference header; can be 'respond-async' for asynchronous processing.
  • prevDate — Previous effective date for the deposit.
  • refName — Reference name for the record.
  • replace — Comma‑separated list of sublist names to replace when sending lines.
  • subsidiary — Subsidiary for the deposit, by internal or external ID.
  • tranCurrencyName — Display name of the transaction currency.
  • X-NetSuite-Idempotency-Key — Idempotency key for asynchronous requests to prevent duplicate execution.
  • X-NetSuite-PropertyNameValidation — Strictness level for validating property names.
  • X-NetSuite-PropertyValueValidation — Strictness level for validating property values.

Output shape

a JSON object representing the created Deposit record, including fields such as id, tranId, and any other attributes returned by NetSuite. If Debug Mode is enabled, the shape also contains the full HTTP request and response payloads.

All fields sent in the request are optional; NetSuite will use defaults for omitted fields. The operation may return additional system fields depending on NetSuite configuration.

Examples

Example 1: Create a minimal Deposit with account and total

Set account.internalId='123', total=1000.00, tranDate='2024-08-19'.

Example 2: Create Deposit with cashback and other ledger lines

Provide cashback.items with account and amount, and other.items with account, amount, and entity.

Example 3: Insert Deposit with debug mode

Turn on Debug Mode to receive request and response details in the output.

Discussion