REST API for Oracle Fusion Cloud Financials

Create a payment instrument assignment

post

/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Request

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.
Upsert-Mode:

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

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.
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.

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "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
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the external payee is an employee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "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
        },
        "PaymentInstrumentAssignmentId":{
            "type":"integer",
            "description":"Identifier of the payment instrument assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "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
        },
        "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
            }
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context(required):

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(required):

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-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 create a payment instrument assignment by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Example Request Body

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

{
	"PaymentPartyId": 300100173366595,
	"PaymentInstrumentId": 300100173366598,
	"PaymentFlow": "DISBURSEMENTS",
	"PaymentInstrumentType": "BANKACCOUNT",
	"Intent": "Supplier"
}

Example Response Body

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

{
	"PaymentPartyId": 300100173366595,
	"PaymentInstrumentId": 300100173366598,
	"PaymentFlow": "DISBURSEMENTS",
	"PaymentInstrumentType": "BANKACCOUNT",
	"Intent": "Supplier",
   ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100173366601",
            "name": "instrumentAssignments",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100173366601",
            "name": "instrumentAssignments",
            "kind": "item"
        }
    ]
}

Example 2

The following example shows how to create a payment instrument assignment for a supplier site by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Example Request Body

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

{
    "PaymentPartyId": 300100180882048,
    "PaymentInstrumentId": 300100181126859,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "Intent": "Supplier"
}

Example Response Body

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

{
    "PaymentInstrumentAssignmentId": 300100181652558,
    "PaymentPartyId": 300100180882048,
    "PaymentInstrumentId": 300100181126859,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "PrimaryIndicator": "Y",
    "StartDate": "2019-11-06",
    "EndDate": "4712-12-31",
    "MaskedBankAccountNumber": "XXXX9655",
    "MaskedCreditCardNumber": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Supplier",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652558",
            "name": "instrumentAssignments",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652558",
            "name": "instrumentAssignments",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652558/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        }
    ]
}

Example 3

The following example shows how to create a payment instrument assignment for a customer site for customer payments by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Example Request Body

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

{
    "PaymentPartyId": 1424,
    "PaymentInstrumentId": 300100181126923,
    "PaymentFlow": "FUNDS_CAPTURE",
    "PaymentInstrumentType": "BANKACCOUNT",
    "Intent": "Customer"
}

Example Response Body

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

{
    "PaymentInstrumentAssignmentId": 300100181652559,
    "PaymentPartyId": 1424,
    "PaymentInstrumentId": 300100181126923,
    "PaymentFlow": "FUNDS_CAPTURE",
    "PaymentInstrumentType": "BANKACCOUNT",
    "PrimaryIndicator": "N",
    "StartDate": "2019-11-06",
    "EndDate": "4712-12-31",
    "MaskedBankAccountNumber": "XXXXX6588",
    "MaskedCreditCardNumber": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Customer",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652559",
            "name": "instrumentAssignments",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652559",
            "name": "instrumentAssignments",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652559/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        }
    ]
}

Example 4

The following example shows how to create a payment instrument assignment for customer refunds by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Example Request Body

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

{
    "PaymentPartyId": 300100180898002,
    "PaymentInstrumentId": 300100181652560,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "Intent": "Customer"
}

Example Response Body

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

{
  "PaymentInstrumentAssignmentId": 300100181652562,
  "PaymentPartyId": 300100180898002,
  "PaymentInstrumentId": 300100181652560,
  "PaymentFlow": "DISBURSEMENTS",
  "PaymentInstrumentType": "BANKACCOUNT",
  "PrimaryIndicator": "Y",
  "StartDate": "2019-11-06",
  "EndDate": "4712-12-31",
  "MaskedBankAccountNumber": "XXXX8777",
  "MaskedCreditCardNumber": null,
  "VendorId": null,
  "PersonId": null,
  "Intent": "Customer",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652562",
      "name": "instrumentAssignments",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652562",
      "name": "instrumentAssignments",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652562/lov/PersonPVA",
      "name": "PersonPVA",
      "kind": "collection"
    }
  ]
}

Example 5

