Get a payment line data
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentLineCommunications/{PaymentHistoryKey}
Request
Path Parameters
-
PaymentHistoryKey(required): integer
The unique identifier for the payment transaction.
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(required):
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(required):
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 : publicSectorPaymentLineCommunications-item-response
Type:
Show Source
object
-
Address1: string
Read Only:
true
Maximum Length:240
First line of the property address. -
Address2: string
Read Only:
true
Maximum Length:240
Second line of the property address. -
Address3: string
Read Only:
true
Maximum Length:240
Third line of the property address. -
Address4: string
Read Only:
true
Maximum Length:240
Fourth line of the property address. -
BillAgencyId: integer
(int64)
Read Only:
true
Unique identifier of the agency associated with the invoice. -
BillType: string
Read Only:
true
Maximum Length:15
Determines the default invoice values for invoice form and invoice number ID. -
CaseId: string
Read Only:
true
Maximum Length:50
Case identifier for a code enforcement fee. -
City: string
Read Only:
true
Maximum Length:60
City of the property address. -
Classification: string
Read Only:
true
Maximum Length:80
Source application that generated the fee. -
Country: string
Read Only:
true
Maximum Length:60
Country of the property address. -
County: string
Read Only:
true
Maximum Length:60
County of the property address. -
DepartmentId: string
Title:
Department ID
Read Only:true
Maximum Length:30
Unique identifier for the department associated with the fee item. -
Invoice: string
Read Only:
true
Maximum Length:50
Unique billing identifier. -
ItemCurrency: string
Read Only:
true
Maximum Length:3
Currency code for both the unit price and tax amount. -
ItemDescription: string
Title:
Item Description
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. -
ItemRecKey: integer
(int32)
Title:
Line Number
Read Only:true
The key value for the item in the payment line. -
ItemUnitPrice: number
Title:
Item Amount
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. -
PaymentHistoryKey: integer
Read Only:
true
The unique identifier for the payment transaction. -
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. -
PostalCode: string
Read Only:
true
Maximum Length:60
Postal code of the property address. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
Extended postal code of the property address. -
Province: string
Read Only:
true
Maximum Length:60
Province of the property address. -
RecordId: string
Title:
Record ID
Read Only:true
Maximum Length:50
Unique identifier for the source application's record. -
RecordType: string
Title:
Record Type
Read Only:true
Maximum Length:100
Source application's record type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
Unique identifier for the source application's record type. -
State: string
Read Only:
true
Maximum Length:60
State of the property address.
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.