Tiny ERP Public API v3 Swagger

https://erp.tiny.com.br/public-api/v3/swagger
Admin
This project provides Swagger documentation for the Tiny ERP Public API v3, enabling developers to...
Tokens:32,014
Snippets:150
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Product Tags

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves all tags associated with a specific product.

```APIDOC
## GET /produtos/{idProduto}/tags

### Description
Retrieves all tags associated with a specific product.

### Method
GET

### Endpoint
/produtos/{idProduto}/tags

### Parameters
#### Path Parameters
- **idProduto** (integer) - Required - Identifier of the product

### Responses
#### Success Response (200)
- **ObterTagsProdutoModelResponse** (object) - Response object containing product tags

#### Error Responses
- **400**: Bad Request
- **404**: Not Found
- **403**: Forbidden
- **503**: Service Unavailable
- **401**: Unauthorized
- **500**: Internal Server Error
```

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

### Get Purchase Order Markers

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves the markers associated with a specific purchase order.

```APIDOC
## GET /ordem-compra/{idOrdemCompra}/marcadores

### Description
Retrieves the markers associated with a specific purchase order.

### Method
GET

### Endpoint
/ordem-compra/{idOrdemCompra}/marcadores

#### Path Parameters
- **idOrdemCompra** (integer) - Required - Identificador da ordem de compra

#### Response
#### Success Response (200)
- **ObterMarcadorResponseModel** (array) - Description of the marker items

#### Response Example
{
  "example": "[\n  {\n    \"id\": 1,\n    \"nome\": \"Exemplo Marcador\",\n    \"cor\": \"#FFFFFF\"\n  }\n]"
}
```

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

### ObterOrdemCompraModelResponse

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the response structure for retrieving a purchase order. It includes details such as order ID, number, dates, status, financial information, items, contact, category, fiscal notes, and payment installments.

```APIDOC
## ObterOrdemCompraModelResponse

### Description
Represents the response structure for retrieving a purchase order. It includes details such as order ID, number, dates, status, financial information, items, contact, category, fiscal notes, and payment installments.

### Schema
```json
{
  "id": "integer",
  "numeroPedido": "string (nullable)",
  "data": "string (example: 2024-01-01)",
  "situacao": "string (enum: 0, 1, 2, 3) - 0: Em Aberto, 1: Atendido, 2: Cancelado, 3: Em Andamento (nullable)",
  "desconto": "string",
  "frete": "number (float)",
  "totalProdutos": "number (float)",
  "totalPedidoCompra": "number (float)",
  "dataPrevista": "string (example: 2024-01-01)",
  "itens": "array of OrdemCompraItemModelResponse",
  "contato": "ContatoModelResponse",
  "categoria": "CategoriaResponseModel",
  "notaFiscal": "OrdemCompraNotaFiscalModelResponse",
  "parcelas": "array of OrdemCompraParcelaModelResponse"
}
```
```

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

### Create Product Tags

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Creates one or more product tags. Expects an array of tag objects in the request body.

```APIDOC
## POST /tags

### Description
Creates one or more product tags. Expects an array of tag objects in the request body.

### Method
POST

### Endpoint
/tags

### Request Body
- **items** (array) - Required - Array of tag objects to create.
  - **nome** (string) - Required - The name of the tag.

### Request Example
{
  "items": [
    {
      "nome": "Nova Tag"
    }
  ]
}

### Response
#### Success Response (200)
- **tags** (array) - List of created tags.

#### Response Example
{
  "tags": [
    {
      "id": 1,
      "nome": "Nova Tag"
    }
  ]
}
```

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

### Create Contact

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Creates a new contact in the system.

```APIDOC
## POST /contatos

### Description
Creates a new contact in the system.

### Method
POST

### Endpoint
/contatos

### Request Body
- **(object)** - Required - The contact data to create.

### Responses
#### Success Response (200)
- **(object)** - The created contact model response.

#### Error Responses
- **400**: Bad Request
- **404**: Not Found
- **403**: Forbidden
- **503**: Service Unavailable
- **401**: Unauthorized
- **500**: Internal Server Error
```

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

### OrdemCompraParcelaModelResponse

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents a payment installment for a purchase order. Includes details such as due date, value, and payment status.

```APIDOC
## OrdemCompraParcelaModelResponse

### Description
Represents a payment installment for a purchase order. Includes details such as due date, value, and payment status.

### Schema
```json
{
  "dataVencimento": "string (example: 2024-01-01)",
  "valor": "number (float)",
  "situacao": "string (enum: 0, 1, 2, 3) - 0: Em Aberto, 1: Pago, 2: Cancelado, 3: A Pagar (nullable)"
}
```
```

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

