Jump to

• Request
• Response

Update a foreign exchange revaluation setup

patch

/fscmRestApi/resources/11.13.18.05/fxRevaluationSetups/{fxRevaluationSetupsUniqID}

Request

Path Parameters

• fxRevaluationSetupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LedgerId, CurrencyCode and BalanceSheetFxPositionCcid ---for the Foreign Exchange (FX) Revaluation Setups resource and used to uniquely identify an instance of Foreign Exchange (FX) Revaluation Setups. The client should not generate the hash key value. Instead, the client should query on the Foreign Exchange (FX) Revaluation Setups collection resource with a filter on the primary key values in order to navigate to a specific instance of Foreign Exchange (FX) Revaluation Setups.
  
  For example: fxRevaluationSetups?q=LedgerId=<value1>;CurrencyCode=<value2>;BalanceSheetFxPositionCcid=<value3>

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BalanceSheetAdjustmentAccount: string
  Title: Balance Sheet Adjustment Account

  Maximum Length: 255

  The balance sheet adjustment account associated with the balance sheet FX position account.
• BalanceSheetFxCounterPositionAccount: string
  Title: Balance Sheet FX Counter Position Account

  Maximum Length: 255

  The counter position account for balance sheet FX revaluation.
• BalanceSheetFxPositionAccount: string
  Title: Balance Sheet FX Position Account

  Maximum Length: 255

  The position account for balance sheet FX revaluation.
• EquivalencyCheck: string
  Title: Require Same Accounted Balance for FX Position and FX Counter Position Accounts

  Maximum Length: 1

  Indicates whether the ledger currency balances of the balance sheet FX position account and the balance sheet FX counter position account must be the same.
• ForeignExchangeGainAccount: string
  Title: FX Gain Account

  Maximum Length: 255

  The foreign exchange gain account for balance sheet FX revaluation.
• ForeignExchangeLossAccount: string
  Title: FX Loss Account

  Maximum Length: 255

  The foreign exchange loss account for balance sheet FX revaluation.
• OffBalanceSheetAdjustmentAccount: string
  Title: Off-Balance Sheet Adjustment Account

  Maximum Length: 255

  The off-balance sheet adjustment account associated with the off-balance sheet FX position account.
• OffBalanceSheetType: string
  Title: Classify Account as Off-Balance Sheet

  Maximum Length: 1

  Indicates whether the balance sheet FX position account is an off-balance sheet.

