Deposits

Deposit Transactions are performed as a part of Cash Management at POS API, which allows users to declare how much currency to send to the bank.

The Deposits documentation includes the following sections:

Deposit Status - The status of a given deposit created by employee.
Example Deposit - A sample JSON illustrating a typical payload sent to the webhook URL.
Data Models - Defines the objects and attributes that make up the Deposit Object.

Deposit Status

This field describes the status of a given Deposit created by an employee.

Deposit Status	Description
Open	The Deposit has not yet been finalized.
Finalized	The Deposit is complete and Final.
Deleted	The Deposit has been deleted by the employee.

Example Deposit Object

The code below shows an example of a Deposit Object that is published to the webhook URL:

"data": {
      "entityName": "Deposit",
      "data": {
        "company_id": "5ddab0e3d93109001df6a76c",
        "created_at": "2021-05-25T14:24:59.880Z",
        "deposit_items": [
          {
            "amount": 1362.46,
            "description": "Site #1234",
            "_id": "ada6bd46-9e97-4c7e-ba72-716364283e37",
            "type": "CASH",
            "created_at": "20XX-05-25T14:23:30.799Z",
            "owner_id": "606b5ed8b1eaee0001cca7c6",
            "session_number": 2100,
            "source_id": "5bddc467-481c-4c3e-96fd-14ba701e58de",
            "display_date": "2021-05-25T14:23:30.801Z"
          }
        ],
        "_id": "bc268787-333b-4c37-9ca0-54a8b82cce75",
        "terminal_id": "5e1626a6cbdbfa001fff6b21",
        "comment": "",
        "business_date": "20XX-05-25T00:00:00.000Z",
        "updated_at": "20XX-05-25T14:24:59.880Z",
        "itemizedCounts_items": [
          {
            "payment_type": "CASH",
            "expected_amount": 1362.46,
            "counted_amount": 1362.46,
            "counted_denominations": [
              {
                "name": "Quarters",
                "value": 0.25,
                "quantity": 1,
                "denomination_type": "coin"
              },
              {
                "name": "Dimes",
                "value": 0.1,
                "quantity": 2,
                "denomination_type": "coin"
              },
              {
                "name": "Nickels",
                "value": 0.05,
                "quantity": 0,
                "denomination_type": "coin"
              },
              {
                "name": "Pennies",
                "value": 0.01,
                "quantity": 1,
                "denomination_type": "coin"
              },
              {
                "name": "Hundreds",
                "value": 100,
                "quantity": 0,
                "denomination_type": "banknote"
              },
              {
                "name": "Fifties",
                "value": 50,
                "quantity": 0,
                "denomination_type": "banknote"
              },
              {
                "name": "Twenties",
                "value": 20,
                "quantity": 60,
                "denomination_type": "banknote"
              },
              {
                "name": "Tens",
                "value": 10,
                "quantity": 10,
                "denomination_type": "banknote"
              },
              {
                "name": "Fives",
                "value": 5,
                "quantity": 10,
                "denomination_type": "banknote"
              },
              {
                "name": "Ones",
                "value": 1,
                "quantity": 12,
                "denomination_type": "banknote"
              },
              {
                "name": "Amount",
                "value": 0,
                "quantity": 0,
                "denomination_type": "other"
              }
            ],
            "_id": "052e314d-a7d9-4b3e-9583-e56173d4c13b"
          },
          {
            "payment_type": "CHECK",
            "expected_amount": 0,
            "counted_amount": 0,
            "counted_denominations": [
              {
                "name": "Amount",
                "value": 0,
                "quantity": 0,
                "denomination_type": "other"
              }
            ],
            "_id": "7caf4da7-4bcb-4be2-af0b-897a36902582"
          }
        ],
        "last_updated_by": "606b5f2eb1eaee0001cca7c8",
        "site_id": "5ff33b75a3ea4100089bdbab",
        "status": "finalized",
        "name": "Deposit_9607_2"
      }
    }

For more information, see Data Models General Structure - Deposits.

Data Models

Data Models General Structure - Deposits

The table below defines the objects and attributes the Data Stream service sends as part of the Deposits object.

Field Name	Type	Description
`_id`	string	The unique identifier (UID) of the deposit document. Example: "id": "80ef7622-6797-43f1-870f-143037c045a1"
`business_date`	string	The current business date within which depositing logic was performed. Example: "business_date": "20XX-06-08T00:00:00.000Z"
`company_id`	string/ UUID Length: 36	The universally unique identifier (UUID) for the company that performed this deposit transaction. Example: "company_id": "60a29826879a1a0007021082"
`comment`	string	Provides an optional comment value stored by the point of sale (POS) terminal during a deposit. Example: "comment": "LB2"
`created_at`	string	The Date/Time value when the deposit was created. Example: "created_at": "20XX-05-25T14:24:59.880Z
`deposit_items`	array	The items which have been included in the current deposit, such as Sales, Cash Pull, Other Amounts, and information about each item included in the deposit transaction. Structure: deposit_items Array
`itemizedCounts_items`	array	An array of objects that detail each denomination that was counted as part of the deposit process. Structure: itemizedCounts_items Array
`last_updated_by`	string	The UID of the last employee to change the deposit. Example: "last_updated_by": "60c71dd2c89b350001338a
`name`	string	Provides an optional name associated with the deposit. A default value is generated, but may be overwritten with user input. The name is auto-generated as: `"Deposit_[Site number]_[Sequential number]"`.
`site_id`	string/ UUID Length: 36	The UID of the site within which the deposit transaction was performed. Example: "site_id": "60b0b81b0d2b510007c9606f"
`status`	string	Describes the status of the deposit. The available values are as follows: open finalized deleted Example: "status": "finalized"
`terminal_id`	string/ UUID Length: 36	The UID of the terminal through which the deposit was performed. Example: "terminal_id": "5e73ae520f100271673b3f39"
`updated_at`	string	The timestamp of the deposit updating the operation. Example: "updated_at": "20XX-07-09T07:30:22.022Z"

