Create a cash drawer session
post
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for the agency that receives incoming customer payments. -
BegBalanceAmount: number
Default Value:
0
The cash amount that is available in the cash drawer at the beginning of the cashier session. -
BnpCashDrawerSessionTimeView: array
Cash Drawer Sessions Time Lines
Title:
Cash Drawer Sessions Time Lines
The cash drawer sessions time lines resource is used to save the cashier session detail of open and close datetime. -
CashierId(required): string
Title:
Cashier ID
Maximum Length:50
The unique identifier for the cashier. -
CurrencyCode(required): string
Maximum Length:
3
The currency code of coins and bills in the cash drawer. -
DrawerId(required): string
Maximum Length:
30
The unique identifier for the cash drawer. -
EndBalanceAmount: number
The cash amount that is available in the cash drawer at the closing of the cashier session.
-
EndDatetime: string
(date-time)
The end date and time for the cashier session.
-
SessionId(required): string
Title:
Session ID
Maximum Length:50
The unique identifier for the cashier session. -
SessionStatus(required): string
Maximum Length:
10
The status of the cashier session, which can be opened, suspended, or closed. -
StartDatetime: string
(date-time)
The start date and time for the cashier session.
-
UserName(required): 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 time lines resource is used to save the cashier session detail of open and close datetime.
Show Source
Nested Schema : publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for the agency that receives incoming customer payments. -
EndDatetime: string
(date-time)
The end date and time for the cashier session line.
-
LineNumber: integer
(int32)
The unique identifier for the cashier session line number.
-
SessionId: string
Maximum Length:
50
The unique identifier for the cashier session. -
StartDatetime: string
(date-time)
The start date and time for the cashier session line.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorCashDrawerSessions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for the agency that receives incoming customer payments. -
BegBalanceAmount: number
Default Value:
0
The cash amount that is available in the cash drawer at the beginning of the cashier session. -
BnpCashDrawerSessionTimeView: array
Cash Drawer Sessions Time Lines
Title:
Cash Drawer Sessions Time Lines
The cash drawer sessions time lines resource is used to save the cashier session detail of open and close datetime. -
CashierId: string
Title:
Cashier ID
Maximum Length:50
The unique identifier for the cashier. -
CurrencyCode: string
Maximum Length:
3
The currency code of coins and bills in the cash drawer. -
DrawerId: string
Maximum Length:
30
The unique identifier for the cash drawer. -
EndBalanceAmount: number
The cash amount that is available in the cash drawer at the closing of the cashier session.
-
EndDatetime: string
(date-time)
The end date and time for the cashier session.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SessionId: string
Title:
Session ID
Maximum Length:50
The unique identifier for the cashier session. -
SessionStatus: string
Maximum Length:
10
The status of the cashier session, which can be opened, suspended, or closed. -
StartDatetime: string
(date-time)
The start date and time for the cashier session.
-
UserName: 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 time lines resource is used to save the cashier session detail of open and close datetime.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for the agency that receives incoming customer payments. -
EndDatetime: string
(date-time)
The end date and time for the cashier session line.
-
LineNumber: integer
(int32)
The unique identifier for the cashier session line number.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SessionId: string
Maximum Length:
50
The unique identifier for the cashier session. -
StartDatetime: string
(date-time)
The start date and time for the cashier session line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BnpCashDrawerSessionTimeView
-
Parameters:
- publicSectorCashDrawerSessionsUniqID:
$request.path.publicSectorCashDrawerSessionsUniqID
The cash drawer sessions time lines resource is used to save the cashier session detail of open and close datetime. - publicSectorCashDrawerSessionsUniqID: