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
Root Schema : schema
Type:
Show Source
object
-
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.
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.
Root Schema : fedTreasuryOffsetAmounts-item-response
Type:
Show Source
object
-
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.
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.