Fakturoid API v3

https://www.fakturoid.cz/api/v3
Admin
Fakturoid API v3 provides programmatic access to Fakturoid's invoicing and business management...
Tokens:129,650
Snippets:511
Trust Score:9.5
Update:6 days ago
Show doc for...
Tokens:
Raw
### Unit Price Examples

Source: https://www.fakturoid.cz/api/v3/recurring-generators

Examples showing how to set unit prices with different VAT price modes and the corresponding responses.

```APIDOC
## Unit Price Examples

### Description
Examples of request and response for setting unit prices with `vat_price_mode` set to `without_vat` or `from_total_with_vat`.

### Unit price without VAT

#### Request
```json
{
  "vat_price_mode": "without_vat",
  "lines": [
    {
      "unit_price": "1000.0",
      "vat_rate": "21"
    }
  ]
}
```

#### Response
```json
{
  "vat_price_mode": "without_vat",
  "lines": [
    {
      "unit_price": "1000.0",
      "vat_rate": "21",
      "unit_price_without_vat": "1000.0",
      "unit_price_with_vat": "1210.0"
    }
  ]
}
```

### Unit price with VAT

#### Request
```json
{
  "vat_price_mode": "from_total_with_vat",
  "lines": [
    {
      "unit_price": "1210.0",
      "vat_rate": "21"
    }
  ]
}
```

#### Response
```json
{
  "vat_price_mode": "from_total_with_vat",
  "lines": [
    {
      "unit_price": "1000.0",
      "vat_rate": "21",
      "unit_price_without_vat": "1000.0",
      "unit_price_with_vat": "1210.0"
    }
  ]
}
```
```

--------------------------------

### Retail Price Example

Source: https://www.fakturoid.cz/api/v3/inventory-items

Example of a retail price object with id, amount, currency, and timestamps. When editing a document, include the retail price ID to avoid duplicate creation.

```json
{
  "id": 1304,
  "amount": "10",
  "currency": "USD",
  "created_at": "2025-10-23T13:50:00.000+02:00",
  "updated_at": "2025-10-23T13:52:00.000+02:00"
  }
}
```

--------------------------------

### Line Example

Source: https://www.fakturoid.cz/api/v3/expenses

Example of a line object with all attributes, including inventory information. Note that when editing a document, the line ID must be sent; otherwise the line will be added again. The unit_price_without_vat and unit_price_with_vat attributes are read-only and are set based on unit_price, vat_rate, and vat_price_mode.

```json
{
  "id": 1304,
  "name": "Disk 2TB",
  "quantity": "2.0",
  "unit_name": "ks",
  "unit_price": "1000.0",
  "vat_rate": 21,
  "unit_price_without_vat": "1000.0",
  "unit_price_with_vat": "1210.0",
  "total_price_without_vat": "2000.0",
  "total_vat": "420.0",
  "native_total_price_without_vat": "2000.0",
  "native_total_vat": "420.0",
  "inventory": {
    "item_id": 28,
    "sku": "KU994RUR8465",
    "article_number_type": "ian",
    "article_number": "32165478",
    "move_id": 52
  }
}
```

--------------------------------

### Delete Retail Price Example

Source: https://www.fakturoid.cz/api/v3/inventory-items

Example of a retail price object with the `_destroy: true` attribute to delete the retail price.

```json
{
  "id": 1304,
  "amount": "10",
  "currency": "USD",
  "_destroy": true
}
```

--------------------------------

### Inventory Move Detail Response Body

Source: https://www.fakturoid.cz/api/v3/inventory-moves

Example JSON response body for a successful GET request to retrieve an inventory move. The response includes move details such as direction, quantities, prices, and document reference.

```json
{
  "id": 12,
  "direction": "out",
  "moved_on": "2023-08-21",
  "quantity_change": "980.0",
  "purchase_price": "1273.474",
  "purchase_currency": "CZK",
  "native_purchase_price": "1273.474",
  "retail_price": "2528.0",
  "retail_currency": "CZK",
  "native_retail_price": "2528.0",
  "private_note": null,
  "inventory_item_id": 1,
  "document": {
    "id": 540,
    "type": "Invoice",
    "line_id": 1298
  },
  "created_at": "2023-09-05T13:26:20.968+02:00",
  "updated_at": "2023-09-05T13:26:20.968+02:00"
}
```

--------------------------------

### GET /inventory_items.json

Source: https://www.fakturoid.cz/api/v3/inventory-items

Returns a list of inventory items.

```APIDOC
## GET /inventory_items.json

### Description
Returns a list of inventory items.

### Method
GET

### Endpoint
/inventory_items.json

### Parameters
#### Query Parameters
- **page** (Integer) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **inventory_items** (Array) - List of inventory items.

#### Response Example
```json
{
  "inventory_items": [
    {
      "id": 1,
      "name": "Example Item",
      "sku": "SKU123",
      "article_number_type": "ian",
      "article_number": "1234567890123",
      "unit_name": "pcs",
      "track_quantity": true,
      "quantity": "10.0",
      "min_quantity": "0.0",
      "max_quantity": "100.0",
      "allow_below_zero": false,
      "low_quantity_date": null,
      "native_purchase_price": "5.0",
      "native_retail_price": "10.0",
      "vat_rate": "standard",
      "average_native_purchase_price": "5.0",
      "supply_type": "goods",
      "archived": false,
      "private_note": null,
      "suggest_for": "both",
      "retail_prices": [],
      "created_at": "2025-10-23T13:50:00.000+02:00",
      "updated_at": "2025-10-23T13:52:00.000+02:00"
    }
  ]
}
```

```

--------------------------------

### GET /accounts/{slug}/inventory_items/{id}.json - Response Body

Source: https://www.fakturoid.cz/api/v3/inventory-items

Example JSON response for a successful item detail request. The response includes item attributes such as id, name, sku, quantity, and pricing information.

```json
{
  "id": 11,
  "name": "Magic mouse",
  "sku": "KU994RUR9439",
  "article_number_type": "ian",
  "article_number": null,
  "unit_name": null,
  "track_quantity": true,
  "quantity": "1998.0",
  "min_quantity": "538.0",
  "max_quantity": "2167.0",
  "allow_below_zero": false,
  "low_quantity_date": null,
  "native_purchase_price": "500.0",
  "native_retail_price": "1000.0",
  "vat_rate": "standard",
  "average_native_purchase_price": "500.0",
  "supply_type": "goods",
  "archived": false,
  "private_note": null,
  "suggest_for": "invoices",
  "created_at": "2023-09-05T13:26:21.175+02:00",
  "updated_at": "2023-09-05T13:26:21.180+02:00"
}
```

--------------------------------

### Response with attachment example

Source: https://www.fakturoid.cz/api/v3/expenses

Shows the response format when an expense has attachments. Each attachment includes id, filename, content_type, and download_url attributes.

```json
{
  …, // Other document attributes
  "attachments": [
    {
      "id": 3,
      "filename": "64d814c560.pdf",
      "content_type": "application/pdf",
      "download_url": "https://app.fakturoid.cz/api/v3/accounts/applecorp/expenses/9/attachments/1/download"
    }
  ]
}
```

--------------------------------

### Unit price with VAT

Source: https://www.fakturoid.cz/api/v3/expenses

Example of setting a line with unit price including VAT using vat_price_mode 'from_total_with_vat'.

```APIDOC
## Unit price with VAT

### Description
Example of setting a line with unit price including VAT using vat_price_mode 'from_total_with_vat'.

### Request Example
```json
{
  "vat_price_mode": "from_total_with_vat",
  "lines": [
    {
      "unit_price": "1210.0",
      "vat_rate": "21"
    }
  ]
}
```

### Response Example
```json
{
  "vat_price_mode": "from_total_with_vat",
  "lines": [
    {
      "unit_price": "1000.0",
      "vat_rate": "21",
      "unit_price_without_vat": "1000.0",
      "unit_price_with_vat": "1210.0"
    }
  ]
}
```
```

--------------------------------

### Response without attachment example

Source: https://www.fakturoid.cz/api/v3/expenses

Shows the response format when an expense has no attachments. The attachments array is empty.

```json
{
  …, // Other document attributes
  "attachments": []
}
```

--------------------------------

### GET /accounts/{slug}/inbox_files.json - List Inbox Files

Source: https://www.fakturoid.cz/api/v3/inbox-files

Lists inbox files for the account. The response is a JSON array of inbox file objects. The example shows a single file with fields like id, filename, bytesize, and download_url.

