Jump to

• Request
• Response

Get a cash drawer payment

get

/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerPayments/{publicSectorCashDrawerPaymentsUniqID}

Request

Path Parameters

• publicSectorCashDrawerPaymentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, ReceiptNumber and ReceiptLineNumber ---for the Cash Drawer Payments resource and used to uniquely identify an instance of Cash Drawer Payments. The client should not generate the hash key value. Instead, the client should query on the Cash Drawer Payments collection resource with a filter on the primary key values in order to navigate to a specific instance of Cash Drawer Payments.
  
  For example: publicSectorCashDrawerPayments?q=AgencyId=<value1>;ReceiptNumber=<value2>;ReceiptLineNumber=<value3>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

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.

Body ()

Root Schema : publicSectorCashDrawerPayments-item-response

Type: object

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top