Jump to

• Request
• Response
• Examples

Update a treasury offset amount

patch

/fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts/{OffsetId}

Request

Path Parameters

• OffsetId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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 ()

Root Schema : schema

Type: object

Show Source

• NetPaymentAmount: number
  Title: Net Payment Amount

  Net payment amount of the treasury offset amount.
• OffsetAmount: number
  Title: Offset Amount

  Offset amount of the treasury offset amount resource.
• OffsetPartyName: string
  Title: Offset Party Name

  Maximum Length: 150

  Offset party name of the treasury offset amount.
• OffsetTreasuryPaymentNumber: integer
  Title: Offset Treasury Payment Number

  Offset treasury payment number of the treasury offset amount.
• OriginalTreasuryPaymentNumber: integer
  Title: Original Treasury Payment Number

  Original treasury payment number of the treasury offset amount.

{
    "type":"object",
    "properties":{
        "OffsetAmount":{
            "title":"Offset Amount",
            "type":"number",
            "description":"Offset amount of the treasury offset amount resource.",
            "nullable":false
        },
        "OriginalTreasuryPaymentNumber":{
            "title":"Original Treasury Payment Number",
            "type":"integer",
            "description":"Original treasury payment number of the treasury offset amount.",
            "nullable":false
        },
        "OffsetTreasuryPaymentNumber":{
            "title":"Offset Treasury Payment Number",
            "type":"integer",
            "description":"Offset treasury payment number of the treasury offset amount.",
            "nullable":false
        },
        "NetPaymentAmount":{
            "title":"Net Payment Amount",
            "type":"number",
            "description":"Net payment amount of the treasury offset amount.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OffsetAmount",
                    "OriginalPaymentAmount"
                ]
            }
        },
        "OffsetPartyName":{
            "title":"Offset Party Name",
            "maxLength":"150",
            "type":"string",
            "description":"Offset party name of the treasury offset amount.",
            "nullable":true
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : fedTreasuryOffsetAmounts-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The last user login that was used to update the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NetPaymentAmount: number
  Title: Net Payment Amount

  Net payment amount of the treasury offset amount.
• OffsetAmount: number
  Title: Offset Amount

  Offset amount of the treasury offset amount resource.
• OffsetId: integer
  Title: Offset ID

  The unique identifier of the offset associated with the treasury offset amount.
• OffsetPartyName: string
  Title: Offset Party Name

  Maximum Length: 150

  Offset party name of the treasury offset amount.
• OffsetTreasuryPaymentNumber: integer
  Title: Offset Treasury Payment Number

  Offset treasury payment number of the treasury offset amount.
• OriginalPaymentAmount: number
  Title: Original Payment Amount

  Offset payment amount of the treasury offset amount.
• OriginalTreasuryPaymentNumber: integer
  Title: Original Treasury Payment Number

  Original treasury payment number of the treasury offset amount.
• PaymentProcessRequestName: string
  Title: Payment Process Request Name

  Maximum Length: 255

  Payment process request name of the treasury offset amount.
• TreasuryConfirmationId: integer
  Title: Treasury Confirmation ID

  The unique identifier of the treasury confirmation associated with the treasury offset amount.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OffsetId":{
            "title":"Offset ID",
            "type":"integer",
            "description":"The unique identifier of the offset associated with the treasury offset amount.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OriginalTreasuryPaymentNumber":{
            "title":"Original Treasury Payment Number",
            "type":"integer",
            "description":"Original treasury payment number of the treasury offset amount.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentProcessRequestName":{
            "title":"Payment Process Request Name",
            "maxLength":"255",
            "type":"string",
            "description":"Payment process request name of the treasury offset amount.",
            "nullable":true,
            "x-queryable":true
        },
        "OffsetPartyName":{
            "title":"Offset Party Name",
            "maxLength":"150",
            "type":"string",
            "description":"Offset party name of the treasury offset amount.",
            "nullable":true,
            "x-queryable":true
        },
        "OffsetAmount":{
            "title":"Offset Amount",
            "type":"number",
            "description":"Offset amount of the treasury offset amount resource.",
            "nullable":false,
            "x-queryable":true
        },
        "OriginalPaymentAmount":{
            "title":"Original Payment Amount",
            "type":"number",
            "description":"Offset payment amount of the treasury offset amount.",
            "nullable":true,
            "x-queryable":true
        },
        "OffsetTreasuryPaymentNumber":{
            "title":"Offset Treasury Payment Number",
            "type":"integer",
            "description":"Offset treasury payment number of the treasury offset amount.",
            "nullable":false,
            "x-queryable":true
        },
        "NetPaymentAmount":{
            "title":"Net Payment Amount",
            "type":"number",
            "description":"Net payment amount of the treasury offset amount.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OffsetAmount",
                    "OriginalPaymentAmount"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TreasuryConfirmationId":{
            "title":"Treasury Confirmation ID",
            "type":"integer",
            "description":"The unique identifier of the treasury confirmation associated with the treasury offset amount.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The last user login that was used to update the record.",
            "nullable":true,
            "readOnly":true,
            "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

Examples

The following example shows how to update a treasury offset amount by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> 
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts/{OffsetId}

Request Body Example

The following shows an example of the request body in JSON format.

{
            
            "OffsetTreasuryPaymentNumber": 8888,
            "OffsetPartyName": "Test Party Test Name",
            "OffsetAmount": 111
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "OffsetId": 300100589623081,
    "TreasuryConfirmationId": 100105428613938,
    "OriginalTreasuryPaymentNumber": 1121,
    "OffsetTreasuryPaymentNumber": 8888,
    "PaymentProcessRequestName": "PPR-TEST-002",
    "OffsetPartyName": "Test Party Test Name",
    "OriginalPaymentAmount": 1000,
    "OffsetAmount": 111,
    "NetPaymentAmount": 889,
    "CreatedBy": "username",
    "CreationDate": "2024-04-24T11:28:11+00:00",
    "LastUpdatedBy": "username",
    "LastUpdateDate": "2024-04-24T11:51:23+00:00",
    "LastUpdateLogin": "1620FA123EE4EB5FE0635F6215AC70AF",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts/300100589623081",
            "name": "fedTreasuryOffsetAmounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts/300100589623081",
            "name": "fedTreasuryOffsetAmounts",
            "kind": "item"
        }
    ]
}

Back to Top