1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Instrument Assignments

Get a payment instrument assignment

get

/fscmRestApi/resources/11.13.18.05/instrumentAssignments/{PaymentInstrumentAssignmentId}

Request

Path Parameters
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 : instrumentAssignments-item-response
Type: object
Show Source
  • Date when the relationship between the payment instrument and the payer or payee becomes inactive within a payment instrument assignment.
  • Purpose of the payment instrument assignment. The value is based on the payment function of the external payee or the external payer. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
  • Links
  • Title: Number
    Read Only: true
    Maximum Length: 100
    Bank account number, as a component of a payment instrument assignment, that returns masked values for display purposes.
  • Title: Number
    Read Only: true
    Maximum Length: 30
    Credit card number, as a component of a payment instrument assignment, that returns masked values for display purposes.
  • Title: Payment Flow
    Maximum Length: 30
    Payment flow of funds capture or disbursement transactions within a payment instrument assignment. Values are from the IBY_PAYMENT_FLOW lookup.
  • Identifier of the payment instrument assignment.
  • Identifier of the bank account or credit card payment instrument, which is a component of a payment instrument assignment.
  • Title: Instrument Type
    Maximum Length: 30
    Type of payment instrument, which is a component of a payment instrument assignment. Values from the IBY_INSTRUMENT_TYPES lookup include BANKACCOUNT, CREDITCARD, and DEBITCARD.
  • Identifier of the external payer or external payee who is the party component of the payment instrument assignment.
  • Person identifier when the external payee is an employee.
  • Title: Primary
    Maximum Length: 30
    Indicates whether the payment instrument, as a component of a payment instrument assignment, is the primary payment instrument for the payer or payee. A primary payment instrument automatically populates the transactions.
  • Title: From Assignment Date
    Date when the relationship between the payment instrument and the payer or payee becomes active within a payment instrument assignment.
  • Read Only: true
    Vendor identifier when the account owner party is a supplier.
Back to Top

Examples

The following example shows how to retrieve a payment instrument assignment by submitting a GET request on the REST resource using cURL.

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

Example Response Body

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

{
    "PaymentInstrumentAssignmentId": 759,
    "PaymentPartyId": 503,
    "PaymentInstrumentId": 271,
    "PaymentFlow": "DISBURSEMENTS",
    ...
    "links": [
         {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/759",
            "name": "instrumentAssignments",
            "kind": "item",
            "properties": {
                              "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/759",
            "name": "instrumentAssignments",
            "kind": "item"
        }
    ]
}
Back to Top