Heartwork API

Currencies

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/core-api/internationalization/currencies

query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Code

Query

string

ids

string[]

external_references

string[]

codes

string[]

Responses

object[] · required

total

integer · int32 · required

GET/core-api/internationalization/currencies

curl --request GET \
  --url https://api.heart.work/core-api/internationalization/currencies

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "code": "code",
      "isDefault": true,
      "conversionRate": 0
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/internationalization/currencies

Request Body

code

string · required

conversionRate

number · double · required

externalReference

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

code

string · required

isDefault

boolean · required

conversionRate

number · double · required

externalReference

string

POST/core-api/internationalization/currencies

curl --request POST \
  --url https://api.heart.work/core-api/internationalization/currencies \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "code": "code",
  "conversionRate": 0
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "code": "code",
  "conversionRate": 0
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "code": "code",
  "isDefault": true,
  "conversionRate": 0
}

plain

GET

https://api.heart.work

/core-api/internationalization/currencies/available

Responses

object[] · required

total

integer · int32 · required

GET/core-api/internationalization/currencies/available

curl --request GET \
  --url https://api.heart.work/core-api/internationalization/currencies/available

shell

Example Responses

{
  "data": [
    {
      "code": "code"
    }
  ],
  "total": 0
}

plain

PUT

https://api.heart.work

/core-api/internationalization/currencies/{id}

path Parameters

id

string · required

Request Body

id

string · required

conversionRate

number · double · required

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

code

string · required

isDefault

boolean · required

conversionRate

number · double · required

externalReference

string

PUT/core-api/internationalization/currencies/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/internationalization/currencies/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "conversionRate": 0
}
'

shell

Example Request Body

{
  "id": "id",
  "conversionRate": 0
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "code": "code",
  "isDefault": true,
  "conversionRate": 0
}

plain

ContentPages Deals

Heartwork API

Currencies

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/core-api/internationalization/currencies

query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Code

Query

string

ids

string[]

external_references

string[]

codes

string[]

Responses

object[] · required

total

integer · int32 · required

GET/core-api/internationalization/currencies

curl --request GET \
  --url https://api.heart.work/core-api/internationalization/currencies

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "code": "code",
      "isDefault": true,
      "conversionRate": 0
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/internationalization/currencies

Request Body

code

string · required

conversionRate

number · double · required

externalReference

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

code

string · required

isDefault

boolean · required

conversionRate

number · double · required

externalReference

string

POST/core-api/internationalization/currencies

curl --request POST \
  --url https://api.heart.work/core-api/internationalization/currencies \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "code": "code",
  "conversionRate": 0
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "code": "code",
  "conversionRate": 0
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "code": "code",
  "isDefault": true,
  "conversionRate": 0
}

plain

GET

https://api.heart.work

/core-api/internationalization/currencies/available

Responses

object[] · required

total

integer · int32 · required

GET/core-api/internationalization/currencies/available

curl --request GET \
  --url https://api.heart.work/core-api/internationalization/currencies/available

shell

Example Responses

{
  "data": [
    {
      "code": "code"
    }
  ],
  "total": 0
}

plain

PUT

https://api.heart.work

/core-api/internationalization/currencies/{id}

path Parameters

id

string · required

Request Body

id

string · required

conversionRate

number · double · required

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

code

string · required

isDefault

boolean · required

conversionRate

number · double · required

externalReference

string

PUT/core-api/internationalization/currencies/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/internationalization/currencies/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "conversionRate": 0
}
'

shell

Example Request Body

{
  "id": "id",
  "conversionRate": 0
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "code": "code",
  "isDefault": true,
  "conversionRate": 0
}

plain

ContentPages Deals