1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Debit Authorizations

Update a debit authorization

patch

/fscmRestApi/resources/11.13.18.05/debitAuthorizations/{debitAuthorizationsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- EffectiveStartDate, EffectiveEndDate and DebitAuthorizationId ---for the Debit Authorizations resource and used to uniquely identify an instance of Debit Authorizations. The client should not generate the hash key value. Instead, the client should query on the Debit Authorizations collection resource with a filter on the primary key values in order to navigate to a specific instance of Debit Authorizations.

    For example: debitAuthorizations?q=EffectiveStartDate=<value1>;EffectiveEndDate=<value2>;DebitAuthorizationId=<value3>
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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 : Debit Authorization Versions
Type: array
Title: Debit Authorization Versions
The debit authorization version resource is used to view a debit authorization version.
Show Source
Nested Schema : debitAuthorizations-debitAuthorizationVersions-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 : debitAuthorizations-item-response
Type: object
Show Source
Nested Schema : Debit Authorization Versions
Type: array
Title: Debit Authorization Versions
The debit authorization version resource is used to view a debit authorization version.
Show Source
Nested Schema : debitAuthorizations-debitAuthorizationVersions-item-response
Type: object
Show Source
Links
debitAuthorizationVersions
Parameters:
  • debitAuthorizationsUniqID: $request.path.debitAuthorizationsUniqID
The debit authorization version resource is used to view a debit authorization version.
Back to Top

Examples

The following example shows how to retrieve and update a debit authorization.

Get all the debit authorizations and use the self URI of the specific a debit authorization. Then, submit a PATCH request on the REST resource using cURL.

Here's the cURL command to retrieve all the debit authorizations.

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

Example Response Body

{
    "items": [
        {
            "DebitAuthorizationReferenceNumber": "300100037459936",
            "CustomerBankAccountNumber": "XXXXXX1156",
            "BankName": "Bank of America",
            "BankBranchName": "New York",
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5",
                    "name": "debitAuthorizations",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                                  }
                },
                {
                    "rel": "child",
                    "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5/child/debitAuthorizationVersions",
                    "name": "debitAuthorizationVersions",
                    "kind": "collection"
                },
                ...
            ]
        },
        ...
    ],
    "count": 25,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations",
            "name": "debitAuthorizations",
            "kind": "collection"
        }
    ]
}

A hash key of EffectiveStartDate, EffectiveEndDate, and DebitAuthorizationId identifies a debit authorization.

Here's the cURL command that uses the hash key in the self URI to retrieve the debit authorization.

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

Here's the cURL command that uses the hash key in the self URI to update the debit authorization.

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/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5

Example Request Payload

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

{
"Frequency": "Daily",
"AuthorizationMethod": "Phone"
}

Example Response Body

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

{
    "DebitAuthorizationReferenceNumber": "900301",
    "CustomerBankAccountNumber": "XXXX6916",
    "Frequency": "Daily",
    "AuthorizationMethod": "Phone",
	...
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5",
            "name": "debitAuthorizations",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167579D8400780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F0841456B5/child/debitAuthorizationVersions",
            "name": "debitAuthorizationVersions",
            "kind": "collection"
        },
        ...
    ]
}
Back to Top