### GET /services/automatic-purchases-from-ai-analysis-available

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /services/automatic-purchases-from-ai-analysis-available

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>service, service_count, serviceExists</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>description</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>service_id</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/services/automatic-purchases-from-ai-analysis-available?include=null&sort=null&filter=null"
```

```

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

### GET /explorer

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /explorer

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>order, order_count, orderExists, owner, owner_count, ownerExists, customer, customer_count, customerExists, order.service, service, service_count, serviceExists, groups, groups_count, groupsExists, children, children_count, childrenExists, children.service, children.owner, parent, parent_count, parentExists, ocr, ocr_count, ocrExists, ocr.pages</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>file, breadcrumb, ai_data, ai_model_name, ai_enrich_data_available, depends_on_ocr_to_request_ai</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>id, created_at, last_operation_at, name, type</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>type, owner_id, name, exact_name, created_between, group_id, ai, service_id, parent_id</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/explorer?page=1&per-page=10&include=null&append=null&sort=null&filter=null"
```

```

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

### GET /users/with-visible-orders

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /users/with-visible-orders

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>permissions, permissions_count, permissionsExists, groups, groups_count, groupsExists, notifications_preferences, notifications_preferences_count, notifications_preferencesExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month, customer.total_ai_tokens_used_current_month, customer.ai_tokens_above_limit_this_month</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/users/with-visible-orders?include=null&append=null"
```

```

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

### GET /services/most-used

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /services/most-used

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/services/most-used"
```

```

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

### GET /services

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /services

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>ai_default_model, ai_default_model_count, ai_default_modelExists, ai_default_model.questions</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>is_favorite, can_be_monitored, automatic_purchase_has_options</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>name</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>ai_enabled, type, can_trigger_automatic_purchase, order_summary_available</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/services?include=null&append=null&sort=null&filter=null"
```

```

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

### GET /services/dont-know-book-page-price

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /services/dont-know-book-page-price

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/services/dont-know-book-page-price"
```

```

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

### GET /login

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /login

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/login"
```

```

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

### GET /purchases

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>orders, orders_count, ordersExists, orders.ocr, orders.groups, orders.service, first_order, first_order_count, first_orderExists, first_order.service, waiting_invoice_payment, waiting_invoice_payment_count, waiting_invoice_paymentExists, user, user_count, userExists, customer, customer_count, customerExists, quote_appraiser, quote_appraiser_count, quote_appraiserExists, recurrence, recurrence_count, recurrenceExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>orders.ai_service_name, orders_status_count, downloadable_orders_ids, orders_count, orders_expired_count, orders_status_count, last_status_change_at, has_ai_extracted_data, has_ai_analysis_pending, orders.has_ai_extracted_data, orders.has_ai_analysis_pending, originated_from_orders, first_order.ai_service_name, orders.has_ai_extracted_data, orders.has_ai_analysis_pending, downloaded_orders_ids, downloadable_orders_ids_not_downloaded</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>id, name, placed_at, type</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>name_or_id_or_register, placed_between, status, orders.service_id, orders.group_id, user_id, recurrence_id, ai, automatic_generated, recurrence_generated</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/purchases?page=1&per-page=10&include=null&append=null&sort=null&filter=null"
```

```

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

### GET /explorer/{explorerItem_id}/ai/models/{aiModelFromCustomerOrPublic}/answers

Source: https://api2.cbrdoc.com.br/docs.openapi

Assincrono

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/explorer/{explorerItem_id}/ai/models/{aiModelFromCustomerOrPublic}/answers"
```

```

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

### GET /ai/models

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>service, service_count, serviceExists, customer, customer_count, customerExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>questions, extracted_fields</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>id, name</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>name_or_id, visibility, service_id</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/ai/models?page=1&per-page=10&include=null&append=null&sort=null&filter=null"
```

```

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

