# Auvo API REST, stateless, Bearer JWT authentication with 30-minute validity. Rate limit of 400 requests per minute per IP. Public API for the Auvo platform 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 [Auvo API](https://developer.auvo.com.br/_bundle/@l10n/en/openapi/api-reference.yaml) ## Login Authentication and Bearer JWT token issuance. ### Retrieve a authentication - GET - [GET /login](https://developer.auvo.com.br/en/openapi/api-reference/login/retrieve-a-authentication-get.md): Authenticates with apiKey and apiToken passed as query parameters. Returns an accessToken valid for 30 minutes. ### Retrieve a authentication - POST - [POST /login](https://developer.auvo.com.br/en/openapi/api-reference/login/retrieve-a-authentication-post.md): Authenticates with apiKey and apiToken in the request body. Preferred over GET to avoid leaking credentials in URL logs. ## Users Admin and technician users of the Auvo account. ### Retrieve a User - [GET /users/{id}](https://developer.auvo.com.br/en/openapi/api-reference/users/retrieve-a-user.md): Returns the details of a Users record identified by its unique identifier. ### Edit a User - [PATCH /users/{id}](https://developer.auvo.com.br/en/openapi/api-reference/users/edit-a-user.md): Updates the editable fields of an existing Users record. Only properties present in the request body are modified. ### Delete a User - [DELETE /users/{id}](https://developer.auvo.com.br/en/openapi/api-reference/users/delete-a-user.md): Removes the relationship or Users record from your account. This operation cannot be undone. ### Add a new User - [POST /users](https://developer.auvo.com.br/en/openapi/api-reference/users/add-a-new-user.md): Creates a Users record in your account using the data provided in the request body. ### Upsert - Add a new User or update an existing one - [PUT /users](https://developer.auvo.com.br/en/openapi/api-reference/users/upsert-add-a-new-user-or-update-an-existing-one.md): Updates or replaces Users data using the payload provided in the request body. ### Retrieve a list of Users - [GET /users](https://developer.auvo.com.br/en/openapi/api-reference/users/retrieve-a-list-of-users.md): Returns a paginated list of Users registered in your account. Use query parameters to filter, sort and paginate results. ## Customers Customers registered in the account. ### Retrieve a Customer - [GET /customers/{id}](https://developer.auvo.com.br/en/openapi/api-reference/customers/retrieve-a-customer.md): Returns the details of a Customers record identified by its unique identifier. ### Edit a Customer - [PATCH /customers/{id}](https://developer.auvo.com.br/en/openapi/api-reference/customers/edit-a-customer.md): Updates the editable fields of an existing Customers record. Only properties present in the request body are modified. ### Delete a Customer - [DELETE /customers/{id}](https://developer.auvo.com.br/en/openapi/api-reference/customers/delete-a-customer.md): Removes the relationship or Customers record from your account. This operation cannot be undone. ### Add a new Customer - [POST /customers](https://developer.auvo.com.br/en/openapi/api-reference/customers/add-a-new-customer.md): Creates a Customers record in your account using the data provided in the request body. ### Upsert a Customer - [PUT /customers](https://developer.auvo.com.br/en/openapi/api-reference/customers/upsert-a-customer.md): Updates or replaces Customers data using the payload provided in the request body. ### Retrieve a list of Customers - [GET /customers](https://developer.auvo.com.br/en/openapi/api-reference/customers/retrieve-a-list-of-customers.md): Returns a paginated list of Customers registered in your account. Use query parameters to filter, sort and paginate results. ### Add a new Customer - Complete - [POST /customers/complete](https://developer.auvo.com.br/en/openapi/api-reference/customers/add-a-new-customer-complete.md): Creates a Customers record in your account using the data provided in the request body. ### Upsert a Customer - Complete - [PUT /customers/complete](https://developer.auvo.com.br/en/openapi/api-reference/customers/upsert-a-customer-complete.md): Updates or replaces Customers data using the payload provided in the request body. ### Update Customer Attachments - [PUT /customers/{id}/attachments](https://developer.auvo.com.br/en/openapi/api-reference/customers/update-customer-attachments.md): Updates or replaces Customers data using the payload provided in the request body. ## Customer Groups Customer groups used to segment records. ### Retrieve a list of Customer Groups - [GET /customergroups](https://developer.auvo.com.br/en/openapi/api-reference/customer-groups/retrieve-a-list-of-customer-groups.md): Returns a paginated list of Customer Groups registered in your account. Use query parameters to filter, sort and paginate results. ### Add a new Customer Group - [POST /customergroups](https://developer.auvo.com.br/en/openapi/api-reference/customer-groups/add-a-new-customer-group.md): Creates a Customer Groups record in your account using the data provided in the request body. ### Retrieve clients of a Customer Group - [GET /customergroups/{clientGroupId}/clients](https://developer.auvo.com.br/en/openapi/api-reference/customer-groups/retrieve-clients-of-a-customer-group.md): Returns a paginated list of Customer Groups registered in your account. Use query parameters to filter, sort and paginate results. ### Delete a Customer Group - [DELETE /customergroups/{id}](https://developer.auvo.com.br/en/openapi/api-reference/customer-groups/delete-a-customer-group.md): Removes the relationship or Customer Groups record from your account. This operation cannot be undone. ## Products Products and inventory items registered in the account. ### Retrieve a Product - [GET /products/{id}](https://developer.auvo.com.br/en/openapi/api-reference/products/retrieve-a-product.md): Returns the details of a Products record identified by its unique identifier. ### Edit a Product - [PATCH /products/{id}](https://developer.auvo.com.br/en/openapi/api-reference/products/edit-a-product.md): Updates the editable fields of an existing Products record. Only properties present in the request body are modified. ### Delete a Product - [DELETE /products/{id}](https://developer.auvo.com.br/en/openapi/api-reference/products/delete-a-product.md): Removes the relationship or Products record from your account. This operation cannot be undone. ### Add a new Product - [POST /products](https://developer.auvo.com.br/en/openapi/api-reference/products/add-a-new-product.md): Creates a Products record in your account using the data provided in the request body. ### Upsert a Product - [PUT /products](https://developer.auvo.com.br/en/openapi/api-reference/products/upsert-a-product.md): Updates or replaces Products data using the payload provided in the request body. ### Retrieve a list of Products - [GET /products](https://developer.auvo.com.br/en/openapi/api-reference/products/retrieve-a-list-of-products.md): Returns a paginated list of Products registered in your account. Use query parameters to filter, sort and paginate results. ### Update Product Attachments - [PUT /products/{id}/attachments](https://developer.auvo.com.br/en/openapi/api-reference/products/update-product-attachments.md): Updates or replaces Products data using the payload provided in the request body. ### Update Employee Product Stock - [PUT /products/employee-product-stock](https://developer.auvo.com.br/en/openapi/api-reference/products/update-employee-product-stock.md): Updates or replaces Products data using the payload provided in the request body. ## Product Categories Categories used to organize products. ### Retrieve a Product Category - [GET /productcategories/{id}](https://developer.auvo.com.br/en/openapi/api-reference/product-categories/retrieve-a-product-category.md): Returns the details of a Product Categories record identified by its unique identifier. ### Edit a Product Category - [PATCH /productcategories/{id}](https://developer.auvo.com.br/en/openapi/api-reference/product-categories/edit-a-product-category.md): Updates the editable fields of an existing Product Categories record. Only properties present in the request body are modified. ### Delete a Product Category - [DELETE /productcategories/{id}](https://developer.auvo.com.br/en/openapi/api-reference/product-categories/delete-a-product-category.md): Removes the relationship or Product Categories record from your account. This operation cannot be undone. ### Add a new Product Category - [POST /productcategories](https://developer.auvo.com.br/en/openapi/api-reference/product-categories/add-a-new-product-category.md): Creates a Product Categories record in your account using the data provided in the request body. ### Upsert a Product Category - [PUT /productcategories](https://developer.auvo.com.br/en/openapi/api-reference/product-categories/upsert-a-product-category.md): Updates or replaces Product Categories data using the payload provided in the request body. ### Retrieve a list of Product Categories - [GET /productcategories](https://developer.auvo.com.br/en/openapi/api-reference/product-categories/retrieve-a-list-of-product-categories.md): Returns a paginated list of Product Categories registered in your account. Use query parameters to filter, sort and paginate results. ## Services Services offered and consumed by field operations. ### Retrieve a Service - [GET /services/{id}](https://developer.auvo.com.br/en/openapi/api-reference/services/retrieve-a-service.md): Returns the details of a Services record identified by its unique identifier. ### Edit a Service - [PATCH /services/{id}](https://developer.auvo.com.br/en/openapi/api-reference/services/edit-a-service.md): Updates the editable fields of an existing Services record. Only properties present in the request body are modified. ### Delete a Service - [DELETE /services/{id}](https://developer.auvo.com.br/en/openapi/api-reference/services/delete-a-service.md): Removes the relationship or Services record from your account. This operation cannot be undone. ### Add a new Service - [POST /services](https://developer.auvo.com.br/en/openapi/api-reference/services/add-a-new-service.md): Creates a Services record in your account using the data provided in the request body. ### Upsert a Service - [PUT /services](https://developer.auvo.com.br/en/openapi/api-reference/services/upsert-a-service.md): Updates or replaces Services data using the payload provided in the request body. ### Retrieve a list of Services - [GET /services](https://developer.auvo.com.br/en/openapi/api-reference/services/retrieve-a-list-of-services.md): Returns a paginated list of Services registered in your account. Use query parameters to filter, sort and paginate results. ### Retrieve all Services (legacy) - [GET /services/obterListaServicos](https://developer.auvo.com.br/en/openapi/api-reference/services/retrieve-all-services-legacy.md): Returns the details of a Services record identified by its unique identifier. ## Equipments Customer equipment and related records. ### Retrieve an Equipment - [GET /equipments/{id}](https://developer.auvo.com.br/en/openapi/api-reference/equipments/retrieve-an-equipment.md): Returns the details of a Equipments record identified by its unique identifier. ### Edit an Equipment - [PATCH /equipments/{id}](https://developer.auvo.com.br/en/openapi/api-reference/equipments/edit-an-equipment.md): Updates the editable fields of an existing Equipments record. Only properties present in the request body are modified. ### Delete an Equipment - [DELETE /equipments/{id}](https://developer.auvo.com.br/en/openapi/api-reference/equipments/delete-an-equipment.md): Removes the relationship or Equipments record from your account. This operation cannot be undone. ### Add a new Equipment - [POST /equipments](https://developer.auvo.com.br/en/openapi/api-reference/equipments/add-a-new-equipment.md): Creates a Equipments record in your account using the data provided in the request body. ### Upsert an Equipment - [PUT /equipments](https://developer.auvo.com.br/en/openapi/api-reference/equipments/upsert-an-equipment.md): Updates or replaces Equipments data using the payload provided in the request body. ### Retrieve a list of Equipments - [GET /equipments](https://developer.auvo.com.br/en/openapi/api-reference/equipments/retrieve-a-list-of-equipments.md): Returns a paginated list of Equipments registered in your account. Use query parameters to filter, sort and paginate results. ### Update Equipment Attachments - [PUT /equipments/{id}/attachments](https://developer.auvo.com.br/en/openapi/api-reference/equipments/update-equipment-attachments.md): Updates or replaces Equipments data using the payload provided in the request body. ## Equipment Categories Categories used to organize equipment. ### Retrieve an Equipment Category - [GET /equipmentcategories/{id}](https://developer.auvo.com.br/en/openapi/api-reference/equipment-categories/retrieve-an-equipment-category.md): Returns the details of a Equipment Categories record identified by its unique identifier. ### Edit an Equipment Category - [PATCH /equipmentcategories/{id}](https://developer.auvo.com.br/en/openapi/api-reference/equipment-categories/edit-an-equipment-category.md): Updates the editable fields of an existing Equipment Categories record. Only properties present in the request body are modified. ### Delete an Equipment Category - [DELETE /equipmentcategories/{id}](https://developer.auvo.com.br/en/openapi/api-reference/equipment-categories/delete-an-equipment-category.md): Removes the relationship or Equipment Categories record from your account. This operation cannot be undone. ### Add a new Equipment Category - [POST /equipmentcategories](https://developer.auvo.com.br/en/openapi/api-reference/equipment-categories/add-a-new-equipment-category.md): Creates a Equipment Categories record in your account using the data provided in the request body. ### Retrieve a list of Equipment Categories - [GET /equipmentcategories](https://developer.auvo.com.br/en/openapi/api-reference/equipment-categories/retrieve-a-list-of-equipment-categories.md): Returns a paginated list of Equipment Categories registered in your account. Use query parameters to filter, sort and paginate results. ## Keywords Keywords used to classify and search records. ### Retrieve a Keyword - [GET /keywords/{id}](https://developer.auvo.com.br/en/openapi/api-reference/keywords/retrieve-a-keyword.md): Returns the details of a Keywords record identified by its unique identifier. ### Edit a Keyword - [PATCH /keywords/{id}](https://developer.auvo.com.br/en/openapi/api-reference/keywords/edit-a-keyword.md): Updates the editable fields of an existing Keywords record. Only properties present in the request body are modified. ### Delete a Keyword - [DELETE /keywords/{id}](https://developer.auvo.com.br/en/openapi/api-reference/keywords/delete-a-keyword.md): Removes the relationship or Keywords record from your account. This operation cannot be undone. ### Add a new Keyword - [POST /keywords](https://developer.auvo.com.br/en/openapi/api-reference/keywords/add-a-new-keyword.md): Creates a Keywords record in your account using the data provided in the request body. ### Retrieve a list of Keywords - [GET /keywords](https://developer.auvo.com.br/en/openapi/api-reference/keywords/retrieve-a-list-of-keywords.md): Returns a paginated list of Keywords registered in your account. Use query parameters to filter, sort and paginate results. ## Task Types Task type configuration for field workflows. ### Retrieve a Task Type - [GET /tasktypes/{id}](https://developer.auvo.com.br/en/openapi/api-reference/task-types/retrieve-a-task-type.md): Returns the details of a Task Types record identified by its unique identifier. ### Edit a Task Type - [PATCH /tasktypes/{id}](https://developer.auvo.com.br/en/openapi/api-reference/task-types/edit-a-task-type.md): Updates the editable fields of an existing Task Types record. Only properties present in the request body are modified. ### Delete a Task Type - [DELETE /tasktypes/{id}](https://developer.auvo.com.br/en/openapi/api-reference/task-types/delete-a-task-type.md): Removes the relationship or Task Types record from your account. This operation cannot be undone. ### Add a new Task Type - [POST /tasktypes](https://developer.auvo.com.br/en/openapi/api-reference/task-types/add-a-new-task-type.md): Creates a Task Types record in your account using the data provided in the request body. ### Retrieve a list of Task Types - [GET /tasktypes](https://developer.auvo.com.br/en/openapi/api-reference/task-types/retrieve-a-list-of-task-types.md): Returns a paginated list of Task Types registered in your account. Use query parameters to filter, sort and paginate results. ## Teams Teams and their assigned users. ### Retrieve a Team - [GET /teams/{id}](https://developer.auvo.com.br/en/openapi/api-reference/teams/retrieve-a-team.md): Returns the details of a Teams record identified by its unique identifier. ### Add a new Team - [POST /teams](https://developer.auvo.com.br/en/openapi/api-reference/teams/add-a-new-team.md): Creates a Teams record in your account using the data provided in the request body. ### Retrieve a list of Teams - [GET /teams](https://developer.auvo.com.br/en/openapi/api-reference/teams/retrieve-a-list-of-teams.md): Returns a paginated list of Teams registered in your account. Use query parameters to filter, sort and paginate results. ### Retrieve Team Participants - [GET /teams/{teamId}/users](https://developer.auvo.com.br/en/openapi/api-reference/teams/retrieve-team-participants.md): Returns the details of a Teams record identified by its unique identifier. ## Segments Customer and operation segments. ### Retrieve a Segment - [GET /segments/{id}](https://developer.auvo.com.br/en/openapi/api-reference/segments/retrieve-a-segment.md): Returns the details of a Segments record identified by its unique identifier. ### Edit a Segment - [PATCH /segments/{id}](https://developer.auvo.com.br/en/openapi/api-reference/segments/edit-a-segment.md): Updates the editable fields of an existing Segments record. Only properties present in the request body are modified. ### Delete a Segment - [DELETE /segments/{id}](https://developer.auvo.com.br/en/openapi/api-reference/segments/delete-a-segment.md): Removes the relationship or Segments record from your account. This operation cannot be undone. ### Add a new Segment - [POST /segments](https://developer.auvo.com.br/en/openapi/api-reference/segments/add-a-new-segment.md): Creates a Segments record in your account using the data provided in the request body. ### Retrieve a list of Segments - [GET /segments](https://developer.auvo.com.br/en/openapi/api-reference/segments/retrieve-a-list-of-segments.md): Returns a paginated list of Segments registered in your account. Use query parameters to filter, sort and paginate results. ## Tasks Service orders, visits and field tasks. ### Retrieve a Task - [GET /tasks/{id}](https://developer.auvo.com.br/en/openapi/api-reference/tasks/retrieve-a-task.md): Returns the details of a Tasks record identified by its unique identifier. ### Edit a Task - [PATCH /tasks/{id}](https://developer.auvo.com.br/en/openapi/api-reference/tasks/edit-a-task.md): Updates the editable fields of an existing Tasks record. Only properties present in the request body are modified. ### Delete a Task - [DELETE /tasks/{id}](https://developer.auvo.com.br/en/openapi/api-reference/tasks/delete-a-task.md): Removes the relationship or Tasks record from your account. This operation cannot be undone. ### Add a new Task - [POST /tasks](https://developer.auvo.com.br/en/openapi/api-reference/tasks/add-a-new-task.md): Creates a Tasks record in your account using the data provided in the request body. ### Upsert - Add a new Task or update an existing one - [PUT /tasks](https://developer.auvo.com.br/en/openapi/api-reference/tasks/upsert-add-a-new-task-or-update-an-existing-one.md): Updates or replaces Tasks data using the payload provided in the request body. ### Retrieve a list of Tasks - [GET /tasks](https://developer.auvo.com.br/en/openapi/api-reference/tasks/retrieve-a-list-of-tasks.md): Returns a paginated list of Tasks registered in your account. Use query parameters to filter, sort and paginate results. ### Upsert Task Attachments - [PUT /tasks/{id}/attachments](https://developer.auvo.com.br/en/openapi/api-reference/tasks/upsert-task-attachments.md): Updates or replaces Tasks data using the payload provided in the request body. ### Upsert Task Products - [PUT /tasks/{id}/products](https://developer.auvo.com.br/en/openapi/api-reference/tasks/upsert-task-products.md): Updates or replaces Tasks data using the payload provided in the request body. ### Delete Task Products - [DELETE /tasks/{id}/products](https://developer.auvo.com.br/en/openapi/api-reference/tasks/delete-task-products.md): Removes the relationship or Tasks record from your account. This operation cannot be undone. ### Upsert Task Services - [PUT /tasks/{id}/services](https://developer.auvo.com.br/en/openapi/api-reference/tasks/upsert-task-services.md): Updates or replaces Tasks data using the payload provided in the request body. ### Delete Task Services - [DELETE /tasks/{id}/services](https://developer.auvo.com.br/en/openapi/api-reference/tasks/delete-task-services.md): Removes the relationship or Tasks record from your account. This operation cannot be undone. ### Upsert Task Additional Costs - [PUT /tasks/{id}/additional-costs](https://developer.auvo.com.br/en/openapi/api-reference/tasks/upsert-task-additional-costs.md): Updates or replaces Tasks data using the payload provided in the request body. ### Delete Task Additional Costs - [DELETE /tasks/{id}/additional-costs](https://developer.auvo.com.br/en/openapi/api-reference/tasks/delete-task-additional-costs.md): Removes the relationship or Tasks record from your account. This operation cannot be undone. ### Upsert Task Questionnaire Response - [PUT /tasks/{id}/questionnaire-response](https://developer.auvo.com.br/en/openapi/api-reference/tasks/upsert-task-questionnaire-responses.md): Creates or updates a questionnaire answer for a task. The request is processed asynchronously. A 202 Accepted response means the answer was validated, queued and should be available in the task within up to 5 minutes. It does not guarantee that the final task record has already been updated when the response is returned. Send one answer per request. The answer is upserted for the questionnaire instance identified by itemID, codigoChecklist and codigoPergunta; when the same checklist is attached to the task more than once, use a distinct itemID for each instance. Use codigoEquipamento when the questionnaire answer belongs to a specific task equipment. ### Retrieve a list of Deleted Tasks - [GET /tasks/GetDeletedTasks](https://developer.auvo.com.br/en/openapi/api-reference/tasks/retrieve-a-list-of-deleted-tasks.md): Returns a paginated list of Tasks registered in your account. Use query parameters to filter, sort and paginate results. ## Tickets Support tickets and request types. ### Retrieve a Ticket - [GET /tickets/{id}](https://developer.auvo.com.br/en/openapi/api-reference/tickets/retrieve-a-ticket.md): Returns the details of a Tickets record identified by its unique identifier. ### Edit a Ticket - [PATCH /tickets/{id}](https://developer.auvo.com.br/en/openapi/api-reference/tickets/edit-a-ticket.md): Updates the editable fields of an existing Tickets record. Only properties present in the request body are modified. ### Add a new Ticket - [POST /tickets](https://developer.auvo.com.br/en/openapi/api-reference/tickets/add-a-new-ticket.md): Creates a Tickets record in your account using the data provided in the request body. ### Retrieve a list of Tickets - [GET /tickets](https://developer.auvo.com.br/en/openapi/api-reference/tickets/retrieve-a-list-of-tickets.md): Returns a paginated list of Tickets registered in your account. Use query parameters to filter, sort and paginate results. ### Retrieve Ticket Request Types - [GET /tickets/request-type](https://developer.auvo.com.br/en/openapi/api-reference/tickets/retrieve-ticket-request-types.md): Returns the details of a Tickets record identified by its unique identifier. ## Ticket Status Ticket status configuration. ### Retrieve active Ticket Statuses - [GET /tickets/status](https://developer.auvo.com.br/en/openapi/api-reference/ticket-status/retrieve-active-ticket-statuses.md): Returns a paginated list of Ticket Status registered in your account. Use query parameters to filter, sort and paginate results. ## Questionnaires Questionnaires and answers collected in the field. ### Retrieve a Questionnaire - [GET /questionnaires/{id}](https://developer.auvo.com.br/en/openapi/api-reference/questionnaires/retrieve-a-questionnaire.md): Returns the details of a Questionnaires record identified by its unique identifier. ### Retrieve a list of Questionnaires - [GET /questionnaires](https://developer.auvo.com.br/en/openapi/api-reference/questionnaires/retrieve-a-list-of-questionnaires.md): Returns a paginated list of Questionnaires registered in your account. Use query parameters to filter, sort and paginate results. ## GPS GPS positions captured by field users. ### Retrieve a list of GPS positions - [GET /gps](https://developer.auvo.com.br/en/openapi/api-reference/gps/retrieve-a-list-of-gps-positions.md): Returns a paginated list of GPS registered in your account. Use query parameters to filter, sort and paginate results. ## Service Orders Service orders and operational work orders. ### Retrieve a Service Order - [GET /serviceorders/{code}](https://developer.auvo.com.br/en/openapi/api-reference/service-orders/retrieve-a-service-order.md): Returns the details of a Service Orders record identified by its unique identifier. ### Edit a Service Order - [PATCH /serviceorders/{code}](https://developer.auvo.com.br/en/openapi/api-reference/service-orders/edit-a-service-order.md): Updates the editable fields of an existing Service Orders record. Only properties present in the request body are modified. ### Add a new Service Order - [POST /serviceorders](https://developer.auvo.com.br/en/openapi/api-reference/service-orders/add-a-new-service-order.md): Creates a Service Orders record in your account using the data provided in the request body. ### Retrieve a list of Service Orders - [GET /serviceorders](https://developer.auvo.com.br/en/openapi/api-reference/service-orders/retrieve-a-list-of-service-orders.md): Returns a paginated list of Service Orders registered in your account. Use query parameters to filter, sort and paginate results. ## Expenses Expenses reported by users. ### Retrieve an Expense - [GET /expenses/{id}](https://developer.auvo.com.br/en/openapi/api-reference/expenses/retrieve-an-expense.md): Returns the details of a Expenses record identified by its unique identifier. ### Edit an Expense - [PATCH /expenses/{id}](https://developer.auvo.com.br/en/openapi/api-reference/expenses/edit-an-expense.md): Updates the editable fields of an existing Expenses record. Only properties present in the request body are modified. ### Delete an Expense - [DELETE /expenses/{id}](https://developer.auvo.com.br/en/openapi/api-reference/expenses/delete-an-expense.md): Removes the relationship or Expenses record from your account. This operation cannot be undone. ### Add a new Expense - [POST /expenses](https://developer.auvo.com.br/en/openapi/api-reference/expenses/add-a-new-expense.md): Creates a Expenses record in your account using the data provided in the request body. ### Retrieve a list of Expenses - [GET /expenses](https://developer.auvo.com.br/en/openapi/api-reference/expenses/retrieve-a-list-of-expenses.md): Returns a paginated list of Expenses registered in your account. Use query parameters to filter, sort and paginate results. ### Update Expense Attachments - [PUT /expenses/{id}/attachments](https://developer.auvo.com.br/en/openapi/api-reference/expenses/update-expense-attachments.md): Updates or replaces Expenses data using the payload provided in the request body. ## Expense Types Expense type configuration. ### Retrieve an Expense Type - [GET /expensetypes/{id}](https://developer.auvo.com.br/en/openapi/api-reference/expense-types/retrieve-an-expense-type.md): Returns the details of a Expense Types record identified by its unique identifier. ### Edit an Expense Type - [PATCH /expensetypes/{id}](https://developer.auvo.com.br/en/openapi/api-reference/expense-types/edit-an-expense-type.md): Updates the editable fields of an existing Expense Types record. Only properties present in the request body are modified. ### Delete an Expense Type - [DELETE /expensetypes/{id}](https://developer.auvo.com.br/en/openapi/api-reference/expense-types/delete-an-expense-type.md): Removes the relationship or Expense Types record from your account. This operation cannot be undone. ### Add a new Expense Type - [POST /expensetypes](https://developer.auvo.com.br/en/openapi/api-reference/expense-types/add-a-new-expense-type.md): Creates a Expense Types record in your account using the data provided in the request body. ### Retrieve a list of Expense Types - [GET /expensetypes](https://developer.auvo.com.br/en/openapi/api-reference/expense-types/retrieve-a-list-of-expense-types.md): Returns a paginated list of Expense Types registered in your account. Use query parameters to filter, sort and paginate results. ## Additional Costs Additional costs linked to tasks, quotations and financial flows. ### Retrieve a list of Additional Costs - [GET /additionalcosts](https://developer.auvo.com.br/en/openapi/api-reference/additional-costs/retrieve-a-list-of-additional-costs.md): Returns a paginated list of Additional Costs registered in your account. Use query parameters to filter, sort and paginate results. ### Add a new Additional Cost - [POST /additionalcosts](https://developer.auvo.com.br/en/openapi/api-reference/additional-costs/add-a-new-additional-cost.md): Creates a Additional Costs record in your account using the data provided in the request body. ### Update an Additional Cost - [PUT /additionalcosts/{id}](https://developer.auvo.com.br/en/openapi/api-reference/additional-costs/update-an-additional-cost.md): Updates or replaces Additional Costs data using the payload provided in the request body. ## Invoices Invoices and billing records. ### Retrieve an Invoice - [GET /invoices/{id}](https://developer.auvo.com.br/en/openapi/api-reference/invoices/retrieve-an-invoice.md): Returns the details of a Invoices record identified by its unique identifier. ### Update an Invoice - [PUT /invoices/{id}](https://developer.auvo.com.br/en/openapi/api-reference/invoices/update-an-invoice.md): Updates or replaces Invoices data using the payload provided in the request body. ### Add a new Invoice - [POST /invoices](https://developer.auvo.com.br/en/openapi/api-reference/invoices/add-a-new-invoice.md): Creates a Invoices record in your account using the data provided in the request body. ### Retrieve a list of Invoices - [GET /invoices](https://developer.auvo.com.br/en/openapi/api-reference/invoices/retrieve-a-list-of-invoices.md): Returns a paginated list of Invoices registered in your account. Use query parameters to filter, sort and paginate results. ## Quotations Commercial quotations and their items. ### Retrieve a Quotation - [GET /quotations/{id}](https://developer.auvo.com.br/en/openapi/api-reference/quotations/retrieve-a-quotation.md): Returns the details of a Quotations record identified by its unique identifier. ### Edit a Quotation - [PATCH /quotations/{id}](https://developer.auvo.com.br/en/openapi/api-reference/quotations/edit-a-quotation.md): Updates the editable fields of an existing Quotations record. Only properties present in the request body are modified. ### Add a new Quotation - [POST /quotations](https://developer.auvo.com.br/en/openapi/api-reference/quotations/add-a-new-quotation.md): Creates a Quotations record in your account using the data provided in the request body. ### Retrieve a list of Quotations - [GET /quotations](https://developer.auvo.com.br/en/openapi/api-reference/quotations/retrieve-a-list-of-quotations.md): Returns a paginated list of Quotations registered in your account. Use query parameters to filter, sort and paginate results. ### Add Service to Quotation - [POST /quotations/{id}/services/{idService}](https://developer.auvo.com.br/en/openapi/api-reference/quotations/add-service-to-quotation.md): Creates a Quotations record in your account using the data provided in the request body. ### Update Service in Quotation - [PUT /quotations/{id}/services/{idService}](https://developer.auvo.com.br/en/openapi/api-reference/quotations/update-service-in-quotation.md): Updates or replaces Quotations data using the payload provided in the request body. ### Delete Service from Quotation - [DELETE /quotations/{id}/services/{idService}](https://developer.auvo.com.br/en/openapi/api-reference/quotations/delete-service-from-quotation.md): Removes the relationship or Quotations record from your account. This operation cannot be undone. ### Add Product to Quotation - [POST /quotations/{id}/products](https://developer.auvo.com.br/en/openapi/api-reference/quotations/add-product-to-quotation.md): Creates a Quotations record in your account using the data provided in the request body. ### Update Product in Quotation - [PUT /quotations/{id}/products/{idProduct}](https://developer.auvo.com.br/en/openapi/api-reference/quotations/update-product-in-quotation.md): Updates or replaces Quotations data using the payload provided in the request body. ### Delete Product from Quotation - [DELETE /quotations/{id}/products/{idProduct}](https://developer.auvo.com.br/en/openapi/api-reference/quotations/delete-product-from-quotation.md): Removes the relationship or Quotations record from your account. This operation cannot be undone. ### Upsert Additional Cost in Quotation - [PUT /quotations/{id}/adicost](https://developer.auvo.com.br/en/openapi/api-reference/quotations/upsert-additional-cost-in-quotation.md): Updates or replaces Quotations data using the payload provided in the request body. ### Delete Additional Cost from Quotation - [DELETE /quotations/{id}/adicost](https://developer.auvo.com.br/en/openapi/api-reference/quotations/delete-additional-cost-from-quotation.md): Removes the relationship or Quotations record from your account. This operation cannot be undone. ## Receivables Accounts receivable records. ### Retrieve a Receivable - [GET /receivables/{id}](https://developer.auvo.com.br/en/openapi/api-reference/receivables/retrieve-a-receivable.md): Returns the details of a Receivables record identified by its unique identifier. ### Update a Receivable - [PUT /receivables/{id}](https://developer.auvo.com.br/en/openapi/api-reference/receivables/update-a-receivable.md): Updates or replaces Receivables data using the payload provided in the request body. ### Add a new Receivable - [POST /receivables](https://developer.auvo.com.br/en/openapi/api-reference/receivables/add-a-new-receivable.md): Creates a Receivables record in your account using the data provided in the request body. ### Retrieve a list of Receivables - [GET /receivables](https://developer.auvo.com.br/en/openapi/api-reference/receivables/retrieve-a-list-of-receivables.md): Returns a paginated list of Receivables registered in your account. Use query parameters to filter, sort and paginate results. ## Financial Categories Financial categories used in billing records. ### Retrieve a list of Financial Categories - [GET /financialcategories](https://developer.auvo.com.br/en/openapi/api-reference/financial-categories/retrieve-a-list-of-financial-categories.md): Returns a paginated list of Financial Categories registered in your account. Use query parameters to filter, sort and paginate results. ## Payment Methods Payment methods configured in the account. ### Retrieve a list of Payment Methods - [GET /paymentmethods](https://developer.auvo.com.br/en/openapi/api-reference/payment-methods/retrieve-a-list-of-payment-methods.md): Returns a paginated list of Payment Methods registered in your account. Use query parameters to filter, sort and paginate results. ## Satisfaction Surveys Satisfaction survey responses. ### Retrieve a list of Satisfaction Survey responses - [GET /satisfactionsurveys](https://developer.auvo.com.br/en/openapi/api-reference/satisfaction-surveys/retrieve-a-list-of-satisfaction-survey-responses.md): Returns a paginated list of Satisfaction Surveys registered in your account. Use query parameters to filter, sort and paginate results. ## WebHooks Registration and management of Webhook subscriptions. ### Retrieve a WebHook - [GET /webhooks/{id}](https://developer.auvo.com.br/en/openapi/api-reference/webhooks/retrieve-a-web-hook.md): Returns the details of a WebHooks record identified by its unique identifier. ### Delete a WebHook - [DELETE /webhooks/{id}](https://developer.auvo.com.br/en/openapi/api-reference/webhooks/delete-a-web-hook.md): Removes the relationship or WebHooks record from your account. This operation cannot be undone. ### Add a new WebHook - [POST /webhooks](https://developer.auvo.com.br/en/openapi/api-reference/webhooks/add-a-new-web-hook.md): Creates a WebHooks record in your account using the data provided in the request body. ### Retrieve a list of WebHooks - [GET /webhooks](https://developer.auvo.com.br/en/openapi/api-reference/webhooks/retrieve-a-list-of-web-hooks.md): Returns a paginated list of WebHooks registered in your account. Use query parameters to filter, sort and paginate results.