Create a payment

post

/fscmRestApi/resources/11.13.18.05/payablesPayments

Request

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Address Line 1
    Maximum Length: 240
    The first address line of the party to whom the payment is made.
  • Title: Address Line 2
    Maximum Length: 240
    The second address line of the party to whom the payment is made.
  • Title: Address Line 3
    Maximum Length: 240
    The third address line of party to whom the payment is made.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth address line of the party to whom the payment is made.
  • Title: Business Unit
    Maximum Length: 240
    The business unit name for the payment.
  • Title: City
    Maximum Length: 60
    The city name of the party to whom the payment is made.
  • Title: Conversion Rate
    The conversion rate used to convert foreign currency payments.
  • Title: Conversion Rate Type
    Maximum Length: 30
    The type of conversion rate used to convert foreign currency payments.
  • Title: Country
    Maximum Length: 60
    The country name of the party to whom the payment is made.
  • Title: County
    Maximum Length: 150
    The county name of the party to whom the payment is made.
  • Title: Conversion Rate Type
    Maximum Length: 30
    The conversion rate type used to convert the invoice currency to payment currency.
  • Maximum Length: 255
    The name of the internal bank account from where the payment is made.
  • Maximum Length: 255
    The address of the employee.
  • Title: Remit-to Account
    The unique identifier for the supplier bank account. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. If both Remit-to Account Number and External Bank Account ID is provided in the payload then the value for the External Bank Account ID is given preference and the value provided for Remit-to Account Number is ignored.
  • Title: Payee
    The unique identifier of the party that a payment is made to. It also helps to uniquely identify the payee associated with the party.
  • Title: Payee Payee
    Maximum Length: 240
    The party name to whom payment is made.
  • Title: Site
    Maximum Length: 240
    The supplier site name to whom payment is made.
  • Title: Payment Currency
    Maximum Length: 15
    The currency in which payment is made.
  • Title: Payment Date
    The date when the payment is made and mentioned on the payment document.
  • Title: Payment Description
    Maximum Length: 240
    The user description for a payment.
  • Payments Descriptive Flexfields
    Title: Payments Descriptive Flexfields
    The payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment.
  • Title: Payment Document
    Maximum Length: 100
    The name of the payment document.
  • The business function that the payment serves. Examples include Employee expenses and Payables disbursements. The value can either be provided while creating payment or populated by default to Payables disbursements.
  • Payments Global Descriptive Flexfields
    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.
  • Title: Name
    Maximum Length: 100
    The option to indicate how the first party payer has made the payment.
  • Title: Payment Method
    Maximum Length: 30
    The user-entered payment method code that helps to uniquely identify a payment method.
  • Title: Payment Number
    The check number printed on physical check.
  • Title: Configuration Profile
    Maximum Length: 100
    The payment process profile name.
  • Maximum Length: 255
    The type of payment such as Manual, Quick, Refund, and Payment Process Request. Note: Currently you can only create manual payments only. Other payment types are not supported.
  • The procurement business unit that is associated to the supplier site and helps to uniquely identify a supplier site.
  • Title: Province
    Maximum Length: 150
    The province of the party to whom the payment is made.
  • Related Invoices
    Title: Related Invoices
    The related invoices resource is used to manage details of invoices related to a payment.
  • Maximum Length: 30
    The supplier's bank account number for electronic payment purposes.
  • Title: State
    Maximum Length: 150
    The state name of the party to whom the payment is made.
  • Title: Third-Party Address Name
    Maximum Length: 240
    The third-party payment related remit-to address where the payment is sent.
  • Title: Third-Party Supplier
    Maximum Length: 240
    The third-party payment related remit-to supplier where the payment is sent.
  • Title: Void Accounting Date
    The date when the voided payment is accounted.
  • Title: Void Date
    The date when the payment is voided.
  • Title: Postal Code
    Maximum Length: 60
    The postal code or zip code of the party to whom the payment is made.
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-post-request", "Context2":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-post-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-post-request", "JA_CN_REMIT_BILL_NUM":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-post-request", "JAxINChallanInfo":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-post-request", "JAxTHPayments":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-post-request", "JE_IL_PAYMENT_CHECKS":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-post-request", "JLxMXPaymentChecks":"#/components/schemas/oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-post-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-post-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_payments_view_PaymentRestDffContext2VO-item-post-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-post-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJA__5FCN__5FREMIT__5FBILL__5FNUMVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxINChallanInfoVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJAxTHPaymentsVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJE__5FIL__5FPAYMENT__5FCHECKSVO-item-post-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_payments_core_restModel_paymentsGdf_view_PaymentRestGdfJLxMXPaymentChecksVO-item-post-request
Type: object
Show Source
Nested Schema : schema
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-post-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-post-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

