Get a bank account use for a bank account
/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}
Request
-
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>
-
dependency: string
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
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.
Back to TopResponse
- application/json
Default Response
-
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.
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.
array
Bank Account Payment Document Categories
array
Links
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.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- 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 retrieve a bank account use for a bank account.
Get all the bank account uses and use the self URI of the specific bank account use.
Here's the cURL command to retrieve all the bank account uses.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankAccounts/10078/child/bankAccountUses
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"items": [
{
"BankAccountUseId": 10078,
"CreatedBy": "2190",
"CreationDate": "1999-12-10T01:33:03+00:00",
"EndDate": null,
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankAccounts/10078/child/bankAccountUses/00020000000EACED00057708000000000000275E0000000EACED00057708000000000000275E",
"name": "bankAccountUses",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000027704000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankAccounts/10078/child/bankAccountUses/00020000000EACED00057708000000000000275E0000000EACED00057708000000000000275E/child/bankAccountPaymentDocumentCategories",
"name": "bankAccountPaymentDocumentCategories",
"kind": "collection"
},
...
]
},
...
],
"count": 150,
"hasMore": false,
"limit": 500,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankAccounts/10078/child/bankAccountUses",
"name": "bankAccountUses",
"kind": "collection"
}
]
}
A
hash key of BankAccountUseId
and GlBankAccountUseId
identifies a bank account use.
Here's the cURL command that uses the hash key in the self URI to retrieve the bank account use.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankAccounts/10078/child/bankAccountUses/00020000000EACED00057708000000000000275E0000000EACED00057708000000000000275E
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "BankAccountUseId": 10078, "CreatedBy": "2190", "CreationDate": "1999-12-10T01:33:03+00:00", "EndDate": null, ... "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankAccounts/10078/child/bankAccountUses/00020000000EACED00057708000000000000275E0000000EACED00057708000000000000275E", "name": "bankAccountUses", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000027704000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankAccounts/10078/child/bankAccountUses/00020000000EACED00057708000000000000275E0000000EACED00057708000000000000275E/child/bankAccountPaymentDocumentCategories", "name": "bankAccountPaymentDocumentCategories", "kind": "collection" }, ... ] }