### Example Order Data Structure

Source: https://developers.vhsys.com.br/api/atualizar-nf-e-16360712e0

This example demonstrates the typical structure of order data, including product details, customer information, shipping, and fiscal parameters. It serves as a reference for creating new orders or understanding existing ones.

```json
{
  "serie_nota": 23,
  "id_cliente": 123456,
  "nome_cliente": "Nome do cliente 2",
  "vendedor_pedido": "Nome do vendedo 2",
  "vendedor_pedido_id": 123456,
  "desconto_pedido": "0.00",
  "peso_total_nota": "0.00",
  "peso_total_nota_liq": "0.00",
  "frete_pedido": "0.00",
  "valor_baseICMS": "0.00",
  "valor_ICMS": "0.00",
  "valor_baseST": "0.00",
  "valor_ST": "0.00",
  "valor_IPI": "0.00",
  "valor_despesas": "0.00",
  "transportadora_pedido": "Nome da transportadora",
  "id_transportadora": 123456,
  "frete_por_pedido": 1,
  "volumes_transporta": 1,
  "especie_transporta": "Caixa",
  "marca_transporta": "Marca do volume",
  "numeracao_transporta": "123456",
  "placa_transporta": "AAA-0000",
  "uf_embarque": "PR",
  "local_embarque": "Local do embarque",
  "data_pedido": "2025-05-25",
  "data_pedido_hora": "00:00:00",
  "natureza_pedido": "Natureza da operação",
  "finalidade_nfe": 1,
  "obs_pedido": "Observação",
  "obs_interno_pedido": "Observação interna",
  "status_pedido": "Em Aberto",
  "ambiente": 2
}
```

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

### GET /ordens-servico/{id_os}/parcelas

Source: https://developers.vhsys.com.br/api/listar-parcelas-16438324e0

Retrieve the installments for a specific service order. This endpoint allows you to query the details of each installment associated with a given service order ID.

```APIDOC
## GET /ordens-servico/{id_os}/parcelas

### Description
Retrieve the installments for a specific service order. This endpoint allows you to query the details of each installment associated with a given service order ID.

### Method
GET

### Endpoint
/ordens-servico/{id_os}/parcelas

### Parameters
#### Path Parameters
- **id_os** (string) - Required - ID da ordem de serviço

#### Query Parameters
- **access-token** (string) - Required - Example: {{ACCESS_TOKEN}}
- **secret-access-token** (string) - Required - Example: {{SECRET_ACCESS_TOKEN}}
- **Cache-Control** (string) - Optional - Example: no-cache
- **Content-Type** (string) - Optional - Example: application/json
- **User-Agent** (string) - Required - Identifica o nome e a versão da aplicação que está consumindo a API. Esse cabeçalho ajuda no monitoramento, diagnóstico e controle de acesso das requisições. Example: MinhaAplicacao/1.0

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **code** (integer) - Código do retorno
- **status** (string) - Status do retorno
- **data** (array) - Dados de Resposta
  - **id_ordem** (integer) - ID da ordem de serviço
  - **data_parcela** (string) - Data da parcela
  - **valor_parcela** (string) - Valor da parcela
  - **forma_pagamento** (string) - Forma de pagamento
  - **observacoes_parcela** (string) - Observação da parcela

#### Response Example
```json
{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id_ordem": 123456,
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Boleto",
      "observacoes_parcela": "Observação"
    },
    {
      "id_ordem": 123456,
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Boleto",
      "observacoes_parcela": "Observação"
    }
  ]
}
```

#### Error Response (403)
- **code** (string) - Código do retorno
- **status** (string) - Status do retorno
- **data** (string) - Dados do erro

#### Error Response Example
```json
{
  "code": "403",
  "status": "error",
  "data": "Nenhuma parcela para a ordem de serviço encontrada!"
}
```
```

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

### POST /websites/developers_vhsys_br_api/products

Source: https://developers.vhsys.com.br/api/alterar-produto-17199880e0

Creates a new product with the provided details.

```APIDOC
## POST /websites/developers_vhsys_br_api/products

### Description
Creates a new product with the provided details.

### Method
POST

### Endpoint
/websites/developers_vhsys_br_api/products

### Parameters
#### Request Body
- **id_produto** (integer) - Required - The unique identifier of the product.
- **cod_produto** (string) - Required - The product code.
- **desc_produto** (string) - Required - The product description.
- **qtde_produto** (string) - Optional - The product quantity.
- **icms_produto** (string) - Optional - The ICMS value for the product.
- **valor_unit_produto** (string) - Optional - The unit price of the product.
- **valor_custo_produto** (string) - Optional - The cost price of the product.
- **vICMS_produto** (string) - Optional - The ICMS value for the product.
- **cfop_produto** (string) - Optional - The CFOP code for the product.
- **ncm_produto** (string) - Optional - The NCM code for the product.
- **unidade_produto** (string) - Optional - The unit of measure for the product.
- **unidade_tributavel** (string) - Optional - The taxable unit of measure for the product.
- **peso_produto** (string) - Optional - The weight of the product.
- **codigo_barras** (string) - Optional - The barcode of the product.
- **valor_tributos_unit** (string) - Optional - The unit value of taxes.
- **info_adicional** (string) - Optional - Additional information about the product.
- **valor_tributos_total** (string) - Optional - The total value of taxes.
- **valor_tributosEst_unit** (string) - Optional - The unit value of state taxes.
- **valor_tributosEst_total** (string) - Optional - The total value of state taxes.

### Request Example
```json
{
  "id_produto": 123456,
  "cod_produto": "PROD002",
  "desc_produto": "Novo Produto Exemplo",
  "qtde_produto": "5.00",
  "icms_produto": "18.00",
  "valor_unit_produto": "150.00",
  "valor_custo_produto": "120.00",
  "vICMS_produto": "18.00",
  "cfop_produto": "5101",
  "ncm_produto": "98765432",
  "unidade_produto": "UN",
  "unidade_tributavel": "UN",
  "peso_produto": "0.75",
  "codigo_barras": "4321098765432",
  "valor_tributos_unit": "0.00",
  "info_adicional": "Este é um novo produto.",
  "valor_tributos_total": "0.00",
  "valor_tributosEst_unit": "0.00",
  "valor_tributosEst_total": "0.00"
}
```

### Response
#### Success Response (200)
- **code** (integer) - Código da resposta
- **status** (string) - Status da resposta
- **data** (object) - Contains details of the created product (similar to GET response structure).

#### Response Example
```json
{
  "code": 200,
  "status": "success",
  "data": {
    "id_ped_produto": 98765,
    "id_nfc": null,
    "id_produto": 123456,
    "id_almoxarifado": null,
    "id_lote": null,
    "cod_produto": "PROD002",
    "desc_produto": "Novo Produto Exemplo",
    "qtde_produto": "5.00",
    "icms_produto": "18.00",
    "valor_unit_produto": "150.00",
    "valor_custo_produto": "120.00",
    "vICMS_produto": "18.00",
    "cfop_produto": "5101",
    "ncm_produto": "98765432",
    "unidade_produto": "UN",
    "unidade_tributavel": "UN",
    "peso_produto": "0.75",
    "codigo_barras": "4321098765432",
    "valor_tributos_unit": "0.00",
    "info_adicional": "Este é um novo produto.",
    "valor_tributos_total": "0.00",
    "valor_tributosEst_unit": "0.00",
    "valor_tributosEst_total": "0.00"
  }
}
```
```

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

### GET /orcamentos/{id_orcamento}/parcelas

Source: https://developers.vhsys.com.br/api/listar-parcelas-16287968e0

Retrieves a list of installments for a given budget ID. This endpoint allows you to query the payment installments associated with a specific budget.