Example 1

The following example shows how to create a manual payment for a supplier invoice by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments

Example Request Body

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

{
"PaymentNumber": 1005,
"PaymentDate": "2018-11-07",
"PaymentDescription": "Manual_Payment",
"PaymentType": "Manual",
"PaymentCurrency": "USD",
"BusinessUnit": "Vision Operations",
"Payee": "Advanced Network Devices",
"PayeeSite": "FRESNO",
"DisbursementBankAccountName": "BofA-204",
"PaymentMethod": "Check",
"PaymentProcessProfile": "Standard Check",
"PaymentDocument": "AP Standard Check Format 2",
 
"relatedInvoices": [
{
"InvoiceNumber": "Functional-Currency-Invoice",
"InstallmentNumber": 1,
"DiscountTaken": 10,
"AmountPaidPaymentCurrency": 46.25
},
{
"InvoiceNumber": "Functional-Currency-Invoice",
"InstallmentNumber": 2,
"DiscountTaken": 10,
"AmountPaidPaymentCurrency": 46.25
}
]
}

Example Response Body

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

{
    "CheckId": 300100170746039,
    "PaymentId": null,
    "PaymentReference": null,
    "PaperDocumentNumber": null,
    "PaymentNumber": 1005,
    "PaymentFileReference": null,
    "PaymentProcessRequest": "300100170746039",
    "PaymentAmount": 92.5,
    "PaymentDate": "2018-11-07",
    "AccountingDate": null,
    "PaymentDescription": "Manual_Payment",
    "ConversionRate": null,
    "ConversionDate": null,
    "ConversionRateType": null,
    "ClearingDate": null,
    "ClearingAmount": null,
    "ClearingLedgerAmount": null,
    "ClearingConversionRate": null,
    "ClearingConversionDate": null,
    "ClearingConversionRateType": null,
    "CrossCurrencyRateType": null,
    "MaturityDate": null,
    "MaturityConversionRateType": null,
    "MaturityConversionDate": null,
    "MaturityConversionRate": 1,
    "AnticipatedValueDate": null,
    "ClearingValueDate": null,
    "StopDate": null,
    "VoidDate": null,
    "VoidAccountingDate": null,
    "PaymentStatus": null,
    "SeparateRemittanceAdviceCreated": null,
    "AccountingStatus": null,
    "ReconciledFlag": null,
    "PaymentType": "Manual",
    "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": null,
    "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-25T19:11:34.001+00:00",
    "LastUpdatedBy": "AP_SUPV_OPERATIONS",
    "LastUpdateDate": "2018-11-25T19:11:34.260+00:00",
    "LastUpdateLogin": "7B273F6DCA3CF7D0E0533BFDF40AFF00",
    "relatedInvoices": [
        {
            "InvoicePaymentId": 300100170746040,
            "CheckId": 300100170746039,
            "InvoiceId": 300100170752632,
            "InvoiceBusinessUnit": "Vision Operations",
            "InvoiceNumber": "Functional-Currency-Invoice",
            "InstallmentNumber": 1,
            "AmountPaidPaymentCurrency": 46.25,
            "AmountPaidInvoiceCurrency": 46.25,
            "DiscountLost": -10,
            "DiscountTaken": 10,
            "InvoiceBaseAmount": null,
            "PaymentBaseAmount": null,
            "InvoiceCurrency": "USD",
            "CrossCurrencyRate": 1,
            "LastUpdatedBy": "AP_SUPV_OPERATIONS",
            "LastUpdateDate": "2018-11-25T19:11:34.317+00:00",
            "CreatedBy": "AP_SUPV_OPERATIONS",
            "CreationDate": "2018-11-25T19:11:34.154+00:00",
            "LastUpdateLogin": "7B273F6DCA3CF7D0E0533BFDF40AFF00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices/300100170746040",
                    "name": "relatedInvoices",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices/300100170746040",
                    "name": "relatedInvoices",
                    "kind": "item"
                },
                ...
            ]
        },
        {
            "InvoicePaymentId": 300100170746041,
            "CheckId": 300100170746039,
            "InvoiceId": 300100170752632,
            "InvoiceBusinessUnit": "Vision Operations",
            "InvoiceNumber": "Functional-Currency-Invoice",
            "InstallmentNumber": 2,
            "AmountPaidPaymentCurrency": 46.25,
            "AmountPaidInvoiceCurrency": 46.25,
            "DiscountLost": -10,
            "DiscountTaken": 10,
            "InvoiceBaseAmount": null,
            "PaymentBaseAmount": null,
            "InvoiceCurrency": "USD",
            "CrossCurrencyRate": 1,
            "LastUpdatedBy": "AP_SUPV_OPERATIONS",
            "LastUpdateDate": "2018-11-25T19:11:34.328+00:00",
            "CreatedBy": "AP_SUPV_OPERATIONS",
            "CreationDate": "2018-11-25T19:11:34.183+00:00",
            "LastUpdateLogin": "7B273F6DCA3CF7D0E0533BFDF40AFF00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices/300100170746041",
                    "name": "relatedInvoices",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039/child/relatedInvoices/300100170746041",
                    "name": "relatedInvoices",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039",
                    "name": "payablesPayments",
                    "kind": "item"
                },
                ...
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039",
            "name": "payablesPayments",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100170746039",
            "name": "payablesPayments",
            "kind": "item"
        },
        ...
    ]
}

