Jump to

• Request
• Response

Create a refund line

post

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine

Request

Path Parameters

• RefundHistoryKey(required): integer(int64)
  The unique identifier for the refund transaction.

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.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier of the agency associated with the refund transaction.
• Classification: string
  Maximum Length: 3

  Source application that generated the fee.
• FarCashReceiptId: integer (int64)
  Receipt identifier created in Oracle Receivables.
• FarReceiptStatus: string
  Maximum Length: 30

  Status of the receipt creation in Oracle Receivables.
• ItemDescription: string
  Maximum Length: 100

  Item description used for the original payment for this item.
• ItemLine: integer (int32)
  Item line used for the original payment for this item.
• ItemName: string
  Maximum Length: 30

  Item name used for the original payment for this item.
• ItemPaymentAmount: number
  Title: Item Payment Amount

  Payment amount from the original payment transaction for this item.
• ItemPaymentCurrency: string
  Title: Item Payment Currency

  Maximum Length: 3

  Currency code used from the original payment transaction for this item.
• ItemRefundAmount: number
  Refund amount.
• ItemRefundCurrency: string
  Maximum Length: 3

  Refund currency.
• ItemRefundReferencePrimary: string
  Maximum Length: 50

  Attribute identifying item level reference value provided by the refund source application.
• ItemRefundReferenceSecondary: string
  Maximum Length: 50

  Additional attribute identifying item level reference value provided by the refund source application.
• RecordId: string
  Title: Record ID

  Maximum Length: 50

  Source application's record ID identifier.
• RecordTypeId: string
  Maximum Length: 30

  Source application's record type identifier.
• RefundRecordKey: integer (int32)
  The auto-sequencing generated value for the unique identification of each line row.

{
    "type":"object",
    "properties":{
        "ItemLine":{
            "type":"integer",
            "description":"Item line used for the original payment for this item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the refund transaction.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "ItemRefundReferencePrimary":{
            "maxLength":50,
            "type":"string",
            "description":"Attribute identifying item level reference value provided by the refund source application.",
            "nullable":false
        },
        "ItemPaymentCurrency":{
            "title":"Item Payment Currency",
            "maxLength":3,
            "type":"string",
            "description":"Currency code used from the original payment transaction for this item.",
            "nullable":true
        },
        "ItemRefundAmount":{
            "type":"number",
            "description":"Refund amount.",
            "nullable":false
        },
        "ItemDescription":{
            "maxLength":100,
            "type":"string",
            "description":"Item description used for the original payment for this item.",
            "nullable":true
        },
        "ItemRefundReferenceSecondary":{
            "maxLength":50,
            "type":"string",
            "description":"Additional attribute identifying item level reference value provided by the refund source application.",
            "nullable":true
        },
        "FarReceiptStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the receipt creation in Oracle Receivables.",
            "nullable":true
        },
        "ItemPaymentAmount":{
            "title":"Item Payment Amount",
            "type":"number",
            "description":"Payment amount from the original payment transaction for this item.",
            "nullable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Source application that generated the fee.",
            "nullable":false
        },
        "ItemRefundCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"Refund currency.",
            "nullable":false
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"Source application's record type identifier.",
            "nullable":true
        },
        "ItemName":{
            "maxLength":30,
            "type":"string",
            "description":"Item name used for the original payment for this item.",
            "nullable":true
        },
        "RefundRecordKey":{
            "type":"integer",
            "description":"The auto-sequencing generated value for the unique identification of each line row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "RecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "description":"Source application's record ID identifier.",
            "nullable":true
        },
        "FarCashReceiptId":{
            "type":"integer",
            "description":"Receipt identifier created in Oracle Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorPaymentRefunds-RefundHistoryLine-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier of the agency associated with the refund transaction.
• Classification: string
  Maximum Length: 3

  Source application that generated the fee.
• FarCashReceiptId: integer (int64)
  Receipt identifier created in Oracle Receivables.
• FarReceiptStatus: string
  Maximum Length: 30

  Status of the receipt creation in Oracle Receivables.
• ItemDescription: string
  Maximum Length: 100

  Item description used for the original payment for this item.
• ItemLine: integer (int32)
  Item line used for the original payment for this item.
• ItemName: string
  Maximum Length: 30

  Item name used for the original payment for this item.
• ItemPaymentAmount: number
  Title: Item Payment Amount

  Payment amount from the original payment transaction for this item.
• ItemPaymentCurrency: string
  Title: Item Payment Currency

  Maximum Length: 3

  Currency code used from the original payment transaction for this item.
• ItemRefundAmount: number
  Refund amount.
• ItemRefundCurrency: string
  Maximum Length: 3

  Refund currency.
• ItemRefundReferencePrimary: string
  Maximum Length: 50

  Attribute identifying item level reference value provided by the refund source application.
• ItemRefundReferenceSecondary: string
  Maximum Length: 50

  Additional attribute identifying item level reference value provided by the refund source application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordId: string
  Title: Record ID

  Maximum Length: 50

  Source application's record ID identifier.
• RecordTypeId: string
  Maximum Length: 30

  Source application's record type identifier.
• RefundHistoryKey: integer (int64)
  Read Only: true

  The parent history key.
• RefundRecordKey: integer (int32)
  The auto-sequencing generated value for the unique identification of each line row.

{
    "type":"object",
    "properties":{
        "ItemLine":{
            "type":"integer",
            "description":"Item line used for the original payment for this item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the refund transaction.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ItemRefundReferencePrimary":{
            "maxLength":50,
            "type":"string",
            "description":"Attribute identifying item level reference value provided by the refund source application.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemPaymentCurrency":{
            "title":"Item Payment Currency",
            "maxLength":3,
            "type":"string",
            "description":"Currency code used from the original payment transaction for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemRefundAmount":{
            "type":"number",
            "description":"Refund amount.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":100,
            "type":"string",
            "description":"Item description used for the original payment for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemRefundReferenceSecondary":{
            "maxLength":50,
            "type":"string",
            "description":"Additional attribute identifying item level reference value provided by the refund source application.",
            "nullable":true,
            "x-queryable":true
        },
        "FarReceiptStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the receipt creation in Oracle Receivables.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemPaymentAmount":{
            "title":"Item Payment Amount",
            "type":"number",
            "description":"Payment amount from the original payment transaction for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundHistoryKey":{
            "type":"integer",
            "description":"The parent history key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Source application that generated the fee.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemRefundCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"Refund currency.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"Source application's record type identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":30,
            "type":"string",
            "description":"Item name used for the original payment for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RefundRecordKey":{
            "type":"integer",
            "description":"The auto-sequencing generated value for the unique identification of each line row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "RecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "description":"Source application's record ID identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "FarCashReceiptId":{
            "type":"integer",
            "description":"Receipt identifier created in Oracle Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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