Get all cash drawer payments
get
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments
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 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:- 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.
- simpleSearchFinder: Finds a cash drawer payment with the specified primary key criteria.
Finder Variables:- value; string; Finds a cash drawer payment with the specified primary key value.
- PrimaryKey: Finds a cash drawer payment 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:- ActualAmount; number; The actual amount of the transaction after the cash drawer is reconciled.
- AgencyId; integer; The identifier for the agency receiving incoming customer payments.
- AmountOverage; number; The amount more than the transaction amount after the cash drawer is reconciled.
- AmountShortage; number; The amount less than the transaction amount after the cash drawer is reconciled.
- BusinessEntityPartyId; integer; The unique identifier for the business entity party associated with this transaction.
- BusinessEntityProfileId; integer; The unique identifier for the business entity profile associated with this transaction.
- CashierId; string; The unique identifier for the cashier.
- ChangeAmount; number; The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due.
- CheckDate; string; The date that the check was received from the payer.
- CheckNumber; string; The number of the check that was received from the payer.
- CheckoutId; string; The unique identifier for the checkout data.
- Comments; string; Comments of the cash drawer payment.
- CreationDate; string; The date and time that the agency was created.
- CreditAmountApplied; number; Amount of credit applied to the payment.
- CreditAmountAvailable; number; Amount available to apply payment on account credit.
- CreditAppliedFlag; string; Payment on account credit is applied.
- CurrencyCode; string; The currency code of coins and bills in the cash drawer.
- DepositSlipNumber; string; The number of the deposit slip used in a deposit transaction.
- Description; string; The description of the cash drawer.
- DrawerId; string; The unique identifier for the cash drawer.
- LastUpdateDate; string; The last date and time that the agency was updated.
- LineAmount; number; That dollar amount that applies to a line item.
- Meaning; string; Identifies the meaning that is associated with the payment method value.
- PartyId; integer; The unique identifier for the customer associated with the payment.
- PayerAddress; string; The address of the person who made the payment.
- PayerName; string; The name of the person who made the payment.
- PaymentAmount; number; The total sum of money due for payment.
- PaymentMethodCode; string; Type of payment selected during checkout, for example, cash and check.
- PaymentReferenceId; string; The 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.
- PaymentStatus; string; Indicates the status of a payment.
- PaymentStatusDesc; string; Describes the status of a payment.
- PrimaryId; string; The unique identifier for the primary document used to identify the payer of a cash drawer check payment.
- ProfileId; integer; The unique identifier for the profile.
- PublishedStatusCode; string; Indicates whether reconciliation activity has been created for the transaction by code value.
- PublishedStatusName; string; Indicates whether reconciliation activity has been created for the transaction by name value.
- ReceiptDate; string; The date that the receipt was created.
- ReceiptLineNumber; integer; The line number of the receipt associated with the payment.
- ReceiptNumber; string; The number of the receipt for the cash drawer payment.
- ReceiptStatus; string; The status of the receipt associated with the payment.
- ReconHistoryKey; integer; Unique identifier for each bank reconciliation activity record.
- ReconcileId; integer; The unique identifier for the payment reconciliation.
- ReversalFlag; string; Specifies whether the record is a reversal of a payment.
- ReversalReasonCd; string; Identifies the reason code for a payment reversal.
- ReversalTransTypeDesc; string; Describes the reversal transaction type.
- ReversalTransactionType; string; Indicates type of reversal transaction.
- SecondaryId; string; The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.
- SessionId; string; The unique identifier for the cashier session.
- TotalTendAmount; number; The 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.
- UnappliedFlag; string; Identifies unapplied payment record.
-
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:
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 : publicSectorCashDrawerPayments
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 : publicSectorCashDrawerPayments-item-response
Type:
Show Source
object
-
ActualAmount: number
Title:
Actual Amount
The actual amount of the transaction after the cash drawer is reconciled. -
AgencyId: integer
(int32)
The identifier for the agency receiving incoming customer payments.
-
AmountOverage: number
Title:
Overage Amount
The amount more than the transaction amount after the cash drawer is reconciled. -
AmountShortage: number
Title:
Shortage Amount
The amount less than the transaction amount after the cash drawer is reconciled. -
BusinessEntityPartyId: integer
(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessEntityProfileId: integer
(int64)
The unique identifier for the business entity profile associated with this transaction.
-
CashierId: string
Maximum Length:
50
The unique identifier for the cashier. -
ChangeAmount: number
Title:
Change Due
The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due. -
CheckDate: string
(date)
Title:
Check Date
The date that the check was received from the payer. -
CheckNumber: string
Title:
Check Number
Maximum Length:10
The number of the check that was received from the payer. -
CheckoutId: string
Maximum Length:
50
The unique identifier for the checkout data. -
Comments: string
Title:
Comments
Maximum Length:240
Comments of the cash drawer payment. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the agency was created. -
CreditAmountApplied: number
Default Value:
0
Amount of credit applied to the payment. -
CreditAmountAvailable: number
Default Value:
0
Amount available to apply payment on account credit. -
CreditAppliedFlag: string
Maximum Length:
1
Default Value:N
Payment on account credit is applied. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The currency code of coins and bills in the cash drawer. -
DepositSlipNumber: string
Maximum Length:
50
The number of the deposit slip used in a deposit transaction. -
Description: string
Maximum Length:
100
The description of the cash drawer. -
DrawerId: string
Maximum Length:
30
The unique identifier for the cash drawer. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last date and time that the agency was updated. -
LineAmount: number
Title:
Amount
That dollar amount that applies to a line item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Read Only:
true
Maximum Length:80
Identifies the meaning that is associated with the payment method value. -
PartyId: integer
(int64)
The unique identifier for the customer associated with the payment.
-
PayerAddress: string
Title:
Address
Maximum Length:240
The address of the person who made the payment. -
PayerName: string
Title:
Payer Name
Maximum Length:100
The name of the person who made the payment. -
PaymentAmount: number
Title:
Recorded Amount
The total sum of money due for payment. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
Type of payment selected during checkout, for example, cash and check. -
PaymentReferenceId: string
Title:
Payment Reference ID
Maximum Length:50
The 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. -
PaymentStatus: string
Maximum Length:
30
Default Value:ORA_PAID
Indicates the status of a payment. -
PaymentStatusDesc: string
Read Only:
true
Maximum Length:80
Describes the status of a payment. -
PrimaryId: string
Title:
Primary ID
Maximum Length:3
The unique identifier for the primary document used to identify the payer of a cash drawer check payment. -
ProfileId: integer
(int64)
The unique identifier for the profile.
-
PublishedStatusCode: string
Maximum Length:
30
Default Value:ORA_UNPUBLISHED
Indicates whether reconciliation activity has been created for the transaction by code value. -
PublishedStatusName: string
Read Only:
true
Maximum Length:80
Indicates whether reconciliation activity has been created for the transaction by name value. -
ReceiptDate: string
(date)
Title:
Receipt Date
The date that the receipt was created. -
ReceiptLineNumber: integer
(int32)
Title:
Line Number
The line number of the receipt associated with the payment. -
ReceiptNumber: string
Title:
Receipt Number
Maximum Length:50
The number of the receipt for the cash drawer payment. -
ReceiptStatus: string
Maximum Length:
3
The status of the receipt associated with the payment. -
ReconcileId: integer
(int64)
The unique identifier for the payment reconciliation.
-
ReconHistoryKey: integer
(int64)
Unique identifier for each bank reconciliation activity record.
-
ReversalFlag: string
Maximum Length:
1
Default Value:N
Specifies whether the record is a reversal of a payment. -
ReversalReasonCd: string
Maximum Length:
30
Identifies the reason code for a payment reversal. -
ReversalTransactionType: string
Title:
Reversal Transaction Type
Maximum Length:30
Default Value:ORA_NONE
Indicates type of reversal transaction. -
ReversalTransTypeDesc: string
Read Only:
true
Maximum Length:80
Describes the reversal transaction type. -
SecondaryId: string
Title:
Secondary ID
Maximum Length:3
The unique identifier for the secondary document used to identify the payer of a cash drawer check payment. -
SessionId: string
Maximum Length:
50
The unique identifier for the cashier session. -
TotalTendAmount: number
Title:
Amount Tendered
The 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. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies unapplied payment record.
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.