# Save Currency

Save Currency

Endpoint: POST /rest/2.0/CURRENCY
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Id` (string, required)
    Currency Code: Currency

  - `brmObjects.Place` (string)
    Place: Location where currency is used

  - `brmObjects.CurrencyName` (string)
    Currency Name: Full Name of the currency

  - `brmObjects.CurrencySign` (string)
    Currency Sign: Sign of the currency

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.CurrencyLevelRounding` (integer)
    Currency-Level Rounding: When Currency-Level Rounding is not enabled, the currency will use the system-wide rounding rule settings. When enabled at the currency level, the rounding rules defined for the currency override the system-wide rounding rule settings

  - `brmObjects.CostRoundingRule` (string, required)
    Cost Rounding Rule: The cost rounding rule setting allows user to define if the cost value should be rounded up, down, or use mathematical rounding. The 3 rounding rule options include:Math Round - The system will round up or down depending on if the decimal values are more or less than 5Round Up - The system will round up if there is a decimalRound Down - The system will round down if there is a decimal (e.g. if the decimal rounding setting is 0 then $50.999 will be rounded to $50.00)

  - `brmObjects.TaxCostRoundingRule` (string, required)
    Tax Cost Rounding Rule: The tax cost rounding rule setting allows user to define if the tax cost value should be rounded up, down, or use mathematical rounding. The 3 rounding rule options include:Math Round - The system will round up or down depending on if the decimal values are more or less than 5Round Up - The system will round up if there is a decimalRound Down - The system will round down if there is a decimal (e.g. if the decimal rounding setting is 0 then $50.999 will be rounded to $50.00)

  - `brmObjects.DecimalRounding` (string, required)
    Decimal Rounding: The decimal rounding setting allows users to define the currency increment used for rounding. This is used when working with currencies that do not round to the nearest cent. (e.g. in Japan, currency values are often rounded down to the nearest Yen). There are 3 decimal rounding options including:Nearest .01 increment - Currency values will include 2 decimals and round to the nearest .01 increment (e.g. nearest 1 cent)Nearest .05 increment - Currency values will include 2 decimals and round to the nearest .05 increment (e.g. nearest 5 cents)Nearest whole number - Currency values will include no decimals. Amounts will be rounded to the nearest whole number

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.Id` (string)
    Currency Code: Currency

  - `retrieveResponse.Place` (string)
    Place: Location where currency is used

  - `retrieveResponse.CurrencyName` (string)
    Currency Name: Full Name of the currency

  - `retrieveResponse.CurrencySign` (string)
    Currency Sign: Sign of the currency

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.CurrencyLevelRounding` (integer)
    Currency-Level Rounding: When Currency-Level Rounding is not enabled, the currency will use the system-wide rounding rule settings. When enabled at the currency level, the rounding rules defined for the currency override the system-wide rounding rule settings

  - `retrieveResponse.CostRoundingRule` (string)
    Cost Rounding Rule: The cost rounding rule setting allows user to define if the cost value should be rounded up, down, or use mathematical rounding. The 3 rounding rule options include:Math Round - The system will round up or down depending on if the decimal values are more or less than 5Round Up - The system will round up if there is a decimalRound Down - The system will round down if there is a decimal (e.g. if the decimal rounding setting is 0 then $50.999 will be rounded to $50.00)

  - `retrieveResponse.TaxCostRoundingRule` (string)
    Tax Cost Rounding Rule: The tax cost rounding rule setting allows user to define if the tax cost value should be rounded up, down, or use mathematical rounding. The 3 rounding rule options include:Math Round - The system will round up or down depending on if the decimal values are more or less than 5Round Up - The system will round up if there is a decimalRound Down - The system will round down if there is a decimal (e.g. if the decimal rounding setting is 0 then $50.999 will be rounded to $50.00)

  - `retrieveResponse.DecimalRounding` (string)
    Decimal Rounding: The decimal rounding setting allows users to define the currency increment used for rounding. This is used when working with currencies that do not round to the nearest cent. (e.g. in Japan, currency values are often rounded down to the nearest Yen). There are 3 decimal rounding options including:Nearest .01 increment - Currency values will include 2 decimals and round to the nearest .01 increment (e.g. nearest 1 cent)Nearest .05 increment - Currency values will include 2 decimals and round to the nearest .05 increment (e.g. nearest 5 cents)Nearest whole number - Currency values will include no decimals. Amounts will be rounded to the nearest whole number

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error