### GET /orders

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>groups, groups_count, groupsExists, purchase, purchase_count, purchaseExists, service, service_count, serviceExists, user, user_count, userExists, customer, customer_count, customerExists, explorer_item, explorer_item_count, explorer_itemExists, explorer_item.groups, explorer_item.ai_question_history, purchase.waiting_invoice_payment, purchase.recurrence, ocr, ocr_count, ocrExists, ocr.pages, active_challenge, active_challenge_count, active_challengeExists, challenges, challenges_count, challengesExists, originated_from, originated_from_count, originated_fromExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>ai_service_name, refundable, explorer_item.file, has_ai_extracted_data, has_ai_analysis_pending, explorer_item_id, ai_service_name, refundable, refundable_value, purchase.downloadable_orders_ids, place_order_default_values, is_expired, can_be_downloaded, explorer_item.ai_enrich_data_available, explorer_item.depends_on_ocr_to_request_ai, previous_order_id_same_purchase, next_order_id_same_purchase, purchase.orders_count, index_in_purchase, can_accept_additional_information, times_downloaded, explorer_item.ai_data, is_summary_extraction_queued, is_get_ai_answers_queued, originated_from_backoffice_code, explorer_item.ai_model_name</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>id, name, placed_at, type</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>id, register, result, name_or_id_or_register, placed_between, valid_until_between, status, service_id, group_id, user_id, purchase.recurrence_id, ai, purchase_id, ocr_content, expired, has_active_challenge, recurrence_generated, has_extracted_summary, originated_from_id, person_document, detailed_service_data.modelo_ia_id</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/orders?page=1&per-page=10&include=null&append=null&sort=null&filter=null"
```

```

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

### GET /recurrences

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>items, items_count, itemsExists, owner, owner_count, ownerExists, items.order, groups, groups_count, groupsExists, customer, customer_count, customerExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>purchases_ids, items.service_can_be_monitored</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>id, name, created_at</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>name_or_id, owner_id, created_between</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/recurrences?page=1&per-page=10&include=null&append=null&sort=null&filter=null"
```

```

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

### GET /dossiers/never-ordered

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /dossiers/never-ordered

```markdown
### Parameters

- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>person_document</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/dossiers/never-ordered?filter=null"
```

```

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

### GET /users/trashed

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>permissions, permissions_count, permissionsExists, groups, groups_count, groupsExists, notifications_preferences, notifications_preferences_count, notifications_preferencesExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month, customer.total_ai_tokens_used_current_month, customer.ai_tokens_above_limit_this_month</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/users/trashed?page=1&per-page=10&include=null&append=null"
```

```

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

### GET /users

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>permissions, permissions_count, permissionsExists, groups, groups_count, groupsExists, notifications_preferences, notifications_preferences_count, notifications_preferencesExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month, customer.total_ai_tokens_used_current_month, customer.ai_tokens_above_limit_this_month</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>name_or_email</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/users?page=1&per-page=10&include=null&append=null&filter=null"
```

```

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

### GET /purchases/{purchases}/download

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /purchases/{purchases}/download

```markdown
### Request Body

**Content-Type:** application/json

- **group_by** (string (purchase|register)) (example: null) ("purchase"|"register")

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/purchases/{purchases}/download" \
  -H "Content-Type: application/json" \
  -d '{
  "group_by": null
}'
```

```

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

### GET /services/tax-price

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /services/tax-price

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/services/tax-price"
```

```

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

### GET /explorer/{id}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /explorer/{id}

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>order, order_count, orderExists, owner, owner_count, ownerExists, customer, customer_count, customerExists, order.service, service, service_count, serviceExists, groups, groups_count, groupsExists, children, children_count, childrenExists, children.service, children.owner, parent, parent_count, parentExists, ocr, ocr_count, ocrExists, ocr.pages</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>file, breadcrumb, ai_data, ai_model_name, ai_enrich_data_available, depends_on_ocr_to_request_ai</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/explorer/{id}?include=null&append=null"
```

```

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

### GET /explorer/{ids}/download

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /explorer/{ids}/download

```markdown
### Parameters

- **groupBy** (string (purchase|register|directory), query, optional):  Indica se arquivos .zip devem criar a estrutura baseada nos diretórios, compra ou no registro do item da compra. (example: "purchase")

### Request Body

**Content-Type:** application/json

- **group_by** (string (purchase|register|directory)) (required) (example: null) ("purchase"|"register"|"directory")

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/explorer/{ids}/download?groupBy=purchase" \
  -H "Content-Type: application/json" \
  -d '{
  "group_by": null
}'
```

```

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

### GET /notifications

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>created_at</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>read, type</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/notifications?page=1&per-page=10&sort=null&filter=null"
```

```

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

### GET /dossiers

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /dossiers

```markdown
### Parameters

- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>name_or_person_document, status, expired</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/dossiers?filter=null"
```

```

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

### GET /services/{id}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /services/{id}

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>aiDefaultModel, aiDefaultModel_count, aiDefaultModelExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>is_favorite, aiDefaultModel.questions</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/services/{id}?include=null&append=null"
```

```

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

### GET /groups

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/groups?page=1&per-page=10"
```

```

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

