Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PaymentDate":{
            "type":"string",
            "description":"Date when the payment was created.",
            "format":"date",
            "nullable":true
        },
        "ThirdPartyPayeeName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the third party payee for which the payment was created.",
            "nullable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"Amount of the payment.",
            "nullable":true
        },
        "PayeeParty":{
            "maxLength":"255",
            "type":"string",
            "description":"Party who received the payment.",
            "nullable":true
        },
        "PayeeSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PayeePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PayeePartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party site that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PayeeSupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the supplier who received the payment.",
            "nullable":true
        },
        "PayeePartySite":{
            "maxLength":"255",
            "type":"string",
            "description":"Party site that received the payment.",
            "nullable":true
        },
        "PaymentMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the payment created on settlement.",
            "nullable":true
        },
        "PayeeSupplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Supplier who received the payment.",
            "nullable":true
        },
        "PayeeSupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Supplier site that received the payment.",
            "nullable":true
        },
        "PaymentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number of the payment created on settlement.",
            "nullable":true
        },
        "PaymentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the payment.",
            "nullable":true
        },
        "PayeeSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who received the payment.",
            "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:
  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 : channelCustomerClaims-settlementMethods-settlementDocuments-payments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "type":"string",
            "description":"Date when the payment was created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeSupplierSiteAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"Site address of the supplier for which the payment was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PaymentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ThirdPartyPayeeName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the third party payee for which the payment was created.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the settlement document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"Amount of the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeParty":{
            "maxLength":"255",
            "type":"string",
            "description":"Party who received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayeePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayeePartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party site that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayeeSupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the supplier who received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeePartySite":{
            "maxLength":"255",
            "type":"string",
            "description":"Party site that received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the payment created on settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PayeeSupplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Supplier who received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeSupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Supplier site that received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number of the payment created on settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayeeSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who received the payment.",
            "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