Jump to

• Request
• Response

Update a payment item

patch

/fscmRestApi/resources/11.13.18.05/leaseAccountingPaymentItems/{PaymentItemId}

Request

Path Parameters

• PaymentItemId(required): integer(int64)
  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

• ActualAmount: number
  Title: Payment Amount

  The actual amount of the payment item.
• InvoiceLineNumber: integer (int64)
  Title: Invoice Line Number

  The number of the invoice line of the payables invoice created by the payment item.
• PayablesInvoiceNumber: string
  Title: Payables Invoice Number

  Maximum Length: 50

  The number of the payables invoice created by the payment item.
• SupplierInvoiceNumber: string
  Title: Supplier Invoice Number

  Maximum Length: 50

  The identifier of the invoice provided by the supplier for the payment item.

{
    "type":"object",
    "properties":{
        "ActualAmount":{
            "title":"Payment Amount",
            "type":"number",
            "description":"The actual amount of the payment item.",
            "nullable":false
        },
        "InvoiceLineNumber":{
            "title":"Invoice Line Number",
            "type":"integer",
            "description":"The number of the invoice line of the payables invoice created by the payment item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PayablesInvoiceNumber":{
            "title":"Payables Invoice Number",
            "maxLength":50,
            "type":"string",
            "description":"The number of the payables invoice created by the payment item.",
            "nullable":true
        },
        "SupplierInvoiceNumber":{
            "title":"Supplier Invoice Number",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the invoice provided by the supplier for the payment item.",
            "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 : leaseAccountingPaymentItems-item-response

Type: object

Show Source

• ActualAmount: number
  Title: Payment Amount

  The actual amount of the payment item.
• AssetNumber: string
  Title: Asset Number

  Read Only: true

  Maximum Length: 30

  The asset number corresponding to the payment item.
• BusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The business unit of the payment item.
• DueDate: string (date)
  Title: Due Date

  The due date of the payment item.
• InvoiceLineNumber: integer (int64)
  Title: Invoice Line Number

  The number of the invoice line of the payables invoice created by the payment item.
• LeaseName: string
  Title: Lease Name

  Read Only: true

  Maximum Length: 50

  The lease name corresponding to the payment item.
• LeaseNumber: string
  Title: Lease Number

  Read Only: true

  Maximum Length: 30

  The lease number of the payment item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayablesInvoiceNumber: string
  Title: Payables Invoice Number

  Maximum Length: 50

  The number of the payables invoice created by the payment item.
• PaymentItemId: integer (int64)
  Read Only: true

  The unique identifier of the payment item.
• PaymentItemStatus: string
  Title: Payment Status

  Read Only: true

  Maximum Length: 80

  The payment item status of the payment item.
• PaymentNumber: string
  Title: Payment Number

  Read Only: true

  Maximum Length: 30

  The number of the payment for the payment item.
• PaymentPurpose: string
  Title: Payment Purpose

  Read Only: true

  Maximum Length: 80

  The payment purpose for the payment item.
• PaymentType: string
  Title: Payment Type

  Read Only: true

  Maximum Length: 80

  The payment type for the payment item.
• PeriodName: string
  Title: Period

  Read Only: true

  Maximum Length: 30

  The name of the period for which the payment item has been created.
• SupplierInvoiceNumber: string
  Title: Supplier Invoice Number

  Maximum Length: 50

  The identifier of the invoice provided by the supplier for the payment item.
• SupplierNumber: string
  Title: Supplier

  Read Only: true

  Maximum Length: 30

  The supplier number of the payment item.

{
    "type":"object",
    "properties":{
        "PaymentItemStatus":{
            "title":"Payment Status",
            "maxLength":80,
            "type":"string",
            "description":"The payment item status of the payment item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentItemId":{
            "type":"integer",
            "description":"The unique identifier of the payment item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InvoiceLineNumber":{
            "title":"Invoice Line Number",
            "type":"integer",
            "description":"The number of the invoice line of the payables invoice created by the payment item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeaseNumber":{
            "title":"Lease Number",
            "maxLength":30,
            "type":"string",
            "description":"The lease number of the payment item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierInvoiceNumber":{
            "title":"Supplier Invoice Number",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the invoice provided by the supplier for the payment item.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualAmount":{
            "title":"Payment Amount",
            "type":"number",
            "description":"The actual amount of the payment item.",
            "nullable":false,
            "x-queryable":true
        },
        "SupplierNumber":{
            "title":"Supplier",
            "maxLength":30,
            "type":"string",
            "description":"The supplier number of the payment item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":30,
            "type":"string",
            "description":"The asset number corresponding to the payment item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeaseName":{
            "title":"Lease Name",
            "maxLength":50,
            "type":"string",
            "description":"The lease name corresponding to the payment item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentPurpose":{
            "title":"Payment Purpose",
            "maxLength":80,
            "type":"string",
            "description":"The payment purpose for the payment item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentType":{
            "title":"Payment Type",
            "maxLength":80,
            "type":"string",
            "description":"The payment type for the payment item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":30,
            "type":"string",
            "description":"The name of the period for which the payment item has been created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayablesInvoiceNumber":{
            "title":"Payables Invoice Number",
            "maxLength":50,
            "type":"string",
            "description":"The number of the payables invoice created by the payment item.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The business unit of the payment item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The due date of the payment item.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentNumber":{
            "title":"Payment Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the payment for the payment item.",
            "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