### GET /customers

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /customers

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>orders_count, automatic_ai_analysis, automatic_ai_analysis_count, automatic_ai_analysisExists, services_automatic_purchase_enabled_by_default, services_automatic_purchase_enabled_by_default_count, services_automatic_purchase_enabled_by_defaultExists, services_automatic_ai_analysis, services_automatic_ai_analysis_count, services_automatic_ai_analysisExists, services_automatic_orders_summary, services_automatic_orders_summary_count, services_automatic_orders_summaryExists, services_automatic_purchase_enabled_from_ai_analysis, services_automatic_purchase_enabled_from_ai_analysis_count, services_automatic_purchase_enabled_from_ai_analysisExists, users, users_count, usersExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>account_balance, account_balance_total_bonuses, used_storage, prepaid, total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/customers?include=null&append=null"
```

```

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

### GET /reports/order-stats

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /reports/order-stats

```markdown
### Request Body

**Content-Type:** application/json

- **begin_date** (string) (required): O campo value não é uma data válida. Must be a valid date in the format <code>Y-m-d</code>. (example: null)
- **end_date** (string) (required): O campo value não é uma data válida. Must be a valid date in the format <code>Y-m-d</code>. (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/reports/order-stats" \
  -H "Content-Type: application/json" \
  -d '{
  "begin_date": null,
  "end_date": null
}'
```

```

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

### GET /two-factor-challenge

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /two-factor-challenge

```markdown
### Request Body

**Content-Type:** application/json

- **code** (string) (example: null)
- **recovery_code** (string) (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/two-factor-challenge" \
  -H "Content-Type: application/json" \
  -d '{
  "code": null,
  "recovery_code": null
}'
```

```

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

### GET /orders/{ids}/download

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /orders/{ids}/download

```markdown
### Request Body

**Content-Type:** application/json

- **group_by** (string (purchase|register)) (example: null) ("purchase"|"register")

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/orders/{ids}/download" \
  -H "Content-Type: application/json" \
  -d '{
  "group_by": null
}'
```

```

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

### GET /permission-groups

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /permission-groups

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>permissions</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>name, order</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/permission-groups?include=null&sort=null"
```

```

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

### GET /user/two-factor-qr-code

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /user/two-factor-qr-code

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/user/two-factor-qr-code"
```

```

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

### GET /invoices/by-period/{year}/{month}

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado por padrão

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>purchase, purchase_count, purchaseExists, purchase.orders, user, user_count, userExists</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>purchase.name, operation, amount, purchase.backoffice_code, user.name</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>operation, purchase_name_or_id, ids</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/invoices/by-period/{year}/{month}?page=1&per-page=10&include=null&sort=null&filter=null"
```

```

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

### GET /services/code/{code}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /services/code/{code}

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>aiDefaultModel, aiDefaultModel_count, aiDefaultModelExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>aiDefaultModel.questions, is_favorite</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/services/code/{code}?include=null&append=null"
```

```

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

### GET /users/{id}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /users/{id}

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>permissions, permissions_count, permissionsExists, groups, groups_count, groupsExists, notifications_preferences, notifications_preferences_count, notifications_preferencesExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>total_ai_tokens_used_current_month, ai_tokens_above_limit_this_month, customer.total_ai_tokens_used_current_month, customer.ai_tokens_above_limit_this_month</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/users/{id}?include=null&append=null"
```

```

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

### GET /wallets/deposits/bonus-for-value/{deposit_value}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /wallets/deposits/bonus-for-value/{deposit_value}

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/wallets/deposits/bonus-for-value/{deposit_value}"
```

```

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

### GET /user/confirm-password

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /user/confirm-password

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/user/confirm-password"
```

```

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

### GET /invoice-postpaids/{year}/{month}

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>order, order_count, orderExists, order.user, customer, customer_count, customerExists</small> (example: null)
- **sort** (string, query, optional): Campos disponíveis para ordenação. Para ordenar decrescentemente use o sinal de - antes do nome do campo <small>Ex: -nome_campo</small>. 
                                                        Múltiplos devem ser separadas com vírgula. Disponíveis: <small>order.name, order.backoffice_code, fiscal_amount, debit_amount</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>order_name_or_id, ids</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/invoice-postpaids/{year}/{month}?page=1&per-page=10&include=null&sort=null&filter=null"
```

```

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

### GET /reports/orders/{format}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /reports/orders/{format}

```markdown
### Request Body

**Content-Type:** application/json

- **one_result_per_row** (boolean) (required) (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/reports/orders/{format}" \
  -H "Content-Type: application/json" \
  -d '{
  "one_result_per_row": null
}'
```

```

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

