API docs by Redocly

AKJET API v2 (2.0.0)

Download OpenAPI specification:Download

AKJET API v2

Acts

acts.index

Authorizations:
http
query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
id[]
Array of strings <uuid>
executor_id
integer or null >= 1
executor[iin][]
Array of strings
document_date[from]
string or null <date>
document_date[to]
string or null <date>
payment_status[]
Array of strings
Items Enum: "NOT_PAYED" "AUTO" "IMPOSSIBLE_PAYED" "WAIT_RECEIPT" "HAS_RECEIPT" "PAYED" "FAILED"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [
    ]
}

acts.show

Authorizations:
http
path Parameters
act
required
string <uuid>

The act ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

acts.sign

Authorizations:
http
path Parameters
act
required
string <uuid>

The act ID

Request Body schema: application/json
SignProvider (string) or null

Responses

Request samples

Content type
application/json
{
  • "provider": "DTT"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

acts.signCheck

Authorizations:
http
path Parameters
act
required
string <uuid>

The act ID

Request Body schema: application/json
token
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "code": "string"
}

Response samples

Content type
application/json
"string"

acts.download

Authorizations:
http
path Parameters
act
required
string <uuid>

The act ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

acts.downloadArchive

Authorizations:
http
path Parameters
act
required
string <uuid>

The act ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

Cards

cards.index

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
status[]
Array of strings
Items Enum: "ACTIVE" "INACTIVE"
expand[]
Array of strings
Items Value: "executor"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [
    ]
}

cards.show

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

card
required
string <uuid>

The card ID

query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
status[]
Array of strings
Items Enum: "ACTIVE" "INACTIVE"
expand[]
Array of strings
Items Value: "executor"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

cards.delete

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

card
required
string <uuid>

The card ID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

cards.setPrimary

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

card
required
string <uuid>

The card ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

CompanyBalance

company.companyBalance

Authorizations:
http

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

CompanyProfile

company.companyProfile

Authorizations:
http

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

Contracts

contracts.index

Authorizations:
http
query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
id[]
Array of strings <uuid>
executor[id][]
Array of integers[ items >= 1 ]
executor[iin][]
Array of strings
start_date[from]
string or null <date>
start_date[to]
string or null <date>

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [
    ]
}

Executors

executors.index

Authorizations:
http
query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
id[]
Array of integers[ items >= 1 ]
iin[]
Array of strings
status[]
Array of strings
Items Enum: "PENDING" "IN_PROGRESS" "SUCCESS" "FAILED"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [
    ]
}

executors.store

Authorizations:
http
Request Body schema: application/json
inn
required
string
phone
required
integer^7\d+$
first_name
required
string
last_name
required
string
patronymic
string

Responses

Request samples

Content type
application/json
{
  • "inn": "string",
  • "phone": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "patronymic": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

executors.show

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

executors.update

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

Request Body schema: application/json
phone
integer^7\d+$
first_name
string
last_name
string
patronymic
string

Responses

Request samples

Content type
application/json
{
  • "phone": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "patronymic": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

executors.delete

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

IssueToken

auth.issueToken

Request Body schema: application/json
client_id
required
string <= 255 characters
client_secret
required
string <= 500 characters

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "client_secret": "string"
}

Response samples

Content type
application/json
"string"

Logout

auth.logout

Authorizations:
http

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

Payouts

payouts.payouts

Authorizations:
http
Request Body schema: application/json
executor_id
required
integer
receipt_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "executor_id": 0,
  • "receipt_id": "64d0a161-468e-472a-b00e-a06ee9ab7de7"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

PersonalData

personalData.show

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

personalData.sign

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

personalData
required
string <uuid>

The personal data ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

personalData.signCheck

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

personalData
required
string <uuid>

The personal data ID

Request Body schema: application/json
token
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "code": "string"
}

Response samples

Content type
application/json
"string"

personalData.download

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

personalData
required
string <uuid>

The personal data ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

personalData.downloadArchive

Authorizations:
http
path Parameters
executor
required
integer

The executor ID

personalData
required
string <uuid>

The personal data ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

Receipts

receipts.index

Authorizations:
http
query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
status[]
Array of strings
Items Enum: "CANCELLED" "SUCCESS" "NEW" "FAILED"
expand[]
Array of strings
Items Value: "executor"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [
    ]
}

receipts.store

Authorizations:
http
Request Body schema: application/json
executor_id
required
integer
operation_id
required
string <uuid>
act_id
string <uuid>
Array of objects

Responses

Request samples

Content type
application/json
{
  • "executor_id": 0,
  • "operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52",
  • "act_id": "6b67f0bb-2b64-4fc5-9abf-e7d020e9c0f0",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

receipts.cancel

Authorizations:
http
path Parameters
receipt
required
string <uuid>

The receipt ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

receipts.show

Authorizations:
http
path Parameters
receipt
required
string <uuid>

The receipt ID

query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
status[]
Array of strings
Items Enum: "CANCELLED" "SUCCESS" "NEW" "FAILED"
expand[]
Array of strings
Items Value: "executor"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}

RefreshToken

auth.refreshToken

Request Body schema: application/json
refresh_token
required
string <= 500 characters

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string"
}

Response samples

Content type
application/json
"string"

Transactions

transactions.index

Authorizations:
http
query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
type[]
Array of strings
Items Enum: "PAYOUT" "INCOME" "TAX" "FEE"
status[]
Array of strings
Items Enum: "DRAFT" "IN_PROGRESS" "CANCELLED" "RECEIPT_FAILED" "PENDING" "FAILED" "TO_PAYED"
expand[]
Array of strings
Items Enum: "act" "executor" "receipt"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [
    ]
}

transactions.show

Authorizations:
http
path Parameters
transaction
required
string <uuid>

The transaction ID

query Parameters
pagination
string
Enum: "offset" "cursor"
page
integer >= 1
per_page
integer [ 1 .. 100 ]
cursor
string or null
type[]
Array of strings
Items Enum: "PAYOUT" "INCOME" "TAX" "FEE"
status[]
Array of strings
Items Enum: "DRAFT" "IN_PROGRESS" "CANCELLED" "RECEIPT_FAILED" "PENDING" "FAILED" "TO_PAYED"
expand[]
Array of strings
Items Enum: "act" "executor" "receipt"

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [
    ]
}