REST API for Oracle Fusion Cloud Financials

Get all payment instrument assignments

get

/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Request

Query Parameters

expand: string

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).
fields: string

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
finder: string
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:
- PaymentInstrumentAttributes: Finds the payment instrument assignments that match specified search parameters.
  Finder Variables:
  - Intent; string.
  - PaymentFlow; string; The payment flow of the payment instrument assignment.
  - PaymentInstrumentAssignmentId; integer; The identifier of a payment instrument assignment.
  - PaymentInstrumentId; integer; The identifier of the payment instrument, which is a component of a payment instrument assignment.
  - PaymentInstrumentType; string; The type of payment instrument, which is a component of a payment instrument assignment.
  - PaymentPartyId; integer; The identifier of the payee or payer who is a component of the payment instrument assignment.
  - PrimaryIndicator; string; The primary indicator of the payment instrument assignment.
- PrimaryKey: Finds the payment instrument assignment with the specified primary key.
  Finder Variables:
  - PaymentInstrumentAssignmentId; integer; The identifier of a payment instrument assignment.
limit: integer

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.
links: string

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
offset: integer

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.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

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
q: string
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:
- EndDate; string; Date when the relationship between the payment instrument and the payer or payee becomes inactive within a payment instrument assignment.
- MaskedBankAccountNumber; string; Bank account number, as a component of a payment instrument assignment, that returns masked values for display purposes.
- MaskedCreditCardNumber; string; Credit card number, as a component of a payment instrument assignment, that returns masked values for display purposes.
- PaymentFlow; string; Payment flow of funds capture or disbursement transactions within a payment instrument assignment. Values are from the IBY_PAYMENT_FLOW lookup.
- PaymentInstrumentAssignmentId; integer; Identifier of the payment instrument assignment.
- PaymentInstrumentId; integer; Identifier of the bank account or credit card payment instrument, which is a component of a payment instrument assignment.
- PaymentInstrumentType; string; 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.
- PaymentPartyId; integer; Identifier of the external payer or external payee who is the party component of the payment instrument assignment.
- PersonId; integer; Person identifier when the external payee is an employee.
- PrimaryIndicator; string; 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.
- StartDate; string; Date when the relationship between the payment instrument and the payer or payee becomes active within a payment instrument assignment.
- VendorId; integer; Vendor identifier when the account owner party is a supplier.
totalResults: boolean

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

Metadata-Context:

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".
REST-Framework-Version:

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.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

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".
REST-Framework-Version:

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.

Root Schema : instrumentAssignments

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/instrumentAssignments-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object instrumentAssignments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/instrumentAssignments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : instrumentAssignments-item-response

Type: object

Show Source

EndDate: string (date)

Date when the relationship between the payment instrument and the payer or payee becomes inactive within a payment instrument assignment.
Intent: string

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: array Links

Title: Links

The link relations associated with the resource instance.
MaskedBankAccountNumber: string

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.
MaskedCreditCardNumber: string

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.
PaymentFlow: string

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.
PaymentInstrumentAssignmentId: integer (int64)

Identifier of the payment instrument assignment.
PaymentInstrumentId: integer (int64)

Identifier of the bank account or credit card payment instrument, which is a component of a payment instrument assignment.
PaymentInstrumentType: string

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.
PaymentPartyId: integer (int64)

Identifier of the external payer or external payee who is the party component of the payment instrument assignment.
PersonId: integer

Person identifier when the external payee is an employee.
PrimaryIndicator: string

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.
StartDate: string (date)

Title: From Assignment Date

Date when the relationship between the payment instrument and the payer or payee becomes active within a payment instrument assignment.
VendorId: integer (int64)

Read Only: true

Vendor identifier when the account owner party is a supplier.

{
    "type":"object",
    "properties":{
        "MaskedBankAccountNumber":{
            "title":"Number",
            "maxLength":"100",
            "type":"string",
            "description":"Bank account number, as a component of a payment instrument assignment, that returns masked values for display purposes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentFlow":{
            "title":"Payment Flow",
            "maxLength":"30",
            "type":"string",
            "description":"Payment flow of funds capture or disbursement transactions within a payment instrument assignment. Values are from the IBY_PAYMENT_FLOW lookup.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryIndicator":{
            "title":"Primary",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Vendor identifier when the account owner party is a supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentInstrumentAssignmentId":{
            "type":"integer",
            "description":"Identifier of the payment instrument assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Intent":{
            "type":"string",
            "description":"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, \nAR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and \nADHOC_PAYMENT - Adhoc.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentInstrumentType":{
            "title":"Instrument Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the relationship between the payment instrument and the payer or payee becomes inactive within a payment instrument assignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentPartyId":{
            "type":"integer",
            "description":"Identifier of the external payer or external payee who is the party component of the payment instrument assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Assignment Date",
            "type":"string",
            "description":"Date when the relationship between the payment instrument and the payer or payee becomes active within a payment instrument assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the external payee is an employee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MaskedCreditCardNumber":{
            "title":"Number",
            "maxLength":"30",
            "type":"string",
            "description":"Credit card number, as a component of a payment instrument assignment, that returns masked values for display purposes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PaymentInstrumentId":{
            "type":"integer",
            "description":"Identifier of the bank account or credit card payment instrument, which is a component of a payment instrument assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Examples

Example 1

The following example shows how to retrieve all the payment instrument assignments 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/instrumentAssignments?finder=PaymentInstrumentAttributes;PaymentPartyId=503,Intent=Supplier

Example Response Body