Currencies.create - PipelinerCRM

Creates new Currency

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Currency on create. Use them as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,
16 - allows to set entity on deleted relationship.

Body Params application / json

code

string

required

Name of the entity and its default text representation.

Example:

string

symbol

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

currency_exchange_rates

array [object {1}]

required

Relations to CurrencyExchangeRatesLists.

string <uri>

optional

Example

{
    "code": "string",
    "symbol": "string",
    "revision": 1,
    "currency_exchange_rates": [
        {
            "id": "http://example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created Currency

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Currency)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

code

string

required

Name of the entity and its default text representation.

Example:

string

is_base

boolean

read-onlyoptional

Boolean value.

Example:

false

symbol

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

currency_exchange_rates

array[string <uri>]

required

Relations to CurrencyExchangeRatesLists.

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "code": "string",
        "is_base": false,
        "symbol": "string",
        "revision": 1,
        "currency_exchange_rates": [
            "http://example.com"
        ]
    }
}

🔴500Server Error