Jump to

• Request
• Response

Create a payment line

post

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

Request

Supported Media Types

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

Path Parameters

• PaymentHistoryKey: integer
  The unique identifier for the payment transaction.

Body ()

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

Root Schema : publicSectorPayments-PaymentHistoryLine-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  First line of the property address.
• Address2(optional): string
  Maximum Length: 240

  Second line of the property address.
• Address3(optional): string
  Maximum Length: 240

  Third line of the property address.
• Address4(optional): string
  Maximum Length: 240

  Fourth line of the property address.
• AgencyId(optional): integer(int64)
  The unique identifier of the agency associated with the row.
• ApplicationReferenceId(optional): string
  Maximum Length: 50

  Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart.
• ApplicationReferenceIdPlus(optional): string
  Maximum Length: 50

  Additional key identifier passed by the consuming application.
• BillAgencyId(optional): integer(int64)
  Unique identifier of the agency associated with the invoice.
• BillType(optional): string
  Maximum Length: 15

  Determines the default invoice values for invoice form and invoice number ID.
• CaseId(optional): string
  Maximum Length: 50

  Case identifier for a code enforcement fee.
• City(optional): string
  Maximum Length: 60

  City of the property address.
• Classification(optional): string
  Maximum Length: 3

  Source application that generated the fee.
• Country(optional): string
  Maximum Length: 60

  Country of the property address.
• County(optional): string
  Maximum Length: 60

  County of the property address.
• DepartmentId(optional): string
  Maximum Length: 30

  Department associated with the fee item.
• FarCashReceiptId(optional): integer(int64)
  Receipt Identifier created in Oracle Receivables.
• FarReceiptStatus(optional): string
  Maximum Length: 30

  Status to indicate creation of receipt in Oracle Receivables.
• FeeItemId(optional): string
  Maximum Length: 30

  The unique identifier for the fee item.
• FeeReferenceId(optional): string
  Maximum Length: 50

  The reference identifier for the fee item.
• FeeReferencePuid(optional): string
  Maximum Length: 480

  The PUID reference identifier for the fee item.
• Invoice(optional): string
  Maximum Length: 50

  Unique billing identifier.
• ItemCurrency(optional): string
  Title: Item Currency

  Maximum Length: 3

  Currency code for both the unit price and tax amount.
• ItemDescription(optional): string
  Title: Item Description

  Maximum Length: 50

  Item description provided by the requesting application.
• ItemLine(optional): integer(int64)
  Item line provided by the requesting application. When none is provided, it is set to zero.
• ItemName(optional): string
  Maximum Length: 30

  Item name provided by the requesting application.
• ItemRecKey(optional): integer(int64)
  The key value for the item in the payment line.
• ItemReference(optional): string
  Title: Item Reference

  Maximum Length: 50

  Custom reference value provided by the requesting application.
• ItemTaxAmount(optional): number
  Title: Item Tax Amount

  Tax amount assessed for the transaction.
• ItemUnitPrice(optional): number
  Title: Item Amount

  Base price of the item being paid by the payment transaction.
• links(optional): array Items
  Title: Items

  Link Relations
• MigratedDataFlag(optional): string
  Maximum Length: 3

  Indicates whether the data is migrated from another system.
• PaymentHistoryKey(optional): integer(int64)
  The unique identifier for the payment transaction.
• PaymentLinePuid(optional): string
  Maximum Length: 480

  The unique key identifier for the payment-related data migration transaction.
• PaymentReferenceId(optional): 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(optional): string
  Maximum Length: 60

  Postal code of the property address.
• PostalPlus4Code(optional): string
  Maximum Length: 10

  Extended postal code of the property address.
• Province(optional): string
  Maximum Length: 60

  Province of the property address.
• RecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  Source application's record identifier.
• RecordTypeId(optional): string
  Title: Record Type

  Maximum Length: 30

  Source application's record type.
• State(optional): string
  Maximum Length: 60

  State of the property address.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the property address."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the property address."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the property address."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the property address."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the row."
        },
        "ApplicationReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart."
        },
        "ApplicationReferenceIdPlus":{
            "maxLength":50,
            "type":"string",
            "description":"Additional key identifier passed by the consuming application."
        },
        "BillAgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier of the agency associated with the invoice."
        },
        "BillType":{
            "maxLength":15,
            "type":"string",
            "description":"Determines the default invoice values for invoice form and invoice number ID."
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"Case identifier for a code enforcement fee."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City of the property address."
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Source application that generated the fee."
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"Country of the property address."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"County of the property address."
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"Department associated with the fee item."
        },
        "FarCashReceiptId":{
            "format":"int64",
            "type":"integer",
            "description":"Receipt Identifier created in Oracle Receivables."
        },
        "FarReceiptStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status to indicate creation of receipt in Oracle Receivables."
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the fee item."
        },
        "FeeReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The reference identifier for the fee item."
        },
        "FeeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The PUID reference identifier for the fee item."
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"Unique billing identifier."
        },
        "ItemCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"Currency code for both the unit price and tax amount.",
            "title":"Item Currency"
        },
        "ItemDescription":{
            "maxLength":50,
            "type":"string",
            "description":"Item description provided by the requesting application.",
            "title":"Item Description"
        },
        "ItemLine":{
            "format":"int64",
            "type":"integer",
            "description":"Item line provided by the requesting application. When none is provided, it is set to zero."
        },
        "ItemName":{
            "maxLength":30,
            "type":"string",
            "description":"Item name provided by the requesting application."
        },
        "ItemRecKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key value for the item in the payment line."
        },
        "ItemReference":{
            "maxLength":50,
            "type":"string",
            "description":"Custom reference value provided by the requesting application.",
            "title":"Item Reference"
        },
        "ItemTaxAmount":{
            "type":"number",
            "description":"Tax amount assessed for the transaction.",
            "title":"Item Tax Amount"
        },
        "ItemUnitPrice":{
            "type":"number",
            "description":"Base price of the item being paid by the payment transaction.",
            "title":"Item Amount"
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the data is migrated from another system."
        },
        "PaymentHistoryKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the payment transaction."
        },
        "PaymentLinePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique key identifier for the payment-related data migration transaction."
        },
        "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."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the property address."
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"Extended postal code of the property address."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"Province of the property address."
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"Source application's record identifier.",
            "title":"Record ID"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"Source application's record type.",
            "title":"Record Type"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"State of the property address."
        },
        "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 : publicSectorPayments-PaymentHistoryLine-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  First line of the property address.
• Address2(optional): string
  Maximum Length: 240

  Second line of the property address.
• Address3(optional): string
  Maximum Length: 240

  Third line of the property address.
• Address4(optional): string
  Maximum Length: 240

  Fourth line of the property address.
• AgencyId(optional): integer(int64)
  The unique identifier of the agency associated with the row.
• ApplicationReferenceId(optional): string
  Maximum Length: 50

  Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart.
• ApplicationReferenceIdPlus(optional): string
  Maximum Length: 50

  Additional key identifier passed by the consuming application.
• BillAgencyId(optional): integer(int64)
  Unique identifier of the agency associated with the invoice.
• BillType(optional): string
  Maximum Length: 15

  Determines the default invoice values for invoice form and invoice number ID.
• CaseId(optional): string
  Maximum Length: 50

  Case identifier for a code enforcement fee.
• City(optional): string
  Maximum Length: 60

  City of the property address.
• Classification(optional): string
  Maximum Length: 3

  Source application that generated the fee.
• Country(optional): string
  Maximum Length: 60

  Country of the property address.
• County(optional): string
  Maximum Length: 60

  County of the property address.
• DepartmentId(optional): string
  Maximum Length: 30

  Department associated with the fee item.
• FarCashReceiptId(optional): integer(int64)
  Receipt Identifier created in Oracle Receivables.
• FarReceiptStatus(optional): string
  Maximum Length: 30

  Status to indicate creation of receipt in Oracle Receivables.
• FeeItemId(optional): string
  Maximum Length: 30

  The unique identifier for the fee item.
• FeeReferenceId(optional): string
  Maximum Length: 50

  The reference identifier for the fee item.
• FeeReferencePuid(optional): string
  Maximum Length: 480

  The PUID reference identifier for the fee item.
• Invoice(optional): string
  Maximum Length: 50

  Unique billing identifier.
• ItemCurrency(optional): string
  Title: Item Currency

  Maximum Length: 3

  Currency code for both the unit price and tax amount.
• ItemDescription(optional): string
  Title: Item Description

  Maximum Length: 50

  Item description provided by the requesting application.
