Get a payment record
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRecords/{publicSectorPaymentRecordsUniqID}
Request
Path Parameters
-
publicSectorPaymentRecordsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Payment Records resource and used to uniquely identify an instance of Payment Records. The client should not generate the hash key value. Instead, the client should query on the Payment Records collection resource in order to navigate to a specific instance of Payment Records to get the hash key.
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 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 : publicSectorPaymentRecords-item-response
Type:
Show Source
object
-
Address1: string
Read Only:
true
Maximum Length:240
First line of the payer billing address. Requires a valid street number and name. -
Address2: string
Read Only:
true
Maximum Length:240
Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3: string
Read Only:
true
Maximum Length:240
Third line of the payer billing address. -
Address4: string
Read Only:
true
Maximum Length:240
Fourth line of the payer billing address. -
AgencyId: integer
(int32)
Read Only:
true
The unique identifier of the agency associated with the payment transaction. -
AmountDue: number
Read Only:
true
Total Payment amount due that is the sum total of the amounts on payment history lines. -
BusinessEntityDbaName: string
Read Only:
true
Maximum Length:100
Doing business as name of the business making the payment. -
BusinessEntityId: string
Read Only:
true
Maximum Length:50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityName: string
Read Only:
true
Maximum Length:100
Entity name of the business making the payment. -
BusinessEntityPartyId: integer
(int64)
Read Only:
true
The unique identifier for the business entity party associated with this transaction. -
BusinessLocationId: string
Read Only:
true
Maximum Length:50
The unique identifier for the location of the business entity. -
BusinessLocationPartyId: integer
(int64)
Read Only:
true
The unique identifier for the party associated with the business entity location. -
BusinessProfileId: integer
(int64)
Read Only:
true
The unique identifier for the profile of the business entity associated with this transaction. -
Classification: string
Read Only:
true
Maximum Length:3
Source application that generated the fee. -
CreditAmountApplied: number
Read Only:
true
The amount of the credit applied to the payment. -
CreditAmountAvailable: number
Read Only:
true
The amount available to apply a payment on account credit. -
CreditAppliedFlag: string
Read Only:
true
Maximum Length:1
The payment on account credit is applied. -
CreditCardDigits: integer
(int32)
Read Only:
true
The last four digits of the credit card number used for a payment. -
CreditCardType: string
Read Only:
true
Maximum Length:4
The type of credit card used for a payment. Examples are Mastercard and Visa. -
ItemCurrency: string
Read Only:
true
Maximum Length:3
Currency code for both the unit price and tax amount. -
ItemDescription: string
Read Only:
true
Maximum Length:100
Item description provided by the requesting application. -
ItemLine: integer
(int32)
Read Only:
true
Item line provided by the requesting application. When none is provided, it is set to zero. -
ItemName: string
Read Only:
true
Maximum Length:30
Item name provided by the requesting application. -
ItemRecKey: integer
(int32)
Read Only:
true
The key value for the item in the payment line. -
ItemReference: string
Read Only:
true
Maximum Length:50
Custom reference value provided by the requesting application. -
ItemTaxAmount: number
Read Only:
true
Tax amount assessed for the transaction. -
ItemUnitPrice: number
Read Only:
true
Base price of the item being paid by the payment transaction. -
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. -
MigratedDataFlag: string
Read Only:
true
Maximum Length:3
Indicates whether the data is migrated from another system. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier for the party associated with this transaction. -
PayerAddress: string
Read Only:
true
Maximum Length:240
The address of the person who made the payment. -
PayerCity: string
Read Only:
true
Maximum Length:60
City of the payer billing address. -
PayerCounty: string
Read Only:
true
Maximum Length:60
County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail: string
Read Only:
true
Maximum Length:320
Email address of the payer for a payment transaction. -
PayerFirstName: string
Read Only:
true
Maximum Length:150
The first name of the payer for a payment transaction. -
PayerLastName: string
Read Only:
true
Maximum Length:150
The last name of the payer for a payment transaction. -
PayerMiddleName: string
Read Only:
true
Maximum Length:60
The middle name of the payer for a payment transaction. -
PayerName: string
Read Only:
true
Maximum Length:100
The name of the person who made the payment. -
PayerPhone: string
Read Only:
true
Maximum Length:60
Phone number of the person making the payment. -
PayerState: string
Read Only:
true
Maximum Length:60
State code of the payer billing address. In the U.S, this is the two-character USPS state abbreviation. For example, NY for New York. -
PaymentDate: string
(date)
Read Only:
true
Date on which the payment transaction occurred. -
PaymentHistoryKey: integer
(int64)
Read Only:
true
The unique identifier for the payment transaction. -
PaymentMethodCode: string
Read Only:
true
Maximum Length:30
Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check. -
PaymentReferenceId: string
Read Only:
true
Maximum Length:50
A reference value created by the payment module and sent as pass-through data to the payment processor, trust account, and cash drawer. -
PaymentStatus: string
Read Only:
true
Maximum Length:30
Indicates the status of the payment. -
PaymentStatusDesc: string
Read Only:
true
Maximum Length:80
Describes the payment status. -
PaymentTransactionId: string
Read Only:
true
Maximum Length:50
The unique identifier of the transaction that is received from the payment gateway or from the trust account system. -
ProfileId: integer
(int64)
Read Only:
true
The unique identifier for the profile of the user associated with this transaction. -
RecordId: string
Read Only:
true
Maximum Length:50
Source application's record identifier. -
RecordType: string
Read Only:
true
Maximum Length:100
Source application's record type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
Source application's record type identifier. -
ReversalTransactionType: string
Read Only:
true
Maximum Length:30
Indicates the type of reversal transaction. -
ReversalTransTypeDesc: string
Read Only:
true
Maximum Length:80
Describes the reversal transaction type. -
TrustAccountNumber: string
Read Only:
true
Maximum Length:30
An attribute that identifies the logical trust account number. -
UnappliedFlag: string
Read Only:
true
Maximum Length:1
Identifies an 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.