Sign in
Currency

Create Currency

Creates a new Currency for the specified Organization.

Used to create a Currency that your Organization will start to use.

post/organizations/{orgId}/picklists/currency

Path parameters

orgIdstring required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
codestring

The short code for the entity.

namestring required

The name of the entity.

archivedboolean

A Boolean TRUE / FALSE flag indicating whether the entity is archived. An entity can be archived if it is obsolete.

  • TRUE - the entity is in the archived state.
  • FALSE - the entity is not in the archived state.
maxDecimalPlacesinteger

Indicates the maximum number of decimal places to use for this Currency.

roundingMode'UP' | 'DOWN' | 'CEILING' | 'FLOOR' | 'HALF_UP' | 'HALF_DOWN' | 'HALF_EVEN' | 'UNNECESSARY'

Example request

{
  "code": "code",
  "maxDecimalPlaces": 2
}

Response

Returns the created Currency

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
codestring

The short code of the data entity.

namestring

The name of the data entity.

archivedboolean

TRUE / FALSE flag indicating whether the data entity is archived. An entity can be archived if it is obsolete.

maxDecimalPlacesinteger

This indicates the maximum number of decimal places to use for this Currency.

roundingMode'UP' | 'DOWN' | 'CEILING' | 'FLOOR' | 'HALF_UP' | 'HALF_DOWN' | 'HALF_EVEN' | 'UNNECESSARY'
dtCreatedstring date-time

The date and time (in ISO-8601 format) when the Currency was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the Currency was last modified.

createdBystring

The unique identifier (UUID) of the user who created this Currency.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this Currency.

Changes

Changed in 1 of the 10 revisions of this API.2

  • 9f9e5f3dbde72See the full diff
    • ▲

      the response property allOf[AbstractPickListResponse]/allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog