Jump to

• Request
• Response

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

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCashDrawerPayments-item

Type: object

Show Source

• 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.
• 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: 50

  The unique identifier for the cashier.
• ChangeAmount(optional): 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(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
  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(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)
  Title: Line Number

  The line number of the receipt associated with the payment.
• ReceiptNumber(optional): string
  Title: Receipt Number

  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
  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(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.

{
    "properties":{
        "ActualAmount":{
            "type":"number",
            "description":"The actual amount of the transaction after the cash drawer is reconciled.",
            "title":"Actual Amount"
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the agency receiving incoming customer payments."
        },
        "AmountOverage":{
            "type":"number",
            "description":"The amount more than the transaction amount after the cash drawer is reconciled.",
            "title":"Overage Amount"
        },
        "AmountShortage":{
            "type":"number",
            "description":"The amount less than the transaction amount after the cash drawer is reconciled.",
            "title":"Shortage Amount"
        },
        "BusinessEntityPartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the business entity party associated with this transaction."
        },
        "BusinessEntityProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the business entity profile associated with this transaction."
        },
        "CashierId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier."
        },
        "ChangeAmount":{
            "type":"number",
            "description":"The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due.",
            "title":"Change Due"
        },
        "CheckDate":{
            "format":"date",
            "type":"string",
            "description":"The date that the check was received from the payer.",
            "title":"Check Date"
        },
        "CheckNumber":{
            "maxLength":10,
            "type":"string",
            "description":"The number of the check that was received from the payer.",
            "title":"Check Number"
        },
        "CheckoutId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the checkout data."
        },
        "Comments":{
            "maxLength":240,
            "type":"string",
            "description":"Comments of the cash drawer payment.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the agency was created."
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer.",
            "title":"Currency"
        },
        "DepositSlipNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The number of the deposit slip used in a deposit transaction."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the cash drawer."
        },
        "DrawerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the agency was updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency."
        },
        "LineAmount":{
            "type":"number",
            "description":"That dollar amount that applies to a line item.",
            "title":"Amount"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies the meaning that is associated with the payment method value."
        },
        "PartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the customer associated with the payment."
        },
        "PayerAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The address of the person who made the payment.",
            "title":"Address"
        },
        "PayerName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the person who made the payment.",
            "title":"Payer Name"
        },
        "PaymentAmount":{
            "type":"number",
            "description":"The total sum of money due for payment.",
            "title":"Recorded Amount"
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of payment selected during checkout, for example, cash and check.",
            "title":"Payment Method"
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"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.",
            "title":"Payment Reference ID"
        },
        "PrimaryId":{
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the primary document used to identify the payer of a cash drawer check payment.",
            "title":"Primary ID"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile."
        },
        "ReceiptDate":{
            "format":"date",
            "type":"string",
            "description":"The date that the receipt was created.",
            "title":"Receipt Date"
        },
        "ReceiptLineNumber":{
            "format":"int64",
            "type":"integer",
            "description":"The line number of the receipt associated with the payment.",
            "title":"Line Number"
        },
        "ReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The number of the receipt for the cash drawer payment.",
            "title":"Receipt Number"
        },
        "ReceiptStatus":{
            "maxLength":3,
            "type":"string",
            "description":"The status of the receipt associated with the payment."
        },
        "ReconcileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the payment reconciliation."
        },
        "SecondaryId":{
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.",
            "title":"Secondary ID"
        },
        "SessionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session."
        },
        "TotalTendAmount":{
            "type":"number",
            "description":"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.",
            "title":"Amount Tendered"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCashDrawerPayments-item

Type: object

Show Source

• 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.
• 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: 50

  The unique identifier for the cashier.
• ChangeAmount(optional): 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(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
  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(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)
  Title: Line Number

  The line number of the receipt associated with the payment.
• ReceiptNumber(optional): string
  Title: Receipt Number

  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
  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(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.

{
    "properties":{
        "ActualAmount":{
            "type":"number",
            "description":"The actual amount of the transaction after the cash drawer is reconciled.",
            "title":"Actual Amount"
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the agency receiving incoming customer payments."
        },
        "AmountOverage":{
            "type":"number",
            "description":"The amount more than the transaction amount after the cash drawer is reconciled.",
            "title":"Overage Amount"
        },
        "AmountShortage":{
            "type":"number",
            "description":"The amount less than the transaction amount after the cash drawer is reconciled.",
            "title":"Shortage Amount"
        },
        "BusinessEntityPartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the business entity party associated with this transaction."
        },
        "BusinessEntityProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the business entity profile associated with this transaction."
        },
        "CashierId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier."
        },
        "ChangeAmount":{
            "type":"number",
            "description":"The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due.",
            "title":"Change Due"
        },
        "CheckDate":{
            "format":"date",
            "type":"string",
            "description":"The date that the check was received from the payer.",
            "title":"Check Date"
        },
        "CheckNumber":{
            "maxLength":10,
            "type":"string",
            "description":"The number of the check that was received from the payer.",
            "title":"Check Number"
        },
        "CheckoutId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the checkout data."
        },
        "Comments":{
            "maxLength":240,
            "type":"string",
            "description":"Comments of the cash drawer payment.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the agency was created."
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer.",
            "title":"Currency"
        },
        "DepositSlipNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The number of the deposit slip used in a deposit transaction."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the cash drawer."
        },
        "DrawerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the agency was updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency."
        },
        "LineAmount":{
            "type":"number",
            "description":"That dollar amount that applies to a line item.",
            "title":"Amount"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies the meaning that is associated with the payment method value."
        },
        "PartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the customer associated with the payment."
        },
        "PayerAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The address of the person who made the payment.",
            "title":"Address"
        },
        "PayerName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the person who made the payment.",
            "title":"Payer Name"
        },
        "PaymentAmount":{
            "type":"number",
            "description":"The total sum of money due for payment.",
            "title":"Recorded Amount"
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of payment selected during checkout, for example, cash and check.",
            "title":"Payment Method"
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"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.",
            "title":"Payment Reference ID"
        },
        "PrimaryId":{
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the primary document used to identify the payer of a cash drawer check payment.",
            "title":"Primary ID"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile."
        },
        "ReceiptDate":{
            "format":"date",
            "type":"string",
            "description":"The date that the receipt was created.",
            "title":"Receipt Date"
        },
        "ReceiptLineNumber":{
            "format":"int64",
            "type":"integer",
            "description":"The line number of the receipt associated with the payment.",
            "title":"Line Number"
        },
        "ReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The number of the receipt for the cash drawer payment.",
            "title":"Receipt Number"
        },
        "ReceiptStatus":{
            "maxLength":3,
            "type":"string",
            "description":"The status of the receipt associated with the payment."
        },
        "ReconcileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the payment reconciliation."
        },
        "SecondaryId":{
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.",
            "title":"Secondary ID"
        },
        "SessionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session."
        },
        "TotalTendAmount":{
            "type":"number",
            "description":"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.",
            "title":"Amount Tendered"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top