### GET /purchases/{ids}/report/{format}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /purchases/{ids}/report/{format}

```markdown
### Parameters

- **oneResultPerRow** (boolean, query, optional):  Indica se cada resultado encontrado para uma pesquisa deve ser mostrado em uma linha diferente. (example: true)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/purchases/{ids}/report/{format}?oneResultPerRow=true"
```

```

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

### GET /purchases/{id}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /purchases/{id}

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>orders, orders_count, ordersExists, orders.ocr, orders.groups, orders.service, first_order, first_order_count, first_orderExists, first_order.service, waiting_invoice_payment, waiting_invoice_payment_count, waiting_invoice_paymentExists, user, user_count, userExists, customer, customer_count, customerExists, quote_appraiser, quote_appraiser_count, quote_appraiserExists, recurrence, recurrence_count, recurrenceExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>orders.ai_service_name, orders_status_count, downloadable_orders_ids, orders_count, orders_expired_count, orders_status_count, last_status_change_at, has_ai_extracted_data, has_ai_analysis_pending, orders.has_ai_extracted_data, orders.has_ai_analysis_pending, originated_from_orders, first_order.ai_service_name, orders.has_ai_extracted_data, orders.has_ai_analysis_pending, downloaded_orders_ids, downloadable_orders_ids_not_downloaded</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/purchases/{id}?include=null&append=null"
```

```

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

### GET /customer-service-expirations

Source: https://api2.cbrdoc.com.br/docs.openapi

O retorno é paginado

```markdown
### Parameters

- **page** (integer, query, optional): a página desejada (example: 1)
- **per-page** (integer, query, optional): quantidade de registros por página (padrão é 20, máx 30) (example: 10)
- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>customer, customer_count, customerExists, service, service_count, serviceExists</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>service_id</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/customer-service-expirations?page=1&per-page=10&include=null&filter=null"
```

```

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

### GET /orders/{id}

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /orders/{id}

```markdown
### Parameters

- **include** (string, query, optional): Relações disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>groups, groups_count, groupsExists, purchase, purchase_count, purchaseExists, service, service_count, serviceExists, user, user_count, userExists, customer, customer_count, customerExists, explorer_item, explorer_item_count, explorer_itemExists, explorer_item.groups, explorer_item.ai_question_history, purchase.waiting_invoice_payment, purchase.recurrence, ocr, ocr_count, ocrExists, ocr.pages, active_challenge, active_challenge_count, active_challengeExists, challenges, challenges_count, challengesExists, originated_from, originated_from_count, originated_fromExists</small> (example: null)
- **append** (string, query, optional): Propriedades disponíveis para incluir na resposta. Múltiplas devem ser separadas com vírgula. 
                                                        Disponíveis: <small>ai_service_name, refundable, explorer_item.file, has_ai_extracted_data, has_ai_analysis_pending, explorer_item_id, ai_service_name, refundable, refundable_value, purchase.downloadable_orders_ids, place_order_default_values, is_expired, can_be_downloaded, explorer_item.ai_enrich_data_available, explorer_item.depends_on_ocr_to_request_ai, previous_order_id_same_purchase, next_order_id_same_purchase, purchase.orders_count, index_in_purchase, can_accept_additional_information, times_downloaded, explorer_item.ai_data, is_summary_extraction_queued, is_get_ai_answers_queued, originated_from_backoffice_code, explorer_item.ai_model_name</small> (example: null)
- **filter** (string[], query, optional): Campos disponíveis para filtrar. <small>Ex: filter[nome_campo]=valor ou filter[nome_campo]=valor1,valor2</small>. 
                                                        Disponíveis: <small>id, register, result, name_or_id_or_register, placed_between, valid_until_between, status, service_id, group_id, user_id, purchase.recurrence_id, ai, purchase_id, ocr_content, expired, has_active_challenge, recurrence_generated, has_extracted_summary, originated_from_id, person_document, detailed_service_data.modelo_ia_id</small> (example: null)

### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/orders/{id}?include=null&append=null&filter=null"
```

```

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

### GET /orders/{order_id}/summary

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /orders/{order_id}/summary

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/orders/{order_id}/summary"
```

```

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

### GET /orders/{order_id}/detailed-progress

Source: https://api2.cbrdoc.com.br/docs.openapi

API endpoint for GET /orders/{order_id}/detailed-progress

```markdown
### Responses

### Example Usage

```bash
curl -X GET "https://api2.cbrdoc.com.br/orders/{order_id}/detailed-progress"
```

```