```APIDOC
## GET /orcamentos/{id_orcamento}/parcelas

### Description
Request for the query of installments of a budget. This endpoint allows you to retrieve the payment installments associated with a specific budget.

### Method
GET

### Endpoint
/orcamentos/{id_orcamento}/parcelas

### Parameters
#### Path Parameters
- **id_orcamento** (string) - Required - ID of the budget

#### Header Parameters
- **access-token** (string) - Required - 
- **secret-access-token** (string) - Required - 
- **Cache-Control** (string) - Optional - no-cache
- **Content-Type** (string) - Optional - application/json
- **User-Agent** (string) - Required - Identifies the name and version of the application consuming the API. This header helps in monitoring, diagnosing, and controlling access to requests. Example: MinhaAplicacao/1.0

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **code** (integer) - Code of the return
- **status** (string) - Status of the return
- **data** (array) - Response Data
  - **id_orcamento** (integer) - ID of the budget
  - **data_parcela** (string) - Installment date
  - **valor_parcela** (string) - Installment value
  - **forma_pagamento** (string) - Payment method
  - **observacoes_parcela** (string) - Installment observation

#### Response Example
```json
{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id_orcamento": 123456,
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Boleto",
      "observacoes_parcela": "Observação"
    },
    {
      "id_orcamento": 123456,
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Boleto",
      "observacoes_parcela": "Observação"
    }
  ]
}
```

#### Error Response (403)
- **code** (string) - Return code
- **status** (string) - Return status
- **data** (string) - Error data

#### Error Response Example
```json
{
  "code": "403",
  "status": "error",
  "data": "Nenhuma parcela para o orçamento encontrado!"
}
```
```

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

### GET /websites/developers_vhsys_br_api/products

Source: https://developers.vhsys.com.br/api/cadastrar-produto-16283307e0

Retrieves a list of products with detailed information, including pricing, taxes, and weight.

```APIDOC
## GET /websites/developers_vhsys_br_api/products

### Description
Retrieves a list of products with detailed information, including pricing, taxes, and weight. This endpoint allows filtering and sorting of product data.

### Method
GET

### Endpoint
/websites/developers_vhsys_br_api/products

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Maximum number of products to return.
- **offset** (integer) - Optional - Number of products to skip before starting to collect the result set.

### Request Example
```json
{
  "limit": 10,
  "offset": 0
}
```

### Response
#### Success Response (200)
- **code** (integer) - Código do retorno
- **status** (string) - Status do retorno
- **data** (array) - Dados de Resposta
  - **id_produto** (integer) - ID do produto
  - **desc_produto** (string) - Nome do produto
  - **qtde_produto** (string) - Quantidade do produto
  - **valor_unit_produto** (integer) - Valor unitário do produto
  - **ipi_produto** (number) - Valor do IPI
  - **icms_produto** (number) - Valor do ICMS
  - **peso_liq_produto** (number) - Peso líquido do produto
  - **valor_total_produto** (integer) - Valor total do produto
  - **id_ordem** (integer) - ID da ordem de compra
  - **id_ped_produto** (integer) - ID do vínculo produto/ordem de compra
  - **desconto_produto** (number) - Valor do desconto
  - **peso_produto** (number) - Peso do produto

#### Response Example
```json
{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id_produto": 123456,
      "desc_produto": "Descrição produto 1",
      "qtde_produto": "3",
      "valor_unit_produto": 15,
      "ipi_produto": 2.22,
      "icms_produto": 3.33,
      "peso_liq_produto": 5.55,
      "valor_total_produto": 100,
      "id_ordem": 1,
      "id_ped_produto": 10,
      "desconto_produto": 1.11,
      "peso_produto": 4.44
    }
  ]
}
```
```

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

### GET /ordens-compra/{id_ordem}/parcelas

Source: https://developers.vhsys.com.br/api/consultar-parcelas-17023824e0

Retrieves the installment details registered for a purchase order.