### Launch Stock for Purchase Order

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Launches stock for a given purchase order, associating it with a specific deposit.

```APIDOC
## POST /compras/ordenscompra/{id}/lancarestq

### Description
Launches stock for a purchase order.

### Method
POST

### Endpoint
/compras/ordenscompra/{id}/lancarestq

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the purchase order.

#### Request Body
- **deposito** (object) - Required - Details of the deposit where the stock will be launched.
  - **$ref** (string) - Reference to DepositoRequestModel schema.

### Request Example
```json
{
  "deposito": {
    "$ref": "#/components/schemas/DepositoRequestModel"
  }
}
```

### Response
#### Success Response (200)
(No specific response fields documented in the source for success.)
```

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

### NotaFiscalParcelaModelResponse

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Details a payment installment for a Nota Fiscal, including the number of days until due, the due date, the amount, and any observations.

```APIDOC
## NotaFiscalParcelaModelResponse

### Description
Represents a payment installment for a Nota Fiscal.

### Properties
- **dias** (integer) - Number of days until the installment is due.
- **data** (string) - The due date of the installment.
- **valor** (number) - The amount of the installment.
- **observacoes** (string) - Any observations related to the installment.
```

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

### Stock API

Source: https://erp.tiny.com.br/public-api/v3/swagger

Endpoints for managing product stock.

```APIDOC
## GET /estoque/{idProduto}

### Description
Obter o estoque de um produto

### Method
GET

### Endpoint
/estoque/{idProduto}
```

```APIDOC
## POST /estoque/{idProduto}

### Description
Atualizar o estoque de um produto

### Method
POST

### Endpoint
/estoque/{idProduto}
```

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

### Obter etiquetas de um agrupamento de expedição

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves labels associated with a specific expedition grouping. Use this endpoint to get all labels for a given expedition group ID.

```APIDOC
## GET /expedicao/{idAgrupamento}/etiquetas

### Description
Obter etiquetas de um agrupamento de expedição

### Method
GET

### Endpoint
/expedicao/{idAgrupamento}/etiquetas

### Parameters
#### Path Parameters
- **idAgrupamento** (integer) - Required - Identificador do agrupamento

### Responses
#### Success Response (200)
- **ObterEtiquetasResponseModel** (object) - OK
```

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

### Create Order

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Allows for the creation of a new order within the ERP Tiny BR system. It accepts a comprehensive request model that includes details about the order, customer, items, payment, and delivery.

