Update a payment

patch

/fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Payments Descriptive Flexfields
Type: array
Title: Payments Descriptive Flexfields
The payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "Context1":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-patch-request", "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-patch-request" } }
Nested Schema : Payments Global Descriptive Flexfields
Type: array
Title: Payments Global Descriptive Flexfields
The payables payments global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for a payment.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSAPCHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-patch-request", "JA_CN_REMIT_BILL_NUM":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-patch-request", "JAxINChallanInfo":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-patch-request", "JAxTHPayments":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-patch-request", "JE_IL_PAYMENT_CHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-patch-request", "JLxMXPaymentChecks":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-patch-request" } }
Nested Schema : Related Invoices
Type: array
Title: Related Invoices
The related invoices resource is used to manage details of invoices related to a payment.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-patch-request
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-patch-request
Type: object
Show Source
Nested Schema : payablesPayments-relatedInvoices-item-patch-request
Type: object
Show Source
Nested Schema : relatedInvoiceGdf
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "JExESOnlineVatReporting":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_invoicePaymentsGdf_view_InvoicePaymentRestGdfJExESOnlineVatReportingVO-item-patch-request" } }
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_invoicePaymentsGdf_view_InvoicePaymentRestGdfJExESOnlineVatReportingVO-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : payablesPayments-item-response
Type: object
Show Source
Nested Schema : Payments Descriptive Flexfields
Type: array
Title: Payments Descriptive Flexfields
The payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "Context1":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response", "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response" } }
Nested Schema : Payments Global Descriptive Flexfields
Type: array
Title: Payments Global Descriptive Flexfields
The payables payments global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for a payment.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSAPCHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-response", "JA_CN_REMIT_BILL_NUM":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response", "JAxINChallanInfo":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-response", "JAxTHPayments":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-response", "JE_IL_PAYMENT_CHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-response", "JLxMXPaymentChecks":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-response" } }
Nested Schema : Related Invoices
Type: array
Title: Related Invoices
The related invoices resource is used to manage details of invoices related to a payment.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext1VO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfFVxUSAPCHECKSVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-response
Type: object
Show Source
Nested Schema : payablesPayments-relatedInvoices-item-response
Type: object
Show Source
Nested Schema : Related Invoice Global Descriptive Flexfields
Type: array
Title: Related Invoice Global Descriptive Flexfields
The related invoice global descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice payment.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "JExESOnlineVatReporting":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_invoicePaymentsGdf_view_InvoicePaymentRestGdfJExESOnlineVatReportingVO-item-response" } }
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_invoicePaymentsGdf_view_InvoicePaymentRestGdfJExESOnlineVatReportingVO-item-response
Type: object
Show Source
Back to Top

Examples

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

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
 "VoidDate": "2018-11-01",
 "VoidAccountingDate": "2018-11-01"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "CheckId": 300100170752773,
    "PaymentId": 103714,
    "PaymentReference": 1883,
    "PaperDocumentNumber": 1006,
    "PaymentNumber": 1006,
    "PaymentFileReference": 137028,
    "PaymentProcessRequest": "Quick payment: ID=300100170752773",
    "PaymentAmount": 1202.75,
    "PaymentDate": "2018-11-01",
    "AccountingDate": "2018-11-01",
    "PaymentDescription": null,
    "ConversionRate": null,
    "ConversionDate": null,
    "ConversionRateType": null,
    "ClearingDate": null,
    "ClearingAmount": null,
    "ClearingLedgerAmount": null,
    "ClearingConversionRate": null,
    "ClearingConversionDate": null,
    "ClearingConversionRateType": null,
    "CrossCurrencyRateType": "Corporate",
    "MaturityDate": null,
    "MaturityConversionRateType": null,
    "MaturityConversionDate": null,
    "MaturityConversionRate": 1,
    "AnticipatedValueDate": null,
    "ClearingValueDate": null,
    "StopDate": null,
    "VoidDate": "2018-11-01",
    "VoidAccountingDate": "2018-11-01",
    "PaymentStatus": "Negotiable",
    "SeparateRemittanceAdviceCreated": null,
    "AccountingStatus": "Unaccounted",
    "ReconciledFlag": false,
    "PaymentType": "Quick",
    "PaymentCurrency": "USD",
    "WithheldAmount": null,
    "BankChargeAmount": null,
    "LegalEntity": "Vision Operations",
    "BusinessUnit": "Vision Operations",
    "PaymentFunction": null,
    "Payee": "Advanced Network Devices",
    "ProcurementBU": null,
    "PayeeSite": "FRESNO",
    "EmployeeAddress": null,
    "SupplierNumber": "1013",
    "ThirdPartySupplier": null,
    "ThirdPartyAddressName": null,
    "ExternalBankAccountId": null,
    "RemitToAccountNumber": null,
    "DisbursementBankAccountNumber": "10271-17621-619",
    "DisbursementBankAccountName": "BofA-204",
    "PaymentMethodCode": "CHECK",
    "PaymentMethod": "Check",
    "PaymentDocument": "AP Standard Check Format 2",
    "PaymentProcessProfile": "Standard Check",
    "DocumentCategory": null,
    "DocumentSequence": null,
    "VoucherNumber": null,
    "PaymentBaseAmount": null,
    "PaymentBaseCurrency": "USD",
    "AddressLine1": "5600 Independence Ave",
    "AddressLine2": null,
    "AddressLine3": null,
    "AddressLine4": null,
    "City": "Fresno",
    "County": null,
    "Province": null,
    "State": "CA",
    "Country": "US",
    "Zip": "95602",
    "CreatedBy": "AP_SUPV_OPERATIONS",
    "CreationDate": "2018-11-26T11:02:52.001+00:00",
    "LastUpdatedBy": "AP_SUPV_OPERATIONS",
    "LastUpdateDate": "2018-11-26T11:10:13+00:00",
    "LastUpdateLogin": "7B273F6DCA3CF7D0E0533BFDF40AFF00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773",
            "name": "payablesPayments",
            "kind": "item",
            "properties": {
                              "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773",
            "name": "payablesPayments",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/BankAccountPaymentDocumentNoBuPVO",
            "name": "BankAccountPaymentDocumentNoBuPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/DisbursementBankAccountVVO",
            "name": "DisbursementBankAccountVVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/SupplierSiteVVO",
            "name": "SupplierSiteVVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/PaymentFunctionPVO",
            "name": "PaymentFunctionPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/ProcurementBusinessUnitVVO",
            "name": "ProcurementBusinessUnitVVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/EmployeeAddressTypeVVO",
            "name": "EmployeeAddressTypeVVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/ApplicablePaymentProfilePVO",
            "name": "ApplicablePaymentProfilePVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/PaymentBusinessUnitPVO",
            "name": "PaymentBusinessUnitPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/RemitToSupplierPVO",
            "name": "RemitToSupplierPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/TradingPartnerVVO",
            "name": "TradingPartnerVVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/PaymentTypeVVO",
            "name": "PaymentTypeVVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/PaymentMethodPVO",
            "name": "PaymentMethodPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/DailyConversionTypePVO",
            "name": "DailyConversionTypePVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/lov/RemitToAddressPVO",
            "name": "RemitToAddressPVO",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773/child/relatedInvoices",
            "name": "relatedInvoices",
            "kind": "collection"
        }
    ]
}
Back to Top