Admin

admin_access-control-rules_list

SecurityToken
Request
query Parameters
type
string
action
string
user
string
group
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/admin/access-control-rules/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_access-control-rules_create

SecurityToken
Request
Request Body schema: application/json
action
required
string (Action)
Enum: "allow" "deny"
type
required
string (Type)
Value: "ip"
value
required
string (Value) [ 1 .. 100 ] characters
label
string or null (Label) <= 50 characters
user
string or null (User)
group
string or null (Group)
Responses
201
post/admin/access-control-rules/
Request samples
application/json
{
  • "action": "allow",
  • "type": "ip",
  • "value": "string",
  • "label": "string",
  • "user": "string",
  • "group": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_access-control-rules_read

SecurityToken
Request
path Parameters
id
required
string
Responses
200
get/admin/access-control-rules/{id}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_access-control-rules_update

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
action
required
string (Action)
Enum: "allow" "deny"
type
required
string (Type)
Value: "ip"
value
required
string (Value) [ 1 .. 100 ] characters
label
string or null (Label) <= 50 characters
user
string or null (User)
group
string or null (Group)
Responses
200
put/admin/access-control-rules/{id}/
Request samples
application/json
{
  • "action": "allow",
  • "type": "ip",
  • "value": "string",
  • "label": "string",
  • "user": "string",
  • "group": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_access-control-rules_partial_update

SecurityToken
Request
path Parameters
id
required
string
Request Body schema: application/json
action
required
string (Action)
Enum: "allow" "deny"
type
required
string (Type)
Value: "ip"
value
required
string (Value) [ 1 .. 100 ] characters
label
string or null (Label) <= 50 characters
user
string or null (User)
group
string or null (Group)
Responses
200
patch/admin/access-control-rules/{id}/
Request samples
application/json
{
  • "action": "allow",
  • "type": "ip",
  • "value": "string",
  • "label": "string",
  • "user": "string",
  • "group": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_access-control-rules_delete

SecurityToken
Request
path Parameters
id
required
string
Responses
204
delete/admin/access-control-rules/{id}/
Response samples
application/json
{
  • "status": "string"
}

admin_account-currencies_list

SecurityToken
Request
query Parameters
account__name
string
account__name__contains
string
active
string
account
string
currency
string
balance
number
balance__gt
number
balance__lt
number
historic
string
orderby
string
user
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/admin/account-currencies/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_list

SecurityToken
Request
query Parameters
archived
string
created
string
created__lt
string
created__gt
string
created__lte
string
created__gte
string
group
string
orderby
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/admin/account-definitions/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_create

SecurityToken
Request
Request Body schema: application/json
name
required
string (Name) [ 1 .. 200 ] characters
label
string or null (Label) <= 200 characters
recon
boolean (Recon)
archived
boolean (Archived)
Responses
201
post/admin/account-definitions/
Request samples
application/json
{
  • "name": "string",
  • "label": "string",
  • "recon": true,
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_read

SecurityToken
Request
path Parameters
definition_name
required
string
Responses
200
get/admin/account-definitions/{definition_name}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_update

SecurityToken
Request
path Parameters
definition_name
required
string
Request Body schema: application/json
name
required
string (Name) [ 1 .. 200 ] characters
label
string or null (Label) <= 200 characters
recon
boolean (Recon)
archived
boolean (Archived)
Responses
200
put/admin/account-definitions/{definition_name}/
Request samples
application/json
{
  • "name": "string",
  • "label": "string",
  • "recon": true,
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_partial_update

SecurityToken
Request
path Parameters
definition_name
required
string
Request Body schema: application/json
name
required
string (Name) [ 1 .. 200 ] characters
label
string or null (Label) <= 200 characters
recon
boolean (Recon)
archived
boolean (Archived)
Responses
200
patch/admin/account-definitions/{definition_name}/
Request samples
application/json
{
  • "name": "string",
  • "label": "string",
  • "recon": true,
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_list

SecurityToken
Request
path Parameters
definition_name
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/admin/account-definitions/{definition_name}/groups/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_create

SecurityToken
Request
path Parameters
definition_name
required
string
Request Body schema: application/json
group
required
string (Group) non-empty
default
boolean (Default)
primary
boolean (Primary)
currencies
Array of strings
Responses
201
post/admin/account-definitions/{definition_name}/groups/
Request samples
application/json
{
  • "group": "string",
  • "default": true,
  • "primary": true,
  • "currencies": [
    ]
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_read

SecurityToken
Request
path Parameters
definition_group_name
required
string
definition_name
required
string
Responses
200
get/admin/account-definitions/{definition_name}/groups/{definition_group_name}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_update

SecurityToken
Request
path Parameters
definition_group_name
required
string
definition_name
required
string
Request Body schema: application/json
default
boolean (Default)
primary
boolean (Primary)
currencies
Array of strings
archived
boolean (Archived)
Responses
200
put/admin/account-definitions/{definition_name}/groups/{definition_group_name}/
Request samples
application/json
{
  • "default": true,
  • "primary": true,
  • "currencies": [
    ],
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_partial_update

SecurityToken
Request
path Parameters
definition_group_name
required
string
definition_name
required
string
Request Body schema: application/json
default
boolean (Default)
primary
boolean (Primary)
currencies
Array of strings
archived
boolean (Archived)
Responses
200
patch/admin/account-definitions/{definition_name}/groups/{definition_group_name}/
Request samples
application/json
{
  • "default": true,
  • "primary": true,
  • "currencies": [
    ],
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_currencies_list

SecurityToken
Request
path Parameters
definition_group_name
required
string
definition_name
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_currencies_create

SecurityToken
Request
path Parameters
definition_group_name
required
string
definition_name
required
string
Request Body schema: application/json
currency
required
string (Currency) non-empty
Responses
201
post/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/
Request samples
application/json
{
  • "currency": "string"
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_currencies_read

SecurityToken
Request
path Parameters
currency_code
required
string
definition_group_name
required
string
definition_name
required
string
Responses
200
get/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/{currency_code}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_currencies_update

SecurityToken
Request
path Parameters
currency_code
required
string
definition_group_name
required
string
definition_name
required
string
Request Body schema: application/json
archived
boolean (Archived)
Responses
200
put/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/{currency_code}/
Request samples
application/json
{
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_account-definitions_groups_currencies_partial_update

SecurityToken
Request
path Parameters
currency_code
required
string
definition_group_name
required
string
definition_name
required
string
Request Body schema: application/json
archived
boolean (Archived)
Responses
200
patch/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/{currency_code}/
Request samples
application/json
{
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_list

SecurityToken
Request
query Parameters
reference
string
reference__contains
string
name
string
primary
string
archived
string
currency
string
user
string
user__isnull
string
group
string
active
string
balance
number
balance__gt
number
balance__lt
number
recon
string
search
string
orderby
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/admin/accounts/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_create

SecurityToken
Request
Request Body schema: application/json
reference
string or null (Reference) <= 50 characters
name
required
string (Name) non-empty
label
string or null (Label) [ 1 .. 200 ] characters
primary
boolean (Primary)
recon
boolean (Recon)
user
string or null (User)
metadata
object or null (Metadata)
archived
boolean (Archived)
Responses
201
post/admin/accounts/
Request samples
application/json
{
  • "reference": "string",
  • "name": "string",
  • "label": "string",
  • "primary": true,
  • "recon": true,
  • "user": "string",
  • "metadata": { },
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_read

SecurityToken
Request
path Parameters
reference
required
string
Responses
200
get/admin/accounts/{reference}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_update

SecurityToken
Request
path Parameters
reference
required
string
Request Body schema: application/json
name
required
string (Name) non-empty
label
string or null (Label) [ 1 .. 200 ] characters
primary
boolean (Primary)
recon
boolean (Recon)
metadata
object or null (Metadata)
archived
boolean (Archived)
Responses
200
put/admin/accounts/{reference}/
Request samples
application/json
{
  • "name": "string",
  • "label": "string",
  • "primary": true,
  • "recon": true,
  • "metadata": { },
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_partial_update

SecurityToken
Request
path Parameters
reference
required
string
Request Body schema: application/json
name
required
string (Name) non-empty
label
string or null (Label) [ 1 .. 200 ] characters
primary
boolean (Primary)
recon
boolean (Recon)
metadata
object or null (Metadata)
archived
boolean (Archived)
Responses
200
patch/admin/accounts/{reference}/
Request samples
application/json
{
  • "name": "string",
  • "label": "string",
  • "primary": true,
  • "recon": true,
  • "metadata": { },
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_currencies_list

SecurityToken
Request
path Parameters
reference
required
string
query Parameters
account__name
string
account__name__contains
string
active
string
account
string
currency
string
balance
number
balance__gt
number
balance__lt
number
historic
string
orderby
string
user
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/admin/accounts/{reference}/currencies/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_currencies_create

SecurityToken
Request
path Parameters
reference
required
string
Request Body schema: application/json
currency
required
string (Currency) non-empty
active
boolean (Active)
Responses
201
post/admin/accounts/{reference}/currencies/
Request samples
application/json
{
  • "currency": "string",
  • "active": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_currencies_read

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
Responses
200
get/admin/accounts/{reference}/currencies/{code}/
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_currencies_update

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
Request Body schema: application/json
active
required
boolean (Active)
archived
boolean (Archived)
Responses
200
put/admin/accounts/{reference}/currencies/{code}/
Request samples
application/json
{
  • "active": true,
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_currencies_partial_update

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
Request Body schema: application/json
active
required
boolean (Active)
archived
boolean (Archived)
Responses
200
patch/admin/accounts/{reference}/currencies/{code}/
Request samples
application/json
{
  • "active": true,
  • "archived": true
}
Response samples
application/json
{
  • "status": "string",
  • "data": {
    }
}

admin_accounts_currencies_fees_list

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
Responses
200
get/admin/accounts/{reference}/currencies/{code}/fees/
Response samples
application/json
{
  • "status": "string",
  • "data": [
    ]
}

admin_accounts_currencies_fees_create

SecurityToken
Request
path Parameters
code
required
string
reference
required
string
Request Body schema: application/json
name
string or null (Name) <= 50 characters
value
integer (Value) >= 0
percentage
number <decimal> (Percentage) >= 0
tx_type
required
string (Tx type)
Enum: "credit" "debit"
subtype
string or null (Subtype)
description
string or null (Description) <= 250 characters
debit_account
string or null (Debit account)
credit_account
string or null (Credit account)
debit_subtype
string or null (Debit subtype)
credit_subtype
string or null (Credit subtype)
inferred
boolean (Inferred)
Responses
201
post/admin/accounts/{reference}/currencies/{code}/fees/
Request samples