The following example shows how to create a payment instrument assignment for a bank account to be used in Payroll.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Example Request Body

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

{
    "PaymentPartyId": 300100177406393,
    "PaymentInstrumentId": 300100177498426,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "Intent": "Person",
    "PersonId": 300100038082897
}

Example Response Body

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

{
    "PaymentInstrumentAssignmentId": 300100177498435,
    "PaymentPartyId": 300100177406393,
    "PaymentInstrumentId": 300100177498426,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "PrimaryIndicator": "Y",
    "StartDate": "2019-04-02",
    "EndDate": "4712-12-31",
    "MaskedBankAccountNumber": "XXXXX3801",
    "MaskedCreditCardNumber": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Person",
    "OwnerPersonId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100177498435",
            "name": "instrumentAssignments",
            "kind": "item",
            "properties": {
                
 "changeIndicator":
"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100177498435",
            "name": "instrumentAssignments",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100177498435/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        }
    ]
}

Example 6

The following example shows how to create a payment instrument assignment for a bank account to be used in Expenses.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Example Request Body

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

{
    "PaymentPartyId": 300100180898209,
    "PaymentInstrumentId": 300100181126921,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "Intent": "Employee"
}

Example Response Body

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

{
  "PaymentInstrumentAssignmentId": 300100181652563,
  "PaymentPartyId": 300100180898209,
  "PaymentInstrumentId": 300100181126921,
  "PaymentFlow": "DISBURSEMENTS",
  "PaymentInstrumentType": "BANKACCOUNT",
  "PrimaryIndicator": "Y",
  "StartDate": "2019-11-06",
  "EndDate": "4712-12-31",
  "MaskedBankAccountNumber": "XXXX9658",
  "MaskedCreditCardNumber": null,
  "VendorId": null,
  "PersonId": null,
  "Intent": "Employee",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652563",
      "name": "instrumentAssignments",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652563",
      "name": "instrumentAssignments",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181652563/lov/PersonPVA",
      "name": "PersonPVA",
      "kind": "collection"
    }
  ]
}

Example 7

The following example shows how to create a payment instrument assignment for an ad-hoc payee by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Example Request Body

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

{
    "PaymentPartyId": 300100180582389,
    "PaymentInstrumentId": 300100181135401,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "Intent": "Adhoc"
}

Example Response Body

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

{
  "PaymentInstrumentAssignmentId": 300100181538390,
  "PaymentPartyId": 300100180582389,
  "PaymentInstrumentId": 300100181135401,
  "PaymentFlow": "DISBURSEMENTS",
  "PaymentInstrumentType": "BANKACCOUNT",
  "PrimaryIndicator": "Y",
  "StartDate": "2019-11-06",
  "EndDate": "4712-12-31",
  "MaskedBankAccountNumber": "XXXX9644",
  "MaskedCreditCardNumber": null,
  "VendorId": null,
  "PersonId": null,
  "Intent": "Adhoc",
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181538390",
      "name": "instrumentAssignments",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181538390",
      "name": "instrumentAssignments",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181538390/lov/PersonPVA",
      "name": "PersonPVA",
      "kind": "collection"
    }
  ]
}

Example 8

The following example shows how to create a payment instrument assignment for a one-time payee by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments

Example Request Body

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

{
    "PaymentPartyId": 300100180582391,
    "PaymentInstrumentId": 249304,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "Intent": "Onetime"
}

Example Response Body

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

{
    "PaymentInstrumentAssignmentId": 300100181538391,
    "PaymentPartyId": 300100180582391,
    "PaymentInstrumentId": 249304,
    "PaymentFlow": "DISBURSEMENTS",
    "PaymentInstrumentType": "BANKACCOUNT",
    "PrimaryIndicator": "Y",
    "StartDate": "2019-11-06",
    "EndDate": "4712-12-31",
    "MaskedBankAccountNumber": "XXXXXXXXXX1047",
    "MaskedCreditCardNumber": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Onetime",
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181538391",
            "name": "instrumentAssignments",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181538391",
            "name": "instrumentAssignments",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/instrumentAssignments/300100181538391/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        }
    ]
}