### Example Response for Creating a Note (201 Created)

Source: https://docs.bexio.com/

This is an example of a successful response after creating a new note.

```json
{
  "id": 4,
  "user_id": 1,
  "event_start": "2019-01-16 14:20:00",
  "subject": "API conception",
  "info": "string",
  "contact_id": 14,
  "project_id": null,
  "entry_id": null,
  "module_id": null

}
```

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

### Example Response for Fetching Notes (200 OK)

Source: https://docs.bexio.com/

This is an example of a successful response when fetching a list of notes.

```json
[
  {
    "id": 4,
    "user_id": 1,
    "event_start": "2019-01-16 14:20:00",
    "subject": "API conception",
    "info": "string",
    "contact_id": 14,
    "project_id": null,
    "entry_id": null,
    "module_id": null
}

]
```

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

### Task JSON Response Example

Source: https://docs.bexio.com/

This is an example of a successful JSON response when fetching a task.

```json
{ \
  * "id": 1, \
  * "user_id": 1, \
  * "finish_date": "2018-04-09T07:44:10+00:00", \
  * "subject": "Unterlagen versenden", \
  * "place": 0, \
  * "info": "so schnell wie möglich.", \
  * "contact_id": 1, \
  * "sub_contact_id": null, \
  * "project_id": null, \
  * "entry_id": null, \
  * "module_id": null, \
  * "todo_status_id": 1, \
  * "todo_priority_id": null, \
  * "has_reminder": false, \
  * "remember_type_id": null, \
  * "remember_time_id": null, \
  * "communication_kind_id": null \
}
```

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

### Get Single File Response (200 OK)

Source: https://docs.bexio.com/

Example JSON response when a file is successfully retrieved. This includes file metadata such as ID, name, size, and creation timestamp.

```JSON
{
  "id": 1,
  "uuid": "474cc93a-2d6f-47e9-bd3f-a5b5a1941314",
  "name": "screenshot",
  "size_in_bytes": 218476,
  "extension": "png",
  "mime_type": "image/png",
  "uploader_email": "contact@example.org",
  "user_id": 1,
  "is_archived": false,
  "source_id": 2,
  "source_type": "web",
  "is_referenced": false,
  "created_at": "2018-06-09T08:52:10+00:00"
}
```

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

### Project Response Sample

Source: https://docs.bexio.com/

This is an example of a successful JSON response when fetching project details. It includes various attributes of the project.

```json
{
  "id": 2,
  "uuid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "nr": "000002",
  "name": "Villa Kunterbunt",
  "start_date": "2019-07-12 00:00:00",
  "end_date": null,
  "comment": "",
  "pr_state_id": 2,
  "pr_project_type_id": 2,
  "contact_id": 2,
  "contact_sub_id": null,
  "pr_invoice_type_id": 3,
  "pr_invoice_type_amount": "230.00",
  "pr_budget_type_id": 1,
  "pr_budget_type_amount": "200.00",
  "user_id": 1

}
```

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

### Create Milestone Response Example

Source: https://docs.bexio.com/

This is an example of a successful JSON response after creating a new milestone. It confirms the creation and returns the details of the newly created milestone.

```json
{
  "id": 4,
  "name": "project documentation",
  "end_date": "2018-05-18",
  "comment": "Finish project documentation.",
  "pr_parent_milestone_id": 3

}
```

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

### Show Repetition Response

Source: https://docs.bexio.com/

An example JSON response detailing the start date, end date, and type of repetition for an order.

```json
{
  "start": "2019-01-01",
  "end": "2019-12-31",
  "repetition": {
    "type": "daily",
    "interval": 1
  }
}
```

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

### Example response for fetching taxes

Source: https://docs.bexio.com/

This is an example of a successful JSON response when fetching a list of taxes.

```json
[
  {
    "id": 1,
    "uuid": "8078b1f3-f85b-4adf-aaa8-c3eeea964927",
    "name": "lib.model.tax.ch.sales_7_7.name",
    "code": "UN77",
    "digit": "302",
    "type": "sales_tax",
    "account_id": 98,
    "tax_settlement_type": "none",
    "value": 7.7,
    "net_tax_value": null,
    "start_year": 2017,
    "end_year": 2018,
    "is_active": true,
    "display_name": "ZOLLM  - Import Mat/SV 100.00%",
    "start_month": 1,
    "end_month": 12
}

]
```

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