```APIDOC
## POST /pedidos

### Description
Creates a new order in the ERP Tiny BR system.

### Method
POST

### Endpoint
/pedidos

### Parameters
#### Request Body
- **body** (CriarPedidoModelRequest) - Required - The request body containing all necessary details to create an order.

### Request Example
```json
{
  "idContato": 123,
  "listaPreco": { ... },
  "naturezaOperacao": { ... },
  "vendedor": { ... },
  "enderecoEntrega": { ... },
  "consumidorFinal": { ... },
  "ecommerce": { ... },
  "transportador": { ... },
  "intermediador": { ... },
  "deposito": { ... },
  "pagamento": { ... },
  "itens": [
    { ... }
  ],
  "pagamentosIntegrados": [
    { ... }
  ]
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the created order.
- **numeroPedido** (string) - The order number generated by the system.

#### Response Example
```json
{
  "id": 456,
  "numeroPedido": "ORD-789012"
}
```
```

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

### Listar Formas de Pagamento

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Lists available payment methods with options for filtering by name and status, and pagination.

```APIDOC
## GET /formas-pagamento

### Description
Lists available payment methods with options for filtering by name and status, and pagination.

### Method
GET

### Endpoint
/formas-pagamento

### Parameters
#### Query Parameters
- **nome** (string) - Optional - Partial or full name of the payment method to search for.
- **situacao** (integer) - Optional - Filters payment methods by status. Use 1 for Enabled, 2 for Disabled.
- **limit** (integer) - Optional - Pagination limit. Defaults to 100.
- **offset** (integer) - Optional - Pagination offset. Defaults to 0.

### Responses
#### Success Response (200)
- **itens** (array) - An array of payment method objects, each conforming to `ListagemFormasPagamentoResponseModel`.
```

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

### ProdutoResponseModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the response model for a product, including ID, SKU, description, and type.

```APIDOC
## ProdutoResponseModel

### Description
Represents the response model for a product, including ID, SKU, description, and type.

### Properties
- **id** (integer) - Nullable - The unique identifier for the product.
- **sku** (string) - Nullable - The Stock Keeping Unit for the product.
- **descricao** (string) - Nullable - The description of the product.
- **tipo** (string) - Nullable - The type of the item, where 'P' denotes Produto (Product) and 'S' denotes Servico (Service).
  - Enum: ["P", "S"]
  - Enum Descriptions: ["P - Produto", "S - Servico"]
```

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

### List Products

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves a paginated list of products with their associated costs. Supports filtering and sorting.

```APIDOC
## GET /produtos

### Description
Retrieves a paginated list of products with their associated costs.

### Method
GET

### Endpoint
/produtos

### Query Parameters
- **pagina** (integer) - Optional - Page number for pagination.
- **itensPorPagina** (integer) - Optional - Number of items per page.
- **offset** (integer) - Optional - Offset for pagination.

### Response
#### Success Response (200)
- **itens** (array) - List of products.
- **paginacao** (object) - Pagination details.
```

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

### List Shipping Methods

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves a list of available shipping methods with pagination support.

```APIDOC
## GET /formas-envio

### Description
Retrieves a list of available shipping methods with pagination support.

### Method
GET

### Endpoint
/formas-envio

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Limite da paginação (default: 100)
- **offset** (integer) - Optional - Offset da paginação (default: 0)

### Response
#### Success Response (200)
- **itens** (array) - List of shipping methods.
- **paginacao** (object) - Pagination details.

#### Response Example
{
  "itens": [
    {
      "id": 1,
      "nome": "Correios",
      "sigla": "ECT",
      "ativo": true,
      "principal": true,
      "freteGratis": false,
      "valorFrete": 0.00,
      "prazoEntrega": 5,
      "tipo": 1
    }
  ],
  "paginacao": {
    "totalRegistros": 10,
    "totalPaginas": 1,
    "paginaAtual": 1,
    "itensPorPagina": 10
  }
}

#### Error Response (400)
- **code** (string) - Error code.
- **message** (string) - Error message.

#### Error Response (401)
- **code** (string) - Error code.
- **message** (string) - Error message.

#### Error Response (403)
- **code** (string) - Error code.
- **message** (string) - Error message.

#### Error Response (404)
- **code** (string) - Error code.
- **message** (string) - Error message.

#### Error Response (500)
- **code** (string) - Error code.
- **message** (string) - Error message.

#### Error Response (503)
- **code** (string) - Error code.
- **message** (string) - Error message.
```

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

### Listar formas de recebimento

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Lists available receipt methods, with options to filter by name and status.

```APIDOC
## GET /formas-recebimento

### Description
Lists available receipt methods, with options to filter by name and status.

### Method
GET

### Endpoint
/formas-recebimento

### Parameters
#### Query Parameters
- **nome** (string) - Optional - Filters receipt methods by name (partial or full match).
- **situacao** (integer) - Optional - Filters receipt methods by status. Use 1 for Enabled, 2 for Disabled.

### Responses
#### Success Response (200)
- **PaginatedResultModel** - A paginated list of receipt methods.

#### Error Response (400)
- **ErrorDTO** - Bad Request

#### Error Response (404)
- Not Found

#### Error Response (403)
- Forbidden

#### Error Response (503)
- Service Unavailable

#### Error Response (401)
- Unauthorized

#### Error Response (500)
- Internal Server Error
```

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

### FormaRecebimentoModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents a receipt method with its ID, name, and status.

```APIDOC
## FormaRecebimentoModel

### Description
Represents a receipt method with its ID, name, and status.

### Properties
- **id** (integer) - The unique identifier for the receipt method.
- **nome** (string, nullable) - The name of the receipt method.
- **situacao** (string, enum, nullable) - The status of the receipt method. Possible values are:
    - 1 - Habilitada
    - 2 - Desabilitada
```

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

### List Product Tags

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves a paginated list of product tags. Supports filtering by ID and pagination parameters.

```APIDOC
## GET /tags

### Description
Retrieves a paginated list of product tags. Supports filtering by ID and pagination parameters.

### Method
GET

### Endpoint
/tags

### Parameters
#### Query Parameters
- **id** (integer) - Optional - Description not provided
- **limit** (integer) - Optional - Limite da paginação (default: 100)
- **offset** (integer) - Optional - Offset da paginação (default: 0)

### Response
#### Success Response (200)
- **itens** (array) - List of product tags.
- **paginacao** (object) - Pagination details.

#### Response Example
{
  "itens": [
    {
      "id": 1,
      "nome": "Exemplo Tag"
    }
  ],
  "paginacao": {
    "totalItens": 1,
    "totalPaginas": 1,
    "paginaAtual": 1,
    "itensPorPagina": 100
  }
}
```

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

### Create Account Receivable

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Allows the creation of a new account receivable entry in the system. It requires detailed information about the receivable, including payment terms, due dates, and amounts.

```APIDOC
## POST /ContaReceber

### Description
Creates a new account receivable.

### Method
POST

### Endpoint
/ContaReceber

### Request Body
- **data** (object) - Required - Data for the account receivable.
  - **tipo** (string) - Optional - Type of receivable (e.g., U, W, Q, M, T, S, A, P).
  - **diaVencimento** (integer) - Optional - Day of the month for the due date.
  - **diaSemanaVencimento** (integer) - Optional - Day of the week for the due date.
  - **quantidadeParcelas** (integer) - Optional - Number of installments.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the created account receivable.
```

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

### ListagemProdutoCustosResponseModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the response model for listing product costs, including various financial and temporal data points.

```APIDOC
## ListagemProdutoCustosResponseModel

### Description
This model provides detailed cost information for products, including historical and current financial data.

### Properties
- **data** (string) - The date associated with the cost information.
- **saldoAtual** (number) - The current balance or stock level.
- **saldoAnterior** (number) - The previous balance or stock level.
- **precoCusto** (number) - The cost price of the product.
- **custoMedio** (number) - The average cost price.
- **precoVenda** (number) - The selling price.
- **impostosRecuperaveis** (number) - Recoverable taxes associated with the product.
```

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

### ObterFormaRecebimentoResponseModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Response model for retrieving a single receipt method.

```APIDOC
## ObterFormaRecebimentoResponseModel

### Description
Response model for retrieving a single receipt method.

### Properties
This model inherits properties from `FormaRecebimentoModel` and may include additional fields.
```

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

### Create Purchase Order

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Creates a new purchase order in the system. It requires details about the order and its items.

```APIDOC
## POST /compras/ordenscompra

### Description
Creates a new purchase order.

### Method
POST

### Endpoint
/compras/ordenscompra

### Parameters
#### Request Body
- **deposito** (object) - Required - Details of the deposit.
- **itens** (array) - Required - List of items in the purchase order.
  - **$ref** (string) - Reference to OrdemCompraItemModelRequest schema.

### Request Example
```json
{
  "deposito": {
    "$ref": "#/components/schemas/DepositoRequestModel"
  },
  "itens": [
    {
      "$ref": "#/components/schemas/OrdemCompraItemModelRequest"
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the created purchase order.
- **numeroPedido** (string) - The order number.
- **data** (string) - The date the order was created.
- **situacao** (string) - The current status of the order (e.g., 'Em Aberto', 'Atendido', 'Cancelado', 'Em Andamento').

#### Response Example
```json
{
  "id": 123,
  "numeroPedido": "PO-2024-001",
  "data": "2024-01-15",
  "situacao": "0"
}
```
```

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

### SeoProdutoRequestModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the SEO request model for a product, including title, description, keywords, video link, and slug.

```APIDOC
## SeoProdutoRequestModel

### Description
Represents the SEO request model for a product, including title, description, keywords, video link, and slug.

### Properties
- **titulo** (string) - Nullable - The SEO title for the product.
- **descricao** (string) - Nullable - The SEO description for the product.
- **keywords** (array of strings) - Nullable - Keywords associated with the product for SEO purposes.
- **linkVideo** (string) - Nullable - A link to a video related to the product.
- **slug** (string) - Nullable - The SEO-friendly URL slug for the product.
```

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

### ListagemProdutosResponseModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the response model for listing products, including their basic identification and type.

```APIDOC
## ListagemProdutosResponseModel

### Description
This model outlines the basic information for a product listing, including its ID, SKU, description, and type.

### Properties
- **id** (integer) - The unique identifier for the product.
- **sku** (string) - The Stock Keeping Unit for the product.
- **descricao** (string) - The description of the product.
- **tipo** (string) - The type of the product. Possible values:
  - K - Kit
  - S - Simples
  - V - Com Variacoes
  - F - Fabricado
  - M - Materia Prima
```

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

### Create CRM Stage

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Creates a new CRM stage.

```APIDOC
## POST /crm/estagios

### Description
Creates a new CRM stage.

### Method
POST

### Endpoint
/crm/estagios

### Request Body
- **descricao** (string) - Required - Description of the stage
- **ativo** (boolean) - Optional - Indicates if the stage is active

### Request Example
{
  "example": "{\n  \"descricao\": \"Qualificação\",\n  \"ativo\": true\n}"
}

### Responses
#### Success Response (200)
- **id** (integer) - The ID of the newly created stage
- **descricao** (string) - The description of the created stage
- **ativo** (boolean) - Indicates if the stage is active

#### Response Example
{
  "example": "{\n  \"id\": 2,\n  \"descricao\": \"Qualificação\",\n  \"ativo\": true\n}"
}
```

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

### ListagemFormasRecebimentoResponseModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Response model for listing receipt methods.

```APIDOC
## ListagemFormasRecebimentoResponseModel

### Description
Response model for listing receipt methods.

### Properties
This model inherits properties from `FormaRecebimentoModel` and may include additional fields.
```

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

### FormaRecebimentoResponseModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Response model for a receipt method.

```APIDOC
## FormaRecebimentoResponseModel

### Description
Response model for a receipt method.

### Properties
- **id** (integer) - The unique identifier for the receipt method.
- **nome** (string, nullable) - The name of the receipt method.
```

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

### OrdemCompraItemModelResponse

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents an item within a purchase order. Includes product details, quantity, unit price, and total value.

```APIDOC
## OrdemCompraItemModelResponse

### Description
Represents an item within a purchase order. Includes product details, quantity, unit price, and total value.

### Schema
```json
{
  "id": "integer",
  "produto": {
    "codigo": "string",
    "descricao": "string"
  },
  "quantidade": "number",
  "valorUnidade": "number (float)",
  "valorTotal": "number (float)"
}
```
```

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

### AtualizarSituacaoOrdemCompraRequestModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Model for updating the status of a purchase order. The status can be set to 'Em Aberto' (Open), 'Atendido' (Attended), 'Cancelado' (Canceled), or 'Em Andamento' (In Progress).

```APIDOC
## AtualizarSituacaoOrdemCompraRequestModel

### Description
Model for updating the status of a purchase order.

### Properties
- **situacao** (integer) - Required - The new status for the purchase order. Possible values are:
    - 0: Em Aberto (Open)
    - 1: Atendido (Attended)
    - 2: Cancelado (Canceled)
    - 3: Em Andamento (In Progress)
```

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

### FormaRecebimentoRequestModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Request model for creating or updating a receipt method.

```APIDOC
## FormaRecebimentoRequestModel

### Description
Request model for creating or updating a receipt method.

### Properties
- **id** (integer, nullable) - The unique identifier for the receipt method. This is optional for creation and required for updates.
```

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

### List CRM Stages

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves a list of CRM stages. Supports filtering by description and pagination.

```APIDOC
## GET /crm/estagios

### Description
Retrieves a list of CRM stages. Supports filtering by description and pagination.

### Method
GET

### Endpoint
/crm/estagios

### Parameters
#### Query Parameters
- **descricao** (string) - Optional - Pesquisa por descrição parcial ou completa do estágio
- **limit** (integer) - Optional - Limite da paginação (default: 100)
- **offset** (integer) - Optional - Offset da paginação (default: 0)

### Responses
#### Success Response (200)
- **items** (array) - List of CrmEstagioResponseModel objects

#### Response Example
{
  "example": "[\n  {\n    \"id\": 1,\n    \"descricao\": \"Novo\",\n    \"ativo\": true\n  }\n]"
}
```

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

### ListagemFormasPagamentoResponseModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Response model for listing payment methods.

```APIDOC
## ListagemFormasPagamentoResponseModel

### Description
Response model for listing payment methods.

### Properties
This model inherits properties from `FormaPagamentoModel` and may include additional fields.
```

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

### SeoProdutoModelResponse

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the SEO response model for a product, including title, description, keywords, video link, and slug.

```APIDOC
## SeoProdutoModelResponse

### Description
Represents the SEO response model for a product, including title, description, keywords, video link, and slug.

### Properties
- **titulo** (string) - Nullable - The SEO title for the product.
- **descricao** (string) - Nullable - The SEO description for the product.
- **keywords** (array of strings) - Nullable - Keywords associated with the product for SEO purposes.
- **linkVideo** (string) - Nullable - A link to a video related to the product.
- **slug** (string) - Nullable - The SEO-friendly URL slug for the product.
```

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

### ObterPedidoModelResponse

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the response model for retrieving order details. It includes information about the order's ID, number, fiscal data, values, associated entities like client, shipping address, carrier, seller, and payment details, as well as a list of items and integrated payments. The 'situacao' field indicates the current status of the order.

```APIDOC
## ObterPedidoModelResponse

### Description
Represents the response model for retrieving order details. It includes information about the order's ID, number, fiscal data, values, associated entities like client, shipping address, carrier, seller, and payment details, as well as a list of items and integrated payments. The 'situacao' field indicates the current status of the order.

### Properties

- **id** (integer) - Nullable
- **numeroPedido** (integer) - Nullable
- **idNotaFiscal** (integer) - Nullable
- **dataFaturamento** (string) - Nullable
- **valorTotalProdutos** (number) - Nullable
- **valorTotalPedido** (number) - Nullable
- **listaPreco** (object) - Reference to ListaPrecoResponseModel
- **cliente** (object) - Reference to PedidoClienteModel
- **enderecoEntrega** (object) - Reference to EnderecoEntregaModelResponse
- **ecommerce** (object) - Reference to EcommerceResponseModel
- **transportador** (object) - Reference to TransportadorResponseModel
- **deposito** (object) - Reference to DepositoResponseModel
- **vendedor** (object) - Reference to VendedorResponseModel
- **naturezaOperacao** (object) - Reference to NaturezaOperacaoResponseModel
- **intermediador** (object) - Reference to IntermediadorResponseModel
- **pagamento** (object) - Reference to PagamentoResponseModel
- **itens** (array) - Nullable. Items are of type ItemPedidoResponseModel.
- **pagamentosIntegrados** (array) - Nullable. Integrated payments are of type PagamentoIntegradoModelResponse.
- **situacao** (integer) - Nullable. Enum values: 8 (Dados Incompletos), 0 (Aberta), 3 (Aprovada), 4 (Preparando Envio), 1 (Faturada), 7 (Pronto Envio), 5 (Enviada), 6 (Entregue), 2 (Cancelada), 9 (Nao Entregue).
- **data** (string) - Example: "2024-01-01"
```

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

### Criar Marcadores da Conta a Receber

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Creates markers for a specific account receivable. Requires authentication.

```APIDOC
## POST /contasreceber/{idContaReceber}/marcadores

### Description
Creates markers for a specific account receivable.

### Method
POST

### Endpoint
/contasreceber/{idContaReceber}/marcadores

### Parameters
#### Path Parameters
- **idContaReceber** (integer) - Required - Identificador da conta a receber

### Responses
(Response details not fully provided in the source text for this operation.)
```

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

### Lançar Estoque do Pedido

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Launches the stock for a given order. This operation is used to update inventory levels based on the items included in the order.

```APIDOC
## POST /pedidos/{idPedido}/lancar-estoque

### Description
Launches the stock for a given order. This operation is used to update inventory levels based on the items included in the order.

### Method
POST

### Endpoint
/pedidos/{idPedido}/lancar-estoque

### Parameters
#### Path Parameters
- **idPedido** (integer) - Required - Identificador do pedido

### Responses
#### Success Response (204)
- No Content

#### Error Responses
- **400** Bad Request: The request was malformed or invalid.
- **404** Not Found: The specified order was not found.
- **403** Forbidden: The authenticated user does not have permission to perform this action.
- **503** Service Unavailable: The service is temporarily unavailable.
- **401** Unauthorized: The request lacks valid authentication credentials.
- **500** Internal Server Error: An unexpected error occurred on the server.
```

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

### List Purchase Orders

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves a list of purchase orders with various details.

```APIDOC
## GET /compras/ordenscompra

### Description
Retrieves a list of purchase orders.

### Method
GET

### Endpoint
/compras/ordenscompra

### Parameters
#### Query Parameters
(No query parameters documented in the source.)

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the purchase order.
- **numero** (string) - The order number.
- **data** (string) - The date of the purchase order.
- **situacao** (string) - The current status of the order.
- **desconto** (string) - Discount applied to the order.
- **frete** (number) - Shipping cost.
- **totalProdutos** (number) - Total cost of products.
- **totalPedidoCompra** (number) - Total purchase order amount.
- **dataPrevista** (string) - Expected delivery date.
- **contato** (object) - Contact information associated with the order.
  - **$ref** (string) - Reference to ContatoModelResponse schema.
- **categoria** (object) - Category of the order.
  - **$ref** (string) - Reference to CategoriaResponseModel schema.
- **notaFiscal** (object) - Invoice details for the order.
  - **$ref** (string) - Reference to OrdemCompraNotaFiscalModelResponse schema.

#### Response Example
```json
{
  "id": 123,
  "numero": "PO-2024-001",
  "data": "2024-01-15",
  "situacao": "0",
  "desconto": "10%",
  "frete": 50.0,
  "totalProdutos": 1000.0,
  "totalPedidoCompra": 1050.0,
  "dataPrevista": "2024-01-20",
  "contato": {
    "$ref": "#/components/schemas/ContatoModelResponse"
  },
  "categoria": {
    "$ref": "#/components/schemas/CategoriaResponseModel"
  },
  "notaFiscal": {
    "$ref": "#/components/schemas/OrdemCompraNotaFiscalModelResponse"
  }
}
```
```

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

### CriarContatoModelRequest

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the request model for creating a new contact. It inherits from `CriarAtualizarContatoModelRequest`.

```APIDOC
## CriarContatoModelRequest

### Description
This model is used specifically for the creation of new contacts. It is based on the `CriarAtualizarContatoModelRequest` model, implying it includes all fields necessary for creating a contact.

### Request Body
This model inherits properties from `CriarAtualizarContatoModelRequest` and has no additional properties defined directly within this schema.

### Response
This model is used for request payloads and does not have a defined response structure.
```

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

### Lançar Contas do Pedido

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Launches the accounts for a given order. This operation is typically used after an order has been confirmed and requires financial processing.

```APIDOC
## POST /pedidos/{idPedido}/lancar-contas

### Description
Launches the accounts for a given order. This operation is typically used after an order has been confirmed and requires financial processing.

### Method
POST

### Endpoint
/pedidos/{idPedido}/lancar-contas

### Parameters
#### Path Parameters
- **idPedido** (integer) - Required - Identificador do pedido

### Responses
#### Success Response (204)
- No Content

#### Error Responses
- **400** Bad Request: The request was malformed or invalid.
- **404** Not Found: The specified order was not found.
- **403** Forbidden: The authenticated user does not have permission to perform this action.
- **503** Service Unavailable: The service is temporarily unavailable.
- **401** Unauthorized: The request lacks valid authentication credentials.
- **500** Internal Server Error: An unexpected error occurred on the server.
```

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

### Create Accounts Receivable

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Creates a new accounts receivable record. Requires due date, value, and contact information.

```APIDOC
## POST /contas-receber

### Description
Creates a new accounts receivable record. Requires due date, value, and contact information.

### Method
POST

### Endpoint
/contas-receber

### Parameters
#### Request Body
- **data** (string) - Optional - The date the record was created.
- **dataVencimento** (string) - Required - The due date of the account receivable.
- **valor** (number) - Required - The value of the account receivable.
- **numeroDocumento** (string) - Optional - The document number.
- **contato** (ContatoRequestModel) - Required - The contact associated with the account receivable.
- **historico** (string) - Optional - Historical information about the account receivable.
- **categoria** (CategoriaRequestModel) - Optional - The category of the account receivable.
- **dataCompetencia** (string) - Optional - The competence date of the account receivable.
- **formaRecebimento** (integer) - Optional - The payment method.
- **ocorrencia** (string) - Optional - The occurrence type (U, W, Q, M, T, S, A, P).
```

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

### FormaPagamentoModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents a payment method with its ID, name, and status.

```APIDOC
## FormaPagamentoModel

### Description
Represents a payment method with its ID, name, and status.

### Properties
- **id** (integer) - The unique identifier for the payment method.
- **nome** (string, nullable) - The name of the payment method.
- **situacao** (string, enum, nullable) - The status of the payment method. Possible values are:
    - 1 - Habilitada
    - 2 - Desabilitada
```

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

### GerarOrdemProducaoPedidoModelRequest

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the request model for generating a production order for an order. It allows specifying items, and options for automatic stock lançamento and related order generation.

```APIDOC
## GerarOrdemProducaoPedidoModelRequest

### Description
Model for generating a production order for an order.

### Request Body
- **itens** (array) - Optional - Lista de itens com produtos e quantidades a serem produzidos. Se não informado, processa todos os itens do pedido automaticamente
  - items: [ItemOrdemProducaoRequestModel]
- **lancarEstoque** (boolean) - Optional - Se true, lança o estoque automaticamente após gerar as ordens de produção (default: false)
- **gerarOrdensRelacionadas** (boolean) - Optional - Se true, gera ordens de produção relacionadas (filhas) automaticamente (default: false)
```

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

### Order Model

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents a customer order, including its status, dates, and financial details.

```APIDOC
## PedidoModel

### Description
Represents a customer order with detailed information about its status and financial aspects.

### Properties
- **situacao** (integer) - Optional - The current status of the order. Possible values include: 8 (Dados Incompletos), 0 (Aberta), 3 (Aprovada), 4 (Preparando Envio), 1 (Faturada), 7 (Pronto Envio), 5 (Enviada), 6 (Entregue), 2 (Cancelada), 9 (Nao Entregue).
- **data** (string) - Optional - The date the order was placed (YYYY-MM-DD).
- **dataEntrega** (string) - Optional - The expected delivery date (YYYY-MM-DD).
- **numeroOrdemCompra** (string) - Optional - The customer's purchase order number.
- **valorDesconto** (number) - Optional - The total discount amount for the order.
- **valorFrete** (number) - Optional - The shipping cost for the order.
- **valorOutrasDespesas** (number) - Optional - Other expenses related to the order.
```

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

### Incluir nota fiscal de consumidor por XML

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

This endpoint allows for the inclusion of a consumer fiscal note by uploading its XML file.

```APIDOC
## POST /notas/nota-fiscal-consumidor/xml

### Description
Allows for the inclusion of a consumer fiscal note by uploading its XML file.

### Method
POST

### Endpoint
/notas/nota-fiscal-consumidor/xml

### Request Body
- **file** (file) - Required - The XML file of the consumer fiscal note to be included.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the newly created consumer fiscal note.
- **status** (string) - The status of the consumer fiscal note.

#### Error Response (400)
- **code** (string) - Error code.
- **message** (string) - Description of the error.
```

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

### Obter ação de um assunto

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves the details of a specific action associated with a CRM subject.

```APIDOC
## GET /crm/assuntos/{idAssunto}/acoes/{idAcao}

### Description
Retrieves the details of a specific action associated with a CRM subject.

### Method
GET

### Endpoint
/crm/assuntos/{idAssunto}/acoes/{idAcao}

### Parameters
#### Path Parameters
- **idAssunto** (integer) - Required - Identificador do assunto
- **idAcao** (integer) - Required - Identificador da ação

### Response
#### Success Response (200)
- **schema** - ObterActionModelResponse

#### Error Responses
- **400** - Bad Request
- **404** - Not Found
- **403** - Forbidden
- **503** - Service Unavailable
- **401** - Unauthorized
- **500** - Internal Server Error
```

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

### ItemOrdemProducaoRequestModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents an item within a production order request. It specifies the product ID.

```APIDOC
## ItemOrdemProducaoRequestModel

### Description
Represents an item within a production order request.

### Request Body
- **idProduto** (integer) - Required - ID do produto
```

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

### Product Price Update Model

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Defines the structure for updating product pricing information, including regular and promotional prices.

```APIDOC
## AtualizarPrecoProdutoRequestModel

### Description
Model for updating product prices, including promotional prices.

### Properties
- **preco** (number) - Required - The regular price of the product.
- **precoPromocional** (number) - Optional - The promotional price of the product.
```

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

### Customer Order Model

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents a customer order, inheriting base contact information and including an order ID.

```APIDOC
## PedidoClienteModel

### Description
Represents a customer order, combining base contact details with a specific order identifier.

### Properties
- **id** (integer) - The unique identifier for the customer order.
```

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

### ObterFormaPagamentoResponseModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Response model for retrieving a single payment method.

```APIDOC
## ObterFormaPagamentoResponseModel

### Description
Response model for retrieving a single payment method.

### Properties
This model inherits properties from `FormaPagamentoModel` and may include additional fields.
```

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

### Listar Notas Fiscais

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Retrieves a paginated list of fiscal notes. Supports filtering by date and sorting. Includes pagination details.

```APIDOC
## GET /notas

### Description
Retrieves a paginated list of fiscal notes. Supports filtering by date and sorting. Includes pagination details.

### Method
GET

### Endpoint
/notas

### Parameters
#### Query Parameters
- **dataEmissaoInicio** (string) - Optional - Data de emissão inicial no formato AAAA-MM-DD
- **dataEmissaoFim** (string) - Optional - Data de emissão final no formato AAAA-MM-DD
- **desc** (string) - Optional - Descrescente
- **limit** (integer) - Optional - Limite da paginação (default: 100)
- **offset** (integer) - Optional - Offset da paginação (default: 0)

### Response
#### Success Response (200)
- **itens** (array) - List of fiscal notes.
- **paginacao** (object) - Pagination information.

#### Response Example
{
  "itens": [
    {
      "example": "ListagemNotaFiscalModelResponse"
    }
  ],
  "paginacao": {
    "example": "PaginatedResultModel"
  }
}
```

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

### ProdutoRequestModel

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Represents the request model for a product, including its ID and type.

```APIDOC
## ProdutoRequestModel

### Description
Represents the request model for a product, including its ID and type.

### Properties
- **id** (integer) - Not Null - The unique identifier for the product.
- **tipo** (string) - Nullable - The type of the item, where 'P' denotes Produto (Product) and 'S' denotes Servico (Service).
  - Enum: ["P", "S"]
  - Enum Descriptions: ["P - Produto", "S - Servico"]
```

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

### CriarMarcadoresPedidoAction

Source: https://erp.tiny.com.br/public-api/v3/swagger/swagger.json

Creates new markers for a specific order. Requires the order ID and an array of marker creation models in the request body.

```APIDOC
## POST /pedidos/{idPedido}/marcadores

### Description
Creates new markers for a specific order.

### Method
POST

### Endpoint
/pedidos/{idPedido}/marcadores

### Parameters
#### Path Parameters
- **idPedido** (integer) - Required - Identificador do pedido

#### Request Body
- **(array)** - Required - Array of marker creation models
  - **(object)** - Required - Marker creation model
    - **[fields from CriarMarcadorRequestModel]**

### Responses
#### Success Response (201 - assumed, as no success code specified)
Created (Details not specified in source)

#### Error Responses
- **400** - Bad Request (application/json, schema: ErrorDTO)
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **500** - Internal Server Error
- **503** - Service Unavailable
```
Tokens:
Raw