Create a cash drawer session
post
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCashDrawerSessions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier for the agency that receives incoming customer payments.
-
BegBalanceAmount(optional):
number
The cash amount that is available in the cash drawer at the beginning of the cashier session.
-
BnpCashDrawerSessionTimeView(optional):
array Cash Drawer Sessions Time Lines
Title:
Cash Drawer Sessions Time Lines
The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device. -
CashierId(optional):
string
Maximum Length:
50
The unique identifier for the cashier. -
CurrencyCode(optional):
string
Maximum Length:
3
The currency code of coins and bills in the cash drawer. -
DrawerId(optional):
string
Maximum Length:
30
The unique identifier for the cash drawer. -
EndBalanceAmount(optional):
number
The cash amount that is available in the cash drawer at the closing of the cashier session.
-
EndDatetime(optional):
string(date-time)
The end date and time for the cashier session.
-
links(optional):
array Items
Title:
Items
Link Relations -
SessionId(optional):
string
Maximum Length:
50
The unique identifier for the cashier session. -
SessionStatus(optional):
string
Maximum Length:
10
The status of the cashier session, which can be opened, suspended, or closed. -
StartDatetime(optional):
string(date-time)
The start date and time for the cashier session.
-
UserName(optional):
string
Maximum Length:
100
The user name of the employee who acts as the cashier of the cashier session.
Nested Schema : Cash Drawer Sessions Time Lines
Type:
array
Title:
Cash Drawer Sessions Time Lines
The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.
Show Source
Nested Schema : publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier for the agency that receives incoming customer payments.
-
EndDatetime(optional):
string(date-time)
The end date and time for the cashier session line.
-
LineNumber(optional):
integer(int64)
The unique identifier for the cashier session line number.
-
links(optional):
array Items
Title:
Items
Link Relations -
SessionId(optional):
string
Maximum Length:
50
The unique identifier for the cashier session. -
StartDatetime(optional):
string(date-time)
The start date and time for the cashier session line.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCashDrawerSessions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier for the agency that receives incoming customer payments.
-
BegBalanceAmount(optional):
number
The cash amount that is available in the cash drawer at the beginning of the cashier session.
-
BnpCashDrawerSessionTimeView(optional):
array Cash Drawer Sessions Time Lines
Title:
Cash Drawer Sessions Time Lines
The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device. -
CashierId(optional):
string
Maximum Length:
50
The unique identifier for the cashier. -
CurrencyCode(optional):
string
Maximum Length:
3
The currency code of coins and bills in the cash drawer. -
DrawerId(optional):
string
Maximum Length:
30
The unique identifier for the cash drawer. -
EndBalanceAmount(optional):
number
The cash amount that is available in the cash drawer at the closing of the cashier session.
-
EndDatetime(optional):
string(date-time)
The end date and time for the cashier session.
-
links(optional):
array Items
Title:
Items
Link Relations -
SessionId(optional):
string
Maximum Length:
50
The unique identifier for the cashier session. -
SessionStatus(optional):
string
Maximum Length:
10
The status of the cashier session, which can be opened, suspended, or closed. -
StartDatetime(optional):
string(date-time)
The start date and time for the cashier session.
-
UserName(optional):
string
Maximum Length:
100
The user name of the employee who acts as the cashier of the cashier session.
Nested Schema : Cash Drawer Sessions Time Lines
Type:
array
Title:
Cash Drawer Sessions Time Lines
The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.
Show Source
Nested Schema : publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier for the agency that receives incoming customer payments.
-
EndDatetime(optional):
string(date-time)
The end date and time for the cashier session line.
-
LineNumber(optional):
integer(int64)
The unique identifier for the cashier session line number.
-
links(optional):
array Items
Title:
Items
Link Relations -
SessionId(optional):
string
Maximum Length:
50
The unique identifier for the cashier session. -
StartDatetime(optional):
string(date-time)
The start date and time for the cashier session line.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.