```json
[
  {
    "id": 51,
    "filename": "INV123654.png",
    "bytesize": 1304,
    "send_to_ocr": false,
    "sent_to_ocr_at": null,
    "ocr_status": null,
    "ocr_completed_at": null,
    "download_url": "https://app.fakturoid.cz/api/v3/accounts/applecorp/inbox_files/51/download",
    "created_at": "2023-12-04T09:49:58.188+01:00",
    "updated_at": "2023-12-04T09:49:58.237+01:00"
  },
  …
]
```

--------------------------------

### Create Payment Response Body

Source: https://www.fakturoid.cz/api/v3/invoice-payments

Example response body for a successful payment creation (201 Created). Contains payment details such as id, paid_on, currency, amount, and variable_symbol.

```json
{
  "id": 2,
  "paid_on": "2023-12-08",
  "currency": "CZK",
  "amount": "1210.0",
  "native_amount": "1210.0",
  "variable_symbol": "120230004",
  "bank_account_id": 11,
  "tax_document_id": null,
  "created_at": "2024-01-12T11:58:30.468+01:00",
  "updated_at": "2024-01-15T16:32:08.890+01:00"
}
```

--------------------------------

### Todos Index - Response Body (JSON)

Source: https://www.fakturoid.cz/api/v3/todos

Example response body for a successful 200 OK request. Contains an array of todo objects with fields like id, name, created_at, completed_at, text, related_objects, and params.

```json
[
  {
    "id": 36,
    "name": "inbox_files_too_many_attachments",
    "created_at": "2023-09-05T13:26:21.662+02:00",
    "completed_at": null,
    "text": "Počet příloh v emailu překračuje zbývající kapacitu krabice",
    "related_objects": [],
    "params": {
      "email_from": "borivoj.hejsek@example.com",
      "count": "3",
      "attachments": "expense-145-4.pdf, photo-145-4.jpg, image-687-5455668-67.gif"
    }
  },
  {
    "id": 35,
    "name": "account_exceeded_vat_turnover_limit",
    "created_at": "2023-09-05T13:26:21.660+02:00",
    "completed_at": null,
    "text": "Zdá se, že jste překročili obrat pro povinnou registrace k DPH.",
    "related_objects": [
      {
        "type": "Subject",
        "id": 32
      }
    ],
    "params": {
      "register_until_date": "2017-10-15",
      "vat_payer_from_date": "2017-11-01"
    }
  },
  {
    "id": 33,
    "name": "email_bounced",
    "created_at": "2023-09-05T13:26:21.654+02:00",
    "completed_at": null,
    "text": "Email na test@test.com se nepodařil doručit",
    "related_objects": [
      {
        "type": "Subject",
        "id": 32
      }
    ],
    "params": {
      "email": "test@test.com",
      "inactive": "true"
    }
  },
  {
    "id": 32,
    "name": "expense_payment_unpaired",
    "created_at": "2023-09-05T13:26:21.651+02:00",
    "completed_at": null,
    "text": "Nespárovaná odchozí platba - VS: 123456789, částka: € 123,00 ",
    "related_objects": [],
    "params": {
      "note": "",
      "amount": "123",
      "currency": "EUR",
      "bank_account_id": "21",
      "variable_symbol": "123456789",
      "bank_account_name": "Účet"
    }
  },
  …
]
```

--------------------------------

### Create Webhook

Source: https://www.fakturoid.cz/api/v3/webhooks

Creates a new webhook.

```APIDOC
## [POST] /webhooks

### Description
Creates a new webhook with the specified attributes.

### Method
POST

### Endpoint
/webhooks

### Parameters
#### Request Body
- **webhook_url** (String) - Required - URL of webhook endpoint
- **auth_header** (String) - Optional - Value sent in Authorization header
- **active** (Boolean) - Optional - Send webhook?
- **events** (Array[String]) - Optional - List of events when webhook is fired

### Request Example
```json
{
  "webhook_url": "https://example.com/hook",
  "auth_header": "Bearer token",
  "active": true,
  "events": ["invoice_created", "invoice_paid"]
}
```

### Response
#### Success Response (201)
- **webhook** (Webhook) - The created webhook object

#### Response Example
```json
{
  "id": 1,
  "failed_deliveries_uuid": "uuid",
  "webhook_url": "https://example.com/hook",
  "auth_header": "Bearer token",
  "active": true,
  "events": ["invoice_created"],
  "url": "https://app.fakturoid.cz/api/v3/webhooks/1",
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z"
}
```
```

--------------------------------

### GET /inventory_items/search.json

Source: https://www.fakturoid.cz/api/v3/inventory-items

Searches inventory items by query.

```APIDOC
## GET /inventory_items/search.json

### Description
Searches inventory items by query.

### Method
GET

### Endpoint
/inventory_items/search.json

### Parameters
#### Query Parameters
- **query** (String) - Required - Search query.
- **page** (Integer) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **inventory_items** (Array) - List of matching inventory items.

#### Response Example
```json
{
  "inventory_items": [
    {
      "id": 1,
      "name": "Example Item",
      "sku": "SKU123",
      "article_number_type": "ian",
      "article_number": "1234567890123",
      "unit_name": "pcs",
      "track_quantity": true,
      "quantity": "10.0",
      "min_quantity": "0.0",
      "max_quantity": "100.0",
      "allow_below_zero": false,
      "low_quantity_date": null,
      "native_purchase_price": "5.0",
      "native_retail_price": "10.0",
      "vat_rate": "standard",
      "average_native_purchase_price": "5.0",
      "supply_type": "goods",
      "archived": false,
      "private_note": null,
      "suggest_for": "both",
      "retail_prices": [],
      "created_at": "2025-10-23T13:50:00.000+02:00",
      "updated_at": "2025-10-23T13:52:00.000+02:00"
    }
  ]
}
```

```

--------------------------------

### POST /accounts/{slug}/inventory_items.json - Request Body

Source: https://www.fakturoid.cz/api/v3/inventory-items

Example JSON body for creating an inventory item. Required fields include name and sku; other fields like track_quantity, quantity, and pricing are optional.

```json
{
  "name": "Keyboard 55F",
  "sku": "00TF6455F",
  "track_quantity": true,
  "quantity": 50,
  "native_purchase_price": 150,
  "native_retail_price": 250
}
```

--------------------------------

### Get generator details with GET /accounts/{slug}/generators/{id}.json

Source: https://www.fakturoid.cz/api/v3/generators

Retrieves details for a single generator. Requires the account slug and generator ID as path parameters. The response includes the generator's configuration, totals, and line items.

```HTTP
GET https://app.fakturoid.cz/api/v3/accounts/{slug}/generators/{id}.json
```

--------------------------------

### GET /accounts/{slug}/todos.json - Request URL

Source: https://www.fakturoid.cz/api/v3/todos

The endpoint to list todos. Requires a User-Agent header and the account slug. The 'since' query parameter must be in ISO 8601 format, otherwise a 400 Bad Request is returned.

```http
GET https://app.fakturoid.cz/api/v3/accounts/{slug}/todos.json
```

--------------------------------

### GET /inventory_items/archived.json

Source: https://www.fakturoid.cz/api/v3/inventory-items

Returns a list of archived inventory items.

```APIDOC
## GET /inventory_items/archived.json

### Description
Returns a list of archived inventory items.

### Method
GET

### Endpoint
/inventory_items/archived.json

### Parameters
#### Query Parameters
- **page** (Integer) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **inventory_items** (Array) - List of archived inventory items.

#### Response Example
```json
{
  "inventory_items": [
    {
      "id": 2,
      "name": "Archived Item",
      "sku": "SKU456",
      "article_number_type": "ean",
      "article_number": "1234567890123",
      "unit_name": "pcs",
      "track_quantity": false,
      "quantity": "0.0",
      "min_quantity": "0.0",
      "max_quantity": null,
      "allow_below_zero": false,
      "low_quantity_date": null,
      "native_purchase_price": "0.0",
      "native_retail_price": "0.0",
      "vat_rate": "standard",
      "average_native_purchase_price": "0.0",
      "supply_type": "goods",
      "archived": true,
      "private_note": null,
      "suggest_for": "both",
      "retail_prices": [],
      "created_at": "2025-10-23T13:50:00.000+02:00",
      "updated_at": "2025-10-23T13:52:00.000+02:00"
    }
  ]
}
```

```

--------------------------------

### Create Inventory Move Response Body

Source: https://www.fakturoid.cz/api/v3/inventory-moves

Example JSON response body for a successful create request. Shows the created move with a Location header pointing to the new resource.

```json
{
  "id": 51,
  "direction": "in",
  "moved_on": "2023-11-10",
  "quantity_change": "35.0",
  "purchase_price": "50.0",
  "purchase_currency": null,
  "native_purchase_price": "50.0",
  "retail_price": null,
  "retail_currency": "CZK",
  "native_retail_price": null,
  "private_note": null,
  "inventory_item_id": 1,
  "document": null,
  "created_at": "2023-11-10T15:47:46.269+01:00",
  "updated_at": "2023-11-10T15:47:46.269+01:00"
}
```

--------------------------------

### GET /inventory_items/{id}.json

Source: https://www.fakturoid.cz/api/v3/inventory-items

Returns a single inventory item by its ID.

```APIDOC
## GET /inventory_items/{id}.json

### Description
Returns a single inventory item by its ID.

### Method
GET

### Endpoint
/inventory_items/{id}.json

### Parameters
#### Path Parameters
- **id** (Integer) - Required - Unique identifier of the inventory item.

### Response
#### Success Response (200)
- **inventory_item** (Object) - The inventory item details.

#### Response Example
```json
{
  "inventory_item": {
    "id": 1,
    "name": "Example Item",
    "sku": "SKU123",
    "article_number_type": "ian",
    "article_number": "1234567890123",
    "unit_name": "pcs",
    "track_quantity": true,
    "quantity": "10.0",
    "min_quantity": "0.0",
    "max_quantity": "100.0",
    "allow_below_zero": false,
    "low_quantity_date": null,
    "native_purchase_price": "5.0",
    "native_retail_price": "10.0",
    "vat_rate": "standard",
    "average_native_purchase_price": "5.0",
    "supply_type": "goods",
    "archived": false,
    "private_note": null,
    "suggest_for": "both",
    "retail_prices": [],
    "created_at": "2025-10-23T13:50:00.000+02:00",
    "updated_at": "2025-10-23T13:52:00.000+02:00"
  }
}
```

```

--------------------------------

### POST /inventory_items.json

Source: https://www.fakturoid.cz/api/v3/inventory-items

Creates a new inventory item.

```APIDOC
## POST /inventory_items.json

### Description
Creates a new inventory item.

### Method
POST

### Endpoint
/inventory_items.json

### Parameters
#### Request Body
- **name** (String) - Required - Item name.
- **sku** (String) - Optional - Stock Keeping Unit (SKU). Required if `track_quantity` is enabled.
- **article_number_type** (String) - Optional - Article number type. Values: `ian`, `ean`, `isbn`. Default: `ian`.
- **article_number** (String) - Optional - Article number.
- **unit_name** (String) - Optional - Unit of measure.
- **track_quantity** (Boolean) - Optional - Track quantity via inventory moves? Default: `false`.
- **quantity** (Decimal) - Optional - Quantity in stock. Required if `track_quantity` is enabled. Becomes read-only after item creation and can be changed only via inventory moves.
- **min_quantity** (Decimal) - Optional - Minimum stock quantity.
- **max_quantity** (Decimal) - Optional - Maximum stock quantity.
- **allow_below_zero** (Boolean) - Optional - Allow quantity below zero. Default: `false`.
- **native_purchase_price** (Decimal) - Optional - Unit purchase price without VAT in account currency. Required if `track_quantity` is enabled.
- **native_retail_price** (Decimal) - Optional - Unit retail price without VAT in account currency.
- **vat_rate** (String) - Optional - VAT rate. Values: `standard` (21%), `reduced` (12%), `reduced2` (10%), `zero` (0%).
- **supply_type** (String) - Optional - Item type. Values: `goods`, `service`. Default: `goods`.
- **private_note** (Text) - Optional - Private note.
- **suggest_for** (String) - Optional - Suggest item for documents. Values: `invoices`, `expenses`, `both`. Default: `both`.
- **retail_prices** (Array[Object]) - Optional - List of retail prices for specific currencies.

### Request Example
```json
{
  "inventory_item": {
    "name": "New Item",
    "sku": "SKU123",
    "article_number_type": "ian",
    "article_number": "1234567890123",
    "unit_name": "pcs",
    "track_quantity": true,
    "quantity": "10.0",
    "min_quantity": "0.0",
    "max_quantity": "100.0",
    "allow_below_zero": false,
    "native_purchase_price": "5.0",
    "native_retail_price": "10.0",
    "vat_rate": "standard",
    "supply_type": "goods",
    "private_note": null,
    "suggest_for": "both",
    "retail_prices": []
  }
}
```

### Response
#### Success Response (201)
- **inventory_item** (Object) - The created inventory item.

#### Response Example
```json
{
  "inventory_item": {
    "id": 1,
    "name": "New Item",
    "sku": "SKU123",
    "article_number_type": "ian",
    "article_number": "1234567890123",
    "unit_name": "pcs",
    "track_quantity": true,
    "quantity": "10.0",
    "min_quantity": "0.0",
    "max_quantity": "100.0",
    "allow_below_zero": false,
    "low_quantity_date": null,
    "native_purchase_price": "5.0",
    "native_retail_price": "10.0",
    "vat_rate": "standard",
    "average_native_purchase_price": "5.0",
    "supply_type": "goods",
    "archived": false,
    "private_note": null,
    "suggest_for": "both",
    "retail_prices": [],
    "created_at": "2025-10-23T13:50:00.000+02:00",
    "updated_at": "2025-10-23T13:52:00.000+02:00"
  }
}
```

```

--------------------------------

### GET /inventory_items/low_quantity.json

Source: https://www.fakturoid.cz/api/v3/inventory-items

Returns a list of inventory items with low quantity (quantity below min_quantity).

```APIDOC
## GET /inventory_items/low_quantity.json

### Description
Returns a list of inventory items with low quantity (quantity below min_quantity).

### Method
GET

### Endpoint
/inventory_items/low_quantity.json

### Parameters
#### Query Parameters
- **page** (Integer) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **inventory_items** (Array) - List of inventory items with low quantity.

#### Response Example
```json
{
  "inventory_items": [
    {
      "id": 3,
      "name": "Low Quantity Item",
      "sku": "SKU789",
      "article_number_type": "isbn",
      "article_number": "1234567890123",
      "unit_name": "pcs",
      "track_quantity": true,
      "quantity": "1.0",
      "min_quantity": "5.0",
      "max_quantity": "100.0",
      "allow_below_zero": false,
      "low_quantity_date": "2025-10-23T13:50:00.000+02:00",
      "native_purchase_price": "5.0",
      "native_retail_price": "10.0",
      "vat_rate": "standard",
      "average_native_purchase_price": "5.0",
      "supply_type": "goods",
      "archived": false,
      "private_note": null,
      "suggest_for": "both",
      "retail_prices": [],
      "created_at": "2025-10-23T13:50:00.000+02:00",
      "updated_at": "2025-10-23T13:52:00.000+02:00"
    }
  ]
}
```

```

--------------------------------

### POST /accounts/{slug}/inventory_items/{inventory_item_id}/inventory_moves.json

Source: https://www.fakturoid.cz/api/v3/inventory-moves

Creates a new inventory move. Returns 201 Created with the move data and a Location header on success, or 422 Unprocessable Content with error details on invalid data.

```APIDOC
## [POST] /accounts/{slug}/inventory_items/{inventory_item_id}/inventory_moves.json

### Description
Creates a new inventory move. Returns 201 Created with the move data and a Location header on success, or 422 Unprocessable Content with error details on invalid data.

### Method
POST

### Endpoint
/accounts/{slug}/inventory_items/{inventory_item_id}/inventory_moves.json

### Parameters
#### URL Parameters
- **slug** (String) - Required - Account name
- **inventory_item_id** (Integer) - Required - Inventory item ID

#### Request Body
- **direction** (String) - Required - Direction of the move (e.g., "in")
- **moved_on** (String) - Required - Date of the move
- **quantity_change** (String) - Required - Quantity change
- **purchase_price** (String) - Required - Purchase price

### Request Example
{
  "direction": "in",
  "moved_on": "2023-11-10",
  "quantity_change": "35",
  "purchase_price": "50"
}

### Response
#### Success Response (201 Created)
- **id** (Integer) - Move ID
- **direction** (String) - Direction of the move
- **moved_on** (String) - Date of the move
- **quantity_change** (String) - Quantity change
- **purchase_price** (String) - Purchase price
- **purchase_currency** (String) - Purchase currency
- **native_purchase_price** (String) - Native purchase price
- **retail_price** (String) - Retail price
- **retail_currency** (String) - Retail currency
- **native_retail_price** (String) - Native retail price
- **private_note** (String) - Private note
- **inventory_item_id** (Integer) - Inventory item ID
- **document** (Object) - Document details
- **created_at** (String) - Creation timestamp
- **updated_at** (String) - Update timestamp

#### Response Example
{
  "id": 51,
  "direction": "in",
  "moved_on": "2023-11-10",
  "quantity_change": "35.0",
  "purchase_price": "50.0",
  "purchase_currency": null,
  "native_purchase_price": "50.0",
  "retail_price": null,
  "retail_currency": "CZK",
  "native_retail_price": null,
  "private_note": null,
  "inventory_item_id": 1,
  "document": null,
  "created_at": "2023-11-10T15:47:46.269+01:00",
  "updated_at": "2023-11-10T15:47:46.269+01:00"
}

#### Error Response (422 Unprocessable Content)
- **errors** (Object) - Object containing field-specific error messages

#### Error Response Example
{
  "errors": {
    "purchase_price": [
      "can't be blank"
    ]
  }
}
```

--------------------------------

### Create Subject

Source: https://www.fakturoid.cz/api/v3/subjects

Creates a new subject.

```APIDOC
## POST /api/v3/accounts/{account_slug}/subjects.json

### Description
Creates a new subject.

### Method
POST

### Endpoint
/api/v3/accounts/{account_slug}/subjects.json

### Parameters
#### Path Parameters
- **account_slug** (string) - Required - Account slug

#### Request Body
- **subject** (object) - Required - Subject attributes

### Request Example
{
  "subject": {
    "name": "Example Company",
    "type": "customer"
  }
}

### Response
#### Success Response (201)
- **subject** (object) - Created subject

#### Response Example
{
  "subject": {
    "id": 1,
    "name": "Example Company"
  }
}
```

--------------------------------

### GET /accounts/{slug}/webhooks/{id}.json

Source: https://www.fakturoid.cz/api/v3/webhooks

Returns details of a single webhook identified by its ID.

```APIDOC
## GET /accounts/{slug}/webhooks/{id}.json

### Description
Returns details of a single webhook identified by its ID.

### Method
GET

### Endpoint
https://app.fakturoid.cz/api/v3/accounts/{slug}/webhooks/{id}.json

### Parameters
#### Headers
- **User-Agent** (string) - Required - YourApp (yourname@example.com)

#### Path Parameters
- **slug** (String) - Required - Account name (e.g., applecorp)
- **id** (Integer) - Required - Webhook ID (e.g., 5)

### Response
#### Success Response (200 OK)
- **id** (integer) - Webhook ID
- **failed_deliveries_uuid** (string) - UUID for failed deliveries
- **webhook_url** (string) - The URL to which webhook events are sent
- **auth_header** (string) - Authorization header value
- **active** (boolean) - Whether the webhook is active
- **events** (array of strings) - List of event types
- **url** (string) - API URL for this webhook
- **created_at** (string) - Creation timestamp
- **updated_at** (string) - Last update timestamp

#### Response Example
```json
{
  "id": 5,
  "failed_deliveries_uuid": "b3518e74-5c9f-4b26-a5e2-6a8021c94a77",
  "webhook_url": "https://example.com/webhook",
  "auth_header": "Bearer TOKEN",
  "active": true,
  "events": ["invoice_created", "invoice_updated", "invoice_paid"],
  "url": "https://app.fakturoid.cz/api/v3/accounts/applecorp/webhooks/5.json",
  "created_at": "2024-06-12T13:29:23.568+02:00",
  "updated_at": "2024-06-12T13:29:23.568+02:00"
}
```
```

--------------------------------

### GET /api/v3/accounts/{account_slug}/todos.json

Source: https://www.fakturoid.cz/api/v3/todos

Retrieves a list of todos for the account. This endpoint is documented as 'Todos Index'.

```APIDOC
## [GET] /api/v3/accounts/{account_slug}/todos.json

### Description
Retrieves a list of todos for the account.

### Method
GET

### Endpoint
/api/v3/accounts/{account_slug}/todos.json

### Parameters
#### Path Parameters
- **account_slug** (string) - Required - The account slug.

### Response
#### Success Response (200)
- **id** (Integer) - Unique identifier in Fakturoid
- **name** (String) - Todo name
- **created_at** (DateTime) - Date and time of todo creation
- **completed_at** (DateTime) - Date and time of todo completion
- **text** (String) - Todo text
- **related_objects** (Object) - Attributes of objects related to the todo
- **params** (Object) - Parameters with details about todo, specific for each type of todo

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Example Todo",
    "created_at": "2023-01-01T00:00:00Z",
    "completed_at": null,
    "text": "Example text",
    "related_objects": {
      "type": "Invoice",
      "id": 123
    },
    "params": {}
  }
]
```
```

--------------------------------

### GET /accounts/{slug}/invoices/{id}.json

Source: https://www.fakturoid.cz/api/v3/invoices

Retrieves the full details of a specific invoice by its ID.

```APIDOC
## GET /accounts/{slug}/invoices/{id}.json

