Rehive logo
Powered by Redocly

currencies

List currencies

SecurityapiAuth
Request
query Parameters
archived
boolean
code
string
code__in
string
display_code
string
orderby
Array of strings

Ordering

  • created - Created
  • -created - Created (descending)
  • code - Code
  • -code - Code (descending)
  • display_code - Display code
  • -display_code - Display code (descending)
Items Enum: "-code" "-created" "-display_code" "code" "created" "display_code"
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

unit
string
Responses
200
get/3/admin/currencies/
Request samples 
rehive.admin.currencies.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create currency

SecurityapiAuth
Request
Request Body schema:
required
code
string or null <= 30 characters
display_code
string or null <= 12 characters
description
string or null <= 255 characters
symbol
string or null <= 30 characters
unit
string or null <= 30 characters
divisibility
required
integer [ 0 .. 18 ]
icon
string or null <uri>
manager
string or null
Array of objects
object or null
archived
boolean
Default: false
Responses
201
post/3/admin/currencies/
Request samples
{
  • "code": "string",
  • "display_code": "string",
  • "description": "string",
  • "symbol": "string",
  • "unit": "string",
  • "divisibility": 18,
  • "icon": "http://example.com",
  • "manager": "string",
  • "manager_conditions": [
    ],
  • "metadata": {
    },
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
Responses
200
get/3/admin/currencies/{code}/
Request samples 
rehive.admin.currencies.get({"code": currencyCode})
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
Request Body schema:
display_code
string or null <= 12 characters
description
string or null <= 255 characters
symbol
string or null <= 30 characters
unit
string or null <= 30 characters
icon
string or null <uri>
manager
string or null
Array of objects
object or null
archived
boolean
Default: false
Responses
200
put/3/admin/currencies/{code}/
Request samples
{
  • "display_code": "string",
  • "description": "string",
  • "symbol": "string",
  • "unit": "string",
  • "icon": "http://example.com",
  • "manager": "string",
  • "manager_conditions": [
    ],
  • "metadata": {
    },
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
Request Body schema:
display_code
string or null <= 12 characters
description
string or null <= 255 characters
symbol
string or null <= 30 characters
unit
string or null <= 30 characters
icon
string or null <uri>
manager
string or null
Array of objects
object or null
archived
boolean
Default: false
Responses
200
patch/3/admin/currencies/{code}/
Request samples
{
  • "display_code": "string",
  • "description": "string",
  • "symbol": "string",
  • "unit": "string",
  • "icon": "http://example.com",
  • "manager": "string",
  • "manager_conditions": [
    ],
  • "metadata": {
    },
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrive currency overview

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
Responses
200
get/3/admin/currencies/{code}/overview/
Request samples 
rehive.admin.currencies.overview.get(currencyCode)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}
➔ Next to document-types