Create a cash drawer payment
post
/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCashDrawerPayments-item
Type:
Show Source
object
-
ActualAmount(optional):
number
Title:
Actual Amount
The 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 Amount
The amount more than the transaction amount after the cash drawer is reconciled. -
AmountShortage(optional):
number
Title:
Shortage Amount
The amount less than the transaction amount after the cash drawer is reconciled. -
CashierId(optional):
string
Maximum Length:
50
The unique identifier for the cashier. -
ChangeAmount(optional):
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(optional):
string(date)
Title:
Check Date
The date that the check was received from the payer. -
CheckNumber(optional):
string
Title:
Check Number
Maximum Length:10
The number of the check that was received from the payer. -
CheckoutId(optional):
string
Maximum Length:
50
The unique identifier for the checkout data. -
Comments(optional):
string
Title:
Comments
Maximum Length:240
Comments of the cash drawer payment. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the agency. -
CreationDate(optional):
string(date-time)
The date and time that the agency was created.
-
CurrencyCode(optional):
string
Title:
Currency
Maximum Length:3
The currency code of coins and bills in the cash drawer. -
DepositSlipNumber(optional):
string
Maximum Length:
50
The number of the deposit slip used in a deposit transaction. -
Description(optional):
string
Maximum Length:
100
The description of the cash drawer. -
DrawerId(optional):
string
Maximum Length:
30
The 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:
64
The user who last updated the agency. -
LineAmount(optional):
number
Title:
Amount
That dollar amount that applies to a line item. -
links(optional):
array Items
Title:
Items
Link Relations -
Meaning(optional):
string
Maximum Length:
80
Identifies 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:
Address
Maximum Length:240
The address of the person who made the payment. -
PayerName(optional):
string
Title:
Payer Name
Maximum Length:100
The name of the person who made the payment. -
PaymentAmount(optional):
number
Title:
Recorded Amount
The total sum of money due for payment. -
PaymentMethodCode(optional):
string
Title:
Payment Method
Maximum Length:30
Type of payment selected during checkout, for example, cash and check. -
PaymentReferenceId(optional):
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. -
PrimaryId(optional):
string
Maximum Length:
3
The 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 Date
The date that the receipt was created. -
ReceiptLineNumber(optional):
integer(int64)
The line number of the receipt associated with the payment.
-
ReceiptNumber(optional):
string
Maximum Length:
50
The number of the receipt for the cash drawer payment. -
ReceiptStatus(optional):
string
Maximum Length:
3
The status of the receipt associated with the payment. -
ReconcileId(optional):
integer(int64)
The unique identifier for the payment reconciliation.
-
SecondaryId(optional):
string
Maximum Length:
3
The unique identifier for the secondary document used to identify the payer of a cash drawer check payment. -
SessionId(optional):
string
Maximum Length:
50
The unique identifier for the cashier session. -
TotalTendAmount(optional):
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.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCashDrawerPayments-item
Type:
Show Source
object
-
ActualAmount(optional):
number
Title:
Actual Amount
The 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 Amount
The amount more than the transaction amount after the cash drawer is reconciled. -
AmountShortage(optional):
number
Title:
Shortage Amount
The amount less than the transaction amount after the cash drawer is reconciled. -
CashierId(optional):
string
Maximum Length:
50
The unique identifier for the cashier. -
ChangeAmount(optional):
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(optional):
string(date)
Title:
Check Date
The date that the check was received from the payer. -
CheckNumber(optional):
string
Title:
Check Number
Maximum Length:10
The number of the check that was received from the payer. -
CheckoutId(optional):
string
Maximum Length:
50
The unique identifier for the checkout data. -
Comments(optional):
string
Title:
Comments
Maximum Length:240
Comments of the cash drawer payment. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the agency. -
CreationDate(optional):
string(date-time)
The date and time that the agency was created.
-
CurrencyCode(optional):
string
Title:
Currency
Maximum Length:3
The currency code of coins and bills in the cash drawer. -
DepositSlipNumber(optional):
string
Maximum Length:
50
The number of the deposit slip used in a deposit transaction. -
Description(optional):
string
Maximum Length:
100
The description of the cash drawer. -
DrawerId(optional):
string
Maximum Length:
30
The 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:
64
The user who last updated the agency. -
LineAmount(optional):
number
Title:
Amount
That dollar amount that applies to a line item. -
links(optional):
array Items
Title:
Items
Link Relations -
Meaning(optional):
string
Maximum Length:
80
Identifies 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:
Address
Maximum Length:240
The address of the person who made the payment. -
PayerName(optional):
string
Title:
Payer Name
Maximum Length:100
The name of the person who made the payment. -
PaymentAmount(optional):
number
Title:
Recorded Amount
The total sum of money due for payment. -
PaymentMethodCode(optional):
string
Title:
Payment Method
Maximum Length:30
Type of payment selected during checkout, for example, cash and check. -
PaymentReferenceId(optional):
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. -
PrimaryId(optional):
string
Maximum Length:
3
The 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 Date
The date that the receipt was created. -
ReceiptLineNumber(optional):
integer(int64)
The line number of the receipt associated with the payment.
-
ReceiptNumber(optional):
string
Maximum Length:
50
The number of the receipt for the cash drawer payment. -
ReceiptStatus(optional):
string
Maximum Length:
3
The status of the receipt associated with the payment. -
ReconcileId(optional):
integer(int64)
The unique identifier for the payment reconciliation.
-
SecondaryId(optional):
string
Maximum Length:
3
The unique identifier for the secondary document used to identify the payer of a cash drawer check payment. -
SessionId(optional):
string
Maximum Length:
50
The unique identifier for the cashier session. -
TotalTendAmount(optional):
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.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.