Get all cash drawer payments
get
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:- RowFinder: Finds a cash drawer payment with the search value. Finder Variables:
- agencyId; string; The unique identifier of the agency.
- paymentMethodCode; string; Type of payment selected during checkout, for example, cash and check.
- sessionId; string; The unique identifier for the cashier session.
- PrimaryKey: Finds a cash drawer payment with the specified primary key criteria. Finder Variables:
- AgencyId; integer; The unique identifier of the agency.
- ReceiptLineNumber; integer; The line number of the receipt associated with the payment.
- ReceiptNumber; string; The number of the receipt for the cash drawer payment.
- RowFinder: Finds a cash drawer payment with the search value. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCashDrawerPayments
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates 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(optional):
array Items
Title:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCashDrawerPayments-item
Type:
Show Source
object-
ActualAmount(optional):
number
Title:
Actual AmountThe actual amount of the transaction after the cash drawer is reconciled. -
AgencyId(optional):
integer(int64)
The identifier for the agency receiving incoming customer payments.
-
AmountOverage(optional):
number
Title:
Overage AmountThe amount more than the transaction amount after the cash drawer is reconciled. -
AmountShortage(optional):
number
Title:
Shortage AmountThe amount less than the transaction amount after the cash drawer is reconciled. -
BusinessEntityPartyId(optional):
integer(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessEntityProfileId(optional):
integer(int64)
The unique identifier for the business entity profile associated with this transaction.
-
CashierId(optional):
string
Maximum Length:
50The unique identifier for the cashier. -
ChangeAmount(optional):
number
Title:
Change DueThe amount of money to be handed back to the payer if the payment received from the payer is more than the amount due. -
CheckDate(optional):
string(date)
Title:
Check DateThe date that the check was received from the payer. -
CheckNumber(optional):
string
Title:
Check NumberMaximum Length:10The number of the check that was received from the payer. -
CheckoutId(optional):
string
Maximum Length:
50The unique identifier for the checkout data. -
Comments(optional):
string
Title:
CommentsMaximum Length:240Comments of the cash drawer payment. -
CreatedBy(optional):
string
Maximum Length:
64The user who created the agency. -
CreationDate(optional):
string(date-time)
The date and time that the agency was created.
-
CurrencyCode(optional):
string
Title:
CurrencyMaximum Length:3The currency code of coins and bills in the cash drawer. -
DepositSlipNumber(optional):
string
Maximum Length:
50The number of the deposit slip used in a deposit transaction. -
Description(optional):
string
Maximum Length:
100The description of the cash drawer. -
DrawerId(optional):
string
Maximum Length:
30The unique identifier for the cash drawer. -
LastUpdateDate(optional):
string(date-time)
The last date and time that the agency was updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The user who last updated the agency. -
LineAmount(optional):
number
Title:
AmountThat dollar amount that applies to a line item. -
links(optional):
array Items
Title:
ItemsLink Relations -
Meaning(optional):
string
Maximum Length:
80Identifies the meaning that is associated with the payment method value. -
PartyId(optional):
integer(int64)
The unique identifier for the customer associated with the payment.
-
PayerAddress(optional):
string
Title:
AddressMaximum Length:240The address of the person who made the payment. -
PayerName(optional):
string
Title:
Payer NameMaximum Length:100The name of the person who made the payment. -
PaymentAmount(optional):
number
Title:
Recorded AmountThe total sum of money due for payment. -
PaymentMethodCode(optional):
string
Title:
Payment MethodMaximum Length:30Type of payment selected during checkout, for example, cash and check. -
PaymentReferenceId(optional):
string
Title:
Payment Reference IDMaximum Length:50The unique identifier for the reference value, which is created by the Payment Engine and is sent to the Payment Processor, Trust Account, and Cash Drawer as pass through data. -
PrimaryId(optional):
string
Title:
Primary IDMaximum Length:3The unique identifier for the primary document used to identify the payer of a cash drawer check payment. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile.
-
ReceiptDate(optional):
string(date)
Title:
Receipt DateThe date that the receipt was created. -
ReceiptLineNumber(optional):
integer(int64)
Title:
Line NumberThe line number of the receipt associated with the payment. -
ReceiptNumber(optional):
string
Title:
Receipt NumberMaximum Length:50The number of the receipt for the cash drawer payment. -
ReceiptStatus(optional):
string
Maximum Length:
3The status of the receipt associated with the payment. -
ReconcileId(optional):
integer(int64)
The unique identifier for the payment reconciliation.
-
SecondaryId(optional):
string
Title:
Secondary IDMaximum Length:3The unique identifier for the secondary document used to identify the payer of a cash drawer check payment. -
SessionId(optional):
string
Maximum Length:
50The unique identifier for the cashier session. -
TotalTendAmount(optional):
number
Title:
Amount TenderedThe total sum of money received in payment from the payer. If this amount is more than the amount due, the difference is handed back to the payer.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.