Create a cash drawer
post
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers
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 identifier for the agency that receives incoming customer payments. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The currency code of coins and bills in the cash drawer. -
Description: string
Title:
Description
Maximum Length:100
The description of the cash drawer. -
DrawerId: string
Title:
Cash Drawer ID
Maximum Length:30
The unique identifier for the cash drawer. -
EnabledFlag: string
Title:
Enabled
Maximum Length:3
Indicates whether the cash drawer is available to be used. -
MultipleSessionFlag: string
Title:
Cash Reconciliation
Maximum Length:3
Indicates whether the cash drawer can be used in more than one session. -
ToleranceAmount: number
Title:
Tolerance Amount
The amount of the acceptable cash shortage.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorCashDrawers-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The identifier for the agency that receives incoming customer payments. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the agency. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the cash drawer was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The currency code of coins and bills in the cash drawer. -
Description: string
Title:
Description
Maximum Length:100
The description of the cash drawer. -
DrawerId: string
Title:
Cash Drawer ID
Maximum Length:30
The unique identifier for the cash drawer. -
EnabledFlag: string
Title:
Enabled
Maximum Length:3
Indicates whether the cash drawer is available to be used. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The last date and time that the cash drawer was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the cash drawer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MultipleSessionFlag: string
Title:
Cash Reconciliation
Maximum Length:3
Indicates whether the cash drawer can be used in more than one session. -
ToleranceAmount: number
Title:
Tolerance Amount
The amount of the acceptable cash shortage.
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.