# API Auvo

API pública da plataforma Auvo. REST, stateless, autenticação via
Bearer JWT de 30 minutos. Rate limit de 400 requisições por minuto por IP.


API pública da plataforma Auvo

Version: 2.0.0
License: Proprietary (Auvo)

## Servers

Produção
```
https://api.auvo.com.br/v2
```

Sandbox (proposed — not yet available)
```
https://sandbox.api.auvo.com.br/v2
```

## Security

### bearerAuth

Obtenha um token chamando `POST /login`. O token expira em 30 minutos e deve ser renovado.

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[API Auvo](https://developer.auvo.com.br/_bundle/openapi/api-reference.yaml)

## Login

Endpoints de autenticação. Troque suas credenciais (`apiKey` e `apiToken`) por um token Bearer JWT com validade de 30 minutos, usado em todas as demais chamadas da API.

### Autenticar via GET

 - [GET /login](https://developer.auvo.com.br/openapi/api-reference/login/retrieve-a-authentication-get.md): The query param example describes the minimum required attributes to successfully retrieve a authentication.
The property authenticated will indicate whether the authentication was a success or not.

### Autenticar via POST

 - [POST /login](https://developer.auvo.com.br/openapi/api-reference/login/retrieve-a-authentication-post.md): The body example describes the minimum required attributes to successfully retrieve a authentication.
The property authenticated will indicate whether the authentication was a success or not.
See the Attributes or Json Schema in the Example section for all allowed attributes.

## Usuários

Gestão dos usuários (técnicos, gestores e administradores) cadastrados na sua conta Auvo. Permite consultar, criar, atualizar e remover colaboradores que executam tarefas em campo.

### Consultar usuário

 - [GET /users/{id}](https://developer.auvo.com.br/openapi/api-reference/usuarios/retrieve-a-user.md): Returns the details of a single User identified by its unique identifier.

### Editar usuário

 - [PATCH /users/{id}](https://developer.auvo.com.br/openapi/api-reference/usuarios/edit-a-user.md): To update a User, send a JSONPatchDocument with updated value for one or more of the UserPatch attributes. See the Attributes or Json Schema in the Example section for all allowed attributes.
JsonPatch example: { "op": "replace", "path": "login", "value": "login.user" }
For more information on JsonPatch, visit: http://jsonpatch.com/.

### Excluir usuário

 - [DELETE /users/{id}](https://developer.auvo.com.br/openapi/api-reference/usuarios/delete-a-user.md): Removes a User from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo usuário

 - [POST /users](https://developer.auvo.com.br/openapi/api-reference/usuarios/add-a-new-user.md): The body example describes the minimum required attributes to successfully add an user. See the Attributes or Json Schema in the Example section for all allowed attributes.

### Criar ou atualizar usuário

 - [PUT /users](https://developer.auvo.com.br/openapi/api-reference/usuarios/upsert-add-a-new-user-or-update-an-existing-one.md): Update or register a new user according to one of its identifier, id OR externalId. If there is no user with the provided identifier, create a new user, if it exists, update it. Returns HTTP status code 200 if the user was updated and 201 if it was created.

The body example describes the minimum required attributes to successfully add/update an user. See the Attributes or Json Schema in the Example section for all allowed attributes.

### Listar usuários

 - [GET /users](https://developer.auvo.com.br/openapi/api-reference/usuarios/retrieve-a-list-of-users.md): Returns a paginated list of Users registered in your account. Use the query parameters to filter, sort and paginate results.

## Clientes

Clientes (pessoas físicas ou jurídicas) atendidos pela sua operação. Permite manter o cadastro completo, anexos e endereços usados como destino das tarefas.

### Consultar cliente

 - [GET /customers/{id}](https://developer.auvo.com.br/openapi/api-reference/clientes/retrieve-a-customer.md): Returns the details of a single Customer identified by its unique identifier.

### Editar cliente

 - [PATCH /customers/{id}](https://developer.auvo.com.br/openapi/api-reference/clientes/edit-a-customer.md): To update a Customer, send a JSONPatchDocument with updated value for one or more of the CustomerPatch attributes.
JsonPatch example: { "op": "replace", "path": "name", "value": "New Name" }

### Excluir cliente

 - [DELETE /customers/{id}](https://developer.auvo.com.br/openapi/api-reference/clientes/delete-a-customer.md): Removes a Customer from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo cliente

 - [POST /customers](https://developer.auvo.com.br/openapi/api-reference/clientes/add-a-new-customer.md): Creates a new Customer in your account using the data provided in the request body.

### Criar ou atualizar cliente

 - [PUT /customers](https://developer.auvo.com.br/openapi/api-reference/clientes/upsert-a-customer.md): Update or register a new customer according to one of its identifier, id OR externalId. If identifierBycpfCnpj is true, also uses cpfCnpj as identifier.

### Listar clientes

 - [GET /customers](https://developer.auvo.com.br/openapi/api-reference/clientes/retrieve-a-list-of-customers.md): Returns a paginated list of Customers registered in your account. Use the query parameters to filter, sort and paginate results.

### Adicionar novo cliente completo

 - [POST /customers/complete](https://developer.auvo.com.br/openapi/api-reference/clientes/add-a-new-customer-complete.md): Register a customer with complete data including billing information, observations, and team associations by name.

### Criar ou atualizar cliente completo

 - [PUT /customers/complete](https://developer.auvo.com.br/openapi/api-reference/clientes/upsert-a-customer-complete.md): Same as Upsert but with complete data including billing information.

### Atualizar anexos do cliente

 - [PUT /customers/{id}/attachments](https://developer.auvo.com.br/openapi/api-reference/clientes/update-customer-attachments.md): Updates the data of an existing Customer Attachments identified by its unique identifier.

## Grupos de clientes

Agrupamentos de clientes utilizados para segmentar a base, aplicar regras comerciais e organizar a operação por carteiras ou regiões.

### Listar grupos de clientes

 - [GET /customergroups](https://developer.auvo.com.br/openapi/api-reference/grupos-de-clientes/retrieve-a-list-of-customer-groups.md): Returns a paginated list of Customer Groups registered in your account. Use the query parameters to filter, sort and paginate results.

### Adicionar novo grupo de clientes

 - [POST /customergroups](https://developer.auvo.com.br/openapi/api-reference/grupos-de-clientes/add-a-new-customer-group.md): Creates a new Customer Group in your account using the data provided in the request body.

### Listar clientes de um grupo

 - [GET /customergroups/{clientGroupId}/clients](https://developer.auvo.com.br/openapi/api-reference/grupos-de-clientes/retrieve-clients-of-a-customer-group.md): Returns clients of a Customer Group registered in your account.

### Excluir grupo de clientes

 - [DELETE /customergroups/{id}](https://developer.auvo.com.br/openapi/api-reference/grupos-de-clientes/delete-a-customer-group.md): Removes a Customer Group from your account by its unique identifier. This operation cannot be undone.

## Produtos

Catálogo de produtos disponíveis para consumo nas tarefas, incluindo anexos e o estoque vinculado a cada usuário (employee product stock).

### Consultar produto

 - [GET /products/{id}](https://developer.auvo.com.br/openapi/api-reference/produtos/retrieve-a-product.md): Returns the details of a single Product identified by its unique identifier.

### Editar produto

 - [PATCH /products/{id}](https://developer.auvo.com.br/openapi/api-reference/produtos/edit-a-product.md): To update a Product, send a JSONPatchDocument.

### Excluir produto

 - [DELETE /products/{id}](https://developer.auvo.com.br/openapi/api-reference/produtos/delete-a-product.md): Removes a Product from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo produto

 - [POST /products](https://developer.auvo.com.br/openapi/api-reference/produtos/add-a-new-product.md): Creates a new Product in your account using the data provided in the request body.

### Criar ou atualizar produto

 - [PUT /products](https://developer.auvo.com.br/openapi/api-reference/produtos/upsert-a-product.md): Update or register a new product. Uses id or externalId as identifier.

### Listar produtos

 - [GET /products](https://developer.auvo.com.br/openapi/api-reference/produtos/retrieve-a-list-of-products.md): Returns a paginated list of Products registered in your account. Use the query parameters to filter, sort and paginate results.

### Atualizar anexos do produto

 - [PUT /products/{id}/attachments](https://developer.auvo.com.br/openapi/api-reference/produtos/update-product-attachments.md): Updates the data of an existing Product Attachments identified by its unique identifier.

### Atualizar estoque de produtos do colaborador

 - [PUT /products/employee-product-stock](https://developer.auvo.com.br/openapi/api-reference/produtos/update-employee-product-stock.md): Updates the data of an existing Employee Product Stock identified by its unique identifier.

## Categorias de produtos

Categorias usadas para classificar e filtrar os produtos do catálogo.

### Consultar categoria de produto

 - [GET /productcategories/{id}](https://developer.auvo.com.br/openapi/api-reference/categorias-de-produtos/retrieve-a-product-category.md): Returns the details of a single Product Category identified by its unique identifier.

### Editar categoria de produto

 - [PATCH /productcategories/{id}](https://developer.auvo.com.br/openapi/api-reference/categorias-de-produtos/edit-a-product-category.md): Updates the editable fields of an existing Product Category identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir categoria de produto

 - [DELETE /productcategories/{id}](https://developer.auvo.com.br/openapi/api-reference/categorias-de-produtos/delete-a-product-category.md): Removes a Product Category from your account by its unique identifier. This operation cannot be undone.

### Adicionar nova categoria de produto

 - [POST /productcategories](https://developer.auvo.com.br/openapi/api-reference/categorias-de-produtos/add-a-new-product-category.md): Creates a new Product Category in your account using the data provided in the request body.

### Criar ou atualizar categoria de produto

 - [PUT /productcategories](https://developer.auvo.com.br/openapi/api-reference/categorias-de-produtos/upsert-a-product-category.md): Uses id or externalId as identifier.

### Listar categorias de produtos

 - [GET /productcategories](https://developer.auvo.com.br/openapi/api-reference/categorias-de-produtos/retrieve-a-list-of-product-categories.md): Returns a paginated list of Product Categories registered in your account. Use the query parameters to filter, sort and paginate results.

## Serviços

Catálogo de serviços que podem ser executados em tarefas e orçamentos, incluindo descrição, valor e demais atributos comerciais.

### Consultar serviço

 - [GET /services/{id}](https://developer.auvo.com.br/openapi/api-reference/servicos/retrieve-a-service.md): Returns the details of a single Service identified by its unique identifier.

### Editar serviço

 - [PATCH /services/{id}](https://developer.auvo.com.br/openapi/api-reference/servicos/edit-a-service.md): Updates the editable fields of an existing Service identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir serviço

 - [DELETE /services/{id}](https://developer.auvo.com.br/openapi/api-reference/servicos/delete-a-service.md): Removes a Service from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo serviço

 - [POST /services](https://developer.auvo.com.br/openapi/api-reference/servicos/add-a-new-service.md): Creates a new Service in your account using the data provided in the request body.

### Criar ou atualizar serviço

 - [PUT /services](https://developer.auvo.com.br/openapi/api-reference/servicos/upsert-a-service.md): Uses id or externalCode as identifier.

### Listar serviços

 - [GET /services](https://developer.auvo.com.br/openapi/api-reference/servicos/retrieve-a-list-of-services.md): Returns a paginated list of Services registered in your account. Use the query parameters to filter, sort and paginate results.

### Listar todos os serviços (legado)

 - [GET /services/obterListaServicos](https://developer.auvo.com.br/openapi/api-reference/servicos/retrieve-all-services-legacy.md): Returns all services for the authenticated user without pagination.

## Equipamentos

Equipamentos vinculados aos clientes, com histórico, anexos e categorização utilizados para manutenção, instalação e ordens de serviço.

### Consultar equipamento

 - [GET /equipments/{id}](https://developer.auvo.com.br/openapi/api-reference/equipamentos/retrieve-an-equipment.md): Returns an Equipment registered in your account.

### Editar equipamento

 - [PATCH /equipments/{id}](https://developer.auvo.com.br/openapi/api-reference/equipamentos/edit-an-equipment.md): Updates the editable fields of an existing Equipment identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir equipamento

 - [DELETE /equipments/{id}](https://developer.auvo.com.br/openapi/api-reference/equipamentos/delete-an-equipment.md): Removes a Equipment from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo equipamento

 - [POST /equipments](https://developer.auvo.com.br/openapi/api-reference/equipamentos/add-a-new-equipment.md): Creates a new Equipment in your account using the data provided in the request body.

### Criar ou atualizar equipamento

 - [PUT /equipments](https://developer.auvo.com.br/openapi/api-reference/equipamentos/upsert-an-equipment.md): Uses id or externalId as identifier.

### Listar equipamentos

 - [GET /equipments](https://developer.auvo.com.br/openapi/api-reference/equipamentos/retrieve-a-list-of-equipments.md): Returns a paginated list of Equipments registered in your account. Use the query parameters to filter, sort and paginate results.

### Atualizar anexos do equipamento

 - [PUT /equipments/{id}/attachments](https://developer.auvo.com.br/openapi/api-reference/equipamentos/update-equipment-attachments.md): Updates the data of an existing Equipment Attachments identified by its unique identifier.

## Categorias de equipamentos

Categorias usadas para classificar e organizar os equipamentos cadastrados.

### Consultar categoria de equipamento

 - [GET /equipmentcategories/{id}](https://developer.auvo.com.br/openapi/api-reference/categorias-de-equipamentos/retrieve-an-equipment-category.md): Returns an Equipment Category registered in your account.

### Editar categoria de equipamento

 - [PATCH /equipmentcategories/{id}](https://developer.auvo.com.br/openapi/api-reference/categorias-de-equipamentos/edit-an-equipment-category.md): Updates the editable fields of an existing Equipment Category identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir categoria de equipamento

 - [DELETE /equipmentcategories/{id}](https://developer.auvo.com.br/openapi/api-reference/categorias-de-equipamentos/delete-an-equipment-category.md): Removes a Equipment Category from your account by its unique identifier. This operation cannot be undone.

### Adicionar nova categoria de equipamento

 - [POST /equipmentcategories](https://developer.auvo.com.br/openapi/api-reference/categorias-de-equipamentos/add-a-new-equipment-category.md): Creates a new Equipment Category in your account using the data provided in the request body.

### Listar categorias de equipamentos

 - [GET /equipmentcategories](https://developer.auvo.com.br/openapi/api-reference/categorias-de-equipamentos/retrieve-a-list-of-equipment-categories.md): Returns a paginated list of Equipment Categories registered in your account. Use the query parameters to filter, sort and paginate results.

## Palavras-chave

Palavras-chave (tags) usadas para etiquetar tarefas, clientes e demais recursos, facilitando filtros e relatórios.

### Consultar palavra-chave

 - [GET /keywords/{id}](https://developer.auvo.com.br/openapi/api-reference/palavras-chave/retrieve-a-keyword.md): Returns the details of a single Keyword identified by its unique identifier.

### Editar palavra-chave

 - [PATCH /keywords/{id}](https://developer.auvo.com.br/openapi/api-reference/palavras-chave/edit-a-keyword.md): Updates the editable fields of an existing Keyword identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir palavra-chave

 - [DELETE /keywords/{id}](https://developer.auvo.com.br/openapi/api-reference/palavras-chave/delete-a-keyword.md): Removes a Keyword from your account by its unique identifier. This operation cannot be undone.

### Adicionar nova palavra-chave

 - [POST /keywords](https://developer.auvo.com.br/openapi/api-reference/palavras-chave/add-a-new-keyword.md): Creates a new Keyword in your account using the data provided in the request body.

### Listar palavras-chave

 - [GET /keywords](https://developer.auvo.com.br/openapi/api-reference/palavras-chave/retrieve-a-list-of-keywords.md): Returns a paginated list of Keywords registered in your account. Use the query parameters to filter, sort and paginate results.

## Tipos de tarefa

Tipos de tarefa configurados na conta, usados para padronizar a operação e definir comportamentos específicos por categoria de trabalho.

### Consultar tipo de tarefa

 - [GET /tasktypes/{id}](https://developer.auvo.com.br/openapi/api-reference/tipos-de-tarefa/retrieve-a-task-type.md): Returns the details of a single Task Type identified by its unique identifier.

### Editar tipo de tarefa

 - [PATCH /tasktypes/{id}](https://developer.auvo.com.br/openapi/api-reference/tipos-de-tarefa/edit-a-task-type.md): Updates the editable fields of an existing Task Type identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir tipo de tarefa

 - [DELETE /tasktypes/{id}](https://developer.auvo.com.br/openapi/api-reference/tipos-de-tarefa/delete-a-task-type.md): Removes a Task Type from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo tipo de tarefa

 - [POST /tasktypes](https://developer.auvo.com.br/openapi/api-reference/tipos-de-tarefa/add-a-new-task-type.md): Creates a new Task Type in your account using the data provided in the request body.

### Listar tipos de tarefa

 - [GET /tasktypes](https://developer.auvo.com.br/openapi/api-reference/tipos-de-tarefa/retrieve-a-list-of-task-types.md): Returns a paginated list of Task Types registered in your account. Use the query parameters to filter, sort and paginate results.

## Equipes

Equipes de trabalho que agrupam usuários, permitindo distribuição de tarefas e gestão hierárquica da operação.

### Consultar equipe

 - [GET /teams/{id}](https://developer.auvo.com.br/openapi/api-reference/equipes/retrieve-a-team.md): Returns the details of a single Team identified by its unique identifier.

### Adicionar nova equipe

 - [POST /teams](https://developer.auvo.com.br/openapi/api-reference/equipes/add-a-new-team.md): Creates a new Team in your account using the data provided in the request body.

### Listar equipes

 - [GET /teams](https://developer.auvo.com.br/openapi/api-reference/equipes/retrieve-a-list-of-teams.md): Returns a paginated list of Teams registered in your account. Use the query parameters to filter, sort and paginate results.

### Listar participantes da equipe

 - [GET /teams/{teamId}/users](https://developer.auvo.com.br/openapi/api-reference/equipes/retrieve-team-participants.md): Returns Team Participants registered in your account.

## Segmentos

Segmentos de mercado utilizados para classificar clientes e gerar análises comerciais por área de atuação.

### Consultar segmento

 - [GET /segments/{id}](https://developer.auvo.com.br/openapi/api-reference/segmentos/retrieve-a-segment.md): Returns the details of a single Segment identified by its unique identifier.

### Editar segmento

 - [PATCH /segments/{id}](https://developer.auvo.com.br/openapi/api-reference/segmentos/edit-a-segment.md): Updates the editable fields of an existing Segment identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir segmento

 - [DELETE /segments/{id}](https://developer.auvo.com.br/openapi/api-reference/segmentos/delete-a-segment.md): Removes a Segment from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo segmento

 - [POST /segments](https://developer.auvo.com.br/openapi/api-reference/segmentos/add-a-new-segment.md): Creates a new Segment in your account using the data provided in the request body.

### Listar segmentos

 - [GET /segments](https://developer.auvo.com.br/openapi/api-reference/segmentos/retrieve-a-list-of-segments.md): Returns a paginated list of Segments registered in your account. Use the query parameters to filter, sort and paginate results.

## Tarefas

Tarefas atribuídas aos usuários em campo, incluindo anexos, produtos, serviços e custos adicionais associados. É o recurso central para orquestrar o trabalho operacional na plataforma.

### Consultar tarefa

 - [GET /tasks/{id}](https://developer.auvo.com.br/openapi/api-reference/tarefas/retrieve-a-task.md): The "taskStatus" task return attribute has the following return values:

* Opened = 1

* InDisplacement = 2

* CheckedIn = 3

* CheckedOut = 4

* Finished = 5

* Paused = 6

### Editar tarefa

 - [PATCH /tasks/{id}](https://developer.auvo.com.br/openapi/api-reference/tarefas/edit-a-task.md): To update a Task, send a JSONPatchDocument with updated value for one or more of the TaskPatch attributes.
JsonPatch example: { "op": "replace", "path": "orientation", "value": "New orientation" }

### Excluir tarefa

 - [DELETE /tasks/{id}](https://developer.auvo.com.br/openapi/api-reference/tarefas/delete-a-task.md): Removes a Task from your account by its unique identifier. This operation cannot be undone.

### Adicionar nova tarefa

 - [POST /tasks](https://developer.auvo.com.br/openapi/api-reference/tarefas/add-a-new-task.md): The body example describes the minimum required attributes to successfully add a task. See the Attributes or Json Schema in the Example section for all allowed attributes.

The task address will preferably be obtained through the client's address.
If the customer ID was not informed, the data will be captured by the parameters of the register itself.
When the latitude and longitude are not informed, the Auvo API will attempt to obtain this information through the address you provided.

### Criar ou atualizar tarefa

 - [PUT /tasks](https://developer.auvo.com.br/openapi/api-reference/tarefas/upsert-add-a-new-task-or-update-an-existing-one.md): Update or register a new task according to one of its identifier, id OR externalId. If there is no task with the provided identifier, create a new task, if it exists, update it. Returns HTTP status code 200 if the task was updated and 201 if it was created.

### Listar tarefas

 - [GET /tasks](https://developer.auvo.com.br/openapi/api-reference/tarefas/retrieve-a-list-of-tasks.md): Maximum page size is 100.

### Criar ou atualizar anexos da tarefa

 - [PUT /tasks/{id}/attachments](https://developer.auvo.com.br/openapi/api-reference/tarefas/upsert-task-attachments.md): Add or replace attachments on a task.

### Criar ou atualizar produtos da tarefa

 - [PUT /tasks/{id}/products](https://developer.auvo.com.br/openapi/api-reference/tarefas/upsert-task-products.md): Add or update products on a task.

### Excluir produtos da tarefa

 - [DELETE /tasks/{id}/products](https://developer.auvo.com.br/openapi/api-reference/tarefas/delete-task-products.md): Remove products from a task by providing a list of product GUIDs.

### Criar ou atualizar serviços da tarefa

 - [PUT /tasks/{id}/services](https://developer.auvo.com.br/openapi/api-reference/tarefas/upsert-task-services.md): Add or update services on a task.

### Excluir serviços da tarefa

 - [DELETE /tasks/{id}/services](https://developer.auvo.com.br/openapi/api-reference/tarefas/delete-task-services.md): Remove services from a task by providing a list of service GUIDs.

### Criar ou atualizar custos adicionais da tarefa

 - [PUT /tasks/{id}/additional-costs](https://developer.auvo.com.br/openapi/api-reference/tarefas/upsert-task-additional-costs.md): Add or update additional costs on a task.

### Excluir custos adicionais da tarefa

 - [DELETE /tasks/{id}/additional-costs](https://developer.auvo.com.br/openapi/api-reference/tarefas/delete-task-additional-costs.md): Remove additional costs from a task by providing a list of additional cost GUIDs.

### Criar ou atualizar resposta de questionário da tarefa

 - [PUT /tasks/{id}/questionnaire-response](https://developer.auvo.com.br/openapi/api-reference/tarefas/upsert-task-questionnaire-responses.md): Cria ou atualiza uma resposta de questionário vinculada a uma tarefa.

O processamento é assíncrono. Uma resposta 202 Accepted significa que a resposta foi validada, enfileirada e deve estar disponível na tarefa em até 5 minutos. Isso não garante que o registro final da tarefa já tenha sido atualizado no momento do retorno.

Envie uma resposta por requisição. A resposta é criada ou atualizada para a instância de questionário identificada por itemID, codigoChecklist e codigoPergunta; quando o mesmo checklist estiver vinculado à tarefa mais de uma vez, use um itemID diferente para cada instância. Use codigoEquipamento quando a resposta pertencer a um equipamento específico da tarefa.

### Listar tarefas excluídas

 - [GET /tasks/GetDeletedTasks](https://developer.auvo.com.br/openapi/api-reference/tarefas/retrieve-a-list-of-deleted-tasks.md): Returns deleted tasks. Maximum page size is 100. Same parameters and response format as the task listing endpoint above.

## Chamados

Tickets (chamados) abertos pelos clientes ou pela operação, suportando tipos de solicitação, status e fluxo de atendimento configurável.

### Consultar chamado

 - [GET /tickets/{id}](https://developer.auvo.com.br/openapi/api-reference/chamados/retrieve-a-ticket.md): Returns the details of a single Ticket identified by its unique identifier.

### Editar chamado

 - [PATCH /tickets/{id}](https://developer.auvo.com.br/openapi/api-reference/chamados/edit-a-ticket.md): Updates the editable fields of an existing Ticket identified by its unique identifier. Only the properties present in the request body are modified.

### Adicionar novo chamado

 - [POST /tickets](https://developer.auvo.com.br/openapi/api-reference/chamados/add-a-new-ticket.md): Creates a new Ticket in your account using the data provided in the request body.

### Listar chamados

 - [GET /tickets](https://developer.auvo.com.br/openapi/api-reference/chamados/retrieve-a-list-of-tickets.md): Returns a paginated list of Tickets registered in your account. Use the query parameters to filter, sort and paginate results.

### Listar tipos de solicitação de chamados

 - [GET /tickets/request-type](https://developer.auvo.com.br/openapi/api-reference/chamados/retrieve-ticket-request-types.md): Returns the request types available for Ticket, used to classify and route ticket according to your operational rules.

## Status de chamados

Status disponíveis para os tickets, refletindo as etapas do fluxo de atendimento configurado na sua conta.

### Listar status ativos de chamados

 - [GET /tickets/status](https://developer.auvo.com.br/openapi/api-reference/status-de-chamados/retrieve-active-ticket-statuses.md): Returns the active Ticket Statuses currently configured in your account.

## Questionários

Questionários (formulários) que podem ser vinculados a tarefas e tickets para coleta padronizada de informações em campo.

### Consultar questionário

 - [GET /questionnaires/{id}](https://developer.auvo.com.br/openapi/api-reference/questionarios/retrieve-a-questionnaire.md): Returns the details of a single Questionnaire identified by its unique identifier.

### Listar questionários

 - [GET /questionnaires](https://developer.auvo.com.br/openapi/api-reference/questionarios/retrieve-a-list-of-questionnaires.md): Returns a paginated list of Questionnaires registered in your account. Use the query parameters to filter, sort and paginate results.

## GPS

Posições de GPS registradas pelos usuários, permitindo auditoria de deslocamento, rastreamento em tempo real e relatórios de jornada.

### Listar posições de GPS

 - [GET /gps](https://developer.auvo.com.br/openapi/api-reference/gps/retrieve-a-list-of-gps-positions.md): Returns a paginated list of GPS positions registered in your account. Use the query parameters to filter, sort and paginate results.

## Ordens de serviço

Ordens de serviço (OS) que consolidam o trabalho executado em campo, vinculando tarefas, equipamentos, materiais e cobrança.

### Consultar ordem de serviço

 - [GET /serviceorders/{code}](https://developer.auvo.com.br/openapi/api-reference/ordens-de-servico/retrieve-a-service-order.md): Returns the details of a single Service Order identified by its unique identifier.

### Editar ordem de serviço

 - [PATCH /serviceorders/{code}](https://developer.auvo.com.br/openapi/api-reference/ordens-de-servico/edit-a-service-order.md): Updates the editable fields of an existing Service Order identified by its unique identifier. Only the properties present in the request body are modified.

### Adicionar nova ordem de serviço

 - [POST /serviceorders](https://developer.auvo.com.br/openapi/api-reference/ordens-de-servico/add-a-new-service-order.md): Creates a new Service Order in your account using the data provided in the request body.

### Listar ordens de serviço

 - [GET /serviceorders](https://developer.auvo.com.br/openapi/api-reference/ordens-de-servico/retrieve-a-list-of-service-orders.md): Maximum page size is 100.

## Despesas

Despesas lançadas pelos usuários, com anexos comprobatórios e workflow de aprovação para o financeiro.

### Consultar despesa

 - [GET /expenses/{id}](https://developer.auvo.com.br/openapi/api-reference/despesas/retrieve-an-expense.md): Returns an Expense registered in your account.

### Editar despesa

 - [PATCH /expenses/{id}](https://developer.auvo.com.br/openapi/api-reference/despesas/edit-an-expense.md): Updates the editable fields of an existing Expense identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir despesa

 - [DELETE /expenses/{id}](https://developer.auvo.com.br/openapi/api-reference/despesas/delete-an-expense.md): Removes a Expense from your account by its unique identifier. This operation cannot be undone.

### Adicionar nova despesa

 - [POST /expenses](https://developer.auvo.com.br/openapi/api-reference/despesas/add-a-new-expense.md): Creates a new Expense in your account using the data provided in the request body.

### Listar despesas

 - [GET /expenses](https://developer.auvo.com.br/openapi/api-reference/despesas/retrieve-a-list-of-expenses.md): Returns a paginated list of Expenses registered in your account. Use the query parameters to filter, sort and paginate results.

### Atualizar anexos da despesa

 - [PUT /expenses/{id}/attachments](https://developer.auvo.com.br/openapi/api-reference/despesas/update-expense-attachments.md): Updates the data of an existing Expense Attachments identified by its unique identifier.

## Tipos de despesa

Tipos de despesa configurados na conta para categorizar lançamentos de reembolso e adiantamento.

### Consultar tipo de despesa

 - [GET /expensetypes/{id}](https://developer.auvo.com.br/openapi/api-reference/tipos-de-despesa/retrieve-an-expense-type.md): Returns an Expense Type registered in your account.

### Editar tipo de despesa

 - [PATCH /expensetypes/{id}](https://developer.auvo.com.br/openapi/api-reference/tipos-de-despesa/edit-an-expense-type.md): Updates the editable fields of an existing Expense Type identified by its unique identifier. Only the properties present in the request body are modified.

### Excluir tipo de despesa

 - [DELETE /expensetypes/{id}](https://developer.auvo.com.br/openapi/api-reference/tipos-de-despesa/delete-an-expense-type.md): Removes a Expense Type from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo tipo de despesa

 - [POST /expensetypes](https://developer.auvo.com.br/openapi/api-reference/tipos-de-despesa/add-a-new-expense-type.md): Creates a new Expense Type in your account using the data provided in the request body.

### Listar tipos de despesa

 - [GET /expensetypes](https://developer.auvo.com.br/openapi/api-reference/tipos-de-despesa/retrieve-a-list-of-expense-types.md): Returns a paginated list of Expense Types registered in your account. Use the query parameters to filter, sort and paginate results.

## Custos adicionais

Custos adicionais (deslocamento, pedágio, hospedagem etc.) que podem ser lançados em tarefas e orçamentos.

### Listar custos adicionais

 - [GET /additionalcosts](https://developer.auvo.com.br/openapi/api-reference/custos-adicionais/retrieve-a-list-of-additional-costs.md): Returns a paginated list of Additional Costs registered in your account. Use the query parameters to filter, sort and paginate results.

### Adicionar novo custo adicional

 - [POST /additionalcosts](https://developer.auvo.com.br/openapi/api-reference/custos-adicionais/add-a-new-additional-cost.md): Creates a new Additional Cost in your account using the data provided in the request body.

### Atualizar custo adicional

 - [PUT /additionalcosts/{id}](https://developer.auvo.com.br/openapi/api-reference/custos-adicionais/update-an-additional-cost.md): Updates the data of an existing Additional Cost identified by its unique identifier.

## Notas fiscais

Notas fiscais geradas a partir de tarefas, orçamentos e ordens de serviço, integrando o ciclo operacional ao financeiro.

### Consultar nota fiscal

 - [GET /invoices/{id}](https://developer.auvo.com.br/openapi/api-reference/notas-fiscais/retrieve-an-invoice.md): Returns an Invoice registered in your account.

### Atualizar nota fiscal

 - [PUT /invoices/{id}](https://developer.auvo.com.br/openapi/api-reference/notas-fiscais/update-an-invoice.md): Some fields are blocked after the invoice is receipted (customerId, responsibleUserId, discountType, discountValue, products, services, additionalCosts, payment).

### Adicionar nova nota fiscal

 - [POST /invoices](https://developer.auvo.com.br/openapi/api-reference/notas-fiscais/add-a-new-invoice.md): Creates a new Invoice in your account using the data provided in the request body.

### Listar notas fiscais

 - [GET /invoices](https://developer.auvo.com.br/openapi/api-reference/notas-fiscais/retrieve-a-list-of-invoices.md): Maximum page size is 100.

## Orçamentos

Orçamentos enviados aos clientes, com itens (produtos, serviços e custos adicionais), status comercial e conversão em ordens de serviço.

### Consultar orçamento

 - [GET /quotations/{id}](https://developer.auvo.com.br/openapi/api-reference/orcamentos/retrieve-a-quotation.md): Notes:

- taskIds: returns an empty array [] when the quotation has no associated tasks.

- payment: returns null when the quotation has no installments.

- leadName: returns null when a customer is associated (customerId > 0).

- internalNote: returns null when empty.

### Editar orçamento

 - [PATCH /quotations/{id}](https://developer.auvo.com.br/openapi/api-reference/orcamentos/edit-a-quotation.md): Updates the editable fields of an existing Quotation identified by its unique identifier. Only the properties present in the request body are modified.

### Adicionar novo orçamento

 - [POST /quotations](https://developer.auvo.com.br/openapi/api-reference/orcamentos/add-a-new-quotation.md): Creates a new Quotation in your account using the data provided in the request body.

### Listar orçamentos

 - [GET /quotations](https://developer.auvo.com.br/openapi/api-reference/orcamentos/retrieve-a-list-of-quotations.md): Returns a paginated list of Quotations registered in your account. Use the query parameters to filter, sort and paginate results.

### Adicionar serviço ao orçamento

 - [POST /quotations/{id}/services/{idService}](https://developer.auvo.com.br/openapi/api-reference/orcamentos/add-service-to-quotation.md): Creates a new Service to Quotation in your account using the data provided in the request body.

### Atualizar serviço no orçamento

 - [PUT /quotations/{id}/services/{idService}](https://developer.auvo.com.br/openapi/api-reference/orcamentos/update-service-in-quotation.md): Uses JSONPatchDocument.

### Excluir serviço do orçamento

 - [DELETE /quotations/{id}/services/{idService}](https://developer.auvo.com.br/openapi/api-reference/orcamentos/delete-service-from-quotation.md): Removes a Service from Quotation from your account by its unique identifier. This operation cannot be undone.

### Adicionar produto ao orçamento

 - [POST /quotations/{id}/products](https://developer.auvo.com.br/openapi/api-reference/orcamentos/add-product-to-quotation.md): Creates a new Product to Quotation in your account using the data provided in the request body.

### Atualizar produto no orçamento

 - [PUT /quotations/{id}/products/{idProduct}](https://developer.auvo.com.br/openapi/api-reference/orcamentos/update-product-in-quotation.md): Uses JSONPatchDocument.

### Excluir produto do orçamento

 - [DELETE /quotations/{id}/products/{idProduct}](https://developer.auvo.com.br/openapi/api-reference/orcamentos/delete-product-from-quotation.md): Removes a Product from Quotation from your account by its unique identifier. This operation cannot be undone.

### Criar ou atualizar custo adicional no orçamento

 - [PUT /quotations/{id}/adicost](https://developer.auvo.com.br/openapi/api-reference/orcamentos/upsert-additional-cost-in-quotation.md): Upsert Additional Cost in Quotation.

### Excluir custo adicional do orçamento

 - [DELETE /quotations/{id}/adicost](https://developer.auvo.com.br/openapi/api-reference/orcamentos/delete-additional-cost-from-quotation.md): Removes a Additional Cost from Quotation from your account by its unique identifier. This operation cannot be undone.

## Contas a receber

Contas a receber geradas a partir das atividades operacionais, com método de pagamento, vencimento e status financeiro.

### Consultar conta a receber

 - [GET /receivables/{id}](https://developer.auvo.com.br/openapi/api-reference/contas-a-receber/retrieve-a-receivable.md): Returns the details of a single Receivable identified by its unique identifier.

### Atualizar conta a receber

 - [PUT /receivables/{id}](https://developer.auvo.com.br/openapi/api-reference/contas-a-receber/update-a-receivable.md): Updates the data of an existing Receivable identified by its unique identifier.

### Adicionar nova conta a receber

 - [POST /receivables](https://developer.auvo.com.br/openapi/api-reference/contas-a-receber/add-a-new-receivable.md): Creates a new Receivable in your account using the data provided in the request body.

### Listar contas a receber

 - [GET /receivables](https://developer.auvo.com.br/openapi/api-reference/contas-a-receber/retrieve-a-list-of-receivables.md): Maximum page size is 100.

## Categorias financeiras

Categorias financeiras usadas para classificar receitas e despesas no plano de contas da conta.

### Listar categorias financeiras

 - [GET /financialcategories](https://developer.auvo.com.br/openapi/api-reference/categorias-financeiras/retrieve-a-list-of-financial-categories.md): Maximum page size is 100.

## Métodos de pagamento

Métodos de pagamento (cartão, boleto, pix etc.) configurados na conta e disponíveis para uso em recebíveis e orçamentos.

### Listar métodos de pagamento

 - [GET /paymentmethods](https://developer.auvo.com.br/openapi/api-reference/metodos-de-pagamento/retrieve-a-list-of-payment-methods.md): Maximum page size is 100.

## Pesquisas de satisfação

Pesquisas de satisfação respondidas pelos clientes ao final do atendimento, usadas para medir NPS e qualidade do serviço.

### Listar respostas de pesquisas de satisfação

 - [GET /satisfactionsurveys](https://developer.auvo.com.br/openapi/api-reference/pesquisas-de-satisfacao/retrieve-a-list-of-satisfaction-survey-responses.md): Returns a paginated list of Satisfaction Survey responses registered in your account. Use the query parameters to filter, sort and paginate results.

## WebHooks

Configuração de webhooks para receber notificações em tempo real sobre eventos da plataforma (criação/atualização de tarefas, tickets etc.) na sua aplicação.

### Consultar WebHook

 - [GET /webhooks/{id}](https://developer.auvo.com.br/openapi/api-reference/webhooks/retrieve-a-web-hook.md): Returns the details of a single WebHook identified by its unique identifier.

### Excluir WebHook

 - [DELETE /webhooks/{id}](https://developer.auvo.com.br/openapi/api-reference/webhooks/delete-a-web-hook.md): Removes a WebHook from your account by its unique identifier. This operation cannot be undone.

### Adicionar novo WebHook

 - [POST /webhooks](https://developer.auvo.com.br/openapi/api-reference/webhooks/add-a-new-web-hook.md): If the id is provided and a webhook with that id already exists, the webhook will be updated instead of created. Returns HTTP status code 200 if updated and 201 if created.

Entity values:

* 1 - User

* 4 - Task

* 7 - Customer

* 27 - Equipment

* 62 - Ticket

Action values:

* 1 - Inclusao (Creation)

* 2 - Alteracao (Modification)

* 3 - Exclusao (Deletion)

### Listar WebHooks

 - [GET /webhooks](https://developer.auvo.com.br/openapi/api-reference/webhooks/retrieve-a-list-of-web-hooks.md): Returns a paginated list of WebHooks registered in your account. Use the query parameters to filter, sort and paginate results.