REST API for Oracle Public Sector Permitting and Licensing

Get a payment line

get

/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine/{PaymentHistoryLineUniqID}

Request

Path Parameters

PaymentHistoryKey(required): integer

The unique identifier for the payment transaction.
PaymentHistoryLineUniqID(required): string

This is the hash key of the attributes which make up the composite key--- PaymentHistoryKey and ItemRecKey ---for the Payment Lines resource and used to uniquely identify an instance of Payment Lines. The client should not generate the hash key value. Instead, the client should query on the Payment Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Payment Lines.

For example: PaymentHistoryLine?q=PaymentHistoryKey=<value1>;ItemRecKey=<value2>

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.

Response

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 : publicSectorPayments-PaymentHistoryLine-item-response

Type: object

Show Source

Address1: string

Maximum Length: 240

The first line of the property address.
Address2: string

Maximum Length: 240

The second line of the property address.
Address3: string

Maximum Length: 240

The third line of the property address.
Address4: string

Maximum Length: 240

The fourth line of the property address.
AgencyId: integer

Default Value: 1

The unique identifier of the agency associated with the row.
ApplicationReferenceId: string

Maximum Length: 50

The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart.
ApplicationReferenceIdPlus: string

Maximum Length: 50

An additional key identifier passed by the consuming application.
BillAgencyId: integer (int64)

The unique identifier of the agency associated with the invoice.
BillType: string

Maximum Length: 15

Determines the default invoice values for invoice form and invoice number ID.
CaseId: string

Maximum Length: 50

The case identifier for a code enforcement fee.
City: string

Maximum Length: 60

The city of the property address.
Classification: string

Maximum Length: 3

The source application that generated the fee.
Country: string

Maximum Length: 60

The country of the property address.
County: string

Maximum Length: 60

The county of the property address.
DepartmentId: string

Maximum Length: 30

The department associated with the fee item.
FarCashReceiptId: integer (int64)

The receipt identifier created in Oracle Receivables.
FarReceiptStatus: string

Maximum Length: 30

Default Value: ORA_NONE

The status to indicate the creation of receipts in Oracle Receivables.
FeeItemId: string

Maximum Length: 30

The unique identifier for the fee item.
FeeReferenceId: string

Maximum Length: 50

The reference identifier for the fee item.
FeeReferencePuid: string

Maximum Length: 480

The PUID reference identifier for the fee item.
Invoice: string

Maximum Length: 50

The unique billing identifier.
ItemCurrency: string

Title: Item Currency

Maximum Length: 3

The currency code for both the unit price and the tax amount.
ItemDescription: string

Title: Item Description

Maximum Length: 50

The item description provided by the requesting application.
ItemLine: integer

Default Value: 0

The item line provided by the requesting application. When none is provided, it is set to zero.
ItemName: string

Maximum Length: 30

The item name provided by the requesting application.
ItemRecKey: integer

The key value for the item in the payment line.
ItemReference: string

Title: Item Reference

Maximum Length: 50

The custom reference value provided by the requesting application.
ItemTaxAmount: number

Title: Item Tax Amount

The tax amount assessed for the transaction.
ItemUnitPrice: number

Title: Item Amount

The base price of the item being paid by the payment transaction.
links: array Links

Title: Links

The link relations associated with the resource instance.
MigratedDataFlag: string

Read Only: true

Maximum Length: 3

Default Value: N

Indicates if the data is migrated from another system.
PaymentHistoryKey: integer

The unique identifier for the payment transaction.
PaymentLinePuid: string

Maximum Length: 480

The unique key identifier for the payment-related data migration transaction.
PaymentReferenceId: string

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

Maximum Length: 60

The postal code of the property address.
PostalPlus4Code: string

Maximum Length: 10

The extended postal code of the property address.
Province: string

Maximum Length: 60

The province of the property address.
RecordId: string

Title: Record ID

Maximum Length: 50

The source application's record identifier.
RecordTypeId: string

Title: Record Type

Maximum Length: 30

The source application's record type.
ReversalFlag: string

Maximum Length: 1

Default Value: N

Indicates whether the record is a reversal of a payment.
State: string

Maximum Length: 60

The state of the property address.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates if the data is migrated from another system.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemLine":{
            "type":"integer",
            "description":"The item line provided by the requesting application. When none is provided, it is set to zero.",
            "nullable":false,
            "default":0,
            "x-queryable":true
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"The unique billing identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the row.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":50,
            "type":"string",
            "description":"The item description provided by the requesting application.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "FarReceiptStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status to indicate the creation of receipts in Oracle Receivables.",
            "nullable":true,
            "default":"ORA_NONE",
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"A reference value created by the payment module and sent as pass-through data to the payment processor, trust account, and cash drawer.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentLinePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique key identifier for the payment-related data migration transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The source application that generated the fee.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record Type",
            "maxLength":30,
            "type":"string",
            "description":"The source application's record type.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":30,
            "type":"string",
            "description":"The item name provided by the requesting application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "description":"The source application's record identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemTaxAmount":{
            "title":"Item Tax Amount",
            "type":"number",
            "description":"The tax amount assessed for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "BillAgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FarCashReceiptId":{
            "type":"integer",
            "description":"The receipt identifier created in Oracle Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The reference identifier for the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitPrice":{
            "title":"Item Amount",
            "type":"number",
            "description":"The base price of the item being paid by the payment transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "BillType":{
            "maxLength":15,
            "type":"string",
            "description":"Determines the default invoice values for invoice form and invoice number ID.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCurrency":{
            "title":"Item Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code for both the unit price and the tax amount.",
            "nullable":false,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"The case identifier for a code enforcement fee.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemReference":{
            "title":"Item Reference",
            "maxLength":50,
            "type":"string",
            "description":"The custom reference value provided by the requesting application.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The extended postal code of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentHistoryKey":{
            "type":"integer",
            "description":"The unique identifier for the payment transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"The country of the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The PUID reference identifier for the fee item.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplicationReferenceIdPlus":{
            "maxLength":50,
            "type":"string",
            "description":"An additional key identifier passed by the consuming application.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"The department associated with the fee item.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversalFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the record is a reversal of a payment.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ItemRecKey":{
            "type":"integer",
            "description":"The key value for the item in the payment line.",
            "nullable":false,
            "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."
        }
    }
}