Example 2

The following example shows how to create a manual payment for an employee expense payment request scenario by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments

Example Request Body

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

{
"PaymentNumber": 1012,
"PaymentDate": "2018-11-01",
"PaymentDescription": "Manual_Payment",
"PaymentType": "Manual",
"PaymentCurrency": "USD",
"BusinessUnit": "Vision Operations",
"PaymentFunction": "Employee expenses",
"Payee": "James Taylor",
"EmployeeAddress": "Home",
"DisbursementBankAccountName": "BofA-204",
"PaymentMethod": "Check",
"PaymentProcessProfile": "Standard Check",
"PaymentDocument": "AP Standard Check Format 2",
  
"relatedInvoices": [
{
"InvoiceNumber": "EXM0169907926",
"InstallmentNumber": 1,
"AmountPaidPaymentCurrency": 50
}
]
}

Example Response Body

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

{
    "CheckId": 300100174803469,
    "PaymentId": null,
    "PaymentReference": null,
    "PaperDocumentNumber": null,
    "PaymentNumber": 1012,
    "PaymentFileReference": null,
    "PaymentProcessRequest": "300100174803469",
    "PaymentAmount": 50,
    "PaymentDate": "2018-11-01",
    "AccountingDate": null,
    "PaymentDescription": "Manual_Payment",
    "ConversionRate": null,
    "ConversionDate": null,
    "ConversionRateType": null,
    "ClearingDate": null,
    "ClearingAmount": null,
    "ClearingLedgerAmount": null,
    "ClearingConversionRate": null,
    "ClearingConversionDate": null,
    "ClearingConversionRateType": null,
    "CrossCurrencyRateType": null,
    "MaturityDate": null,
    "MaturityConversionRateType": null,
    "MaturityConversionDate": null,
    "MaturityConversionRate": 1,
    "AnticipatedValueDate": null,
    "ClearingValueDate": null,
    "StopDate": null,
    "VoidDate": null,
    "VoidAccountingDate": null,
    "PaymentStatus": null,
    "SeparateRemittanceAdviceCreated": null,
    "AccountingStatus": null,
    "ReconciledFlag": null,
    "PaymentType": "Manual",
    "PaymentCurrency": "USD",
    "WithheldAmount": null,
    "BankChargeAmount": null,
    "LegalEntity": "Vision Operations",
    "BusinessUnit": "Vision Operations",
    "PaymentFunction": "Employee expenses",
    "Payee": "James Taylor",
    "ProcurementBU": null,
    "PayeeSite": null,
    "EmployeeAddress": "Home",
    "SupplierNumber": null,
    "ThirdPartySupplier": null,
    "ThirdPartyAddressName": null,
    "ExternalBankAccountId": null,
    "RemitToAccountNumber": null,
    "DisbursementBankAccountNumber": null,
    "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": null,
    "AddressLine2": null,
    "AddressLine3": null,
    "AddressLine4": null,
    "City": null,
    "County": null,
    "Province": null,
    "State": null,
    "Country": null,
    "Zip": null,
    "CreatedBy": "AP_SUPV_OPERATIONS",
    "CreationDate": "2018-11-28T09:15:49.001+00:00",
    "LastUpdatedBy": "AP_SUPV_OPERATIONS",
    "LastUpdateDate": "2018-11-28T09:15:51.035+00:00",
    "LastUpdateLogin": "7B2737422803F39EE0533AFDF40A6863",
    "relatedInvoices": [
        {
            "InvoicePaymentId": 300100174803470,
            "CheckId": 300100174803469,
            "InvoiceId": 355912,
            "InvoiceBusinessUnit": "Vision Operations",
            "InvoiceNumber": "EXM0169907926",
            "InstallmentNumber": 1,
            "AmountPaidPaymentCurrency": 50,
            "AmountPaidInvoiceCurrency": 50,
            "DiscountLost": 0,
            "DiscountTaken": 0,
            "InvoiceBaseAmount": null,
            "PaymentBaseAmount": null,
            "InvoiceCurrency": "USD",
            "CrossCurrencyRate": 1,
            "LastUpdatedBy": "AP_SUPV_OPERATIONS",
            "LastUpdateDate": "2018-11-28T09:15:51.118+00:00",
            "CreatedBy": "AP_SUPV_OPERATIONS",
            "CreationDate": "2018-11-28T09:15:49.290+00:00",
            "LastUpdateLogin": "7B2737422803F39EE0533AFDF40A6863",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174803469/child/relatedInvoices/300100174803470",
                    "name": "relatedInvoices",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174803469/child/relatedInvoices/300100174803470",
                    "name": "relatedInvoices",
                    "kind": "item"
                },
                ...
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174803469",
            "name": "payablesPayments",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100174803469",
            "name": "payablesPayments",
            "kind": "item"
        },
        ...
    ]
}