```APIDOC
## GET /ordens-compra/{id_ordem}/parcelas

### Description
Request to consult the installments registered in the purchase order.

### Method
GET

### Endpoint
/ordens-compra/{id_ordem}/parcelas

### Parameters
#### Path Parameters
- **id_ordem** (string) - Required - ID of the purchase order

#### Header Parameters
- **access-token** (string) - Required - Access token for authentication
- **secret-access-token** (string) - Required - Secret access token for authentication
- **Cache-Control** (string) - Optional - Cache control directive (e.g., no-cache)
- **Content-Type** (string) - Optional - Content type of the request (e.g., application/json)
- **User-Agent** (string) - Required - Identifies the name and version of the application consuming the API.

### Request Example
```json
{
  "headers": {
    "access-token": "{{ACCESS_TOKEN}}",
    "secret-access-token": "{{SECRET_ACCESS_TOKEN}}",
    "User-Agent": "MinhaAplicacao/1.0"
  }
}
```

### Response
#### Success Response (200)
- **code** (integer) - Return code
- **status** (string) - Return status
- **data** (array) - Response data
  - **data_parcela** (string) - Installment date
  - **valor_parcela** (string) - Installment value
  - **forma_pagamento** (string) - Payment method
  - **observacoes_parcela** (string) - Installment notes
  - **id_ordem** (integer) - Purchase order ID

#### Response Example
```json
{
  "code": 200,
  "status": "success",
  "data": [
    {
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Boleto",
      "observacoes_parcela": "Observação",
      "id_ordem": 123456
    },
    {
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Boleto",
      "observacoes_parcela": "Observação",
      "id_ordem": 123456
    }
  ]
}
```

#### Error Response (403)
- **code** (string) - Return code
- **status** (string) - Return status
- **data** (string) - Error data

#### Error Response Example
```json
{
  "code": 403,
  "status": "error",
  "data": "Erro ao cadastrar a parcela para a ordem de compra!"
}
```
```

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

### Create Product API

Source: https://developers.vhsys.com.br/api/atualizar-produto-16210784e0

This endpoint is used to create a new product entry in the system. It requires a detailed request body containing all necessary product information.

```APIDOC
## POST /websites/developers_vhsys_br_api/produto

### Description
Allows the creation of a new product with all its attributes.

### Method
POST

### Endpoint
/websites/developers_vhsys_br_api/produto

### Parameters
#### Request Body
- **id_categoria** (integer) - Required - The category ID for the product.
- **cod_produto** (integer) - Required - The product code.
- **marca_produto** (string) - Required - The brand of the product.
- **desc_produto** (string) - Required - The description of the product.
- **fornecedor_produto** (string) - Optional - The name of the product supplier.
- **fornecedor_produto_id** (integer) - Optional - The ID of the product supplier.
- **minimo_produto** (string) - Optional - The minimum stock level for the product.
- **maximo_produto** (string) - Optional - The maximum stock level for the product.
- **estoque_produto** (string) - Optional - The current stock level of the product.
- **unidade_produto** (string) - Optional - The unit of measurement for the product.
- **valor_produto** (string) - Optional - The selling price of the product.
- **valor_custo_produto** (string) - Optional - The cost price of the product.
- **peso_produto** (string) - Optional - The gross weight of the product.
- **peso_liq_produto** (string) - Optional - The net weight of the product.
- **icms_produto** (string) - Optional - The ICMS tax rate for the product.
- **ipi_produto** (string) - Optional - The IPI tax rate for the product.
- **pis_produto** (string) - Optional - The PIS tax rate for the product.
- **cofins_produto** (string) - Optional - The COFINS tax rate for the product.
- **cest_produto** (string) - Optional - The CEST code for the product.
- **ncm_produto** (string) - Optional - The NCM code for the product.
- **codigo_barra_produto** (string) - Optional - The barcode of the product.
- **obs_produto** (string) - Optional - Additional observations about the product.
- **tipo_produto** (string) - Optional - The type of the product.
- **kit_produto** (string) - Optional - Indicates if the product is a kit.
- **status_produto** (string) - Optional - The status of the product (e.g., 'Ativo').
- **produto_variado** (integer) - Required - Indicates if the product has variations.
- **grades** (object) - Required - Product grading information.
- **variacoes** (object) - Required - Product variations.

### Request Example
```json
{
  "id_categoria": 123456,
  "cod_produto": 123456,
  "marca_produto": "Marca do produto",
  "desc_produto": "Descrição produto",
  "fornecedor_produto": "Nome do fornecedor",
  "fornecedor_produto_id": 123456,
  "minimo_produto": "15.00",
  "maximo_produto": "30.00",
  "estoque_produto": "10.00",
  "unidade_produto": "UN",
  "valor_produto": "15.00",
  "valor_custo_produto": "5.00",
  "peso_produto": "1.00",
  "peso_liq_produto": "0.50",
  "icms_produto": "1.00",
  "ipi_produto": "1.00",
  "pis_produto": "1.00",
  "cofins_produto": "1.00",
  "cest_produto": "123456",
  "ncm_produto": "123456",
  "codigo_barra_produto": "123456789",
  "obs_produto": "Observação do produto",
  "tipo_produto": "Produto",
  "kit_produto": "Nao",
  "status_produto": "Ativo",
  "produto_variado": 1,
  "grades": {},
  "variacoes": {}
}
```

### Response
#### Success Response (200)
- **code** (integer) - The return code.
- **status** (string) - The status of the return.
- **data** (object) - Contains product details.
  - **id_produto** (integer) - The unique identifier for the product.
  - **id_registro** (integer) - The registration ID.
  - **id_empresa** (integer) - The company ID.
  - **id_categoria** (integer) - The category ID.
  - **cod_produto** (integer) - The product code.
  - **marca_produto** (string) - The brand of the product.
  - **desc_produto** (string) - The description of the product.
  - **atalho_produto** (string) - A shortcut for the product.
  - **fornecedor_produto** (string) - The name of the supplier.
  - **fornecedor_produto_id** (integer) - The ID of the supplier.
  - **produto_variado** (integer) - Indicates if the product has variations.
  - **id_produto_parent** (integer) - The parent product ID if this is a variation.
  - **minimo_produto** (string) - Minimum stock level.
  - **maximo_produto** (string) - Maximum stock level.
  - **estoque_produto** (string) - Current stock level.
  - **unidade_produto** (string) - Unit of measurement.
  - **valor_produto** (string) - Selling price.
  - **valor_custo_produto** (string) - Cost price.
  - **peso_produto** (string) - Gross weight.
  - **peso_liq_produto** (string) - Net weight.

#### Response Example
```json
{
  "code": 200,
  "status": "success",
  "data": {
    "id_produto": 1234567,
    "id_registro": 1,
    "id_empresa": 1,
    "id_categoria": 123456,
    "cod_produto": 123456,
    "marca_produto": "Marca do produto",
    "desc_produto": "Descrição produto",
    "atalho_produto": null,
    "fornecedor_produto": "Nome do fornecedor",
    "fornecedor_produto_id": 123456,
    "produto_variado": 1,
    "id_produto_parent": null,
    "minimo_produto": "15.00",
    "maximo_produto": "30.00",
    "estoque_produto": "10.00",
    "unidade_produto": "UN",
    "valor_produto": "15.00",
    "valor_custo_produto": "5.00",
    "peso_produto": "1.00",
    "peso_liq_produto": "0.50"
  }
}
```
```

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

