Cash Drawer

Cash Drawers are used to keep track of cash transactions during the Convention via the Point of Sale system. You must have the financials ConventionPrivilege to access any drawer or be the User that controls the drawer. Cash Drawers are accessed via /api/cashdrawer.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in CashDrawerProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

convention

The Convention this cash drawer belongs to.

user

The User this cash drawer belongs to. They are the cashier in the Point of Sale system.

Services

The services used to fetch and manipulate cashdrawers.

Search Cash Drawers

This will search across all conventions, and return the cash drawers created by the user who's session is used to make this request. To search on a single convention see "Relationships" in Convention.

 GET /api/cashdrawer

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "user_id" : "xxx",
          ...
        },
        ...
    ]
 }

Create Cash Drawer

 POST /api/cashdrawer

Required Params

convention_id

starting_amount

Returns the same as a normal read.

Read CashDrawer

 GET /api/cashdrawer/xxx

You can also make the request without the ID and then the system will just use an open cash drawer associated with the Convention id passed as a parameter.

 GET /api/cashdrawer/

Optional Params

convention_id

Returns:

 {
   "id" : "xxx",
   "user_id" : "xxx",
   ...
 }

Update Cash Drawer

 PUT /api/cashdrawer/xxx

You can also make the request without the ID and then the system will just use an open cash drawer associated with the Convention id passed as a parameter.

 PUT /api/cashdrawer/

Optional Params

convention_id

Returns the same as a normal read.

Close Out Cash Drawer

When a cash drawer is done being used it is closed not deleted.

 POST /api/cashdrawer/xxx/close

You can also make the request without the ID and then the system will just use an open cash drawer associated with the Convention id passed as a parameter.

 POST /api/cashdrawer//close

Required Params

closing_amount

Optional Params

convention_id

Returns the same as a normal read.

Verify Cash Drawer

A convention organizer will verify the closing amount of each cash drawer against the cash they received back from the cashier.

 POST /api/cashdrawer/xxx/verify

You can also make the request without the ID and then the system will just use an open cash drawer associated with the Convention id passed as a parameter.

 POST /api/cashdrawer//close

Required Params

verified_amount

Optional Params

convention_id

Returns the same as a normal read.