• ItemLine(optional): integer(int64)
  Item line provided by the requesting application. When none is provided, it is set to zero.
• ItemName(optional): string
  Maximum Length: 30

  Item name provided by the requesting application.
• ItemRecKey(optional): integer(int64)
  The key value for the item in the payment line.
• ItemReference(optional): string
  Title: Item Reference

  Maximum Length: 50

  Custom reference value provided by the requesting application.
• ItemTaxAmount(optional): number
  Title: Item Tax Amount

  Tax amount assessed for the transaction.
• ItemUnitPrice(optional): number
  Title: Item Amount

  Base price of the item being paid by the payment transaction.
• links(optional): array Items
  Title: Items

  Link Relations
• MigratedDataFlag(optional): string
  Maximum Length: 3

  Indicates whether the data is migrated from another system.
• PaymentHistoryKey(optional): integer(int64)
  The unique identifier for the payment transaction.
• PaymentLinePuid(optional): string
  Maximum Length: 480

  The unique key identifier for the payment-related data migration transaction.
• PaymentReferenceId(optional): 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(optional): string
  Maximum Length: 60

  Postal code of the property address.
• PostalPlus4Code(optional): string
  Maximum Length: 10

  Extended postal code of the property address.
• Province(optional): string
  Maximum Length: 60

  Province of the property address.
• RecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  Source application's record identifier.
• RecordTypeId(optional): string
  Title: Record Type

  Maximum Length: 30

  Source application's record type.
• State(optional): string
  Maximum Length: 60

  State of the property address.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the property address."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the property address."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the property address."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the property address."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the row."
        },
        "ApplicationReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart."
        },
        "ApplicationReferenceIdPlus":{
            "maxLength":50,
            "type":"string",
            "description":"Additional key identifier passed by the consuming application."
        },
        "BillAgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier of the agency associated with the invoice."
        },
        "BillType":{
            "maxLength":15,
            "type":"string",
            "description":"Determines the default invoice values for invoice form and invoice number ID."
        },
        "CaseId":{
            "maxLength":50,
            "type":"string",
            "description":"Case identifier for a code enforcement fee."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City of the property address."
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Source application that generated the fee."
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"Country of the property address."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"County of the property address."
        },
        "DepartmentId":{
            "maxLength":30,
            "type":"string",
            "description":"Department associated with the fee item."
        },
        "FarCashReceiptId":{
            "format":"int64",
            "type":"integer",
            "description":"Receipt Identifier created in Oracle Receivables."
        },
        "FarReceiptStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status to indicate creation of receipt in Oracle Receivables."
        },
        "FeeItemId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the fee item."
        },
        "FeeReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The reference identifier for the fee item."
        },
        "FeeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The PUID reference identifier for the fee item."
        },
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"Unique billing identifier."
        },
        "ItemCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"Currency code for both the unit price and tax amount.",
            "title":"Item Currency"
        },
        "ItemDescription":{
            "maxLength":50,
            "type":"string",
            "description":"Item description provided by the requesting application.",
            "title":"Item Description"
        },
        "ItemLine":{
            "format":"int64",
            "type":"integer",
            "description":"Item line provided by the requesting application. When none is provided, it is set to zero."
        },
        "ItemName":{
            "maxLength":30,
            "type":"string",
            "description":"Item name provided by the requesting application."
        },
        "ItemRecKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key value for the item in the payment line."
        },
        "ItemReference":{
            "maxLength":50,
            "type":"string",
            "description":"Custom reference value provided by the requesting application.",
            "title":"Item Reference"
        },
        "ItemTaxAmount":{
            "type":"number",
            "description":"Tax amount assessed for the transaction.",
            "title":"Item Tax Amount"
        },
        "ItemUnitPrice":{
            "type":"number",
            "description":"Base price of the item being paid by the payment transaction.",
            "title":"Item Amount"
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the data is migrated from another system."
        },
        "PaymentHistoryKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the payment transaction."
        },
        "PaymentLinePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique key identifier for the payment-related data migration transaction."
        },
        "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."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the property address."
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"Extended postal code of the property address."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"Province of the property address."
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"Source application's record identifier.",
            "title":"Record ID"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"Source application's record type.",
            "title":"Record Type"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"State of the property address."
        },
        "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