### GET /notas-consumidor/{id_nfce}/parcelas

Source: https://developers.vhsys.com.br/api/consultar-parcelas-17199936e0

Retrieve the installments associated with a specific consumer note (NFC-e).

```APIDOC
## GET /notas-consumidor/{id_nfce}/parcelas

### Description
Request for the consultation of NFC-e installments.

### Method
GET

### Endpoint
/notas-consumidor/{id_nfce}/parcelas

### Parameters
#### Path Parameters
- **id_nfce** (string) - Required - ID NFC-e

#### Header Parameters
- **access-token** (string) - Required - Access token for authentication.
- **secret-access-token** (string) - Required - Secret access token for authentication.
- **Cache-Control** (string) - Optional - Cache control directive.
- **Content-Type** (string) - Optional - Content type of the request.
- **User-Agent** (string) - Required - Identifies the name and version of the application consuming the API. This header aids in monitoring, diagnostics, and request access control.

### Response
#### Success Response (200)
- **code** (integer) - Code of the request return.
- **status** (string) - Status of the request.
- **data** (array) - Data of the installment listing.
  - **id_nfc** (integer) - ID of the invoice.
  - **data_parcela** (string) - Installment date.
  - **valor_parcela** (string) - Installment value.
  - **forma_pagamento** (string) - Payment method.
  - **observacoes_parcela** (string) - Installment observations.

#### Response Example (200)
```json
{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id_nfc": 123456,
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Boleto",
      "observacoes_parcela": "Observação"
    },
    {
      "id_nfc": 123456,
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Boleto",
      "observacoes_parcela": "Observação"
    }
  ]
}
```

#### Error Response (403)
- **code** (integer) - Code of the request return.
- **status** (string) - Status of the request.
- **data** (string) - Reason for request rejection.

#### Response Example (403)
```json
{
  "code": 403,
  "status": "error",
  "data": "Reason for rejection"
}
```
```

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

