sÚčto API Documentation

AccountingDiaries

List of accounting diaries

Parameters

Name Description
q[month_eq] Search by month
q[year_eq] Search by year

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"77ff38a8075e29d65a45bc7a04b767ce"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b55b596f972c250df97f2793a570c27a; path=/; expires=Mon, 21 May 2018 10:19:03 -0000; HttpOnly
X-Request-Id: 44806950-b058-475f-b0af-b0981f5d19fb
X-Runtime: 0.311960
Content-Length: 833

Body

{
  "total_months": 2,
  "months": [
    1,
    8
  ],
  "groups": [
    {
      "accounts": [
        {
          "id": null,
          "total": "20,00 Kč",
          "group_id": 1,
          "account_code": "6535",
          "account_name": "Keyon Hettinger DVM",
          "months_total": [
            {
              "table": {
                "total": "20",
                "month": 8
              }
            }
          ]
        },
        {
          "id": null,
          "total": "20,00 Kč",
          "group_id": 1,
          "account_code": "6993",
          "account_name": "Mr. Era Hagenes",
          "months_total": [
            {
              "table": {
                "total": "20",
                "month": 1
              }
            }
          ]
        }
      ],
      "group_name": "Výnosy",
      "group_id": 1,
      "total": "40,00 Kč"
    },
    {
      "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": "40,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": "40,00 Kč"
    }
  ]
}

List of accounting diaries available years

Request

Route

GET api/companies/3/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"52980a720e572464445634deb2a2434a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=60d39977ed556d2c2b437f8c26dce11b; path=/; expires=Mon, 21 May 2018 10:19:04 -0000; HttpOnly
X-Request-Id: ec99942f-eda0-44f6-8aa7-8db62646f8dd
X-Runtime: 0.010557
Content-Length: 6

Body

[
  2017
]

Search by month

Parameters

Name Description
q[month_eq] Search by month
q[year_eq] Search by year

Request

Route

GET api/companies/2/accounting_diaries?q%5Bmonth_eq%5D=5

Headers

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

Query Parameters

q%5Bmonth_eq%5D=5

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"c20611d1e564e6df657b6d8cdf2ca715"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=0725d89570bc7c9ce00276f5cccd347c; path=/; expires=Mon, 21 May 2018 10:19:03 -0000; HttpOnly
X-Request-Id: 6601eb2a-7ce3-44e3-b82c-abbd455a1a20
X-Runtime: 0.014565
Content-Length: 677

Body

{
  "total_months": 1,
  "months": [
    5
  ],
  "groups": [
    {
      "accounts": [
        {
          "id": null,
          "total": "20,00 Kč",
          "group_id": 0,
          "account_code": "6249",
          "account_name": "Miss Leon Hoeger",
          "months_total": [
            {
              "table": {
                "total": "20",
                "month": 5
              }
            }
          ]
        }
      ],
      "group_name": "Náklady",
      "group_id": 0,
      "total": "20,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": "-20,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": "-20,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/4/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"575e63357de11f71eb69f65f9442fd99"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=2de9dd0ec027b82df8d8e3bac81d96b6; path=/; expires=Mon, 21 May 2018 10:19:04 -0000; HttpOnly
X-Request-Id: 8f8f91f4-40ea-4a18-aee7-7ea5500095a6
X-Runtime: 0.131898
Content-Length: 3144

Body

[
  {
    "id": 7,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 7,
    "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": 8,
    "name": "Banka",
    "identifier": null,
    "account_type": 2,
    "currency_id": 7,
    "country_id": 11,
    "prefix": "B1",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 4,
      "country_id": 11,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2018-05-21T10:19:04.000+02:00",
      "updated_at": "2018-05-21T10:19:04.000+02:00",
      "bank_code": "1111",
      "bankable_id": 4,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 9,
    "name": "Mona Pouros",
    "identifier": null,
    "account_type": 2,
    "currency_id": 7,
    "country_id": 10,
    "prefix": "aut",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 5,
      "country_id": 10,
      "account": "Icie Leuschke",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-05-21T10:19:04.000+02:00",
      "updated_at": "2018-05-21T10:19:04.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 10,
    "name": "Miss Shanna Padberg",
    "identifier": null,
    "account_type": 2,
    "currency_id": 7,
    "country_id": 10,
    "prefix": "recusandae",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 6,
      "country_id": 10,
      "account": "Lucius Runolfsson",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-05-21T10:19:04.000+02:00",
      "updated_at": "2018-05-21T10:19:04.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 11,
    "name": "Rahsaan Ziemann",
    "identifier": null,
    "account_type": 2,
    "currency_id": 7,
    "country_id": 10,
    "prefix": "voluptatem",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 7,
      "country_id": 10,
      "account": "Tressie Hoeger",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-05-21T10:19:04.000+02:00",
      "updated_at": "2018-05-21T10:19:04.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 12,
    "name": "Hunter Goldner",
    "identifier": null,
    "account_type": 2,
    "currency_id": 7,
    "country_id": 10,
    "prefix": "nihil",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 8,
      "country_id": 10,
      "account": "Jamar Dare",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-05-21T10:19:04.000+02:00",
      "updated_at": "2018-05-21T10:19:04.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 13,
    "name": "Anastacio Greenholt",
    "identifier": null,
    "account_type": 2,
    "currency_id": 7,
    "country_id": 10,
    "prefix": "aperiam",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 9,
      "country_id": 10,
      "account": "Modesto Willms PhD",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-05-21T10:19:04.000+02:00",
      "updated_at": "2018-05-21T10:19:04.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "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/5/accounts?q%5Bname_or_identifier_cont%5D=Kiley+Hagenes+PhD

Headers

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

Query Parameters

q%5Bname_or_identifier_cont%5D=Kiley Hagenes PhD

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"bc8ce9628e3269d132fc023bd08414d2"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=6fc7ec0eaf3a04712545a8c998307ee9; path=/; expires=Mon, 21 May 2018 10:19:05 -0000; HttpOnly
X-Request-Id: fe081ae3-2d94-4039-90dc-a94222ad242f
X-Runtime: 0.020219
Content-Length: 458

Body

[
  {
    "id": 20,
    "name": "Kiley Hagenes PhD",
    "identifier": null,
    "account_type": 2,
    "currency_id": 8,
    "country_id": 12,
    "prefix": "et",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 15,
      "country_id": 12,
      "account": "Samara Haag",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-05-21T10:19:05.000+02:00",
      "updated_at": "2018-05-21T10:19:05.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"638c6dce367d127bacc0b34dab418cc2"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=a3bcec4c0758304e9ce3d53f43e9d5b9; path=/; expires=Mon, 21 May 2018 10:19:05 -0000; HttpOnly
X-Request-Id: 2d112fc9-560d-446f-96d6-abcb541879de
X-Runtime: 0.015197
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/16/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"b7a26b7f4e7ab4bebf439d8d2b0549e1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=e2b31ce43986530da10c7d460ca7ed86; path=/; expires=Mon, 21 May 2018 10:19:17 -0000; HttpOnly
X-Request-Id: 6167675e-495e-481c-b103-51d06a4a8fa0
X-Runtime: 0.028404
Content-Length: 1129

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": null,
  "uzp_date_at": "21. 05. 2018",
  "due_date_at": "31. 05. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "21. 05. 2018",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "currency": {
    "id": 14,
    "iso_code": "EUR",
    "name": "Euro",
    "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": 42,
    "name": "Banka",
    "identifier": null,
    "account_type": 2,
    "currency_id": 14,
    "country_id": 30,
    "prefix": "B1",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 26,
      "country_id": 30,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2018-05-21T10:19:15.000+02:00",
      "updated_at": "2018-05-21T10:19:15.000+02:00",
      "bank_code": "1111",
      "bankable_id": 16,
      "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/18/actuarials_ins/new?scan_id=a8e756d0-5ccf-11e8-921d-0242daacf3b2

Headers

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

Query Parameters

scan_id=a8e756d0-5ccf-11e8-921d-0242daacf3b2

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"d5ffaf9f6fc37f61f2bb991e97789fdd"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=e7b419f318a0b524d7d6a75b42108fd1; path=/; expires=Mon, 21 May 2018 10:19:20 -0000; HttpOnly
X-Request-Id: df9e289f-c652-473b-b96b-cfcef6bc48b3
X-Runtime: 0.196198
Content-Length: 1316

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": null,
  "uzp_date_at": "21. 05. 2018",
  "due_date_at": "31. 05. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "21. 05. 2018",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "currency": {
    "id": 15,
    "iso_code": "USD",
    "name": "United states dollar",
    "symbol": "$",
    "symbol_first": true
  },
  "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": 45,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 15,
    "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": "Roob Inc",
    "ic": "18",
    "dic": "CZ75-971-6296",
    "dic2": null,
    "street": "Myron Estate",
    "city": "Runolfsdottirfort",
    "zip": "73324-1272",
    "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/20/actuarials_ins/new?scan_id=aa43e0ac-5ccf-11e8-921d-0242daacf3b2

Headers

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

Query Parameters

scan_id=aa43e0ac-5ccf-11e8-921d-0242daacf3b2

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: your_session_key=20f34b8e8d6d01d9af24000118191b10; path=/; expires=Mon, 21 May 2018 10:19:22 -0000; HttpOnly
X-Request-Id: e1875aec-ebf6-44ee-abc2-66196efff19a
X-Runtime: 0.029349
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/14/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"3b570abb2c61a98d4aa8718e3a67c892"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=aba7dc541d97318168e8195cb49e9bee; path=/; expires=Mon, 21 May 2018 10:19:15 -0000; HttpOnly
X-Request-Id: 78fa243a-f7fd-4325-86c6-1552e6662d61
X-Runtime: 0.061592
Content-Length: 1278

Body

{
  "id": 142,
  "actuarial_type": "FA",
  "actuarial_number": "FV 142",
  "uzp_date_at": "21. 05. 2018",
  "due_date_at": "21. 05. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "21. 05. 2018",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "currency": {
    "id": 13,
    "iso_code": "EUR",
    "name": "Euro",
    "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": 37,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 13,
    "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": "Elisa Grimes Jr.",
      "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/22/actuarials_ins

Headers

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

Body

{
  "partner_id": 47,
  "actuarial_type_id": 315,
  "due_date_at": "2018-06-04",
  "account_id": 53,
  "currency_id": 17,
  "actuarial_number": "2015000001",
  "lines": [
    {
      "vat_id": 9,
      "lineable_type": "Actuarial",
      "name": "Rose Lueilwitz I",
      "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"806396e4ae269917c5350da054f35dad"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=6296bd78d21d8d70ec7843c1691970ea; path=/; expires=Mon, 21 May 2018 10:19:24 -0000; HttpOnly
X-Request-Id: f54a503f-f6bd-4c72-a9d3-1e2df98b2dfb
X-Runtime: 0.054608
Content-Length: 1333

Body

{
  "id": 312,
  "actuarial_type": "FA",
  "actuarial_number": "2015000001",
  "uzp_date_at": "21. 05. 2018",
  "due_date_at": "04. 06. 2018",
  "status": "Připravený",
  "status_id": 2,
  "issue_date_at": "21. 05. 2018",
  "base_price": "200.0",
  "end_price": "200.0",
  "remaining": "200.0",
  "currency": {
    "id": 17,
    "iso_code": "PLN",
    "name": "Polish zloty",
    "symbol": "zł",
    "symbol_first": false
  },
  "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": 53,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 17,
    "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": "Miss Antonette Brown",
    "ic": null,
    "dic": null,
    "dic2": null,
    "street": "Otilia Track",
    "city": "Sigridstad",
    "zip": "12844-0927",
    "is_taxable": false,
    "country_id": 38
  },
  "items": [
    {
      "id": 312,
      "quantity": "1.0",
      "unit_name": "h",
      "name": "Rose Lueilwitz I",
      "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/6/actuarials_ins

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"130cc4f4ffa761b47f4a6dfb02714fde"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f51480afe1a55e0de26bcc9dccac81e7; path=/; expires=Mon, 21 May 2018 10:19:07 -0000; HttpOnly
X-Request-Id: 7aa97b1c-99c9-4165-b79c-ca495f4a1e70
X-Runtime: 0.248928
Content-Length: 8035

Body

[
  {
    "id": 35,
    "actuarial_type": "FA",
    "actuarial_number": "FV 35",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "0.0",
    "end_price": "0.0",
    "remaining": "0.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 29,
    "actuarial_type": "FA",
    "actuarial_number": "FV 29",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 28,
    "actuarial_type": "FA",
    "actuarial_number": "FV 28",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 27,
    "actuarial_type": "FA",
    "actuarial_number": "FV 27",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 26,
    "actuarial_type": "FA",
    "actuarial_number": "FV 26",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 25,
    "actuarial_type": "FA",
    "actuarial_number": "FV 25",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 24,
    "actuarial_type": "FA",
    "actuarial_number": "FV 24",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 23,
    "actuarial_type": "FA",
    "actuarial_number": "FV 23",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 22,
    "actuarial_type": "FA",
    "actuarial_number": "FV 22",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 21,
    "actuarial_type": "FA",
    "actuarial_number": "FV 21",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 20,
    "actuarial_type": "FA",
    "actuarial_number": "FV 20",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 19,
    "actuarial_type": "FA",
    "actuarial_number": "FV 19",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 18,
    "actuarial_type": "FA",
    "actuarial_number": "FV 18",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 17,
    "actuarial_type": "FA",
    "actuarial_number": "FV 17",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 16,
    "actuarial_type": "FA",
    "actuarial_number": "FV 16",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 15,
    "actuarial_type": "FA",
    "actuarial_number": "FV 15",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 14,
    "actuarial_type": "FA",
    "actuarial_number": "FV 14",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 13,
    "actuarial_type": "FA",
    "actuarial_number": "FV 13",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 12,
    "actuarial_type": "FA",
    "actuarial_number": "FV 12",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 11,
    "actuarial_type": "FA",
    "actuarial_number": "FV 11",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 9,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 11,
      "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/12/actuarials_ins?q%5Bstatus_eq%5D=6

Headers

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

Query Parameters

q%5Bstatus_eq%5D=6

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"9c12353f04b217b700b095acab326e52"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=233b24bab27912e28808803d0e2c79db; path=/; expires=Mon, 21 May 2018 10:19:13 -0000; HttpOnly
X-Request-Id: 9827d199-c7b3-45a8-b1ac-ba90542db8f2
X-Runtime: 0.045341
Content-Length: 405

Body

[
  {
    "id": 141,
    "actuarial_type": "FA",
    "actuarial_number": "FV 141",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "Opravený",
    "status_id": 6,
    "issue_date_at": "21. 05. 2018",
    "base_price": "0.0",
    "end_price": "0.0",
    "remaining": "0.0",
    "variable_symbol": null,
    "currency": {
      "id": 12,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 23,
      "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/670/lines

Headers

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

Body

{
  "name": "Sammy Wintheiser",
  "quantity": "1.0",
  "unit_name": null,
  "unit_price": "200.0",
  "vat_id": 44,
  "tax": "20.0",
  "vat": {
    "id": 44,
    "value": "20.0",
    "valid_from": "2018-05-21",
    "valid_to": "2018-05-22",
    "created_at": "2018-05-21T10:21:12.000+02:00",
    "updated_at": "2018-05-21T10:21:12.000+02:00",
    "country_id": 1068,
    "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"0479df499dc452ef001781feef7527a1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=291c1f4cc71b9237642443fe0cb8d8bd; path=/; expires=Mon, 21 May 2018 10:21:13 -0000; HttpOnly
X-Request-Id: e7252860-8145-49aa-a76c-ec6befeefe83
X-Runtime: 0.025601
Content-Length: 197

Body

{
  "id": 1080,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Sammy Wintheiser",
  "vat_id": 44,
  "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/667/lines

Headers

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

Body

{
  "name": "Juliet Rippin",
  "unit_name": null,
  "quantity": "1.0",
  "unit_price": "200.0",
  "vat_id": 43,
  "tax": "20.0",
  "vat": {
    "id": 43,
    "value": "20.0",
    "valid_from": "2018-05-21",
    "valid_to": "2018-05-22",
    "created_at": "2018-05-21T10:21:12.000+02:00",
    "updated_at": "2018-05-21T10:21:12.000+02:00",
    "country_id": 1065,
    "creator_id": null,
    "updater_id": null,
    "vat_type_id": 43
  },
  "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"e44b8ed6d2786b4c8481abb638c13fe3"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=a3f4091ddca3f2b0af4f034d3d62f005; path=/; expires=Mon, 21 May 2018 10:21:12 -0000; HttpOnly
X-Request-Id: f885990c-cc83-43b7-aad3-b5ad957a89f5
X-Runtime: 0.023624
Content-Length: 194

Body

{
  "id": 1077,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Juliet Rippin",
  "vat_id": 43,
  "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/678/lines/1090

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
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
Cache-Control: no-cache
Set-Cookie: your_session_key=24f86d0d2e063c6e59364f83e6f53e7b; path=/; expires=Mon, 21 May 2018 10:21:14 -0000; HttpOnly
X-Request-Id: 1da0fd83-bc2c-45d5-9ce0-e09edc73a7c4
X-Runtime: 0.017513

Delete company's actuarial out line

Request

Route

DELETE api/companies/129/actuarials_outs/675/lines/1087

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
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
Cache-Control: no-cache
Set-Cookie: your_session_key=da3e3506b5d9b8c73673f19c7eacfbec; path=/; expires=Mon, 21 May 2018 10:21:14 -0000; HttpOnly
X-Request-Id: eecc91b7-371e-46dd-b97c-f3d5cef48711
X-Runtime: 0.020320

Get company's actuarial in line detail

Request

Route

GET api/companies/124/actuarials_ins/666/lines/1074

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"745dcd8597350c8341f18ac94dc3a89c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=e601a788348d2b54a073e42e13ebd378; path=/; expires=Mon, 21 May 2018 10:21:12 -0000; HttpOnly
X-Request-Id: ec6a2cbe-f6bc-4a76-a0fe-2f0f7f5386ae
X-Runtime: 0.019530
Content-Length: 196

Body

{
  "id": 1074,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Hollie Ondricka",
  "vat_id": 42,
  "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/663/lines/1071

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"a4d11ed80e38796eb37b15848fd1e0b9"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=3bdbe3abcc4f461da6d1ef4e7e68b3f8; path=/; expires=Mon, 21 May 2018 10:21:12 -0000; HttpOnly
X-Request-Id: 25d346f6-e1cb-4751-a599-ee63ba74382e
X-Runtime: 0.020553
Content-Length: 194

Body

{
  "id": 1071,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Joanie Dooley",
  "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 in lines

Request

Route

GET api/companies/122/actuarials_ins/662/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"643a086f1ecaf8bd2791bb2bf067303d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=63130756405eb9fde14b902757ed8053; path=/; expires=Mon, 21 May 2018 10:21:11 -0000; HttpOnly
X-Request-Id: b5b2a695-a2a0-42b2-9015-1ea48cece3d0
X-Runtime: 0.022827
Content-Length: 196

Body

[
  {
    "id": 1070,
    "quantity": "1.0",
    "unit_name": null,
    "name": "Brent Kulas I",
    "vat_id": 40,
    "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/659/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"c6f4c1e9c76706d758f3fd6fe7a8ffbd"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=c6f5b062fa7c9381b7cc126ad2239970; path=/; expires=Mon, 21 May 2018 10:21:11 -0000; HttpOnly
X-Request-Id: 777610e7-4a39-4aee-90a6-98808096a791
X-Runtime: 0.036417
Content-Length: 196

Body

[
  {
    "id": 1067,
    "quantity": "1.0",
    "unit_name": null,
    "name": "Delia Goodwin",
    "vat_id": 39,
    "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/674/lines/1084

Headers

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

Body

{
  "quantity": 5.0
}

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"a6b442a9d23bab4a90eace8ad1d5eaba"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=41709d4fa66ab8adeafe02124e3b35ed; path=/; expires=Mon, 21 May 2018 10:21:13 -0000; HttpOnly
X-Request-Id: fb6d519f-b2d6-48a0-af82-f421eba67622
X-Runtime: 0.023346
Content-Length: 193

Body

{
  "id": 1084,
  "quantity": "5.0",
  "unit_name": null,
  "name": "Willy Barton",
  "vat_id": 46,
  "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/671/lines/1081

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"a25b806b7139f034878b1c5688a7eb39"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=990004778dcb9b63cd96bd94290e4a55; path=/; expires=Mon, 21 May 2018 10:21:13 -0000; HttpOnly
X-Request-Id: 1a527c1d-2365-458c-9f45-e95b08eeec46
X-Runtime: 0.160236
Content-Length: 195

Body

{
  "id": 1081,
  "quantity": "5.0",
  "unit_name": null,
  "name": "Kevon Gorczany",
  "vat_id": 45,
  "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/34/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"c5762194676b08f73298d196619fdd4a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=98fba4ea10354942d0f0d7e5a6473479; path=/; expires=Mon, 21 May 2018 10:19:38 -0000; HttpOnly
X-Request-Id: 3c8a17dd-89e0-4946-b855-53c04e054a08
X-Runtime: 0.148431
Content-Length: 1302

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": "201800001",
  "uzp_date_at": "21. 05. 2018",
  "due_date_at": "31. 05. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "21. 05. 2018",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "variable_symbol": null,
  "currency": {
    "id": 23,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "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": 83,
    "name": "Banka",
    "identifier": null,
    "account_type": 2,
    "currency_id": 23,
    "country_id": 57,
    "prefix": "B1",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 49,
      "country_id": 57,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2018-05-21T10:19:36.000+02:00",
      "updated_at": "2018-05-21T10:19:36.000+02:00",
      "bank_code": "1111",
      "bankable_id": 34,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  "taxable": false,
  "pay": "0.0",
  "supplier": {
    "name": "Company 34",
    "ic": "34",
    "dic": null,
    "dic2": null,
    "street": "Roslyn Stream",
    "city": "Greenland",
    "zip": "66138",
    "is_taxable": false,
    "country_id": 57
  },
  "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/36/actuarials_outs/new?scan_id=b54c6852-5ccf-11e8-921d-0242daacf3b2

Headers

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

Query Parameters

scan_id=b54c6852-5ccf-11e8-921d-0242daacf3b2

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"364f195a724964fafbd0548740974eb4"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b63718456c496e7ced9c1271f5904ecf; path=/; expires=Mon, 21 May 2018 10:19:40 -0000; HttpOnly
X-Request-Id: e3f93ad3-94be-41b8-aaca-f336a7b2bb00
X-Runtime: 0.147111
Content-Length: 1462

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": "201800001",
  "uzp_date_at": "21. 05. 2018",
  "due_date_at": "31. 05. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "21. 05. 2018",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "variable_symbol": "123456789",
  "currency": {
    "id": 24,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  },
  "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": 87,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 24,
    "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": "Greenfelder and Sons",
    "email": "",
    "ic": "08-827-0067",
    "dic": "CZ99-432-8471",
    "dic2": null,
    "street": "Paucek Locks",
    "city": "Lake Alanna",
    "zip": "69120-1369",
    "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/38/actuarials_outs/new?scan_id=b6a64754-5ccf-11e8-921d-0242daacf3b2

Headers

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

Query Parameters

scan_id=b6a64754-5ccf-11e8-921d-0242daacf3b2

Response

Status

400

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: your_session_key=ff50c9d106e21a5358c021c6c51e4efa; path=/; expires=Mon, 21 May 2018 10:19:42 -0000; HttpOnly
X-Request-Id: e73003ba-f2ff-4680-8e79-3e42425317d4
X-Runtime: 0.016499
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/32/actuarials_outs/454

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"a2afe5249118c8868c7721b1e01a6073"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9d7d2d9236858c356c7c6e7b83f9d3e6; path=/; expires=Mon, 21 May 2018 10:19:36 -0000; HttpOnly
X-Request-Id: 1b05ec0b-1e7d-401f-a4ef-6d7b3ddaecee
X-Runtime: 0.030239
Content-Length: 1462

Body

{
  "id": 454,
  "actuarial_type": "FA",
  "actuarial_number": "FV 453",
  "uzp_date_at": "21. 05. 2018",
  "due_date_at": "21. 05. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "21. 05. 2018",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "variable_symbol": null,
  "currency": {
    "id": 22,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  },
  "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": 77,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 22,
    "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 32",
    "ic": "32",
    "dic": null,
    "dic2": null,
    "street": "Shanahan Summit",
    "city": "North Janessatown",
    "zip": "88925",
    "is_taxable": false,
    "country_id": 54
  },
  "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": "Mr. Zachariah Hermiston",
      "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/40/actuarials_outs

Headers

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

Body

{
  "partner_id": 84,
  "vat_regime_id": 623,
  "actuarial_type_id": 627,
  "due_date_at": "2018-06-04",
  "account_id": 97,
  "currency_id": 26,
  "actuarial_number": "2015000001",
  "lines": [
    {
      "vat_id": 18,
      "lineable_type": "Actuarial",
      "name": "Pete Crona V",
      "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"57923a8d9e90e864df1953c59b78f755"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=27cbafc67f68e3ca563a1468df99fd41; path=/; expires=Mon, 21 May 2018 10:19:45 -0000; HttpOnly
X-Request-Id: c1be2b64-0f99-41b2-a3cc-f3a4a0a41b96
X-Runtime: 0.061627
Content-Length: 1516

Body

{
  "id": 624,
  "actuarial_type": "FA",
  "actuarial_number": "2015000001",
  "uzp_date_at": "21. 05. 2018",
  "due_date_at": "04. 06. 2018",
  "status": "Připravený",
  "status_id": 2,
  "issue_date_at": "21. 05. 2018",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "variable_symbol": null,
  "currency": {
    "id": 26,
    "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": "40.0",
  "paypal_identifier": null,
  "account": {
    "id": 97,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 26,
    "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 40",
    "ic": "40",
    "dic": null,
    "dic2": null,
    "street": "Filiberto Springs",
    "city": "New Brittany",
    "zip": "19184-0782",
    "is_taxable": false,
    "country_id": 66
  },
  "customer": {
    "name": "Geraldine Bauch IV",
    "email": "2price_dicki@example.net",
    "ic": null,
    "dic": null,
    "dic2": null,
    "street": "Batz Parkway",
    "city": "Haleystad",
    "zip": "78861",
    "country_id": 65
  },
  "items": [
    {
      "id": 624,
      "quantity": "1.0",
      "unit_name": "h",
      "name": "Pete Crona V",
      "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/24/actuarials_outs

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"b3565be1bb13f96a2cec1dce167c55a8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b38a6182e5ab0ddc1ee554a9680778bc; path=/; expires=Mon, 21 May 2018 10:19:26 -0000; HttpOnly
X-Request-Id: 0c091e08-473f-4fd0-861a-ae0e15a7245a
X-Runtime: 0.327895
Content-Length: 8381

Body

[
  {
    "id": 347,
    "actuarial_type": "FA",
    "actuarial_number": "FV 346",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 341,
    "actuarial_type": "FA",
    "actuarial_number": "FV 340",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 340,
    "actuarial_type": "FA",
    "actuarial_number": "FV 339",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 339,
    "actuarial_type": "FA",
    "actuarial_number": "FV 338",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 338,
    "actuarial_type": "FA",
    "actuarial_number": "FV 337",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 337,
    "actuarial_type": "FA",
    "actuarial_number": "FV 336",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 336,
    "actuarial_type": "FA",
    "actuarial_number": "FV 335",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 335,
    "actuarial_type": "FA",
    "actuarial_number": "FV 334",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 334,
    "actuarial_type": "FA",
    "actuarial_number": "FV 333",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 333,
    "actuarial_type": "FA",
    "actuarial_number": "FV 332",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 332,
    "actuarial_type": "FA",
    "actuarial_number": "FV 331",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 331,
    "actuarial_type": "FA",
    "actuarial_number": "FV 330",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 330,
    "actuarial_type": "FA",
    "actuarial_number": "FV 329",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 329,
    "actuarial_type": "FA",
    "actuarial_number": "FV 328",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 328,
    "actuarial_type": "FA",
    "actuarial_number": "FV 327",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 327,
    "actuarial_type": "FA",
    "actuarial_number": "FV 326",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 326,
    "actuarial_type": "FA",
    "actuarial_number": "FV 325",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 325,
    "actuarial_type": "FA",
    "actuarial_number": "FV 324",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 324,
    "actuarial_type": "FA",
    "actuarial_number": "FV 323",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 323,
    "actuarial_type": "FA",
    "actuarial_number": "FV 322",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 18,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 48,
      "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/30/actuarials_outs?q%5Bstatus_eq%5D=7

Headers

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

Query Parameters

q%5Bstatus_eq%5D=7

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"e0ca1374f464a8b50d47c61c1b4222a5"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=28020ecd3727ef0d50f688e65937bd43; path=/; expires=Mon, 21 May 2018 10:19:33 -0000; HttpOnly
X-Request-Id: b2473f70-402e-437d-9672-491ec233b06a
X-Runtime: 0.020645
Content-Length: 420

Body

[
  {
    "id": 453,
    "actuarial_type": "FA",
    "actuarial_number": "FV 452",
    "uzp_date_at": "21. 05. 2018",
    "due_date_at": "21. 05. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "21. 05. 2018",
    "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
    },
    "customer": {
      "id": 60,
      "name": "Drobný nákup"
    }
  }
]

Pay actuarial and make cash voucher

Request

Route

GET api/companies/42/actuarials_outs/625/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"60d2e0b86a527668780adac60bbf6df8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=cbd8919ccb20abd4cd985ca4d3c01a10; path=/; expires=Mon, 21 May 2018 10:19:47 -0000; HttpOnly
X-Request-Id: 44495d4e-739d-4910-b081-3d90deae5e5d
X-Runtime: 0.224269
Content-Length: 21

Body

{
  "cash_voucher_id": 1
}

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
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
Content-Type: text/html
Cache-Control: no-cache
X-Request-Id: ce3189f3-066e-44b3-9785-d6feba83a5e3
X-Runtime: 0.019384
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
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
Content-Type: text/html
Cache-Control: no-cache
X-Request-Id: b05f7c9d-bbf6-4b4f-b469-4d1bd3804d0b
X-Runtime: 0.002027
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
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
Content-Type: application/json; charset=utf-8
ETag: W/"3afe8bb80a2a53307142a55d22918a4d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: bc13b425-34cd-4eec-9070-615f0ea0b059
X-Runtime: 0.028430
Content-Length: 299

Body

[
  {
    "id": 77,
    "name": "Czech Republic",
    "fuel_unit": "l",
    "length_unit": "km",
    "default_language": "en",
    "currency": {
      "id": 30,
      "iso_code": "CZK",
      "name": "Czech crown"
    }
  },
  {
    "id": 78,
    "name": "Slovak Republic",
    "fuel_unit": "l",
    "length_unit": "km",
    "default_language": "en",
    "currency": {
      "id": 31,
      "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"1359485966fccb777d2536f45ad9fae0"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1baec7bd-69b4-4bd0-8ab9-3208163bd8d7
X-Runtime: 0.023466
Content-Length: 254

Body

[
  {
    "id": 32,
    "iso_code": "GBP",
    "name": "Pound sterling",
    "symbol": "£",
    "symbol_first": true
  },
  {
    "id": 33,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  },
  {
    "id": 34,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  }
]

Admin Scans

Get scan data

Request

Route

GET api/admin/scans/bedd4b0c-5ccf-11e8-921d-0242daacf3b2/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
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
Content-Disposition: attachment; filename="empty2.png"
Content-Transfer-Encoding: binary
Content-Type: text/plain
Cache-Control: private
X-Request-Id: 0d1b0c56-3b2e-4651-93d0-aac7127090f2
X-Runtime: 0.003290
Content-Length: 95

Body

[BINARY CONTENT]

Get scan detail

Request

Route

GET api/admin/scans/be231afc-5ccf-11e8-921d-0242daacf3b2

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
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
Location: http://example.org/api/admin/scans/be231afc-5ccf-11e8-921d-0242daacf3b2
Content-Type: application/json; charset=utf-8
ETag: W/"e1e80265b97d1b9b8d598686a97b7084"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2b0070eb-3eca-4b5b-bd63-f004ff5ebc8a
X-Runtime: 0.004170
Content-Length: 83

Body

{
  "id": "be231afc-5ccf-11e8-921d-0242daacf3b2",
  "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

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"a4400499ee1ef91dab08762910230b4d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ce749625-d03b-4212-8ee5-1e6df94338f6
X-Runtime: 0.004416
Content-Length: 313

Body

[
  {
    "id": "bcffea6a-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "bcf3616e-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "bcd91502-5ccf-11e8-921d-0242daacf3b2",
    "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

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"8c2943442ef1c8b543e660f3ffae3935"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 38478be4-299d-4b82-8823-4d64f1abb2d3
X-Runtime: 0.006818
Content-Length: 622

Body

[
  {
    "id": "babcb97c-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "ba9b5f02-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "ba8e3318-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "ba806440-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "uploaded"
  },
  {
    "id": "ba65264e-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "uploaded"
  },
  {
    "id": "ba586b3e-5ccf-11e8-921d-0242daacf3b2",
    "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

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"aef0c5e4ec7b22b8ec8d6ecc3ebcc275"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 37f3b2b1-c2ee-45cc-933f-155b51347544
X-Runtime: 0.004361
Content-Length: 310

Body

[
  {
    "id": "bbb18f2e-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "uploaded"
  },
  {
    "id": "bb96033a-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "uploaded"
  },
  {
    "id": "bb842c00-5ccf-11e8-921d-0242daacf3b2",
    "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/c041b2c6-5ccf-11e8-921d-0242daacf3b2/proceed

Headers

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

Body

{
  "scan": {
    "total_price": "1000.10",
    "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": 103,
    "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": 103,
    "issue_date_at": "2018-05-21",
    "due_date_at": "2018-06-04",
    "uzp_date_at": "2018-05-21",
    "payment_type": 2,
    "variable_symbol": "20170123456",
    "currency_id": 45
  }
}

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Location: http://example.org/api/admin/scans/c041b2c6-5ccf-11e8-921d-0242daacf3b2
Content-Type: application/json; charset=utf-8
ETag: W/"5cf378a6416abd045928276b158ed74e"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: cca0e57c-db1f-42fe-9cf6-928d7bb4906b
X-Runtime: 0.013757
Content-Length: 655

Body

{
  "id": "c041b2c6-5ccf-11e8-921d-0242daacf3b2",
  "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": 103,
  "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": 103,
  "payment_type": "bank",
  "variable_symbol": "20170123456",
  "currency_id": "45",
  "due_date_at": "04. 06. 2018",
  "issue_date_at": "21. 05. 2018",
  "uzp_date_at": "21. 05. 2018"
}

Processing scan

Request

Route

PATCH api/admin/scans/bfa9afe4-5ccf-11e8-921d-0242daacf3b2/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
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
Location: http://example.org/api/admin/scans/bfa9afe4-5ccf-11e8-921d-0242daacf3b2
Content-Type: application/json; charset=utf-8
ETag: W/"d956b1196e9c808ea00c8aafdb7c92ce"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c227327f-4558-477f-9d0e-fd1c9ecfd63b
X-Runtime: 0.008254
Content-Length: 83

Body

{
  "id": "bfa9afe4-5ccf-11e8-921d-0242daacf3b2",
  "size": 95,
  "content_type": "text/plain"
}

ApiPermissions

List of resources with read permission

Request

Route

GET api/companies/57/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"10a2c1a7a71dfd4b5e26409228fe55f4"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=20d0eb2ca712ae5f779c26864377ae99; path=/; expires=Mon, 21 May 2018 10:19:59 -0000; HttpOnly
X-Request-Id: c8bd0525-d99a-497d-acb0-de11e1898ade
X-Runtime: 0.018022
Content-Length: 280

Body

[
  "ActuarialsIn",
  "ActuarialsOut",
  "CashVouchersIn",
  "CashVouchersOut",
  "CashVoucher",
  "CashBook",
  "DriveRecord",
  "Message",
  "Partner",
  "VatDeclaration",
  "Company",
  "Filter",
  "ExchangeRate",
  "Holiday",
  "User",
  "OwnExchangeRate",
  "Support",
  "Coupon",
  "GeneratorsActuarial",
  "GeneratorsVoucher",
  "Scan"
]

List of user abilities

Parameters

Name Description
resource Permissions by resource

Request

Route

GET api/companies/56/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"ecc4a83fa8a658fc060c30579da37649"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=2533e5b320311ae7984257ddc2f29f92; path=/; expires=Mon, 21 May 2018 10:19:59 -0000; HttpOnly
X-Request-Id: 6155d5fc-54ae-47aa-a1fd-ae0a07da8a24
X-Runtime: 0.151966
Content-Length: 60

Body

{
  "create": false,
  "read": false,
  "update": false,
  "destroy": false
}

Request

Route

GET api/companies/56/api_permissions?resource=ActuarialsIn

Headers

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

Query Parameters

resource=ActuarialsIn

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"d0797d13241b9cd77718153d239ce72f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=75d3389d7e7920410f722e563807d01f; path=/; expires=Mon, 21 May 2018 10:19:59 -0000; HttpOnly
X-Request-Id: fdcfccb6-c4d0-4dec-818d-e87a7e932ce1
X-Runtime: 0.016402
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/68/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"a12020a1fe499d3eb30cb2b4839fbdb3"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1176177ae32fdfcaae6f1ee7b0aca675; path=/; expires=Mon, 21 May 2018 10:20:14 -0000; HttpOnly
X-Request-Id: bbe75615-e707-4007-96a9-bc4ae08ae38d
X-Runtime: 0.041074
Content-Length: 565

Body

{
  "id": 107,
  "number": "106",
  "description": null,
  "total_price": "240,00 GBP",
  "base_price": "200,00 GBP",
  "transaction_date": "21. 05. 2018",
  "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": 761,
      "quantity": "1.0",
      "unit_name": null,
      "name": "Ms. Merl Skiles",
      "vat_id": 23,
      "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/62/cash_vouchers_ins

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"9f29732a267b0f8151a0296f61f83ddb"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ed9be29a88ee3d13ee8ae9a80a93aade; path=/; expires=Mon, 21 May 2018 10:20:04 -0000; HttpOnly
X-Request-Id: ad9bc53d-f207-47a4-9459-56302808ea7a
X-Runtime: 0.281707
Content-Length: 5057

Body

[
  {
    "id": 36,
    "number": "35",
    "description": null,
    "total_price": "0,00 USD",
    "base_price": "0,00 USD",
    "transaction_date": "21. 05. 2019",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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 USD",
    "base_price": "200,00 USD",
    "transaction_date": "21. 05. 2018",
    "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/70/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
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
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: your_session_key=729544b286e9426ce4615acc5bd0fb26; path=/; expires=Mon, 21 May 2018 10:20:17 -0000; HttpOnly
X-Request-Id: 23c91ad5-d4c4-41b1-bf38-7d09a2bef96c
X-Runtime: 0.013789
Content-Length: 0

Cash Vouchers Out

Company's cash voucher out detail

Request

Route

GET api/companies/80/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"abc09ad92965d696ea4a5997db0e66bf"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=0c325213149b64733e110e0649f2defe; path=/; expires=Mon, 21 May 2018 10:20:33 -0000; HttpOnly
X-Request-Id: 8b86365b-bc7f-4b22-9dba-978017402ed8
X-Runtime: 0.042109
Content-Length: 568

Body

{
  "id": 314,
  "number": "313",
  "description": null,
  "total_price": "240,00 PLN",
  "base_price": "200,00 PLN",
  "transaction_date": "21. 05. 2018",
  "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": 965,
      "quantity": "1.0",
      "unit_name": null,
      "name": "Mrs. Branson Adams",
      "vat_id": 29,
      "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/74/cash_vouchers_outs

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"ed9e4a6b95495bfd875ef9e64c13df3e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=46b617f9d8c633f9489737a975be5c86; path=/; expires=Mon, 21 May 2018 10:20:24 -0000; HttpOnly
X-Request-Id: 56ab2b56-fbe4-4672-a5f4-dc5fb4dcd261
X-Runtime: 0.300686
Content-Length: 5097

Body

[
  {
    "id": 243,
    "number": "242",
    "description": null,
    "total_price": "0,00 EUR",
    "base_price": "0,00 EUR",
    "transaction_date": "21. 05. 2019",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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 EUR",
    "base_price": "200,00 EUR",
    "transaction_date": "21. 05. 2018",
    "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/82/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
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
Content-Type: text/plain; charset=utf-8
Cache-Control: no-cache
Set-Cookie: your_session_key=ecc6ae215506eba477a28f233df7d53b; path=/; expires=Mon, 21 May 2018 10:20:36 -0000; HttpOnly
X-Request-Id: d1ca8864-79bd-465a-93ec-9137ae1c2e36
X-Runtime: 0.013509
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
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
Content-Type: application/json; charset=utf-8
ETag: W/"bd0a30a66b86aaa9f2182a0fa65b019e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=effb27e70f0c3db6ea4250c868101ed5; path=/; expires=Mon, 21 May 2018 10:21:10 -0000; HttpOnly
X-Request-Id: bc5fadd2-a6b9-451a-8879-327231a9449a
X-Runtime: 0.014651
Content-Length: 305

Body

{
  "id": 90,
  "first_name": "Aurelio",
  "last_name": "Tremblay",
  "bank_account": null,
  "birthday": "2018-05-21",
  "status": null,
  "nationality": null,
  "place_of_birth": null,
  "personal_number": "21. 05. 2018",
  "identification_number": null,
  "employee_number": "number_21. 05. 2018",
  "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"b3374b1b20a531e553242ad153622c3b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9f0f81a8dd3453af178f45d335f9d208; path=/; expires=Mon, 21 May 2018 10:20:41 -0000; HttpOnly
X-Request-Id: 20ff2a74-3ddb-419b-9ca6-beb7f6d4d5e0
X-Runtime: 0.137651
Content-Length: 198

Body

{
  "id": 96,
  "name": "Company 96",
  "ic": "96",
  "is_taxable": false,
  "country_id": 1005,
  "email": "company-96@sucto.cz",
  "address": {
    "street": "Koch Ways",
    "city": "North Freeman",
    "city_part": null,
    "zip": "52292-9673"
  }
}

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"d595237850e9d811bf5b364d92b7e881"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=65f26a76051ece221578baf784acc3d9; path=/; expires=Mon, 21 May 2018 10:20:40 -0000; HttpOnly
X-Request-Id: 0ec622ef-f901-48d9-9e12-7ddeca224511
X-Runtime: 0.034180
Content-Length: 322

Body

[
  {
    "id": 86,
    "name": "Company 86",
    "ic": "86",
    "is_taxable": false,
    "country_id": 1001,
    "email": "company-86@sucto.cz"
  },
  {
    "id": 87,
    "name": "Company 87",
    "ic": "87",
    "is_taxable": false,
    "country_id": 1000,
    "email": "company-87@sucto.cz"
  },
  {
    "id": 88,
    "name": "Company 88",
    "ic": "88",
    "is_taxable": false,
    "country_id": 1000,
    "email": "company-88@sucto.cz"
  }
]

List of company's employees

Parameters

Name Description
page Page

Request

Route

GET api/companies/115/employees

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"ada2baf42471c401dbe2969cbb61963b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=72f2b9fd76dd2f8a47674085fa2b4364; path=/; expires=Mon, 21 May 2018 10:21:09 -0000; HttpOnly
X-Request-Id: 062a0b03-97a1-43a9-a8f9-4cdfa685e5d8
X-Runtime: 0.136306
Content-Length: 2476

Body

[
  {
    "id": 10,
    "first_name": "Devyn",
    "last_name": "Sauer",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 11,
    "first_name": "Cordie",
    "last_name": "Johnston",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 12,
    "first_name": "Dayna",
    "last_name": "Franecki",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 13,
    "first_name": "Leilani",
    "last_name": "O'Reilly",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 14,
    "first_name": "Barbara",
    "last_name": "Auer",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 15,
    "first_name": "Eino",
    "last_name": "Oberbrunner",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 16,
    "first_name": "Rhea",
    "last_name": "Gibson",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 17,
    "first_name": "Stanford",
    "last_name": "DuBuque",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 18,
    "first_name": "Abdiel",
    "last_name": "Jaskolski",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 19,
    "first_name": "Hailey",
    "last_name": "Lemke",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 20,
    "first_name": "Zachary",
    "last_name": "Padberg",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 21,
    "first_name": "Maxime",
    "last_name": "Swaniawski",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 22,
    "first_name": "Marisa",
    "last_name": "Tromp",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 23,
    "first_name": "Antone",
    "last_name": "Carroll",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 24,
    "first_name": "Karli",
    "last_name": "Johnston",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 25,
    "first_name": "Danyka",
    "last_name": "Effertz",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 26,
    "first_name": "Miles",
    "last_name": "Medhurst",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 27,
    "first_name": "Janae",
    "last_name": "Bode",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 28,
    "first_name": "Dereck",
    "last_name": "Lehner",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  },
  {
    "id": 29,
    "first_name": "Pauline",
    "last_name": "Nolan",
    "personal_number": "21. 05. 2018",
    "birthday": "2018-05-21",
    "sex": "Muž"
  }
]

Countries

Detail of country

Request

Route

GET api/countries/1012

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"ffd0313fde97a17d8935b8499087edfe"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=dd5b29658ceebc0cd5107b8139214623; path=/; expires=Mon, 21 May 2018 10:20:41 -0000; HttpOnly
X-Request-Id: 242cda66-fd53-49da-b570-44a9c602eb10
X-Runtime: 0.028938
Content-Length: 153

Body

{
  "id": 1012,
  "name": "Czech Republic",
  "fuel_unit": "l",
  "length_unit": "km",
  "default_language": "en",
  "currency": {
    "id": 67,
    "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"ee7937cbc5c3c01a01992ce35c1dde7b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9499ce5b881cac267be97a3f5e4842eb; path=/; expires=Mon, 21 May 2018 10:20:41 -0000; HttpOnly
X-Request-Id: bda1abb0-7919-4375-a807-a64764d176be
X-Runtime: 0.026742
Content-Length: 303

Body

[
  {
    "id": 1008,
    "name": "Czech Republic",
    "fuel_unit": "l",
    "length_unit": "km",
    "default_language": "en",
    "currency": {
      "id": 65,
      "iso_code": "CZK",
      "name": "Czech crown"
    }
  },
  {
    "id": 1009,
    "name": "Slovak Republic",
    "fuel_unit": "l",
    "length_unit": "km",
    "default_language": "en",
    "currency": {
      "id": 66,
      "iso_code": "EUR",
      "name": "Euro"
    }
  }
]

List of country's vat regimes

Request

Route

GET api/countries/1142/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"9a84c15159ad188c5f5426d8fdff0eba"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=957978f6440e99dbcebc7f1cfb4199f7; path=/; expires=Mon, 21 May 2018 10:21:32 -0000; HttpOnly
X-Request-Id: 01a290a1-1f1e-48b5-a0ed-946d7e0b364c
X-Runtime: 0.032670
Content-Length: 154

Body

[
  {
    "id": 678,
    "name": "Tuzemská plnění"
  },
  {
    "id": 679,
    "name": "Přenesení daňové povinnosti"
  },
  {
    "id": 680,
    "name": "EU zboží"
  },
  {
    "id": 681,
    "name": "EU služba"
  }
]

List of country's vats

Request

Route

GET api/countries/1145/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"32bfc46e049e2b8f7ad991f0a8c84534"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ab867bc66ea4af986d615074a2a41f7f; path=/; expires=Mon, 21 May 2018 10:21:32 -0000; HttpOnly
X-Request-Id: c9abe46e-5c1d-46ec-8f90-9932a9a27a86
X-Runtime: 0.133779
Content-Length: 226

Body

[
  {
    "id": 49,
    "value": "20.0",
    "valid_from": "2018-05-21",
    "valid_to": "2018-05-22"
  },
  {
    "id": 51,
    "value": "19.0",
    "valid_from": "2018-05-21",
    "valid_to": "2018-05-22"
  },
  {
    "id": 50,
    "value": "11.0",
    "valid_from": "2018-05-21",
    "valid_to": "2018-05-22"
  }
]

List of current country's vats

Request

Route

GET api/countries/1154/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"f969b88150601351e00c53049d003ba7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=091aed241aea2ea32b28a0e4dca657f9; path=/; expires=Mon, 21 May 2018 10:21:32 -0000; HttpOnly
X-Request-Id: 506e087f-eb74-42c5-b6ae-503d3e434a02
X-Runtime: 0.009694
Content-Length: 68

Body

[
  {
    "id": 61,
    "value": "21.0",
    "valid_from": "2018-05-21",
    "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"f9fe5595582ebab416e441aa72599fba"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ddf37343a6b03d1e710b0f3cbafec89e; path=/; expires=Mon, 21 May 2018 10:21:31 -0000; HttpOnly
X-Request-Id: c2c649bb-923d-40e7-9b51-3ac1f3f1ddbf
X-Runtime: 0.023509
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

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"b1ee328a594bdb22863f7c4093fba839"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=cd473f4d781f7b7e2b950eda0e6310b8; path=/; expires=Mon, 21 May 2018 10:20:42 -0000; HttpOnly
X-Request-Id: 92365193-49c3-4f86-8d77-810bf25316c5
X-Runtime: 0.172978
Content-Length: 246

Body

[
  {
    "id": 69,
    "iso_code": "GBP",
    "name": "Pound sterling",
    "symbol": "£",
    "symbol_first": true
  },
  {
    "id": 70,
    "iso_code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "symbol_first": true
  },
  {
    "id": 71,
    "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?q%5Biso_code_cont%5D=CZK

Headers

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

Query Parameters

q%5Biso_code_cont%5D=CZK

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"6a377e5f6c11813bf6ca5a61e248726e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=4ec03988c334de555f6c3eca27e4ea7d; path=/; expires=Mon, 21 May 2018 10:20:42 -0000; HttpOnly
X-Request-Id: 8992c0c7-e2c2-4de5-8eb0-07f4c5865b3a
X-Runtime: 0.013528
Content-Length: 85

Body

[
  {
    "id": 74,
    "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"e6ed34c615ba1ee7f8008f5268f2f056"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=5840d7ed57998afba89521eae77a1271; path=/; expires=Mon, 21 May 2018 10:20:42 -0000; HttpOnly
X-Request-Id: ef1a2988-f1ba-4f9e-98f8-da6fc165bd68
X-Runtime: 0.034910
Content-Length: 118

Body

{
  "system_informations": {
    "id": 1,
    "title": "Roselyn Murazik",
    "created_at": "21. 05. 2018",
    "description": "in",
    "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"6916754de17526843e521dbf39a5247d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=095ac21e6e121cb3eff49b687aa34b0e; path=/; expires=Mon, 21 May 2018 10:20:43 -0000; HttpOnly
X-Request-Id: 12addeec-7422-4ff0-a576-91a433a65b10
X-Runtime: 0.029246
Content-Length: 951

Body

[
  {
    "id": 13,
    "value": "Mr. Kennith Zieme",
    "company_id": 98,
    "created_at": "2018-05-21T10:20:42.000+02:00",
    "updated_at": "2018-05-21T10:20:42.000+02:00",
    "parent_id": null,
    "lft": 1,
    "rgt": 2,
    "position": null
  },
  {
    "id": 14,
    "value": "Wanda Wyman",
    "company_id": 98,
    "created_at": "2018-05-21T10:20:42.000+02:00",
    "updated_at": "2018-05-21T10:20:42.000+02:00",
    "parent_id": null,
    "lft": 3,
    "rgt": 4,
    "position": null
  },
  {
    "id": 15,
    "value": "Marlin Herzog",
    "company_id": 98,
    "created_at": "2018-05-21T10:20:43.000+02:00",
    "updated_at": "2018-05-21T10:20:43.000+02:00",
    "parent_id": null,
    "lft": 5,
    "rgt": 6,
    "position": null
  },
  {
    "id": 16,
    "value": "Marquise Wunsch",
    "company_id": 98,
    "created_at": "2018-05-21T10:20:43.000+02:00",
    "updated_at": "2018-05-21T10:20:43.000+02:00",
    "parent_id": null,
    "lft": 7,
    "rgt": 8,
    "position": null
  },
  {
    "id": 17,
    "value": "Trystan Robel",
    "company_id": 98,
    "created_at": "2018-05-21T10:20:43.000+02:00",
    "updated_at": "2018-05-21T10:20:43.000+02:00",
    "parent_id": null,
    "lft": 9,
    "rgt": 10,
    "position": null
  }
]

Logbook

Company's car

Request

Route

GET api/companies/60/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"58946bcaf78d01644d19cee6e7950f10"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=5258de14519edd4816befee818e8c652; path=/; expires=Mon, 21 May 2018 10:20:01 -0000; HttpOnly
X-Request-Id: 74d228fc-1ed8-46aa-aae5-867b8373a7c0
X-Runtime: 0.016105
Content-Length: 319

Body

{
  "id": 7,
  "number_plate": "05-680-6476",
  "description": "Libero deleniti aut delectus nobis.",
  "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": "Chaya Powlowski"
  }
}

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"6e106d44c30221b2541f337733987c24"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=dc1d820bf28a2f695e30bb0618aa906f; path=/; expires=Mon, 21 May 2018 10:21:05 -0000; HttpOnly
X-Request-Id: 24b1a0b1-0311-404d-a568-635fbc48b9ed
X-Runtime: 0.131837
Content-Length: 2765

Body

{
  "id": 75,
  "is_private": null,
  "start_location": "74330 Steve Rest",
  "end_location": "1372 Janis Ramp",
  "start_time": "2018-05-21T10:20:59.000+02:00",
  "end_time": "2018-05-21T14:20:59.000+02:00",
  "and_back": null,
  "trip_length": 300,
  "start_tachometer": 0,
  "end_tachometer": 500,
  "purpose": "Fugit atque quis molestiae totam deleniti in harum et.",
  "car": {
    "id": 17,
    "number_plate": "37-953-7920",
    "description": "Ex eum et explicabo quam nostrum.",
    "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": 17,
      "name": "Arturo Tromp II"
    }
  },
  "employee": {
    "id": 7,
    "first_name": "Maggie",
    "last_name": "Kuhic",
    "bank_account": null,
    "birthday": "2018-05-21",
    "status": null,
    "nationality": null,
    "place_of_birth": null,
    "personal_number": "21. 05. 2018",
    "identification_number": null,
    "employee_number": "number_21. 05. 2018",
    "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": "Fugit atque quis molestiae totam deleniti in harum et."
      },
      "car": {
        "id": 17,
        "description": "Ex eum et explicabo quam nostrum."
      },
      "employee": {
        "id": 7,
        "first_name": "Maggie",
        "last_name": "Kuhic"
      }
    },
    {
      "id": 220,
      "drive_record_id": 75,
      "price": "120.0",
      "end_price": "120.0",
      "vat_value": "20.0",
      "drive_record": {
        "id": 75,
        "purpose": "Fugit atque quis molestiae totam deleniti in harum et."
      },
      "car": {
        "id": 17,
        "description": "Ex eum et explicabo quam nostrum."
      },
      "employee": {
        "id": 7,
        "first_name": "Maggie",
        "last_name": "Kuhic"
      }
    }
  ],
  "drive_refuels": [
    {
      "id": 223,
      "place": "340 Waelchi Courts",
      "amount": "40.0",
      "price": "123.0",
      "end_price": "123.0",
      "vat_id": 36,
      "unit_price": 20,
      "vat_value": "20.0",
      "tachometer_value": 333,
      "drive_record": {
        "id": 75,
        "purpose": "Fugit atque quis molestiae totam deleniti in harum et."
      },
      "car": {
        "id": 17,
        "description": "Ex eum et explicabo quam nostrum."
      },
      "employee": {
        "id": 7,
        "first_name": "Maggie",
        "last_name": "Kuhic"
      }
    },
    {
      "id": 224,
      "place": "53581 Marshall Square",
      "amount": "40.0",
      "price": "123.0",
      "end_price": "123.0",
      "vat_id": 36,
      "unit_price": 20,
      "vat_value": "20.0",
      "tachometer_value": 333,
      "drive_record": {
        "id": 75,
        "purpose": "Fugit atque quis molestiae totam deleniti in harum et."
      },
      "car": {
        "id": 17,
        "description": "Ex eum et explicabo quam nostrum."
      },
      "employee": {
        "id": 7,
        "first_name": "Maggie",
        "last_name": "Kuhic"
      }
    },
    {
      "id": 225,
      "place": "729 Carmela Divide",
      "amount": "40.0",
      "price": "123.0",
      "end_price": "123.0",
      "vat_id": 36,
      "unit_price": 20,
      "vat_value": "20.0",
      "tachometer_value": 333,
      "drive_record": {
        "id": 75,
        "purpose": "Fugit atque quis molestiae totam deleniti in harum et."
      },
      "car": {
        "id": 17,
        "description": "Ex eum et explicabo quam nostrum."
      },
      "employee": {
        "id": 7,
        "first_name": "Maggie",
        "last_name": "Kuhic"
      }
    }
  ]
}

List of company's cars

Request

Route

GET api/companies/58/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"10a42247834b5b4cba297e7c7f99032c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=19400938c91c38665241f9a19cf64fd2; path=/; expires=Mon, 21 May 2018 10:20:00 -0000; HttpOnly
X-Request-Id: 3de94435-adf7-46de-a21c-52ab3a50278a
X-Runtime: 0.044493
Content-Length: 992

Body

[
  {
    "id": 1,
    "number_plate": "94-641-5239",
    "description": "Eos culpa et ab.",
    "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": "Vernie Emmerich"
    }
  },
  {
    "id": 2,
    "number_plate": "17-963-7018",
    "description": "Sunt sed tenetur voluptates adipisci itaque officia tempora deserunt.",
    "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": "Bill O'Reilly"
    }
  },
  {
    "id": 3,
    "number_plate": "64-952-1368",
    "description": "Cum accusantium et ea deserunt perferendis odit quidem.",
    "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": 3,
      "name": "Gordon Wisozk"
    }
  }
]

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"1a2967f6f9d8b1d87ae0478f42144930"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=aad4378b1201e6a938b80d9db6b14b33; path=/; expires=Mon, 21 May 2018 10:20:43 -0000; HttpOnly
X-Request-Id: 2575588d-f91b-4e7f-b0a4-1296b58596d6
X-Runtime: 0.027946
Content-Length: 78

Body

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

List of company's drive expenses

Parameters

Name Description
page Page

Request

Route

GET api/companies/101/drive_expenses

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"7f699ffb1b3a80e0aa44e8a6e3073c65"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=8477504e36b245afe4d0eee1d3bc85aa; path=/; expires=Mon, 21 May 2018 10:20:45 -0000; HttpOnly
X-Request-Id: 5192ec72-a474-42ea-996f-c705236b3208
X-Runtime: 0.063604
Content-Length: 6301

Body

[
  {
    "id": 34,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 33,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 32,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 31,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 30,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 29,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 28,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 27,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 26,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 25,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 24,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 23,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 22,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 21,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 20,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 19,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 18,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 17,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 16,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  },
  {
    "id": 15,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Inventore dolor soluta hic aut cupiditate."
    },
    "car": {
      "id": 13,
      "description": "Beatae excepturi perferendis sunt quia rerum nisi in ea."
    },
    "employee": {
      "id": 3,
      "first_name": "Alice",
      "last_name": "Zulauf"
    }
  }
]

List of company's drive records

Parameters

Name Description
page Page

Request

Route

GET api/companies/105/drive_records

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"6eda7d0ac51b77deeaaf89ed98cc505f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=26906b6b46b7d7690859c3c1dc8d284f; path=/; expires=Mon, 21 May 2018 10:20:53 -0000; HttpOnly
X-Request-Id: 51dda2a5-b858-48d7-ae59-9ba86bf265f3
X-Runtime: 0.048656
Content-Length: 7337

Body

[
  {
    "id": 34,
    "purpose": "Hic non illo et non.",
    "start_location": "6696 Satterfield Centers",
    "end_location": "3336 Brando Groves",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 33,
    "purpose": "Quas et ut incidunt labore delectus adipisci qui iusto.",
    "start_location": "596 Russel Light",
    "end_location": "735 Willms Plains",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 32,
    "purpose": "Id distinctio molestias rerum facilis.",
    "start_location": "10073 Halie Dale",
    "end_location": "92243 Ruecker Locks",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 31,
    "purpose": "Aspernatur blanditiis laboriosam animi magni.",
    "start_location": "48659 Lind Club",
    "end_location": "4765 Larson Views",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 30,
    "purpose": "Tempora quasi et voluptatibus dolor qui enim consectetur.",
    "start_location": "1813 Haag Isle",
    "end_location": "994 Lang Locks",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 29,
    "purpose": "Iusto molestiae omnis ad officiis quae.",
    "start_location": "5545 Heaney Centers",
    "end_location": "2469 Martine River",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 28,
    "purpose": "Ut voluptatem maiores vel dolores ex.",
    "start_location": "817 Padberg Green",
    "end_location": "452 Katelin Hill",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 27,
    "purpose": "Expedita impedit consequatur quasi.",
    "start_location": "791 Bosco Street",
    "end_location": "671 Fay Land",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 26,
    "purpose": "Non eum pariatur rerum id ut animi quaerat autem.",
    "start_location": "7100 Gutkowski Divide",
    "end_location": "41267 Rachel River",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 25,
    "purpose": "Tempore omnis rerum architecto omnis eos ad illum dolorum.",
    "start_location": "1992 Bahringer Circle",
    "end_location": "54193 Meggie Square",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 24,
    "purpose": "Esse qui tempora ab praesentium voluptas iste.",
    "start_location": "7312 Erdman Flats",
    "end_location": "4238 Karli Extension",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 23,
    "purpose": "Praesentium cum mollitia atque at omnis.",
    "start_location": "92687 Felicita Walk",
    "end_location": "199 Kellen Dam",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 22,
    "purpose": "Quis voluptatem ut nihil provident est temporibus qui mollitia.",
    "start_location": "266 Xavier Summit",
    "end_location": "6298 Ankunding Row",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 21,
    "purpose": "Veniam tenetur voluptatem aperiam ad laudantium.",
    "start_location": "14758 Will Wall",
    "end_location": "890 Edyth Creek",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 20,
    "purpose": "Magni ad dolorum iusto doloribus.",
    "start_location": "837 Juana Ramp",
    "end_location": "7115 Ankunding Well",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 19,
    "purpose": "Accusantium error ut fugiat labore.",
    "start_location": "2004 Emma Ridges",
    "end_location": "92911 Kilback Dale",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 18,
    "purpose": "Eum ut consequatur deleniti alias tempora aliquam.",
    "start_location": "53670 Franecki Plains",
    "end_location": "40348 Orie Rapids",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 17,
    "purpose": "Ab aut est qui quas esse saepe error.",
    "start_location": "956 Aniyah Groves",
    "end_location": "932 Balistreri Ferry",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 16,
    "purpose": "Est sapiente sunt suscipit est dolorem necessitatibus minima quia.",
    "start_location": "847 Euna Mews",
    "end_location": "361 Smitham Way",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  },
  {
    "id": 15,
    "purpose": "Aperiam consequatur ipsum itaque.",
    "start_location": "33180 Williamson Falls",
    "end_location": "85821 Einar Rapids",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Eum cumque laudantium numquam aperiam consequatur accusantium quibusdam."
    },
    "employee": {
      "id": 5,
      "first_name": "Arlene",
      "last_name": "Emard"
    }
  }
]

List of company's drive refuels

Parameters

Name Description
page Page

Request

Route

GET api/companies/111/drive_refuels

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"d8ab460f3048dd39ed9e8842872b7331"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=e093061cc45c951d628f787a7e7da378; path=/; expires=Mon, 21 May 2018 10:21:07 -0000; HttpOnly
X-Request-Id: e25123bc-ab36-44e2-80c6-465f2c9a4911
X-Runtime: 0.163864
Content-Length: 7307

Body

[
  {
    "id": 363,
    "place": "822 Haag Ports",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 362,
    "place": "8989 Lisette Drives",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 361,
    "place": "3484 Barney Mews",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 37,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 360,
    "place": "47726 Hulda Stravenue",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 359,
    "place": "201 Seth Squares",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 358,
    "place": "200 Feest Causeway",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 357,
    "place": "722 Alayna Viaduct",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 356,
    "place": "761 Jaskolski Bypass",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 355,
    "place": "57204 Chasity Unions",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 354,
    "place": "4522 Durgan Extension",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 353,
    "place": "3962 Leann Station",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 352,
    "place": "1591 Beulah Estates",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 351,
    "place": "87218 D'Amore Greens",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 350,
    "place": "95254 Filiberto Burg",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 349,
    "place": "877 Schuppe Circle",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 348,
    "place": "38825 Lindgren Passage",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 347,
    "place": "46176 Jettie Lodge",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 346,
    "place": "95905 Wade Neck",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 345,
    "place": "9676 Ledner Corners",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  },
  {
    "id": 344,
    "place": "3123 Jack Burg",
    "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": 110,
      "purpose": "Porro qui et autem sequi officia in natus."
    },
    "car": {
      "id": 18,
      "description": "Ut rem ratione sunt molestiae."
    },
    "employee": {
      "id": 8,
      "first_name": "Zula",
      "last_name": "Hane"
    }
  }
]

Partners

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

{
  "name": "Josiah Cartwright",
  "email": "23curt@example.com",
  "ic": "123456789",
  "dic": null,
  "is_taxable": false,
  "is_supplier": false,
  "is_customer": true,
  "currency_id": 101,
  "address_attributes": {
    "country_id": 1089,
    "city": "Balistreriburgh",
    "street": "Jaqueline Turnpike",
    "zip": "27000-9916"
  },
  "postal_address_attributes": {
    "country_id": 1089,
    "city": "Balistreriburgh",
    "street": "Jaqueline Turnpike",
    "zip": "27000-9916"
  }
}

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"e96aa706317b9796ccd207d58120b8b7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=47d9b617d5efe545920f7a7b2da72000; path=/; expires=Mon, 21 May 2018 10:21:16 -0000; HttpOnly
X-Request-Id: 03a5a9d7-9d86-4da3-b96a-59c6402786c3
X-Runtime: 0.043917
Content-Length: 639

Body

{
  "id": 291,
  "name": "Josiah Cartwright",
  "ic": "123456789",
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "23curt@example.com",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "en",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Jaqueline Turnpike",
    "city": "Balistreriburgh",
    "country_id": 1089,
    "zip": "27000-9916"
  },
  "postal_address": {
    "street": "Jaqueline Turnpike",
    "city": "Balistreriburgh",
    "country_id": 1089,
    "zip": "27000-9916"
  },
  "contacts": [

  ],
  "bank_accounts": [

  ],
  "currency_id": 101,
  "currency": {
    "id": 101,
    "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"d949374ed1af5de9074f3e7fb5e36781"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=108b6537a1b4334ca64933a8a76ce4c0; path=/; expires=Mon, 21 May 2018 10:21:18 -0000; HttpOnly
X-Request-Id: 11cbd8b9-98a1-42bc-848e-546245442e2c
X-Runtime: 0.154498
Content-Length: 519

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": "en",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Technologická 372/2",
    "city": "Ostrava - Pustkovec",
    "country_id": 1099,
    "zip": "70800"
  },
  "contacts": [

  ],
  "bank_accounts": [

  ],
  "currency_id": 104,
  "currency": {
    "id": 104,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "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
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
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Set-Cookie: your_session_key=a11e7991a3b7bc29a74afaa6caf10751; path=/; expires=Mon, 21 May 2018 10:21:17 -0000; HttpOnly
X-Request-Id: c1291d2d-a7a6-488f-afc4-b83185d2b9a9
X-Runtime: 0.036161
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
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
Cache-Control: no-cache
Set-Cookie: your_session_key=0c1234c12d9c0d76e9cd085acc127268; path=/; expires=Mon, 21 May 2018 10:21:19 -0000; HttpOnly
X-Request-Id: 8a019b82-1431-4c67-ba6b-9905e9c1e602
X-Runtime: 0.151987

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"65d8545e144aea09b6245c2fb91e9270"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1628de31d1b7384a3d8b4a515a83e9d9; path=/; expires=Mon, 21 May 2018 10:21:16 -0000; HttpOnly
X-Request-Id: ad55a174-68c5-4bd6-ae08-75c4a968a033
X-Runtime: 0.166117
Content-Length: 512

Body

{
  "id": 279,
  "name": "Alexie Konopelski",
  "ic": null,
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "13talia_ullrich@example.com",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Feeney Manor",
    "city": "New Tyra",
    "country_id": 1087,
    "zip": "10141"
  },
  "contacts": [

  ],
  "bank_accounts": [

  ],
  "currency_id": 100,
  "currency": {
    "id": 100,
    "iso_code": "PLN",
    "name": "Polish zloty",
    "symbol": "zł",
    "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

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"c69517a3fe0e468b0d6937cebe1d229b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=84eb716385e656f90f78e48bc5d5f4a0; path=/; expires=Mon, 21 May 2018 10:21:15 -0000; HttpOnly
X-Request-Id: 9092305f-13cf-4836-b9be-d30162ec7e13
X-Runtime: 0.168391
Content-Length: 2436

Body

[
  {
    "id": 263,
    "name": "Drobný nákup",
    "ic": null,
    "dic": null,
    "is_customer": false,
    "is_supplier": true,
    "email": null,
    "is_taxable": false,
    "invoicing_language": "en",
    "invoice_due": null,
    "currency": {
      "id": 98,
      "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": "en",
    "invoice_due": null,
    "currency": {
      "id": 98,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 265,
    "name": "Dina Adams",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "3merle_anderson@example.com",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Bayer Prairie",
      "city": "Maynardstad",
      "city_part": null,
      "zip": "20612"
    },
    "currency": {
      "id": 98,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 266,
    "name": "Marcos Purdy",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "4emmanuelle.yost@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Lila Coves",
      "city": "Jeffereyberg",
      "city_part": null,
      "zip": "52492-5696"
    },
    "currency": {
      "id": 98,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 267,
    "name": "Beatrice Beier DDS",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "5dorothy_haley@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Schinner Square",
      "city": "Port Clarissa",
      "city_part": null,
      "zip": "84695"
    },
    "currency": {
      "id": 98,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 268,
    "name": "Dr. Mathias Bauch",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "6delfina@example.com",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Ida Plain",
      "city": "New Princeshire",
      "city_part": null,
      "zip": "12968"
    },
    "currency": {
      "id": 98,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    }
  },
  {
    "id": 269,
    "name": "Raymundo Gerlach",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "7lonnie@example.com",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Henry Fort",
      "city": "Velmaton",
      "city_part": null,
      "zip": "65173"
    },
    "currency": {
      "id": 98,
      "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?q%5Bname_or_ic_or_dic_or_address_street_or_address_city_cont%5D=Oswald+Volkman

Headers

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

Query Parameters

q%5Bname_or_ic_or_dic_or_address_street_or_address_city_cont%5D=Oswald Volkman

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"c9e1c972b60e83f55b659653340037da"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=40d3f01928a5179e6b13b790fdf8915e; path=/; expires=Mon, 21 May 2018 10:21:15 -0000; HttpOnly
X-Request-Id: 0ca4435e-195d-426e-8209-98c75457efd7
X-Runtime: 0.022869
Content-Length: 380

Body

[
  {
    "id": 276,
    "name": "Oswald Volkman",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "12velda.bartoletti@example.com",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Nienow Union",
      "city": "North Daleville",
      "city_part": null,
      "zip": "85986"
    },
    "currency": {
      "id": 99,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    }
  }
]

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

{
  "name": "Willa Gerlach",
  "email": "44candido_thompson@example.org",
  "ic": "123456789",
  "dic": null,
  "is_taxable": false,
  "is_supplier": false,
  "is_customer": true,
  "currency_id": 105,
  "address_attributes": {
    "country_id": 1100,
    "city": "Lake Evalynview",
    "street": "Edgardo Burg",
    "zip": "46950"
  }
}

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
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
Content-Type: application/json; charset=utf-8
ETag: W/"0f0903a26dc635ddc08833d606d414ba"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fdbc96590b7608da1d56772fcf3ded0e; path=/; expires=Mon, 21 May 2018 10:21:19 -0000; HttpOnly
X-Request-Id: 4f2f805e-20b0-4e58-8a77-65804fd0ab89
X-Runtime: 0.043536
Content-Length: 530

Body

{
  "id": 317,
  "name": "Willa Gerlach",
  "ic": "123456789",
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "44candido_thompson@example.org",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Edgardo Burg",
    "city": "Lake Evalynview",
    "country_id": 1100,
    "zip": "46950"
  },
  "contacts": [

  ],
  "bank_accounts": [

  ],
  "currency_id": 105,
  "currency": {
    "id": 105,
    "iso_code": "USD",
    "name": "United states dollar",
    "symbol": "$",
    "symbol_first": true
  }
}

Payment Types

List of company's payment types

Request

Route

GET api/companies/140/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"b1f587d0b618d56d82d035a8196562e8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=6671161f1b99dc3a37f6fd0ac457ed11; path=/; expires=Mon, 21 May 2018 10:21:20 -0000; HttpOnly
X-Request-Id: 14d28a71-b0e5-4912-bf61-63f863919b2f
X-Runtime: 0.128927
Content-Length: 107

Body

[
  {
    "id": 25,
    "name": "Sincere Volkman I"
  },
  {
    "id": 26,
    "name": "Hannah Bode DVM"
  },
  {
    "id": 27,
    "name": "Pearlie Willms"
  }
]

Scans

Company's processed scan

Request

Route

GET api/companies/150/scans/f5cc428a-5ccf-11e8-921d-0242daacf3b2

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"45b83c3dbcc68f1fd2a0022a8dd5095d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f86d086ae51663155c65775fb96b49fd; path=/; expires=Mon, 21 May 2018 10:21:28 -0000; HttpOnly
X-Request-Id: 60c728cd-71f5-475f-af11-b23dd32ed9b3
X-Runtime: 0.013362
Content-Length: 785

Body

{
  "id": "f5cc428a-5ccf-11e8-921d-0242daacf3b2",
  "size": 95,
  "content_type": "text/plain",
  "state": "Zpracovaná",
  "state_id": 3,
  "created_at": "Po 21. Květen 2018 10:21 +0200",
  "actuarial_id": null,
  "total_price": "1000.0",
  "partner_name": "Davis, Becker and Bednar",
  "partner_ic": "75-709-8321",
  "partner_dic": "CZ76-196-2117",
  "partner_street": "Gaylord View",
  "partner_city": "Brownbury",
  "partner_zip": "50138-1428",
  "partner_country_id": 1,
  "company_name": "Kautzer, Herman and Spencer",
  "company_ic": "28-275-9870",
  "company_dic": "CZ31-090-8223",
  "company_street": "Gust Station",
  "company_city": "Johnsfort",
  "company_zip": "68463",
  "company_country_id": 1,
  "payment_type": "checkout",
  "variable_symbol": "123456789",
  "currency_id": "1",
  "due_date_at": "31. 05. 2018",
  "issue_date_at": "21. 05. 2018",
  "uzp_date_at": "21. 05. 2018"
}

Company's scan

Request

Route

GET api/companies/149/scans/f5161e7e-5ccf-11e8-921d-0242daacf3b2

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"a371b7601d8476c91b56994f24734a66"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9c22a40d008de86b8d241d428adfcc42; path=/; expires=Mon, 21 May 2018 10:21:27 -0000; HttpOnly
X-Request-Id: cb8d1833-9663-41a3-b670-ee23abe68d00
X-Runtime: 0.012333
Content-Length: 610

Body

{
  "id": "f5161e7e-5ccf-11e8-921d-0242daacf3b2",
  "size": 95,
  "content_type": "text/plain",
  "state": "Nahraná",
  "state_id": 1,
  "created_at": "Po 21. Květen 2018 10:21 +0200",
  "actuarial_id": null,
  "total_price": null,
  "partner_name": null,
  "partner_ic": null,
  "partner_dic": null,
  "partner_street": null,
  "partner_city": null,
  "partner_zip": null,
  "partner_country_id": null,
  "company_name": null,
  "company_ic": null,
  "company_dic": null,
  "company_street": null,
  "company_city": null,
  "company_zip": null,
  "company_country_id": null,
  "payment_type": null,
  "variable_symbol": null,
  "currency_id": null,
  "due_date_at": null,
  "issue_date_at": null,
  "uzp_date_at": null
}

Creating company's scan

Parameters

Name Description
attachment required Scaned file

Request

Route

POST api/companies/151/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"959b6c20238515f055ba86b31a9d0221"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b3339595774eb34bcb1bd397530081c9; path=/; expires=Mon, 21 May 2018 10:21:29 -0000; HttpOnly
X-Request-Id: ada18d06-b46a-4db1-ab80-5cac2bac6930
X-Runtime: 0.314200
Content-Length: 613

Body

{
  "id": "6820da05-063d-4ca1-bc84-1295799e15d9",
  "size": 13706,
  "content_type": "text/plain",
  "state": "Nahraná",
  "state_id": 1,
  "created_at": "Po 21. Květen 2018 10:21 +0200",
  "actuarial_id": null,
  "total_price": null,
  "partner_name": null,
  "partner_ic": null,
  "partner_dic": null,
  "partner_street": null,
  "partner_city": null,
  "partner_zip": null,
  "partner_country_id": null,
  "company_name": null,
  "company_ic": null,
  "company_dic": null,
  "company_street": null,
  "company_city": null,
  "company_zip": null,
  "company_country_id": null,
  "payment_type": null,
  "variable_symbol": null,
  "currency_id": null,
  "due_date_at": null,
  "issue_date_at": null,
  "uzp_date_at": null
}

Get version of scan data

Parameters

Name Description
version version of image ['thumb', 'hd', 'fullhd']

Request

Route

GET api/companies/153/scans/f730362c-5ccf-11e8-921d-0242daacf3b2/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
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
Content-Disposition: attachment; filename="thumb_empty2.png"
Content-Transfer-Encoding: binary
Content-Type: text/plain
Cache-Control: private
Set-Cookie: your_session_key=2b8c420a970134f3a189de311ecb4c9c; path=/; expires=Mon, 21 May 2018 10:21:31 -0000; HttpOnly
X-Request-Id: 754befdb-ec98-47db-8f0d-59b9db7a3685
X-Runtime: 0.010875
Content-Length: 296

Body

[BINARY CONTENT]

List of company's processed scans

Parameters

Name Description
page Page
limit Per page

Request

Route

GET api/companies/147/scans/processed

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"cc4df3ef0c02eefd22df2dbae4386016"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9c90be76cb7fb2a9e30fd49b9bc6e464; path=/; expires=Mon, 21 May 2018 10:21:26 -0000; HttpOnly
X-Request-Id: b53d9680-07e1-4e8b-bd48-f96292267a14
X-Runtime: 0.114147
Content-Length: 559

Body

[
  {
    "id": "f42da2f2-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  },
  {
    "id": "f40e7a4e-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  },
  {
    "id": "f3f010b8-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  }
]

List of company's processing scans

Parameters

Name Description
page Page
limit Per page

Request

Route

GET api/companies/145/scans/processing

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"0022ad1099791162d0d3856534bfe2ad"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=80e88ff1a028d8c139eb9f6869d92cd4; path=/; expires=Mon, 21 May 2018 10:21:23 -0000; HttpOnly
X-Request-Id: dc745da4-439e-4030-a8cb-3c3765526185
X-Runtime: 0.012103
Content-Length: 571

Body

[
  {
    "id": "f2d9d920-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Ve zpracování",
    "state_id": 2,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  },
  {
    "id": "f2ca2840-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Ve zpracování",
    "state_id": 2,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  },
  {
    "id": "f2bba5e0-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Ve zpracování",
    "state_id": 2,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  }
]

List of company's scans

Parameters

Name Description
page Page
limit Per page

Request

Route

GET api/companies/141/scans

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"1d83c2544a17bd562ba16410e28adf22"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=6e0a8519b2871f1b7d9541aa68d42ede; path=/; expires=Mon, 21 May 2018 10:21:20 -0000; HttpOnly
X-Request-Id: 33f9b11a-dc81-470b-9765-b8365e1aa700
X-Runtime: 0.135402
Content-Length: 550

Body

[
  {
    "id": "f0e007a2-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  },
  {
    "id": "f0ecd608-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  },
  {
    "id": "f1095e2c-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  }
]

List of company's unprocessed scans

Parameters

Name Description
page Page
limit Per page

Request

Route

GET api/companies/143/scans/unprocessed

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
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
Content-Type: application/json; charset=utf-8
ETag: W/"142cd93b73afddb26d65e7ca160b0bff"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b22d0cd4f6d984935cc06a3afa3b6b6d; path=/; expires=Mon, 21 May 2018 10:21:22 -0000; HttpOnly
X-Request-Id: ff5c7c78-1b7a-459d-b480-a41465c707cb
X-Runtime: 0.014408
Content-Length: 550

Body

[
  {
    "id": "f1e1283e-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  },
  {
    "id": "f1c48fb2-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "actuarial_id": null
  },
  {
    "id": "f1a5d036-5ccf-11e8-921d-0242daacf3b2",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "Po 21. Květen 2018 10:21 +0200",
    "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"52bdbc372bd2c216d6c1ce271bd07391"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 743f89a7-b8e7-4de8-974c-e6f993eaacab
X-Runtime: 0.075520
Content-Length: 71

Body

{
  "email": "test@test.com",
  "authentication_token": "_zxxgMrLZbqWBiXPow4K"
}

System informations

List of system informations

Request

Route

GET api/companies/154/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
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
Content-Type: application/json; charset=utf-8
ETag: W/"2149b584024df8a4d65e0441b6b3472d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=c14dc436e48d21537658d5269c9d9f7f; path=/; expires=Mon, 21 May 2018 10:21:31 -0000; HttpOnly
X-Request-Id: 954215b1-5254-4def-b367-aded2ff1c499
X-Runtime: 0.028798
Content-Length: 287

Body

[
  {
    "id": 4,
    "title": "Cora Denesik",
    "created_at": "21. 05. 2018",
    "description": "aut",
    "image": null
  },
  {
    "id": 3,
    "title": "Charity Goldner",
    "created_at": "21. 05. 2018",
    "description": "maxime",
    "image": null
  },
  {
    "id": 2,
    "title": "Percy Wisozk",
    "created_at": "21. 05. 2018",
    "description": "quos",
    "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
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
Content-Type: application/json; charset=utf-8
ETag: W/"3e9b4ea09ab0df65f3a97dea94f08cbf"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=be35509e7e24c96e9494df1c2a09a523; path=/; expires=Mon, 21 May 2018 10:21:32 -0000; HttpOnly
X-Request-Id: 9e5ac688-d170-4bc0-bfc3-f539522be388
X-Runtime: 0.128688
Content-Length: 83

Body

[
  {
    "id": 1,
    "name": "t",
    "description": "tuna"
  },
  {
    "id": 2,
    "name": "ks",
    "description": "kus"
  }
]