Update a bank account use for a bank account
patch
/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}
Request
Path Parameters
-
BankAccountId(required): integer(int64)
The unique identifier of the bank account.
-
bankAccountUsesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BankAccountUseId and GlBankAccountUseId ---for the Bank Account Uses resource and used to uniquely identify an instance of Bank Account Uses. The client should not generate the hash key value. Instead, the client should query on the Bank Account Uses collection resource with a filter on the primary key values in order to navigate to a specific instance of Bank Account Uses.
For example: bankAccountUses?q=BankAccountUseId=<value1>;GlBankAccountUseId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
bankAccountPaymentDocumentCategories: array
Bank Account Payment Document Categories
Title:
Bank Account Payment Document Categories
The bank account payment document categories resource manages the payment method and payment document category associated to the business unit. -
BankChargesAccountCombination: string
The accounting flexfield combination for the bank charges account.
-
CashAccountCombination: string
The accounting flexfield combination for the cash account.
-
CashClearingAccountCombination: string
The accounting flexfield combination for the cash clearing account.
-
EndDate: string
(date)
Title:
End Date
The last date when the record is active. -
ForeignExchangeGainAccountCombination: string
The accounting flexfield combination for the account that posts the realized exchange rate gains.
-
ForeignExchangeLossAccountCombination: string
The accounting flexfield combination for the account that posts the realized exchange rate losses.
Nested Schema : Bank Account Payment Document Categories
Type:
array
Title:
Bank Account Payment Document Categories
The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.
Show Source
Nested Schema : cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-patch-request
Type:
Show Source
object
-
PaymentDocumentCategory: string
Title:
Payment Document Category
The payment document category for the business unit. -
PaymentMethod: string
Title:
Payment Method
The payment method of the payment document category for the business unit.
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 : cashBankAccounts-bankAccountUses-item-response
Type:
Show Source
object
-
bankAccountPaymentDocumentCategories: array
Bank Account Payment Document Categories
Title:
Bank Account Payment Document Categories
The bank account payment document categories resource manages the payment method and payment document category associated to the business unit. -
BankAccountUseId: integer
(int64)
The unique identifier of the bank account use.
-
BankChargesAccountCombination: string
The accounting flexfield combination for the bank charges account.
-
BusinessUnitName: string
Maximum Length:
255
The name of the business unit. At least one business unit name must be provided by the user if the bank account is used for payables or receivables. -
CashAccountCombination: string
The accounting flexfield combination for the cash account.
-
CashClearingAccountCombination: string
The accounting flexfield combination for the cash clearing account.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
EndDate: string
(date)
Title:
End Date
The last date when the record is active. -
ForeignExchangeGainAccountCombination: string
The accounting flexfield combination for the account that posts the realized exchange rate gains.
-
ForeignExchangeLossAccountCombination: string
The accounting flexfield combination for the account that posts the realized exchange rate losses.
-
GlBankAccountUseId: integer
(int64)
The unique identifier of the bank account use.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Bank Account Payment Document Categories
Type:
array
Title:
Bank Account Payment Document Categories
The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-response
Type:
Show Source
object
-
ApPmDocumentCategoryId: integer
(int64)
The unique identifier of the payment document category for the business unit.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentDocumentCategory: string
Title:
Payment Document Category
The payment document category for the business unit. -
PaymentMethod: string
Title:
Payment Method
The payment method of the payment document category for the business unit.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- bankAccountPaymentDocumentCategories
-
Parameters:
- BankAccountId:
$request.path.BankAccountId
- bankAccountUsesUniqID:
$request.path.bankAccountUsesUniqID
The bank account payment document categories resource manages the payment method and payment document category associated to the business unit. - BankAccountId:
Examples
The following example shows how to update a bank account use for a bank account by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X PATCH -d <payload> https://fuscdrmsmc79-fa-ext.us2.oracle.com/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountUses/300100196542415
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "EndDate": "2020-04-18" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "BankAccountUseId": 300100196542415, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-04-18T00:34:35.776+00:00", "EndDate": "2020-04-18", "LastUpdateDate": "2020-04-21T02:37:11+00:00", "LastUpdateLogin": "A38FEA9E660574ADE053D713F50A815E", "LastUpdatedBy": "CASH_MANAGER", "GlBankAccountUseId": 300100196542415, "CashAccountCombination": "01-000-1110-0000-000", "CashClearingAccountCombination": "01-000-1250-0000-000", "BankChargesAccountCombination": "", "ForeignExchangeGainAccountCombination": "", "ForeignExchangeLossAccountCombination": "", "BusinessUnitName": "Vision Operations", "links": [ { "rel": "self", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountUses/00020000000EACED00057708000110F0859CA7CF0000000EACED00057708000110F0859CA7CF", "name": "bankAccountUses", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000037371007E00020000000178" } }, { "rel": "canonical", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountUses/00020000000EACED00057708000110F0859CA7CF0000000EACED00057708000110F0859CA7CF", "name": "bankAccountUses", "kind": "item" }, { "rel": "parent", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495", "name": "cashBankAccounts", "kind": "item" }, { "rel": "lov", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountUses/00020000000EACED00057708000110F0859CA7CF0000000EACED00057708000110F0859CA7CF/lov/BusinessUnitPVOVA", "name": "BusinessUnitPVOVA", "kind": "collection" }, { "rel": "child", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountUses/00020000000EACED00057708000110F0859CA7CF0000000EACED00057708000110F0859CA7CF/child/bankAccountPaymentDocumentCategories", "name": "bankAccountPaymentDocumentCategories", "kind": "collection" } ] }