### GET /websites/developers_vhsys_br_api

Source: https://developers.vhsys.com.br/api/cadastrar-parcelas-17230116e0

Retrieves project information and associated data, including payment methods and installment details.

```APIDOC
## GET /websites/developers_vhsys_br_api

### Description
Retrieves project information and associated data, including payment methods and installment details.

### Method
GET

### Endpoint
/websites/developers_vhsys_br_api

### Parameters
#### Query Parameters
* **None**

#### Request Body
* **None**

### Request Example
* **None**

### Response
#### Success Response (200)
- **code** (integer) - Código da resposta
- **status** (string) - Status da resposta
- **data** (array) - Array of installment details
  - **data_parcela** (string) - Data da parcela
  - **valor_parcela** (string) - Valor da parcela
  - **forma_pagamento** (string) - Forma de pagamento (enum: Dinheiro, PIX, Cheque, Permuta, Cartão de Crédito, Cartão de Débito, Boleto, Transferência, Ted, Depósito Identificado, Depósito em C/C, Duplicata Mercantil, Faturado, Faturar, Débito Automático, Lotérica, Banco, DDA, Pagamento online, BNDES, Outros, DP Descontada, CH Descontado, Vale Alimentação, Vale Refeição, Vale Presente, Vale Combustível)
  - **observacoes_parcela** (string) - Observação da parcela

#### Response Example
```json
{
  "code": 200,
  "status": "success",
  "data": [
    {
      "data_parcela": "0000-00-00",
      "valor_parcela": "100.00",
      "forma_pagamento": "Cartão de Crédito",
      "observacoes_parcela": "Observação"
    }
  ]
}
```
```

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

### Example Delete Operation for Counter Sale

Source: https://developers.vhsys.com.br/api/excluir-produto-venda-balc%C3%A3o-15850508e0

Provides an example of a delete operation for a counter sale. It specifies the entity, operation, and the data required for deletion, including order details and product information. This serves as a reference for how to structure delete requests.

```json
{
  "entidade": "vendas_balcao",
  "operacao": "delete",
  "dados": {
    "id_frente": 123456,
    "id_pedido": 0,
    "id_cliente": 123456,
    "valor_total_produtos": 1,
    "valor_total_nota": 1,
    "valor_desconto_pedido": 0,
    "valor_acrescimo_pedido": 0,
    "valor_recebido": 0,
    "troco_pedido": 0,
    "status_pedido": "Atendido",
    "razao_vendedor": "Nome Cliente",
    "data_cad_pedido": "0000-00-00 00:00:00",
    "data_mod_pedido": "0000-00-00 00:00:00",
    "forma_pagamento": "Dinheiro",
    "obs_pedido": "Observação",
    "produtos": [
      {
        "id_ped_produto": 123456,
        "desc_produto": "Descrição do produto 1",
        "qtde_produto": 1,
        "valor_unit_produto": 1,
        "valor_total_produto": 1
      }
    ],
    "parcelas": [
      {
        "data_parcela": "0000-00-00",
        "valor_parcela": 1,
        "forma_pagamento": "Cartão de Crédito",
        "nome_banco": null
      },
      {
        "data_parcela": "0000-00-00",
        "valor_parcela": 1,
        "forma_pagamento": "Cartão de Crédito",
        "nome_banco": null
      }
    ]
  }
}
```

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

### Example Order Creation Payload

Source: https://developers.vhsys.com.br/api/cadastrar-venda-balc%C3%A3o-15850447e0

This example demonstrates the expected JSON payload for creating a new counter sale order. It includes fields for order details, customer information, and financial aspects like product values and discounts. The 'dados' object contains the core order information.

```json
{
  "entidade": "vendas_balcao",
  "operacao": "create",
  "dados": {
    "id_frente": 123456,
    "id_pedido": 0,
    "id_cliente": 123456,
    "valor_total_produtos": 0,
    "valor_total_nota": 0,
    "valor_desconto_pedido": 0,
    "valor_acrescimo_pedido": 0,
    "valor_recebido": 0,
    "troco_pedido": 0,
    "status_pedido": "Em Aberto",
    "razao_vendedor": "Nome Vendedor",
    "data_cad_pedido": "0000-00-00 00:00:00",
    "data_mod_pedido": "0000-00-00 00:00:00",
    "forma_pagamento": "Dinheiro",
    "obs_pedido": "Observação",
    "produtos": [],
    "parcelas": [],
    "pedidos": [],
    "ordem_servicos": [],
    "orcamentos": []
  }
}
```

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