### Contact Sector Response Example

Source: https://docs.bexio.com/

This is an example of a successful response when fetching or searching for contact sectors.

```JSON
[
  {
    "id": 1,
    "name": "Photography"
}

]
```

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

### Example response for fetching a single tax

Source: https://docs.bexio.com/

This is an example of a successful JSON response when fetching a single tax.

```json
{
  "id": 1,
  "uuid": "8078b1f3-f85b-4adf-aaa8-c3eeea964927",
  "name": "lib.model.tax.ch.sales_7_7.name",
  "code": "UN77",
  "digit": "302",
  "type": "sales_tax",
  "account_id": 98,
  "tax_settlement_type": "none",
  "value": 7.7,
  "net_tax_value": null,
  "start_year": 2017,
  "end_year": 2018,
  "is_active": true,
  "display_name": "ZOLLM  - Import Mat/SV 100.00%",
  "start_month": 1,
  "end_month": 12

}
```

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

### Project Milestone Response Example

Source: https://docs.bexio.com/

This is an example of a successful JSON response when fetching project milestones. It details the structure of milestone objects.

```json
[
  {
    "id": 4,
    "name": "project documentation",
    "end_date": "2018-05-18",
    "comment": "Finish project documentation.",
    "pr_parent_milestone_id": 3

}

]
```

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

### Example Response for Exchange Rates

Source: https://docs.bexio.com/

This is an example JSON response when successfully fetching exchange rates. It includes details like exchange rate factor, target currency, and date.

```json
[
  {
    "factor_nr": 1.2,
    "exchange_currency": {
      "id": 1,
      "name": "CHF",
      "round_factor": 0.05
},
    "ratio": 1,
    "exchange_rate_to_ratio": 0.9849,
    "source": "monthly_average",
    "source_reason": "monthly_average_provided",
    "exchange_rate_date": "2024-05-01"
}

]
```

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

### Project Search Response (200 OK)

Source: https://docs.bexio.com/

Example of a successful response when searching for projects. It includes detailed information about the found project.

```json
[
  {
    "id": 2,
    "uuid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "nr": "000002",
    "name": "Villa Kunterbunt",
    "start_date": "2019-07-12 00:00:00",
    "end_date": null,
    "comment": "",
    "pr_state_id": 2,
    "pr_project_type_id": 2,
    "contact_id": 2,
    "contact_sub_id": null,
    "pr_invoice_type_id": 3,
    "pr_invoice_type_amount": "230.00",
    "pr_budget_type_id": 1,
    "pr_budget_type_amount": "200.00",
    "user_id": 1
}

]
```

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

### Create Task Response (201 Created)

Source: https://docs.bexio.com/

Example JSON response when a task is successfully created. Includes the ID of the newly created task.

```json
{
  "id": 1,
  "user_id": 1,
  "finish_date": "2018-04-09T07:44:10+00:00",
  "subject": "Unterlagen versenden",
  "place": 0,
  "info": "so schnell wie möglich.",
  "contact_id": 1,
  "sub_contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null,
  "todo_status_id": 1,
  "todo_priority_id": null,
  "has_reminder": false,
  "remember_type_id": null,
  "remember_time_id": null,
  "communication_kind_id": null
}
```

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

### Create Payment Response (201 Created)

Source: https://docs.bexio.com/

This is an example of a successful response when a payment is created. It includes the details of the newly created payment.

```json
{
  "id": 4,
  "date": "2019-06-29",
  "value": "10.0000",
  "bank_account_id": 1,
  "title": "Received Payment",
  "payment_service_id": null,
  "is_client_account_redemption": false,
  "is_cash_discount": false,
  "kb_invoice_id": 1,
  "kb_credit_voucher_id": null,
  "kb_bill_id": null,
  "kb_credit_voucher_text": ""
}
```

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

### Create Project Response Sample (201 Created)

Source: https://docs.bexio.com/

This is a sample successful response (HTTP 201 Created) when a project is created.

```json
{
  "id": 2,
  "uuid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "nr": "000002",
  "name": "Villa Kunterbunt",
  "start_date": "2019-07-12 00:00:00",
  "end_date": null,
  "comment": "",
  "pr_state_id": 2,
  "pr_project_type_id": 2,
  "contact_id": 2,
  "contact_sub_id": null,
  "pr_invoice_type_id": 3,
  "pr_invoice_type_amount": "230.00",
  "pr_budget_type_id": 1,
  "pr_budget_type_amount": "200.00",
  "user_id": 1
}
```

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

