Create currency conversion lists
post
/fscmRestApi/resources/11.13.18.05/currencyConversionLists
Request
Header Parameters
-
Metadata-Context: string
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: string
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: string
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:
Show Source
object-
accessSets: array
Access Sets
Title:
Access SetsAccess set for the currency conversion list. -
BusinessUnit: string
Maximum Length:
255Name of the business unit. -
BusinessUnitId(required): integer
(int64)
Title:
Business UnitValue that uniquely identifies the business unit. -
conversions: array
Conversion Details
Title:
Conversion DetailsConversion details of the currency conversion list. -
CurrencyConversionDescription: string
Title:
DescriptionMaximum Length:1000Description of the currency conversion list. -
CurrencyConversionName(required): string
Title:
NameMaximum Length:80Name of the currency conversion list. -
CurrencyConvListId: integer
(int64)
Value that uniquely identifies the currency conversion list.
-
EndDate: string
(date-time)
Title:
End DateDate when the currency conversion list expires. -
headerDFF: array
headerDFF
-
StartDate(required): string
(date-time)
Title:
Start DateDate when the currency conversion list goes into effect. -
Status: string
Maximum Length:
255Abbreviation that indicates the status of the currency conversion list. -
StatusCode: string
Title:
StatusMaximum Length:30Default Value:IN_PROGRESSAbbreviation that indicates the status of the currency conversion list.
Nested Schema : Access Sets
Type:
arrayTitle:
Access SetsAccess set for the currency conversion list.
Show Source
Nested Schema : Conversion Details
Type:
arrayTitle:
Conversion DetailsConversion details of the currency conversion list.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AccessSetCode: string
Maximum Length:
255Value that uniquely identifies the currency conversion list. -
AccessSetDescription: string
Maximum Length:
255Description of the access set. -
AccessSetId: integer
(int64)
Value that uniquely identifies the access set.
-
AccessSetName: string
Maximum Length:
255Value that uniquely identifies the access set. -
CurrencyConvListId: integer
(int64)
Value that uniquely identifies the currency conversion list.
-
CurrencyConvListSetId: integer
(int64)
Value that uniquely identifies the access set.
Nested Schema : currencyConversionLists-conversions-item-post-request
Type:
Show Source
object-
AdjustmentType: string
Maximum Length:
255Abbreviation that indicates the adjustment type in the currency conversion. -
AdjustmentTypeCode: string
Title:
Adjustment TypeMaximum Length:30Abbreviation that indicates the adjustment type in the currency conversion. -
AdjustmentValue: number
Title:
Adjustment AmountValue of the adjustment in the currency conversion. -
ConversionRate: number
Title:
Conversion RateRate of the currency conversion. -
ConversionType: string
Maximum Length:
255Abbreviation that indicates the conversion type in the currency conversion. -
ConversionTypeCode: string
Title:
Conversion TypeMaximum Length:30Default Value:FIXEDAbbreviation that indicates the conversion type in the currency conversion. -
CurrencyConvDetailId: integer
(int64)
Value that uniquely identifies the currency conversion detail.
-
CurrencyConvListId(required): integer
(int64)
Value that uniquely identifies the currency conversion list.
-
detailsDFF: array
detailsDFF
-
EndDate: string
(date-time)
Title:
End DateDate when the currency conversion expires. -
FromCurrency: string
Maximum Length:
255Base currency in the conversion. -
FromCurrencyCode(required): string
Title:
Base CurrencyMaximum Length:15Abbreviation that indicates the base currency in the conversion. -
GlConversionType: string
Maximum Length:
255Abbreviation that indicates the conversion type in general ledger in the conversion. -
GlConversionTypeCode: string
Title:
GL Conversion TypeMaximum Length:30Abbreviation that indicates the conversion type in general ledger in the conversion. -
StartDate(required): string
(date-time)
Title:
Start DateEffective date of the currency conversion. -
ToCurrency: string
Maximum Length:
255Target currency of the conversion. -
ToCurrencyCode(required): string
Title:
To CurrencyMaximum Length:15Abbreviation that indicates the target currency of the conversion.
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
CurrencyConvDetailId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
CurrencyConvListId: integer
(int64)
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 : currencyConversionLists-item-response
Type:
Show Source
object-
accessSets: array
Access Sets
Title:
Access SetsAccess set for the currency conversion list. -
BusinessUnit: string
Maximum Length:
255Name of the business unit. -
BusinessUnitId: integer
(int64)
Title:
Business UnitValue that uniquely identifies the business unit. -
conversions: array
Conversion Details
Title:
Conversion DetailsConversion details of the currency conversion list. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
CurrencyConversionDescription: string
Title:
DescriptionMaximum Length:1000Description of the currency conversion list. -
CurrencyConversionName: string
Title:
NameMaximum Length:80Name of the currency conversion list. -
CurrencyConvListId: integer
(int64)
Value that uniquely identifies the currency conversion list.
-
EndDate: string
(date-time)
Title:
End DateDate when the currency conversion list expires. -
headerDFF: array
headerDFF
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StartDate: string
(date-time)
Title:
Start DateDate when the currency conversion list goes into effect. -
Status: string
Maximum Length:
255Abbreviation that indicates the status of the currency conversion list. -
StatusCode: string
Title:
StatusMaximum Length:30Default Value:IN_PROGRESSAbbreviation that indicates the status of the currency conversion list.
Nested Schema : Access Sets
Type:
arrayTitle:
Access SetsAccess set for the currency conversion list.
Show Source
Nested Schema : Conversion Details
Type:
arrayTitle:
Conversion DetailsConversion details of the currency conversion list.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : currencyConversionLists-accessSets-item-response
Type:
Show Source
object-
AccessSetCode: string
Maximum Length:
255Value that uniquely identifies the currency conversion list. -
AccessSetDescription: string
Maximum Length:
255Description of the access set. -
AccessSetId: integer
(int64)
Value that uniquely identifies the access set.
-
AccessSetName: string
Maximum Length:
255Value that uniquely identifies the access set. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
CurrencyConvListId: integer
(int64)
Value that uniquely identifies the currency conversion list.
-
CurrencyConvListSetId: integer
(int64)
Value that uniquely identifies the access set.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : currencyConversionLists-conversions-item-response
Type:
Show Source
object-
AdjustmentType: string
Maximum Length:
255Abbreviation that indicates the adjustment type in the currency conversion. -
AdjustmentTypeCode: string
Title:
Adjustment TypeMaximum Length:30Abbreviation that indicates the adjustment type in the currency conversion. -
AdjustmentValue: number
Title:
Adjustment AmountValue of the adjustment in the currency conversion. -
ConversionRate: number
Title:
Conversion RateRate of the currency conversion. -
ConversionType: string
Maximum Length:
255Abbreviation that indicates the conversion type in the currency conversion. -
ConversionTypeCode: string
Title:
Conversion TypeMaximum Length:30Default Value:FIXEDAbbreviation that indicates the conversion type in the currency conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
CurrencyConvDetailId: integer
(int64)
Value that uniquely identifies the currency conversion detail.
-
CurrencyConvListId: integer
(int64)
Value that uniquely identifies the currency conversion list.
-
detailsDFF: array
detailsDFF
-
EndDate: string
(date-time)
Title:
End DateDate when the currency conversion expires. -
FromCurrency: string
Maximum Length:
255Base currency in the conversion. -
FromCurrencyCode: string
Title:
Base CurrencyMaximum Length:15Abbreviation that indicates the base currency in the conversion. -
GlConversionType: string
Maximum Length:
255Abbreviation that indicates the conversion type in general ledger in the conversion. -
GlConversionTypeCode: string
Title:
GL Conversion TypeMaximum Length:30Abbreviation that indicates the conversion type in general ledger in the conversion. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StartDate: string
(date-time)
Title:
Start DateEffective date of the currency conversion. -
ToCurrency: string
Maximum Length:
255Target currency of the conversion. -
ToCurrencyCode: string
Title:
To CurrencyMaximum Length:15Abbreviation that indicates the target currency of the conversion.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : currencyConversionLists-conversions-detailsDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
CurrencyConvDetailId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : currencyConversionLists-headerDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
CurrencyConvListId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- accessSets
-
Operation: /fscmRestApi/resources/11.13.18.05/currencyConversionLists/{CurrencyConvListId}/child/accessSetsParameters:
- CurrencyConvListId:
$request.path.CurrencyConvListId
Access set for the currency conversion list. - CurrencyConvListId:
- conversions
-
Operation: /fscmRestApi/resources/11.13.18.05/currencyConversionLists/{CurrencyConvListId}/child/conversionsParameters:
- CurrencyConvListId:
$request.path.CurrencyConvListId
Conversion details of the currency conversion list. - CurrencyConvListId:
- headerDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/currencyConversionLists/{CurrencyConvListId}/child/headerDFFParameters:
- CurrencyConvListId:
$request.path.CurrencyConvListId
- CurrencyConvListId: