sÚčto API Documentation

AccountingDiaries

List of accounting diaries

Parameters

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

Request

Route

GET api/companies/1/accounting_diaries

Headers

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

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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/"7dae47f1ab69269b8d667aa008905bac"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f08c7530d308d541d9ffdfdc10d064fa; path=/; expires=Wed, 13 Jun 2018 12:23:55 -0000; HttpOnly
X-Request-Id: d27f86d9-77f6-49ec-b803-c13ff6657b91
X-Runtime: 0.675457
Content-Length: 635

Body

{
  "total_months": 0,
  "months": [

  ],
  "groups": [
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 0,
          "account_code": null,
          "account_name": "Celkové náklady",
          "months_total": [

          ]
        }
      ],
      "group_name": "Náklady",
      "group_id": 0,
      "total": "0,00 Kč"
    },
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 1,
          "account_code": null,
          "account_name": "Celkové výnosy",
          "months_total": [

          ]
        }
      ],
      "group_name": "Výnosy",
      "group_id": 1,
      "total": "0,00 Kč"
    },
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 2,
          "account_code": null,
          "account_name": "Celkový hospodářský výsledek",
          "months_total": [

          ]
        }
      ],
      "group_name": "Hospodářský výsledek",
      "group_id": 2,
      "total": "0,00 Kč"
    }
  ]
}

List of accounting diaries available departments

Request

Route

GET api/companies/5/accounting_diaries/available_departments

Headers

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

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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/"7305ef120d87d579155a520c5268a019"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b14ea2e73fbd597c3cab18bdbebfb35e; path=/; expires=Wed, 13 Jun 2018 12:23:56 -0000; HttpOnly
X-Request-Id: 4bbf8ec1-4488-4feb-802e-fc3758f57c40
X-Runtime: 0.112092
Content-Length: 14

Body

[
  "department"
]

List of accounting diaries available years

Request

Route

GET api/companies/4/accounting_diaries/available_years

Headers

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

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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=d20c6c32165d013e14d1d596c7dc6200; path=/; expires=Wed, 13 Jun 2018 12:23:56 -0000; HttpOnly
X-Request-Id: 3cfeb9d3-6e7a-4e6c-987f-e23af1b10302
X-Runtime: 0.021927
Content-Length: 6

Body

[
  2017
]

Search by department

Parameters

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

Request

Route

GET api/companies/3/accounting_diaries?q%5Bdepartment_value_eq%5D=department

Headers

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

Query Parameters

q%5Bdepartment_value_eq%5D=department

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/"7dae47f1ab69269b8d667aa008905bac"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=37df1abddc27e68ced6c0f3c0ad8470a; path=/; expires=Wed, 13 Jun 2018 12:23:55 -0000; HttpOnly
X-Request-Id: 3c09e2de-2910-4fda-ab2b-db68816a0a64
X-Runtime: 0.027153
Content-Length: 635

Body

{
  "total_months": 0,
  "months": [

  ],
  "groups": [
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 0,
          "account_code": null,
          "account_name": "Celkové náklady",
          "months_total": [

          ]
        }
      ],
      "group_name": "Náklady",
      "group_id": 0,
      "total": "0,00 Kč"
    },
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 1,
          "account_code": null,
          "account_name": "Celkové výnosy",
          "months_total": [

          ]
        }
      ],
      "group_name": "Výnosy",
      "group_id": 1,
      "total": "0,00 Kč"
    },
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 2,
          "account_code": null,
          "account_name": "Celkový hospodářský výsledek",
          "months_total": [

          ]
        }
      ],
      "group_name": "Hospodářský výsledek",
      "group_id": 2,
      "total": "0,00 Kč"
    }
  ]
}

Search by month

Parameters

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

Request

Route

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

Headers

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

Query Parameters

q%5Bmonth_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/"7dae47f1ab69269b8d667aa008905bac"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1e8ec8b5b4cb196e8dc05bc474b5a1f6; path=/; expires=Wed, 13 Jun 2018 12:23:55 -0000; HttpOnly
X-Request-Id: 1791f38e-24d0-46a1-ba1e-e556679d264c
X-Runtime: 0.028081
Content-Length: 635

Body

{
  "total_months": 0,
  "months": [

  ],
  "groups": [
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 0,
          "account_code": null,
          "account_name": "Celkové náklady",
          "months_total": [

          ]
        }
      ],
      "group_name": "Náklady",
      "group_id": 0,
      "total": "0,00 Kč"
    },
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 1,
          "account_code": null,
          "account_name": "Celkové výnosy",
          "months_total": [

          ]
        }
      ],
      "group_name": "Výnosy",
      "group_id": 1,
      "total": "0,00 Kč"
    },
    {
      "accounts": [
        {
          "id": null,
          "total": "0,00 Kč",
          "group_id": 2,
          "account_code": null,
          "account_name": "Celkový hospodářský výsledek",
          "months_total": [

          ]
        }
      ],
      "group_name": "Hospodářský výsledek",
      "group_id": 2,
      "total": "0,00 Kč"
    }
  ]
}

Accounts

List of accounts

Parameters

Name Description
page Page
limit Per page
q[name_or_identifier_cont] Search by fields
q[account_type] Account type {1=>"checkout", 2=>"bank", 3=>"paypal"}

Request

Route

GET api/companies/6/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/"58d4c4b23bff7d934c56b858eaf103a1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=384923ca681a5a108b07014336eee441; path=/; expires=Wed, 13 Jun 2018 12:23:57 -0000; HttpOnly
X-Request-Id: fedaf277-9fc5-47d9-a7ef-2fd94d09fa52
X-Runtime: 0.051479
Content-Length: 3151

Body

[
  {
    "id": 11,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 11,
    "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": 12,
    "name": "Banka",
    "identifier": null,
    "account_type": 2,
    "currency_id": 11,
    "country_id": 17,
    "prefix": "B1",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 6,
      "country_id": 17,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2018-06-13T12:23:56.000+02:00",
      "updated_at": "2018-06-13T12:23:56.000+02:00",
      "bank_code": "1111",
      "bankable_id": 6,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 13,
    "name": "Lamont Eichmann",
    "identifier": null,
    "account_type": 2,
    "currency_id": 11,
    "country_id": 16,
    "prefix": "soluta",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 7,
      "country_id": 16,
      "account": "Bria Block",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-06-13T12:23:56.000+02:00",
      "updated_at": "2018-06-13T12:23:56.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 14,
    "name": "Katelin Farrell",
    "identifier": null,
    "account_type": 2,
    "currency_id": 11,
    "country_id": 16,
    "prefix": "esse",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 8,
      "country_id": 16,
      "account": "Jewell Kihn",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-06-13T12:23:56.000+02:00",
      "updated_at": "2018-06-13T12:23:56.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 15,
    "name": "Dr. Elissa Schmeler",
    "identifier": null,
    "account_type": 2,
    "currency_id": 11,
    "country_id": 16,
    "prefix": "quidem",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 9,
      "country_id": 16,
      "account": "Urban Schuppe",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-06-13T12:23:56.000+02:00",
      "updated_at": "2018-06-13T12:23:56.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 16,
    "name": "Anabelle Gaylord",
    "identifier": null,
    "account_type": 2,
    "currency_id": 11,
    "country_id": 16,
    "prefix": "voluptas",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 10,
      "country_id": 16,
      "account": "Mrs. Raoul Leannon",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-06-13T12:23:57.000+02:00",
      "updated_at": "2018-06-13T12:23:57.000+02:00",
      "bank_code": "6200",
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  {
    "id": 17,
    "name": "Henry Marquardt Sr.",
    "identifier": null,
    "account_type": 2,
    "currency_id": 11,
    "country_id": 16,
    "prefix": "itaque",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 11,
      "country_id": 16,
      "account": "Queenie Harber",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-06-13T12:23:57.000+02:00",
      "updated_at": "2018-06-13T12:23:57.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/7/accounts?q%5Bname_or_identifier_cont%5D=Mrs.+Jules+Kerluke

Headers

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

Query Parameters

q%5Bname_or_identifier_cont%5D=Mrs. Jules Kerluke

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/"7b0fc4e0102a7493e0c6eb65319559a7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=bd171224e5ade6f29c7dd3c1e0b649f6; path=/; expires=Wed, 13 Jun 2018 12:23:57 -0000; HttpOnly
X-Request-Id: 52d4fdba-7fab-4db5-8293-57fde5964e96
X-Runtime: 0.016770
Content-Length: 464

Body

[
  {
    "id": 24,
    "name": "Mrs. Jules Kerluke",
    "identifier": null,
    "account_type": 2,
    "currency_id": 12,
    "country_id": 18,
    "prefix": "eius",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 17,
      "country_id": 18,
      "account": "Neoma Watsica",
      "bank_name": null,
      "iban": null,
      "created_at": "2018-06-13T12:23:57.000+02:00",
      "updated_at": "2018-06-13T12:23:57.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=cf215f4b8b8276e04a269319ec6ed4d6; path=/; expires=Wed, 13 Jun 2018 12:23:57 -0000; HttpOnly
X-Request-Id: d76a2fea-860e-409b-b94c-23a1625e0047
X-Runtime: 0.015385
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/18/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/"f7abcb717f0987f78277351e9575e6fa"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9c9de32422bcdf86b6606669e41330ee; path=/; expires=Wed, 13 Jun 2018 12:24:10 -0000; HttpOnly
X-Request-Id: 2ea753fe-6e6c-495e-8f65-3fead4e1d17d
X-Runtime: 0.038276
Content-Length: 1138

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": null,
  "uzp_date_at": "13. 06. 2018",
  "due_date_at": "23. 06. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "13. 06. 2018",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "currency": {
    "id": 18,
    "iso_code": "PLN",
    "name": "Polish zloty",
    "symbol": "zł",
    "symbol_first": false
  },
  "external_number": null,
  "payment_type": null,
  "due_date": 10,
  "order_number": null,
  "bank_number": "1111/1111",
  "iban": null,
  "swift": null,
  "vat": null,
  "paypal_identifier": null,
  "account": {
    "id": 46,
    "name": "Banka",
    "identifier": null,
    "account_type": 2,
    "currency_id": 18,
    "country_id": 36,
    "prefix": "B1",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 28,
      "country_id": 36,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2018-06-13T12:24:09.000+02:00",
      "updated_at": "2018-06-13T12:24:09.000+02:00",
      "bank_code": "1111",
      "bankable_id": 18,
      "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/20/actuarials_ins/new?scan_id=eac6d8ce-6ef3-11e8-8323-02426fe1ba3e

Headers

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

Query Parameters

scan_id=eac6d8ce-6ef3-11e8-8323-02426fe1ba3e

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/"15d3dc85887c07704edb6ca4e64246a0"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=be9e8de9dbad062a5c4ab53570192180; path=/; expires=Wed, 13 Jun 2018 12:24:13 -0000; HttpOnly
X-Request-Id: 84cce657-2a3e-47e9-a85a-1b574d97b247
X-Runtime: 0.147294
Content-Length: 1317

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": null,
  "uzp_date_at": "13. 06. 2018",
  "due_date_at": "23. 06. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "13. 06. 2018",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "currency": {
    "id": 19,
    "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": 49,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 19,
    "country_id": null,
    "prefix": "H1",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": null,
      "country_id": null,
      "account": null,
      "bank_name": null,
      "iban": null,
      "created_at": null,
      "updated_at": null,
      "bank_code": null,
      "bankable_id": null,
      "bankable_type": null,
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  "taxable": false,
  "pay": "0,00 Kč",
  "supplier": {
    "name": "Hessel and Sons",
    "ic": "20",
    "dic": "CZ71-985-5999",
    "dic2": null,
    "street": "Bartoletti Well",
    "city": "Aidafurt",
    "zip": "33596-1792",
    "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/22/actuarials_ins/new?scan_id=ec001728-6ef3-11e8-8323-02426fe1ba3e

Headers

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

Query Parameters

scan_id=ec001728-6ef3-11e8-8323-02426fe1ba3e

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=c39c9e5f59661bc8d1442770115f40a5; path=/; expires=Wed, 13 Jun 2018 12:24:15 -0000; HttpOnly
X-Request-Id: 452147dd-a48b-4be7-a15e-f0ba295efe2e
X-Runtime: 0.016292
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/16/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/"3f5a0a02fa00ceaf5cb71430424b16eb"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b4c71bd1966e372539044e406023e65b; path=/; expires=Wed, 13 Jun 2018 12:24:08 -0000; HttpOnly
X-Request-Id: d9622464-d99a-46a0-ae7e-06ff164a3565
X-Runtime: 0.145989
Content-Length: 1289

Body

{
  "id": 142,
  "actuarial_type": "FA",
  "actuarial_number": "FV 142",
  "uzp_date_at": "13. 06. 2018",
  "due_date_at": "13. 06. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "13. 06. 2018",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "currency": {
    "id": 17,
    "iso_code": "USD",
    "name": "United states dollar",
    "symbol": "$",
    "symbol_first": true
  },
  "external_number": null,
  "payment_type": null,
  "due_date": 0,
  "order_number": null,
  "bank_number": null,
  "iban": null,
  "swift": null,
  "vat": "40.0",
  "paypal_identifier": null,
  "account": {
    "id": 41,
    "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": 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": "Adela Farrell",
      "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/24/actuarials_ins

Headers

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

Body

{
  "partner_id": 51,
  "actuarial_type_id": 315,
  "due_date_at": "2018-06-27",
  "account_id": 57,
  "currency_id": 21,
  "actuarial_number": "2015000001",
  "lines": [
    {
      "vat_id": 9,
      "lineable_type": "Actuarial",
      "name": "Joseph Marvin",
      "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/"a277394f2ff9670a2d70405717461f6a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=3ccba795e9aee697b510632583c1f70e; path=/; expires=Wed, 13 Jun 2018 12:24:17 -0000; HttpOnly
X-Request-Id: d953713e-8cd9-4e9b-9965-b9f4b4025d83
X-Runtime: 0.056352
Content-Length: 1321

Body

{
  "id": 312,
  "actuarial_type": "FA",
  "actuarial_number": "2015000001",
  "uzp_date_at": "13. 06. 2018",
  "due_date_at": "27. 06. 2018",
  "status": "Připravený",
  "status_id": 2,
  "issue_date_at": "13. 06. 2018",
  "base_price": "200.0",
  "end_price": "200.0",
  "remaining": "200.0",
  "currency": {
    "id": 21,
    "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": 57,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 21,
    "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": "Orion Halvorson",
    "ic": null,
    "dic": null,
    "dic2": null,
    "street": "Rippin Walks",
    "city": "North Micah",
    "zip": "33582",
    "is_taxable": false,
    "country_id": 44
  },
  "items": [
    {
      "id": 312,
      "quantity": "1.0",
      "unit_name": "h",
      "name": "Joseph Marvin",
      "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/8/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/"b7ea4c82ef3b29644b81f3ba0d7b92ff"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=e39b7cf83240b0c2619f305289a12961; path=/; expires=Wed, 13 Jun 2018 12:24:00 -0000; HttpOnly
X-Request-Id: 484401ef-9432-495c-afe7-feae617e0b89
X-Runtime: 0.283897
Content-Length: 8235

Body

[
  {
    "id": 35,
    "actuarial_type": "FA",
    "actuarial_number": "FV 35",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "0.0",
    "end_price": "0.0",
    "remaining": "0.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 29,
    "actuarial_type": "FA",
    "actuarial_number": "FV 29",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 28,
    "actuarial_type": "FA",
    "actuarial_number": "FV 28",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 27,
    "actuarial_type": "FA",
    "actuarial_number": "FV 27",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 26,
    "actuarial_type": "FA",
    "actuarial_number": "FV 26",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 25,
    "actuarial_type": "FA",
    "actuarial_number": "FV 25",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 24,
    "actuarial_type": "FA",
    "actuarial_number": "FV 24",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 23,
    "actuarial_type": "FA",
    "actuarial_number": "FV 23",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 22,
    "actuarial_type": "FA",
    "actuarial_number": "FV 22",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 21,
    "actuarial_type": "FA",
    "actuarial_number": "FV 21",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 20,
    "actuarial_type": "FA",
    "actuarial_number": "FV 20",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 19,
    "actuarial_type": "FA",
    "actuarial_number": "FV 19",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 18,
    "actuarial_type": "FA",
    "actuarial_number": "FV 18",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 17,
    "actuarial_type": "FA",
    "actuarial_number": "FV 17",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 16,
    "actuarial_type": "FA",
    "actuarial_number": "FV 16",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 15,
    "actuarial_type": "FA",
    "actuarial_number": "FV 15",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 14,
    "actuarial_type": "FA",
    "actuarial_number": "FV 14",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 13,
    "actuarial_type": "FA",
    "actuarial_number": "FV 13",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 12,
    "actuarial_type": "FA",
    "actuarial_number": "FV 12",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 11,
    "actuarial_type": "FA",
    "actuarial_number": "FV 11",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 13,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    },
    "supplier": {
      "id": 15,
      "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/14/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/"b0abf3ef930af82c0510cdf0d218914d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=8a55ea1d0e7b0c127b6494100c12347d; path=/; expires=Wed, 13 Jun 2018 12:24:06 -0000; HttpOnly
X-Request-Id: fe9981b3-ece6-48c6-a9ed-13dd2bb61e5d
X-Runtime: 0.024389
Content-Length: 396

Body

[
  {
    "id": 141,
    "actuarial_type": "FA",
    "actuarial_number": "FV 141",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "Opravený",
    "status_id": 6,
    "issue_date_at": "13. 06. 2018",
    "base_price": "0.0",
    "end_price": "0.0",
    "remaining": "0.0",
    "variable_symbol": null,
    "currency": {
      "id": 16,
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "symbol_first": true
    },
    "supplier": {
      "id": 27,
      "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/130/actuarials_ins/704/lines

Headers

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

Body

{
  "name": "Isom O'Hara",
  "quantity": "1.0",
  "unit_name": null,
  "unit_price": "200.0",
  "vat_id": 45,
  "tax": "20.0",
  "vat": {
    "id": 45,
    "value": "20.0",
    "valid_from": "2018-06-13",
    "valid_to": "2018-06-14",
    "created_at": "2018-06-13T12:25:52.000+02:00",
    "updated_at": "2018-06-13T12:25:52.000+02:00",
    "country_id": 1077,
    "creator_id": null,
    "updater_id": null,
    "vat_type_id": 45
  },
  "base_price": "200.0",
  "total_price": "220.0",
  "discount_percentage": 0
}

Response

Status

201

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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/"264a19a50049cdcff2c2dd7008aa0535"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b7f42d4e1bb13256136a569e6e32e6b7; path=/; expires=Wed, 13 Jun 2018 12:25:52 -0000; HttpOnly
X-Request-Id: af302fad-9b05-43a1-8dea-d1a2461e477b
X-Runtime: 0.020403
Content-Length: 192

Body

{
  "id": 1114,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Isom O'Hara",
  "vat_id": 45,
  "tax": "20.0",
  "vat": "20.0",
  "unit_price": "200.0",
  "base_price": "200.0",
  "total_price": "220.0",
  "discount_percentage": 0
}

Create company's actuarial out line

Parameters

Name Description
line[name] required Line name
line[quantity] required Line qty
line[unit_price] required Unit price
line[vat_id] required Vat id
line[unit_name] Unit name
line[tax] Tax
line[vat] Vat
line[base_price] Base price
line[total_price] Total price
line[discount_percentage] Unit discount

Request

Route

POST api/companies/129/actuarials_outs/701/lines

Headers

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

Body

{
  "name": "Mallie Boyle",
  "unit_name": null,
  "quantity": "1.0",
  "unit_price": "200.0",
  "vat_id": 44,
  "tax": "20.0",
  "vat": {
    "id": 44,
    "value": "20.0",
    "valid_from": "2018-06-13",
    "valid_to": "2018-06-14",
    "created_at": "2018-06-13T12:25:51.000+02:00",
    "updated_at": "2018-06-13T12:25:51.000+02:00",
    "country_id": 1074,
    "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/"82c11d262321b9e6c899e42ccbe0a8ae"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9306b33bde886c9c05a847d24fbcd67a; path=/; expires=Wed, 13 Jun 2018 12:25:51 -0000; HttpOnly
X-Request-Id: 5d94e49f-2f17-4359-853a-23eb172f4c14
X-Runtime: 0.018300
Content-Length: 193

Body

{
  "id": 1111,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Mallie Boyle",
  "vat_id": 44,
  "tax": "20.0",
  "vat": "20.0",
  "unit_price": "200.0",
  "base_price": "200.0",
  "total_price": "220.0",
  "discount_percentage": 0
}

Delete company's actuarial in line

Request

Route

DELETE api/companies/134/actuarials_ins/712/lines/1124

Headers

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

Response

Status

204

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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=a4a0ac635caf9316a466b3b1ce8086e3; path=/; expires=Wed, 13 Jun 2018 12:25:53 -0000; HttpOnly
X-Request-Id: eea698d9-b798-41fe-95ba-e9ce7c70f0fb
X-Runtime: 0.015479

Delete company's actuarial out line

Request

Route

DELETE api/companies/133/actuarials_outs/709/lines/1121

Headers

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

Response

Status

204

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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=4fab09edce7b27b5d07236882d178598; path=/; expires=Wed, 13 Jun 2018 12:25:53 -0000; HttpOnly
X-Request-Id: 43cca258-9de7-46a2-ac24-db25f8f4324e
X-Runtime: 0.014928

Get company's actuarial in line detail

Request

Route

GET api/companies/128/actuarials_ins/700/lines/1108

Headers

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

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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/"15c37509ff3261684d9d39715a092eb0"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=223c321dde1d6e3d2d9cfe0894c28e84; path=/; expires=Wed, 13 Jun 2018 12:25:51 -0000; HttpOnly
X-Request-Id: 3df57720-415b-4298-9d3c-d6793a4d47f8
X-Runtime: 0.016325
Content-Length: 197

Body

{
  "id": 1108,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Sabina Tillman I",
  "vat_id": 43,
  "tax": "40.0",
  "vat": "20.0",
  "unit_price": "200.0",
  "base_price": "200.0",
  "total_price": "240.0",
  "discount_percentage": 0
}

Get company's actuarial out line detail

Request

Route

GET api/companies/127/actuarials_outs/697/lines/1105

Headers

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

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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/"893c82a8b9c3045713f079b7cf4bb632"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fec263331a4d9e525fd35ae87ad95fed; path=/; expires=Wed, 13 Jun 2018 12:25:51 -0000; HttpOnly
X-Request-Id: 35a549fe-c518-4f68-86fc-2ae4c777971e
X-Runtime: 0.122584
Content-Length: 197

Body

{
  "id": 1105,
  "quantity": "1.0",
  "unit_name": null,
  "name": "Ms. Malcolm Beer",
  "vat_id": 42,
  "tax": "40.0",
  "vat": "20.0",
  "unit_price": "200.0",
  "base_price": "200.0",
  "total_price": "240.0",
  "discount_percentage": 0
}

List of company's actuarial in lines

Request

Route

GET api/companies/126/actuarials_ins/696/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/"1022432a4cc53a39f76f6f3f60d0472f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=81e25d62d6db6cdd9d7c845e344bc081; path=/; expires=Wed, 13 Jun 2018 12:25:51 -0000; HttpOnly
X-Request-Id: 0ecda8fc-0aee-439e-b4f0-55313a8fe866
X-Runtime: 0.019233
Content-Length: 196

Body

[
  {
    "id": 1104,
    "quantity": "1.0",
    "unit_name": null,
    "name": "Anna Botsford",
    "vat_id": 41,
    "tax": "40.0",
    "vat": "20.0",
    "unit_price": "200.0",
    "base_price": "200.0",
    "total_price": "240.0",
    "discount_percentage": 0
  }
]

List of company's actuarial out lines

Request

Route

GET api/companies/125/actuarials_outs/693/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/"83d6f24d6e03f76e25c29fc0622b391b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=3e9d4609d780cbb9a5b564449b197e35; path=/; expires=Wed, 13 Jun 2018 12:25:50 -0000; HttpOnly
X-Request-Id: 082b8a3e-0867-4c5e-af0d-b89f13ba7a52
X-Runtime: 0.033910
Content-Length: 200

Body

[
  {
    "id": 1101,
    "quantity": "1.0",
    "unit_name": null,
    "name": "Mr. Blake D'Amore",
    "vat_id": 40,
    "tax": "40.0",
    "vat": "20.0",
    "unit_price": "200.0",
    "base_price": "200.0",
    "total_price": "240.0",
    "discount_percentage": 0
  }
]

Update company's actuarial in line

Parameters

Name Description
line[name] Line name
line[quantity] Line qty
line[unit_price] Unit price
line[unit_name] Unit name
line[vat_id] Vat id
line[tax] Tax
line[vat] Vat
line[base_price] Base price
line[total_price] Total price
line[discount_percentage] Unit discount

Request

Route

PATCH api/companies/132/actuarials_ins/708/lines/1118

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/"2d408b0945bde66678d1c83f1f90f24f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=d51f7074aeb979f5c0962e85fdf61850; path=/; expires=Wed, 13 Jun 2018 12:25:52 -0000; HttpOnly
X-Request-Id: 4c51c54c-33c4-4345-aa35-bf0e621c43be
X-Runtime: 0.017697
Content-Length: 193

Body

{
  "id": 1118,
  "quantity": "5.0",
  "unit_name": null,
  "name": "Dina Zboncak",
  "vat_id": 47,
  "tax": "40.0",
  "vat": "20.0",
  "unit_price": "200.0",
  "base_price": "200.0",
  "total_price": "240.0",
  "discount_percentage": 0
}

Update company's actuarial out line

Parameters

Name Description
line[name] Line name
line[quantity] Line qty
line[unit_price] Unit price
line[vat_id] Vat id
line[unit_name] Unit name
line[tax] Tax
line[vat] Vat
line[base_price] Base price
line[total_price] Total price
line[discount_percentage] Unit discount

Request

Route

PATCH api/companies/131/actuarials_outs/705/lines/1115

Headers

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

Body

{
  "line": {
    "quantity": 5.0
  }
}

Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Accept: application/vnd-revisions-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/"397731700eb1d1859d90111ee4072880"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=5dbbd7ba3408a0588b5ae80df3101e96; path=/; expires=Wed, 13 Jun 2018 12:25:52 -0000; HttpOnly
X-Request-Id: be03e9fb-e38a-4333-884d-0a89c7fca418
X-Runtime: 0.022921
Content-Length: 194

Body

{
  "id": 1115,
  "quantity": "5.0",
  "unit_name": null,
  "name": "Camryn Dooley",
  "vat_id": 46,
  "tax": "40.0",
  "vat": "20.0",
  "unit_price": "200.0",
  "base_price": "200.0",
  "total_price": "240.0",
  "discount_percentage": 0
}

Actuarials Out

Actuarials Out Initialize

Request

Route

GET api/companies/36/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/"90aab8700e54f27301aaaa730acbe5d2"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=17b1ffe2d77d16d085bcf66b4b56ba7e; path=/; expires=Wed, 13 Jun 2018 12:24:29 -0000; HttpOnly
X-Request-Id: 455dbb91-2db6-470d-8375-eb53f22495e2
X-Runtime: 0.023721
Content-Length: 1307

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": "201800001",
  "uzp_date_at": "13. 06. 2018",
  "due_date_at": "23. 06. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "13. 06. 2018",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "variable_symbol": null,
  "currency": {
    "id": 27,
    "iso_code": "PLN",
    "name": "Polish zloty",
    "symbol": "zł",
    "symbol_first": false
  },
  "external_number": null,
  "payment_type": null,
  "due_date": 10,
  "order_number": null,
  "bank_number": "1111/1111",
  "iban": null,
  "swift": null,
  "vat": null,
  "paypal_identifier": null,
  "account": {
    "id": 87,
    "name": "Banka",
    "identifier": null,
    "account_type": 2,
    "currency_id": 27,
    "country_id": 63,
    "prefix": "B1",
    "is_deactivated": false,
    "opening_balance": "0.0",
    "bank_account": {
      "id": 51,
      "country_id": 63,
      "account": "1111",
      "bank_name": "Banka",
      "iban": null,
      "created_at": "2018-06-13T12:24:28.000+02:00",
      "updated_at": "2018-06-13T12:24:28.000+02:00",
      "bank_code": "1111",
      "bankable_id": 36,
      "bankable_type": "Company",
      "is_deleted": false,
      "swift": null,
      "qr_codes": false
    }
  },
  "taxable": false,
  "pay": "0.0",
  "supplier": {
    "name": "Company 36",
    "ic": "36",
    "dic": null,
    "dic2": null,
    "street": "Alexys Islands",
    "city": "Ethaton",
    "zip": "86567-8149",
    "is_taxable": false,
    "country_id": 63
  },
  "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/38/actuarials_outs/new?scan_id=f6008c08-6ef3-11e8-8323-02426fe1ba3e

Headers

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

Query Parameters

scan_id=f6008c08-6ef3-11e8-8323-02426fe1ba3e

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/"fff52759f1f1d1a62997b6f2e4798d5e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=de188d5efabb04705938940a8b24e0e7; path=/; expires=Wed, 13 Jun 2018 12:24:31 -0000; HttpOnly
X-Request-Id: 3284a2dc-b689-483f-b4d9-db25acacbcc6
X-Runtime: 0.038192
Content-Length: 1452

Body

{
  "id": null,
  "actuarial_type": "FA",
  "actuarial_number": "201800001",
  "uzp_date_at": "13. 06. 2018",
  "due_date_at": "23. 06. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "13. 06. 2018",
  "base_price": null,
  "end_price": null,
  "remaining": 0,
  "variable_symbol": "123456789",
  "currency": {
    "id": 28,
    "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": 91,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 28,
    "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": "Keebler LLC",
    "email": "",
    "ic": "09-194-9895",
    "dic": "CZ94-568-2751",
    "dic2": null,
    "street": "Columbus Shore",
    "city": "Gabriellabury",
    "zip": "17550",
    "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/40/actuarials_outs/new?scan_id=f72ee0c0-6ef3-11e8-8323-02426fe1ba3e

Headers

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

Query Parameters

scan_id=f72ee0c0-6ef3-11e8-8323-02426fe1ba3e

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=ef71c42fcca004d4366722edce8b6838; path=/; expires=Wed, 13 Jun 2018 12:24:34 -0000; HttpOnly
X-Request-Id: 555cc4b5-0fb7-4b1a-b80d-dd784dde5ef1
X-Runtime: 0.018367
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/34/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/"509dd4fcb444c13b0067b8ec34145b9b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9488a169bd7da4091e8ad5c8991147e6; path=/; expires=Wed, 13 Jun 2018 12:24:28 -0000; HttpOnly
X-Request-Id: 68df010a-8535-45e8-bf61-e8f4dcd8d714
X-Runtime: 0.026064
Content-Length: 1446

Body

{
  "id": 454,
  "actuarial_type": "FA",
  "actuarial_number": "FV 453",
  "uzp_date_at": "13. 06. 2018",
  "due_date_at": "13. 06. 2018",
  "status": "V přípravě",
  "status_id": 1,
  "issue_date_at": "13. 06. 2018",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "variable_symbol": null,
  "currency": {
    "id": 26,
    "iso_code": "PLN",
    "name": "Polish zloty",
    "symbol": "zł",
    "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": 81,
    "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 34",
    "ic": "34",
    "dic": null,
    "dic2": null,
    "street": "Fritsch Islands",
    "city": "Ericmouth",
    "zip": "17671",
    "is_taxable": false,
    "country_id": 60
  },
  "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": "Kari Boehm Jr.",
      "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/42/actuarials_outs

Headers

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

Body

{
  "partner_id": 88,
  "vat_regime_id": 623,
  "actuarial_type_id": 627,
  "due_date_at": "2018-06-27",
  "account_id": 101,
  "currency_id": 30,
  "actuarial_number": "2015000001",
  "lines": [
    {
      "vat_id": 18,
      "lineable_type": "Actuarial",
      "name": "Easton Terry",
      "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/"56334937c9e3f349cd1cd3fc5cd86472"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=39977208d5cc0ffc1f2dd3965391c5c2; path=/; expires=Wed, 13 Jun 2018 12:24:36 -0000; HttpOnly
X-Request-Id: 792f5863-dbed-4c9d-b448-43e730a370f2
X-Runtime: 0.052696
Content-Length: 1507

Body

{
  "id": 624,
  "actuarial_type": "FA",
  "actuarial_number": "2015000001",
  "uzp_date_at": "13. 06. 2018",
  "due_date_at": "27. 06. 2018",
  "status": "Připravený",
  "status_id": 2,
  "issue_date_at": "13. 06. 2018",
  "base_price": "200.0",
  "end_price": "240.0",
  "remaining": "240.0",
  "variable_symbol": null,
  "currency": {
    "id": 30,
    "iso_code": "GBP",
    "name": "Pound sterling",
    "symbol": "£",
    "symbol_first": true
  },
  "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": 101,
    "name": "Hotovost",
    "identifier": null,
    "account_type": 1,
    "currency_id": 30,
    "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 42",
    "ic": "42",
    "dic": null,
    "dic2": null,
    "street": "Simonis View",
    "city": "West Giovani",
    "zip": "96718-7878",
    "is_taxable": false,
    "country_id": 72
  },
  "customer": {
    "name": "Earl Rogahn",
    "email": "2tara@example.com",
    "ic": null,
    "dic": null,
    "dic2": null,
    "street": "Kihn Hill",
    "city": "Port Mathiasland",
    "zip": "43828-1381",
    "country_id": 71
  },
  "items": [
    {
      "id": 624,
      "quantity": "1.0",
      "unit_name": "h",
      "name": "Easton Terry",
      "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/26/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/"55784b943b299cd53ded8fc6c5be25a8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=69cabc10476d45394f53198db43d82cb; path=/; expires=Wed, 13 Jun 2018 12:24:19 -0000; HttpOnly
X-Request-Id: 1d1d46e6-0194-4e47-95b9-0ff64924d287
X-Runtime: 0.254386
Content-Length: 8281

Body

[
  {
    "id": 347,
    "actuarial_type": "FA",
    "actuarial_number": "FV 346",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2019",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 341,
    "actuarial_type": "FA",
    "actuarial_number": "FV 340",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 340,
    "actuarial_type": "FA",
    "actuarial_number": "FV 339",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 339,
    "actuarial_type": "FA",
    "actuarial_number": "FV 338",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 338,
    "actuarial_type": "FA",
    "actuarial_number": "FV 337",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 337,
    "actuarial_type": "FA",
    "actuarial_number": "FV 336",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 336,
    "actuarial_type": "FA",
    "actuarial_number": "FV 335",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 335,
    "actuarial_type": "FA",
    "actuarial_number": "FV 334",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 334,
    "actuarial_type": "FA",
    "actuarial_number": "FV 333",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 333,
    "actuarial_type": "FA",
    "actuarial_number": "FV 332",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 332,
    "actuarial_type": "FA",
    "actuarial_number": "FV 331",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 331,
    "actuarial_type": "FA",
    "actuarial_number": "FV 330",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 330,
    "actuarial_type": "FA",
    "actuarial_number": "FV 329",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 329,
    "actuarial_type": "FA",
    "actuarial_number": "FV 328",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 328,
    "actuarial_type": "FA",
    "actuarial_number": "FV 327",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 327,
    "actuarial_type": "FA",
    "actuarial_number": "FV 326",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 326,
    "actuarial_type": "FA",
    "actuarial_number": "FV 325",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 325,
    "actuarial_type": "FA",
    "actuarial_number": "FV 324",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 324,
    "actuarial_type": "FA",
    "actuarial_number": "FV 323",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "name": "Drobný nákup"
    }
  },
  {
    "id": 323,
    "actuarial_type": "FA",
    "actuarial_number": "FV 322",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 22,
      "iso_code": "GBP",
      "name": "Pound sterling",
      "symbol": "£",
      "symbol_first": true
    },
    "customer": {
      "id": 52,
      "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/32/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/"b113cf1da879285c41aa5bf562fa92e9"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b16907df6b336e9de6903c9e5a8d2fa0; path=/; expires=Wed, 13 Jun 2018 12:24:26 -0000; HttpOnly
X-Request-Id: 7dc28b82-8643-4610-bac5-3e9b3621f75a
X-Runtime: 0.032067
Content-Length: 420

Body

[
  {
    "id": 453,
    "actuarial_type": "FA",
    "actuarial_number": "FV 452",
    "uzp_date_at": "13. 06. 2018",
    "due_date_at": "13. 06. 2018",
    "status": "V přípravě",
    "status_id": 1,
    "issue_date_at": "13. 06. 2018",
    "base_price": "200.0",
    "end_price": "240.0",
    "remaining": "240.0",
    "variable_symbol": null,
    "currency": {
      "id": 25,
      "iso_code": "USD",
      "name": "United states dollar",
      "symbol": "$",
      "symbol_first": true
    },
    "customer": {
      "id": 64,
      "name": "Drobný nákup"
    }
  }
]

Pay actuarial and make cash voucher

Request

Route

GET api/companies/44/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=1eb5f7c5c6b2cbdab3c453fa788b0168; path=/; expires=Wed, 13 Jun 2018 12:24:38 -0000; HttpOnly
X-Request-Id: ff81b679-352f-4156-a071-6e43e0930d36
X-Runtime: 0.329448
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: 51e1ea34-97fe-4119-b276-632732f079c1
X-Runtime: 0.019676
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: 817da7f7-cb05-45d6-b6e8-66a204e78356
X-Runtime: 0.001871
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/"c013867214c561b32fde4a9354d44ff4"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8f1246d2-4b34-4b36-b39e-c719c21acb6a
X-Runtime: 0.127414
Content-Length: 299

Body

[
  {
    "id": 86,
    "name": "Czech Republic",
    "fuel_unit": "l",
    "length_unit": "km",
    "default_language": "cs",
    "currency": {
      "id": 35,
      "iso_code": "CZK",
      "name": "Czech crown"
    }
  },
  {
    "id": 87,
    "name": "Slovak Republic",
    "fuel_unit": "l",
    "length_unit": "km",
    "default_language": "cs",
    "currency": {
      "id": 36,
      "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/"5cbda38c8318f968ed5c5181f4d43272"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 56423d82-5199-4cd6-a008-aa094838e040
X-Runtime: 0.024801
Content-Length: 237

Body

[
  {
    "id": 37,
    "iso_code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "symbol_first": true
  },
  {
    "id": 38,
    "iso_code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "symbol_first": true
  },
  {
    "id": 39,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  }
]

Admin Scans

Get scan data

Request

Route

GET api/admin/scans/ffca800e-6ef3-11e8-8323-02426fe1ba3e/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: b70c9eef-80e2-413a-9277-461185e0d03f
X-Runtime: 0.003503
Content-Length: 95

Body

[BINARY CONTENT]

Get scan detail

Request

Route

GET api/admin/scans/ff42bfa2-6ef3-11e8-8323-02426fe1ba3e

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/ff42bfa2-6ef3-11e8-8323-02426fe1ba3e
Content-Type: application/json; charset=utf-8
ETag: W/"9f33a4eabc25f48d16c5e32a9e3be7ca"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 42d93b64-ebf5-4882-9d95-d008be08dc1b
X-Runtime: 0.004449
Content-Length: 83

Body

{
  "id": "ff42bfa2-6ef3-11e8-8323-02426fe1ba3e",
  "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/"b5830f013c88c095902fdc15dcc4081f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 7868118a-e133-426b-9e98-18c5e235c2ed
X-Runtime: 0.005691
Content-Length: 313

Body

[
  {
    "id": "fe23c9ea-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "fe16e3b0-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "fdfbf1e0-6ef3-11e8-8323-02426fe1ba3e",
    "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/"714ecae6ec06a2defcacf28d576d7699"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 48379d64-2999-43e2-a427-23565f78ae70
X-Runtime: 0.006628
Content-Length: 622

Body

[
  {
    "id": "fc061bd6-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "fbfac5ce-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "fbe1123c-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "processed"
  },
  {
    "id": "fbd485ee-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "uploaded"
  },
  {
    "id": "fbc8cace-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "uploaded"
  },
  {
    "id": "fbabda7c-6ef3-11e8-8323-02426fe1ba3e",
    "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/"c95458b39f41fed5b846172faee0cf93"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 65e3f3a6-8632-4ed7-ae59-eef79c410255
X-Runtime: 0.004426
Content-Length: 310

Body

[
  {
    "id": "fcef0b5c-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "uploaded"
  },
  {
    "id": "fccebd7a-6ef3-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "uploaded"
  },
  {
    "id": "fcc3328e-6ef3-11e8-8323-02426fe1ba3e",
    "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/010d7638-6ef4-11e8-8323-02426fe1ba3e/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": 112,
    "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": 112,
    "issue_date_at": "2018-06-13",
    "due_date_at": "2018-06-27",
    "uzp_date_at": "2018-06-13",
    "payment_type": 2,
    "variable_symbol": "20170123456",
    "currency_id": 50
  }
}

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/010d7638-6ef4-11e8-8323-02426fe1ba3e
Content-Type: application/json; charset=utf-8
ETag: W/"0dcb4a8324813ee67cc009d0a514cf12"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 511d8ef2-f4ac-4453-99f1-cd9ef8550348
X-Runtime: 0.009985
Content-Length: 655

Body

{
  "id": "010d7638-6ef4-11e8-8323-02426fe1ba3e",
  "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": 112,
  "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": 112,
  "payment_type": "bank",
  "variable_symbol": "20170123456",
  "currency_id": "50",
  "due_date_at": "27. 06. 2018",
  "issue_date_at": "13. 06. 2018",
  "uzp_date_at": "13. 06. 2018"
}

Processing scan

Request

Route

PATCH api/admin/scans/0063897a-6ef4-11e8-8323-02426fe1ba3e/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/0063897a-6ef4-11e8-8323-02426fe1ba3e
Content-Type: application/json; charset=utf-8
ETag: W/"146bc0fe55ea307bbdb0be5ec0438f7e"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8dc767e1-06c5-4f09-912b-664fc7ef5362
X-Runtime: 0.007432
Content-Length: 83

Body

{
  "id": "0063897a-6ef4-11e8-8323-02426fe1ba3e",
  "size": 95,
  "content_type": "text/plain"
}

ApiPermissions

List of resources with read permission

Request

Route

GET api/companies/61/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/"6b65ac66af09470a95da25c8ada8332c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=aa632025e01072c6d768af50c602c8c7; path=/; expires=Wed, 13 Jun 2018 12:24:51 -0000; HttpOnly
X-Request-Id: 4e55755e-8238-49d2-8c54-60449b471c86
X-Runtime: 0.018106
Content-Length: 42

Body

[
  "ActuarialsIn",
  "ActuarialsOut",
  "Partner"
]

List of user abilities

Parameters

Name Description
resource Permissions by resource

Request

Route

GET api/companies/60/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=cc62f37f0db9c79ba44f84865af9dd97; path=/; expires=Wed, 13 Jun 2018 12:24:50 -0000; HttpOnly
X-Request-Id: 631ebca8-1a5a-45f0-b0c7-de18a8cdec41
X-Runtime: 0.039760
Content-Length: 60

Body

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

Request

Route

GET api/companies/60/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=c40a7be9df765285b54dc4e8e2d11ec3; path=/; expires=Wed, 13 Jun 2018 12:24:50 -0000; HttpOnly
X-Request-Id: bb77ece6-3a13-430c-a1c0-0a1c5a26d1b3
X-Runtime: 0.014246
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/72/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/"d3b33141a894e900c88b86826e953add"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1b441a162acd4a464c4c60fd6f34ffdc; path=/; expires=Wed, 13 Jun 2018 12:25:02 -0000; HttpOnly
X-Request-Id: 4ba806e0-a4e1-41d2-959b-c963acfa5e4a
X-Runtime: 0.025752
Content-Length: 569

Body

{
  "id": 107,
  "number": "106",
  "description": null,
  "total_price": "240,00 EUR",
  "base_price": "200,00 EUR",
  "transaction_date": "13. 06. 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": 795,
      "quantity": "1.0",
      "unit_name": null,
      "name": "Mariane Schamberger",
      "vat_id": 24,
      "tax": "40.0",
      "vat": "20.0",
      "unit_price": "200.0",
      "base_price": "200.0",
      "total_price": "240.0",
      "discount_percentage": 0
    }
  ],
  "amounts": [

  ],
  "payments": [

  ]
}

List of company's cash vouchers ins

Parameters

Name Description
page Page
q[number_cont] Number contains
q[description_cont] Description contains
q[partner_name_cont] Recipient name contains
q[transaction_date_gteq] Transaction date is later or equal to
q[transaction_date_lteq] Transaction date is before or equal to
q[base_price_gteq] Base price is greater or equal to
q[base_price_lteq] Base price is lower or equal to
q[total_price_gteq] Total price is greater or equal to
q[total_price_lteq] Total price is lower or equal to

Request

Route

GET api/companies/66/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/"d2ca2ca93a0fe280c5858f62c7bfe9ef"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=0a68789d36d3f508c4ce69877297f06b; path=/; expires=Wed, 13 Jun 2018 12:24:55 -0000; HttpOnly
X-Request-Id: dc2d0431-f2cb-4676-8a8c-e3e0cae3dfbd
X-Runtime: 0.248073
Content-Length: 5057

Body

[
  {
    "id": 36,
    "number": "35",
    "description": null,
    "total_price": "0,00 CZK",
    "base_price": "0,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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 CZK",
    "base_price": "200,00 CZK",
    "transaction_date": "13. 06. 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/74/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=2018ad6611b3b01a1ca1b617ef9ce906; path=/; expires=Wed, 13 Jun 2018 12:25:05 -0000; HttpOnly
X-Request-Id: 66b554a3-b532-43bb-a229-e7d81b8a9ef4
X-Runtime: 0.012243
Content-Length: 0

Cash Vouchers Out

Company's cash voucher out detail

Request

Route

GET api/companies/84/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/"9bcb51383d629567e8d3cd483d397101"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=3a89777002be422ad80e3775df222cdc; path=/; expires=Wed, 13 Jun 2018 12:25:18 -0000; HttpOnly
X-Request-Id: dc4eb134-b90e-41e5-87ef-dabfc9aaf8cf
X-Runtime: 0.024499
Content-Length: 564

Body

{
  "id": 314,
  "number": "313",
  "description": null,
  "total_price": "240,00 EUR",
  "base_price": "200,00 EUR",
  "transaction_date": "13. 06. 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": 999,
      "quantity": "1.0",
      "unit_name": null,
      "name": "Marie O'Conner",
      "vat_id": 30,
      "tax": "40.0",
      "vat": "20.0",
      "unit_price": "200.0",
      "base_price": "200.0",
      "total_price": "240.0",
      "discount_percentage": 0
    }
  ],
  "amounts": [

  ],
  "payments": [

  ]
}

List of company's cash vouchers outs

Parameters

Name Description
page Page
q[number_cont] Number contains
q[description_cont] Description contains
q[partner_name_cont] Recipient name contains
q[transaction_date_gteq] Transaction date is later or equal to
q[transaction_date_lteq] Transaction date is before or equal to
q[base_price_gteq] Base price is greater or equal to
q[base_price_lteq] Base price is lower or equal to
q[total_price_gteq] Total price is greater or equal to
q[total_price_lteq] Total price is lower or equal to

Request

Route

GET api/companies/78/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/"cc0d10c52e06a6f99f515b5055cd068d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=afd10c828067e8210a711ea2703f021a; path=/; expires=Wed, 13 Jun 2018 12:25:10 -0000; HttpOnly
X-Request-Id: 434a24fc-bc17-4f55-95fe-97901748ca7a
X-Runtime: 0.242187
Content-Length: 5097

Body

[
  {
    "id": 243,
    "number": "242",
    "description": null,
    "total_price": "0,00 PLN",
    "base_price": "0,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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 PLN",
    "base_price": "200,00 PLN",
    "transaction_date": "13. 06. 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/86/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=ccbcf25f72af1353fb788d84e64ae0d7; path=/; expires=Wed, 13 Jun 2018 12:25:20 -0000; HttpOnly
X-Request-Id: 4c3aa4bd-c4cf-4a4d-9809-705aad7cbd13
X-Runtime: 0.012071
Content-Length: 0

Companies

Company's employee

Request

Route

GET api/companies/123/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/"436f71e6dcb0777c25d162254dd1d802"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=89dd76b4d306967166ceb463d269bb65; path=/; expires=Wed, 13 Jun 2018 12:25:50 -0000; HttpOnly
X-Request-Id: 7fa960ff-d100-41fc-8678-fa15adab6d51
X-Runtime: 0.012091
Content-Length: 305

Body

{
  "id": 90,
  "first_name": "Benny",
  "last_name": "Schowalter",
  "bank_account": null,
  "birthday": "2018-06-13",
  "status": null,
  "nationality": null,
  "place_of_birth": null,
  "personal_number": "13. 06. 2018",
  "identification_number": null,
  "employee_number": "number_13. 06. 2018",
  "education": null,
  "citizenhood": null,
  "sex": "Muž"
}

Detail of company

Request

Route

GET api/companies/100

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/"7dbaee9140290b5b7358a2f4a88a2fcd"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=76c58b25af44dbcbdbaa20f1fa3808c7; path=/; expires=Wed, 13 Jun 2018 12:25:24 -0000; HttpOnly
X-Request-Id: f4447d43-a004-41b9-81dc-c32228f38981
X-Runtime: 0.010907
Content-Length: 211

Body

{
  "id": 100,
  "name": "Company 100",
  "ic": "100",
  "is_taxable": false,
  "country_id": 1014,
  "email": "company-100@sucto.cz",
  "address": {
    "street": "Schroeder Gateway",
    "city": "West Myrticeborough",
    "city_part": null,
    "zip": "63833"
  }
}

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/"3a537c42ed2527f86cda231e540fc5d8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=209cdf0a5d7c09e475acdb5af7034a40; path=/; expires=Wed, 13 Jun 2018 12:25:23 -0000; HttpOnly
X-Request-Id: 61de93c9-0b11-4a89-ae8c-8f7c1e2be4c5
X-Runtime: 0.026442
Content-Length: 322

Body

[
  {
    "id": 90,
    "name": "Company 90",
    "ic": "90",
    "is_taxable": false,
    "country_id": 1010,
    "email": "company-90@sucto.cz"
  },
  {
    "id": 91,
    "name": "Company 91",
    "ic": "91",
    "is_taxable": false,
    "country_id": 1009,
    "email": "company-91@sucto.cz"
  },
  {
    "id": 92,
    "name": "Company 92",
    "ic": "92",
    "is_taxable": false,
    "country_id": 1009,
    "email": "company-92@sucto.cz"
  }
]

List of company's employees

Parameters

Name Description
page Page

Request

Route

GET api/companies/119/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/"09b618d7641c71f95d338a882997b503"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ccd50c00f2eacb22c0c0f9ccc90cb23f; path=/; expires=Wed, 13 Jun 2018 12:25:49 -0000; HttpOnly
X-Request-Id: f2a51b04-b4cd-42a7-92d5-db9852fc68e0
X-Runtime: 0.029120
Content-Length: 2482

Body

[
  {
    "id": 10,
    "first_name": "Kira",
    "last_name": "Sauer",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 11,
    "first_name": "Breanne",
    "last_name": "Buckridge",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 12,
    "first_name": "Gracie",
    "last_name": "Watsica",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 13,
    "first_name": "Triston",
    "last_name": "West",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 14,
    "first_name": "Reta",
    "last_name": "Nikolaus",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 15,
    "first_name": "Jovani",
    "last_name": "Leffler",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 16,
    "first_name": "Arne",
    "last_name": "Farrell",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 17,
    "first_name": "Hermann",
    "last_name": "Stroman",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 18,
    "first_name": "Makayla",
    "last_name": "Hilpert",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 19,
    "first_name": "Filomena",
    "last_name": "O'Kon",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 20,
    "first_name": "Tabitha",
    "last_name": "Gulgowski",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 21,
    "first_name": "Isadore",
    "last_name": "Greenfelder",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 22,
    "first_name": "Kevon",
    "last_name": "Langworth",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 23,
    "first_name": "Karen",
    "last_name": "Davis",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 24,
    "first_name": "Jenifer",
    "last_name": "Vandervort",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 25,
    "first_name": "Adonis",
    "last_name": "Fisher",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 26,
    "first_name": "Isom",
    "last_name": "Stracke",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 27,
    "first_name": "Kelsi",
    "last_name": "Bogisich",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 28,
    "first_name": "Dimitri",
    "last_name": "Dach",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  },
  {
    "id": 29,
    "first_name": "Lesly",
    "last_name": "Lindgren",
    "personal_number": "13. 06. 2018",
    "birthday": "2018-06-13",
    "sex": "Muž"
  }
]

Countries

Detail of country

Request

Route

GET api/countries/1021

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/"03465588411b4b682ff5b34a355ed7ee"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=34da93ef52cd4910078e1a9dbbc80a4d; path=/; expires=Wed, 13 Jun 2018 12:25:25 -0000; HttpOnly
X-Request-Id: d308dac4-c4c5-4263-9c01-7e7f99144046
X-Runtime: 0.012197
Content-Length: 153

Body

{
  "id": 1021,
  "name": "Czech Republic",
  "fuel_unit": "l",
  "length_unit": "km",
  "default_language": "cs",
  "currency": {
    "id": 72,
    "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/"0c22a5dc1a142b9092d8b768242eb3b4"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=d4a2a30d01f293287c7192d44c2fea33; path=/; expires=Wed, 13 Jun 2018 12:25:25 -0000; HttpOnly
X-Request-Id: efd5b7b5-06e6-40ef-87ac-5a8100a44f7a
X-Runtime: 0.134519
Content-Length: 303

Body

[
  {
    "id": 1017,
    "name": "Czech Republic",
    "fuel_unit": "l",
    "length_unit": "km",
    "default_language": "cs",
    "currency": {
      "id": 70,
      "iso_code": "CZK",
      "name": "Czech crown"
    }
  },
  {
    "id": 1018,
    "name": "Slovak Republic",
    "fuel_unit": "l",
    "length_unit": "km",
    "default_language": "cs",
    "currency": {
      "id": 71,
      "iso_code": "EUR",
      "name": "Euro"
    }
  }
]

List of country's vat regimes

Request

Route

GET api/countries/1151/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/"da93da32e7ba7db6c9d05690acb90227"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=7425a8e9d8b2ac7029bae456a0ad6c8c; path=/; expires=Wed, 13 Jun 2018 12:26:08 -0000; HttpOnly
X-Request-Id: 808ba030-d591-431d-960a-30ea4b93d171
X-Runtime: 0.132074
Content-Length: 154

Body

[
  {
    "id": 712,
    "name": "Tuzemská plnění"
  },
  {
    "id": 713,
    "name": "Přenesení daňové povinnosti"
  },
  {
    "id": 714,
    "name": "EU zboží"
  },
  {
    "id": 715,
    "name": "EU služba"
  }
]

List of country's vats

Request

Route

GET api/countries/1154/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/"17a6a5cb66b04c55a6909d5dba755093"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=d1343f770d1649e1213faa0bab3aaf1f; path=/; expires=Wed, 13 Jun 2018 12:26:09 -0000; HttpOnly
X-Request-Id: 0be743de-46f8-42a9-b7a6-8740d20e355d
X-Runtime: 0.015967
Content-Length: 226

Body

[
  {
    "id": 50,
    "value": "20.0",
    "valid_from": "2018-06-13",
    "valid_to": "2018-06-14"
  },
  {
    "id": 52,
    "value": "19.0",
    "valid_from": "2018-06-13",
    "valid_to": "2018-06-14"
  },
  {
    "id": 51,
    "value": "11.0",
    "valid_from": "2018-06-13",
    "valid_to": "2018-06-14"
  }
]

List of current country's vats

Request

Route

GET api/countries/1163/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/"937046c127884da4468b4ba130bcffec"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9f68058093a39270d5a4e29ec9827da9; path=/; expires=Wed, 13 Jun 2018 12:26:09 -0000; HttpOnly
X-Request-Id: 8ac9acd4-27a1-4678-a225-0c4b38dc1961
X-Runtime: 0.112029
Content-Length: 68

Body

[
  {
    "id": 62,
    "value": "21.0",
    "valid_from": "2018-06-13",
    "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=23bd3fa991a1fb8da0b0860193724959; path=/; expires=Wed, 13 Jun 2018 12:26:08 -0000; HttpOnly
X-Request-Id: 702a3fa9-a8b0-460a-ad2a-30821b66ad76
X-Runtime: 0.021772
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/"1eed6f7834573e7287b05ed080a04e42"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=303f62eed783578d38749f0176f0c1af; path=/; expires=Wed, 13 Jun 2018 12:25:25 -0000; HttpOnly
X-Request-Id: cef8fcf7-3ae2-44f3-9d92-880c81c97ce2
X-Runtime: 0.022188
Content-Length: 253

Body

[
  {
    "id": 74,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  },
  {
    "id": 75,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  },
  {
    "id": 76,
    "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/"993ba13ee494cff9fe7d48d73ebe1fab"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=ca640a537a04f2c5902c243c4332d3eb; path=/; expires=Wed, 13 Jun 2018 12:25:25 -0000; HttpOnly
X-Request-Id: ca429c52-8e7f-4fe0-bd1c-b0252f43ee8c
X-Runtime: 0.117718
Content-Length: 85

Body

[
  {
    "id": 79,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  }
]

Dashboard

Widgets

Request

Route

GET api/companies/101/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/"f417a256636e20e4a1c9a5f95bde460d"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=10c3b35276f08aadeab6a09aa480272a; path=/; expires=Wed, 13 Jun 2018 12:25:25 -0000; HttpOnly
X-Request-Id: d4d0a3c6-c7db-4a7e-8948-80e747d3bb34
X-Runtime: 0.022328
Content-Length: 125

Body

{
  "system_informations": {
    "id": 1,
    "title": "Brandyn Larkin",
    "created_at": "13. 06. 2018",
    "description": "distinctio",
    "image": null
  }
}

Departments

List of departments

Request

Route

GET api/companies/102/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/"8bd81e8d472ac411fd88b86a199c8e86"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=680527ca1ab3ec294c23d405271492fa; path=/; expires=Wed, 13 Jun 2018 12:25:26 -0000; HttpOnly
X-Request-Id: e80cfccb-d056-4f53-afa8-6fd05945e249
X-Runtime: 0.021438
Content-Length: 1050

Body

[
  {
    "id": 18,
    "value": "Anya Schultz Jr.",
    "company_id": 102,
    "created_at": "2018-06-13T12:25:25.000+02:00",
    "updated_at": "2018-06-13T12:25:25.000+02:00",
    "parent_id": null,
    "lft": 1,
    "rgt": 2,
    "position": null,
    "pohoda_id": null
  },
  {
    "id": 19,
    "value": "Miss Krystal Metz",
    "company_id": 102,
    "created_at": "2018-06-13T12:25:25.000+02:00",
    "updated_at": "2018-06-13T12:25:25.000+02:00",
    "parent_id": null,
    "lft": 3,
    "rgt": 4,
    "position": null,
    "pohoda_id": null
  },
  {
    "id": 20,
    "value": "Catherine Lehner",
    "company_id": 102,
    "created_at": "2018-06-13T12:25:26.000+02:00",
    "updated_at": "2018-06-13T12:25:26.000+02:00",
    "parent_id": null,
    "lft": 5,
    "rgt": 6,
    "position": null,
    "pohoda_id": null
  },
  {
    "id": 21,
    "value": "Trent Abshire",
    "company_id": 102,
    "created_at": "2018-06-13T12:25:26.000+02:00",
    "updated_at": "2018-06-13T12:25:26.000+02:00",
    "parent_id": null,
    "lft": 7,
    "rgt": 8,
    "position": null,
    "pohoda_id": null
  },
  {
    "id": 22,
    "value": "Darrick Bernhard",
    "company_id": 102,
    "created_at": "2018-06-13T12:25:26.000+02:00",
    "updated_at": "2018-06-13T12:25:26.000+02:00",
    "parent_id": null,
    "lft": 9,
    "rgt": 10,
    "position": null,
    "pohoda_id": null
  }
]

Logbook

Company's car

Request

Route

GET api/companies/64/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/"c20af17e647e652c90b9dc00ca230012"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1d5f92b6532dbeb4ecdac5596c0a0f9e; path=/; expires=Wed, 13 Jun 2018 12:24:52 -0000; HttpOnly
X-Request-Id: 50783346-dd5b-42ae-95b8-bea88721c3cf
X-Runtime: 0.015841
Content-Length: 315

Body

{
  "id": 7,
  "number_plate": "60-425-6393",
  "description": "Optio ab qui et in laborum et aut.",
  "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": "Jesse Fisher"
  }
}

Company's drive record

Request

Route

GET api/companies/113/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/"bfffe019a2348bea341400456384c40a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=cba58423bafc625a26212fbba4d6069c; path=/; expires=Wed, 13 Jun 2018 12:25:45 -0000; HttpOnly
X-Request-Id: 2589f873-1dec-4a48-ad43-aeef4e820dbe
X-Runtime: 0.130419
Content-Length: 2730

Body

{
  "id": 75,
  "is_private": null,
  "start_location": "17810 Rosetta Isle",
  "end_location": "99049 Hiram Mountain",
  "start_time": "2018-06-13T12:25:40.000+02:00",
  "end_time": "2018-06-13T16:25:40.000+02:00",
  "and_back": null,
  "trip_length": 300,
  "start_tachometer": 0,
  "end_tachometer": 500,
  "purpose": "Occaecati sapiente aut ipsam.",
  "car": {
    "id": 17,
    "number_plate": "30-969-7337",
    "description": "Mollitia et enim rerum magnam iste voluptas porro.",
    "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": "Ms. Callie Tillman"
    }
  },
  "employee": {
    "id": 7,
    "first_name": "Edna",
    "last_name": "Reynolds",
    "bank_account": null,
    "birthday": "2018-06-13",
    "status": null,
    "nationality": null,
    "place_of_birth": null,
    "personal_number": "13. 06. 2018",
    "identification_number": null,
    "employee_number": "number_13. 06. 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": "Occaecati sapiente aut ipsam."
      },
      "car": {
        "id": 17,
        "description": "Mollitia et enim rerum magnam iste voluptas porro."
      },
      "employee": {
        "id": 7,
        "first_name": "Edna",
        "last_name": "Reynolds"
      }
    },
    {
      "id": 220,
      "drive_record_id": 75,
      "price": "120.0",
      "end_price": "120.0",
      "vat_value": "20.0",
      "drive_record": {
        "id": 75,
        "purpose": "Occaecati sapiente aut ipsam."
      },
      "car": {
        "id": 17,
        "description": "Mollitia et enim rerum magnam iste voluptas porro."
      },
      "employee": {
        "id": 7,
        "first_name": "Edna",
        "last_name": "Reynolds"
      }
    }
  ],
  "drive_refuels": [
    {
      "id": 223,
      "place": "8138 Gleason Gardens",
      "amount": "40.0",
      "price": "123.0",
      "end_price": "123.0",
      "vat_id": 37,
      "unit_price": 20,
      "vat_value": "20.0",
      "tachometer_value": 333,
      "drive_record": {
        "id": 75,
        "purpose": "Occaecati sapiente aut ipsam."
      },
      "car": {
        "id": 17,
        "description": "Mollitia et enim rerum magnam iste voluptas porro."
      },
      "employee": {
        "id": 7,
        "first_name": "Edna",
        "last_name": "Reynolds"
      }
    },
    {
      "id": 224,
      "place": "370 Kristian Mill",
      "amount": "40.0",
      "price": "123.0",
      "end_price": "123.0",
      "vat_id": 37,
      "unit_price": 20,
      "vat_value": "20.0",
      "tachometer_value": 333,
      "drive_record": {
        "id": 75,
        "purpose": "Occaecati sapiente aut ipsam."
      },
      "car": {
        "id": 17,
        "description": "Mollitia et enim rerum magnam iste voluptas porro."
      },
      "employee": {
        "id": 7,
        "first_name": "Edna",
        "last_name": "Reynolds"
      }
    },
    {
      "id": 225,
      "place": "5568 Conroy Cliff",
      "amount": "40.0",
      "price": "123.0",
      "end_price": "123.0",
      "vat_id": 37,
      "unit_price": 20,
      "vat_value": "20.0",
      "tachometer_value": 333,
      "drive_record": {
        "id": 75,
        "purpose": "Occaecati sapiente aut ipsam."
      },
      "car": {
        "id": 17,
        "description": "Mollitia et enim rerum magnam iste voluptas porro."
      },
      "employee": {
        "id": 7,
        "first_name": "Edna",
        "last_name": "Reynolds"
      }
    }
  ]
}

List of company's cars

Request

Route

GET api/companies/62/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/"21f461476595f21722b39dca7dc3f8c7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=5222ff73f7892cd14fcaf98c31a7d6c1; path=/; expires=Wed, 13 Jun 2018 12:24:51 -0000; HttpOnly
X-Request-Id: 4f1830e7-1fe8-4712-9d3c-540ae47671ea
X-Runtime: 0.136118
Content-Length: 1014

Body

[
  {
    "id": 1,
    "number_plate": "41-556-8704",
    "description": "Sit qui veritatis doloremque molestias.",
    "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": "Ellis Nolan V"
    }
  },
  {
    "id": 2,
    "number_plate": "49-477-7044",
    "description": "Accusamus optio cumque repudiandae quasi ducimus voluptas inventore.",
    "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": "Mr. Brooke Kovacek"
    }
  },
  {
    "id": 3,
    "number_plate": "52-174-0894",
    "description": "Harum temporibus voluptatem labore alias quod vel.",
    "is_private": false,
    "average_consumption": "5.0",
    "engine_capacity": "30.0",
    "initial_tach_value": 123,
    "year": null,
    "color": null,
    "body_number": null,
    "default_starting_location": null,
    "vin": null,
    "car_type": {
      "id": 3,
      "name": "Winston Keebler"
    }
  }
]

List of company's drive expense types

Request

Route

GET api/companies/103/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/"84841c69f8795092ead8f13d5ea47ebf"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=5b2e45db616d4bd18538320171276c45; path=/; expires=Wed, 13 Jun 2018 12:25:26 -0000; HttpOnly
X-Request-Id: 9d1705b1-b9f7-43ff-b6c3-6cf8920e4160
X-Runtime: 0.123755
Content-Length: 74

Body

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

List of company's drive expenses

Parameters

Name Description
page Page

Request

Route

GET api/companies/105/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/"e6845286fee471aa27b0ffa359abcad7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=e348718f5d73f97a446f706d9cc990c7; path=/; expires=Wed, 13 Jun 2018 12:25:28 -0000; HttpOnly
X-Request-Id: 616720d6-81d4-4690-884e-35e0f0ee3b5e
X-Runtime: 0.053545
Content-Length: 5881

Body

[
  {
    "id": 34,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 33,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 32,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 31,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 30,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 29,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 28,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 27,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 26,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 25,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 24,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 23,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 22,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 21,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 20,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 19,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 18,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 17,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 16,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  },
  {
    "id": 15,
    "drive_record_id": 1,
    "price": "120.0",
    "end_price": "120.0",
    "vat_value": "20.0",
    "drive_record": {
      "id": 1,
      "purpose": "Quidem modi numquam repellendus."
    },
    "car": {
      "id": 13,
      "description": "Rerum sunt eligendi molestiae in eveniet id."
    },
    "employee": {
      "id": 3,
      "first_name": "Eldridge",
      "last_name": "Rath"
    }
  }
]

List of company's drive records

Parameters

Name Description
page Page

Request

Route

GET api/companies/109/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/"219ee36d8ddcedd188a967b234472394"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f3b28d29949dcb908d70ba5e1a85b369; path=/; expires=Wed, 13 Jun 2018 12:25:34 -0000; HttpOnly
X-Request-Id: 7e607c4b-fb21-4817-b7b6-4f88e0232efd
X-Runtime: 0.142689
Content-Length: 6471

Body

[
  {
    "id": 34,
    "purpose": "Perferendis accusamus nostrum eos vel iure.",
    "start_location": "5486 Schroeder Cape",
    "end_location": "80108 Matilde Mountain",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 33,
    "purpose": "Minima labore autem est.",
    "start_location": "8139 Cole Prairie",
    "end_location": "48323 Ondricka Creek",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 32,
    "purpose": "Qui maxime quis sapiente facilis est.",
    "start_location": "2268 Leffler Radial",
    "end_location": "3824 Rutherford Stravenue",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 31,
    "purpose": "Aut unde voluptas in doloremque nihil nostrum.",
    "start_location": "627 Hank Inlet",
    "end_location": "1118 Maxwell Burgs",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 30,
    "purpose": "Qui et ut vero voluptatem.",
    "start_location": "1515 Schuster Street",
    "end_location": "576 Kreiger Underpass",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 29,
    "purpose": "Voluptatibus quia voluptatum maiores omnis quas voluptatem nihil sapiente.",
    "start_location": "78274 Mozelle Causeway",
    "end_location": "53298 Tiara Via",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 28,
    "purpose": "Et aspernatur mollitia voluptatibus modi.",
    "start_location": "596 Garth Glen",
    "end_location": "4972 Strosin Ferry",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 27,
    "purpose": "Et deleniti labore qui rem sapiente soluta quaerat velit.",
    "start_location": "96274 Osinski Glens",
    "end_location": "1331 Larkin Bridge",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 26,
    "purpose": "Aspernatur dolores dolorem voluptatum ut quaerat fuga.",
    "start_location": "9697 Larry Highway",
    "end_location": "3647 Nikolaus Plain",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 25,
    "purpose": "Sunt qui exercitationem beatae aut illo ut sed.",
    "start_location": "296 Leann Loaf",
    "end_location": "198 Lesly Drive",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 24,
    "purpose": "Quis quidem exercitationem reprehenderit.",
    "start_location": "340 Karlie Turnpike",
    "end_location": "66256 Murphy Fords",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 23,
    "purpose": "Sint nulla officia necessitatibus eum ipsum cupiditate repellendus.",
    "start_location": "128 Elisha Falls",
    "end_location": "4421 Logan Shoals",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 22,
    "purpose": "Voluptas quibusdam iusto ratione autem sed.",
    "start_location": "4062 Gorczany Shoals",
    "end_location": "31031 Burdette Keys",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 21,
    "purpose": "Non enim consequuntur ad ipsa repellat expedita consequatur aut.",
    "start_location": "21598 Kertzmann Court",
    "end_location": "8501 Hartmann Gateway",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 20,
    "purpose": "Magnam eos laboriosam voluptatibus rerum et quae et ea.",
    "start_location": "13363 Alexanne Island",
    "end_location": "94055 O'Conner Station",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 19,
    "purpose": "Expedita nobis commodi aut aliquam.",
    "start_location": "850 Effertz Meadows",
    "end_location": "224 Anika Mills",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 18,
    "purpose": "Magni sint in rerum optio earum dolores.",
    "start_location": "2030 Dietrich Corner",
    "end_location": "9451 Aida Pass",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 17,
    "purpose": "Et dolores doloribus sequi et.",
    "start_location": "4002 Corkery Estate",
    "end_location": "2592 Senger Oval",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 16,
    "purpose": "Inventore aliquam voluptatem tempora molestiae cupiditate blanditiis nulla esse.",
    "start_location": "244 Friesen Ranch",
    "end_location": "9720 Wisozk Mission",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  },
  {
    "id": 15,
    "purpose": "Dolorem amet quo alias ad dolore.",
    "start_location": "13253 Cierra Islands",
    "end_location": "9346 Ola Loop",
    "start_tachometer": 0,
    "end_tachometer": 500,
    "trip_length": 300,
    "car": {
      "id": 15,
      "description": "Quia ex totam dolore."
    },
    "employee": {
      "id": 5,
      "first_name": "Harmony",
      "last_name": "Bartell"
    }
  }
]

List of company's drive refuels

Parameters

Name Description
page Page

Request

Route

GET api/companies/115/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/"ccd4092c413f6146f44938d19e14e6a1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=4c3eb44b2c197c7be113e50fa1d75f8b; path=/; expires=Wed, 13 Jun 2018 12:25:47 -0000; HttpOnly
X-Request-Id: fc09c851-7644-401c-84bb-86d0fc8959a7
X-Runtime: 0.162304
Content-Length: 7633

Body

[
  {
    "id": 363,
    "place": "32084 Tillman Greens",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 362,
    "place": "91954 Feest Prairie",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 361,
    "place": "930 Kurtis Stravenue",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 360,
    "place": "9293 Maximillian Corners",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 359,
    "place": "84044 Lisandro Rue",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 358,
    "place": "62707 Harber Views",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 357,
    "place": "15703 Joannie Run",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 356,
    "place": "9288 Rosenbaum Haven",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 355,
    "place": "5346 Kyla Mews",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 354,
    "place": "13367 Haskell Villages",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 353,
    "place": "47205 Bernhard Ford",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 352,
    "place": "9304 Fredrick Valleys",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 351,
    "place": "782 Florida Branch",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 350,
    "place": "26630 Mraz Walk",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 349,
    "place": "11303 Keeling Road",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 348,
    "place": "8218 Aubrey Drive",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 347,
    "place": "2470 Dicki Causeway",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 346,
    "place": "35242 Nicolas Rue",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 345,
    "place": "18364 Kamren Light",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  },
  {
    "id": 344,
    "place": "1406 Sipes Prairie",
    "amount": "40.0",
    "price": "123.0",
    "end_price": "123.0",
    "vat_id": 38,
    "unit_price": 20,
    "vat_value": "20.0",
    "tachometer_value": 333,
    "drive_record": {
      "id": 110,
      "purpose": "Rerum id consectetur inventore molestias pariatur ut a."
    },
    "car": {
      "id": 18,
      "description": "Quia quia dolorem quibusdam."
    },
    "employee": {
      "id": 8,
      "first_name": "Micaela",
      "last_name": "Murray"
    }
  }
]

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/138/partners

Headers

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

Body

{
  "name": "Carlos Pollich",
  "email": "23raven.bayer@example.com",
  "ic": "123456789",
  "dic": null,
  "is_taxable": false,
  "is_supplier": false,
  "is_customer": true,
  "currency_id": 106,
  "address_attributes": {
    "country_id": 1098,
    "city": "West Theodora",
    "street": "Eveline Squares",
    "zip": "35176-7696"
  },
  "postal_address_attributes": {
    "country_id": 1098,
    "city": "West Theodora",
    "street": "Eveline Squares",
    "zip": "35176-7696"
  }
}

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/"d8ced718088c1adb9bd16d740f7731cd"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=52717dc3ecd713ec8b5204f4181930a8; path=/; expires=Wed, 13 Jun 2018 12:25:55 -0000; HttpOnly
X-Request-Id: 0aba248c-ccdb-4d2b-9d44-c40768628bfb
X-Runtime: 0.147138
Content-Length: 632

Body

{
  "id": 299,
  "name": "Carlos Pollich",
  "ic": "123456789",
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "23raven.bayer@example.com",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Eveline Squares",
    "city": "West Theodora",
    "country_id": 1098,
    "zip": "35176-7696"
  },
  "postal_address": {
    "street": "Eveline Squares",
    "city": "West Theodora",
    "country_id": 1098,
    "zip": "35176-7696"
  },
  "contacts": [

  ],
  "bank_accounts": [

  ],
  "currency_id": 106,
  "currency": {
    "id": 106,
    "iso_code": "CZK",
    "name": "Czech crown",
    "symbol": "Kč",
    "symbol_first": false
  }
}

Create a partner by ARES

Parameters

Name Description
ic required Partner Ic

Request

Route

POST api/companies/141/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/"90baf8ab4e9ed6ad1362c47a18664d90"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fe6342c6755d2b1ea4b5a7fde3856f99; path=/; expires=Wed, 13 Jun 2018 12:25:56 -0000; HttpOnly
X-Request-Id: 38029883-a938-44ca-9395-e4c51e5cf2c9
X-Runtime: 0.040069
Content-Length: 520

Body

{
  "id": 322,
  "name": "Railsformers s.r.o.",
  "ic": "24704440",
  "dic": "CZ24704440",
  "dic2": null,
  "is_customer": true,
  "is_supplier": true,
  "phone": null,
  "fax": null,
  "email": null,
  "web": null,
  "paypal": null,
  "is_taxable": true,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Technologická 372/2",
    "city": "Ostrava - Pustkovec",
    "country_id": 1108,
    "zip": "70800"
  },
  "contacts": [

  ],
  "bank_accounts": [

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

Create a partner by ARES end with error

Parameters

Name Description
ic required Partner Ic

Request

Route

POST api/companies/139/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=f651a4dadd3209b3ee3ca498a755ee14; path=/; expires=Wed, 13 Jun 2018 12:25:56 -0000; HttpOnly
X-Request-Id: 4377eddc-6e18-4632-b5e7-c79e884e50e2
X-Runtime: 0.137767
Content-Length: 21

Body

{
  "errors": "[\"ic\"]"
}

Delete a partner

Request

Route

DELETE api/companies/143/partners/332

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=1a43af0e05c5b7529100fedd8d7b02d2; path=/; expires=Wed, 13 Jun 2018 12:25:58 -0000; HttpOnly
X-Request-Id: 714d1a91-00cf-43bd-8418-9e23a14fa143
X-Runtime: 0.145176

Detail of a partner

Request

Route

GET api/companies/137/partners/287

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/"ef4355e29eb7638b8279601db23478c1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=8f09ed18fc0b15f7c5c00e9200eeb63f; path=/; expires=Wed, 13 Jun 2018 12:25:54 -0000; HttpOnly
X-Request-Id: f1510e21-ce4f-45a5-b7e7-226a3b34537d
X-Runtime: 0.052758
Content-Length: 502

Body

{
  "id": 287,
  "name": "Moises Murray",
  "ic": null,
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "13pattie@example.com",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Micheal Ranch",
    "city": "Imashire",
    "country_id": 1096,
    "zip": "15991"
  },
  "contacts": [

  ],
  "bank_accounts": [

  ],
  "currency_id": 105,
  "currency": {
    "id": 105,
    "iso_code": "GBP",
    "name": "Pound sterling",
    "symbol": "£",
    "symbol_first": true
  }
}

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/135/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/"fb421be0a6dc692ab8c17dce16749f28"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=958091b430200fac46297dd485159336; path=/; expires=Wed, 13 Jun 2018 12:25:54 -0000; HttpOnly
X-Request-Id: cbb46a65-99a0-4f9c-af16-d01b79ed82e2
X-Runtime: 0.055053
Content-Length: 2454

Body

[
  {
    "id": 271,
    "name": "Drobný nákup",
    "ic": null,
    "dic": null,
    "is_customer": false,
    "is_supplier": true,
    "email": null,
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "currency": {
      "id": 103,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    }
  },
  {
    "id": 272,
    "name": "Drobný prodej",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": null,
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "currency": {
      "id": 103,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    }
  },
  {
    "id": 273,
    "name": "Savion Blanda",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "3viva@example.com",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Harber Shores",
      "city": "New Darian",
      "city_part": null,
      "zip": "34483"
    },
    "currency": {
      "id": 103,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    }
  },
  {
    "id": 274,
    "name": "Jaquelin Klein",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "4coby@example.com",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Gertrude Forest",
      "city": "South Jessiebury",
      "city_part": null,
      "zip": "14017-5137"
    },
    "currency": {
      "id": 103,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    }
  },
  {
    "id": 275,
    "name": "Irving Schiller Sr.",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "5robyn@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Parker Isle",
      "city": "Faheyside",
      "city_part": null,
      "zip": "67678-6702"
    },
    "currency": {
      "id": 103,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    }
  },
  {
    "id": 276,
    "name": "Aisha Walter",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "6sheila.runolfsdottir@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Schamberger Lodge",
      "city": "Langworthville",
      "city_part": null,
      "zip": "50836-0989"
    },
    "currency": {
      "id": 103,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    }
  },
  {
    "id": 277,
    "name": "Libby Metz",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "7candelario_torp@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Sigmund Fall",
      "city": "Gutkowskiton",
      "city_part": null,
      "zip": "62272"
    },
    "currency": {
      "id": 103,
      "iso_code": "PLN",
      "name": "Polish zloty",
      "symbol": "zł",
      "symbol_first": false
    }
  }
]

Search of partners

Parameters

Name Description
page Page
limit Per page
q[name_or_ic_or_dic_or_address_street_or_address_city_cont] Search by fields

Request

Route

GET api/companies/136/partners?q%5Bname_or_ic_or_dic_or_address_street_or_address_city_cont%5D=Retta+Williamson+DDS

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=Retta Williamson DDS

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/"e8a193d70cd20a8713f103f848db0fa7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=795f3db43740587d8c94985e5c78928b; path=/; expires=Wed, 13 Jun 2018 12:25:54 -0000; HttpOnly
X-Request-Id: 359e1c04-e275-4961-93c7-6d1e48682f18
X-Runtime: 0.021964
Content-Length: 392

Body

[
  {
    "id": 284,
    "name": "Retta Williamson DDS",
    "ic": null,
    "dic": null,
    "is_customer": true,
    "is_supplier": false,
    "email": "12katlynn@example.net",
    "is_taxable": false,
    "invoicing_language": "cs",
    "invoice_due": null,
    "address": {
      "street": "Langosh Hollow",
      "city": "Joantown",
      "city_part": null,
      "zip": "72608-3183"
    },
    "currency": {
      "id": 104,
      "iso_code": "USD",
      "name": "United states dollar",
      "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/142/partners/325

Headers

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

Body

{
  "name": "Benny Beatty",
  "email": "44giles@example.org",
  "ic": "123456789",
  "dic": null,
  "is_taxable": false,
  "is_supplier": false,
  "is_customer": true,
  "currency_id": 110,
  "address_attributes": {
    "country_id": 1109,
    "city": "New Christaburgh",
    "street": "Ledner Mountains",
    "zip": "52996-0037"
  }
}

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/"03894ef58412f8e37c3117b03b545885"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=be4acea567d602a0e8e1872f15277a3f; path=/; expires=Wed, 13 Jun 2018 12:25:57 -0000; HttpOnly
X-Request-Id: 0a7ec225-a908-4ce8-86c9-0a7ecacdf229
X-Runtime: 0.040419
Content-Length: 528

Body

{
  "id": 325,
  "name": "Benny Beatty",
  "ic": "123456789",
  "dic": null,
  "dic2": null,
  "is_customer": true,
  "is_supplier": false,
  "phone": null,
  "fax": null,
  "email": "44giles@example.org",
  "web": null,
  "paypal": null,
  "is_taxable": false,
  "invoicing_language": "cs",
  "invoice_due": null,
  "reminders": false,
  "address": {
    "street": "Ledner Mountains",
    "city": "New Christaburgh",
    "country_id": 1109,
    "zip": "52996-0037"
  },
  "contacts": [

  ],
  "bank_accounts": [

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

Payment Types

List of company's payment types

Request

Route

GET api/companies/144/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/"7d008157494af390f8fcaedad140a021"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=1b89cdd4bc166746eef7868f16dfdf35; path=/; expires=Wed, 13 Jun 2018 12:25:58 -0000; HttpOnly
X-Request-Id: 20001214-94b5-44f5-be36-4d3f65c57208
X-Runtime: 0.020809
Content-Length: 110

Body

[
  {
    "id": 25,
    "name": "Dannie Vandervort Jr."
  },
  {
    "id": 26,
    "name": "Elissa Reichert"
  },
  {
    "id": 27,
    "name": "Sierra Sporer"
  }
]

Scans

Company's processed scan

Request

Route

GET api/companies/154/scans/2deeb450-6ef4-11e8-8323-02426fe1ba3e

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/"4046b455d2222904f502529e70273068"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=341dcae229a8c3131b0e59e7ae534916; path=/; expires=Wed, 13 Jun 2018 12:26:05 -0000; HttpOnly
X-Request-Id: 0acaf616-c8c9-458c-bafd-a49d425a3e6c
X-Runtime: 0.012225
Content-Length: 790

Body

{
  "id": "2deeb450-6ef4-11e8-8323-02426fe1ba3e",
  "size": 95,
  "content_type": "text/plain",
  "state": "Zpracovaná",
  "state_id": 3,
  "created_at": "St 13. Červen 2018 12:26 +0200",
  "actuarial_id": null,
  "total_price": "1000.0",
  "partner_name": "Huels, Dibbert and Witting",
  "partner_ic": "79-664-1763",
  "partner_dic": "CZ93-075-0855",
  "partner_street": "Georgiana Extensions",
  "partner_city": "New Tania",
  "partner_zip": "26101-9578",
  "partner_country_id": 1,
  "company_name": "McDermott Group",
  "company_ic": "52-367-3060",
  "company_dic": "CZ74-086-6413",
  "company_street": "Troy Corner",
  "company_city": "North Jeanne",
  "company_zip": "52298-7052",
  "company_country_id": 1,
  "payment_type": "checkout",
  "variable_symbol": "123456789",
  "currency_id": "1",
  "due_date_at": "23. 06. 2018",
  "issue_date_at": "13. 06. 2018",
  "uzp_date_at": "13. 06. 2018"
}

Company's scan

Request

Route

GET api/companies/153/scans/2d6be4d0-6ef4-11e8-8323-02426fe1ba3e

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/"dd0ee527a2b9cb488c6cca044514813e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f7a960430f6a3c0805423fca04ea69fd; path=/; expires=Wed, 13 Jun 2018 12:26:05 -0000; HttpOnly
X-Request-Id: 75913844-d53c-42fb-bf17-c1e1d03286c7
X-Runtime: 0.011992
Content-Length: 610

Body

{
  "id": "2d6be4d0-6ef4-11e8-8323-02426fe1ba3e",
  "size": 95,
  "content_type": "text/plain",
  "state": "Nahraná",
  "state_id": 1,
  "created_at": "St 13. Červen 2018 12:26 +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/155/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/"ba069861abff43cb433fb0dfbf735fc3"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=b2f83e5324571cb6671f4c217f295e53; path=/; expires=Wed, 13 Jun 2018 12:26:06 -0000; HttpOnly
X-Request-Id: d1542015-fca7-40b3-b72d-b585fbe66299
X-Runtime: 0.221632
Content-Length: 613

Body

{
  "id": "0c1e0fba-d15d-425f-965c-74d651d39893",
  "size": 13706,
  "content_type": "text/plain",
  "state": "Nahraná",
  "state_id": 1,
  "created_at": "St 13. Červen 2018 12:26 +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/157/scans/2f3daa46-6ef4-11e8-8323-02426fe1ba3e/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=8a4ed1a68c7c58110a97009d6dff1902; path=/; expires=Wed, 13 Jun 2018 12:26:07 -0000; HttpOnly
X-Request-Id: 8e80d58b-fb6a-4c42-9117-1fb40788fa8d
X-Runtime: 0.010553
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/151/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/"2d1cbd38f6f6431c2d20799afce7e1e1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=cf01694e762c51bf45e0265e5f2301c4; path=/; expires=Wed, 13 Jun 2018 12:26:03 -0000; HttpOnly
X-Request-Id: 816fb3b9-0115-48aa-8b77-b810f42b89f6
X-Runtime: 0.012233
Content-Length: 559

Body

[
  {
    "id": "2c8d32a8-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "St 13. Červen 2018 12:26 +0200",
    "actuarial_id": null
  },
  {
    "id": "2c7f0de0-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "St 13. Červen 2018 12:26 +0200",
    "actuarial_id": null
  },
  {
    "id": "2c6377ba-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Zpracovaná",
    "state_id": 3,
    "created_at": "St 13. Červen 2018 12:26 +0200",
    "actuarial_id": null
  }
]

List of company's processing scans

Parameters

Name Description
page Page
limit Per page

Request

Route

GET api/companies/149/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/"7eac0b0a875a32e6050f25f31ef20a3f"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=fe87555ccb55f4587225ce4731d67eb7; path=/; expires=Wed, 13 Jun 2018 12:26:01 -0000; HttpOnly
X-Request-Id: ea39734d-7c7a-4007-8378-10d8f2240803
X-Runtime: 0.011944
Content-Length: 571

Body

[
  {
    "id": "2b6774b0-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Ve zpracování",
    "state_id": 2,
    "created_at": "St 13. Červen 2018 12:26 +0200",
    "actuarial_id": null
  },
  {
    "id": "2b5c58a0-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Ve zpracování",
    "state_id": 2,
    "created_at": "St 13. Červen 2018 12:26 +0200",
    "actuarial_id": null
  },
  {
    "id": "2b40579a-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Ve zpracování",
    "state_id": 2,
    "created_at": "St 13. Červen 2018 12:26 +0200",
    "actuarial_id": null
  }
]

List of company's scans

Parameters

Name Description
page Page
limit Per page

Request

Route

GET api/companies/145/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/"5e905ece40ddffe9d894ae5a045d3aac"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=3784a0f4126f8c0f6385af5109fadbf4; path=/; expires=Wed, 13 Jun 2018 12:25:59 -0000; HttpOnly
X-Request-Id: 36701521-ad88-4387-b5df-6ce240e4e958
X-Runtime: 0.029941
Content-Length: 550

Body

[
  {
    "id": "29bdfb20-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 13. Červen 2018 12:25 +0200",
    "actuarial_id": null
  },
  {
    "id": "29c9de86-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 13. Červen 2018 12:25 +0200",
    "actuarial_id": null
  },
  {
    "id": "29d6de38-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 13. Červen 2018 12:25 +0200",
    "actuarial_id": null
  }
]

List of company's unprocessed scans

Parameters

Name Description
page Page
limit Per page

Request

Route

GET api/companies/147/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/"4333c209a6237315a6414c44c8ee35c3"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=5b5a314724160e437acc10c6688dd8e5; path=/; expires=Wed, 13 Jun 2018 12:26:00 -0000; HttpOnly
X-Request-Id: d2e20c90-658e-4377-9d02-782647bde029
X-Runtime: 0.013643
Content-Length: 550

Body

[
  {
    "id": "2a8859ce-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 13. Červen 2018 12:26 +0200",
    "actuarial_id": null
  },
  {
    "id": "2a7d16d6-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 13. Červen 2018 12:25 +0200",
    "actuarial_id": null
  },
  {
    "id": "2a70b792-6ef4-11e8-8323-02426fe1ba3e",
    "size": 95,
    "content_type": "text/plain",
    "state": "Nahraná",
    "state_id": 1,
    "created_at": "St 13. Červen 2018 12:25 +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/"0b7827292081e6735a565bf0ab585089"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: af321597-a399-4b9a-a887-42a69d990038
X-Runtime: 0.068849
Content-Length: 71

Body

{
  "email": "test@test.com",
  "authentication_token": "gQ7Ehit2JQYeaYjVZ-BV"
}

System informations

List of system informations

Request

Route

GET api/companies/158/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/"1f48baca76076897247939a7fecf92d4"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=f3aeba2059e6f08b3c1bcf0d069aa942; path=/; expires=Wed, 13 Jun 2018 12:26:08 -0000; HttpOnly
X-Request-Id: 3af37904-a1e2-4adf-84ef-e52aa2a92b1f
X-Runtime: 0.128476
Content-Length: 290

Body

[
  {
    "id": 4,
    "title": "Madisen Lakin",
    "created_at": "13. 06. 2018",
    "description": "quidem",
    "image": null
  },
  {
    "id": 3,
    "title": "Al Fritsch",
    "created_at": "13. 06. 2018",
    "description": "repellat",
    "image": null
  },
  {
    "id": 2,
    "title": "Elnora Nikolaus",
    "created_at": "13. 06. 2018",
    "description": "eos",
    "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/"c3b8b802089f9875977cd1a8914e7fbe"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: your_session_key=9de0f3520d12cdd772d4fa114698dfd4; path=/; expires=Wed, 13 Jun 2018 12:26:08 -0000; HttpOnly
X-Request-Id: 9318b8c8-3127-4cb7-956a-19d39876ae82
X-Runtime: 0.018083
Content-Length: 87

Body

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