Example 3

The following example shows how to create a manual payment for a customer refund payment request scenario by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments

Example Request Body

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

{
	"PaymentNumber": 192,
	"PaymentDate": "2020-04-01",
	"PaymentDescription": "Manual_Payment",
	"PaymentType": "Manual",
	"PaymentCurrency": "USD",
	"BusinessUnit": "Vision Operations",
	"Payee": "B2CM_Customer",
	"DisbursementBankAccountName": "AP BofA - USD",
	"PaymentMethod": "Check",
	"PaymentProcessProfile": "AP Basic Printed for IL",
	"PaymentDocument": "IBY Prenum 3-2",
	"PaymentFunction": "Receivables customer refunds",
	 
	"relatedInvoices": [
	{
		"InvoiceNumber": "999995000469018",
		"InstallmentNumber": 1,
		"AmountPaidPaymentCurrency": 10
	}
	]
}

Example response Body

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

{
  "CheckId": 300100261773606,
  "PaymentId": null,
  "PaymentReference": null,
  "PaperDocumentNumber": null,
  "PaymentNumber": 192,
  "PaymentFileReference": null,
  "PaymentProcessRequest": "300100261773606",
  "PaymentAmount": 10,
  "PaymentDate": "2020-04-01",
  "AccountingDate": null,
  "PaymentDescription": "Manual_Payment",
  "ConversionRate": null,
  "ConversionDate": null,
  "ConversionRateType": null,
  "ClearingDate": null,
  "ClearingAmount": null,
  "ClearingLedgerAmount": null,
  "ClearingConversionRate": null,
  "ClearingConversionDate": null,
  "ClearingConversionRateType": null,
  "CrossCurrencyRateType": null,
  "MaturityDate": null,
  "MaturityConversionRateType": null,
  "MaturityConversionDate": null,
  "MaturityConversionRate": 1,
  "AnticipatedValueDate": null,
  "ClearingValueDate": null,
  "StopDate": null,
  "VoidDate": null,
  "VoidAccountingDate": null,
  "PaymentStatus": null,
  "SeparateRemittanceAdviceCreated": null,
  "AccountingStatus": null,
  "ReconciledFlag": null,
  "PaymentType": "Manual",
  "PaymentCurrency": "USD",
  "WithheldAmount": null,
  "BankChargeAmount": null,
  "LegalEntity": "Vision Operations",
  "BusinessUnit": "Vision Operations",
  "PaymentFunction": "Receivables customer refunds",
  "Payee": "B2CM_Customer",
  "ProcurementBU": null,
  "PayeeSite": null,
  "EmployeeAddress": null,
  "SupplierNumber": null,
  "ThirdPartySupplier": null,
  "ThirdPartyAddressName": null,
  "ExternalBankAccountId": null,
  "RemitToAccountNumber": null,
  "DisbursementBankAccountNumber": null,
  "DisbursementBankAccountName": "AP BofA - USD",
  "PaymentMethodCode": "CHECK",
  "PaymentMethod": "Check",
  "PaymentDocument": "IBY Prenum 3-2",
  "PaymentProcessProfile": "AP Basic Printed for IL",
  "DocumentCategory": null,
  "DocumentSequence": null,
  "VoucherNumber": null,
  "PaymentBaseAmount": null,
  "PaymentBaseCurrency": "USD",
  "AddressLine1": null,
  "AddressLine2": null,
  "AddressLine3": null,
  "AddressLine4": null,
  "City": null,
  "County": null,
  "Province": null,
  "State": null,
  "Country": "US",
  "Zip": null,
  "CreatedBy": "FINUSER1",
  "CreationDate": "2020-04-20T08:49:45.001+00:00",
  "LastUpdatedBy": "FINUSER1",
  "LastUpdateDate": "2020-04-20T08:49:48.946+00:00",
  "LastUpdateLogin": "A3A4DE17E9CB5148E05322EAF40A6C6B",
  "relatedInvoices": [
    {
      "InvoicePaymentId": 300100261773607,
      "CheckId": 300100261773606,
      "InvoiceId": 608945,
      "InvoiceBusinessUnit": "Vision Operations",
      "InvoiceNumber": "999995000469018",
      "InstallmentNumber": 1,
      "AmountPaidPaymentCurrency": 10,
      "AmountPaidInvoiceCurrency": 10,
      "DiscountLost": 0,
      "DiscountTaken": 0,
      "InvoiceBaseAmount": null,
      "PaymentBaseAmount": null,
      "InvoiceCurrency": "USD",
      "CrossCurrencyRate": 1,
      "LastUpdatedBy": "FINUSER1",
      "LastUpdateDate": "2020-04-20T08:49:49.016+00:00",
      "CreatedBy": "FINUSER1",
      "CreationDate": "2020-04-20T08:49:46.344+00:00",
      "LastUpdateLogin": "A3A4DE17E9CB5148E05322EAF40A6C6B",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100261773606/child/relatedInvoices/300100261773607",
          "name": "relatedInvoices",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100261773606/child/relatedInvoices/300100261773607",
          "name": "relatedInvoices",
          "kind": "item"
        },
        ...
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100261773606",
      "name": "payablesPayments",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payablesPayments/300100261773606",
      "name": "payablesPayments",
      "kind": "item"
    },
    ...
  ]
}
Back to Top