deposit_items Array

Field Field	Type	Description
`_id`	string	The unique identifier (UID) for this deposit record
`type`	string	Describes the pay type associated with the deposit. The available values are as follows: CASH CHECK
`session_number`	integer	Represents the drawer session from which the deposit item was added. For Cash Drawer - The reference to the drawer session's `sessionNumber` field during which deposit item was created. Warning For Cash Pull, this field is absent.
`source_id`	string	It could be a reference to the different entities: For Cash Drawer - The reference to the drawer session's `_id` field during which the deposit item was created. For Cash Pull - The reference to the drawer event's `_id` field during which the deposit item was created. Otherwise, it is set to null.
`owner_id`	string	Could be a reference to different entities: For Cash Drawer - The reference to the drawer session's `ownerId` field during which the deposit item was created. For Cash Pull - The reference to the drawer event's actor `id` field during which the deposit item was created. Otherwise, this field describes the employee that added this item to the deposit.
`display_date`	string	For Cash Pull and Cash Drawer, this is a reference to the drawer event's `date` field in which the deposit item was created. Warning For Another Amount deposit item, this field is absent.
`amount`	decimal	Describes how much of the deposit item is included
`description`	string	The deposit description which was added by the employee during the creation step. Warning For Cash Pull, this field contains the event actor's description.
`created_at`	string	For Cash Drawer - The reference to the drawer session's `lastUpdated` field during which the deposit item was created. Warning For other types, this field is absent.

Sample Deposits Object deposit_items Array

"deposit_items":
[
    {
        "_id": 
          "ecb3ac5c-9447-4ae3-9938-c4494d49e96f",
        "type": "CASH",
        "source_id": null,
        "owner_id": "60c71dd2c89b350001338a20",
        "amount": 12,
        "description": "Deposit from 07/08 "
    }
]

itemizedCounts_items Array

Field Name

Type

Description

_id

string

The unique identifier (UID) of the calculated Item

payment_type

string

Describes that payment type that was deposited. It correlates with the payment type "name" value.

The available values are as follows:

CASH
CHECK

expected_amount

decimal

Represents how much money the system calculated as "expected," It represents the sum of all drawer counts.

counted_amount

decimal

Captures the sum of the counted denominations for the pay type.

counted_denominations

array

Captures each denomination that was counted. The object includes name, value, and quantity fields.

Structure:

Field Name	Type	Description
`name`	string	The denomination's name
`value`	decimal	The base value of denomination. For example, quarters are 0.25 and twenty dollars are 20.
`quantity`	integer	The quantity of denomination item. For example, if there is one dollar in 4 quarters, it will have 4 as a set value. Warning For CHECK type, this field is absent.
`denomination_type`	string	The type of denomination. The available values are as follows: coin banknote other

Sample Deposits Object itemizedCounts_items Array

"itemizedCounts_items": [
      {
        "payment_type": "CASH",
        "expected_amount": 12,
        "counted_amount": 12,
        "counted_denominations": [
          {
            "name": "Quarters",
            "value": 0.25,
            "quantity": 48,
            "denomination_type": "coin"
          },
          {
            "name": "Dimes",
            "value": 0.1,
            "quantity": 0,
            "denomination_type": "coin"
          },
          {
            "name": "Nickels",
            "value": 0.05,
            "quantity": 0,
            "denomination_type": "coin"
          },
          {
            "name": "Pennies",
            "value": 0.01,
            "quantity": 0,
            "denomination_type": "coin"
          },
          {
            "name": "Hundreds",
            "value": 100,
            "quantity": 0,
            "denomination_type": "banknote"
          },
          {
            "name": "Fifties",
            "value": 50,
            "quantity": 0,
            "denomination_type": "banknote"
          },
          {
            "name": "Twenties",
            "value": 20,
            "quantity": 0,
            "denomination_type": "banknote"
          },
          {
            "name": "Tens",
            "value": 10,
            "quantity": 0,
            "denomination_type": "banknote"
          },
          {
            "name": "Fives",
            "value": 5,
            "quantity": 0,
            "denomination_type": "banknote"
          },
          {
            "name": "Ones",
            "value": 1,
            "quantity": 0,
            "denomination_type": "banknote"
          },
          {
            "name": "Amount",
            "value": 0,
            "quantity": 0,
            "denomination_type": "other"
          }
        ],
        "_id": "c26692be-9e54-431b-be41-236c1805306a"
      },
      {
        "payment_type": "CHECK",
        "expected_amount": 0,
        "counted_amount": 0,
        "counted_denominations": [
          {
            "name": "Amount",
            "value": 0,
            "denomination_type": "other"
          }
        ],
        "_id": "7df85893-9578-4b32-85b1-8dc0f1b2230b"
      }
    ]

Deposits

Deposit Status

Example Deposit Object

Data Models

Data Models General Structure - Deposits

deposit_items Array

Warning

Warning

Warning

Warning

itemizedCounts_items Array

Warning

Search results