sÚčto API Documentation

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

200

Headers

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=8360d2375d90505254bf71a7763bbf08; path=/; expires=Wed, 18 Dec 2019 12:53:01 -0000; HttpOnly
X-Request-Id: 80739bd9-f5fe-4f1e-ab65-16a465edc584
X-Runtime: 0.177002
Content-Length: 802

Body

{
  "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

200

Headers

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=63172b606cde978e88f6736f7a639b9f; path=/; expires=Wed, 18 Dec 2019 12:53:02 -0000; HttpOnly
X-Request-Id: 364fd576-37f4-42c4-a40b-f23300bc8ade
X-Runtime: 0.010181
Content-Length: 2

Body

[

]

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

200

Headers

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=f587e8f0d037d347e45b9eab43b628b7; path=/; expires=Wed, 18 Dec 2019 12:53:02 -0000; HttpOnly
X-Request-Id: 8fb0ce67-7972-4c95-8599-0e6b11ad950d
X-Runtime: 0.015609
Content-Length: 168

Body

[
  [
    "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

200

Headers

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=3ae8bf4975c8c57ac0bfce0f223fc1b5; path=/; expires=Wed, 18 Dec 2019 12:53:02 -0000; HttpOnly
X-Request-Id: 6071ed60-817d-4d3c-9d37-5d820ef34859
X-Runtime: 0.009143
Content-Length: 6

Body

[
  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

200

Headers

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/"d9db8b3f645cf345d4a0a48bb8fc098d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=3e65eaca9866eb949f4c7d6542b4f346; path=/; expires=Wed, 18 Dec 2019 12:53:03 -0000; HttpOnly
X-Request-Id: 755b2685-6c56-4f3e-85b5-4ecf899daa40
X-Runtime: 0.009657
Content-Length: 198

Body

[
  {
    "total": 20,
    "account_code": "526",
    "account_name": "Malinda Hagenes"
  },
  {
    "total": 20,
    "account_code": "527",
    "account_name": "Jewel Bauch"
  },
  {
    "total": 20,
    "account_code": "625",
    "account_name": "Ahmad Powlowski"
  }
]

List of accounting diaries chart components

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/7/accounting_diaries/report_components

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Response

Status

200

Headers

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/"df0d433731997f2371c3ca5a443f2232"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=30aa60dac65f59e27b4e37c358a05d9c; path=/; expires=Wed, 18 Dec 2019 12:53:02 -0000; HttpOnly
X-Request-Id: 98ad2011-85f1-413d-a58c-bd9604372e4b
X-Runtime: 0.012879
Content-Length: 70

Body

[
  {
    "total": 20,
    "month": 3
  },
  {
    "total": 20,
    "month": 6
  },
  {
    "total": 20,
    "month": 7
  }
]

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

200

Headers

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/"956a6cecd03aa700c3e925a67cea1562"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=5d84c9a8f0bebd23f886280f278a633b; path=/; expires=Wed, 18 Dec 2019 12:53:02 -0000; HttpOnly
X-Request-Id: 08e37af0-f1ae-458c-bf15-cf62903a25b6
X-Runtime: 0.009763
Content-Length: 46

Body

[
  {
    "total": 20,
    "month": 1
  },
  {
    "total": 0,
    "month": 4
  }
]

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

200

Headers

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=713d392d78887b7f6c733ede51b004ab; path=/; expires=Wed, 18 Dec 2019 12:53:02 -0000; HttpOnly
X-Request-Id: 8e2dcc79-6ff6-452b-b055-d8a95e665b0d
X-Runtime: 0.010919
Content-Length: 802

Body

{
  "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=4

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

q={"month_eq"=>"4"}

Response

Status

200

Headers

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=4f374da1acbe93decd26cb3f1c840f30; path=/; expires=Wed, 18 Dec 2019 12:53:01 -0000; HttpOnly
X-Request-Id: 07286314-a3c5-416c-809f-0a7b4c0759ef
X-Runtime: 0.009480
Content-Length: 802

Body

{
  "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"}

Request

Route

GET api/companies/10/accounts?page=%23%3CCapybara%3A%3ASession%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"4fc691ba3ccaaa9e6497848e257e6a9f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fbd1febd87290894cde4f4aaed0e235d; path=/; expires=Wed, 18 Dec 2019 12:53:03 -0000; HttpOnly
X-Request-Id: 67e9fd42-1a35-4cd6-80c0-8aa7b5e8b196
X-Runtime: 0.024861
Content-Length: 3128

Body

[
  {
    "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": "2019-12-18T11:53:03.000+01:00",
      "updated_at": "2019-12-18T11:53:03.000+01:00",
      "bank_code": "1111",
      "bankable_id": 10,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 21,
    "name": "Abel Denesik",
    "identifier": null,
    "account_type": 2,
    "currency_id": 19,
    "country_id": 28,
    "prefix": "enim",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 10,
      "country_id": 28,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2019-12-18T11:53:03.000+01:00",
      "updated_at": "2019-12-18T11:53:03.000+01:00",
      "bank_code": "1111",
      "bankable_id": 10,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 22,
    "name": "Agustin Gleichner",
    "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": "2019-12-18T11:53:03.000+01:00",
      "updated_at": "2019-12-18T11:53:03.000+01:00",
      "bank_code": "1111",
      "bankable_id": 10,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 23,
    "name": "Chance Tromp",
    "identifier": null,
    "account_type": 2,
    "currency_id": 19,
    "country_id": 28,
    "prefix": "amet",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 10,
      "country_id": 28,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2019-12-18T11:53:03.000+01:00",
      "updated_at": "2019-12-18T11:53:03.000+01:00",
      "bank_code": "1111",
      "bankable_id": 10,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 24,
    "name": "Walker Ritchie II",
    "identifier": null,
    "account_type": 2,
    "currency_id": 19,
    "country_id": 28,
    "prefix": "aliquid",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 10,
      "country_id": 28,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2019-12-18T11:53:03.000+01:00",
      "updated_at": "2019-12-18T11:53:03.000+01:00",
      "bank_code": "1111",
      "bankable_id": 10,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 25,
    "name": "Jenna Bernier",
    "identifier": null,
    "account_type": 2,
    "currency_id": 19,
    "country_id": 28,
    "prefix": "provident",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 10,
      "country_id": 28,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2019-12-18T11:53:03.000+01:00",
      "updated_at": "2019-12-18T11:53:03.000+01: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"}

Request

Route

GET api/companies/11/accounts?page=%23%3CCapybara%3A%3ASession%3A0x0000560d122b0ca8%3E&q%5Bname_or_identifier_cont%5D=Keith+Satterfield

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>
q={"name_or_identifier_cont"=>"Keith Satterfield"}

Response

Status

200

Headers

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/"93f50a6e20d7989cc5bba4a8c6ab03d5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=a40a79814b70ea0bb4f9028b737c671d; path=/; expires=Wed, 18 Dec 2019 12:53:03 -0000; HttpOnly
X-Request-Id: 68571605-de9b-438f-a77e-f8ea027ba4e7
X-Runtime: 0.004980
Content-Length: 460

Body

[
  {
    "id": 32,
    "name": "Keith Satterfield",
    "identifier": null,
    "account_type": 2,
    "currency_id": 20,
    "country_id": 30,
    "prefix": "modi",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 11,
      "country_id": 30,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2019-12-18T11:53:03.000+01:00",
      "updated_at": "2019-12-18T11:53:03.000+01: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

200

Headers

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=4997614a2c09c091eeaa13b61f7a3a71; path=/; expires=Wed, 18 Dec 2019 12:53:03 -0000; HttpOnly
X-Request-Id: 72568b49-bfda-4e83-a11b-b544cb49ba6d
X-Runtime: 0.007618
Content-Length: 91

Body

[
  {
    "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

200

Headers

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/"27bebb21a6e355381b9aa29be850c456"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=516b76ba429210be74b45ae408b9fa76; path=/; expires=Wed, 18 Dec 2019 12:53:07 -0000; HttpOnly
X-Request-Id: af82f90d-938f-41e5-ad2d-8883f2fb98de
X-Runtime: 0.010091
Content-Length: 1138

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": null,
  "uzp_date_at": "18. 12. 2019",
  "due_date_at": "28. 12. 2019",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "18. 12. 2019",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "currency": {
    "id": 26,
    "iso_code": "PLN",
    "name": "Polish zloty",
    "symbol": "zł",
    "symbol_first": false
  },
  "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": "2019-12-18T11:53:07.000+01:00",
      "updated_at": "2019-12-18T11:53:07.000+01: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

200

Headers

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/"7433f7852ad5d0597894de301515a729"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b287f9102ab2565dea1e1edb48cbfdc0; path=/; expires=Wed, 18 Dec 2019 12:53:08 -0000; HttpOnly
X-Request-Id: b6316e5e-bd65-47c8-9be8-a5465776edc1
X-Runtime: 0.024285
Content-Length: 1320

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": null,
  "uzp_date_at": "18. 12. 2019",
  "due_date_at": "28. 12. 2019",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "18. 12. 2019",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "currency": {
    "id": 27,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  },
  "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": "Bins-Runolfsdottir",
    "ic": "24",
    "dic": "CZ76-663-7009",
    "dic2": null,
    "street": "Macejkovic Roads",
    "city": "Jimmieborough",
    "zip": "24802-2901",
    "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

400

Headers

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=72dbd1fa63d4cd6b68e7300a416022fb; path=/; expires=Wed, 18 Dec 2019 12:53:09 -0000; HttpOnly
X-Request-Id: b2b5cdea-17ea-48c1-88ba-d32db8c5c5cb
X-Runtime: 0.006953
Content-Length: 95

Body

{
  "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

200

Headers

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/"243863d55c0515aaeeec9a757cabebdb"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7d45c3ee56cb75453be6d7839fe93332; path=/; expires=Wed, 18 Dec 2019 12:53:06 -0000; HttpOnly
X-Request-Id: f5c354ef-4376-4cfb-91cc-dfc6ad528d96
X-Runtime: 0.017555
Content-Length: 1295

Body

{
  "id": 142,
  "actuarial_type": "FA",
  "actuarial_number": "FV 142",
  "uzp_date_at": "18. 12. 2019",
  "due_date_at": "18. 12. 2019",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "18. 12. 2019",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "currency": {
    "id": 25,
    "iso_code": "USD",
    "name": "United states dollar",
    "symbol": "$",
    "symbol_first": true
  },
  "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": "Kristopher Schulist",
      "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-01-01",
  "account_id": 65,
  "currency_id": 29,
  "actuarial_number": "2015000001",
  "lines": [
    {
      "vat_id": 9,
      "lineable_type": "Actuarial",
      "name": "Kent Herzog DVM",
      "quantity": 1,
      "unit_price": 200,
      "base_price": 200,
      "tax": 20,
      "total_price": 220,
      "unit_name": "h"
    }
  ]
}

Response

Status

200

Headers

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/"fe80e736f892cd0e81d2dc9a9da4ee84"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b4b02e9971e79514ee2d9b2d6bba15f4; path=/; expires=Wed, 18 Dec 2019 12:53:10 -0000; HttpOnly
X-Request-Id: 0577c94e-26de-4fd5-b36f-79d4157f7ad2
X-Runtime: 0.028995
Content-Length: 1324

Body

{
  "id": 312,
  "actuarial_type": "FA",
  "actuarial_number": "2015000001",
  "uzp_date_at": "18. 12. 2019",
  "due_date_at": "01. 01. 2020",
  "status": "Připravený",
  "status_id": 2,
  "issue_date_at": "18. 12. 2019",
  "base_price": "200.0",
  "end_price": "200.0",
  "remaining": "200.0",
  "currency": {
    "id": 29,
    "iso_code": "GBP",
    "name": "Pound sterling",
    "symbol": "£",
    "symbol_first": true
  },
  "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": "Yer Bashirian",
    "ic": null,
    "dic": null,
    "dic2": null,
    "street": "Christoper Burgs",
    "city": "Greenshire",
    "zip": "48119",
    "is_taxable": false,
    "country_id": 56
  },
  "items": [
    {
      "id": 312,
      "quantity": "1.0",
      "unit_name": "h",
      "name": "Kent Herzog DVM",
      "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"b450bb3c34947c2f7a2d0173634067c8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=34bf1bbb45f018b32a13d0611a54d45a; path=/; expires=Wed, 18 Dec 2019 12:53:04 -0000; HttpOnly
X-Request-Id: c0a01832-6240-4ea6-be74-7114bb801801
X-Runtime: 0.070324
Content-Length: 8335

Body

[
  {
    "id": 35,
    "actuarial_type": "FA",
    "actuarial_number": "FV 35",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2020",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "0.0",
    "end_price": "0.0",
    "remaining": "0.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 29,
    "actuarial_type": "FA",
    "actuarial_number": "FV 29",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 28,
    "actuarial_type": "FA",
    "actuarial_number": "FV 28",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 27,
    "actuarial_type": "FA",
    "actuarial_number": "FV 27",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 26,
    "actuarial_type": "FA",
    "actuarial_number": "FV 26",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 25,
    "actuarial_type": "FA",
    "actuarial_number": "FV 25",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 24,
    "actuarial_type": "FA",
    "actuarial_number": "FV 24",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 23,
    "actuarial_type": "FA",
    "actuarial_number": "FV 23",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 22,
    "actuarial_type": "FA",
    "actuarial_number": "FV 22",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 21,
    "actuarial_type": "FA",
    "actuarial_number": "FV 21",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 20,
    "actuarial_type": "FA",
    "actuarial_number": "FV 20",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 19,
    "actuarial_type": "FA",
    "actuarial_number": "FV 19",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 18,
    "actuarial_type": "FA",
    "actuarial_number": "FV 18",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 17,
    "actuarial_type": "FA",
    "actuarial_number": "FV 17",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 16,
    "actuarial_type": "FA",
    "actuarial_number": "FV 16",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 15,
    "actuarial_type": "FA",
    "actuarial_number": "FV 15",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 14,
    "actuarial_type": "FA",
    "actuarial_number": "FV 14",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 13,
    "actuarial_type": "FA",
    "actuarial_number": "FV 13",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 12,
    "actuarial_type": "FA",
    "actuarial_number": "FV 12",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "supplier": {
      "id": 23,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 11,
    "actuarial_type": "FA",
    "actuarial_number": "FV 11",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 21,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "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%3A0x0000560d122b0ca8%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:0x0000560d122b0ca8>
q={"status_eq"=>"6"}

Response

Status

200

Headers

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/"5f350bd332248542a37721063e41deed"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=2df51974041774c3672f8bc369f7825d; path=/; expires=Wed, 18 Dec 2019 12:53:06 -0000; HttpOnly
X-Request-Id: 26a84aeb-5e4c-4fca-99c8-3d12b52634fa
X-Runtime: 0.008390
Content-Length: 410

Body

[
  {
    "id": 141,
    "actuarial_type": "FA",
    "actuarial_number": "FV 141",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "Opravený",
    "status_id": 6,
    "issue_date_at": "18. 12. 2019",
    "base_price": "0.0",
    "end_price": "0.0",
    "remaining": "0.0",
    "variable_symbol": null,
    "currency": {
      "id": 24,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "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": "James Dickinson",
  "quantity": "1.0",
  "unit_name": null,
  "unit_price": "200.0",
  "vat_id": 45,
  "tax": "20.0",
  "vat": {
    "id": 45,
    "value": "20.0",
    "valid_from": "2019-12-18",
    "valid_to": "2019-12-19",
    "created_at": "2019-12-18T11:53:53.000+01:00",
    "updated_at": "2019-12-18T11:53:53.000+01: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

201

Headers

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/"18e8b7e5844f7596722ad3c024d895f6"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=621b4b1de1ab80cd417368ae9bcd5c5a; path=/; expires=Wed, 18 Dec 2019 12:53:53 -0000; HttpOnly
X-Request-Id: d9f0c5f4-c5e5-4df1-bf70-b2bf3ec9ac64
X-Runtime: 0.009556
Content-Length: 196

Body

{
  "id": 1114,
  "quantity": "1.0",
  "unit_name": null,
  "name": "James Dickinson",
  "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": "Dewayne Ward PhD",
  "unit_name": null,
  "quantity": "1.0",
  "unit_price": "200.0",
  "vat_id": 44,
  "tax": "20.0",
  "vat": {
    "id": 44,
    "value": "20.0",
    "valid_from": "2019-12-18",
    "valid_to": "2019-12-19",
    "created_at": "2019-12-18T11:53:53.000+01:00",
    "updated_at": "2019-12-18T11:53:53.000+01: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

201

Headers

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/"9197a1588ba16ebbb28a56bf34394aa8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=560404d5f41be31d85ec02a75e5ee3f4; path=/; expires=Wed, 18 Dec 2019 12:53:53 -0000; HttpOnly
X-Request-Id: 2704657f-edbd-45a7-982a-d7fa5ce67fd1
X-Runtime: 0.010288
Content-Length: 197

Body

{
  "id": 1111,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Dewayne Ward PhD",
  "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

204

Headers

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=710668d61326f0fe1dbcd62692cd3a08; path=/; expires=Wed, 18 Dec 2019 12:53:54 -0000; HttpOnly
X-Request-Id: e3fbf4cc-bf19-4280-8c06-ca2c640dd4da
X-Runtime: 0.011451

Delete 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

204

Headers

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=fae9ceee6da5ec31285545cc7bd6f86e; path=/; expires=Wed, 18 Dec 2019 12:53:53 -0000; HttpOnly
X-Request-Id: 67f4d05d-5983-4445-bffa-694a3ad07ee1
X-Runtime: 0.008129

Get 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

200

Headers

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/"7e23f04440e571b54885c016321921ef"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fd0aa4cff88b080fb0335fdc02ab45ac; path=/; expires=Wed, 18 Dec 2019 12:53:53 -0000; HttpOnly
X-Request-Id: 4400ac0d-cf51-4ac9-a914-fbc46bff04fe
X-Runtime: 0.008176
Content-Length: 191

Body

{
  "id": 1108,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Hong Dicki",
  "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

200

Headers

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/"ff4810aa190cfcb6194dd7694f57d486"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=8173ee22eddafa6ae3ca64a8b9eb2197; path=/; expires=Wed, 18 Dec 2019 12:53:52 -0000; HttpOnly
X-Request-Id: 34563a59-5e70-4a84-a3fd-c29775889908
X-Runtime: 0.013142
Content-Length: 198

Body

{
  "id": 1105,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Fredric Rippin II",
  "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

200

Headers

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/"3209646f3556a2c9865996761ccacec1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1f4ff6ba0642e6beb91c6df84877cf7d; path=/; expires=Wed, 18 Dec 2019 12:53:52 -0000; HttpOnly
X-Request-Id: 187d3871-b07a-4783-8dd6-2a44d96fe4e2
X-Runtime: 0.013413
Content-Length: 200

Body

[
  {
    "id": 1104,
    "quantity": "1.0",
    "unit_name": null,
    "name": "Georgette Goodwin",
    "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

200

Headers

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/"633593211fa3af685cdda0edce83ded5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=a1e3d61c57e65fc93170f84e1b4795a0; path=/; expires=Wed, 18 Dec 2019 12:53:52 -0000; HttpOnly
X-Request-Id: f30624ea-7f76-4bc4-a391-e26b1cc0a1a8
X-Runtime: 0.019678
Content-Length: 194

Body

[
  {
    "id": 1101,
    "quantity": "1.0",
    "unit_name": null,
    "name": "Myles Lesch",
    "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

200

Headers

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/"5427db17e95e7c516289b7d9b3f9d522"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7007e68424c8f83cdd8501d33fd063f0; path=/; expires=Wed, 18 Dec 2019 12:53:53 -0000; HttpOnly
X-Request-Id: 6b1f87a7-ec2c-461b-9d75-3a9889f4e738
X-Runtime: 0.009539
Content-Length: 196

Body

{
  "id": 1118,
  "quantity": "5.0",
  "unit_name": null,
  "name": "Debbi Tromp PhD",
  "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

200

Headers

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/"cc316683064aab15663d640b0fc4ee75"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=da70da549dd66b6c9aa5cd0838e3dd52; path=/; expires=Wed, 18 Dec 2019 12:53:53 -0000; HttpOnly
X-Request-Id: 904658bf-7647-4e9d-a5be-b29850f7bdc4
X-Runtime: 0.009597
Content-Length: 198

Body

{
  "id": 1115,
  "quantity": "5.0",
  "unit_name": null,
  "name": "Clarence Nikolaus",
  "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

200

Headers

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/"043f1761d25bf35e63c64168fd82173a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=d8d9d3e3b77f703118d55b8e4f3b2469; path=/; expires=Wed, 18 Dec 2019 12:53:14 -0000; HttpOnly
X-Request-Id: 4838d08f-1926-43ff-a5fe-7230fb9f55f3
X-Runtime: 0.014906
Content-Length: 1313

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": "201900001",
  "uzp_date_at": "18. 12. 2019",
  "due_date_at": "28. 12. 2019",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "18. 12. 2019",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "variable_symbol": null,
  "currency": {
    "id": 35,
    "iso_code": "USD",
    "name": "United states dollar",
    "symbol": "$",
    "symbol_first": true
  },
  "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": "2019-12-18T11:53:13.000+01:00",
      "updated_at": "2019-12-18T11:53:13.000+01: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": "Effertz Port",
    "city": "Claudshire",
    "zip": "16968-7982",
    "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

200

Headers

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/"f4f8ba999508445ab4551d09c370f900"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=acb558b10af3dde0dffbfda5069c8633; path=/; expires=Wed, 18 Dec 2019 12:53:15 -0000; HttpOnly
X-Request-Id: ed8180d7-3576-4c8b-8139-6139acfe5d3f
X-Runtime: 0.026873
Content-Length: 1465

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": "201900001",
  "uzp_date_at": "18. 12. 2019",
  "due_date_at": "28. 12. 2019",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "18. 12. 2019",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "variable_symbol": "123456789",
  "currency": {
    "id": 36,
    "iso_code": "GBP",
    "name": "Pound sterling",
    "symbol": "£",
    "symbol_first": true
  },
  "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": "Champlin and Sons",
    "email": "",
    "ic": "23-580-7106",
    "dic": "CZ84-940-1687",
    "dic2": null,
    "street": "Reichert Spurs",
    "city": "North Katinachester",
    "zip": "18508",
    "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

400

Headers

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=c25af58391573941d723dc08d785b459; path=/; expires=Wed, 18 Dec 2019 12:53:16 -0000; HttpOnly
X-Request-Id: 2ed29959-acda-42fd-a148-c1e30ccab71d
X-Runtime: 0.006790
Content-Length: 95

Body

{
  "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

200

Headers

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/"cb92822541b10052b63a0ec632ad8673"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=97d58677d50f961fe145c8ad7594af0a; path=/; expires=Wed, 18 Dec 2019 12:53:13 -0000; HttpOnly
X-Request-Id: cc8c26fe-0ba4-481f-8cf0-ab7330d18cac
X-Runtime: 0.016530
Content-Length: 1449

Body

{
  "id": 453,
  "actuarial_type": "FA",
  "actuarial_number": "FV 453",
  "uzp_date_at": "18. 12. 2019",
  "due_date_at": "18. 12. 2019",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "18. 12. 2019",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "variable_symbol": null,
  "currency": {
    "id": 34,
    "iso_code": "USD",
    "name": "United states dollar",
    "symbol": "$",
    "symbol_first": true
  },
  "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": "Leuschke Cliff",
    "city": "Oscarbury",
    "zip": "74625",
    "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": "Angel Pfeffer",
      "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-01-01",
  "account_id": 109,
  "currency_id": 38,
  "actuarial_number": "2015000001",
  "lines": [
    {
      "vat_id": 18,
      "lineable_type": "Actuarial",
      "name": "Roxanna Cassin",
      "quantity": 1,
      "unit_price": 200,
      "base_price": 200,
      "tax": 20,
      "total_price": 220,
      "unit_name": "h"
    }
  ]
}

Response

Status

200

Headers

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/"2dfaa09a57cbec99a40be63e4c9b6bd5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=69b64ff187156813aa68d7215ab7260d; path=/; expires=Wed, 18 Dec 2019 12:53:17 -0000; HttpOnly
X-Request-Id: 0b6f045f-30a9-4bf7-aec0-ad6112611f8f
X-Runtime: 0.023130
Content-Length: 1515

Body

{
  "id": 623,
  "actuarial_type": "FA",
  "actuarial_number": "2015000001",
  "uzp_date_at": "18. 12. 2019",
  "due_date_at": "01. 01. 2020",
  "status": "Připravený",
  "status_id": 2,
  "issue_date_at": "18. 12. 2019",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "variable_symbol": null,
  "currency": {
    "id": 38,
    "iso_code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "symbol_first": true
  },
  "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": "Domenic Station",
    "city": "Port Charlamouth",
    "zip": "46726-3591",
    "is_taxable": false,
    "country_id": 83
  },
  "customer": {
    "name": "Rory Lesch",
    "email": "2edwardo_jones@example.org",
    "ic": null,
    "dic": null,
    "dic2": null,
    "street": "Telma Course",
    "city": "West Rodmouth",
    "zip": "13363-4665",
    "country_id": 83
  },
  "items": [
    {
      "id": 624,
      "quantity": "1.0",
      "unit_name": "h",
      "name": "Roxanna Cassin",
      "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"6d017916f453f01c28941fa914efd6ed"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1f5d731ca0a451b409b0e0392b21c665; path=/; expires=Wed, 18 Dec 2019 12:53:10 -0000; HttpOnly
X-Request-Id: 50406a86-4f2b-487b-9a4d-b1f84ccd4a4b
X-Runtime: 0.069036
Content-Length: 8281

Body

[
  {
    "id": 346,
    "actuarial_type": "FA",
    "actuarial_number": "FV 346",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2020",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 340,
    "actuarial_type": "FA",
    "actuarial_number": "FV 340",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 339,
    "actuarial_type": "FA",
    "actuarial_number": "FV 339",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 338,
    "actuarial_type": "FA",
    "actuarial_number": "FV 338",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 337,
    "actuarial_type": "FA",
    "actuarial_number": "FV 337",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 336,
    "actuarial_type": "FA",
    "actuarial_number": "FV 336",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 335,
    "actuarial_type": "FA",
    "actuarial_number": "FV 335",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 334,
    "actuarial_type": "FA",
    "actuarial_number": "FV 334",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 333,
    "actuarial_type": "FA",
    "actuarial_number": "FV 333",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 332,
    "actuarial_type": "FA",
    "actuarial_number": "FV 332",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 331,
    "actuarial_type": "FA",
    "actuarial_number": "FV 331",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 330,
    "actuarial_type": "FA",
    "actuarial_number": "FV 330",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 329,
    "actuarial_type": "FA",
    "actuarial_number": "FV 329",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 328,
    "actuarial_type": "FA",
    "actuarial_number": "FV 328",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 327,
    "actuarial_type": "FA",
    "actuarial_number": "FV 327",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 326,
    "actuarial_type": "FA",
    "actuarial_number": "FV 326",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 325,
    "actuarial_type": "FA",
    "actuarial_number": "FV 325",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 324,
    "actuarial_type": "FA",
    "actuarial_number": "FV 324",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 323,
    "actuarial_type": "FA",
    "actuarial_number": "FV 323",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 322,
    "actuarial_type": "FA",
    "actuarial_number": "FV 322",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 30,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "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%3A0x0000560d122b0ca8%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:0x0000560d122b0ca8>
q={"status_eq"=>"7"}

Response

Status

200

Headers

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/"27f1aaa154d1a49f5c8dc777e1dc9c4b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=eedc196db5eb8406571cb3f62c229031; path=/; expires=Wed, 18 Dec 2019 12:53:13 -0000; HttpOnly
X-Request-Id: c3ce03d9-15c8-4582-9950-ed75412c09c1
X-Runtime: 0.009755
Content-Length: 415

Body

[
  {
    "id": 452,
    "actuarial_type": "FA",
    "actuarial_number": "FV 452",
    "uzp_date_at": "18. 12. 2019",
    "due_date_at": "18. 12. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "18. 12. 2019",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 33,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "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

200

Headers

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=c762872339c8a7eba2a659aba7baec1c; path=/; expires=Wed, 18 Dec 2019 12:53:17 -0000; HttpOnly
X-Request-Id: 3c4dbeed-9430-41b7-b2f9-26ba903710d0
X-Runtime: 0.068565
Content-Length: 21

Body

{
  "cash_voucher_id": 1
}

Send Actuarial to specific email

Parameters

Name Description
email Required email
comment email

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

200

Headers

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=c2910263f0c3c755c142c37c22e2f086; path=/; expires=Wed, 18 Dec 2019 12:53:20 -0000; HttpOnly
X-Request-Id: c4233ae6-98ad-4d23-bc9e-57e8b168a5fa
X-Runtime: 1.792748
Content-Length: 0

Admin 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

401

Headers

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: 10aff66a-94bf-42f2-ab53-d0973761c39f
X-Runtime: 0.008969
Content-Length: 0

App 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

401

Headers

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: f14b3978-d765-4e82-b498-38a9ea0f9765
X-Runtime: 0.001625
Content-Length: 0

Admin 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

200

Headers

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: 0cee008d-70cc-48a1-8e15-254c71ee68b6
X-Runtime: 0.015790
Content-Length: 299

Body

[
  {
    "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

200

Headers

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/"fa2d1a8e9fca3eef9d37004b262eed6b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0c7eef11-0fee-4de1-a584-960d33100b95
X-Runtime: 0.013692
Content-Length: 255

Body

[
  {
    "id": 45,
    "iso_code": "GBP",
    "name": "Pound sterling",
    "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

200

Headers

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: 75ad8d0c-be40-4fc9-bb10-48ea5fa10cf2
X-Runtime: 0.001981
Content-Length: 95

Body

[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

200

Headers

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: fa498fea-ab67-4cc2-a231-32c1cba54d1b
X-Runtime: 0.003783
Content-Length: 83

Body

{
  "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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: 8a5f4ce6-553a-4ba1-823c-b0e54ef9cdcb
X-Runtime: 0.003547
Content-Length: 313

Body

[
  {
    "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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: 9d16fc00-ace4-4715-b535-57495ea890a4
X-Runtime: 0.005870
Content-Length: 622

Body

[
  {
    "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-App: app_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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: 4076d63f-8616-4969-b71b-e8c5b5e28fd2
X-Runtime: 0.004037
Content-Length: 310

Body

[
  {
    "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": "2019-12-18",
    "due_date_at": "2020-01-01",
    "uzp_date_at": "2019-12-18",
    "payment_type": 2,
    "variable_symbol": "20170123456",
    "currency_id": 58
  }
}

Response

Status

200

Headers

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/"652455b7b5335d5058152cf5e3fb5009"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 20d99be5-14fa-463f-8b0c-2baffce323d3
X-Runtime: 0.007636
Content-Length: 655

Body

{
  "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": "01. 01. 2020",
  "issue_date_at": "18. 12. 2019",
  "uzp_date_at": "18. 12. 2019"
}

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

200

Headers

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: 453d5136-1d32-4e9f-b910-0f645710c3e7
X-Runtime: 0.004347
Content-Length: 83

Body

{
  "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

401

Headers

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: c9aa1a3c-2016-48ed-98ec-ed4e8f362a3b
X-Runtime: 0.018397
Content-Length: 2

Body

[

]

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

401

Headers

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: 37d5c915-622b-4591-abfe-42105bf39a77
X-Runtime: 0.001546
Content-Length: 2

Body

[

]

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

200

Headers

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=c98ccce7290b92d0009a9c9fea088126; path=/; expires=Wed, 18 Dec 2019 12:53:29 -0000; HttpOnly
X-Request-Id: f4f1b4d9-6c32-43c2-865e-1bac32034377
X-Runtime: 0.006990
Content-Length: 42

Body

[
  "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

200

Headers

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=d8ec453a96646fde00a4351440043bfc; path=/; expires=Wed, 18 Dec 2019 12:53:29 -0000; HttpOnly
X-Request-Id: c371edb7-d458-44b7-9e03-c185ce2522ac
X-Runtime: 0.014833
Content-Length: 60

Body

{
  "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=d8ec453a96646fde00a4351440043bfc

Query Parameters

resource=ActuarialsIn

Response

Status

200

Headers

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=d8ec453a96646fde00a4351440043bfc; path=/; expires=Wed, 18 Dec 2019 12:53:29 -0000; HttpOnly
X-Request-Id: e4a9c951-873a-409d-a95c-c49803b99ac9
X-Runtime: 0.007528
Content-Length: 59

Body

{
  "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

200

Headers

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/"6951800218b4cb27a484245eba346f79"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=343baf981623702a3dec1c6032f81fea; path=/; expires=Wed, 18 Dec 2019 12:53:33 -0000; HttpOnly
X-Request-Id: d5b4c59f-da8b-41ee-9f27-92eaed80e868
X-Runtime: 0.010888
Content-Length: 570

Body

{
  "id": 107,
  "number": "106",
  "description": null,
  "total_price": "240,00 GBP",
  "base_price": "200,00 GBP",
  "transaction_date": "18. 12. 2019",
  "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": "Ms. Kenton Buckridge",
      "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"068ae72af790271a4ac08274e1214761"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=38a162f920edfde0ec45303fddb5ebc1; path=/; expires=Wed, 18 Dec 2019 12:53:31 -0000; HttpOnly
X-Request-Id: 6498322a-c98d-4f23-8138-a26da37e5cf9
X-Runtime: 0.059900
Content-Length: 5057

Body

[
  {
    "id": 36,
    "number": "35",
    "description": null,
    "total_price": "0,00 GBP",
    "base_price": "0,00 GBP",
    "transaction_date": "18. 12. 2020",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 email

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

200

Headers

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=ba3894c2d3b8fdad3268b4230184f3f3; path=/; expires=Wed, 18 Dec 2019 12:53:34 -0000; HttpOnly
X-Request-Id: 3e04f81f-e1be-46c3-bb31-ff1ad116e007
X-Runtime: 0.004856
Content-Length: 0

Send cash voucher to specific email

Parameters

Name Description
email Required email
comment email

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

200

Headers

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=251bec3cc1d4c463e85b6876ba018293; path=/; expires=Wed, 18 Dec 2019 12:53:37 -0000; HttpOnly
X-Request-Id: 4de9abf4-ae3f-4d78-8eea-11db3d189693
X-Runtime: 0.863844
Content-Length: 0

Cash 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

200

Headers

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/"74e713171f72fb1c42a51d519f48e017"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f8e1292d012ae3e1bd839c30789c6d62; path=/; expires=Wed, 18 Dec 2019 12:53:41 -0000; HttpOnly
X-Request-Id: b512d370-8974-4c05-887e-4cf1660a0faa
X-Runtime: 0.009889
Content-Length: 566

Body

{
  "id": 314,
  "number": "313",
  "description": null,
  "total_price": "240,00 GBP",
  "base_price": "200,00 GBP",
  "transaction_date": "18. 12. 2019",
  "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": "Jordan Cummerata",
      "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"a425b1c434aba8c97c33a5062db3f0d4"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=62f6d9289c7c3238b0f8609dff798ff7; path=/; expires=Wed, 18 Dec 2019 12:53:38 -0000; HttpOnly
X-Request-Id: c6b83ef8-ca8f-4823-a6ef-c7f5fd3a1bf9
X-Runtime: 0.075738
Content-Length: 5097

Body

[
  {
    "id": 243,
    "number": "242",
    "description": null,
    "total_price": "0,00 GBP",
    "base_price": "0,00 GBP",
    "transaction_date": "18. 12. 2020",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 GBP",
    "base_price": "200,00 GBP",
    "transaction_date": "18. 12. 2019",
    "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 email

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

200

Headers

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=fe90b7acb0e7ddc6967c09a3eef90f94; path=/; expires=Wed, 18 Dec 2019 12:53:42 -0000; HttpOnly
X-Request-Id: 002dabd6-7ab7-4762-b771-a436e9147829
X-Runtime: 0.004470
Content-Length: 0

Send cash voucher to specific email

Parameters

Name Description
email Required email
comment email

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

200

Headers

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=5e2cc0e30a1763cb28e5038c59a09a1a; path=/; expires=Wed, 18 Dec 2019 12:53:44 -0000; HttpOnly
X-Request-Id: d146d8c2-63bc-4025-b7f3-4f2728e177d7
X-Runtime: 0.719097
Content-Length: 0

Companies

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

200

Headers

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/"f9f76fc0e31bc4e0730590c76ed43a9d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b175921aac2cee6d76afa4fef53c789c; path=/; expires=Wed, 18 Dec 2019 12:53:52 -0000; HttpOnly
X-Request-Id: 90f605a1-ad26-4ed1-8aea-6ab423f5e491
X-Runtime: 0.005308
Content-Length: 301

Body

{
  "id": 90,
  "first_name": "Kasey",
  "last_name": "Rempel",
  "bank_account": null,
  "birthday": "2019-12-18",
  "status": null,
  "nationality": null,
  "place_of_birth": null,
  "personal_number": "18. 12. 2019",
  "identification_number": null,
  "employee_number": "number_18. 12. 2019",
  "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

200

Headers

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/"d4c69af2227f64d6f09f714fb9e25b20"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=46c1f3319841dc581826979d7f9747a7; path=/; expires=Wed, 18 Dec 2019 12:53:44 -0000; HttpOnly
X-Request-Id: bfece648-0dca-47cf-a700-1ac09c920848
X-Runtime: 0.009601
Content-Length: 200

Body

{
  "id": 96,
  "name": "Company 96",
  "ic": "96",
  "is_taxable": false,
  "country_id": 1001,
  "email": "company-96@sucto.cz",
  "address": {
    "street": "Adams Station",
    "city": "South Adrianview",
    "city_part": null,
    "zip": "39104"
  }
}

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

200

Headers

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=734bdc9c88bef956bbcadf05ad69e391; path=/; expires=Wed, 18 Dec 2019 12:53:44 -0000; HttpOnly
X-Request-Id: 87a97e23-3d15-43b7-9b9e-f9e734f23f1a
X-Runtime: 0.014416
Content-Length: 2

Body

[

]

List of company's employees

Parameters

Name Description
page Page

Request

Route

GET api/companies/115/employees?page=%23%3CCapybara%3A%3ASession%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"2e42026a611cd5561ca4d79773ecccd7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=d1c3f9c9a6a97bb8f38905c033cd41d5; path=/; expires=Wed, 18 Dec 2019 12:53:51 -0000; HttpOnly
X-Request-Id: 470e01b3-c5cd-4ba5-b10a-1bb2073d5883
X-Runtime: 0.013412
Content-Length: 2476

Body

[
  {
    "id": 10,
    "first_name": "Tinisha",
    "last_name": "Medhurst",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 11,
    "first_name": "Dorie",
    "last_name": "Kihn",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 12,
    "first_name": "Toney",
    "last_name": "Rau",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 13,
    "first_name": "Micheal",
    "last_name": "Erdman",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 14,
    "first_name": "Elliot",
    "last_name": "Carroll",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 15,
    "first_name": "Emogene",
    "last_name": "Turcotte",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 16,
    "first_name": "Alphonso",
    "last_name": "Kshlerin",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 17,
    "first_name": "Wilton",
    "last_name": "Boehm",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 18,
    "first_name": "Gonzalo",
    "last_name": "Bartell",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 19,
    "first_name": "Laverne",
    "last_name": "Mertz",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 20,
    "first_name": "Rachele",
    "last_name": "Spinka",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 21,
    "first_name": "Hermelinda",
    "last_name": "Orn",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 22,
    "first_name": "Minh",
    "last_name": "Fisher",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 23,
    "first_name": "Daren",
    "last_name": "Shields",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 24,
    "first_name": "Susanna",
    "last_name": "Fritsch",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 25,
    "first_name": "Shiloh",
    "last_name": "Roob",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 26,
    "first_name": "Garrett",
    "last_name": "Luettgen",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 27,
    "first_name": "Judson",
    "last_name": "Zemlak",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 28,
    "first_name": "Natividad",
    "last_name": "Beier",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "sex": "Muž"
  },
  {
    "id": 29,
    "first_name": "Christene",
    "last_name": "Langosh",
    "personal_number": "18. 12. 2019",
    "birthday": "2019-12-18",
    "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

200

Headers

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=323eff39e4b1c61985851f0c28e766cd; path=/; expires=Wed, 18 Dec 2019 12:53:44 -0000; HttpOnly
X-Request-Id: 513ab329-d369-4543-888c-8d60ee3436f2
X-Runtime: 0.011247
Content-Length: 153

Body

{
  "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

200

Headers

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=7b8245e895bb097ca50ec84fece976eb; path=/; expires=Wed, 18 Dec 2019 12:53:44 -0000; HttpOnly
X-Request-Id: 382e706f-70f7-4afb-8596-c14a74a60631
X-Runtime: 0.022938
Content-Length: 303

Body

[
  {
    "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

200

Headers

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=05f937067fc1b20d17ac0e441ea00586; path=/; expires=Wed, 18 Dec 2019 12:54:07 -0000; HttpOnly
X-Request-Id: ea22dda1-b07f-46af-adfb-29405c5b3cf3
X-Runtime: 0.018235
Content-Length: 150

Body

[
  {
    "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

200

Headers

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/"299202fd1c53b1ae2bb91bb8ff9fafc8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=230e39e56281deb8da0f925dde5a8174; path=/; expires=Wed, 18 Dec 2019 12:54:07 -0000; HttpOnly
X-Request-Id: e1542e82-1654-42ac-ac98-8fc83ed3871e
X-Runtime: 0.008926
Content-Length: 226

Body

[
  {
    "id": 52,
    "value": "20.0",
    "valid_from": "2019-12-18",
    "valid_to": "2019-12-19"
  },
  {
    "id": 54,
    "value": "19.0",
    "valid_from": "2019-12-18",
    "valid_to": "2019-12-19"
  },
  {
    "id": 53,
    "value": "11.0",
    "valid_from": "2019-12-18",
    "valid_to": "2019-12-19"
  }
]

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

200

Headers

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/"f76c49e681d7c7b85942c1d7f6263291"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ea1e4d424f5b04325d1592f2d91b08ff; path=/; expires=Wed, 18 Dec 2019 12:54:07 -0000; HttpOnly
X-Request-Id: f167ec00-d0f3-46f1-a4f1-cdc7babb344c
X-Runtime: 0.003758
Content-Length: 68

Body

[
  {
    "id": 64,
    "value": "21.0",
    "valid_from": "2019-12-18",
    "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

200

Headers

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=16a9143a73b172d9e60ff8e363f99531; path=/; expires=Wed, 18 Dec 2019 12:54:07 -0000; HttpOnly
X-Request-Id: f052c610-9658-485a-91ba-c786ecbf623e
X-Runtime: 0.021206
Content-Length: 118

Body

[
  {
    "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"c50755c56c99cc3fdf0beefc139f38ae"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=00345abd04957041e1ae3da029576d0c; path=/; expires=Wed, 18 Dec 2019 12:53:45 -0000; HttpOnly
X-Request-Id: c57fe2fd-4cbd-4c2b-bc1c-0dbe25339f8d
X-Runtime: 0.028006
Content-Length: 255

Body

[
  {
    "id": 82,
    "iso_code": "PLN",
    "name": "Polish zloty",
    "symbol": "zł",
    "symbol_first": false
  },
  {
    "id": 83,
    "iso_code": "GBP",
    "name": "Pound sterling",
    "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%3A0x0000560d122b0ca8%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:0x0000560d122b0ca8>
q={"iso_code_cont"=>"CZK"}

Response

Status

200

Headers

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/"368002c83d8aa18ade24f37bc03e6210"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=8c25cba531eb2da743b20e83f75f7893; path=/; expires=Wed, 18 Dec 2019 12:53:45 -0000; HttpOnly
X-Request-Id: 6442d8d1-9253-4033-ac3c-ae75ff18d9be
X-Runtime: 0.009180
Content-Length: 169

Body

[
  {
    "id": 86,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  },
  {
    "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

200

Headers

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/"82202bb9b8336984982624f40dba686b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f6c7e4e828d76730d2b15d7c757568f0; path=/; expires=Wed, 18 Dec 2019 12:53:45 -0000; HttpOnly
X-Request-Id: c4acbcf8-d704-4813-a885-e96d246ff523
X-Runtime: 0.012882
Content-Length: 123

Body

{
  "system_informations": {
    "id": 1,
    "title": "Tijuana Abernathy",
    "created_at": "18. 12. 2019",
    "description": "omnis",
    "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

200

Headers

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/"1470d91cd98573a181df448c0e6dec43"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fd18702f6b9290bf4e1b31bca2df9446; path=/; expires=Wed, 18 Dec 2019 12:53:45 -0000; HttpOnly
X-Request-Id: 7da079ac-3e2a-4563-9e77-8ef50a29ea9c
X-Runtime: 0.015610
Content-Length: 1041

Body

[
  {
    "id": 22,
    "value": "Bettina Ernser",
    "company_id": 98,
    "created_at": "2019-12-18T11:53:45.000+01:00",
    "updated_at": "2019-12-18T11:53:45.000+01:00",
    "parent_id": null,
    "lft": 1,
    "rgt": 2,
    "position": null,
    "pohoda_id": null
  },
  {
    "id": 23,
    "value": "Salvatore Feeney DDS",
    "company_id": 98,
    "created_at": "2019-12-18T11:53:45.000+01:00",
    "updated_at": "2019-12-18T11:53:45.000+01:00",
    "parent_id": null,
    "lft": 3,
    "rgt": 4,
    "position": null,
    "pohoda_id": null
  },
  {
    "id": 24,
    "value": "Fernande Terry",
    "company_id": 98,
    "created_at": "2019-12-18T11:53:45.000+01:00",
    "updated_at": "2019-12-18T11:53:45.000+01:00",
    "parent_id": null,
    "lft": 5,
    "rgt": 6,
    "position": null,
    "pohoda_id": null
  },
  {
    "id": 25,
    "value": "Jeane Robel",
    "company_id": 98,
    "created_at": "2019-12-18T11:53:45.000+01:00",
    "updated_at": "2019-12-18T11:53:45.000+01:00",
    "parent_id": null,
    "lft": 7,
    "rgt": 8,
    "position": null,
    "pohoda_id": null
  },
  {
    "id": 26,
    "value": "Mario Hermiston",
    "company_id": 98,
    "created_at": "2019-12-18T11:53:45.000+01:00",
    "updated_at": "2019-12-18T11:53:45.000+01: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

200

Headers

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/"c087367af73639dd992b6cc6b85a46f0"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fcfe9dbd49c9bd2b07a98a1045ed6189; path=/; expires=Wed, 18 Dec 2019 12:53:30 -0000; HttpOnly
X-Request-Id: 950c55a4-b789-43be-8cff-842d95783226
X-Runtime: 0.005804
Content-Length: 319

Body

{
  "id": 7,
  "number_plate": "60-832-6600",
  "description": "Autem cum dignissimos recusandae.",
  "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": "Mrs. Nickie Kuhic"
  }
}

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

200

Headers

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/"a1382a9ca8baae7004460d71fca3ebd1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=0e3fb7790c6a15aed981ce237078eb65; path=/; expires=Wed, 18 Dec 2019 12:53:50 -0000; HttpOnly
X-Request-Id: c187409f-d093-4788-8202-a113c9205dea
X-Runtime: 0.011682
Content-Length: 2532

Body

{
  "id": 75,
  "is_private": null,
  "start_location": "612 Maricela Brook",
  "end_location": "13826 Abram Street",
  "start_time": "2019-12-18T11:53:49.000+01:00",
  "end_time": "2019-12-18T15:53:49.000+01:00",
  "and_back": null,
  "trip_length": 300,
  "start_tachometer": 0,
  "end_tachometer": 500,
  "purpose": "Cumque voluptates odit eveniet.",
  "car": {
    "id": 17,
    "number_plate": "07-201-1458",
    "description": "Ea est quo id.",
    "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": "Carter Price Sr."
    }
  },
  "employee": {
    "id": 7,
    "first_name": "Ignacia",
    "last_name": "Ferry",
    "bank_account": null,
    "birthday": "2019-12-18",
    "status": null,
    "nationality": null,
    "place_of_birth": null,
    "personal_number": "18. 12. 2019",
    "identification_number": null,
    "employee_number": "number_18. 12. 2019",
    "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": "Cumque voluptates odit eveniet."
      },
      "car": {
        "id": 17,
        "description": "Ea est quo id."
      },
      "employee": {
        "id": 7,
        "first_name": "Ignacia",
        "last_name": "Ferry"
      }
    },
    {
      "id": 220,
      "drive_record_id": 75,
      "price": "120.0",
      "end_price": "120.0",
      "vat_value": "20.0",
      "drive_record": {
        "id": 75,
        "purpose": "Cumque voluptates odit eveniet."
      },
      "car": {
        "id": 17,
        "description": "Ea est quo id."
      },
      "employee": {
        "id": 7,
        "first_name": "Ignacia",
        "last_name": "Ferry"
      }
    }
  ],
  "drive_refuels": [
    {
      "id": 223,
      "place": "958 Christiansen Crossing",
      "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": "Cumque voluptates odit eveniet."
      },
      "car": {
        "id": 17,
        "description": "Ea est quo id."
      },
      "employee": {
        "id": 7,
        "first_name": "Ignacia",
        "last_name": "Ferry"
      }
    },
    {
      "id": 224,
      "place": "90202 Turner Throughway",
      "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": "Cumque voluptates odit eveniet."
      },
      "car": {
        "id": 17,
        "description": "Ea est quo id."
      },
      "employee": {
        "id": 7,
        "first_name": "Ignacia",
        "last_name": "Ferry"
      }
    },
    {
      "id": 225,
      "place": "63710 Zulauf View",
      "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": "Cumque voluptates odit eveniet."
      },
      "car": {
        "id": 17,
        "description": "Ea est quo id."
      },
      "employee": {
        "id": 7,
        "first_name": "Ignacia",
        "last_name": "Ferry"
      }
    }
  ]
}

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

200

Headers

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/"5e5e9b1ea7e86e2993c8f50fc7f8b8c3"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=37e2b9728efa53631ddb24cf10634228; path=/; expires=Wed, 18 Dec 2019 12:53:30 -0000; HttpOnly
X-Request-Id: bef26629-74bc-4e81-8cdc-8b75610745e7
X-Runtime: 0.013907
Content-Length: 918

Body

[
  {
    "id": 1,
    "number_plate": "37-049-2156",
    "description": "Soluta dicta quidem iste.",
    "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": "Johnie Hilpert"
    }
  },
  {
    "id": 2,
    "number_plate": "28-038-1976",
    "description": "Nobis at quo incidunt.",
    "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": "Johnie Hilpert"
    }
  },
  {
    "id": 3,
    "number_plate": "85-589-4003",
    "description": "Modi est quia vel.",
    "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": "Johnie Hilpert"
    }
  }
]

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

200

Headers

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/"2600908c5ac60062d83e868feef2aad7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=15e5c94d29c075c27655213009106dc1; path=/; expires=Wed, 18 Dec 2019 12:53:45 -0000; HttpOnly
X-Request-Id: 79a1d00c-000f-470f-ae41-47d77e77a870
X-Runtime: 0.015876
Content-Length: 74

Body

[
  {
    "id": 1,
    "name": "Oprava"
  },
  {
    "id": 2,
    "name": "Jidlo"
  },
  {
    "id": 3,
    "name": "Hotel"
  }
]

List of company's drive expenses

Parameters

Name Description
page Page

Request

Route

GET api/companies/101/drive_expenses?page=%23%3CCapybara%3A%3ASession%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"8f69f7c05b4a381fdf56c8a678cbc137"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=02410a404a889010914ebc68dec7c109; path=/; expires=Wed, 18 Dec 2019 12:53:46 -0000; HttpOnly
X-Request-Id: 40a97ad2-956e-4829-b796-dfbbbae1c3e3
X-Runtime: 0.041355
Content-Length: 5341

Body

[
  {
    "id": 34,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 33,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 32,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 31,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 30,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 29,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 28,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 27,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 26,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 25,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 24,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 23,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 22,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 21,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 20,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 19,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 18,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 17,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 16,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  },
  {
    "id": 15,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Voluptate placeat nihil qui."
    },
    "car": {
      "id": 13,
      "description": "Recusandae nam et et."
    },
    "employee": {
      "id": 3,
      "first_name": "Simonne",
      "last_name": "Hintz"
    }
  }
]

List of company's drive records

Parameters

Name Description
page Page

Request

Route

GET api/companies/105/drive_records?page=%23%3CCapybara%3A%3ASession%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"2e651433aad7fd72472df6cb53d7c397"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=4f783dd8abfbc233834ab772f23ac201; path=/; expires=Wed, 18 Dec 2019 12:53:48 -0000; HttpOnly
X-Request-Id: 6ddcb0ee-24cc-45bd-8133-4ecf2a03bc6a
X-Runtime: 0.032488
Content-Length: 6014

Body

[
  {
    "id": 34,
    "purpose": "Eum deserunt aut inventore.",
    "start_location": "779 Hortense Manors",
    "end_location": "901 Fe Manors",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 33,
    "purpose": "Dolorum iste ut omnis.",
    "start_location": "2570 Romaguera Hollow",
    "end_location": "99467 Berry Lodge",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 32,
    "purpose": "Et porro assumenda rerum.",
    "start_location": "799 Darrin Cliffs",
    "end_location": "440 Schmitt Bridge",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 31,
    "purpose": "Ex perspiciatis officia impedit.",
    "start_location": "85433 Funk Rapids",
    "end_location": "2098 Homenick Spur",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 30,
    "purpose": "Fuga placeat magnam in.",
    "start_location": "2522 Howell Springs",
    "end_location": "4726 Junior Expressway",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 29,
    "purpose": "Aliquid ut repudiandae nihil.",
    "start_location": "32323 Cinderella Ranch",
    "end_location": "70893 Marcelo Viaduct",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 28,
    "purpose": "Quis minima non facilis.",
    "start_location": "2755 Schmeler Motorway",
    "end_location": "5398 Duane Spring",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 27,
    "purpose": "Rem quia natus atque.",
    "start_location": "9228 Ratke Roads",
    "end_location": "554 Stracke Radial",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 26,
    "purpose": "Cupiditate facilis libero rem.",
    "start_location": "4995 Glover Village",
    "end_location": "878 Jamal Shoal",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 25,
    "purpose": "Et dolor eos pariatur.",
    "start_location": "2427 Jan Station",
    "end_location": "6794 Kerluke Junction",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 24,
    "purpose": "Doloremque id nobis consequatur.",
    "start_location": "73051 Gemma Oval",
    "end_location": "177 Borer Divide",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 23,
    "purpose": "Et sint necessitatibus et.",
    "start_location": "57528 Felton Highway",
    "end_location": "420 Kasi Fields",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 22,
    "purpose": "Voluptas debitis ut aut.",
    "start_location": "71949 Reichert Estates",
    "end_location": "955 Murazik Hollow",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 21,
    "purpose": "Culpa quia aut hic.",
    "start_location": "2294 Elbert Cliffs",
    "end_location": "80749 Giovanni Common",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 20,
    "purpose": "Qui laboriosam perferendis assumenda.",
    "start_location": "6117 Yundt Creek",
    "end_location": "71093 Robyn Plain",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 19,
    "purpose": "Sit dicta labore ea.",
    "start_location": "24657 Walker Corners",
    "end_location": "394 Kertzmann Mountains",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 18,
    "purpose": "Non culpa nisi sunt.",
    "start_location": "69393 Berneice Light",
    "end_location": "72666 Garfield Prairie",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 17,
    "purpose": "Vero saepe et nisi.",
    "start_location": "825 Durgan Summit",
    "end_location": "26789 Dominque Streets",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 16,
    "purpose": "Nihil alias eligendi repellendus.",
    "start_location": "21108 Altenwerth Lake",
    "end_location": "527 Cory Station",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  },
  {
    "id": 15,
    "purpose": "Unde ea eum perspiciatis.",
    "start_location": "4488 Tora Meadows",
    "end_location": "6432 Kasandra Loaf",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Sapiente minus est iste."
    },
    "employee": {
      "id": 5,
      "first_name": "Colin",
      "last_name": "Bins"
    }
  }
]

List of company's drive refuels

Parameters

Name Description
page Page

Request

Route

GET api/companies/111/drive_refuels?page=%23%3CCapybara%3A%3ASession%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"e53b14146156eb643e675d824f4fca3f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=8af1e7f6aada5635f246ea5f82cc5a11; path=/; expires=Wed, 18 Dec 2019 12:53:51 -0000; HttpOnly
X-Request-Id: def3b932-4da3-4ed5-b550-4d2599d722f9
X-Runtime: 0.034099
Content-Length: 7097

Body

[
  {
    "id": 363,
    "place": "2067 VonRueden Parkway",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 362,
    "place": "181 Georgia Path",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 361,
    "place": "157 Fisher Stream",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 360,
    "place": "94932 Scotty Burg",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 359,
    "place": "7532 Hills Viaduct",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 358,
    "place": "50315 Kuhlman Creek",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 357,
    "place": "157 Lorinda Parks",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 356,
    "place": "7191 Laila Port",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 355,
    "place": "5874 Simonis Expressway",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 354,
    "place": "18179 Rozanne Valley",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 353,
    "place": "3506 Smith Lane",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 352,
    "place": "983 D'Amore Route",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 351,
    "place": "2296 Cronin Point",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 350,
    "place": "10050 Glover Cape",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 349,
    "place": "5842 Greenholt Avenue",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 348,
    "place": "3404 Kary Lane",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 347,
    "place": "560 Carli Inlet",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 346,
    "place": "1707 Lynch Turnpike",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 345,
    "place": "33064 Heller Squares",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  },
  {
    "id": 344,
    "place": "2898 Lindsey Well",
    "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": "Quam non quidem qui."
    },
    "car": {
      "id": 18,
      "description": "Natus inventore voluptatum tempore."
    },
    "employee": {
      "id": 8,
      "first_name": "Stephanie",
      "last_name": "Miller"
    }
  }
]

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

200

Headers

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/"a0c542abe28a8078921f224a93fd3ce4"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f94e24dc1b039c9ae6dff231a9a63a9d; path=/; expires=Wed, 18 Dec 2019 12:53:56 -0000; HttpOnly
X-Request-Id: 8cafded9-2cc9-4280-b7d2-eae10856d59c
X-Runtime: 0.016918
Content-Length: 6

Body

[
  2019
]

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=2019

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

year=2019

Response

Status

200

Headers

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/"182942dcc35461974f6027aa6d08dd87"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7683a9eb29c5ad603539143875eaa3ca; path=/; expires=Wed, 18 Dec 2019 12:53:57 -0000; HttpOnly
X-Request-Id: c66d7f9b-6c07-46f5-86ab-5066d36a2460
X-Runtime: 0.010161
Content-Length: 330

Body

[
  {
    "name": "Faktury přijaté",
    "data": [
      505.0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  },
  {
    "name": "Faktury vydané",
    "data": [
      683.0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  },
  {
    "name": "Doklady příjmové",
    "data": [
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0
    ]
  },
  {
    "name": "Doklady výdajové",
    "data": [
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.0,
      92.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] 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": "Miss Boyce Botsford",
    "email": "23amalia@example.com",
    "dic": null,
    "is_taxable": false,
    "is_supplier": false,
    "is_customer": true,
    "currency_id": 114,
    "address_attributes": {
      "country_id": 1086,
      "city": "Lake Dorcastown",
      "street": "Hintz Ranch",
      "zip": "12253-2949"
    },
    "postal_address_attributes": {
      "country_id": 1086,
      "city": "Lake Dorcastown",
      "street": "Hintz Ranch",
      "zip": "12253-2949"
    }
  }
}

Response

Status

200

Headers

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/"b3345dc1ec54ab6af830b030171ad402"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=cbabc23d31fe6a928e7d9dbf8bc45f4d; path=/; expires=Wed, 18 Dec 2019 12:53:55 -0000; HttpOnly
X-Request-Id: 48feae76-c920-44e8-8a18-67c08936dd7d
X-Runtime: 0.018460
Content-Length: 663

Body

{
  "id": 291,
  "name": "Miss Boyce Botsford",
  "ic": "123456789",
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "23amalia@example.com",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Hintz Ranch",
    "city": "Lake Dorcastown",
    "country_id": 1086,
    "zip": "12253-2949",
    "country": {
      "id": 1086,
      "name": null
    }
  },
  "postal_address": {
    "street": "Hintz Ranch",
    "city": "Lake Dorcastown",
    "country_id": 1086,
    "zip": "12253-2949"
  },
  "contacts": [

  ],
  "bank_accounts": [

  ],
  "currency_id": 114,
  "currency": {
    "id": 114,
    "iso_code": "PLN",
    "name": "Polish zloty",
    "symbol": "zł",
    "symbol_first": false
  }
}

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

200

Headers

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=c2c2a475a5de0858480dd7268cd553a7; path=/; expires=Wed, 18 Dec 2019 12:53:55 -0000; HttpOnly
X-Request-Id: f068f68b-a794-41c5-bd40-6348edcd9acf
X-Runtime: 0.017918
Content-Length: 569

Body

{
  "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

422

Headers

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=d870cfd726828e6aeaed6ce5bc403459; path=/; expires=Wed, 18 Dec 2019 12:53:55 -0000; HttpOnly
X-Request-Id: 6bcf2a74-ae59-462f-8ce6-1e1dbe3d09ec
X-Runtime: 0.013646
Content-Length: 21

Body

{
  "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

204

Headers

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=2370ceb33b96974218dbab849162c018; path=/; expires=Wed, 18 Dec 2019 12:53:56 -0000; HttpOnly
X-Request-Id: 518ee0f5-38cc-44d1-97ca-ac52c11669cf
X-Runtime: 0.014313

Detail 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

200

Headers

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/"810b4dd346c9adee8764aff3816d42b2"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f86b380240fc356f716ebc2e1265912f; path=/; expires=Wed, 18 Dec 2019 12:53:55 -0000; HttpOnly
X-Request-Id: 1d012afb-2032-4b6f-b888-5344e4dd36d2
X-Runtime: 0.027102
Content-Length: 544

Body

{
  "id": 279,
  "name": "Mandie Kreiger",
  "ic": null,
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "13billie@example.org",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Timothy Road",
    "city": "Minnaborough",
    "country_id": 1084,
    "zip": "05051-4650",
    "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"a8d21565b0491770b02df13243998aa5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b96afe833220efe5c7ff81b0aecf1bd7; path=/; expires=Wed, 18 Dec 2019 12:53:54 -0000; HttpOnly
X-Request-Id: 6a4ae9df-8c8c-49b4-9783-b1265fd0c027
X-Runtime: 0.025259
Content-Length: 2467

Body

[
  {
    "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": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "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": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 265,
    "name": "Ms. Kum Larkin",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "3rochelle.weber@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Powlowski Roads",
      "city": "Beerborough",
      "city_part": null,
      "zip": "01768-8689"
    },
    "currency": {
      "id": 111,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 266,
    "name": "Elidia Weber Sr.",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "4long@example.org",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Robel Lakes",
      "city": "South Faustinaburgh",
      "city_part": null,
      "zip": "48524-4224"
    },
    "currency": {
      "id": 111,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 267,
    "name": "Long Hoppe V",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "5norris@example.com",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Marlin Plains",
      "city": "South Jeremychester",
      "city_part": null,
      "zip": "18234-2548"
    },
    "currency": {
      "id": 111,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 268,
    "name": "Forest Grady",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "6kristy.littel@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Bernier Road",
      "city": "Lake Melinaton",
      "city_part": null,
      "zip": "94866"
    },
    "currency": {
      "id": 111,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 269,
    "name": "Violette Murray",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "7christel@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Verdie Forest",
      "city": "Franeckiview",
      "city_part": null,
      "zip": "26778-8176"
    },
    "currency": {
      "id": 111,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  }
]

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%3A0x0000560d122b0ca8%3E&q%5Bname_or_ic_or_dic_or_address_street_or_address_city_cont%5D=Angelina+Rice

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>
q={"name_or_ic_or_dic_or_address_street_or_address_city_cont"=>"Angelina Rice"}

Response

Status

200

Headers

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/"4fd8e77805e449fdc48eeb4dd831cd13"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=6f8e5cbb59402ba04eb6792893b85f34; path=/; expires=Wed, 18 Dec 2019 12:53:54 -0000; HttpOnly
X-Request-Id: aed920a0-7d01-4112-960f-8fe294098a79
X-Runtime: 0.007471
Content-Length: 388

Body

[
  {
    "id": 276,
    "name": "Angelina Rice",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "12santos_steuber@example.com",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Ratke Views",
      "city": "Aufderharberg",
      "city_part": null,
      "zip": "53973-3540"
    },
    "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] 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": "Elvin Torphy",
    "email": "44bryce@example.com",
    "dic": null,
    "is_taxable": false,
    "is_supplier": false,
    "is_customer": true,
    "currency_id": 118,
    "address_attributes": {
      "country_id": 1097,
      "city": "North Mauricebury",
      "street": "Sid Harbor",
      "zip": "33222"
    }
  }
}

Response

Status

200

Headers

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/"40f7e3d866e980351644cde59ecc52b9"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=77100fda6fbe407bc17a0f253e66fbd5; path=/; expires=Wed, 18 Dec 2019 12:53:56 -0000; HttpOnly
X-Request-Id: e0b91196-4c7c-4952-aeb5-d3b7b2360b4e
X-Runtime: 0.030740
Content-Length: 538

Body

{
  "id": 317,
  "name": "Elvin Torphy",
  "ic": "123456789",
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "44bryce@example.com",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Sid Harbor",
    "city": "North Mauricebury",
    "country_id": 1097,
    "zip": "33222",
    "country": {
      "id": 1097,
      "name": null
    }
  },
  "contacts": [

  ],
  "bank_accounts": [

  ],
  "currency_id": 118,
  "currency": {
    "id": 118,
    "iso_code": "EUR",
    "name": "Euro",
    "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

200

Headers

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/"21399f640cf7673e406309a2444f03fe"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1ee1b2dcea1d5adc175a6010e13e2f39; path=/; expires=Wed, 18 Dec 2019 12:53:58 -0000; HttpOnly
X-Request-Id: b69ec20d-37be-4126-a32e-6d1ff5704c5b
X-Runtime: 0.009289
Content-Length: 127

Body

[
  {
    "id": 41,
    "name": "Steven Kunze DVM"
  },
  {
    "id": 42,
    "name": "Sam Herman"
  },
  {
    "id": 43,
    "name": "Jere Bode"
  },
  {
    "id": 44,
    "name": "Dee Leannon"
  }
]

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

200

Headers

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/"a26aae4299de482902ff76561daad5ba"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=05822bb2e18d149811ffbf17fcace9c7; path=/; expires=Wed, 18 Dec 2019 12:54:04 -0000; HttpOnly
X-Request-Id: 0ccff9c1-6cf6-4dbe-a6a7-fb27655a4e7a
X-Runtime: 0.006076
Content-Length: 782

Body

{
  "id": "00000000-0000-0000-0000-000000000119",
  "size": 95,
  "content_type": "text/plain",
  "state": "Zpracovaná",
  "state_id": 3,
  "created_at": "St 18. prosinec 2019 11:54 +0100",
  "actuarial_id": null,
  "total_price": "1000.0",
  "partner_name": "Swaniawski Inc",
  "partner_ic": "78-553-0293",
  "partner_dic": "CZ13-481-2889",
  "partner_street": "West Pine",
  "partner_city": "South Odeliahaven",
  "partner_zip": "06044-0771",
  "partner_country_id": 1,
  "company_name": "Becker, Sporer and Veum",
  "company_ic": "26-237-9286",
  "company_dic": "CZ83-868-7128",
  "company_street": "Ward Divide",
  "company_city": "East Alysiaview",
  "company_zip": "91118",
  "company_country_id": 1,
  "payment_type": "checkout",
  "variable_symbol": "123456789",
  "currency_id": "1",
  "due_date_at": "28. 12. 2019",
  "issue_date_at": "18. 12. 2019",
  "uzp_date_at": "18. 12. 2019"
}

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

200

Headers

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/"0deb19accfbdde0ceeb847fbae2ce24a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=bc827468358396e11b5d16861a613f6f; path=/; expires=Wed, 18 Dec 2019 12:54:03 -0000; HttpOnly
X-Request-Id: d6dec734-861b-4b00-aea1-107be12d155a
X-Runtime: 0.007034
Content-Length: 611

Body

{
  "id": "00000000-0000-0000-0000-000000000113",
  "size": 95,
  "content_type": "text/plain",
  "state": "Nahraná",
  "state_id": 1,
  "created_at": "St 18. prosinec 2019 11:54 +0100",
  "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

200

Headers

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/"91ec054478c636937b41834d3ff2f826"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b70c10a41f0b47f7002c3491e1e6b677; path=/; expires=Wed, 18 Dec 2019 12:54:05 -0000; HttpOnly
X-Request-Id: 815f8c76-4a7f-4d5c-8621-0411f15bd11a
X-Runtime: 0.198654
Content-Length: 614

Body

{
  "id": "cc17d89c-7734-4e34-8867-f569aa1bba08",
  "size": 13706,
  "content_type": "text/plain",
  "state": "Nahraná",
  "state_id": 1,
  "created_at": "St 18. prosinec 2019 11:54 +0100",
  "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

200

Headers

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=b075f6cf7cc575f132f361d646541aae; path=/; expires=Wed, 18 Dec 2019 12:54:06 -0000; HttpOnly
X-Request-Id: 1ca3a685-169a-4bab-bfde-58ab06b4942b
X-Runtime: 0.004480
Content-Length: 296

Body

[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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"c95ca05a65eb1fa3526df7868746a5e0"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=a2003f4d8eeab8bf550b6dc38217cdf7; path=/; expires=Wed, 18 Dec 2019 12:54:02 -0000; HttpOnly
X-Request-Id: 1bcdf2c3-7cc8-4957-86c3-5ad52c6bb3a8
X-Runtime: 0.005813
Content-Length: 562

Body

[
  {
    "id": "00000000-0000-0000-0000-000000000106",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "St 18. prosinec 2019 11:54 +0100",
    "actuarial_id": null
  },
  {
    "id": "00000000-0000-0000-0000-000000000105",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "St 18. prosinec 2019 11:54 +0100",
    "actuarial_id": null
  },
  {
    "id": "00000000-0000-0000-0000-000000000104",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "St 18. prosinec 2019 11:54 +0100",
    "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"1629b84e4fe537b9efec740baa24621c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=07ad6a4fc0d4d9610b0c37112d2f7f92; path=/; expires=Wed, 18 Dec 2019 12:54:01 -0000; HttpOnly
X-Request-Id: 0b00b57c-9174-46e9-8623-bd84e92fa6cb
X-Runtime: 0.005964
Content-Length: 574

Body

[
  {
    "id": "00000000-0000-0000-0000-000000000094",
    "size": 95,
    "content_type": "text/plain",
    "state": "Ve zpracování",
    "state_id": 2,
    "created_at": "St 18. prosinec 2019 11:54 +0100",
    "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 18. prosinec 2019 11:54 +0100",
    "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 18. prosinec 2019 11:54 +0100",
    "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"0035a5b7b941de5108b15e00a02cafa1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1dc2567c68ddf63848f06d856502a1ee; path=/; expires=Wed, 18 Dec 2019 12:53:59 -0000; HttpOnly
X-Request-Id: fc5b4f64-b06f-465b-b4da-48e074047aad
X-Runtime: 0.007283
Content-Length: 553

Body

[
  {
    "id": "00000000-0000-0000-0000-000000000077",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 18. prosinec 2019 11:53 +0100",
    "actuarial_id": null
  },
  {
    "id": "00000000-0000-0000-0000-000000000078",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 18. prosinec 2019 11:53 +0100",
    "actuarial_id": null
  },
  {
    "id": "00000000-0000-0000-0000-000000000079",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 18. prosinec 2019 11:53 +0100",
    "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%3A0x0000560d122b0ca8%3E

Headers

Accept: application/json
Content-Type: application/json
Auth-Token: auth_token
Host: example.org
Cookie: 

Query Parameters

page=#<Capybara::Session:0x0000560d122b0ca8>

Response

Status

200

Headers

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/"8a8b6d03b7376e43a6749b2f825c88de"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=e7179402ec30d0b52dc54972e08932af; path=/; expires=Wed, 18 Dec 2019 12:53:59 -0000; HttpOnly
X-Request-Id: e1e6e646-7163-4915-9205-20a4c36099ec
X-Runtime: 0.005440
Content-Length: 553

Body

[
  {
    "id": "00000000-0000-0000-0000-000000000085",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 18. prosinec 2019 11:53 +0100",
    "actuarial_id": null
  },
  {
    "id": "00000000-0000-0000-0000-000000000084",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 18. prosinec 2019 11:53 +0100",
    "actuarial_id": null
  },
  {
    "id": "00000000-0000-0000-0000-000000000083",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 18. prosinec 2019 11:53 +0100",
    "actuarial_id": null
  }
]

Sessions

Get user authentication token

Parameters

Name Description
email Required Email
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=password

Response

Status

200

Headers

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/"ab59ee43d88859f6870ca22e138f9917"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c047c315-6816-46f0-8983-f9690d18b36c
X-Runtime: 0.050987
Content-Length: 71

Body

{
  "email": "test@test.com",
  "authentication_token": "6ZN9pBnE_zz_tdgxreyw"
}

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

200

Headers

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/"e2bfcdb38b3b7ccd3234d6f93b432a1f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f335a5fb6069ac7ff161a53abfce9418; path=/; expires=Wed, 18 Dec 2019 12:54:07 -0000; HttpOnly
X-Request-Id: cf6c03ba-6e40-458f-81bf-709421aea720
X-Runtime: 0.015538
Content-Length: 292

Body

[
  {
    "id": 4,
    "title": "Santana Hilpert",
    "created_at": "18. 12. 2019",
    "description": "magni",
    "image": null
  },
  {
    "id": 3,
    "title": "Stanford Botsford",
    "created_at": "18. 12. 2019",
    "description": "fugit",
    "image": null
  },
  {
    "id": 2,
    "title": "Elroy Osinski",
    "created_at": "18. 12. 2019",
    "description": "et",
    "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

200

Headers

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/"6948287d0042f5b5788c92dc062e59b5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=574c58cb8961ecc2c3fb6b9939180f61; path=/; expires=Wed, 18 Dec 2019 12:54:07 -0000; HttpOnly
X-Request-Id: 436cdd6c-665a-4f7f-a9b5-6eb86aceab5d
X-Runtime: 0.010140
Content-Length: 90

Body

[
  {
    "id": 1,
    "name": "kg",
    "description": "kilogram"
  },
  {
    "id": 2,
    "name": "h",
    "description": "hodina"
  }
]

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=1234

Response

Status

200

Headers

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/"17c7fcf80f986fc8b1a189af02a97b24"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0856f4a2-65ee-4a7e-97f9-95d0473faf72
X-Runtime: 0.004876
Content-Length: 71

Body

{
  "email": "test@test.com",
  "authentication_token": "3xKi_Y8VzFk5H_ivzbWy"
}

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=1234

Response

Status

200

Headers

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/"930d2fa5c1533c52c4c31d8f0f466534"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: f5866d98-799f-40bb-95b2-124d83abf315
X-Runtime: 0.161981
Content-Length: 71

Body

{
  "email": "test@test.com",
  "authentication_token": "vssMbwM3T_vxSBA-mVvp"
}

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=1234

Response

Status

200

Headers

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/"0c1ef9c346d7992cac52045318ad39b2"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5189edc6-a592-414c-9da1-c6102c6bfe82
X-Runtime: 0.133565
Content-Length: 71

Body

{
  "email": "test@test.com",
  "authentication_token": "sPH8XXtojjv3zxzW-Sv8"
}