### Vat Period Response Sample

Source: https://docs.bexio.com/

This is an example of a successful response when fetching a list of vat periods. It includes details like ID, start and end dates, type, status, and closure date.

```json
[
  {
    "id": 1,
    "start": "2018-01-01",
    "end": "2018-03-31",
    "type": "quarter",
    "status": "closed",
    "closed_at": "2018-04-28"
}

]
```

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

### PHP OpenID Connect Authentication

Source: https://docs.bexio.com/

This PHP example demonstrates how to use the OpenID-Connect-PHP library to authenticate with Bexio's OpenID Connect service. It sets up the client, defines redirect URLs and scopes, and retrieves an access token. Ensure you have the 'jumbojett/openid-connect-php' library installed via Composer.

```php
<?php
require __DIR__ . '/vendor/autoload.php';
use Jumbojett\OpenIDConnectClient;

$oidc = new OpenIDConnectClient("https://auth.bexio.com/realms/bexio", "client_id", "client_secret");
$oidc->setRedirectURL("https://www.example.com/oidc_callback");
$oidc->addScope(array("openid", "profile", "contact_show", "offline_access"));
$oidc->authenticate();

echo $oidc->getAccessToken();

```

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

### Manual Entry File Response Sample

Source: https://docs.bexio.com/

This is an example of the JSON response when successfully fetching files for a manual entry line. It includes details like file ID, UUID, name, size, and creation date.

```json
[
  {
    "id": 1,
    "uuid": "474cc93a-2d6f-47e9-bd3f-a5b5a1941314",
    "name": "screenshot",
    "size_in_bytes": 218476,
    "extension": "png",
    "mime_type": "image/png",
    "uploader_email": "contact@example.org",
    "user_id": 1,
    "is_archived": false,
    "source_id": 2,
    "source_type": "web",
    "is_referenced": false,
    "created_at": "2018-06-09T08:52:10+00:00"
}

]
```

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

### Fetch Projects List (cURL)

Source: https://docs.bexio.com/

Use this cURL command to fetch a list of all projects. Ensure to replace `{access-token}` with your actual Bearer token and set the 'Accept' header to 'application/json'.

```bash
curl -X GET \
  https://api.bexio.com/2.0/pr_project \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

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

### File Usage Response Sample

Source: https://docs.bexio.com/

An example of the JSON response when querying file usage details. It includes the file's ID, reference class, and title.

```json
{
  * "id": 1,
  * "ref_class": "KbInvoice",
  * "title": "RE-00001",
  * "document_nr": "RE-00001"

}
```

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

### Sample Response for Fetching File

Source: https://docs.bexio.com/

This is a sample JSON response when a file associated with a manual compound entry is successfully fetched. It includes file metadata such as ID, name, size, extension, and creation timestamp.

```json
{
  "id": 1,
  "uuid": "474cc93a-2d6f-47e9-bd3f-a5b5a1941314",
  "name": "screenshot",
  "size_in_bytes": 218476,
  "extension": "png",
  "mime_type": "image/png",
  "uploader_email": "contact@example.org",
  "user_id": 1,
  "is_archived": false,
  "source_id": 2,
  "source_type": "web",
  "is_referenced": false,
  "created_at": "2018-06-09T08:52:10+00:00",
  "data": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAIAAADTED8xAAAACXBIWXMAAABIAAAASABGyWs+AAACu0lEQVR42u3TAQkAMBDEsHuYf80T0oRa6G07qdrbDbIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYC0DxplBfxP7XIvAAAAAElFTkSuQmCC"
}
```

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

### Create Unit Response Sample (201 Created)

Source: https://docs.bexio.com/

This is a sample response when a unit is successfully created. It includes the 'id' and 'name' of the new unit.

```json
{
  "id": 1,
  "name": "h"
}
```

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

### Fetch Files for Manual Entry Line (cURL)

Source: https://docs.bexio.com/

Use this cURL command to fetch a list of files for a given manual entry line. Ensure you include the correct 'Accept' and 'Authorization' headers.

```bash
curl -X GET \
  https://api.bexio.com/3.0/accounting/manual_entries/{manual_entry_id}/entries/{entry_id}/files \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

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

### Project Response Sample

Source: https://docs.bexio.com/