### GET /vendas-balcao/{id_frente}/parcelas

Source: https://developers.vhsys.com.br/api/consultar-parcelas-venda-balc%C3%A3o-16487067e0

Retrieves the installment details for a specific counter sale by its ID.

```APIDOC
## GET /vendas-balcao/{id_frente}/parcelas

### Description
This endpoint allows for the consultation of the installments of a counter sale.

### Method
GET

### Endpoint
/vendas-balcao/{id_frente}/parcelas

### Parameters
#### Path Parameters
- **id_frente** (string) - Required - ID of the counter sale.

#### Header Parameters
- **access-token** (string) - Required - Access token for authentication.
- **secret-access-token** (string) - Required - Secret access token for authentication.
- **Cache-Control** (string) - Optional - Cache control directive (e.g., no-cache).
- **Content-Type** (string) - Optional - Content type of the request (e.g., application/json).
- **User-Agent** (string) - Required - Identifies the application name and version consuming the API.

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **status** (string) - Response status.
- **data** (array) - Contains the installment details.
  - **id_parcela** (integer) - Installment ID.
  - **id_frente** (integer) - Counter sale ID.
  - **data_parcela** (string) - Installment date.
  - **valor_parcela** (string) - Installment value.
  - **forma_pagamento** (string) - Payment method.
  - **observacoes_parcela** (string) - Installment notes.
  - **id_banco** (integer) - Bank ID.
  - **id_conta_rec** (integer) - Received account ID.
  - **order_ref** (null) - Order reference.
  - **id_carteira** (integer) - Wallet ID.
  - **id_pagamento_invoice_pdv** (integer) - PDV invoice payment ID.
  - **data_cad** (string) - Creation date.
  - **data_mod** (string) - Modification date.

#### Response Example
```json
{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id_parcela": 1,
      "id_frente": 123,
      "data_parcela": "2023-10-27",
      "valor_parcela": "100.00",
      "forma_pagamento": "Credit Card",
      "observacoes_parcela": "",
      "id_banco": 1,
      "id_conta_rec": 10,
      "order_ref": null,
      "id_carteira": 5,
      "id_pagamento_invoice_pdv": 99,
      "data_cad": "2023-10-26T10:00:00Z",
      "data_mod": "2023-10-26T10:00:00Z"
    }
  ]
}
```
```

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

### List Budget Installments (OpenAPI)

Source: https://developers.vhsys.com.br/api/listar-parcelas-16287968e0