### Description
Retrieves the full details of a specific invoice identified by its ID.

### Method
GET

### Endpoint
/accounts/{slug}/invoices/{id}.json

### Parameters
#### URL Parameters
- **slug** (String) - Required - Account name (e.g., applecorp)
- **id** (Integer) - Required - Invoice ID (e.g., 1)

### Request Example
GET https://app.fakturoid.cz/api/v3/accounts/{slug}/invoices/{id}.json

### Response
#### Success Response (200 OK)
- **id** (Integer) - Invoice ID
- **number** (String) - Invoice number
- Additional fields may be present.

#### Response Example
{
  "id": 27,
  "number": "2023-0021",
  ...
}
```

--------------------------------

### Unit price with VAT - Request and Response

Source: https://www.fakturoid.cz/api/v3/expenses

Request and response pair showing how to set unit price including VAT using vat_price_mode: "from_total_with_vat". The response shows the calculated unit_price_without_vat and unit_price_with_vat.

```json
{
  …
  "vat_price_mode": "from_total_with_vat",
  …
  "lines": [
    {
      …
      "unit_price": "1210.0",
      "vat_rate": "21"
    }
  ]
}
```

```json
{
  …
  "vat_price_mode": "from_total_with_vat",
  …
  "lines": [
    {
      …
      "unit_price": "1000.0",
      "vat_rate": "21",
      "unit_price_without_vat": "1000.0",
      "unit_price_with_vat": "1210.0"
    }
  ]
}
```

--------------------------------

### Example Response Body for Generators List

Source: https://www.fakturoid.cz/api/v3/generators

The example response body returned with HTTP 200 OK for a successful request to list generators. It shows a complete generator object, including fields such as id, name, lines (invoice line items), totals, URLs, and timestamps. The ellipsis (…) indicates that additional generator objects follow in the actual response.

```JSON
[
  {
    "id": 10,
    "custom_id": null,
    "name": "Školení",
    "proforma": false,
    "paypal": false,
    "gopay": false,
    "tax_date_at_end_of_last_month": false,
    "due": 10,
    "subject_id": 32,
    "number_format_id": null,
    "note": "",
    "footer_note": "",
    "legacy_bank_details": null,
    "bank_account_id": null,
    "iban_visibility": "automatically",
    "tags": [],
    "order_number": "",
    "currency": "CZK",
    "payment_method": "bank",
    "custom_payment_method": null,
    "exchange_rate": "1.0",
    "language": "cz",
    "vat_price_mode": "without_vat",
    "transferred_tax_liability": false,
    "oss": "disabled",
    "supply_code": "",
    "subtotal": "28044.0",
    "total": "33933.24",
    "native_subtotal": "28044.0",
    "native_total": "33933.24",
    "lines": [
      {
        "id": 1269,
        "name": "Školení personálu",
        "quantity": "4.0",
        "unit_name": "lidi",
        "unit_price": "7000.0",
        "vat_rate": 21,
        "unit_price_without_vat": "7000.0",
        "unit_price_with_vat": "8470.0",
        "inventory_item_id": null
      },
      {
        "id": 1278,
        "name": "Občerstvení",
        "quantity": "1.0",
        "unit_name": "",
        "unit_price": "44.0",
        "vat_rate": 21,
        "unit_price_without_vat": "44.0",
        "unit_price_with_vat": "53.24",
        "inventory_item_id": null
      }
    ],
    "html_url": "https://app.fakturoid.cz/applecorp/generators/10",
    "url": "https://app.fakturoid.cz/api/v3/accounts/applecorp/generators/10.json",
    "subject_url": "https://app.fakturoid.cz/api/v3/accounts/applecorp/subjects/32.json",
    "created_at": "2023-09-05T13:26:20.806+02:00",
    "updated_at": "2023-09-26T12:00:21.083+02:00"
  },
  …
]
```
Tokens:
Raw