Get all cash drawer reconciliations
get
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcils
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a cash drawer reconciliation with the specified primary key criteria.
Finder Variables:- ReconcileId; integer; The unique identifier for the cash drawer reconciliation.
- PrimaryKey: Finds a cash drawer reconciliation with the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The identifier for the agency that receives incoming customer payments.
- BeginningBalance; number; The initial balance amount for the cash drawer session.
- CashActual; number; The actual cash amount for this session.
- CashOverage; number; The cash overage amount for this session after reconciliation.
- CashRecord; number; The recorded cash amount for this session.
- CashShortage; number; The cash shortage amount for this session after reconciliation.
- Comments; string; Remarks or additional information for the cash drawer session.
- CreatedBy; string; The user who created the agency.
- CreationDate; string; The date and time that the agency was created.
- CsckActual; number; The recorded cashier check amount for this session.
- CsckOverage; number; The cashier check overage amount for this session after reconciliation.
- CsckRecord; number; The actual cashier check amount for this session.
- CsckShortage; number; The cashier check shortage amount for this session after reconciliation.
- CurrencyCode; string; The currency code of coins and bills in the cash drawer.
- DrawerId; string; The unique identifier of the cash drawer.
- LastUpdateDate; string; The last date and time that the agency was updated.
- LastUpdatedBy; string; The user who last updated the agency.
- MordActual; number; The recorded money order amount for this session.
- MordOverage; number; The money order overage amount for this session after reconciliation.
- MordRecord; number; The actual money order amount for this session.
- MordShortage; number; The money order shortage amount for this session after reconciliation.
- PrckActual; number; The recorded personal check amount for this session.
- PrckOverage; number; The personal check overage amount for this session after reconciliation.
- PrckRecord; number; The actual personal check amount for this session.
- PrckShortage; number; The personal check shortage amount for this session after reconciliation.
- ReconcileDate; string; The date of the cashier session reconciliation.
- ReconcileId; integer; The unique identifier for the cashier session reconciliation.
- ReconcileStatus; string; The status of the cash drawer reconciliation, which is Reconciled or Unreconciled.
- SessionId; string; The unique identifier for the cash drawer session.
- TotalActual; number; The total recorded payment amount collected for the cash drawer session.
- TotalRecord; number; The total actual payment amount collected for the cash drawer session.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : publicSectorCashDrawReconcils
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCashDrawReconcils-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The identifier for the agency that receives incoming customer payments.
-
BeginningBalance: number
The initial balance amount for the cash drawer session.
-
CashActual: number
The actual cash amount for this session.
-
CashOverage: number
The cash overage amount for this session after reconciliation.
-
CashRecord: number
The recorded cash amount for this session.
-
CashShortage: number
The cash shortage amount for this session after reconciliation.
-
Comments: string
Maximum Length:
240
Remarks or additional information for the cash drawer session. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the agency. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the agency was created. -
CsckActual: number
The recorded cashier check amount for this session.
-
CsckOverage: number
The cashier check overage amount for this session after reconciliation.
-
CsckRecord: number
The actual cashier check amount for this session.
-
CsckShortage: number
The cashier check shortage amount for this session after reconciliation.
-
CurrencyCode: string
Maximum Length:
3
The currency code of coins and bills in the cash drawer. -
DrawerId: string
Maximum Length:
30
The unique identifier of the cash drawer. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last date and time that the agency was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the agency. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MordActual: number
The recorded money order amount for this session.
-
MordOverage: number
The money order overage amount for this session after reconciliation.
-
MordRecord: number
The actual money order amount for this session.
-
MordShortage: number
The money order shortage amount for this session after reconciliation.
-
PrckActual: number
The recorded personal check amount for this session.
-
PrckOverage: number
The personal check overage amount for this session after reconciliation.
-
PrckRecord: number
The actual personal check amount for this session.
-
PrckShortage: number
The personal check shortage amount for this session after reconciliation.
-
ReconcileDate: string
(date)
The date of the cashier session reconciliation.
-
ReconcileId: integer
(int64)
The unique identifier for the cashier session reconciliation.
-
ReconcileStatus: string
Title:
Reconciliation Status
Maximum Length:30
The status of the cash drawer reconciliation, which is Reconciled or Unreconciled. -
SessionId: string
Maximum Length:
50
The unique identifier for the cash drawer session. -
TotalActual: number
The total recorded payment amount collected for the cash drawer session.
-
TotalRecord: number
The total actual payment amount collected for the cash drawer session.
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.