This OpenAPI specification defines the GET request for listing installments of a budget. It includes path parameters for the budget ID, authentication tokens, and optional headers like Cache-Control and Content-Type. The response structure details success and error scenarios, including the format of installment data.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /orcamentos/{id_orcamento}/parcelas:
    get:
      summary: Listar parcelas
      deprecated: false
      description: Request para a consulta das parcelas de um orçamento.
      tags:
        - API V2/Vendas/Orçamentos
      parameters:
        - name: id_orcamento
          in: path
          description: ID do orçamento
          required: true
          schema:
            type: string
        - name: access-token
          in: header
          description: ''
          required: true
          example: '{{ACCESS_TOKEN}}'
          schema:
            type: string
        - name: secret-access-token
          in: header
          description: ''
          required: true
          example: '{{SECRET_ACCESS_TOKEN}}'
          schema:
            type: string
        - name: Cache-Control
          in: header
          description: ''
          required: false
          example: no-cache
          schema:
            type: string
        - name: Content-Type
          in: header
          description: ''
          required: false
          example: application/json
          schema:
            type: string
        - name: User-Agent
          in: header
          description: >-
            Identifica o nome e a versão da aplicação que está consumindo a API.
            Esse cabeçalho ajuda no monitoramento, diagnóstico e controle de
            acesso das requisições.
          required: true
          example: MinhaAplicacao/1.0
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Código do retorno
                  status:
                    type: string
                    description: Status do retorno
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id_orcamento:
                          type: integer
                          description: ID do orçamento
                        data_parcela:
                          type: string
                          description: Data da parcela
                        valor_parcela:
                          type: string
                          description: Valor da parcela
                        forma_pagamento:
                          type: string
                          description: Forma de pagamento
                        observacoes_parcela:
                          type: string
                          description: Observação da parcela
                      required:
                        - id_orcamento
                        - data_parcela
                        - valor_parcela
                        - forma_pagamento
                        - observacoes_parcela
                      x-apidog-orders:
                        - id_orcamento
                        - data_parcela
                        - valor_parcela
                        - forma_pagamento
                        - observacoes_parcela
                    description: Dados de Resposta
                required:
                  - code
                  - status
                  - data
                x-apidog-orders:
                  - code
                  - status
                  - data
              example:
                code: 200
                status: success
                data:
                  - id_orcamento: 123456
                    data_parcela: '0000-00-00'
                    valor_parcela: '100.00'
                    forma_pagamento: Boleto
                    observacoes_parcela: Observação
                  - id_orcamento: 123456
                    data_parcela: '0000-00-00'
                    valor_parcela: '100.00'
                    forma_pagamento: Boleto
                    observacoes_parcela: Observação
          headers: {}
          x-apidog-name: Success
        '403':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Código do retorno
                  status:
                    type: string
                    description: Status do retorno
                  data:
                    type: string
                    description: Dados do erro
                x-apidog-orders:
                  - code
                  - status
                  - data
              example:
                code: 403
                status: error
                data: Nenhuma parcela para o orçamento encontrado!
          headers: {}
```

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

### Exemplo de Resposta de Sucesso para Produto (JSON)

Source: https://developers.vhsys.com.br/api/atualizar-produto-16210784e0

Este exemplo demonstra a estrutura de uma resposta bem-sucedida ao buscar ou criar um produto. Inclui detalhes completos do produto, como identificadores, descrições, preços, estoque e informações fiscais. A resposta contém um código de status '200' e um objeto 'data' com todas as propriedades do produto.

```json
{
  "code": 200,
  "status": "success",
  "data": {
    "id_produto": 123456,
    "id_registro": 123456,
    "id_empresa": 123456,
    "id_categoria": 123456,
    "cod_produto": 123456,
    "marca_produto": "Marca do produto",
    "desc_produto": "Descrição produto",
    "atalho_produto": "nome_do_produto_123456",
    "fornecedor_produto": "Nome do fornecedor",
    "fornecedor_produto_id": 123456,
    "produto_variado": 0,
    "id_produto_parent": 0,
    "minimo_produto": "15.00",
    "maximo_produto": "30.00",
    "estoque_produto": "0.000000",
    "unidade_produto": "UN",
    "valor_produto": "15.00",
    "valor_custo_produto": "5.00",
    "peso_produto": "1.00",
    "peso_liq_produto": "0.50",
    "icms_produto": "1.00",
    "ipi_produto": "1.00",
    "pis_produto": "1.00",
    "cofins_produto": "1.00",
    "unidade_tributavel": "UN",
    "cest_produto": "123456",
    "beneficio_fiscal": "123456",
    "ncm_produto": "123456",
    "origem_produto": 0,
    "codigo_barra_produto": "123456789",
    "codigo_barras_internos": "",
    "obs_produto": "Observação do produto",
    "tipo_produto": "Produto",
    "tamanho_produto": "123456",
    "localizacao_produto": "",
    "kit_produto": "Nao",
    "baixar_kit": 1,
    "desmembrar_kit": 0,
    "loja_visivel": 0,
    "loja_video_url": "",
    "valor_tributos": "2.00",
    "valor_tributosEst": "2.00",
    "status_produto": "Ativo",
    "id_comissionamento": 0,
    "id_regra_comissionamento_servico": 0,
    "data_cad_produto": "0000-00-00 00:00:00",
    "data_mod_produto": "0000-00-00 00:00:00",
    "data_mod_estoque": null,
    "lixeira": "Nao",
    "controla_lote": 0,
    "controla_validade": 0,
    "endereco_fixo": 0,
    "lista_preco": null,
    "subcategoria": [],
    "grades": [],
    "variacoes": [],
    "imagens": []
  }
}
```