Create a payment

post

/fscmRestApi/resources/11.13.18.05/payablesPayments

Request

Supported Media Types
Body ()
The following table describes the body parameters in the request for this task.
Root Schema : payablesPayments-item
Type: object
Show Source
Nested Schema : Payments Descriptive Flexfields
Type: array
Title: Payments Descriptive Flexfields
The payables payments resource is used to manage payment details. You can create manual payments, update descriptive and global flexfields for a payment, and void a payment.
Show Source
Nested Schema : Payments Global Descriptive Flexfields
Type: array
Title: Payments Global Descriptive Flexfields
The payables payments resource is used to manage payment details. You can create manual payments, update descriptive and global flexfields for a payment, and void a payment.
Show Source
Nested Schema : Related Invoices
Type: array
Title: Related Invoices
The payables payments resource is used to manage payment details. You can create manual payments, update descriptive and global flexfields for a payment, and void a payment.
Show Source
Nested Schema : payablesPayments-paymentDff-item
Type: object
Show Source
Nested Schema : payablesPayments-paymentGdf-item
Type: object
Show Source
Nested Schema : payablesPayments-relatedInvoices-item
Type: object
Show Source
Nested Schema : Related Invoice Global Descriptive Flexfields
Type: array
Title: Related Invoice Global Descriptive Flexfields
The related invoices resource is used to manage details of invoices related to a payment.
Show Source
Nested Schema : payablesPayments-relatedInvoices-relatedInvoiceGdf-item
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : payablesPayments-item
Type: object
Show Source
Nested Schema : Payments Descriptive Flexfields
Type: array
Title: Payments Descriptive Flexfields
The payables payments resource is used to manage payment details. You can create manual payments, update descriptive and global flexfields for a payment, and void a payment.
Show Source
Nested Schema : Payments Global Descriptive Flexfields
Type: array
Title: Payments Global Descriptive Flexfields
The payables payments resource is used to manage payment details. You can create manual payments, update descriptive and global flexfields for a payment, and void a payment.
Show Source
Nested Schema : Related Invoices
Type: array
Title: Related Invoices
The payables payments resource is used to manage payment details. You can create manual payments, update descriptive and global flexfields for a payment, and void a payment.
Show Source
Nested Schema : payablesPayments-paymentDff-item
Type: object
Show Source
Nested Schema : payablesPayments-paymentGdf-item
Type: object
Show Source
Nested Schema : payablesPayments-relatedInvoices-item
Type: object
Show Source
Nested Schema : Related Invoice Global Descriptive Flexfields
Type: array
Title: Related Invoice Global Descriptive Flexfields
The related invoices resource is used to manage details of invoices related to a payment.
Show Source
Nested Schema : payablesPayments-relatedInvoices-relatedInvoiceGdf-item
Type: object
Show Source
Back to Top

Examples

The following example shows how to create a manual payment 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 Payload

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"
        },
        ...
    ]
}

The following example shows how to create a payment for a 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 Payload

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"
        },
        ...
    ]
}
Back to Top