AccountingDiaries
List of accounting diaries
Parameters
| Name | Description |
|---|---|
| q[month_eq] | Search by month |
| q[year_eq] | Search by year |
| q[department_value_eq] | Search by department |
Request
Route
GET api/companies/1/accounting_diaries
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"ccb11e01683e46e4ec35d2daa8a179f7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=85fe26d07bf6f38034f2770cb2872ec0; path=/; expires=Wed, 19 Aug 2020 13:03:16 -0000; HttpOnly
X-Request-Id: 71caa8be-31aa-4607-8f81-98d34ee3eaa5
X-Runtime: 0.196552
Content-Length: 802Body
{
"total_months": 12,
"months": [
[
"leden",
1
],
[
"únor",
2
],
[
"březen",
3
],
[
"duben",
4
],
[
"květen",
5
],
[
"červen",
6
],
[
"červenec",
7
],
[
"srpen",
8
],
[
"září",
9
],
[
"říjen",
10
],
[
"listopad",
11
],
[
"prosinec",
12
]
],
"groups": [
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 0,
"account_code": null,
"account_name": "Celkové náklady",
"months_total": [
]
}
],
"group_name": "Náklady",
"group_id": 0,
"total": "0,00 Kč"
},
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 1,
"account_code": null,
"account_name": "Celkové výnosy",
"months_total": [
]
}
],
"group_name": "Výnosy",
"group_id": 1,
"total": "0,00 Kč"
},
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 2,
"account_code": null,
"account_name": "Celkový hospodářský výsledek",
"months_total": [
]
}
],
"group_name": "Hospodářský výsledek",
"group_id": 2,
"total": "0,00 Kč"
}
]
}List of accounting diaries available departments
Request
Route
GET api/companies/6/accounting_diaries/available_departments
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=72562d1dae3c7d17dd84aaa97381bf9e; path=/; expires=Wed, 19 Aug 2020 13:03:17 -0000; HttpOnly
X-Request-Id: b5a84d1b-08ea-4b4c-a151-3fd78b721e30
X-Runtime: 0.015301
Content-Length: 2Body
[
]List of accounting diaries available months
Request
Route
GET api/companies/5/accounting_diaries/available_months
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"91f20d83041dd60c0cbbcabb872c0caa"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=786b8b11c6a1d89dddc51f93e1f0cc26; path=/; expires=Wed, 19 Aug 2020 13:03:17 -0000; HttpOnly
X-Request-Id: 5266caf1-cb7f-4035-9994-bae14265b527
X-Runtime: 0.011509
Content-Length: 168Body
[
[
"leden",
1
],
[
"únor",
2
],
[
"březen",
3
],
[
"duben",
4
],
[
"květen",
5
],
[
"červen",
6
],
[
"červenec",
7
],
[
"srpen",
8
],
[
"září",
9
],
[
"říjen",
10
],
[
"listopad",
11
],
[
"prosinec",
12
]
]List of accounting diaries available years
Request
Route
GET api/companies/4/accounting_diaries/available_years
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"91393285a05733788dae6ccb35bf2b73"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=8ea667bc693c6db6c8f50432cf578a39; path=/; expires=Wed, 19 Aug 2020 13:03:17 -0000; HttpOnly
X-Request-Id: 514fef2e-1107-4930-9f9c-767c2d421f86
X-Runtime: 0.011884
Content-Length: 6Body
[
2017
]List of accounting diaries chart accounts
Parameters
| Name | Description |
|---|---|
| date[geq] | Search by date |
| date[leq] | Search by date |
| accounting_type | Search by accounting type 1 = credit, 0 = debit |
| any other | https://github.com/kollegorna/active_hash_relation |
Request
Route
GET api/companies/9/accounting_diaries/report_accounts
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b6fff25df147b3f7ee95b7dee11be008"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=77a4538d7e6869afaf37dbce2f180d93; path=/; expires=Wed, 19 Aug 2020 13:03:18 -0000; HttpOnly
X-Request-Id: f9533d64-55f8-4c82-b193-a47f2ff0e335
X-Runtime: 0.013509
Content-Length: 199Body
[
{
"total": 20,
"account_code": "525",
"account_name": "Zella Heathcote MD"
},
{
"total": 20,
"account_code": "526",
"account_name": "Clay Deckow I"
},
{
"total": 20,
"account_code": "527",
"account_name": "Jere Stokes"
}
]List of accounting diaries chart totals
Parameters
| Name | Description |
|---|---|
| date[geq] | Search by date |
| date[leq] | Search by date |
| accounting_type | Search by accounting type 1 = credit, 0 = debit |
| any other | https://github.com/kollegorna/active_hash_relation |
Request
Route
GET api/companies/8/accounting_diaries/report_totals
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"5c97b387c8eee45aed9da8afca1bd2d6"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=563253238a11b2b359a75d952bc86c68; path=/; expires=Wed, 19 Aug 2020 13:03:18 -0000; HttpOnly
X-Request-Id: 7043d113-ddba-40a4-ba0c-327c7955d241
X-Runtime: 0.012964
Content-Length: 71Body
[
{
"total": 20,
"month": 3
},
{
"total": 20,
"month": 4
},
{
"total": -20,
"month": 8
}
]Search by department
Parameters
| Name | Description |
|---|---|
| q[month_eq] | Search by month |
| q[year_eq] | Search by year |
| q[department_value_eq] | Search by department |
Request
Route
GET api/companies/3/accounting_diaries?q%5Bdepartment_value_eq%5D=department
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
q={"department_value_eq"=>"department"}
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"ccb11e01683e46e4ec35d2daa8a179f7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=0ac16cabc5589846490441a38c0bb5f5; path=/; expires=Wed, 19 Aug 2020 13:03:17 -0000; HttpOnly
X-Request-Id: 9b38b378-d352-4fa5-ac94-63dee3cb7f9c
X-Runtime: 0.014929
Content-Length: 802Body
{
"total_months": 12,
"months": [
[
"leden",
1
],
[
"únor",
2
],
[
"březen",
3
],
[
"duben",
4
],
[
"květen",
5
],
[
"červen",
6
],
[
"červenec",
7
],
[
"srpen",
8
],
[
"září",
9
],
[
"říjen",
10
],
[
"listopad",
11
],
[
"prosinec",
12
]
],
"groups": [
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 0,
"account_code": null,
"account_name": "Celkové náklady",
"months_total": [
]
}
],
"group_name": "Náklady",
"group_id": 0,
"total": "0,00 Kč"
},
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 1,
"account_code": null,
"account_name": "Celkové výnosy",
"months_total": [
]
}
],
"group_name": "Výnosy",
"group_id": 1,
"total": "0,00 Kč"
},
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 2,
"account_code": null,
"account_name": "Celkový hospodářský výsledek",
"months_total": [
]
}
],
"group_name": "Hospodářský výsledek",
"group_id": 2,
"total": "0,00 Kč"
}
]
}Search by month
Parameters
| Name | Description |
|---|---|
| q[month_eq] | Search by month |
| q[year_eq] | Search by year |
| q[department_value_eq] | Search by department |
Request
Route
GET api/companies/2/accounting_diaries?q%5Bmonth_eq%5D=10
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
q={"month_eq"=>"10"}
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"ccb11e01683e46e4ec35d2daa8a179f7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=755b7731c65efacefac16a4562a902e7; path=/; expires=Wed, 19 Aug 2020 13:03:17 -0000; HttpOnly
X-Request-Id: c7bc7dc4-7c07-4421-b486-c4739daed455
X-Runtime: 0.013866
Content-Length: 802Body
{
"total_months": 12,
"months": [
[
"leden",
1
],
[
"únor",
2
],
[
"březen",
3
],
[
"duben",
4
],
[
"květen",
5
],
[
"červen",
6
],
[
"červenec",
7
],
[
"srpen",
8
],
[
"září",
9
],
[
"říjen",
10
],
[
"listopad",
11
],
[
"prosinec",
12
]
],
"groups": [
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 0,
"account_code": null,
"account_name": "Celkové náklady",
"months_total": [
]
}
],
"group_name": "Náklady",
"group_id": 0,
"total": "0,00 Kč"
},
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 1,
"account_code": null,
"account_name": "Celkové výnosy",
"months_total": [
]
}
],
"group_name": "Výnosy",
"group_id": 1,
"total": "0,00 Kč"
},
{
"accounts": [
{
"id": null,
"total": "0,00 Kč",
"group_id": 2,
"account_code": null,
"account_name": "Celkový hospodářský výsledek",
"months_total": [
]
}
],
"group_name": "Hospodářský výsledek",
"group_id": 2,
"total": "0,00 Kč"
}
]
}Accounts
List of accounts
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
| q[name_or_identifier_cont] | Search by fields |
| q[account_type] | Account type {1=>"checkout", 2=>"bank", 3=>"paypal", 4=>"card", 5=>"credit", 6=>"delivery"} |
Request
Route
GET api/companies/10/accounts?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"0a7a6a5878bbba151fb8d3960ce7115d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=eae883ec3649dede557593f7a1013426; path=/; expires=Wed, 19 Aug 2020 13:03:18 -0000; HttpOnly
X-Request-Id: bdb3cc52-c9d8-4738-a750-68d68c2f1315
X-Runtime: 0.032207
Content-Length: 3123Body
[
{
"id": 19,
"name": "Hotovost",
"identifier": null,
"account_type": 1,
"currency_id": 19,
"country_id": null,
"prefix": "H1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": null,
"country_id": null,
"account": null,
"bank_name": null,
"iban": null,
"created_at": null,
"updated_at": null,
"bank_code": null,
"bankable_id": null,
"bankable_type": null,
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
{
"id": 20,
"name": "Banka",
"identifier": null,
"account_type": 2,
"currency_id": 19,
"country_id": 28,
"prefix": "B1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 10,
"country_id": 28,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:18.000+02:00",
"updated_at": "2020-08-19T13:03:18.000+02:00",
"bank_code": "1111",
"bankable_id": 10,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
{
"id": 21,
"name": "Christian Ritchie",
"identifier": null,
"account_type": 2,
"currency_id": 19,
"country_id": 28,
"prefix": "quis",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 10,
"country_id": 28,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:18.000+02:00",
"updated_at": "2020-08-19T13:03:18.000+02:00",
"bank_code": "1111",
"bankable_id": 10,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
{
"id": 22,
"name": "Nikole Huel",
"identifier": null,
"account_type": 2,
"currency_id": 19,
"country_id": 28,
"prefix": "aut",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 10,
"country_id": 28,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:18.000+02:00",
"updated_at": "2020-08-19T13:03:18.000+02:00",
"bank_code": "1111",
"bankable_id": 10,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
{
"id": 23,
"name": "Chester Osinski DDS",
"identifier": null,
"account_type": 2,
"currency_id": 19,
"country_id": 28,
"prefix": "totam",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 10,
"country_id": 28,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:18.000+02:00",
"updated_at": "2020-08-19T13:03:18.000+02:00",
"bank_code": "1111",
"bankable_id": 10,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
{
"id": 24,
"name": "Bryon Boyle",
"identifier": null,
"account_type": 2,
"currency_id": 19,
"country_id": 28,
"prefix": "et",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 10,
"country_id": 28,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:18.000+02:00",
"updated_at": "2020-08-19T13:03:18.000+02:00",
"bank_code": "1111",
"bankable_id": 10,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
{
"id": 25,
"name": "Tamika Satterfield",
"identifier": null,
"account_type": 2,
"currency_id": 19,
"country_id": 28,
"prefix": "maiores",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 10,
"country_id": 28,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:18.000+02:00",
"updated_at": "2020-08-19T13:03:18.000+02:00",
"bank_code": "1111",
"bankable_id": 10,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
}
]Search of accounts
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
| q[name_or_identifier_cont] | Search by fields |
| q[account_type] | Account type {1=>"checkout", 2=>"bank", 3=>"paypal", 4=>"card", 5=>"credit", 6=>"delivery"} |
Request
Route
GET api/companies/11/accounts?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E&q%5Bname_or_identifier_cont%5D=Austin+Ratke
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
q={"name_or_identifier_cont"=>"Austin Ratke"}
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"7c25c04be032fa59e1881f3b5c3995fe"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=62e4ade3979179f37e3f4325d1140a06; path=/; expires=Wed, 19 Aug 2020 13:03:18 -0000; HttpOnly
X-Request-Id: 12845782-d13d-431e-8058-ef3664dbf84a
X-Runtime: 0.006767
Content-Length: 459Body
[
{
"id": 32,
"name": "Austin Ratke",
"identifier": null,
"account_type": 2,
"currency_id": 20,
"country_id": 30,
"prefix": "suscipit",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 11,
"country_id": 30,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:18.000+02:00",
"updated_at": "2020-08-19T13:03:18.000+02:00",
"bank_code": "1111",
"bankable_id": 11,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
}
]Actuarial Types
List of actuarial types
Request
Route
GET api/actuarial_types
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"9ab1a9974d4995695bdfcece339d1fd8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7afdda9eec006e2cc401cd3760a060b7; path=/; expires=Wed, 19 Aug 2020 13:03:18 -0000; HttpOnly
X-Request-Id: 1c6a3605-34bc-44e0-9f8f-afc040ca6d19
X-Runtime: 0.011888
Content-Length: 91Body
[
{
"id": 1,
"name": "invoice"
},
{
"id": 2,
"name": "call_for_payment"
},
{
"id": 3,
"name": "correcting"
}
]Actuarials In
Actuarials In Initialize
Request
Route
GET api/companies/22/actuarials_ins/new
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"abb20a0ae51e03c9c95677bf0261fcc5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=de28a1e3f2c7dc4ce60cc938fb3e7bf3; path=/; expires=Wed, 19 Aug 2020 13:03:24 -0000; HttpOnly
X-Request-Id: 00546b2e-e69f-4ac5-b9e2-c082ad9cea3e
X-Runtime: 0.014506
Content-Length: 1168Body
{
"id": null,
"actuarial_type": "FA",
"actuarial_number": null,
"uzp_date_at": "19. 08. 2020",
"due_date_at": "29. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": null,
"end_price": null,
"remaining": 0,
"currency": {
"id": 26,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"external_number": null,
"payment_type": null,
"due_date": 10,
"order_number": null,
"bank_number": "1111/1111",
"iban": null,
"swift": null,
"vat": null,
"paypal_identifier": null,
"account": {
"id": 54,
"name": "Banka",
"identifier": null,
"account_type": 2,
"currency_id": 26,
"country_id": 47,
"prefix": "B1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 22,
"country_id": 47,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:23.000+02:00",
"updated_at": "2020-08-19T13:03:23.000+02:00",
"bank_code": "1111",
"bankable_id": 22,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
"taxable": false,
"pay": "0,00 Kč",
"supplier": {
"name": null,
"ic": null,
"dic": null,
"dic2": null,
"street": null,
"city": null,
"zip": null,
"is_taxable": false,
"country_id": null
},
"items": [
],
"amounts": [
]
}Actuarials In Initialize from scan
Request
Route
GET api/companies/24/actuarials_ins/new?scan_id=00000000-0000-0000-0000-000000000001
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
scan_id=00000000-0000-0000-0000-000000000001
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"ea10ae9e12188cbefb4c960adb8ba014"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=963c9f161fff827b57c39f41bf1bad23; path=/; expires=Wed, 19 Aug 2020 13:03:25 -0000; HttpOnly
X-Request-Id: 3106bc18-ccc4-44cb-802b-d2e0eb3ab2a7
X-Runtime: 0.061873
Content-Length: 1335Body
{
"id": null,
"actuarial_type": "FA",
"actuarial_number": null,
"uzp_date_at": "19. 08. 2020",
"due_date_at": "29. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": null,
"end_price": null,
"remaining": 0,
"currency": {
"id": 27,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"external_number": "123456789",
"payment_type": null,
"due_date": 10,
"order_number": null,
"bank_number": null,
"iban": null,
"swift": null,
"vat": null,
"paypal_identifier": null,
"account": {
"id": 57,
"name": "Hotovost",
"identifier": null,
"account_type": 1,
"currency_id": 27,
"country_id": null,
"prefix": "H1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": null,
"country_id": null,
"account": null,
"bank_name": null,
"iban": null,
"created_at": null,
"updated_at": null,
"bank_code": null,
"bankable_id": null,
"bankable_type": null,
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
"taxable": false,
"pay": "0,00 Kč",
"supplier": {
"name": "Hahn and Sons",
"ic": "24",
"dic": "CZ47-727-0730",
"dic2": null,
"street": "Duane Loop",
"city": "Deckowborough",
"zip": "70234",
"is_taxable": false,
"country_id": null
},
"items": [
{
"id": null,
"quantity": null,
"unit_name": null,
"name": "Celková cena",
"vat_id": null,
"tax": null,
"unit_price": "1000.0",
"base_price": null,
"total_price": null,
"discount_percentage": null
}
],
"amounts": [
]
}Actuarials In Initialize from scan when partner_ic not match
Request
Route
GET api/companies/26/actuarials_ins/new?scan_id=00000000-0000-0000-0000-000000000002
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
scan_id=00000000-0000-0000-0000-000000000002
Response
Status
400Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: your_session_key=c4e96cccfd428ac2f34132ac5b94c48a; path=/; expires=Wed, 19 Aug 2020 13:03:27 -0000; HttpOnly
X-Request-Id: 8275895e-7f2b-4d83-b7cc-f5ae01169af8
X-Runtime: 0.010092
Content-Length: 95Body
{
"errors": [
"Nelze identifikovat fakturu. Je ta faktura opravdu vaše nebo Vám byla vydána?"
]
}Company's actuarial out detail
Request
Route
GET api/companies/20/actuarials_ins/142
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"94f07c28e5880884f04f1932ccd3914a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=442a40518b18f0d615da45d080d16fc1; path=/; expires=Wed, 19 Aug 2020 13:03:23 -0000; HttpOnly
X-Request-Id: 80404cb1-7f6c-4493-99b5-88d07acd8c61
X-Runtime: 0.022862
Content-Length: 1316Body
{
"id": 142,
"actuarial_type": "FA",
"actuarial_number": "FV 142",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"currency": {
"id": 25,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"external_number": null,
"payment_type": null,
"due_date": 0,
"order_number": null,
"bank_number": null,
"iban": null,
"swift": null,
"vat": "40.0",
"paypal_identifier": null,
"account": {
"id": 49,
"name": "Hotovost",
"identifier": null,
"account_type": 1,
"currency_id": 25,
"country_id": null,
"prefix": "H1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": null,
"country_id": null,
"account": null,
"bank_name": null,
"iban": null,
"created_at": null,
"updated_at": null,
"bank_code": null,
"bankable_id": null,
"bankable_type": null,
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
"taxable": false,
"pay": "0,00 Kč",
"supplier": {
"name": null,
"ic": null,
"dic": null,
"dic2": null,
"street": null,
"city": null,
"zip": null,
"is_taxable": false,
"country_id": null
},
"items": [
{
"id": 142,
"quantity": "1.0",
"unit_name": null,
"name": "Laverne Spencer",
"vat_id": 5,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}
],
"amounts": [
]
}Create Actuarials In
Parameters
| Name | Description |
|---|---|
| actuarials_in[partner_id] Required | Id of Partner |
| actuarials_in[account_id] Required | Id of account |
| actuarials_in[currency_id] Required | Id of currency |
| actuarials_in[actuarial_type_id] Required | Id of Type of actuarial |
| actuarials_in[actuarial_number] Required | Generated Number of actuarial |
| actuarials_in[due_date_at] Required | Due date of actuarial |
| actuarials_in[issue_date_at] Required | Issue date |
| actuarials_in[uzp_date_at] Required | UZP date |
| actuarials_in[lines[name]] Required | Line name |
| actuarials_in[lines[quantity]] Required | Line name |
| actuarials_in[lines[unit_price]] Required | Price for unit |
| actuarials_in[lines[vat_id]] Required | Id of VAT |
| actuarials_in[lines[unit_name]] | Unit name |
| actuarials_in[lines[tax]] | tax |
| actuarials_in[lines[vat]] | vat |
| actuarials_in[lines[base_price]] | base_price |
| actuarials_in[lines[total_price]] | total_price |
| actuarials_in[lines[discount_percentage]] | discount_percentage |
| actuarials_in[variable_symbol] | Variable Symbol |
| actuarials_in[print_notice] | Print notice |
| actuarials_in[foot_notice] | Foot notice |
| actuarials_in[internal_notice] | Internal notice |
| actuarials_in[payment_type_id] | Id of Payment type |
| actuarials_in[order_number] | Number of order |
| actuarials_in[department_id] | Id of Department |
| actuarials_in[bank_number] | Bank number |
| actuarials_in[iban] | IBAN |
| actuarials_in[swift] | SWIFT |
| actuarials_in[vat_regime_id] | Id of vat regime, only if company is_taxable = true |
| actuarials_in[is_visible_stamp] | Stamp visibility |
| actuarials_in[language] | ["en", "cs", "es"] |
Request
Route
POST api/companies/28/actuarials_ins
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"partner_id": 59,
"actuarial_type_id": 13,
"due_date_at": "2020-09-02",
"account_id": 65,
"currency_id": 29,
"actuarial_number": "2015000001",
"lines": [
{
"vat_id": 9,
"lineable_type": "Actuarial",
"name": "Grover Osinski",
"quantity": 1,
"unit_price": 200,
"base_price": 200,
"tax": 20,
"total_price": 220,
"unit_name": "h"
}
]
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b936994abe119ac2266eee478a49d734"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=4c109d47f2bb1df1a5fa460bbdb65b40; path=/; expires=Wed, 19 Aug 2020 13:03:28 -0000; HttpOnly
X-Request-Id: 94d8debd-484f-4f96-a076-90db35783966
X-Runtime: 0.033297
Content-Length: 1363Body
{
"id": 312,
"actuarial_type": "FA",
"actuarial_number": "2015000001",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "02. 09. 2020",
"status": "Připravený",
"status_id": 2,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "200.0",
"remaining": "200.0",
"currency": {
"id": 29,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
},
"print_notice": null,
"foot_notice": null,
"external_number": null,
"payment_type": null,
"due_date": 14,
"order_number": null,
"bank_number": null,
"iban": null,
"swift": null,
"vat": "0.0",
"paypal_identifier": null,
"account": {
"id": 65,
"name": "Hotovost",
"identifier": null,
"account_type": 1,
"currency_id": 29,
"country_id": null,
"prefix": "H1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": null,
"country_id": null,
"account": null,
"bank_name": null,
"iban": null,
"created_at": null,
"updated_at": null,
"bank_code": null,
"bankable_id": null,
"bankable_type": null,
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
"taxable": false,
"pay": "0,00 Kč",
"supplier": {
"name": "Tiffani Wisozk",
"ic": null,
"dic": null,
"dic2": null,
"street": "Wiley Cliff",
"city": "Brandefort",
"zip": "30860-4313",
"is_taxable": false,
"country_id": 56
},
"items": [
{
"id": 312,
"quantity": "1.0",
"unit_name": "h",
"name": "Grover Osinski",
"vat_id": 9,
"tax": "0.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "200.0",
"discount_percentage": null
}
],
"amounts": [
]
}List of company's actuarials ins
Parameters
| Name | Description |
|---|---|
| page | Page |
| q[actuarial_type_id_eq] | ID of actuarial type |
| q[actuarial_number_cont] | Acturial number contains |
| q[partner_name_cont] | Supplier name contains |
| q[status_eq] | Status is one of {1=>"concept", 2=>"prepare", 3=>"sent", 4=>"displayed", 5=>"commented", 6=>"corrected", 7=>"partly_paid", 8=>"paid", 9=>"archived", 10=>"storno", 11=>"done"} |
| q[uzp_date_at_gteq] | UZP date is later or equal to |
| q[uzp_date_at_lteq] | UZP date is before or equal to |
| q[due_date_at_gteq] | Due date is later or equal to |
| q[due_date_at_lteq] | Due date is before or equal to |
| q[issue_date_at_gteq] | Issue date is later or equal to |
| q[issue_date_at_lteq] | Issue date is before or equal to |
| q[base_price_gteq] | Base price is greater or equal to |
| q[base_price_lteq] | Base price is lower or equal to |
| q[end_price_gteq] | End price is greater or equal to |
| q[end_price_lteq] | End price is lower or equal to |
Request
Route
GET api/companies/12/actuarials_ins?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"6fd824ca366797810f9d2e55d3443205"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=610e98de8a975759f91d2b36c4d8059d; path=/; expires=Wed, 19 Aug 2020 13:03:19 -0000; HttpOnly
X-Request-Id: 84466b5c-5ff5-4f75-8442-839ac113c002
X-Runtime: 0.096581
Content-Length: 8835Body
[
{
"id": 35,
"actuarial_type": "FA",
"actuarial_number": "FV 35",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2021",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "0.0",
"end_price": "0.0",
"remaining": "0.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 29,
"actuarial_type": "FA",
"actuarial_number": "FV 29",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 28,
"actuarial_type": "FA",
"actuarial_number": "FV 28",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 27,
"actuarial_type": "FA",
"actuarial_number": "FV 27",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 26,
"actuarial_type": "FA",
"actuarial_number": "FV 26",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 25,
"actuarial_type": "FA",
"actuarial_number": "FV 25",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 24,
"actuarial_type": "FA",
"actuarial_number": "FV 24",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 23,
"actuarial_type": "FA",
"actuarial_number": "FV 23",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 22,
"actuarial_type": "FA",
"actuarial_number": "FV 22",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 21,
"actuarial_type": "FA",
"actuarial_number": "FV 21",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 20,
"actuarial_type": "FA",
"actuarial_number": "FV 20",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 19,
"actuarial_type": "FA",
"actuarial_number": "FV 19",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 18,
"actuarial_type": "FA",
"actuarial_number": "FV 18",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 17,
"actuarial_type": "FA",
"actuarial_number": "FV 17",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 16,
"actuarial_type": "FA",
"actuarial_number": "FV 16",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 15,
"actuarial_type": "FA",
"actuarial_number": "FV 15",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 14,
"actuarial_type": "FA",
"actuarial_number": "FV 14",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 13,
"actuarial_type": "FA",
"actuarial_number": "FV 13",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 12,
"actuarial_type": "FA",
"actuarial_number": "FV 12",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
},
{
"id": 11,
"actuarial_type": "FA",
"actuarial_number": "FV 11",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 21,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 23,
"name": "Drobný nákup"
}
}
]List of company's actuarials ins with filter status
Parameters
| Name | Description |
|---|---|
| page | Page |
| q[actuarial_type_id_eq] | ID of actuarial type |
| q[actuarial_number_cont] | Acturial number contains |
| q[partner_name_cont] | Supplier name contains |
| q[status_eq] | Status is one of {1=>"concept", 2=>"prepare", 3=>"sent", 4=>"displayed", 5=>"commented", 6=>"corrected", 7=>"partly_paid", 8=>"paid", 9=>"archived", 10=>"storno", 11=>"done"} |
| q[uzp_date_at_gteq] | UZP date is later or equal to |
| q[uzp_date_at_lteq] | UZP date is before or equal to |
| q[due_date_at_gteq] | Due date is later or equal to |
| q[due_date_at_lteq] | Due date is before or equal to |
| q[issue_date_at_gteq] | Issue date is later or equal to |
| q[issue_date_at_lteq] | Issue date is before or equal to |
| q[base_price_gteq] | Base price is greater or equal to |
| q[base_price_lteq] | Base price is lower or equal to |
| q[end_price_gteq] | End price is greater or equal to |
| q[end_price_lteq] | End price is lower or equal to |
Request
Route
GET api/companies/18/actuarials_ins?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E&q%5Bstatus_eq%5D=6
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
q={"status_eq"=>"6"}
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"2ff976069ed227b88afbf3b375776a7b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ee4150e23138efe2a0132f618aebb2a7; path=/; expires=Wed, 19 Aug 2020 13:03:22 -0000; HttpOnly
X-Request-Id: eff0fc11-5a25-4c9a-a787-ab9bc7f24890
X-Runtime: 0.010606
Content-Length: 444Body
[
{
"id": 141,
"actuarial_type": "FA",
"actuarial_number": "FV 141",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "Opravený",
"status_id": 6,
"issue_date_at": "19. 08. 2020",
"base_price": "0.0",
"end_price": "0.0",
"remaining": "0.0",
"variable_symbol": null,
"currency": {
"id": 24,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
},
"print_notice": null,
"foot_notice": null,
"supplier": {
"id": 35,
"name": "Drobný nákup"
}
}
]Actuarials Lines
Create company's actuarial in line
Parameters
| Name | Description |
|---|---|
| line[name] Required | Line name |
| line[quantity] Required | Line qty |
| line[unit_price] Required | Unit price |
| line[vat_id] Required | Vat id |
| line[unit_name] | Unit name |
| line[tax] | Tax |
| line[vat] | Vat |
| line[base_price] | Base price |
| line[total_price] | Total price |
| line[discount_percentage] | Unit discount |
Request
Route
POST api/companies/126/actuarials_ins/702/lines
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"name": "Asha Stokes II",
"quantity": "1.0",
"unit_name": null,
"unit_price": "200.0",
"vat_id": 45,
"tax": "20.0",
"vat": {
"id": 45,
"value": "20.0",
"valid_from": "2020-08-19",
"valid_to": "2020-08-20",
"created_at": "2020-08-19T13:05:24.000+02:00",
"updated_at": "2020-08-19T13:05:24.000+02:00",
"country_id": 1065,
"creator_id": null,
"updater_id": null,
"vat_type_id": 45
},
"base_price": "200.0",
"total_price": "220.0",
"discount_percentage": 0
}Response
Status
201Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"977322b1d6f395f4903b8b11a0dc520d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b08bdc2c8b4bf5e9bafb8544f165b012; path=/; expires=Wed, 19 Aug 2020 13:05:24 -0000; HttpOnly
X-Request-Id: 37f60a68-fad2-4e7a-b88e-5216f53ea689
X-Runtime: 0.013083
Content-Length: 195Body
{
"id": 1114,
"quantity": "1.0",
"unit_name": null,
"name": "Asha Stokes II",
"vat_id": 45,
"tax": "20.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "220.0",
"discount_percentage": 0
}Create company's actuarial out line
Parameters
| Name | Description |
|---|---|
| line[name] Required | Line name |
| line[quantity] Required | Line qty |
| line[unit_price] Required | Unit price |
| line[vat_id] Required | Vat id |
| line[unit_name] | Unit name |
| line[tax] | Tax |
| line[vat] | Vat |
| line[base_price] | Base price |
| line[total_price] | Total price |
| line[discount_percentage] | Unit discount |
Request
Route
POST api/companies/125/actuarials_outs/699/lines
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"name": "Bertram Kris",
"unit_name": null,
"quantity": "1.0",
"unit_price": "200.0",
"vat_id": 44,
"tax": "20.0",
"vat": {
"id": 44,
"value": "20.0",
"valid_from": "2020-08-19",
"valid_to": "2020-08-20",
"created_at": "2020-08-19T13:05:24.000+02:00",
"updated_at": "2020-08-19T13:05:24.000+02:00",
"country_id": 1062,
"creator_id": null,
"updater_id": null,
"vat_type_id": 44
},
"base_price": "200.0",
"total_price": "220.0",
"discount_percentage": 0
}Response
Status
201Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"637681cfafeb1158706e22fe6e15c6e7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=4f422cfe3a6606d5c91d4220145d4b51; path=/; expires=Wed, 19 Aug 2020 13:05:24 -0000; HttpOnly
X-Request-Id: babfd1b5-5d61-4675-9e8b-639b67fe2e0a
X-Runtime: 0.012429
Content-Length: 193Body
{
"id": 1111,
"quantity": "1.0",
"unit_name": null,
"name": "Bertram Kris",
"vat_id": 44,
"tax": "20.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "220.0",
"discount_percentage": 0
}Delete company's actuarial in line
Request
Route
DELETE api/companies/130/actuarials_ins/710/lines/1124
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
204Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Cache-Control: no-cache
Set-Cookie: your_session_key=d007bfdbc22cd30a89672ba2e8bc7c63; path=/; expires=Wed, 19 Aug 2020 13:05:25 -0000; HttpOnly
X-Request-Id: 05c137ab-7c18-4cc9-95d0-ac07180c1457
X-Runtime: 0.010249Delete company's actuarial out line
Request
Route
DELETE api/companies/129/actuarials_outs/707/lines/1121
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
204Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Cache-Control: no-cache
Set-Cookie: your_session_key=f844fd605b0aeb969ee6e59093c28c19; path=/; expires=Wed, 19 Aug 2020 13:05:25 -0000; HttpOnly
X-Request-Id: 62abbb2f-451a-4901-8621-0b0d08262246
X-Runtime: 0.010742Get company's actuarial in line detail
Request
Route
GET api/companies/124/actuarials_ins/698/lines/1108
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"a80a9bea520e37d50456074b54db4c63"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1845ffbd83c6026356415e2996f91aa6; path=/; expires=Wed, 19 Aug 2020 13:05:24 -0000; HttpOnly
X-Request-Id: 057c144d-b3d6-4f78-817e-b21e033f4cf5
X-Runtime: 0.010908
Content-Length: 197Body
{
"id": 1108,
"quantity": "1.0",
"unit_name": null,
"name": "Nichelle DuBuque",
"vat_id": 43,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}Get company's actuarial out line detail
Request
Route
GET api/companies/123/actuarials_outs/695/lines/1105
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"bdd980c9e09bdf6a23ce88a4660b9222"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b6d218fdae4436d15a05fb47aaf56254; path=/; expires=Wed, 19 Aug 2020 13:05:24 -0000; HttpOnly
X-Request-Id: d4bed88e-7654-4cda-a0c6-b6afaabe9959
X-Runtime: 0.012045
Content-Length: 193Body
{
"id": 1105,
"quantity": "1.0",
"unit_name": null,
"name": "Avis Leffler",
"vat_id": 42,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}List of company's actuarial in lines
Request
Route
GET api/companies/122/actuarials_ins/694/lines
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"56d21a9bb339bc58c8ea52de748b0ff9"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=2fd976cad8ea013d108d3446265a91b6; path=/; expires=Wed, 19 Aug 2020 13:05:23 -0000; HttpOnly
X-Request-Id: edf50c6d-6e49-499c-b536-290786c815d0
X-Runtime: 0.011156
Content-Length: 195Body
[
{
"id": 1104,
"quantity": "1.0",
"unit_name": null,
"name": "Emilio Stark",
"vat_id": 41,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}
]List of company's actuarial out lines
Request
Route
GET api/companies/121/actuarials_outs/691/lines
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"a4c68e39904bb32b840678ef6a3b4e45"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=01de7d4187e233b941bf2e3b9e300fcf; path=/; expires=Wed, 19 Aug 2020 13:05:23 -0000; HttpOnly
X-Request-Id: b0462ee1-c168-4177-9b8b-2cc483b7c1e6
X-Runtime: 0.025112
Content-Length: 199Body
[
{
"id": 1101,
"quantity": "1.0",
"unit_name": null,
"name": "Theron Cummerata",
"vat_id": 40,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}
]Update company's actuarial in line
Parameters
| Name | Description |
|---|---|
| line[name] | Line name |
| line[quantity] | Line qty |
| line[unit_price] | Unit price |
| line[unit_name] | Unit name |
| line[vat_id] | Vat id |
| line[tax] | Tax |
| line[vat] | Vat |
| line[base_price] | Base price |
| line[total_price] | Total price |
| line[discount_percentage] | Unit discount |
Request
Route
PATCH api/companies/128/actuarials_ins/706/lines/1118
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"line": {
"quantity": 5.0
},
"quantity": 5.0
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"12cde0e972665c8dfde5dc7690e972c1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9961b999a379fc00325a452df4fd19f8; path=/; expires=Wed, 19 Aug 2020 13:05:24 -0000; HttpOnly
X-Request-Id: f59bb1f4-2ae7-4624-96fb-ff6a21dfe61e
X-Runtime: 0.013166
Content-Length: 203Body
{
"id": 1118,
"quantity": "5.0",
"unit_name": null,
"name": "Miss Lorriane Franecki",
"vat_id": 47,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}Update company's actuarial out line
Parameters
| Name | Description |
|---|---|
| line[name] | Line name |
| line[quantity] | Line qty |
| line[unit_price] | Unit price |
| line[vat_id] | Vat id |
| line[unit_name] | Unit name |
| line[tax] | Tax |
| line[vat] | Vat |
| line[base_price] | Base price |
| line[total_price] | Total price |
| line[discount_percentage] | Unit discount |
Request
Route
PATCH api/companies/127/actuarials_outs/703/lines/1115
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"line": {
"quantity": 5.0
}
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"6adeb74e8cfeb09e2a4767d6b191df9c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f4ec9947168cef68a67936ad7f5ffea4; path=/; expires=Wed, 19 Aug 2020 13:05:24 -0000; HttpOnly
X-Request-Id: bd4a2829-711d-4c0b-b938-7ab584361f2d
X-Runtime: 0.013513
Content-Length: 197Body
{
"id": 1115,
"quantity": "5.0",
"unit_name": null,
"name": "Marco Medhurst V",
"vat_id": 46,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}Actuarials Out
Actuarials Out Initialize
Request
Route
GET api/companies/40/actuarials_outs/new
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"8067c2f085331124703b213858eb500d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=0440618035fc649ff0ae66935b824d0b; path=/; expires=Wed, 19 Aug 2020 13:03:33 -0000; HttpOnly
X-Request-Id: e9971280-a2fe-43ff-9004-0be43f750ff3
X-Runtime: 0.014920
Content-Length: 1355Body
{
"id": null,
"actuarial_type": "FA",
"actuarial_number": "202000001",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "29. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": null,
"end_price": null,
"remaining": 0,
"variable_symbol": null,
"currency": {
"id": 35,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
},
"print_notice": null,
"foot_notice": null,
"external_number": null,
"payment_type": null,
"due_date": 10,
"order_number": null,
"bank_number": "1111/1111",
"iban": null,
"swift": null,
"vat": null,
"paypal_identifier": null,
"account": {
"id": 95,
"name": "Banka",
"identifier": null,
"account_type": 2,
"currency_id": 35,
"country_id": 74,
"prefix": "B1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": 40,
"country_id": 74,
"account": "1111",
"bank_name": "Banka",
"iban": null,
"created_at": "2020-08-19T13:03:33.000+02:00",
"updated_at": "2020-08-19T13:03:33.000+02:00",
"bank_code": "1111",
"bankable_id": 40,
"bankable_type": "Company",
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
"taxable": false,
"pay": "0.0",
"supplier": {
"name": "Company 40",
"ic": "40",
"dic": null,
"dic2": null,
"street": "Mohammad Gardens",
"city": "East Georgeton",
"zip": "28541-2216",
"is_taxable": false,
"country_id": 74
},
"customer": {
"name": null,
"email": null,
"ic": null,
"dic": null,
"dic2": null,
"street": null,
"city": null,
"zip": null,
"country_id": null
},
"items": [
]
}Actuarials Out Initialize from scan
Request
Route
GET api/companies/42/actuarials_outs/new?scan_id=00000000-0000-0000-0000-000000000003
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
scan_id=00000000-0000-0000-0000-000000000003
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"245464af6d78f4db24bc1b34c66a0181"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fb5cdef7eabbc08ac6705bfb0d380ed7; path=/; expires=Wed, 19 Aug 2020 13:03:35 -0000; HttpOnly
X-Request-Id: f4bccc80-77a6-4a1f-8e4b-1bbdebd97de9
X-Runtime: 0.028525
Content-Length: 1492Body
{
"id": null,
"actuarial_type": "FA",
"actuarial_number": "202000001",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "29. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": null,
"end_price": null,
"remaining": 0,
"variable_symbol": "123456789",
"currency": {
"id": 36,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
},
"print_notice": null,
"foot_notice": null,
"external_number": null,
"payment_type": null,
"due_date": 10,
"order_number": null,
"bank_number": null,
"iban": null,
"swift": null,
"vat": null,
"paypal_identifier": null,
"account": {
"id": 99,
"name": "Hotovost",
"identifier": null,
"account_type": 1,
"currency_id": 36,
"country_id": null,
"prefix": "H1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": null,
"country_id": null,
"account": null,
"bank_name": null,
"iban": null,
"created_at": null,
"updated_at": null,
"bank_code": null,
"bankable_id": null,
"bankable_type": null,
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
"taxable": false,
"pay": "0.0",
"supplier": {
"name": null,
"ic": null,
"dic": null,
"dic2": null,
"street": null,
"city": null,
"zip": null,
"is_taxable": false,
"country_id": null
},
"customer": {
"name": "Mante-Hintz",
"email": "",
"ic": "89-589-4859",
"dic": "CZ07-262-0664",
"dic2": null,
"street": "Sebastian Divide",
"city": "West Iraida",
"zip": "27816",
"country_id": null
},
"items": [
{
"id": null,
"quantity": "1.0",
"unit_name": null,
"name": "Celková cena",
"vat_id": null,
"tax": null,
"unit_price": "1000.0",
"base_price": null,
"total_price": null,
"discount_percentage": null
}
]
}Actuarials Out Initialize from scan when company_ic not match
Request
Route
GET api/companies/44/actuarials_outs/new?scan_id=00000000-0000-0000-0000-000000000004
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
scan_id=00000000-0000-0000-0000-000000000004
Response
Status
400Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: your_session_key=0ba8f1c201635bc02777576613ff4b0b; path=/; expires=Wed, 19 Aug 2020 13:03:36 -0000; HttpOnly
X-Request-Id: 4c301172-6804-4249-9878-ebe508101642
X-Runtime: 0.010681
Content-Length: 95Body
{
"errors": [
"Nelze identifikovat fakturu. Je ta faktura opravdu vaše nebo Vám byla vydána?"
]
}Company's actuarial out detail
Request
Route
GET api/companies/38/actuarials_outs/453
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"407bd5eadf8f611120f53257ccb685c1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=10403c34becf485a474df21b8f82b892; path=/; expires=Wed, 19 Aug 2020 13:03:32 -0000; HttpOnly
X-Request-Id: e389d39f-1833-4cc0-8eee-9a9356790565
X-Runtime: 0.024401
Content-Length: 1496Body
{
"id": 453,
"actuarial_type": "FA",
"actuarial_number": "FV 453",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 34,
"iso_code": "CZK",
"name": "Czech crown",
"symbol": "Kč",
"symbol_first": false
},
"print_notice": null,
"foot_notice": null,
"external_number": null,
"payment_type": null,
"due_date": 0,
"order_number": null,
"bank_number": null,
"iban": null,
"swift": null,
"vat": "40.0",
"paypal_identifier": null,
"account": {
"id": 89,
"name": "Hotovost",
"identifier": null,
"account_type": 1,
"currency_id": 34,
"country_id": null,
"prefix": "H1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": null,
"country_id": null,
"account": null,
"bank_name": null,
"iban": null,
"created_at": null,
"updated_at": null,
"bank_code": null,
"bankable_id": null,
"bankable_type": null,
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
"taxable": false,
"pay": "0.0",
"supplier": {
"name": "Company 38",
"ic": "38",
"dic": null,
"dic2": null,
"street": "Jayson Ways",
"city": "Lake Latanyamouth",
"zip": "22843-6685",
"is_taxable": false,
"country_id": 71
},
"customer": {
"name": null,
"email": null,
"ic": null,
"dic": null,
"dic2": null,
"street": null,
"city": null,
"zip": null,
"country_id": null
},
"items": [
{
"id": 454,
"quantity": "1.0",
"unit_name": null,
"name": "Nanci Gutmann DDS",
"vat_id": 14,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}
]
}Create Actuarials Out
Parameters
| Name | Description |
|---|---|
| actuarials_out[partner_id] Required | Id of Partner |
| actuarials_out[account_id] Required | Id of account |
| actuarials_out[currency_id] Required | Id of currency |
| actuarials_out[actuarial_type_id] Required | Id of Type of actuarial |
| actuarials_out[actuarial_number] Required | Generated Number of actuarial |
| actuarials_out[due_date_at] Required | Due date of actuarial |
| actuarials_out[lines[name]] Required | Line name |
| actuarials_out[lines[quantity]] Required | Line name |
| actuarials_out[lines[unit_price]] Required | Price for unit |
| actuarials_out[lines[vat_id]] Required | Id of VAT |
| actuarials_out[lines[unit_name]] | Line unit_name |
| actuarials_out[lines[tax]] | tax |
| actuarials_out[lines[vat]] | vat |
| actuarials_out[lines[base_price]] | base_price |
| actuarials_out[lines[total_price]] | total_price |
| actuarials_out[lines[discount_percentage]] | discount_percentage |
| actuarials_out[variable_symbol] | Variable Symbol |
| actuarials_out[print_notice] | Print notice |
| actuarials_out[foot_notice] | Foot notice |
| actuarials_out[internal_notice] | Internal notice |
| actuarials_out[payment_type_id] | Id of Payment type |
| actuarials_out[issue_date_at] | Issue date |
| actuarials_out[uzp_date_at] | UZP date |
| actuarials_out[order_number] | Number of order |
| actuarials_out[department_id] | Id of Department |
| actuarials_out[bank_number] | Bank number |
| actuarials_out[iban] | IBAN |
| actuarials_out[swift] | SWIFT |
| actuarials_out[vat_regime_id] | Id of vat regime, only if company is_taxable = true |
| actuarials_out[is_visible_stamp] | Stamp visibility |
| actuarials_out[language] | ["en", "cs", "es"] |
Request
Route
POST api/companies/46/actuarials_outs
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"partner_id": 96,
"vat_regime_id": 19,
"actuarial_type_id": 23,
"due_date_at": "2020-09-02",
"account_id": 109,
"currency_id": 38,
"actuarial_number": "2015000001",
"lines": [
{
"vat_id": 18,
"lineable_type": "Actuarial",
"name": "Echo McCullough",
"quantity": 1,
"unit_price": 200,
"base_price": 200,
"tax": 20,
"total_price": 220,
"unit_name": "h"
}
]
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"2b81c2dc0e31e21b5cbda7e1850c7ef6"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=55e1a221091e5d332742e3546bc58b45; path=/; expires=Wed, 19 Aug 2020 13:03:37 -0000; HttpOnly
X-Request-Id: f14ecb0b-1e09-4434-8bf0-df94685545ab
X-Runtime: 0.030842
Content-Length: 1549Body
{
"id": 623,
"actuarial_type": "FA",
"actuarial_number": "2015000001",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "02. 09. 2020",
"status": "Připravený",
"status_id": 2,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 38,
"iso_code": "USD",
"name": "United states dollar",
"symbol": "$",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"external_number": null,
"payment_type": null,
"due_date": 14,
"order_number": null,
"bank_number": null,
"iban": null,
"swift": null,
"vat": "40.0",
"paypal_identifier": null,
"account": {
"id": 109,
"name": "Hotovost",
"identifier": null,
"account_type": 1,
"currency_id": 38,
"country_id": null,
"prefix": "H1",
"is_deactivated": false,
"opening_balance": "0.0",
"bank_account": {
"id": null,
"country_id": null,
"account": null,
"bank_name": null,
"iban": null,
"created_at": null,
"updated_at": null,
"bank_code": null,
"bankable_id": null,
"bankable_type": null,
"is_deleted": false,
"swift": null,
"qr_codes": false
}
},
"taxable": false,
"pay": "0.0",
"supplier": {
"name": "Company 46",
"ic": "46",
"dic": null,
"dic2": null,
"street": "Eleonor Row",
"city": "Gradyside",
"zip": "16284-6276",
"is_taxable": false,
"country_id": 83
},
"customer": {
"name": "Carrol Gislason",
"email": "2bud.durgan@example.net",
"ic": null,
"dic": null,
"dic2": null,
"street": "Lavon Ville",
"city": "Karryton",
"zip": "79677",
"country_id": 83
},
"items": [
{
"id": 624,
"quantity": "1.0",
"unit_name": "h",
"name": "Echo McCullough",
"vat_id": 18,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": null
}
]
}List of company's actuarials outs
Parameters
| Name | Description |
|---|---|
| page | Page |
| q[actuarial_type_id_eq] | ID of actuarial type |
| q[actuarial_number_cont] | Acturial number contains |
| q[partner_name_cont] | Customer name contains |
| q[status_eq] | Status is one of {1=>"concept", 2=>"prepare", 3=>"sent", 4=>"displayed", 5=>"commented", 6=>"corrected", 7=>"partly_paid", 8=>"paid", 9=>"archived", 10=>"storno", 11=>"done"} |
| q[uzp_date_at_gteq] | UZP date is later or equal to |
| q[uzp_date_at_lteq] | UZP date is before or equal to |
| q[due_date_at_gteq] | Due date is later or equal to |
| q[due_date_at_lteq] | Due date is before or equal to |
| q[issue_date_at_gteq] | Issue date is later or equal to |
| q[issue_date_at_lteq] | Issue date is before or equal to |
| q[base_price_gteq] | Base price is greater or equal to |
| q[base_price_lteq] | Base price is lower or equal to |
| q[end_price_gteq] | End price is greater or equal to |
| q[end_price_lteq] | End price is lower or equal to |
Request
Route
GET api/companies/30/actuarials_outs?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"ad531ef9f5980eb926678eb650644461"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=02c40a058c203846b3ded453cfdcec51; path=/; expires=Wed, 19 Aug 2020 13:03:29 -0000; HttpOnly
X-Request-Id: 1dabdb4c-b462-433f-88b4-04b8d89b3563
X-Runtime: 0.093531
Content-Length: 8881Body
[
{
"id": 346,
"actuarial_type": "FA",
"actuarial_number": "FV 346",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2021",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 340,
"actuarial_type": "FA",
"actuarial_number": "FV 340",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 339,
"actuarial_type": "FA",
"actuarial_number": "FV 339",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 338,
"actuarial_type": "FA",
"actuarial_number": "FV 338",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 337,
"actuarial_type": "FA",
"actuarial_number": "FV 337",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 336,
"actuarial_type": "FA",
"actuarial_number": "FV 336",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 335,
"actuarial_type": "FA",
"actuarial_number": "FV 335",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 334,
"actuarial_type": "FA",
"actuarial_number": "FV 334",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 333,
"actuarial_type": "FA",
"actuarial_number": "FV 333",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 332,
"actuarial_type": "FA",
"actuarial_number": "FV 332",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 331,
"actuarial_type": "FA",
"actuarial_number": "FV 331",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 330,
"actuarial_type": "FA",
"actuarial_number": "FV 330",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 329,
"actuarial_type": "FA",
"actuarial_number": "FV 329",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 328,
"actuarial_type": "FA",
"actuarial_number": "FV 328",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 327,
"actuarial_type": "FA",
"actuarial_number": "FV 327",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 326,
"actuarial_type": "FA",
"actuarial_number": "FV 326",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 325,
"actuarial_type": "FA",
"actuarial_number": "FV 325",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 324,
"actuarial_type": "FA",
"actuarial_number": "FV 324",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 323,
"actuarial_type": "FA",
"actuarial_number": "FV 323",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
},
{
"id": 322,
"actuarial_type": "FA",
"actuarial_number": "FV 322",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 30,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 60,
"name": "Drobný nákup"
}
}
]List of company's actuarials outs with filter status
Parameters
| Name | Description |
|---|---|
| page | Page |
| q[actuarial_type_id_eq] | ID of actuarial type |
| q[actuarial_number_cont] | Acturial number contains |
| q[partner_name_cont] | Customer name contains |
| q[status_eq] | Status is one of {1=>"concept", 2=>"prepare", 3=>"sent", 4=>"displayed", 5=>"commented", 6=>"corrected", 7=>"partly_paid", 8=>"paid", 9=>"archived", 10=>"storno", 11=>"done"} |
| q[uzp_date_at_gteq] | UZP date is later or equal to |
| q[uzp_date_at_lteq] | UZP date is before or equal to |
| q[due_date_at_gteq] | Due date is later or equal to |
| q[due_date_at_lteq] | Due date is before or equal to |
| q[issue_date_at_gteq] | Issue date is later or equal to |
| q[issue_date_at_lteq] | Issue date is before or equal to |
| q[base_price_gteq] | Base price is greater or equal to |
| q[base_price_lteq] | Base price is lower or equal to |
| q[end_price_gteq] | End price is greater or equal to |
| q[end_price_lteq] | End price is lower or equal to |
Request
Route
GET api/companies/36/actuarials_outs?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E&q%5Bstatus_eq%5D=7
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
q={"status_eq"=>"7"}
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b7fe9f1341002aec7b8da62f6a533107"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=c7094b48d1924a391083130541aa4d8d; path=/; expires=Wed, 19 Aug 2020 13:03:32 -0000; HttpOnly
X-Request-Id: 374c3712-8cf5-44f2-bb98-dac100c5c5f6
X-Runtime: 0.012623
Content-Length: 459Body
[
{
"id": 452,
"actuarial_type": "FA",
"actuarial_number": "FV 452",
"uzp_date_at": "19. 08. 2020",
"due_date_at": "19. 08. 2020",
"status": "V přípravě",
"status_id": 1,
"issue_date_at": "19. 08. 2020",
"base_price": "200.0",
"end_price": "240.0",
"remaining": "240.0",
"variable_symbol": null,
"currency": {
"id": 33,
"iso_code": "USD",
"name": "United states dollar",
"symbol": "$",
"symbol_first": true
},
"print_notice": null,
"foot_notice": null,
"customer": {
"id": 72,
"name": "Drobný nákup"
}
}
]Pay actuarial and make cash voucher
Request
Route
GET api/companies/48/actuarials_outs/623/pay
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"a8f94bb858f74b14da887dcf5109ee21"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=2ccd222f75b827acb4575018e72da278; path=/; expires=Wed, 19 Aug 2020 13:03:38 -0000; HttpOnly
X-Request-Id: 3434614f-b2e0-4ffe-bdc9-a05aba477a02
X-Runtime: 0.095286
Content-Length: 21Body
{
"cash_voucher_id": 1
}Send Actuarial to specific email
Parameters
| Name | Description |
|---|---|
| email Required | |
| comment |
Request
Route
PATCH api/companies/50/actuarials_outs/657/send_to_email
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"email": "a@a.com",
"comment": "bla"
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json
Cache-Control: no-cache
Set-Cookie: your_session_key=a017e46dfe3a4d8239229dde1d22ee64; path=/; expires=Wed, 19 Aug 2020 13:04:17 -0000; HttpOnly
X-Request-Id: 98c47581-2205-4164-8fc4-5223fc323dd2
X-Runtime: 38.376183
Content-Length: 0Admin Auth
App auth
Request
Route
GET api/admin/scans?document=false
Headers
Accept: application/json
Content-Type: application/json
Host: example.org
Cookie: Query Parameters
document=false
Response
Status
401Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: text/html
Cache-Control: no-cache
X-Request-Id: cd5b80ca-93f4-42c0-a3f6-9666c381c8ac
X-Runtime: 0.017105
Content-Length: 0App auth without token
Request
Route
GET api/admin/scans?document=false
Headers
Accept: application/json
Content-Type: application/json
Auth-App: invalid
Host: example.org
Cookie: Query Parameters
document=false
Response
Status
401Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: text/html
Cache-Control: no-cache
X-Request-Id: ec42b1a1-81b3-414f-bb8d-babf8d7c0aaf
X-Runtime: 0.002051
Content-Length: 0Admin Countries
List of countries
Request
Route
GET api/admin/countries
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"5c796f88571baa67c7d7c3d747576ea4"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ba76804b-a77c-4ce6-8a4c-5c34ac966469
X-Runtime: 0.021287
Content-Length: 299Body
[
{
"id": 98,
"name": "Czech Republic",
"fuel_unit": "l",
"length_unit": "km",
"default_language": "cs",
"currency": {
"id": 43,
"iso_code": "CZK",
"name": "Czech crown"
}
},
{
"id": 99,
"name": "Slovak Republic",
"fuel_unit": "l",
"length_unit": "km",
"default_language": "cs",
"currency": {
"id": 44,
"iso_code": "EUR",
"name": "Euro"
}
}
]Admin Currencies
List of currencies
Request
Route
GET api/admin/currencies
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"90c28d79ff7e2cac61b59b7b400fb575"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: cf6da40e-0ed1-4f7a-85a1-c2cbafb7f15c
X-Runtime: 0.018141
Content-Length: 246Body
[
{
"id": 45,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
{
"id": 46,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
},
{
"id": 47,
"iso_code": "CZK",
"name": "Czech crown",
"symbol": "Kč",
"symbol_first": false
}
]Admin Scans
Get scan data
Request
Route
GET api/admin/scans/00000000-0000-0000-0000-000000000058/data
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: text/plain
Content-Disposition: attachment; filename="empty2.png"
Content-Transfer-Encoding: binary
Cache-Control: private
X-Request-Id: 8c1774ef-9d3a-457b-8d5c-10db019dbcf1
X-Runtime: 0.003052
Content-Length: 95Body
[binary data]Get scan detail
Request
Route
GET api/admin/scans/00000000-0000-0000-0000-000000000051
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Location: http://example.org/api/admin/scans/00000000-0000-0000-0000-000000000051
Content-Type: application/json; charset=utf-8
ETag: W/"2781899f20b000e20ac5586891c20f06"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1f0713bb-97cc-4eb4-bdec-def631c12bd5
X-Runtime: 0.007448
Content-Length: 83Body
{
"id": "00000000-0000-0000-0000-000000000051",
"size": 95,
"content_type": "text/plain"
}List of processed scans
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
Request
Route
GET api/admin/scans/processed?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"6b28924efa01b7aa2e7eef6865fc6fd6"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ec398904-d804-484c-a02a-48df40e78dd9
X-Runtime: 0.004538
Content-Length: 313Body
[
{
"id": "00000000-0000-0000-0000-000000000038",
"size": 95,
"content_type": "text/plain",
"state": "processed"
},
{
"id": "00000000-0000-0000-0000-000000000037",
"size": 95,
"content_type": "text/plain",
"state": "processed"
},
{
"id": "00000000-0000-0000-0000-000000000036",
"size": 95,
"content_type": "text/plain",
"state": "processed"
}
]List of scans
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
Request
Route
GET api/admin/scans?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"a0c7238daa5c6dfdbbaabbf3dc4c7efd"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: edd48f5d-d61d-471f-a6e1-adf6a8dca08b
X-Runtime: 0.008558
Content-Length: 622Body
[
{
"id": "00000000-0000-0000-0000-000000000014",
"size": 95,
"content_type": "text/plain",
"state": "processed"
},
{
"id": "00000000-0000-0000-0000-000000000013",
"size": 95,
"content_type": "text/plain",
"state": "processed"
},
{
"id": "00000000-0000-0000-0000-000000000012",
"size": 95,
"content_type": "text/plain",
"state": "processed"
},
{
"id": "00000000-0000-0000-0000-000000000011",
"size": 95,
"content_type": "text/plain",
"state": "uploaded"
},
{
"id": "00000000-0000-0000-0000-000000000010",
"size": 95,
"content_type": "text/plain",
"state": "uploaded"
},
{
"id": "00000000-0000-0000-0000-000000000009",
"size": 95,
"content_type": "text/plain",
"state": "uploaded"
}
]List of unprocessed scans
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
Request
Route
GET api/admin/scans/unprocessed?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"e5b333283c716411bdf1904d945e6af2"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8dc422b3-fe15-4f8c-a912-3067ea1d40ef
X-Runtime: 0.004702
Content-Length: 310Body
[
{
"id": "00000000-0000-0000-0000-000000000023",
"size": 95,
"content_type": "text/plain",
"state": "uploaded"
},
{
"id": "00000000-0000-0000-0000-000000000022",
"size": 95,
"content_type": "text/plain",
"state": "uploaded"
},
{
"id": "00000000-0000-0000-0000-000000000021",
"size": 95,
"content_type": "text/plain",
"state": "uploaded"
}
]Procesed scan
Parameters
| Name | Description | Types |
|---|---|---|
| scan[total_price] | Total price | |
| scan[partner_name] | Partner Name | |
| scan[partner_ic] | Partner TIN | |
| scan[partner_dic] | Partner VAT | |
| scan[partner_street] | Partner Street | |
| scan[partner_city] | Partner City | |
| scan[partner_zip] | Partner ZIP | |
| scan[partner_country_id] | Partner Country ID | |
| scan[company_name] | Company Name | |
| scan[company_ic] | Company TIN | |
| scan[company_dic] | Company VAT | |
| scan[company_street] | Company Street | |
| scan[company_city] | Company City | |
| scan[company_zip] | Company ZIP | |
| scan[company_country_id] | Company Country ID | |
| scan[issue_date_at] | Issue date | |
| scan[due_date_at] | Due date | |
| scan[uzp_date_at] | UZP date | |
| scan[payment_type] | Payment type | checkout: 1, bank: 2, paypal: 3 |
| scan[variable_symbol] | Variable symbol | |
| scan[currency_id] | Currency ID |
Request
Route
PATCH api/admin/scans/00000000-0000-0000-0000-000000000072/proceed
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Body
{
"scan": {
"partner_name": "Partner Company s.r.o.",
"company_name": "My Company s.r.o.",
"total_price": "1000.10",
"partner_ic": "12345678",
"partner_dic": "CZ12345678",
"partner_street": "Street 134/2",
"partner_city": "City",
"partner_zip": "12345",
"partner_country_id": 124,
"company_ic": "98765432",
"company_dic": "CZ98765432",
"company_street": "Street 567/3",
"company_city": "Another City",
"company_zip": "98765",
"company_country_id": 124,
"issue_date_at": "2020-08-19",
"due_date_at": "2020-09-02",
"uzp_date_at": "2020-08-19",
"payment_type": 2,
"variable_symbol": "20170123456",
"currency_id": 58
}
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Location: http://example.org/api/admin/scans/00000000-0000-0000-0000-000000000072
Content-Type: application/json; charset=utf-8
ETag: W/"0dc75b859e8c469b35e8b326fd852e41"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e20b5d19-38b8-462e-a2a9-59e36dd5278e
X-Runtime: 0.010486
Content-Length: 655Body
{
"id": "00000000-0000-0000-0000-000000000072",
"size": 95,
"content_type": "text/plain",
"total_price": "1000.1",
"partner_name": "Partner Company s.r.o.",
"partner_ic": "12345678",
"partner_dic": "CZ12345678",
"partner_street": "Street 134/2",
"partner_city": "City",
"partner_zip": "12345",
"partner_country_id": 124,
"company_name": "My Company s.r.o.",
"company_ic": "98765432",
"company_dic": "CZ98765432",
"company_street": "Street 567/3",
"company_city": "Another City",
"company_zip": "98765",
"company_country_id": 124,
"payment_type": "bank",
"variable_symbol": "20170123456",
"currency_id": "58",
"due_date_at": "02. 09. 2020",
"issue_date_at": "19. 08. 2020",
"uzp_date_at": "19. 08. 2020"
}Processing scan
Request
Route
PATCH api/admin/scans/00000000-0000-0000-0000-000000000065/processing
Headers
Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Location: http://example.org/api/admin/scans/00000000-0000-0000-0000-000000000065
Content-Type: application/json; charset=utf-8
ETag: W/"6a4dc2339acee310b2a100d56e3d5a4d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5ecd3d73-66ec-4387-af12-55cfb234f522
X-Runtime: 0.007327
Content-Length: 83Body
{
"id": "00000000-0000-0000-0000-000000000065",
"size": 95,
"content_type": "text/plain"
}Api Auth
App auth
Request
Route
GET api/companies/66/scans?document=false
Headers
Accept: application/json
Content-Type: application/json
Host: example.org
Cookie: Query Parameters
document=false
Response
Status
401Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: fdd1502a-c19c-4ed1-a3db-13e6d558ec0a
X-Runtime: 0.023997
Content-Length: 2Body
[
]App auth without token
Request
Route
GET api/companies/67/scans?document=false
Headers
Accept: application/json
Content-Type: application/json
Auth-App: invalid
Host: example.org
Cookie: Query Parameters
document=false
Response
Status
401Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
X-Request-Id: 18a345ee-ac57-4567-90de-6501dbf772f0
X-Runtime: 0.002786
Content-Length: 2Body
[
]ApiPermissions
List of resources with read permission
Request
Route
GET api/companies/65/api_permissions/navigation
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"4ffa561c1300227f9b0ae109381af9ce"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=746a521e2df4f8185fe6115b4dd10107; path=/; expires=Wed, 19 Aug 2020 13:04:57 -0000; HttpOnly
X-Request-Id: a937393c-7faa-4712-a16f-b5920fba1cbc
X-Runtime: 0.008924
Content-Length: 42Body
[
"ActuarialsIn",
"ActuarialsOut",
"Partner"
]List of user abilities
Parameters
| Name | Description |
|---|---|
| resource | Permissions by resource |
Request
Route
GET api/companies/64/api_permissions
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"2bc45dd2402780fa6aba504bd1246896"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7637040e79ea5b1b0ec418972a09bf46; path=/; expires=Wed, 19 Aug 2020 13:04:57 -0000; HttpOnly
X-Request-Id: d451802b-270a-4997-b312-a190e20e13d7
X-Runtime: 0.025835
Content-Length: 60Body
{
"create": false,
"read": false,
"update": false,
"destroy": false
}Request
Route
GET api/companies/64/api_permissions?resource=ActuarialsIn
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: your_session_key=7637040e79ea5b1b0ec418972a09bf46Query Parameters
resource=ActuarialsIn
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"d137f30b050637bdd08ee8d450542b9f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7637040e79ea5b1b0ec418972a09bf46; path=/; expires=Wed, 19 Aug 2020 13:04:57 -0000; HttpOnly
X-Request-Id: ceb4a582-5d01-48e3-8a62-05cc0d6389c0
X-Runtime: 0.009993
Content-Length: 59Body
{
"create": false,
"read": true,
"update": false,
"destroy": false
}Cash Vouchers In
Company's cash voucher in detail
Request
Route
GET api/companies/78/cash_vouchers_ins/107
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"d9e91a4194686742ccb204941b494de1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=28c3d8df1521dff5297bf0acbaae1513; path=/; expires=Wed, 19 Aug 2020 13:05:05 -0000; HttpOnly
X-Request-Id: dc9acf14-68ab-4269-828b-de6ee3e58b9d
X-Runtime: 0.014939
Content-Length: 567Body
{
"id": 107,
"number": "106",
"description": null,
"total_price": "240,00 USD",
"base_price": "200,00 USD",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
},
"external_number": null,
"status": {
"storno": "Stornováno"
},
"account": "Hotovost",
"items": [
{
"id": 795,
"quantity": "1.0",
"unit_name": null,
"name": "Flavia Schowalter",
"vat_id": 24,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}
],
"amounts": [
],
"payments": [
]
}List of company's cash vouchers ins
Parameters
| Name | Description |
|---|---|
| page | Page |
| q[number_cont] | Number contains |
| q[description_cont] | Description contains |
| q[partner_name_cont] | Recipient name contains |
| q[transaction_date_gteq] | Transaction date is later or equal to |
| q[transaction_date_lteq] | Transaction date is before or equal to |
| q[base_price_gteq] | Base price is greater or equal to |
| q[base_price_lteq] | Base price is lower or equal to |
| q[total_price_gteq] | Total price is greater or equal to |
| q[total_price_lteq] | Total price is lower or equal to |
Request
Route
GET api/companies/72/cash_vouchers_ins?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"348d3261b84d9a79faa2644ce5f338aa"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=2ac3dd32000268de345e2d3167aaf779; path=/; expires=Wed, 19 Aug 2020 13:05:01 -0000; HttpOnly
X-Request-Id: 0369a297-f4f4-4431-b3e7-f4735f1dae2a
X-Runtime: 0.080597
Content-Length: 5057Body
[
{
"id": 36,
"number": "35",
"description": null,
"total_price": "0,00 CZK",
"base_price": "0,00 CZK",
"transaction_date": "19. 08. 2021",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 30,
"number": "29",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 29,
"number": "28",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 28,
"number": "27",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 27,
"number": "26",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 26,
"number": "25",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 25,
"number": "24",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 24,
"number": "23",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 23,
"number": "22",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 22,
"number": "21",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 21,
"number": "20",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 20,
"number": "19",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 19,
"number": "18",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 18,
"number": "17",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 17,
"number": "16",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 16,
"number": "15",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 15,
"number": "14",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 14,
"number": "13",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 13,
"number": "12",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 12,
"number": "11",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
}
]Send cash voucher to partner
Parameters
| Name | Description |
|---|---|
| comment |
Request
Route
PATCH api/companies/80/cash_vouchers_ins/141/send_to_partner
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"comment": "bla"
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json
Cache-Control: no-cache
Set-Cookie: your_session_key=efd3c610385a20a0f8286f632aced5bd; path=/; expires=Wed, 19 Aug 2020 13:05:06 -0000; HttpOnly
X-Request-Id: 83c01040-e658-471f-b491-34be51b73d07
X-Runtime: 0.005794
Content-Length: 0Send cash voucher to specific email
Parameters
| Name | Description |
|---|---|
| email Required | |
| comment |
Request
Route
PATCH api/companies/82/cash_vouchers_ins/175/send_to_email
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"email": "a@a.com",
"comment": "bla"
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json
Cache-Control: no-cache
Set-Cookie: your_session_key=c83a8788e181858e1f9e1f4b767707b0; path=/; expires=Wed, 19 Aug 2020 13:05:07 -0000; HttpOnly
X-Request-Id: e6f21585-4f46-403e-a12b-2a8bdcedab05
X-Runtime: 0.494364
Content-Length: 0Cash Vouchers Out
Company's cash voucher out detail
Request
Route
GET api/companies/90/cash_vouchers_outs/314
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"2c65866912ac6e8d03606f329ee6e5db"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=71c7e02e79d37d16a061f167e73cf825; path=/; expires=Wed, 19 Aug 2020 13:05:12 -0000; HttpOnly
X-Request-Id: 31a0eb43-609e-4653-82bf-816911248a76
X-Runtime: 0.013107
Content-Length: 567Body
{
"id": 314,
"number": "313",
"description": null,
"total_price": "240,00 EUR",
"base_price": "200,00 EUR",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
},
"external_number": null,
"status": {
"storno": "Stornováno"
},
"account": "Hotovost",
"items": [
{
"id": 999,
"quantity": "1.0",
"unit_name": null,
"name": "Wilfredo Schaefer",
"vat_id": 30,
"tax": "40.0",
"vat": "20.0",
"unit_price": "200.0",
"base_price": "200.0",
"total_price": "240.0",
"discount_percentage": 0
}
],
"amounts": [
],
"payments": [
]
}List of company's cash vouchers outs
Parameters
| Name | Description |
|---|---|
| page | Page |
| q[number_cont] | Number contains |
| q[description_cont] | Description contains |
| q[partner_name_cont] | Recipient name contains |
| q[transaction_date_gteq] | Transaction date is later or equal to |
| q[transaction_date_lteq] | Transaction date is before or equal to |
| q[base_price_gteq] | Base price is greater or equal to |
| q[base_price_lteq] | Base price is lower or equal to |
| q[total_price_gteq] | Total price is greater or equal to |
| q[total_price_lteq] | Total price is lower or equal to |
Request
Route
GET api/companies/84/cash_vouchers_outs?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"cf29843066ad58eb6b4cc809dcd8e1b2"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=0fb788eb03e5568c961c7adf75a3a2d1; path=/; expires=Wed, 19 Aug 2020 13:05:08 -0000; HttpOnly
X-Request-Id: 91aaaa01-fd6f-401b-a826-11969243c925
X-Runtime: 0.082467
Content-Length: 5097Body
[
{
"id": 243,
"number": "242",
"description": null,
"total_price": "0,00 CZK",
"base_price": "0,00 CZK",
"transaction_date": "19. 08. 2021",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 237,
"number": "236",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 236,
"number": "235",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 235,
"number": "234",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 234,
"number": "233",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 233,
"number": "232",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 232,
"number": "231",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 231,
"number": "230",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 230,
"number": "229",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 229,
"number": "228",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 228,
"number": "227",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 227,
"number": "226",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 226,
"number": "225",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 225,
"number": "224",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 224,
"number": "223",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 223,
"number": "222",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 222,
"number": "221",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 221,
"number": "220",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 220,
"number": "219",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
},
{
"id": 219,
"number": "218",
"description": null,
"total_price": "240,00 CZK",
"base_price": "200,00 CZK",
"transaction_date": "19. 08. 2020",
"recipient": {
"name": "Drobný nákup",
"street": null,
"city": null,
"zip": null,
"country": null,
"ic": null,
"dic": null,
"dic2": null
}
}
]Send cash voucher to partner
Parameters
| Name | Description |
|---|---|
| comment |
Request
Route
PATCH api/companies/92/cash_vouchers_outs/348/send_to_partner
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"comment": "bla"
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json
Cache-Control: no-cache
Set-Cookie: your_session_key=3533ac3dd418d343c8583bdd260c9d97; path=/; expires=Wed, 19 Aug 2020 13:05:13 -0000; HttpOnly
X-Request-Id: 09586034-3d78-475d-b7a8-9fdb08cbd39f
X-Runtime: 0.005680
Content-Length: 0Send cash voucher to specific email
Parameters
| Name | Description |
|---|---|
| email Required | |
| comment |
Request
Route
PATCH api/companies/94/cash_vouchers_outs/382/send_to_email
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"email": "a@a.com",
"comment": "bla"
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json
Cache-Control: no-cache
Set-Cookie: your_session_key=e9ac56688b786ff93594907f20dc9396; path=/; expires=Wed, 19 Aug 2020 13:05:14 -0000; HttpOnly
X-Request-Id: 02036cd9-e80e-4356-b63f-0c0cc8421441
X-Runtime: 0.418849
Content-Length: 0Companies
Company's employee
Request
Route
GET api/companies/119/employees/90
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b90443a4cda2cb8fbc8f3b19cb678848"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=3d3720e8a38af1ff86e80d2e481643d3; path=/; expires=Wed, 19 Aug 2020 13:05:23 -0000; HttpOnly
X-Request-Id: c64dde8e-b89e-4f94-9091-4b9a9b252aa2
X-Runtime: 0.006603
Content-Length: 306Body
{
"id": 90,
"first_name": "Moises",
"last_name": "Rutherford",
"bank_account": null,
"birthday": "2020-08-19",
"status": null,
"nationality": null,
"place_of_birth": null,
"personal_number": "19. 08. 2020",
"identification_number": null,
"employee_number": "number_19. 08. 2020",
"education": null,
"citizenhood": null,
"sex": "Muž"
}Detail of company
Request
Route
GET api/companies/96
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"ca85432d624f17b90ffd39f098f5f299"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=d315719ea1a4e618507b676165040809; path=/; expires=Wed, 19 Aug 2020 13:05:15 -0000; HttpOnly
X-Request-Id: 6d1b830f-1920-4fa5-84b3-0ac061133f6d
X-Runtime: 0.008796
Content-Length: 194Body
{
"id": 96,
"name": "Company 96",
"ic": "96",
"is_taxable": false,
"country_id": 1001,
"email": "company-96@sucto.cz",
"address": {
"street": "Robby Wall",
"city": "Roseannaville",
"city_part": null,
"zip": "25250"
}
}List of companies
Request
Route
GET api/companies
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"4f53cda18c2baa0c0354bb5f9a3ecbe5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b6515ae6be9cf601bea2144da7ddc7fb; path=/; expires=Wed, 19 Aug 2020 13:05:14 -0000; HttpOnly
X-Request-Id: 9f608708-d8d4-4afd-82c8-2b4a5eb59160
X-Runtime: 0.018682
Content-Length: 2Body
[
]List of company's employees
Parameters
| Name | Description |
|---|---|
| page | Page |
Request
Route
GET api/companies/115/employees?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"9432902bced56689209ad0b055b7d8ea"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=38f767f17ba2da9245383e1b1cdcedb7; path=/; expires=Wed, 19 Aug 2020 13:05:22 -0000; HttpOnly
X-Request-Id: 48d52631-62b8-4686-8393-e527f032cfbb
X-Runtime: 0.020860
Content-Length: 2469Body
[
{
"id": 10,
"first_name": "Patti",
"last_name": "Towne",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 11,
"first_name": "Lou",
"last_name": "Koelpin",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 12,
"first_name": "Merry",
"last_name": "Reichert",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 13,
"first_name": "Tamica",
"last_name": "Considine",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 14,
"first_name": "Cheryl",
"last_name": "McLaughlin",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 15,
"first_name": "Oleta",
"last_name": "Schneider",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 16,
"first_name": "Tatyana",
"last_name": "Zulauf",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 17,
"first_name": "Aisha",
"last_name": "Toy",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 18,
"first_name": "Tomas",
"last_name": "Dibbert",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 19,
"first_name": "Jeromy",
"last_name": "Fadel",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 20,
"first_name": "Andreas",
"last_name": "Schneider",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 21,
"first_name": "Alfonso",
"last_name": "Lind",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 22,
"first_name": "Summer",
"last_name": "Lind",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 23,
"first_name": "Jordan",
"last_name": "Casper",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 24,
"first_name": "Rosina",
"last_name": "Ullrich",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 25,
"first_name": "Lenard",
"last_name": "Fay",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 26,
"first_name": "Assunta",
"last_name": "Hermiston",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 27,
"first_name": "Valentine",
"last_name": "Romaguera",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 28,
"first_name": "Ollie",
"last_name": "Wiza",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
},
{
"id": 29,
"first_name": "Janiece",
"last_name": "Bogan",
"personal_number": "19. 08. 2020",
"birthday": "2020-08-19",
"sex": "Muž"
}
]Countries
Detail of country
Request
Route
GET api/countries/1009
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b16d59ed525ff3b940ad5218b54238f5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=3a5a43f2c293c3278a7096f2532cd99c; path=/; expires=Wed, 19 Aug 2020 13:05:15 -0000; HttpOnly
X-Request-Id: 82b91bb8-0c1f-4a65-8e02-b171ec602949
X-Runtime: 0.007126
Content-Length: 153Body
{
"id": 1009,
"name": "Czech Republic",
"fuel_unit": "l",
"length_unit": "km",
"default_language": "cs",
"currency": {
"id": 80,
"iso_code": "CZK",
"name": "Czech crown"
}
}List of countries
Request
Route
GET api/countries
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"217d9b3718456098aa325db0fd0cfba5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=5c6a678bae17fafe4feb74760afde203; path=/; expires=Wed, 19 Aug 2020 13:05:15 -0000; HttpOnly
X-Request-Id: 25554923-ed69-4738-a5d4-908275ea2b66
X-Runtime: 0.019588
Content-Length: 303Body
[
{
"id": 1005,
"name": "Czech Republic",
"fuel_unit": "l",
"length_unit": "km",
"default_language": "cs",
"currency": {
"id": 78,
"iso_code": "CZK",
"name": "Czech crown"
}
},
{
"id": 1006,
"name": "Slovak Republic",
"fuel_unit": "l",
"length_unit": "km",
"default_language": "cs",
"currency": {
"id": 79,
"iso_code": "EUR",
"name": "Euro"
}
}
]List of country's vat regimes
Request
Route
GET api/countries/1237/vat_regimes
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"db02c24e051e104b53e86a1ff315342e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=99f0357121f7b672c292446a4937ee84; path=/; expires=Wed, 19 Aug 2020 13:06:03 -0000; HttpOnly
X-Request-Id: c6f33925-8b4f-4bc0-a241-a375f89714ec
X-Runtime: 0.021810
Content-Length: 150Body
[
{
"id": 34,
"name": "Tuzemská plnění"
},
{
"id": 35,
"name": "Přenesení daňové povinnosti"
},
{
"id": 36,
"name": "EU zboží"
},
{
"id": 37,
"name": "EU služba"
}
]List of country's vats
Request
Route
GET api/countries/1240/vats
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"040e7f4242be007ba46a8dbe4220fbd8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=61a5972893e27984a7dc7b7f65d24b8c; path=/; expires=Wed, 19 Aug 2020 13:06:03 -0000; HttpOnly
X-Request-Id: 0c674e69-5314-45ca-a045-d297e5b36e05
X-Runtime: 0.013890
Content-Length: 226Body
[
{
"id": 52,
"value": "20.0",
"valid_from": "2020-08-19",
"valid_to": "2020-08-20"
},
{
"id": 54,
"value": "19.0",
"valid_from": "2020-08-19",
"valid_to": "2020-08-20"
},
{
"id": 53,
"value": "11.0",
"valid_from": "2020-08-19",
"valid_to": "2020-08-20"
}
]List of current country's vats
Request
Route
GET api/countries/1244/vats/current
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"96c791254285b25c006a606773217f11"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9139e1466a3b9f4a670d5b520dc9727a; path=/; expires=Wed, 19 Aug 2020 13:06:03 -0000; HttpOnly
X-Request-Id: 8c7c356d-fc4c-45dc-95cd-7104003d9dae
X-Runtime: 0.004488
Content-Length: 68Body
[
{
"id": 64,
"value": "21.0",
"valid_from": "2020-08-19",
"valid_to": null
}
]Cupply Codes
List of supply codes
Request
Route
GET api/supply_codes
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"0d06c3f70b7b5ef5eceb4ca2f1d37d24"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=bab68d79f1a1b09d74c6ea505f46ec49; path=/; expires=Wed, 19 Aug 2020 13:06:03 -0000; HttpOnly
X-Request-Id: 7dc62e7e-4237-4961-9a4c-d1b832d86bfe
X-Runtime: 0.020390
Content-Length: 118Body
[
{
"id": 1,
"ident": "1",
"name": "MyString"
},
{
"id": 2,
"ident": "2",
"name": "MyString"
},
{
"id": 3,
"ident": "3",
"name": "MyString"
}
]Currencies
List of currencies
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
| q[iso_code_or_name_cont] | Search by fields |
Request
Route
GET api/currencies?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"dce75b90318662ac8ffd450bd65ea2c0"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fadd077f2ed3860089e6a06b0449bb1f; path=/; expires=Wed, 19 Aug 2020 13:05:15 -0000; HttpOnly
X-Request-Id: 05814e88-e098-4b5e-8b01-e93a6d56219a
X-Runtime: 0.019289
Content-Length: 251Body
[
{
"id": 82,
"iso_code": "EUR",
"name": "Euro",
"symbol": "€",
"symbol_first": true
},
{
"id": 83,
"iso_code": "USD",
"name": "United states dollar",
"symbol": "$",
"symbol_first": true
},
{
"id": 84,
"iso_code": "CZK",
"name": "Czech crown",
"symbol": "Kč",
"symbol_first": false
}
]Search of currencies
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
| q[iso_code_or_name_cont] | Search by fields |
Request
Route
GET api/currencies?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E&q%5Biso_code_cont%5D=CZK
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
q={"iso_code_cont"=>"CZK"}
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"89908a4f42221d63aa1ae5b0b92446e7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fe757cb5d72d0c09414c1ac956978dac; path=/; expires=Wed, 19 Aug 2020 13:05:15 -0000; HttpOnly
X-Request-Id: 31209f46-39e6-4783-9609-3ebc6e7c654d
X-Runtime: 0.006109
Content-Length: 85Body
[
{
"id": 87,
"iso_code": "CZK",
"name": "Czech crown",
"symbol": "Kč",
"symbol_first": false
}
]Dashboard
Widgets
Request
Route
GET api/companies/97/dashboard
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"521d39e2fc3904dc47d8f9bc8841bafa"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=6dd2faeb8d4e61264a89d7a5904e8590; path=/; expires=Wed, 19 Aug 2020 13:05:15 -0000; HttpOnly
X-Request-Id: a1c10b81-e387-4893-a918-b1b68ebfa86a
X-Runtime: 0.016146
Content-Length: 116Body
{
"system_informations": {
"id": 1,
"title": "Grover Larkin",
"created_at": "19. 08. 2020",
"description": "ut",
"image": null
}
}Departments
List of departments
Request
Route
GET api/companies/98/departments
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"5f59e979fb664e4cbe6dc8eb0a24da24"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=12c0c61ba9dd743891e4f3ae50e2ddd6; path=/; expires=Wed, 19 Aug 2020 13:05:15 -0000; HttpOnly
X-Request-Id: ad1d6e73-c0d8-4374-8b58-a3ac21bc423d
X-Runtime: 0.015220
Content-Length: 1045Body
[
{
"id": 22,
"value": "Ms. Wilford Pfeffer",
"company_id": 98,
"created_at": "2020-08-19T13:05:15.000+02:00",
"updated_at": "2020-08-19T13:05:15.000+02:00",
"parent_id": null,
"lft": 1,
"rgt": 2,
"position": null,
"pohoda_id": null
},
{
"id": 23,
"value": "Selene Bergstrom",
"company_id": 98,
"created_at": "2020-08-19T13:05:15.000+02:00",
"updated_at": "2020-08-19T13:05:15.000+02:00",
"parent_id": null,
"lft": 3,
"rgt": 4,
"position": null,
"pohoda_id": null
},
{
"id": 24,
"value": "Ima O'Connell",
"company_id": 98,
"created_at": "2020-08-19T13:05:15.000+02:00",
"updated_at": "2020-08-19T13:05:15.000+02:00",
"parent_id": null,
"lft": 5,
"rgt": 6,
"position": null,
"pohoda_id": null
},
{
"id": 25,
"value": "Reggie Adams",
"company_id": 98,
"created_at": "2020-08-19T13:05:15.000+02:00",
"updated_at": "2020-08-19T13:05:15.000+02:00",
"parent_id": null,
"lft": 7,
"rgt": 8,
"position": null,
"pohoda_id": null
},
{
"id": 26,
"value": "Elena Pfannerstill",
"company_id": 98,
"created_at": "2020-08-19T13:05:15.000+02:00",
"updated_at": "2020-08-19T13:05:15.000+02:00",
"parent_id": null,
"lft": 9,
"rgt": 10,
"position": null,
"pohoda_id": null
}
]Logbook
Company's car
Request
Route
GET api/companies/70/cars/7
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"4c23ded2f4c4326322b302d2e263b45c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=97a1481e6ca63b5cca9e618a60cabe15; path=/; expires=Wed, 19 Aug 2020 13:05:00 -0000; HttpOnly
X-Request-Id: 80dca243-6342-4a61-95ae-ee303bea1340
X-Runtime: 0.007213
Content-Length: 314Body
{
"id": 7,
"number_plate": "85-346-8551",
"description": "Dolores non aspernatur quod.",
"is_private": false,
"average_consumption": "5.0",
"engine_capacity": "30.0",
"initial_tach_value": 123,
"year": null,
"color": null,
"body_number": null,
"default_starting_location": null,
"vin": null,
"car_type": {
"id": 2,
"name": "Melissa Zemlak IV"
}
}Company's drive record
Request
Route
GET api/companies/109/drive_records/75
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"34555fc60c3c5d8a009d854811176510"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=852199e7cb55e1c2c5e884d2c31bf283; path=/; expires=Wed, 19 Aug 2020 13:05:21 -0000; HttpOnly
X-Request-Id: ad795124-4c90-447f-8d63-a5f71a284b9c
X-Runtime: 0.015135
Content-Length: 2598Body
{
"id": 75,
"is_private": null,
"start_location": "37581 Jess Isle",
"end_location": "8682 Sanford Passage",
"start_time": "2020-08-19T13:05:20.000+02:00",
"end_time": "2020-08-19T17:05:20.000+02:00",
"and_back": null,
"trip_length": 300,
"start_tachometer": 0,
"end_tachometer": 500,
"purpose": "Doloribus hic cum quo.",
"car": {
"id": 17,
"number_plate": "48-197-3192",
"description": "Et distinctio placeat veritatis.",
"is_private": false,
"average_consumption": "5.0",
"engine_capacity": "30.0",
"initial_tach_value": 123,
"year": null,
"color": null,
"body_number": null,
"default_starting_location": null,
"vin": null,
"car_type": {
"id": 7,
"name": "Ezekiel Hegmann"
}
},
"employee": {
"id": 7,
"first_name": "Prudence",
"last_name": "Bergnaum",
"bank_account": null,
"birthday": "2020-08-19",
"status": null,
"nationality": null,
"place_of_birth": null,
"personal_number": "19. 08. 2020",
"identification_number": null,
"employee_number": "number_19. 08. 2020",
"education": null,
"citizenhood": null,
"sex": "Muž"
},
"drive_expenses": [
{
"id": 219,
"drive_record_id": 75,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 75,
"purpose": "Doloribus hic cum quo."
},
"car": {
"id": 17,
"description": "Et distinctio placeat veritatis."
},
"employee": {
"id": 7,
"first_name": "Prudence",
"last_name": "Bergnaum"
}
},
{
"id": 220,
"drive_record_id": 75,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 75,
"purpose": "Doloribus hic cum quo."
},
"car": {
"id": 17,
"description": "Et distinctio placeat veritatis."
},
"employee": {
"id": 7,
"first_name": "Prudence",
"last_name": "Bergnaum"
}
}
],
"drive_refuels": [
{
"id": 223,
"place": "916 Jacobson Parkways",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 37,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 75,
"purpose": "Doloribus hic cum quo."
},
"car": {
"id": 17,
"description": "Et distinctio placeat veritatis."
},
"employee": {
"id": 7,
"first_name": "Prudence",
"last_name": "Bergnaum"
}
},
{
"id": 224,
"place": "6636 Murphy Mews",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 37,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 75,
"purpose": "Doloribus hic cum quo."
},
"car": {
"id": 17,
"description": "Et distinctio placeat veritatis."
},
"employee": {
"id": 7,
"first_name": "Prudence",
"last_name": "Bergnaum"
}
},
{
"id": 225,
"place": "5033 Brekke Skyway",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 37,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 75,
"purpose": "Doloribus hic cum quo."
},
"car": {
"id": 17,
"description": "Et distinctio placeat veritatis."
},
"employee": {
"id": 7,
"first_name": "Prudence",
"last_name": "Bergnaum"
}
}
]
}List of company's cars
Request
Route
GET api/companies/68/cars
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b7917a207abd5cd87bf93b7abc6e2cf1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ab6983116cacc5477c4dc073274aac20; path=/; expires=Wed, 19 Aug 2020 13:05:00 -0000; HttpOnly
X-Request-Id: 1712cf0b-9b64-4bd4-9d7c-2b16873e270a
X-Runtime: 0.022552
Content-Length: 935Body
[
{
"id": 1,
"number_plate": "02-458-8777",
"description": "Culpa rerum itaque animi.",
"is_private": false,
"average_consumption": "5.0",
"engine_capacity": "30.0",
"initial_tach_value": 123,
"year": null,
"color": null,
"body_number": null,
"default_starting_location": null,
"vin": null,
"car_type": {
"id": 1,
"name": "Jerrell O'Kon"
}
},
{
"id": 2,
"number_plate": "86-890-1866",
"description": "Eveniet explicabo aliquid saepe.",
"is_private": false,
"average_consumption": "5.0",
"engine_capacity": "30.0",
"initial_tach_value": 123,
"year": null,
"color": null,
"body_number": null,
"default_starting_location": null,
"vin": null,
"car_type": {
"id": 1,
"name": "Jerrell O'Kon"
}
},
{
"id": 3,
"number_plate": "31-367-4354",
"description": "Adipisci amet fugit aliquam.",
"is_private": false,
"average_consumption": "5.0",
"engine_capacity": "30.0",
"initial_tach_value": 123,
"year": null,
"color": null,
"body_number": null,
"default_starting_location": null,
"vin": null,
"car_type": {
"id": 1,
"name": "Jerrell O'Kon"
}
}
]List of company's drive expense types
Request
Route
GET api/companies/99/drive_expense_types
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"2a16dd5b5250ae980e5244700ce9199d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=bb170fcb8eda73dcab8a2fe1278fbec1; path=/; expires=Wed, 19 Aug 2020 13:05:16 -0000; HttpOnly
X-Request-Id: 93ddfe7d-8d08-4ef1-805c-b226bfe6c43c
X-Runtime: 0.015464
Content-Length: 72Body
[
{
"id": 1,
"name": "Hotel"
},
{
"id": 2,
"name": "Hotel"
},
{
"id": 3,
"name": "Taxi"
}
]List of company's drive expenses
Parameters
| Name | Description |
|---|---|
| page | Page |
Request
Route
GET api/companies/101/drive_expenses?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"8b25baf2e19f79220c07a893120b2bb1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=44c18cf868365829eec272c6fd44b5df; path=/; expires=Wed, 19 Aug 2020 13:05:16 -0000; HttpOnly
X-Request-Id: dfdf6cab-ffc4-4003-9493-6b8d7719f405
X-Runtime: 0.045611
Content-Length: 5501Body
[
{
"id": 34,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 33,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 32,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 31,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 30,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 29,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 28,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 27,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 26,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 25,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 24,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 23,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 22,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 21,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 20,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 19,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 18,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 17,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 16,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
},
{
"id": 15,
"drive_record_id": 1,
"price": "120.0",
"end_price": "120.0",
"vat_value": "20.0",
"drive_record": {
"id": 1,
"purpose": "Non tempora dolorum autem."
},
"car": {
"id": 13,
"description": "Excepturi esse laboriosam laborum."
},
"employee": {
"id": 3,
"first_name": "Rufus",
"last_name": "Torp"
}
}
]List of company's drive records
Parameters
| Name | Description |
|---|---|
| page | Page |
Request
Route
GET api/companies/105/drive_records?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"50d5d113daced0af0ad2593b1c9f9c05"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=30ce92e8dbc2e9c686d8b2dcc9e45bb0; path=/; expires=Wed, 19 Aug 2020 13:05:18 -0000; HttpOnly
X-Request-Id: e68b5909-8b5f-41f5-9b8a-37276c94a373
X-Runtime: 0.036707
Content-Length: 5930Body
[
{
"id": 34,
"purpose": "Est quis molestias voluptatem.",
"start_location": "6506 Soledad Mews",
"end_location": "1841 Pollich Gateway",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 33,
"purpose": "Reiciendis ea eos sapiente.",
"start_location": "66772 Marquardt Mill",
"end_location": "90514 Gene Spurs",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 32,
"purpose": "Et nihil aut ea.",
"start_location": "2557 Drusilla Circles",
"end_location": "77679 Rippin Drive",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 31,
"purpose": "Qui corrupti tempore excepturi.",
"start_location": "32272 Leisha Square",
"end_location": "190 Tromp Spur",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 30,
"purpose": "Qui numquam ad maiores.",
"start_location": "523 Reichert Wells",
"end_location": "8034 Murray Ports",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 29,
"purpose": "Totam error est aperiam.",
"start_location": "1690 Elisha Way",
"end_location": "1203 Elissa Falls",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 28,
"purpose": "Maiores at qui fuga.",
"start_location": "8401 Carter Mission",
"end_location": "8750 Cole Underpass",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 27,
"purpose": "Quia in magni commodi.",
"start_location": "80652 Judson Lodge",
"end_location": "27920 Stanton Park",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 26,
"purpose": "Harum unde repellat mollitia.",
"start_location": "10486 Huels Overpass",
"end_location": "852 Allen Manor",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 25,
"purpose": "Nihil occaecati quis assumenda.",
"start_location": "9383 Arlinda Expressway",
"end_location": "4538 Ollie Track",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 24,
"purpose": "Voluptatem sed dolor qui.",
"start_location": "6079 Wisoky Canyon",
"end_location": "260 Lina Land",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 23,
"purpose": "Et sapiente minus esse.",
"start_location": "491 Nikolaus Prairie",
"end_location": "840 Rogelio Groves",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 22,
"purpose": "Ut nostrum voluptatibus ut.",
"start_location": "296 Werner Alley",
"end_location": "19983 Emmerich Loop",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 21,
"purpose": "In id officiis molestiae.",
"start_location": "9594 Kathrin Green",
"end_location": "1522 Roseanna Land",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 20,
"purpose": "Earum ad nisi numquam.",
"start_location": "5869 Bergnaum Lane",
"end_location": "473 Stewart Forge",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 19,
"purpose": "Aut labore quis et.",
"start_location": "6592 Renay Court",
"end_location": "631 Ernser Oval",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 18,
"purpose": "Rerum aspernatur sed error.",
"start_location": "816 Billy Meadow",
"end_location": "5461 Welch Wells",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 17,
"purpose": "Eveniet omnis voluptatibus optio.",
"start_location": "98491 Rod Tunnel",
"end_location": "45672 Donovan Ferry",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 16,
"purpose": "Ex accusamus ea voluptate.",
"start_location": "701 Feil Unions",
"end_location": "6610 Crooks Wells",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
},
{
"id": 15,
"purpose": "Beatae quia saepe dolorem.",
"start_location": "4807 Connelly Summit",
"end_location": "75741 Monty Bridge",
"start_tachometer": 0,
"end_tachometer": 500,
"trip_length": 300,
"car": {
"id": 15,
"description": "Iure natus a cumque."
},
"employee": {
"id": 5,
"first_name": "Dayle",
"last_name": "Nienow"
}
}
]List of company's drive refuels
Parameters
| Name | Description |
|---|---|
| page | Page |
Request
Route
GET api/companies/111/drive_refuels?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"a46126850001b73bbc40711d64999b8c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7423f113a7a5d42a513509bbfcbbad40; path=/; expires=Wed, 19 Aug 2020 13:05:22 -0000; HttpOnly
X-Request-Id: a73a0a1d-432a-4391-a12a-c7ab42ec56d2
X-Runtime: 0.067166
Content-Length: 6824Body
[
{
"id": 363,
"place": "79736 Tama Ports",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 362,
"place": "54441 Donnelly Manor",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 361,
"place": "542 Schmidt Ramp",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 360,
"place": "397 Toshia Run",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 359,
"place": "75668 Jose Fields",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 358,
"place": "99770 Kassulke Ridges",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 357,
"place": "355 Danny Land",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 356,
"place": "669 Minda Branch",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 355,
"place": "4036 Laticia Prairie",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 354,
"place": "82169 Lakin Locks",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 353,
"place": "91153 Gusikowski Branch",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 352,
"place": "498 Bryant Mountain",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 351,
"place": "71701 Brendan Estate",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 350,
"place": "1991 Williamson Parkways",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 349,
"place": "380 Emard Road",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 348,
"place": "41166 Chet Shores",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 347,
"place": "96370 Larkin Lakes",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 346,
"place": "272 Hegmann Land",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 345,
"place": "236 Towanda Spring",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
},
{
"id": 344,
"place": "7296 Morissette Freeway",
"amount": "40.0",
"price": "123.0",
"end_price": "123.0",
"vat_id": 38,
"unit_price": 20,
"vat_value": "20.0",
"tachometer_value": 333,
"drive_record": {
"id": 110,
"purpose": "Sapiente aspernatur enim et."
},
"car": {
"id": 18,
"description": "Unde porro eum rem."
},
"employee": {
"id": 8,
"first_name": "Fe",
"last_name": "Windler"
}
}
]Partners
Charts available years
Request
Route
GET api/companies/140/partners/331/partner_charts/available_years
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"91a2461c25439830d94bf4b3d3a3b020"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ab324506de8917f4f81368a186efa669; path=/; expires=Wed, 19 Aug 2020 13:05:28 -0000; HttpOnly
X-Request-Id: e382740b-61d6-4eda-aac8-bd91b8e9fe65
X-Runtime: 0.031233
Content-Length: 6Body
[
2020
]Charts month data for specific year
Parameters
| Name | Description |
|---|---|
| year Required | Year for which you want to get data |
Request
Route
GET api/companies/141/partners/338/partner_charts/series?year=2020
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
year=2020
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"934ba774a72a7ede5646636ca017849a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=2bc13978a031d413783aa3910bc0849d; path=/; expires=Wed, 19 Aug 2020 13:05:29 -0000; HttpOnly
X-Request-Id: f28d11b9-1358-44e0-904c-530c95378a46
X-Runtime: 0.020087
Content-Length: 370Body
[
{
"name": "Faktury přijaté",
"data": [
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0
]
},
{
"name": "Faktury vydané",
"data": [
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0,
1.0
]
},
{
"name": "Doklady příjmové",
"data": [
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0
]
},
{
"name": "Doklady výdajové",
"data": [
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0,
41.0
]
}
]Create a partner
Parameters
| Name | Description |
|---|---|
| partner[name] Required | Partner Name |
| partner[ic] | Partner Ic |
| partner[invoicing_language] Required | languages: ["en", "cs", "es"], default is language by your company |
| partner[dic] | Partner Dic |
| partner[dic2] | Partner Dic2 |
| partner[is_taxable] | Vat payer? |
| partner[is_supplier] | Supplier? |
| partner[is_customer] | Customer? |
| partner[currency_id] Required | currency |
| partner[email] | |
| partner[fax] | Fax |
| partner[phone] | Phone |
| partner[web] | Web |
| partner[paypal] | Paypal |
| partner[reminders] | Reminders |
| partner[paypal] | Paypal |
| partner[invoice_due] | Invoice due |
| partner[address[street]] | Address street |
| partner[address[city]] Required | Address city |
| partner[address[country_id]] Required | Address country_id |
| partner[address[zip]] Required | Address zip |
| partner[postal_address[street]] | Postal Address street |
| partner[postal_address[city]] | Postal Address city |
| partner[postal_address[country_id]] | Postal Address country_id |
| partner[postal_address[zip]] | Postal Address zip |
Request
Route
POST api/companies/134/partners
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"partner": {
"ic": "123456789",
"name": "Graham Leuschke",
"email": "23gregg_keeling@example.com",
"dic": null,
"is_taxable": false,
"is_supplier": false,
"is_customer": true,
"currency_id": 114,
"address_attributes": {
"country_id": 1086,
"city": "Nolanview",
"street": "Carlo Green",
"zip": "52294"
},
"postal_address_attributes": {
"country_id": 1086,
"city": "Nolanview",
"street": "Carlo Green",
"zip": "52294"
}
}
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"242e42c4376914a208dda2e6af64abc6"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7d319222735485c8b29d224ca699bc0d; path=/; expires=Wed, 19 Aug 2020 13:05:26 -0000; HttpOnly
X-Request-Id: 8cdf7d17-f544-43a5-92e4-cf2020f9894d
X-Runtime: 0.022292
Content-Length: 644Body
{
"id": 291,
"name": "Graham Leuschke",
"ic": "123456789",
"dic": null,
"dic2": null,
"is_customer": true,
"is_supplier": false,
"phone": null,
"fax": null,
"email": "23gregg_keeling@example.com",
"web": null,
"paypal": null,
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"reminders": false,
"address": {
"street": "Carlo Green",
"city": "Nolanview",
"country_id": 1086,
"zip": "52294",
"country": {
"id": 1086,
"name": null
}
},
"postal_address": {
"street": "Carlo Green",
"city": "Nolanview",
"country_id": 1086,
"zip": "52294"
},
"contacts": [
],
"bank_accounts": [
],
"currency_id": 114,
"currency": {
"id": 114,
"iso_code": "GBP",
"name": "Pound sterling",
"symbol": "£",
"symbol_first": true
}
}Create a partner by ARES
Parameters
| Name | Description |
|---|---|
| ic Required | Partner Ic |
Request
Route
POST api/companies/137/partners/create_by_ares/24704440
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"68192a7accfe6a4baede67352c14560d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=c881468b6926369fbb4e5327b517f75c; path=/; expires=Wed, 19 Aug 2020 13:05:27 -0000; HttpOnly
X-Request-Id: 09c4c291-0bab-4add-ba57-ef678713e6de
X-Runtime: 0.023114
Content-Length: 569Body
{
"id": 314,
"name": "Railsformers s.r.o.",
"ic": "24704440",
"dic": "CZ24704440",
"dic2": null,
"is_customer": true,
"is_supplier": true,
"phone": null,
"fax": null,
"email": null,
"web": null,
"paypal": null,
"is_taxable": true,
"invoicing_language": "cs",
"invoice_due": null,
"reminders": false,
"address": {
"street": "Technologická 372/2",
"city": "Ostrava - Pustkovec",
"country_id": 1096,
"zip": "70800",
"country": {
"id": 1096,
"name": "Česká Republika"
}
},
"contacts": [
],
"bank_accounts": [
],
"currency_id": 117,
"currency": {
"id": 117,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
}
}Create a partner by ARES end with error
Parameters
| Name | Description |
|---|---|
| ic Required | Partner Ic |
Request
Route
POST api/companies/135/partners/create_by_ares/24704440
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
}Response
Status
422Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: your_session_key=ec0603e7ab7b8742f390fa9127f11e4e; path=/; expires=Wed, 19 Aug 2020 13:05:27 -0000; HttpOnly
X-Request-Id: 285c4c35-a421-4283-a7c5-2f466f71fcb4
X-Runtime: 0.019501
Content-Length: 21Body
{
"errors": "[\"ic\"]"
}Delete a partner
Request
Route
DELETE api/companies/139/partners/324
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
204Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Cache-Control: no-cache
Set-Cookie: your_session_key=d910804e098446d4c25f80f976088844; path=/; expires=Wed, 19 Aug 2020 13:05:27 -0000; HttpOnly
X-Request-Id: 61762197-db2e-4aba-9951-1fd6ad33324e
X-Runtime: 0.025147Detail of a partner
Request
Route
GET api/companies/133/partners/279
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b8fda247d9c3325bdc66899870b4e260"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=37e3eb59ebead2c9c0f24d74be2a857f; path=/; expires=Wed, 19 Aug 2020 13:05:26 -0000; HttpOnly
X-Request-Id: 503e2125-6145-4e86-ad33-21648ee47098
X-Runtime: 0.033934
Content-Length: 551Body
{
"id": 279,
"name": "Shanel Carter V",
"ic": null,
"dic": null,
"dic2": null,
"is_customer": true,
"is_supplier": false,
"phone": null,
"fax": null,
"email": "13bonny.mosciski@example.net",
"web": null,
"paypal": null,
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"reminders": false,
"address": {
"street": "Maggio Corners",
"city": "Kihnland",
"country_id": 1084,
"zip": "58359-0838",
"country": {
"id": 1084,
"name": null
}
},
"contacts": [
],
"bank_accounts": [
],
"currency_id": 113,
"currency": {
"id": 113,
"iso_code": "CZK",
"name": "Czech crown",
"symbol": "Kč",
"symbol_first": false
}
}List of partners
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
| q[name_or_ic_or_dic_or_address_street_or_address_city_cont] | Search by fields |
Request
Route
GET api/companies/131/partners?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"2911e13c3d767628892aa217bc034706"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1c1ae28024a068a41f3e7bb980b5857f; path=/; expires=Wed, 19 Aug 2020 13:05:26 -0000; HttpOnly
X-Request-Id: b62e3901-e9ac-4ce4-93b3-31c24fb425ac
X-Runtime: 0.036226
Content-Length: 2466Body
[
{
"id": 263,
"name": "Drobný nákup",
"ic": null,
"dic": null,
"is_customer": false,
"is_supplier": true,
"email": null,
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"currency": {
"id": 111,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
}
},
{
"id": 264,
"name": "Drobný prodej",
"ic": null,
"dic": null,
"is_customer": true,
"is_supplier": false,
"email": null,
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"currency": {
"id": 111,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
}
},
{
"id": 265,
"name": "Abdul Raynor",
"ic": null,
"dic": null,
"is_customer": true,
"is_supplier": false,
"email": "3maricruz.mitchell@example.com",
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"address": {
"street": "Evalyn Highway",
"city": "O'Connellport",
"city_part": null,
"zip": "63881-0682"
},
"currency": {
"id": 111,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
}
},
{
"id": 266,
"name": "Korey Wyman",
"ic": null,
"dic": null,
"is_customer": true,
"is_supplier": false,
"email": "4caleb_considine@example.com",
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"address": {
"street": "Luke Mountain",
"city": "New Lonaside",
"city_part": null,
"zip": "90500"
},
"currency": {
"id": 111,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
}
},
{
"id": 267,
"name": "Rhett Hammes II",
"ic": null,
"dic": null,
"is_customer": true,
"is_supplier": false,
"email": "5audria@example.net",
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"address": {
"street": "Virgilio Station",
"city": "Franklinfort",
"city_part": null,
"zip": "39656-1067"
},
"currency": {
"id": 111,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
}
},
{
"id": 268,
"name": "Jimmie Johnston IV",
"ic": null,
"dic": null,
"is_customer": true,
"is_supplier": false,
"email": "6tawna@example.org",
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"address": {
"street": "Roselia Neck",
"city": "Abshirechester",
"city_part": null,
"zip": "75900"
},
"currency": {
"id": 111,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
}
},
{
"id": 269,
"name": "Nyla Mertz",
"ic": null,
"dic": null,
"is_customer": true,
"is_supplier": false,
"email": "7sima_mccullough@example.net",
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"address": {
"street": "Haag Locks",
"city": "East Wilburnmouth",
"city_part": null,
"zip": "49542-2334"
},
"currency": {
"id": 111,
"iso_code": "PLN",
"name": "Polish zloty",
"symbol": "zł",
"symbol_first": false
}
}
]Search of partners
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
| q[name_or_ic_or_dic_or_address_street_or_address_city_cont] | Search by fields |
Request
Route
GET api/companies/132/partners?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E&q%5Bname_or_ic_or_dic_or_address_street_or_address_city_cont%5D=Kimiko+Bahringer+MD
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
q={"name_or_ic_or_dic_or_address_street_or_address_city_cont"=>"Kimiko Bahringer MD"}
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b9e48d14079f916b3622cbd8e342e2e6"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=23cefdd5ec9924e35d89d84995727641; path=/; expires=Wed, 19 Aug 2020 13:05:26 -0000; HttpOnly
X-Request-Id: c59afc41-aa48-4852-b927-0067de846a91
X-Runtime: 0.010073
Content-Length: 390Body
[
{
"id": 276,
"name": "Kimiko Bahringer MD",
"ic": null,
"dic": null,
"is_customer": true,
"is_supplier": false,
"email": "12monica.dubuque@example.com",
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"address": {
"street": "Kuhn Park",
"city": "Strosinport",
"city_part": null,
"zip": "95688-0691"
},
"currency": {
"id": 112,
"iso_code": "CZK",
"name": "Czech crown",
"symbol": "Kč",
"symbol_first": false
}
}
]Update a partner
Parameters
| Name | Description |
|---|---|
| partner[name] | Partner Name |
| partner[ic] | Partner Ic |
| partner[invoicing_language] | languages: ["en", "cs", "es"], default is language by your company |
| partner[dic] | Partner Dic |
| partner[dic2] | Partner Dic2 |
| partner[is_taxable] | Vat payer? |
| partner[is_supplier] | Supplier? |
| partner[is_customer] | Customer? |
| partner[currency_id] | currency |
| partner[email] | |
| partner[fax] | Fax |
| partner[phone] | Phone |
| partner[web] | Web |
| partner[paypal] | Paypal |
| partner[reminders] | Reminders |
| partner[paypal] | Paypal |
| partner[invoice_due] | Invoice due |
| partner[address[street]] | Address street |
| partner[address[city]] | Address city |
| partner[address[country_id]] | Address country_id |
| partner[address[zip]] | Address zip |
| partner[postal_address[street]] | Postal Address street |
| partner[postal_address[city]] | Postal Address city |
| partner[postal_address[country_id]] | Postal Address country_id |
| partner[postal_address[zip]] | Postal Address zip |
Request
Route
PATCH api/companies/138/partners/317
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Body
{
"partner": {
"ic": "123456789",
"name": "Aaron Stokes",
"email": "44devin@example.org",
"dic": null,
"is_taxable": false,
"is_supplier": false,
"is_customer": true,
"currency_id": 118,
"address_attributes": {
"country_id": 1097,
"city": "Hartmannchester",
"street": "Dooley Extension",
"zip": "96820"
}
}
}Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"73ec765404b17bc201c7df3ebd3a0da5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7a931ab171972bf6591ae7b4d6e946a3; path=/; expires=Wed, 19 Aug 2020 13:05:27 -0000; HttpOnly
X-Request-Id: e6e032d0-83ae-4b2a-8571-56e6a674f469
X-Runtime: 0.028725
Content-Length: 556Body
{
"id": 317,
"name": "Aaron Stokes",
"ic": "123456789",
"dic": null,
"dic2": null,
"is_customer": true,
"is_supplier": false,
"phone": null,
"fax": null,
"email": "44devin@example.org",
"web": null,
"paypal": null,
"is_taxable": false,
"invoicing_language": "cs",
"invoice_due": null,
"reminders": false,
"address": {
"street": "Dooley Extension",
"city": "Hartmannchester",
"country_id": 1097,
"zip": "96820",
"country": {
"id": 1097,
"name": null
}
},
"contacts": [
],
"bank_accounts": [
],
"currency_id": 118,
"currency": {
"id": 118,
"iso_code": "USD",
"name": "United states dollar",
"symbol": "$",
"symbol_first": true
}
}Payment Types
List of company's payment types
Request
Route
GET api/companies/143/payment_types
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"b4efd9bfd2955c544cc9d10e9cd276dd"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9973d5d3191e6b1c047dc6e04bc615ad; path=/; expires=Wed, 19 Aug 2020 13:05:30 -0000; HttpOnly
X-Request-Id: e1a5fe2f-7707-463e-9857-5750c10635bc
X-Runtime: 0.013530
Content-Length: 139Body
[
{
"id": 41,
"name": "Reagan Steuber V"
},
{
"id": 42,
"name": "Norine Bergnaum"
},
{
"id": 43,
"name": "Barry Stamm"
},
{
"id": 44,
"name": "Kamilah Kassulke"
}
]Scans
Company's processed scan
Request
Route
GET api/companies/153/scans/00000000-0000-0000-0000-000000000119
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"2fccb0d5b8406d33634e3a75f20e954d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=19b98c50673e8c1894257f7323a3ca91; path=/; expires=Wed, 19 Aug 2020 13:05:56 -0000; HttpOnly
X-Request-Id: db0097e3-6464-4b2d-91c8-cdc0ea97a061
X-Runtime: 0.009767
Content-Length: 777Body
{
"id": "00000000-0000-0000-0000-000000000119",
"size": 95,
"content_type": "text/plain",
"state": "Zpracovaná",
"state_id": 3,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null,
"total_price": "1000.0",
"partner_name": "Dickinson, Torphy and Greenfelder",
"partner_ic": "21-212-3698",
"partner_dic": "CZ52-450-4238",
"partner_street": "Freeman Walk",
"partner_city": "Eldonton",
"partner_zip": "61015",
"partner_country_id": 1,
"company_name": "Tromp-Corkery",
"company_ic": "54-161-8057",
"company_dic": "CZ10-816-7430",
"company_street": "Dickens Fork",
"company_city": "Buffytown",
"company_zip": "34415-9652",
"company_country_id": 1,
"payment_type": "checkout",
"variable_symbol": "123456789",
"currency_id": "1",
"due_date_at": "29. 08. 2020",
"issue_date_at": "19. 08. 2020",
"uzp_date_at": "19. 08. 2020"
}Company's scan
Request
Route
GET api/companies/152/scans/00000000-0000-0000-0000-000000000113
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"00bc702e059e8dcfe446c07ac4e9ce0d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=4e5359798e991fd835bd0c7e5f27bd7c; path=/; expires=Wed, 19 Aug 2020 13:05:53 -0000; HttpOnly
X-Request-Id: 14a2b512-9e3c-4577-a23a-4c768dfc8f25
X-Runtime: 0.011376
Content-Length: 608Body
{
"id": "00000000-0000-0000-0000-000000000113",
"size": 95,
"content_type": "text/plain",
"state": "Nahraná",
"state_id": 1,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null,
"total_price": null,
"partner_name": null,
"partner_ic": null,
"partner_dic": null,
"partner_street": null,
"partner_city": null,
"partner_zip": null,
"partner_country_id": null,
"company_name": null,
"company_ic": null,
"company_dic": null,
"company_street": null,
"company_city": null,
"company_zip": null,
"company_country_id": null,
"payment_type": null,
"variable_symbol": null,
"currency_id": null,
"due_date_at": null,
"issue_date_at": null,
"uzp_date_at": null
}Creating company's scan
Parameters
| Name | Description |
|---|---|
| attachment Required | Scaned file |
Request
Route
POST api/companies/154/scans
Headers
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Auth-Token: auth_token
Host: example.org
Cookie: Body
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="scan[attachment]"; filename="rails.png"
Content-Type: text/plain
Content-Length: 13706
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"af3e0522d8dceda8a92f3817e2e217d7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7a48207ddd064df9b1b2207c1bd3c5c7; path=/; expires=Wed, 19 Aug 2020 13:05:58 -0000; HttpOnly
X-Request-Id: baa19db1-a031-4ed7-8bb2-b480f6769534
X-Runtime: 0.783356
Content-Length: 611Body
{
"id": "252a486f-0c43-47f7-bbd1-e407f19201df",
"size": 13706,
"content_type": "text/plain",
"state": "Nahraná",
"state_id": 1,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null,
"total_price": null,
"partner_name": null,
"partner_ic": null,
"partner_dic": null,
"partner_street": null,
"partner_city": null,
"partner_zip": null,
"partner_country_id": null,
"company_name": null,
"company_ic": null,
"company_dic": null,
"company_street": null,
"company_city": null,
"company_zip": null,
"company_country_id": null,
"payment_type": null,
"variable_symbol": null,
"currency_id": null,
"due_date_at": null,
"issue_date_at": null,
"uzp_date_at": null
}Get version of scan data
Parameters
| Name | Description |
|---|---|
| version | version of image ['thumb', 'hd', 'fullhd'] |
Request
Route
GET api/companies/156/scans/00000000-0000-0000-0000-000000000129/data?version=thumb
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
version=thumb
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: text/plain
Content-Disposition: attachment; filename="thumb_empty2.png"
Content-Transfer-Encoding: binary
Cache-Control: private
Set-Cookie: your_session_key=ae6251a0e5db81504004c04ea81aadf7; path=/; expires=Wed, 19 Aug 2020 13:06:02 -0000; HttpOnly
X-Request-Id: 586a7f85-1ce9-439a-b494-64c789bd2c10
X-Runtime: 0.007598
Content-Length: 296Body
[binary data]List of company's processed scans
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
Request
Route
GET api/companies/150/scans/processed?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"1cbb3d24e8bacf0c0c721cb7c453edff"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=73580d646bb8e321057770401766b36a; path=/; expires=Wed, 19 Aug 2020 13:05:48 -0000; HttpOnly
X-Request-Id: 18f2712a-09ed-4efd-8044-73287a72777b
X-Runtime: 0.009000
Content-Length: 553Body
[
{
"id": "00000000-0000-0000-0000-000000000106",
"size": 95,
"content_type": "text/plain",
"state": "Zpracovaná",
"state_id": 3,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
},
{
"id": "00000000-0000-0000-0000-000000000105",
"size": 95,
"content_type": "text/plain",
"state": "Zpracovaná",
"state_id": 3,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
},
{
"id": "00000000-0000-0000-0000-000000000104",
"size": 95,
"content_type": "text/plain",
"state": "Zpracovaná",
"state_id": 3,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
}
]List of company's processing scans
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
Request
Route
GET api/companies/148/scans/processing?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"a5a953b7faf7d64fad467aa39a3b31e6"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=8f528e2d411615474773f23af5e4b277; path=/; expires=Wed, 19 Aug 2020 13:05:41 -0000; HttpOnly
X-Request-Id: 4e29265b-56b3-4e22-961f-1c5428d43921
X-Runtime: 0.011274
Content-Length: 565Body
[
{
"id": "00000000-0000-0000-0000-000000000094",
"size": 95,
"content_type": "text/plain",
"state": "Ve zpracování",
"state_id": 2,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
},
{
"id": "00000000-0000-0000-0000-000000000093",
"size": 95,
"content_type": "text/plain",
"state": "Ve zpracování",
"state_id": 2,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
},
{
"id": "00000000-0000-0000-0000-000000000092",
"size": 95,
"content_type": "text/plain",
"state": "Ve zpracování",
"state_id": 2,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
}
]List of company's scans
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
Request
Route
GET api/companies/144/scans?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"e7eabc3cacf238dbc26348f3a5012cdc"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=548a21332b1456e0c2cd41e5541dcd3d; path=/; expires=Wed, 19 Aug 2020 13:05:32 -0000; HttpOnly
X-Request-Id: 0a4217b7-0e5b-4c01-b58b-e1ae7bbfb9a3
X-Runtime: 0.015383
Content-Length: 544Body
[
{
"id": "00000000-0000-0000-0000-000000000077",
"size": 95,
"content_type": "text/plain",
"state": "Nahraná",
"state_id": 1,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
},
{
"id": "00000000-0000-0000-0000-000000000078",
"size": 95,
"content_type": "text/plain",
"state": "Nahraná",
"state_id": 1,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
},
{
"id": "00000000-0000-0000-0000-000000000079",
"size": 95,
"content_type": "text/plain",
"state": "Nahraná",
"state_id": 1,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
}
]List of company's unprocessed scans
Parameters
| Name | Description |
|---|---|
| page | Page |
| limit | Per page |
Request
Route
GET api/companies/146/scans/unprocessed?page=%23%3CCapybara%3A%3ASession%3A0x0000561ce5c3d478%3E
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Query Parameters
page=#<Capybara::Session:0x0000561ce5c3d478>
Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"dbe7379978123517d0eb0f2e85a2d647"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1167a06fe51d80dffb14d8680905615d; path=/; expires=Wed, 19 Aug 2020 13:05:36 -0000; HttpOnly
X-Request-Id: 6615a51d-90bf-4435-afbc-ad3d0a85fe7a
X-Runtime: 0.011427
Content-Length: 544Body
[
{
"id": "00000000-0000-0000-0000-000000000085",
"size": 95,
"content_type": "text/plain",
"state": "Nahraná",
"state_id": 1,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
},
{
"id": "00000000-0000-0000-0000-000000000084",
"size": 95,
"content_type": "text/plain",
"state": "Nahraná",
"state_id": 1,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
},
{
"id": "00000000-0000-0000-0000-000000000083",
"size": 95,
"content_type": "text/plain",
"state": "Nahraná",
"state_id": 1,
"created_at": "St 19. srpen 2020 13:05 +0200",
"actuarial_id": null
}
]Sessions
Get user authentication token
Parameters
| Name | Description |
|---|---|
| email Required | |
| password Required | Password |
Request
Route
POST api/sessions/create
Headers
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: Body
email=test%40test.com&password=passwordResponse
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"bf183d7d089b14c315c76e7108b1a8d2"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 9778df9c-64b2-48ec-b565-4d345d764a42
X-Runtime: 0.068283
Content-Length: 71Body
{
"email": "test@test.com",
"authentication_token": "4yHT_KtL4DfXtV9SDov9"
}System informations
List of system informations
Request
Route
GET api/companies/157/system_informations
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"ffbdcae5d57652cffa55373a694e511c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=66c13094c4b7014b1021ad85991d8d95; path=/; expires=Wed, 19 Aug 2020 13:06:03 -0000; HttpOnly
X-Request-Id: 50064348-d552-449c-b218-ffb5ab0a25f0
X-Runtime: 0.017418
Content-Length: 298Body
[
{
"id": 4,
"title": "Jacinta Lang",
"created_at": "19. 08. 2020",
"description": "numquam",
"image": null
},
{
"id": 3,
"title": "Sadie Torphy",
"created_at": "19. 08. 2020",
"description": "error",
"image": null
},
{
"id": 2,
"title": "Madeline Bergnaum IV",
"created_at": "19. 08. 2020",
"description": "debitis",
"image": null
}
]Units
List of units
Request
Route
GET api/units
Headers
Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"6915d1a8b795cba8efeb931b5259fcf3"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=c5a55813e8974cfc90c9d11b5ed1c6de; path=/; expires=Wed, 19 Aug 2020 13:06:03 -0000; HttpOnly
X-Request-Id: 1f653a82-d699-4e03-ba6e-d13be007770e
X-Runtime: 0.015024
Content-Length: 89Body
[
{
"id": 1,
"name": "s",
"description": "sekunda"
},
{
"id": 2,
"name": "s",
"description": "sekunda"
}
]Users
Login user with apple
Parameters
| Name | Description | Type |
|---|---|---|
| email Required | user email | string |
| token Required | token for authentication | string |
Request
Route
POST api/users/auth/apple
Headers
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: Body
email=test%40test.com&token=1234Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"88669cc46f4be81805fcaf2f0c653c6b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: cd20bb8a-8868-47ef-a66d-61dc50e24efc
X-Runtime: 0.005700
Content-Length: 71Body
{
"email": "test@test.com",
"authentication_token": "rPTXrthzsr3Dqy_ZRc1c"
}Login user with facebook
Parameters
| Name | Description | Type |
|---|---|---|
| email Required | user email | string |
| token Required | token for authentication | string |
Request
Route
POST api/users/auth/facebook
Headers
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: Body
email=test%40test.com&token=1234Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"49786707c11e2f96c2e6f9cfcbb340b6"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 9852ef1d-99ed-443f-ab71-b525e2e0b831
X-Runtime: 0.183917
Content-Length: 71Body
{
"email": "test@test.com",
"authentication_token": "53Jx1xsPCiCwc7oPkUBQ"
}Login user with google_oauth2
Parameters
| Name | Description | Type |
|---|---|---|
| email Required | user email | string |
| token Required | token for authentication | string |
Request
Route
POST api/users/auth/google_oauth2
Headers
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: Body
email=test%40test.com&token=1234Response
Status
200Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Accept: application/vnd-revisions-v1
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization, Auth-Token
Content-Type: application/json; charset=utf-8
ETag: W/"20778903d81cc72ef7943a8c423e46d8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 376d4478-a600-4a54-8a57-9421a49e2be9
X-Runtime: 0.145882
Content-Length: 71Body
{
"email": "test@test.com",
"authentication_token": "riRZH4Fif8tHRftZ3Uxi"
}