{
    "type":"object",
    "properties":{
        "BalanceSheetFxCounterPositionAccount":{
            "title":"Balance Sheet FX Counter Position Account",
            "maxLength":"255",
            "type":"string",
            "description":"The counter position account for balance sheet FX revaluation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#CounterBalanceSheetDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"CounterBalanceSheetCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "OffBalanceSheetType":{
            "title":"Classify Account as Off-Balance Sheet",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the balance sheet FX position account is an off-balance sheet.",
            "nullable":false
        },
        "EquivalencyCheck":{
            "title":"Require Same Accounted Balance for FX Position and FX Counter Position Accounts",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the ledger currency balances of the balance sheet FX position account and the balance sheet FX counter position account must be the same.",
            "nullable":false
        },
        "ForeignExchangeGainAccount":{
            "title":"FX Gain Account",
            "maxLength":"255",
            "type":"string",
            "description":"The foreign exchange gain account for balance sheet FX revaluation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#ExchangeGainDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"ExchangeGainCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "BalanceSheetAdjustmentAccount":{
            "title":"Balance Sheet Adjustment Account",
            "maxLength":"255",
            "type":"string",
            "description":"The balance sheet adjustment account associated with the balance sheet FX position account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#AdjBalanceSheetDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"BalanceSheetAdjCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "OffBalanceSheetAdjustmentAccount":{
            "title":"Off-Balance Sheet Adjustment Account",
            "maxLength":"255",
            "type":"string",
            "description":"The off-balance sheet adjustment account associated with the off-balance sheet FX position account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#OffBalanceSheetAdjDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"OffBalanceSheetAdjCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "BalanceSheetFxPositionAccount":{
            "title":"Balance Sheet FX Position Account",
            "maxLength":"255",
            "type":"string",
            "description":"The position account for balance sheet FX revaluation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#BalanceSheetFxPositionDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"BalanceSheetFxPositionCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "ForeignExchangeLossAccount":{
            "title":"FX Loss Account",
            "maxLength":"255",
            "type":"string",
            "description":"The foreign exchange loss account for balance sheet FX revaluation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#ExchangeLossDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"ExchangeLossCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : fxRevaluationSetups-item-response

Type: object

Show Source

• BalanceSheetAdjustmentAccount: string
  Title: Balance Sheet Adjustment Account

  Maximum Length: 255

  The balance sheet adjustment account associated with the balance sheet FX position account.
• BalanceSheetFxCounterPositionAccount: string
  Title: Balance Sheet FX Counter Position Account

  Maximum Length: 255

  The counter position account for balance sheet FX revaluation.
• BalanceSheetFxPositionAccount: string
  Title: Balance Sheet FX Position Account

  Maximum Length: 255

  The position account for balance sheet FX revaluation.
• BalanceSheetFxPositionCcid: integer (int64)
  Title: Balance Sheet FX Position Account

  The unique identifier of the FX revaluation setup.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The three-letter ISO code associated with the foreign currency of the income statement account.
• EquivalencyCheck: string
  Title: Require Same Accounted Balance for FX Position and FX Counter Position Accounts

  Maximum Length: 1

  Indicates whether the ledger currency balances of the balance sheet FX position account and the balance sheet FX counter position account must be the same.
• ForeignExchangeGainAccount: string
  Title: FX Gain Account

  Maximum Length: 255

  The foreign exchange gain account for balance sheet FX revaluation.
• ForeignExchangeLossAccount: string
  Title: FX Loss Account

  Maximum Length: 255

  The foreign exchange loss account for balance sheet FX revaluation.
• Ledger: string
  Title: Ledger

  Maximum Length: 30

  The ledger associates with the associated with the balance sheet FX position account.
• LedgerId: integer (int64)
  The ledger associates with the associated with the balance sheet FX position account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OffBalanceSheetAdjustmentAccount: string
  Title: Off-Balance Sheet Adjustment Account

  Maximum Length: 255

  The off-balance sheet adjustment account associated with the off-balance sheet FX position account.
• OffBalanceSheetType: string
  Title: Classify Account as Off-Balance Sheet

  Maximum Length: 1

  Indicates whether the balance sheet FX position account is an off-balance sheet.

{
    "type":"object",
    "properties":{
        "BalanceSheetFxPositionCcid":{
            "title":"Balance Sheet FX Position Account",
            "type":"integer",
            "description":"The unique identifier of the FX revaluation setup.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_CCID":"BalanceSheetFxPositionDetails",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Ledger":{
            "title":"Ledger",
            "maxLength":"30",
            "type":"string",
            "description":"The ledger associates with the associated with the balance sheet FX position account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceSheetAdjustmentAccount":{
            "title":"Balance Sheet Adjustment Account",
            "maxLength":"255",
            "type":"string",
            "description":"The balance sheet adjustment account associated with the balance sheet FX position account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#AdjBalanceSheetDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"BalanceSheetAdjCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "LedgerId":{
            "type":"integer",
            "description":"The ledger associates with the associated with the balance sheet FX position account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OffBalanceSheetAdjustmentAccount":{
            "title":"Off-Balance Sheet Adjustment Account",
            "maxLength":"255",
            "type":"string",
            "description":"The off-balance sheet adjustment account associated with the off-balance sheet FX position account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#OffBalanceSheetAdjDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"OffBalanceSheetAdjCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "ForeignExchangeLossAccount":{
            "title":"FX Loss Account",
            "maxLength":"255",
            "type":"string",
            "description":"The foreign exchange loss account for balance sheet FX revaluation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#ExchangeLossDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"ExchangeLossCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The three-letter ISO code associated with the foreign currency of the income statement account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceSheetFxCounterPositionAccount":{
            "title":"Balance Sheet FX Counter Position Account",
            "maxLength":"255",
            "type":"string",
            "description":"The counter position account for balance sheet FX revaluation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#CounterBalanceSheetDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"CounterBalanceSheetCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "OffBalanceSheetType":{
            "title":"Classify Account as Off-Balance Sheet",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the balance sheet FX position account is an off-balance sheet.",
            "nullable":false,
            "x-queryable":true
        },
        "EquivalencyCheck":{
            "title":"Require Same Accounted Balance for FX Position and FX Counter Position Accounts",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the ledger currency balances of the balance sheet FX position account and the balance sheet FX counter position account must be the same.",
            "nullable":false,
            "x-queryable":true
        },
        "ForeignExchangeGainAccount":{
            "title":"FX Gain Account",
            "maxLength":"255",
            "type":"string",
            "description":"The foreign exchange gain account for balance sheet FX revaluation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#ExchangeGainDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"ExchangeGainCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BalanceSheetFxPositionAccount":{
            "title":"Balance Sheet FX Position Account",
            "maxLength":"255",
            "type":"string",
            "description":"The position account for balance sheet FX revaluation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.generalLedger.currencies.revaluation.model.view.GlRevalFxPositionAccountsVO#BalanceSheetFxPositionDetails",
                "FND_ACFF_ResourceName":"fxRevaluationSetup",
                "ojStructureInstanceNumber":"BalanceSheetFxPositionCoa"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "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."
        }
    }
}

Back to Top