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

Get all debit authorizations

get

/fscmRestApi/resources/11.13.18.05/debitAuthorizations

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the debit authorization with the specified primary key.
      Finder Variables:
      • DebitAuthorizationId; integer; The identifier of the debit authorization.
      • EffectiveEndDate; string; The effective end date of the debit authorization.
      • EffectiveStartDate; string; The effective start date of the debit authorization.
    • SearchDebitAuthorization: Finds debit authorizations that match specified search parameters.
      Finder Variables:
      • CustomerBankAccountIdentifier; integer; The customer bank account identifier on the debit authorization.
      • CustomerBankAccountNumber; string; The customer bank account number on the debit authorization.
      • CustomerPartyIdentifier; integer; The customer party identifier on the debit authorization.
      • CustomerPartyName; string; The customer party name on the debit authorization.
      • CustomerPartyNumber; string; The customer party number on the debit authorization.
      • DebitAuthorizationId; integer; The identifier of the debit authorization.
      • DebitAuthorizationReferenceNumber; string; The user-specified reference number of the debit authorization.
      • IBAN; string; The International Bank Account Number (IBAN) of the customer bank account that is present on the debit authorization.
      • LegalEntityIdentifier; integer; The legal entity identifier on the debit authorization.
      • LegalEntityName; string; The legal entity name present on the debit authorization.
      • SysEffectiveDate; object.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AuthorizationMethod; string; Method of delivering the debit authorization. Values include Digital Signature, Written Document, Phone, and Other.
    • BIC; string; Bank Identifier Code (BIC), which is the identifier code used by SWIFT to identify a bank or bank branch. The BIC is a universal method of identifying financial institutions to facilitate the automated processing of telecommunication messages in banking and related financial environments.
    • BankAccountCountry; string; Name of the country where a customer has a bank account.
    • BankAccountCurrency; string; Currency of the customer's bank account.
    • BankBranchName; string; Name of the bank branch where a customer has an account.
    • BankName; string; Name of the bank where a customer has an account.
    • CancellationDate; string; Date when the debtor canceled the debit authorization.
    • CreditorIdentificationNumber; string; Identification number of the creditor, as provided on the debit authorization document.
    • CustomerBankAccountIdentifier; integer; Identifier of a customer bank account.
    • CustomerBankAccountNumber; string; Bank account number of a customer. For display purposes, the masked value is returned.
    • CustomerPartyIdentifier; integer; Party identifier of the debtor.
    • CustomerPartyName; string; Party name of the debtor.
    • CustomerPartyNumber; string; Party number of the debtor.
    • DebitAuthorizationId; integer; Identifier of a debit authorization.
    • DebitAuthorizationReferenceNumber; string; Unique user-specified reference number of a debit authorization.
    • DirectDebitCount; integer; Number of direct debit transactions attributed to a debit authorization.
    • EffectiveEndDate; string; Date when the debit authorization ended.
    • EffectiveStartDate; string; Date when the debit authorization started.
    • FinalCollectionDate; string; Date when the final collection of a direct debit was made, according to the debit authorization.
    • Frequency; string; Regularity with which direct debit instructions are created and processed.
    • IBAN; string; International Bank Account Number (IBAN), which is an alphanumeric sequence that conforms to the ISO standard for uniquely identifying a bank account number internationally. The standard IBAN carries all the routing information needed to get a payment from one bank to another.
    • LegalEntityIdentifier; integer; Identifier of a legal entity.
    • LegalEntityName; string; Name of the legal entity on the debit authorization.
    • PrimaryIndicator; string; Indicates whether a debit authorization is primary.
    • ReasonForAmendment; string; Reason for amending a debt authorization.
    • SigningDate; string; Date when the debtor signed the debit authorization.
    • Status; string; Indicates whether a debit authorization is active or inactive.
    • TransactionType; string; Type of debit authorization, one-off or recurring.
    • VersionNumber; integer; Version number of the debit authorization. The version is set at 1 and increases with each new amendment.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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
Back to Top

Examples

The following example shows how to retrieve all the debit authorizations by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+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/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001477F6AA000780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07C213FDF",
                    "name": "debitAuthorizations",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                                  }
                },
                {
                    "rel": "child",
                    "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/debitAuthorizations/00030000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001477F6AA000780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07C213FDF/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"
        }
    ]
}
Back to Top