Void a Payment

Your Accounts Payables Supervisor or Manager wants to void a payment.

Example URL

Here's an example of the resource URL:

PATCH

fscmRestApi/resources/11.13.18.05/payablesPayments/300100170752773

cURL Command

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

Here's an example of the request body in JSON format:

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

Example Response

Here's an example 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"
        }
    ]
}