Get all currencies.
get
/crmRestApi/resources/11.13.18.05/fndCurrencies
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- EnabledFlagFinder Finds all enabled currencies.
Finder Variables- BindEnabledFlag; string;
- PrimaryKey Finds the currency with the specified primary key.
Finder Variables- CurrencyCode; string; The currency code
- EnabledFlagFinder Finds all enabled currencies.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CurrencyCode; string; The currency code
- DeriveEffective; string; The date from which this currency's value becomes derived from the related currency. If this value is null or later than the computation date, then the other derive attributes are undefined.
- DeriveFactor; number; Multiple applied to the base currency to derive this currency. Only used for the derived currency in a relationship.
- DeriveType; string; Indicates whether the currency has a special relationship with other currencies. Currently, only EURO, EMU, and NULL are possible values.
- Description; string; The currency description
- DigitalCurrencyCode; integer; The digital currency code
- EnabledFlag; string; Indicates whether the currency is enabled
- EndDateActive; string; Date at which the currency is no longer active
- ExtendedPrecision; integer; Extended precision of the currency
- GlobalAttributeDate1; string; Reserved for country-specific functionality
- GlobalAttributeDate2; string; Reserved for country-specific functionality
- GlobalAttributeDate3; string; Reserved for country-specific functionality
- GlobalAttributeDate4; string; Reserved for country-specific functionality
- GlobalAttributeDate5; string; Reserved for country-specific functionality
- GlobalAttributeNumber1; number; Reserved for country-specific functionality
- GlobalAttributeNumber2; number; Reserved for country-specific functionality
- GlobalAttributeNumber3; number; Reserved for country-specific functionality
- GlobalAttributeNumber4; number; Reserved for country-specific functionality
- GlobalAttributeNumber5; number; Reserved for country-specific functionality
- GlobalAttributeTimestamp1; string; Reserved for country-specific functionality
- GlobalAttributeTimestamp2; string; Reserved for country-specific functionality
- GlobalAttributeTimestamp3; string; Reserved for country-specific functionality
- GlobalAttributeTimestamp4; string; Reserved for country-specific functionality
- GlobalAttributeTimestamp5; string; Reserved for country-specific functionality
- IsoFlag; string; Indicates whether or not the currency is defined in ISO 4217
- IssuingTerritoryCode; string; The territory issuing this currency
- MinimumAccountableUnit; number; The minimum accountable unit for the currency
- Name; string; The currency name
- Precision; integer; Maximum number of digits to the right of the decimal point
- StartDateActive; string; The date at which this currency becomes active
- Symbol; string; The symbol denoting the currency
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : fndCurrencies
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fndCurrencies-item-response
Type:
Show Source
object
-
Attribute1: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute10: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute11: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute12: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute13: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute14: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute15: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute2: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute3: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute4: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute5: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute6: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute7: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute8: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Attribute9: string
Read Only:
true
Maximum Length:150
One of the descriptive flexfield attributes -
Context: string
Read Only:
true
Maximum Length:80
One of the descriptive flexfield attributes -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
The currency code -
CurrencyFlag: string
Title:
Currency Flag
Read Only:true
Maximum Length:1
Indicates if the currency is a statistical unit or a currency -
DeriveEffective: string
(date)
Title:
Derive Effective Date
Read Only:true
The date from which this currency's value becomes derived from the related currency. If this value is null or later than the computation date, then the other derive attributes are undefined. -
DeriveFactor: number
Title:
Derive Factor
Read Only:true
Multiple applied to the base currency to derive this currency. Only used for the derived currency in a relationship. -
DeriveType: string
Title:
Derive Type
Read Only:true
Maximum Length:8
Indicates whether the currency has a special relationship with other currencies. Currently, only EURO, EMU, and NULL are possible values. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
The currency description -
DigitalCurrencyCode: integer
(int32)
Title:
Numeric Currency Code
Read Only:true
The digital currency code -
EnabledFlag: string
Title:
Enabled
Read Only:true
Maximum Length:1
Indicates whether the currency is enabled -
EndDateActive: string
(date)
Title:
End Date
Read Only:true
Date at which the currency is no longer active -
ExtendedPrecision: integer
(int32)
Title:
Extended Precision
Read Only:true
Extended precision of the currency -
GlobalAttribute1: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute10: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute11: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute12: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute13: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute14: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute15: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute16: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute17: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute18: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute19: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute2: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute20: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute3: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute4: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute5: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute6: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute7: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute8: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttribute9: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttributeCategory: string
Read Only:
true
Maximum Length:150
Reserved for country-specific functionality -
GlobalAttributeDate1: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeDate2: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeDate3: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeDate4: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeDate5: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeNumber1: number
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeNumber2: number
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeNumber3: number
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeNumber4: number
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeNumber5: number
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeTimestamp1: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeTimestamp2: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeTimestamp3: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeTimestamp4: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
GlobalAttributeTimestamp5: string
(date-time)
Read Only:
true
Reserved for country-specific functionality -
IsoFlag: string
Title:
ISO Currency
Read Only:true
Maximum Length:1
Indicates whether or not the currency is defined in ISO 4217 -
IssuingTerritoryCode: string
Title:
Issuing Territory
Read Only:true
Maximum Length:2
The territory issuing this currency -
LastUpdateDate: string
(date-time)
Read Only:
true
The date 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 login of the user who last updated the record -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumAccountableUnit: number
Title:
Minimum Accountable Unit
Read Only:true
The minimum accountable unit for the currency -
Name: string
Title:
Currency Name
Read Only:true
Maximum Length:80
The currency name -
Precision: integer
(int32)
Title:
Precision
Read Only:true
Maximum number of digits to the right of the decimal point -
StartDateActive: string
(date)
Title:
Start Date
Read Only:true
The date at which this currency becomes active -
Symbol: string
Title:
Symbol
Read Only:true
Maximum Length:12
The symbol denoting the currency
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.