This is a sample JSON response for a single project when fetching a list of projects. It includes details such as ID, name, dates, and associated IDs.

```json
[ 
  {
    "id": 2,
    "uuid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "nr": "000002",
    "name": "Villa Kunterbunt",
    "start_date": "2019-07-12 00:00:00",
    "end_date": null,
    "comment": "",
    "pr_state_id": 2,
    "pr_project_type_id": 2,
    "contact_id": 2,
    "contact_sub_id": null,
    "pr_invoice_type_id": 3,
    "pr_invoice_type_amount": "230.00",
    "pr_budget_type_id": 1,
    "pr_budget_type_amount": "200.00",
    "user_id": 1
}

]
```

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

### Manual Entry Response Sample

Source: https://docs.bexio.com/

This is an example of a successful response (200 OK) when fetching manual entries. It includes details about the entry and its associated sub-entries.

```json
[
  {
    "id": 1,
    "type": "manual_single_entry",
    "date": "2019-11-17",
    "reference_nr": "Booking BA-22",
    "created_by_user_id": 1,
    "edited_by_user_id": 1,
    "entries": [
      {
        "id": 32,
        "date": "2019-11-17",
        "debit_account_id": 77,
        "credit_account_id": 139,
        "tax_id": 3,
        "tax_account_id": 77,
        "description": "Payment for client Smith",
        "amount": 328.25,
        "currency_id": 1,
        "base_currency_id": 1,
        "currency_factor": 1,
        "base_currency_amount": 328.25,
        "created_by_user_id": 1,
        "edited_by_user_id": 1
}
],
    "is_locked": false,
    "locked_info": "closed_business_year"
}

]
```

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

### JSON Payload Example

Source: https://docs.bexio.com/

This is an example of a JSON payload for creating a purchase order. It includes details about the document, contact, currency, and line items.

```json
{
  "id": 1,
  "document_nr": "RE-00001",
  "kb_payment_template_id": 1,
  "payment_type_id": 1,
  "title": "purchase order example title",
  "contact_id": 14,
  "contact_sub_id": 1,
  "template_slug": "581a8010821e01426b8b456b",
  "user_id": 1,
  "project_id": 1,
  "logopaper_id": 1,
  "language": {
    "id": 1,
    "name": "Deutsch",
    "decimalpoint": ".",
    "thousandsseparator": "'",
    "iso_639_1": "de",
    "date_format": "d.m.Y"
  },
  "language_id": 1,
  "bank_account_id": 1,
  "currency": {
    "id": 1,
    "name": "CHF",
    "round_factor": 0.05
  },
  "currency_id": 1,
  "header": "We would like to order the following products:",
  "footer": "Many thanks for the fast processing of our order.",
  "mwst_type": "included",
  "mwst_is_net": true,
  "is_compact_view": false,
  "show_position_taxes": false,
  "salesman_user_id": 1,
  "is_valid_from": "2019-06-24",
  "is_valid_to": "2019-07-24",
  "delivery_address_type": "contact_address",
  "contact_address_manual": "bexio AG\\nReinluftweg 1\\nCH - 9630 Wattwil",
  "delivery_address_manual": "bexio AG\\nReinluftweg 1\\nCH - 9630 Wattwil",
  "nb_decimals_amount": 2,
  "nb_decimals_price": 2,
  "terms_of_payment_text": "Payable within 30 days",
  "reference": "Based on Quote Q-3860",
  "api_reference": null,
  "mail": "support@bexio.com",
  "is_valid_until": "2019-07-24",
  "created_at": "2020-04-28T19:58:58+00:00",
  "updated_at": "2020-04-30T19:58:58+00:00",
  "custom_translations": { },
  "date_format": "d.m.Y",
  "positions": {
    "required": [
      {
        "type": "text",
        "pos": null,
        "is_optional": false,
        "id": 1,
        "text": "This position type allows to add free text to a document",
        "show_pos_nr": false
      }
    ],
    "optional": [
      {
        "type": "text",
        "pos": null,
        "is_optional": false,
        "id": 1,
        "text": "This position type allows to add free text to a document",
        "show_pos_nr": false
      }
    ],
    "discount": [
      {
        "type": "discount",
        "pos": null,
        "is_optional": false,
        "id": 1,
        "text": "Partner discount",
        "is_percentual": true,
        "value": 10,
        "discount_total": 1.78
      }
    ]
  }
}
```

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

