Update one payment document
patch
/fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods/{SettlementMethodId}/child/settlementDocuments/{SettlementDocumentId}/child/payments/{PaymentId}
Request
Path Parameters
-
ClaimId(required): integer(int64)
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
-
PaymentId(required): integer(int64)
Value that uniquely identifies the payment.
-
SettlementDocumentId(required): integer(int64)
Value that uniquely identifies the settlement document.
-
SettlementMethodId(required): integer(int64)
Value that uniquely identifies the settlement method.
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
-
PayeeParty: string
Maximum Length:
255
Party who received the payment. -
PayeePartyId: integer
(int64)
Value that uniquely identifies the party that received the payment.
-
PayeePartySite: string
Maximum Length:
255
Party site that received the payment. -
PayeePartySiteId: integer
(int64)
Value that uniquely identifies the party site that received the payment.
-
PayeeSupplier: string
Maximum Length:
255
Supplier who received the payment. -
PayeeSupplierId: integer
(int64)
Value that uniquely identifies the supplier who received the payment.
-
PayeeSupplierNumber: string
Maximum Length:
255
Number of the supplier who received the payment. -
PayeeSupplierSite: string
Maximum Length:
255
Supplier site that received the payment. -
PayeeSupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site that received the payment.
-
PaymentAmount: number
Amount of the payment.
-
PaymentDate: string
(date)
Date when the payment was created.
-
PaymentMethod: string
Maximum Length:
30
Name of the payment created on settlement. -
PaymentNumber: string
Maximum Length:
30
Number of the payment created on settlement. -
PaymentStatus: string
Maximum Length:
30
Status of the payment. -
ThirdPartyPayeeName: string
Maximum Length:
360
Name of the third party payee for which the payment was created.
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 : channelCustomerClaims-settlementMethods-settlementDocuments-payments-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date and time when the user most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayeeParty: string
Maximum Length:
255
Party who received the payment. -
PayeePartyId: integer
(int64)
Value that uniquely identifies the party that received the payment.
-
PayeePartySite: string
Maximum Length:
255
Party site that received the payment. -
PayeePartySiteId: integer
(int64)
Value that uniquely identifies the party site that received the payment.
-
PayeeSupplier: string
Maximum Length:
255
Supplier who received the payment. -
PayeeSupplierId: integer
(int64)
Value that uniquely identifies the supplier who received the payment.
-
PayeeSupplierNumber: string
Maximum Length:
255
Number of the supplier who received the payment. -
PayeeSupplierSite: string
Maximum Length:
255
Supplier site that received the payment. -
PayeeSupplierSiteAddress: string
Read Only:
true
Maximum Length:255
Site address of the supplier for which the payment was created. -
PayeeSupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site that received the payment.
-
PaymentAmount: number
Amount of the payment.
-
PaymentDate: string
(date)
Date when the payment was created.
-
PaymentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the payment. -
PaymentMethod: string
Maximum Length:
30
Name of the payment created on settlement. -
PaymentNumber: string
Maximum Length:
30
Number of the payment created on settlement. -
PaymentStatus: string
Maximum Length:
30
Status of the payment. -
SettlementDocumentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the settlement document. -
ThirdPartyPayeeName: string
Maximum Length:
360
Name of the third party payee for which the payment was created.
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.