Get Cash Management Receptacle Templates
post
/config/sim/v1/setup/getCashManagementReceptacleTemplates
Request
Supported Media Types
- application/json
- multipart/form-data
Get request Body
Root Schema : CMTemplateGetRequest
Type:
objectThe input body model that needs to be given for GET request.
Show Source
-
include:
string
Objects included in response
-
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits translated strings returned
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported
-
orderBy:
string
Sorts the response by the specified field name and sort order.
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of Cash Management Templates of the organization
Root Schema : CMTemplateGetResponse
Type:
Show Source
object-
count(required):
integer
Current response recount count.Example:
1 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of cash management template objects of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of cash management template objects of the organization.
Show Source
-
Array of:
object CMTemplates
Model for Cash Management Template Object
Nested Schema : CMTemplates
Type:
objectModel for Cash Management Template Object
Show Source
-
cashCountThresholdObjNum(required):
integer
Determines Cash Count Threshold Set Object number that a receptacle session uses.It only affects the behavior of types 1, 2 and 3 and 5.Example:
1 -
cashDepositRoutingObjNum(required):
number
Object number of the destination receptacle (safe or bank deposit) session to receive funds that transfer from a receptacle session as part of a cash deposit operation. It only affects the behavior of types 2 and 3.Example:
1 -
cashPullDestinationObjNum(required):
integer
Object number of destination receptacle into which funds from cash pull operations will transfer; if you select None, funds do not transfer and ownership remains with the receptacle session.It only affects the behavior of types 2 and 3.Example:
1 -
cashPullThresholdObjNum(required):
integer
Determines object number the Cash Pull Threshold Set that a receptacle session uses. It only affects the behavior of types 2 and 3.Example:
1 -
classDetails(required):
array classDetails
Used to create additional currency classes (alternate currency such as Dollar, Peso, Euro, or Pounds, or non-currency such as gift cards) for a receptacle session or operation. You can add/modify alternate classes for types 0, 2, 3, 4 and 5 only. You cannot add a duplicate class entry.
-
classExclusions(required):
array classExclusions
To specify currency classes that cannot be used in till(Type 2) and server bank(Type 3) receptacles created with the receptacle template. You cannot add a duplicate class exclusion entry.
-
closeOnCountCompletion(required):
boolean
Select this option to have the application attempt to automatically reconcile the receptacle session upon completion of the count. This process transfers funds from the receptacle session to the sessions designated under Starting Amount Source and Cash Deposit Routing to bring the session to zero. Deselect this option to leave the session open after the count completes. The workstation operator must then manually reconcile all funds and close the receptacle.It only affects the behavior of types 2 and 3.Example:
true -
countSheetObjNum(required):
integer
Determines the Count Sheet object number that is used to count the receptacle.It only affects the behavior of types 1, 2 and 3 and 5.Example:
1 -
description(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
hierUnitId(required):
integer
Unique reference of the hierarchy unit where the Cash Management Template is configured.Example:
3599 -
hierUnitName(required):
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
maximum(required):
number
Determines the largest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of types 4 and 5.Example:
100 -
minimum(required):
number
Determines the lowest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of type 5.Example:
10 -
name(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
objectNum(required):
integer
Object Number of the Cash Management Template.Example:
1 -
parLevelObjNum(required):
integer
Defines the object number of PAR Level Set (quantity to maintain of each currency denomination) to use for the safe session. It only affects the behavior of type 1.Example:
1 -
parLevels(required):
array parLevels
Used to add additional PAR Levelsation. You can add/ modify alternate PAR Levels for type 1 only. You cannot add a duplicate PAR Level entry.
-
promptForStartingAmount(required):
boolean
Select this option to prompt the workstation operator to enter the starting amount for the receptacle session upon opening. When you select this option, the application ignores the value in the starting amount field. It only affects the behavior of types 2 and 3.Example:
true -
recepatacleType(required):
integer
Type of receptacle template. Range=>[0-5] | Receptacle Type | Receptacle Name | | 0 | None | | 1 | Safe | | 2 | Till | | 3 | Server Bank | | 4 | Bank Deposit | | 5 | Petty Cash |Example:
1 -
startingAmount(required):
integer
The initial currency value of the session upon opening. Range => [0 - 999999999999]. It only affects the behavior of types 2 and 3Example:
10000 -
startingAmountSourceObjNum(required):
integer
Determines where the starting amount for the session originates. The source receptacle session should be active session of type 1 - Safe. It only affects the behavior of types 2 and 3. Required for type 2.Example:
1
Nested Schema : classDetails
Type:
arrayUsed to create additional currency classes (alternate currency such as Dollar, Peso, Euro, or Pounds, or non-currency such as gift cards) for a receptacle session or operation. You can add/modify alternate classes for types 0, 2, 3, 4 and 5 only. You cannot add a duplicate class entry.
Show Source
Nested Schema : classExclusions
Type:
arrayTo specify currency classes that cannot be used in till(Type 2) and server bank(Type 3) receptacles created with the receptacle template. You cannot add a duplicate class exclusion entry.
Show Source
Nested Schema : TranslatedString_Name
Type:
objectAdditional Properties Allowed
Show Source
A group of translated names
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : parLevels
Type:
arrayUsed to add additional PAR Levelsation. You can add/ modify alternate PAR Levels for type 1 only. You cannot add a duplicate PAR Level entry.
Show Source
Nested Schema : ClassDetails
Type:
Show Source
object-
cashDepositRoutingObjNum:
number
Object number of the destination receptacle (safe or bank deposit) session to receive funds that transfer from a receptacle session as part of a cash deposit operation. It only affects the behavior of types 2 and 3Example:
1 -
cashPullDestinationObjNum:
integer
Object number of destination receptacle into which funds from cash pull operations will transfer; if you select None, funds do not transfer and ownership remains with the receptacle session.It only affects the behavior of types 2 and 3.Example:
1 -
cashPullThresholdObjNum:
integer
Determines object number the Cash Pull Threshold Set that a receptacle session uses. It only affects the behavior of types 2 and 3.Example:
1 -
classObjNum(required):
integer
Object number of additional currency class.Example:
1 -
maximum:
number
Determines the largest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of types 4 and 5.Example:
100 -
minimum:
number
Determines the lowest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of type 5.Example:
10 -
promptForStartingAmount:
boolean
Select this option to prompt the workstation operator to enter the starting amount for the receptacle session upon opening. When you select this option, the application ignores the value in the starting amount field. It only affects the behavior of types 2 and 3.Example:
true -
startingAmount:
integer
The initial currency value of the session upon opening. Range => [0 - 9999999999]. It only affects the behavior of types 2 and 3Example:
10000 -
startingAmountSourceObjNum:
integer
Determines where the starting amount for the session originates. The source receptacle session should be active session of type 1 - Safe. It only affects the behavior of types 2 and 3. Required for type 2.Example:
1
Nested Schema : ClassExclusions
Type:
Show Source
object-
classObjNum(required):
integer
Object number of currency class to be excludedExample:
1
Nested Schema : PARLevels
Type:
Show Source
object-
parLevelObjNum(required):
integer
Object number of PAR Level SetExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html