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

Get a debit authorization version

get

/fscmRestApi/resources/11.13.18.05/debitAuthorizations/{debitAuthorizationsUniqID}/child/debitAuthorizationVersions/{debitAuthorizationVersionsUniqID}

Request

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

    For example: debitAuthorizationVersions?q=DebitAuthorizationId=<value1>;VersionNumber=<value2>
  • 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>
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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-debitAuthorizationVersions-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve a debit authorization version for a debit authorization:
  • Get all the debit authorizations.
  • Use the self URI of the specific debit authorization.
  • Get all the debit authorization versions.
  • Use the self URI of the specific debit authorization version.

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

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

Example Response Body

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

{
    "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/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000014C49142800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07CC996D3",
                    "name": "debitAuthorizations",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                                  }
                },
                {
                    "rel": "child",
                    "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000014C49142800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07CC996D3/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 https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000014C49142800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07CC996D3

Here's the cURL command that uses the child URI of the debit authorization to retrieve all the debit authorization versions.

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

Here's the cURL command that uses the self URI to retrieve the debit authorization version.

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

Example Response Body

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

{
    "DebitAuthorizationId": 300100048492243,
    "EffectiveStartDate": "2014-08-08",
    "EffectiveEndDate": "2015-03-23",
    "DebitAuthorizationReferenceNumber": "300100037459936",
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000014C49142800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07CC996D3/child/debitAuthorizationVersions/300100048492243",
            "name": "debitAuthorizationVersions",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000014C49142800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07CC996D3/child/debitAuthorizationVersions/300100048492243",
            "name": "debitAuthorizationVersions",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000014C49142800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07CC996D3",
            "name": "debitAuthorizations",
            "kind": "item"
        }
    ]
}
Back to Top