### Fetch Business Activities

Source: https://docs.bexio.com/

Fetches a list of all business activities. Requires 'Accept' and 'Authorization' headers.

```shell
curl -X GET \
  https://api.bexio.com/2.0/client_service \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

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

### Example Response for Currency Codes

Source: https://docs.bexio.com/

This is an example JSON response when successfully fetching currency codes. It returns an array of strings, where each string is a currency code.

```json
[
  "EUR",
  "GBP",
  "PLN"

]
```

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

### Outgoing Payment Response Example

Source: https://docs.bexio.com/

Example JSON response structure for a successful retrieval of outgoing payments, including payment details and pagination information.

```json
{
  "data": [
    {
      "id": "46913fdc-802b-49ba-99d7-4ccc13cccfc2",
      "bill_id": "176a1442-d66d-4907-b8c8-6dad090452a8",
      "payment_type": "MANUAL",
      "execution_date": "2019-10-15",
      "status": "TRANSFERRED",
      "amount": 45.98,
      "sender_bank_account_id": 4,
      "receiver_account_no": "657858734587301523",
      "receiver_iban": "DE121234567812345678900",
      "banking_payment_id": "0c8b18af-9a66-4c89-b01a-8abab642d69a",
      "transaction_id": "f020b371-939e-427a-8175-eceb8dea17b3"
},
    {
      "id": "176a1442-d66d-4907-b8c8-6dad090452a8",
      "bill_id": "869f16ee-d688-476b-9f18-9bb608fdc21f",
      "payment_type": "IBAN",
      "status": "PENDING",
      "execution_date": "2019-09-25",
      "amount": 95.2,
      "sender_bank_account_id": 96,
      "receiver_account_no": "253458734587301523",
      "receiver_iban": "ES121234567812345678900",
      "banking_payment_id": "f7e53b5e-a496-4bce-94b5-97f739dc4d5b",
      "transaction_id": "b3bafed8-fe0f-414d-b360-b50734fb199c"
}
],
  "paging": {
    "page": 1,
    "page_size": 10,
    "page_count": 50,
    "item_count": 300
}

}
```

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

### File Preview Response Sample

Source: https://docs.bexio.com/

A sample JSON string representing the content type for a file preview response.

```json
"string"
```

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

### Fetch Manual Entry File (cURL)

Source: https://docs.bexio.com/

Use this cURL command to fetch a file associated with a specific manual entry line. Ensure you replace placeholders like {manual_entry_id}, {entry_id}, {file_id}, and {access-token} with your actual values. The 'Accept' header should be set to 'application/json'.

```bash
curl -X GET \
  https://api.bexio.com/3.0/accounting/manual_entries/{manual_entry_id}/entries/{entry_id}/files/{file_id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

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

### Document Number Validation Response Example

Source: https://docs.bexio.com/

This is an example of a JSON response from the Bexio API indicating whether a document number is valid and providing the next available number if it is not.

```json
{
  "valid": false,
  "next_available_no": "AB-1235"
}
```

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

### Create Project

Source: https://docs.bexio.com/

This action creates a new project. It requires various details about the project, including its name, dates, associated IDs for state, type, contact, and user.

```APIDOC
## POST /2.0/pr_project

### Description
Creates a new project with specified details.

### Method
POST

### Endpoint
https://api.bexio.com/2.0/pr_project

### Parameters
#### Header Parameters
- **Accept** (string) - Required - Example: application/json

#### Request Body
- **document_nr** (string) - Optional - Can not be used if “automatic numbering” is activated in frontend-settings. Required if “automatic numbering” deactivated.
- **name** (string) - Required
- **start_date** (string or null) - Optional - <date-time>
- **end_date** (string or null) - Optional - <date-time>
- **comment** (string) - Optional
- **pr_state_id** (integer) - Required - References a project status object
- **pr_project_type_id** (integer) - Required - References a project type object
- **contact_id** (integer) - Required - References a contact object
- **contact_sub_id** (integer or null) - Optional - References a contact object
- **pr_invoice_type_id** (integer or null) - Optional - The following invoice types are available: 1: type_hourly_rate_service, 2: type_hourly_rate_employee, 3: type_hourly_rate_project, 4: type_fix
- **pr_invoice_type_amount** (string) - Optional - This field can only be edited if the `pr_invoice_type` is set. (Only supported for invoice types: `type_hourly_rate_project` and `type_fix`)
- **pr_budget_type_id** (number or null) - Optional - The following budget types are available: 1: type_budgeted_costs, 2: type_budgeted_hours, 3: type_service_budget, 4: type_service_employees
- **pr_budget_type_amount** (string) - Optional - This field can only be edited if the `pr_budget_type` is set. (Only supported for budget types: `type_budgeted_costs` and `type_budgeted_hours`)
- **user_id** (integer) - Required - References a user object

### Request Example
```json
{
  "document_nr": "project name",
  "name": "Villa Kunterbunt",
  "start_date": "2019-07-12 00:00:00",
  "end_date": null,
  "comment": "",
  "pr_state_id": 2,
  "pr_project_type_id": 2,
  "contact_id": 2,
  "contact_sub_id": null,
  "pr_invoice_type_id": 3,
  "pr_invoice_type_amount": "230.00",
  "pr_budget_type_id": 1,
  "pr_budget_type_amount": "200.00",
  "user_id": 1
}
```

### Response
#### Success Response (201)
- **id** (integer) - Description
- **uuid** (string) - Description
- **nr** (string) - Description
- **name** (string) - Description
- **start_date** (string) - Description
- **end_date** (string or null) - Description
- **comment** (string) - Description
- **pr_state_id** (integer) - Description
- **pr_project_type_id** (integer) - Description
- **contact_id** (integer) - Description
- **contact_sub_id** (integer or null) - Description
- **pr_invoice_type_id** (integer or null) - Description
- **pr_invoice_type_amount** (string) - Description
- **pr_budget_type_id** (number or null) - Description
- **pr_budget_type_amount** (string) - Description
- **user_id** (integer) - Description

#### Response Example
```json
{
  "id": 2,
  "uuid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "nr": "000002",
  "name": "Villa Kunterbunt",
  "start_date": "2019-07-12 00:00:00",
  "end_date": null,
  "comment": "",
  "pr_state_id": 2,
  "pr_project_type_id": 2,
  "contact_id": 2,
  "contact_sub_id": null,
  "pr_invoice_type_id": 3,
  "pr_invoice_type_amount": "230.00",
  "pr_budget_type_id": 1,
  "pr_budget_type_amount": "200.00",
  "user_id": 1
}
```

#### Error Response (422)
Validation error
```

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

### Reminder Response Example

Source: https://docs.bexio.com/

This is an example of a successful JSON response when fetching reminder details. It includes information such as the reminder ID, associated invoice ID, validity dates, and status.

```JSON
{
  * "id": 4,
  * "kb_invoice_id": 1,
  * "title": "First reminder",
  * "is_valid_from": "2019-06-24",
  * "is_valid_to": "2019-07-24",
  * "reminder_period_in_days": 14,
  * "reminder_level": 1,
  * "show_positions": true,
  * "remaining_price": "17.8000",
  * "received_total": "0.0000",
  * "is_sent": false,
  * "header": null,
  * "footer": null

}
```

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

### Document Settings Response Sample

Source: https://docs.bexio.com/

This is a sample JSON response for a successful request to fetch document settings. It includes various configuration details for document types.

```json
[
  {
    "id": 1,
    "text": "Quote",
    "kb_item_class": "KbOffer",
    "enumeration_format": "AN-%nummer%",
    "use_automatic_enumeration": true,
    "use_yearly_enumeration": false,
    "next_nr": 1,
    "nr_min_length": 5,
    "default_time_period_in_days": 14,
    "default_logopaper_id": 1,
    "default_language_id": 1,
    "default_client_bank_account_new_id": 1,
    "default_currency_id": 1,
    "default_mwst_type": 0,
    "default_mwst_is_net": true,
    "default_nb_decimals_amount": 2,
    "default_nb_decimals_price": 2,
    "default_show_position_taxes": false,
    "default_title": "Angebot",
    "default_show_esr_on_same_page": false,
    "default_payment_type_id": 1,
    "kb_terms_of_payment_template_id": 1,
    "default_show_total": true
}

]
```

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

### Get Payment Request (cURL)

Source: https://docs.bexio.com/

Use this cURL command to make a GET request to retrieve a specific payment. Ensure you replace `{payment_id}` with the actual payment UUID and `{access-token}` with your valid bearer token. The `Accept` header should be set to `application/json`.

```curl
curl -X GET \
  https://api.bexio.com/4.0/banking/payments/{payment_id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

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

### Get File Preview

Source: https://docs.bexio.com/

Provides a requested preview for a file from the backend as a stream.

```APIDOC
## Get File Preview

Provides requested preview for file from backend as stream.

### Method
GET

### Endpoint
/3.0/files/{file_id}/preview

### Parameters
#### Path Parameters
- **file_id** (integer) - Required - File ID to get preview file.

#### Header Parameters
- **Accept** (string) - Required - Example: application/json

### Request Example
```curl
curl -X GET \
  https://api.bexio.com/3.0/files/{file_id}/preview \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

### Response
#### Success Response (200)
OK

#### Response Example
```json
"string"
```
```

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

### Sample Country Response

Source: https://docs.bexio.com/

This is an example of a successful JSON response when fetching country details.

```json
{
  "id": 1,
  "name": "Kiribati",
  "name_short": "KI",
  "iso3166_alpha2": "KI"
}
```

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

### Fetch Document Settings (cURL)

Source: https://docs.bexio.com/

Use this cURL command to fetch a list of all document settings. Ensure you include the correct 'Accept' and 'Authorization' headers.

```bash
curl -X GET \
  https://api.bexio.com/2.0/kb_item_setting \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

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

### Delete Contact Group Success Response

Source: https://docs.bexio.com/

This is an example of a successful response when deleting a contact group.

```JSON
{
  "success": true

}
```

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

### Create Item Response (201 Created)

Source: https://docs.bexio.com/

This is a sample successful response (201 Created) after creating an item. It includes the newly created item's details.

```json
{
  "id": 4,
  "user_id": 1,
  "article_type_id": 1,
  "contact_id": 14,
  "deliverer_code": null,
  "deliverer_name": null,
  "deliverer_description": null,
  "intern_code": "wh-2019",
  "intern_name": "Webhosting",
  "intern_description": null,
  "purchase_price": null,
  "sale_price": null,
  "purchase_total": null,
  "sale_total": null,
  "currency_id": null,
  "tax_income_id": null,
  "tax_id": null,
  "tax_expense_id": null,
  "unit_id": null,
  "is_stock": false,
  "stock_id": null,
  "stock_place_id": null,
  "stock_nr": 0,
  "stock_min_nr": 0,
  "stock_reserved_nr": 0,
  "stock_available_nr": 0,
  "stock_picked_nr": 0,
  "stock_disposed_nr": 0,
  "stock_ordered_nr": 0,
  "width": null,
  "height": null,
  "weight": null,
  "volume": null,
  "html_text": null,
  "remarks": null,
  "delivery_price": null,
  "article_group_id": null,
  "account_id": null,
  "expense_account_id": null
}
```

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

### Get Next Reference Number

Source: https://docs.bexio.com/

Retrieves the next available reference number for a manual entry.

```APIDOC
## GET /3.0/accounting/manual_entries/next_ref_nr

### Description
This action can be used to get the next reference number for a manual entry.

### Method
GET

### Endpoint
/3.0/accounting/manual_entries/next_ref_nr

### Parameters
#### Header Parameters
- **Accept** (string) - Required - Example: application/json

### Responses
#### Success Response (200)
OK

#### Response Example
```json
{
  "next_ref_nr": "Booking BA-22"
}
```

#### Error Response (422)
Validation error
```

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

### Manual Entry File Response Sample

Source: https://docs.bexio.com/

This is a sample JSON response when successfully fetching a file associated with a manual entry line. It includes details such as file ID, UUID, name, size, extension, MIME type, and creation timestamp.

```json
{
  "id": 1,
  "uuid": "474cc93a-2d6f-47e9-bd3f-a5b5a1941314",
  "name": "screenshot",
  "size_in_bytes": 218476,
  "extension": "png",
  "mime_type": "image/png",
  "uploader_email": "contact@example.org",
  "user_id": 1,
  "is_archived": false,
  "source_id": 2,
  "source_type": "web",
  "is_referenced": false,
  "created_at": "2018-06-09T08:52:10+00:00",
  "data": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAIAAADTED8xAAAACXBIWXMAAABIAAAASABGyWs+AAACu0lEQVR42u3TAQkAMBDEsHuYf80T0oRa6G07qdrbDbIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYA0A5BmANIMQJoBSDMAaQYgzQCkGYC0DxplBfxP7XIvAAAAAElFTkSuQmCC"
}
```