{
"openapi": "3.0.0",
"info": {
"title": "Bling API",
"description": "A sessão abaixo contém a documentação das API's que o Bling disponibiliza.",
"version": "3.0"
},
"servers": [
{
"url": "https://api.bling.com.br/Api/v3",
"description": "Ambiente de produção"
},
{
"url": "https://developer.bling.com.br/api/bling",
"description": "Ambiente de teste da documentação"
}
],
"paths": {
"/": {},
"/anuncios/categorias": {
"get": {
"tags": [
"Anúncios - Categorias"
],
"summary": "Obtém categorias de anúncios",
"description": "Obtém categorias de anúncios.",
"parameters": [
{
"$ref": "#/components/parameters/tipoIntegracao"
},
{
"$ref": "#/components/parameters/idLojaQuery"
},
{
"name": "idCategoria",
"in": "query",
"description": "ID da categoria",
"required": false,
"schema": {
"type": "integer",
"example": 10
}
},
{
"name": "tipoProduto",
"in": "query",
"description": "Tipo do produto",
"required": false,
"schema": {
"type": "string",
"example": "eletronico"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnunciosCategoriaDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "AnunciosCategorias",
"x-api-action": "ObterMultiplos"
}
},
"/anuncios/categorias/{idCategoria}": {
"get": {
"tags": [
"Anúncios - Categorias"
],
"summary": "Obtém uma categoria de anúncio",
"description": "Obtém uma categoria de anúncio pelo ID.",
"parameters": [
{
"name": "idCategoria",
"in": "path",
"description": "ID da categoria no marketplace (ex.: Mercado Livre)",
"required": true,
"schema": {
"type": "string",
"example": "MLB1430"
}
},
{
"$ref": "#/components/parameters/tipoIntegracao"
},
{
"$ref": "#/components/parameters/idLojaQuery"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/AnunciosGetAttributesFromCategoryResponseDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "AnunciosCategorias",
"x-api-action": "Obter"
}
},
"/anuncios": {
"get": {
"tags": [
"Anúncios"
],
"summary": "Obtém anúncios",
"description": "Obtém anúncios paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "situacao",
"in": "query",
"description": "Situação do anúncio
`1` Publicado
`2` Rascunho
`3` Com problema
`4` Pausado",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"enum": [
1,
2,
3,
4
]
}
},
{
"name": "idProduto",
"in": "query",
"description": "ID do produto",
"required": false,
"schema": {
"type": "integer",
"example": 12345
}
},
{
"$ref": "#/components/parameters/tipoIntegracao"
},
{
"$ref": "#/components/parameters/idLojaQuery"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/AnunciosGetAllResponseDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Anuncios",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Anúncios"
],
"summary": "Cria um anúncio",
"description": "Cria um anúncio.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnunciosSaveRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/AnunciosSaveResponseDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Anuncios",
"x-api-action": "Criar"
}
},
"/anuncios/{idAnuncio}": {
"get": {
"tags": [
"Anúncios"
],
"summary": "Obtém um anúncio",
"description": "Obtém os detalhes de um anúncio específico pelo seu ID.",
"parameters": [
{
"$ref": "#/components/parameters/idAnuncio"
},
{
"$ref": "#/components/parameters/tipoIntegracao"
},
{
"$ref": "#/components/parameters/idLojaQuery"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/AnunciosGetByIdResponseDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Anuncios",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Anúncios"
],
"summary": "Altera um anúncio",
"description": "Altera um anúncio pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idAnuncio"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnunciosSaveRequest"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Anuncios",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Anúncios"
],
"summary": "Remove um anúncio",
"description": "Remove um anúncio pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idAnuncio"
},
{
"$ref": "#/components/parameters/tipoIntegracao"
},
{
"$ref": "#/components/parameters/idLojaQuery"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Anuncios",
"x-api-action": "Remover"
}
},
"/anuncios/{idAnuncio}/publicar": {
"post": {
"tags": [
"Anúncios"
],
"summary": "Publica um anúncio",
"description": "Altera o status do anúncio para publicado.",
"parameters": [
{
"$ref": "#/components/parameters/idAnuncio"
},
{
"$ref": "#/components/parameters/tipoIntegracao"
},
{
"$ref": "#/components/parameters/idLojaQuery"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Anuncios",
"x-api-action": "Publicar"
}
},
"/anuncios/{idAnuncio}/pausar": {
"post": {
"tags": [
"Anúncios"
],
"summary": "Pausa um anúncio",
"description": "Altera o status do anúncio para pausado.",
"parameters": [
{
"$ref": "#/components/parameters/idAnuncio"
},
{
"$ref": "#/components/parameters/tipoIntegracao"
},
{
"$ref": "#/components/parameters/idLojaQuery"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Anuncios",
"x-api-action": "Pausar"
}
},
"/borderos/{idBordero}": {
"get": {
"tags": [
"Borderôs"
],
"summary": "Obtém um borderô",
"description": "Obtém um borderô pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idBordero"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BorderosDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Borderos",
"x-api-action": "Obter"
},
"delete": {
"tags": [
"Borderôs"
],
"summary": "Remove um borderô",
"description": "Remove um borderô pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idBordero"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Borderos",
"x-api-action": "Remover"
}
},
"/campos-customizados/modulos": {
"get": {
"tags": [
"Campos Customizados"
],
"summary": "Obtém módulos que possuem campos customizados",
"description": "Obtém módulos que possuem campos customizados.",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CamposCustomizadosModuloBaseDTO"
},
{
"$ref": "#/components/schemas/CamposCustomizadosModuloDTO"
}
]
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CamposCustomizados",
"x-api-action": "ObterModulosCamposCustomizados"
}
},
"/campos-customizados/tipos": {
"get": {
"tags": [
"Campos Customizados"
],
"summary": "Obtém tipos de campos customizados",
"description": "Obtém tipos de campos customizados.",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CamposCustomizadosTipoBaseDTO"
},
{
"$ref": "#/components/schemas/CamposCustomizadosTipoDTO"
}
]
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CamposCustomizados",
"x-api-action": "ObterTiposCamposCustomizados"
}
},
"/campos-customizados/modulos/{idModulo}": {
"get": {
"tags": [
"Campos Customizados"
],
"summary": "Obtém campos customizados por módulo",
"description": "Obtém campos customizados por módulo paginados.",
"parameters": [
{
"name": "idModulo",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"example": "12345678"
}
},
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CamposCustomizadosDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CamposCustomizados",
"x-api-action": "ObterMultiplos"
}
},
"/campos-customizados/{idCampoCustomizado}": {
"get": {
"tags": [
"Campos Customizados"
],
"summary": "Obtém um campo customizado",
"description": "Obtém um campo customizado pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCampoCustomizado"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CamposCustomizadosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/CamposCustomizadosDadosEdicaoDTO"
},
{
"$ref": "#/components/schemas/CamposCustomizadosDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CamposCustomizados",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Campos Customizados"
],
"summary": "Altera um campo customizado",
"description": "Altera um campo customizado pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCampoCustomizado"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CamposCustomizadosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/CamposCustomizadosDadosEdicaoDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/CamposCustomizadosResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CamposCustomizados",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Campos Customizados"
],
"summary": "Remove um campo customizado",
"description": "Remove um campo customizado pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCampoCustomizado"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CamposCustomizados",
"x-api-action": "Remover"
}
},
"/campos-customizados": {
"post": {
"tags": [
"Campos Customizados"
],
"summary": "Cria um campo customizado",
"description": "Cria um campo customizado.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CamposCustomizadosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/CamposCustomizadosDadosEdicaoDTO"
},
{
"$ref": "#/components/schemas/CamposCustomizadosDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/CamposCustomizadosResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CamposCustomizados",
"x-api-action": "Criar"
}
},
"/campos-customizados/{idCampoCustomizado}/situacoes": {
"patch": {
"tags": [
"Campos Customizados"
],
"summary": "Altera a situação de um campo customizado",
"description": "Altera a situação de um campo customizado pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCampoCustomizado"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"situacao": {
"description": "`0` Inativo
`1` Ativo",
"type": "integer",
"enum": [
0,
1
],
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CamposCustomizados",
"x-api-action": "AlterarSituacao"
}
},
"/categorias/lojas": {
"get": {
"tags": [
"Categorias - Lojas"
],
"summary": "Obtém categorias de lojas virtuais vinculadas a de produtos",
"description": "Obtém categorias de lojas virtuais vinculadas a de produtos paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "idLoja",
"in": "query",
"description": "ID da loja",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idCategoriaProduto",
"in": "query",
"description": "ID da categoria do produto",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idCategoriaProdutoPai",
"in": "query",
"description": "ID da categoria do produto pai",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoriasLojasDadosDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CategoriasLojas",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Categorias - Lojas"
],
"summary": "Cria o vínculo de uma categoria da loja com a de produto",
"description": "Cria o vínculo de uma categoria da loja com a de produto.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoriasLojasDadosDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasLojas",
"x-api-action": "Criar"
}
},
"/categorias/lojas/{idCategoriaLoja}": {
"get": {
"tags": [
"Categorias - Lojas"
],
"summary": "Obtém uma categoria da loja vinculada a de produto",
"description": "Obtém uma categoria da loja vinculada a de produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoriaLoja"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/CategoriasLojasDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasLojas",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Categorias - Lojas"
],
"summary": "Altera o vínculo de uma categoria da loja com a de produto",
"description": "Altera o vínculo de uma categoria da loja com a de produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoriaLoja"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoriasLojasDadosDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasLojas",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Categorias - Lojas"
],
"summary": "Remove o vínculo de uma categoria da loja com a de produto",
"description": "Remove o vínculo de uma categoria da loja com a de produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoriaLoja"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasLojas",
"x-api-action": "Remover"
}
},
"/categorias/produtos": {
"get": {
"tags": [
"Categorias - Produtos"
],
"summary": "Obtém categorias de produtos",
"description": "Obtém categorias de produtos paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CategoriasProdutosDadosDTO"
},
{
"properties": {
"categoriaPai": {
"$ref": "#/components/schemas/CategoriasProdutosCategoriPaiDTO"
}
},
"type": "object"
}
]
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CategoriasProdutos",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Categorias - Produtos"
],
"summary": "Cria uma categoria de produto",
"description": "Cria uma categoria de produto.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CategoriasProdutosDadosDTO"
},
{
"properties": {
"categoriaPai": {
"$ref": "#/components/schemas/CategoriasProdutosCategoriPaiDTO"
}
},
"type": "object"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasProdutos",
"x-api-action": "Criar"
}
},
"/categorias/produtos/{idCategoriaProduto}": {
"get": {
"tags": [
"Categorias - Produtos"
],
"summary": "Obtém uma categoria de produto",
"description": "Obtém uma categoria de produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoriaProduto"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CategoriasProdutosDadosDTO"
},
{
"properties": {
"categoriaPai": {
"$ref": "#/components/schemas/CategoriasProdutosCategoriPaiDTO"
}
},
"type": "object"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasProdutos",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Categorias - Produtos"
],
"summary": "Altera uma categoria de produto",
"description": "Altera uma categoria de produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoriaProduto"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoriasProdutosDadosDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasProdutos",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Categorias - Produtos"
],
"summary": "Remove uma categoria de produto",
"description": "Remove uma categoria de produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoriaProduto"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasProdutos",
"x-api-action": "Remover"
}
},
"/categorias/receitas-despesas": {
"get": {
"tags": [
"Categorias - Receitas e Despesas"
],
"summary": "Obtém categorias de receitas e despesas",
"description": "Obtém categorias de receitas e despesas paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "tipo",
"in": "query",
"description": "`0` Todas
`1` Despesa
`2` Receita
`3` Receita e despesa",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1,
2,
3
]
}
},
{
"name": "situacao",
"in": "query",
"description": "`0` Ativas e Inativas
`1` Ativas
`2` Inativas",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1,
2
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosBaseDTO"
}
]
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CategoriasReceitasDespesas",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Categorias - Receitas e Despesas"
],
"summary": "Cria uma categoria de receita e despesa",
"description": "Cria uma categoria de receita e despesa.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosPostDTO"
},
{
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosBaseDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosBaseDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasReceitasDespesas",
"x-api-action": "Criar"
},
"delete": {
"tags": [
"Categorias - Receitas e Despesas"
],
"summary": "Remove múltiplas categorias de receita e despesa",
"description": "Remove múltiplas categorias de receita e despesa a partir de uma lista de IDs.",
"parameters": [
{
"name": "idsCategorias[]",
"in": "query",
"description": "IDs das categorias a serem removidas",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"alertas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CategoriasReceitasDespesas",
"x-api-action": "RemoverMultiplos"
}
},
"/categorias/receitas-despesas/{idCategoria}": {
"get": {
"tags": [
"Categorias - Receitas e Despesas"
],
"summary": "Obtém uma categoria de receita e despesa",
"description": "Obtém uma categoria de receita e despesa pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoria"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasReceitasDespesas",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Categorias - Receitas e Despesas"
],
"summary": "Atualiza uma categoria de receita e despesa",
"description": "Atualiza uma categoria de receita e despesa a partir do ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoria"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosPostDTO"
},
{
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosBaseDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/CategoriasReceitasDespesasDadosBaseDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasReceitasDespesas",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Categorias - Receitas e Despesas"
],
"summary": "Remove uma categoria de receita e despesa",
"description": "Remove uma categoria de receita e despesa pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCategoria"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CategoriasReceitasDespesas",
"x-api-action": "Remover"
}
},
"/contas-contabeis": {
"get": {
"tags": [
"Contas Financeiras"
],
"summary": "Obtém contas financeiras",
"description": "Obtém contas financeiras paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "ocultarInvisiveis",
"in": "query",
"description": "Oculta contas financeiras invisíveis",
"required": false,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "ocultarTipoContaBancaria",
"in": "query",
"description": "Oculta contas financeiras do tipo conta bancária",
"required": false,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "situacoes",
"in": "query",
"description": "Situação da conta financeira
`1` Ativo
`2` Inativo
`3` Pendente
`4` Cancelada",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer",
"enum": [
1,
2,
3,
4
]
}
}
},
{
"name": "aliasIntegracao",
"in": "query",
"description": "Alias da integração",
"required": false,
"schema": {
"type": "string",
"example": "BlingPagamentos"
}
},
{
"name": "aliasIntegracao",
"in": "path",
"description": "Alias da integração",
"required": false,
"schema": {
"type": "string",
"example": "BlingPagamentos"
}
},
{
"name": "ordenacao",
"in": "query",
"description": "Ordenação da obtenção pelos campos:
`descricao`",
"required": false,
"schema": {
"type": "string",
"enum": [
"descricao",
"-descricao"
],
"example": "descricao"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContasContabeisDadosDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "ContasContabeis",
"x-api-action": "ObterMultiplos"
}
},
"/contas-contabeis/{idContaContabil}": {
"get": {
"tags": [
"Contas Financeiras"
],
"summary": "Obtém uma conta financeira",
"description": "Obtém uma conta financeira pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContaContabil"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ContasContabeisDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasContabeis",
"x-api-action": "Obter"
}
},
"/contas/receber": {
"get": {
"tags": [
"Contas a Receber"
],
"summary": "Obtém contas a receber",
"description": "Obtém contas a receber paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "situacoes[]",
"in": "query",
"description": "`1` Em aberto
`2` Recebido
`3` Parcialmente recebido
`4` Devolvido
`5` Cancelado",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"enum": [
1,
2,
3,
4,
5
],
"example": [
1,
3
]
}
},
{
"name": "tipoFiltroData",
"in": "query",
"description": "Referente ao campo que será considerado ao filtrar por data inicial e final
`E` Data de emissão
`V` Data de vencimento
`R` Data de recebimento",
"required": false,
"schema": {
"type": "string",
"default": "E",
"enum": [
"E",
"V",
"R"
]
}
},
{
"name": "dataInicial",
"in": "query",
"description": "Data inicial. Por padrão, um ano antes da data atual.",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-01"
}
},
{
"name": "dataFinal",
"in": "query",
"description": "Data final. Por padrão, a data atual.",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-01"
}
},
{
"name": "idsCategorias[]",
"in": "query",
"description": "IDs das categorias de receitas e despesas",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"name": "idPortador",
"in": "query",
"description": "ID da conta financeira",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idContato",
"in": "query",
"description": "ID do contato",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idVendedor",
"in": "query",
"description": "ID do vendedor",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idFormaPagamento",
"in": "query",
"description": "ID da forma de pagamento",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "boletoGerado",
"in": "query",
"description": "Obtém contas com ou sem boletos emitidos via integração, `0` para boletos não emitidos e `1` para boletos emitidos",
"required": false,
"schema": {
"type": "integer",
"enum": [
0,
1
],
"example": 1
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContasReceberDadosListDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "ContasReceber",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Contas a Receber"
],
"summary": "Cria uma conta a receber",
"description": "Cria uma conta a receber.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContasReceberDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContasReceberDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasReceber",
"x-api-action": "Criar"
}
},
"/contas/receber/{idContaReceber}": {
"get": {
"tags": [
"Contas a Receber"
],
"summary": "Obtém uma conta a receber",
"description": "Obtém uma conta a receber pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContaReceber"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ContasReceberDadosListDTO"
},
{
"$ref": "#/components/schemas/ContasReceberDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContasReceberDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasReceber",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Contas a Receber"
],
"summary": "Altera uma conta a receber",
"description": "Altera uma conta a receber pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContaReceber"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContasReceberDadosBaseDTO"
}
]
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasReceber",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Contas a Receber"
],
"summary": "Remove uma conta a receber",
"description": "Remove uma conta a receber pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContaReceber"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasReceber",
"x-api-action": "Remover"
}
},
"/contas/receber/{idContaReceber}/baixar": {
"post": {
"tags": [
"Contas a Receber"
],
"summary": "Cria o recebimento de uma conta a receber",
"description": "Cria o recebimento de uma conta a receber.",
"parameters": [
{
"$ref": "#/components/parameters/idContaReceber"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContasBaixarContaDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"bordero": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasReceber",
"x-api-action": "BaixarConta"
}
},
"/contas/receber/boletos": {
"get": {
"tags": [
"Contas a Receber"
],
"summary": "Obtém boletos de contas a receber",
"description": "Obtém os boletos vinculados a um idOrigem, o qual corresponde ao ID de uma venda ou nota fiscal.",
"parameters": [
{
"$ref": "#/components/parameters/idOrigemContaReceber"
},
{
"$ref": "#/components/parameters/situacoesContaReceber"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContasReceberBoletosDadosBaseDTO"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"properties": {
"type": {
"description": "Tipo do erro.",
"type": "string",
"example": "RESOURCE_NOT_FOUND"
},
"message": {
"description": "Mensagem de erro.",
"type": "string",
"example": "Nenhum boleto foi localizado"
},
"description": {
"description": "Descrição do erro.",
"type": "string",
"example": "O recurso requisitado não foi encontrado. Verifique se o endpoint solicitado está correto ou se o ID informado realmente existe no sistema"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "ContasReceber",
"x-api-action": "ObterBoletos"
}
},
"/contas/receber/boletos/cancelar": {
"post": {
"tags": [
"Contas a Receber"
],
"summary": "Cancela boletos de contas a receber",
"description": "Cancela um ou todos os boletos em aberto vinculados a uma venda ou nota fiscal.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContasReceberBoletosCancelarDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"type",
"message",
"description"
],
"properties": {
"type": {
"type": "string",
"enum": [
"BAD_REQUEST",
"VALIDATION_ERROR",
"MISSING_REQUIRED_FIELD_ERROR",
"EMPTY_REQUEST_BODY",
"INVALID_REQUEST_BODY",
"INVALID_APIKEY_ERROR",
"UNAUTHORIZED",
"UNAUTHENTICATED",
"FORBIDDEN",
"RESOURCE_NOT_FOUND",
"METHOD_NOT_ALLOWED",
"TOO_MANY_REQUESTS",
"UNKNOWN_ERROR",
"SERVER_ERROR",
"NOT_IMPLEMENTED"
],
"example": "VALIDATION_ERROR"
},
"message": {
"type": "string",
"example": "Não foi possível realizar o cancelamento"
},
"description": {
"type": "string",
"example": "Não foi possível realizar cancelamento da(s) conta(s) a receber, pois houveram erros de validação."
},
"fields": {
"type": "array",
"items": {
"properties": {
"code": {
"type": "integer",
"example": ""
},
"msg": {
"type": "string",
"example": "Conta(s) a receber não foram encontrada(s), verifique se as contas estão em aberto e com forma de pagamento boleto bancário"
},
"element": {
"type": "string",
"example": "idDuplicata"
},
"namespace": {
"description": "",
"type": "string",
"example": ""
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "ContasReceber",
"x-api-action": "CancelarBoletos"
}
},
"/contatos": {
"get": {
"tags": [
"Contatos"
],
"summary": "Obtém contatos",
"description": "Obtém contatos paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "pesquisa",
"in": "query",
"description": "Nome, CPF/CNPJ, fantasia, e-mail ou código do contato",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "criterio",
"in": "query",
"description": "Criterio de listagem
`1` Todos
`2` Excluídos
`3` Últimos incluídos
`4` Sem movimento",
"required": false,
"schema": {
"type": "integer",
"default": 3,
"enum": [
1,
2,
3,
4
]
}
},
{
"name": "dataInclusaoInicial",
"in": "query",
"description": "Data de inclusão inicial",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2022-01-01 10:00:00"
}
},
{
"name": "dataInclusaoFinal",
"in": "query",
"description": "Data de inclusão final",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2022-01-01 15:00:00"
}
},
{
"name": "dataAlteracaoInicial",
"in": "query",
"description": "Data de alteração inicial",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2022-01-01 10:00:00"
}
},
{
"name": "dataAlteracaoFinal",
"in": "query",
"description": "Data de alteração final",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2022-01-01 15:00:00"
}
},
{
"name": "idTipoContato",
"in": "query",
"description": "ID do tipo do contato",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idVendedor",
"in": "query",
"description": "ID do vendedor relacionado ao contato",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "uf",
"in": "query",
"description": "UF do contato",
"required": false,
"schema": {
"type": "string",
"example": "RS"
}
},
{
"name": "telefone",
"in": "query",
"description": "Telefone do contato",
"required": false,
"schema": {
"type": "string",
"example": "(51) 99999-9999"
}
},
{
"name": "idsContatos[]",
"in": "query",
"description": "IDs dos contatos",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"name": "numeroDocumento",
"in": "query",
"description": " CPF/CNPJ, desconsiderando a pontuação",
"required": false,
"schema": {
"type": "string",
"example": "12345678910"
}
},
{
"name": "tipoPessoa",
"in": "query",
"description": "Tipo de pessoa
`1` Física
`2` Jurídica
`3` Estrangeiro",
"required": false,
"schema": {
"type": "integer",
"enum": [
1,
2,
3
],
"example": 1
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContatosDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Contatos"
],
"summary": "Cria um contato",
"description": "Cria um contato.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContatosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContatosDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "Criar"
},
"delete": {
"tags": [
"Contatos"
],
"summary": "Remove múltiplos contatos",
"description": "Remove múltiplos contatos pelos IDs.",
"parameters": [
{
"name": "idsContatos[]",
"in": "query",
"description": "IDs dos contatos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ContatosAlertasResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "RemoverMultiplos"
}
},
"/contatos/{idContato}": {
"get": {
"tags": [
"Contatos"
],
"summary": "Obtém um contato",
"description": "Obtém um contato pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContato"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ContatosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContatosDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Contatos"
],
"summary": "Altera um contato",
"description": "Altera um contato pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContato"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContatosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContatosDadosDTO"
}
]
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Contatos"
],
"summary": "Remove um contato",
"description": "Remove um contato pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContato"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "Remover"
}
},
"/contatos/{idContato}/tipos": {
"get": {
"tags": [
"Contatos"
],
"summary": "Obtém os tipos de contato de um contato",
"description": "Obtém os tipos de contato de um contato pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContato"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContatosTipoContatoDTO"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "ObterTipoContato"
}
},
"/contatos/consumidor-final": {
"get": {
"tags": [
"Contatos"
],
"summary": "Obtém os dados do contato Consumidor Final",
"description": "Obtém os dados do contato Consumidor Final. O consumidor final é um contato padrão do sistema que é criado automaticamente e não pode ser alterado.",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ContatosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContatosDadosDTO"
}
]
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "Obter"
}
},
"/contatos/{idContato}/situacoes": {
"patch": {
"tags": [
"Contatos"
],
"summary": "Altera a situação de um contato",
"description": "Altera a situação de um contato pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContato"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"situacao": {
"type": "string",
"enum": [
"A",
"I",
"E",
"S"
],
"example": "A"
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "AlterarSituacao"
}
},
"/contatos/situacoes": {
"post": {
"tags": [
"Contatos"
],
"summary": "Altera a situação de múltiplos contatos",
"description": "Altera a situação de múltiplos contatos pelos IDs.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"idsContatos": {
"type": "array",
"items": {
"type": "integer",
"example": 12345678
}
},
"situacao": {
"type": "string",
"enum": [
"A",
"I",
"E",
"S"
],
"example": "A"
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ContatosAlertasResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contatos",
"x-api-action": "AlterarSituacaoMultiplos"
}
},
"/contatos/tipos": {
"get": {
"tags": [
"Contatos - Tipos"
],
"summary": "Obtém tipos de contato",
"description": "Obtém tipos de contato pelo ID.",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContatosTipoContatoDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "ContatosTipos",
"x-api-action": "ObterTipoContatoMultiplos"
}
},
"/contratos": {
"get": {
"tags": [
"Contratos"
],
"summary": "Obtém contratos",
"description": "Obtém contratos paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "dataCriacaoInicio",
"in": "query",
"description": "Data inicial de criação",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-01"
}
},
{
"name": "dataCriacaoFinal",
"in": "query",
"description": "Data final de criação",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-15"
}
},
{
"name": "dataBaseInicio",
"in": "query",
"description": "Data base inicial para geração de cobranças",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-01"
}
},
{
"name": "dataBaseFinal",
"in": "query",
"description": "Data base final para geração de cobranças",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-15"
}
},
{
"name": "situacao",
"in": "query",
"description": "`0` Inativo
`1` Ativo
`2` Baixado
`3` Isento",
"required": false,
"schema": {
"type": "string",
"default": 1,
"enum": [
0,
1,
2,
3
]
}
},
{
"name": "idContato",
"in": "query",
"description": "ID do contato",
"required": false,
"schema": {
"type": "integer",
"example": 1245678
}
},
{
"name": "idContatoCobranca",
"in": "query",
"description": "ID do contato de cobrança",
"required": false,
"schema": {
"type": "integer",
"example": 1245678
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContratosDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "Contratos",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Contratos"
],
"summary": "Cria um contrato",
"description": "Cria um contrato.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContratosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContratosDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contratos",
"x-api-action": "Criar"
}
},
"/contratos/{idContrato}": {
"get": {
"tags": [
"Contratos"
],
"summary": "Obtém um contrato",
"description": "Obtém um contrato pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContrato"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ContratosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContratosDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contratos",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Contratos"
],
"summary": "Altera um contrato",
"description": "Altera um contrato pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContrato"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContratosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContratosDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contratos",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Contratos"
],
"summary": "Remove um contrato",
"description": "Remove um contrato pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContrato"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Contratos",
"x-api-action": "Remover"
}
},
"/depositos": {
"get": {
"tags": [
"Depósitos"
],
"summary": "Obtém depósitos",
"description": "Obtém depósitos paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "descricao",
"in": "query",
"description": "Descrição do depósito",
"required": false,
"schema": {
"type": "string",
"example": "Geral"
}
},
{
"name": "situacao",
"in": "query",
"description": "`0` Inativo
`1` Ativo",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DepositosDadosDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "Depositos",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Depósitos"
],
"summary": "Cria um depósito",
"description": "Cria um depósito. Até 100 depósitos podem ser criados.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepositosDadosDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Depositos",
"x-api-action": "Criar"
}
},
"/depositos/{idDeposito}": {
"get": {
"tags": [
"Depósitos"
],
"summary": "Obtém um depósito",
"description": "Obtém um depósito pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idDeposito"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/DepositosDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Depositos",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Depósitos"
],
"summary": "Altera um depósito",
"description": "Altera um depósito pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idDeposito"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepositosDadosDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"properties": {
"alertas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorField"
}
}
},
"type": "object"
}
]
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Depositos",
"x-api-action": "Alterar"
}
},
"/empresas/me/dados-basicos": {
"get": {
"tags": [
"Empresas"
],
"summary": "Obtém dados básicos da empresa",
"description": "Obtém CNPJ, razão social e e-mail da empresa.",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/EmpresasDadosBasicosDTO"
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "Empresas",
"x-api-action": "Obter"
}
},
"/estoques/saldos/{idDeposito}": {
"get": {
"tags": [
"Estoques"
],
"summary": "Obtém o saldo em estoque de produtos por depósito",
"description": "Obtém o saldo em estoque de produtos pelo ID do depósito.",
"parameters": [
{
"name": "idDeposito",
"in": "path",
"description": "ID do depósito",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idsProdutos[]",
"in": "query",
"description": "IDs dos produtos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"name": "codigos[]",
"in": "query",
"description": "Códigos dos produtos",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SKU1",
"SKU2"
]
}
},
{
"$ref": "#/components/parameters/filtroSaldoEstoque"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EstoquesSaldosBaseDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Estoques",
"x-api-action": "ObterSaldosEstoqueDeposito"
}
},
"/estoques/saldos": {
"get": {
"tags": [
"Estoques"
],
"summary": "Obtém o saldo em estoque de produtos",
"description": "Obtém o saldo em estoque de produtos, em todos os depósitos.",
"parameters": [
{
"name": "idsProdutos[]",
"in": "query",
"description": "IDs dos produtos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"name": "codigos[]",
"in": "query",
"description": "Códigos dos produtos",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SKU1",
"SKU2"
]
}
},
{
"$ref": "#/components/parameters/filtroSaldoEstoque"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/EstoquesSaldosBaseDTO"
},
{
"$ref": "#/components/schemas/EstoquesSaldosDTO"
}
]
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Estoques",
"x-api-action": "ObterSaldosEstoque"
}
},
"/estoques": {
"post": {
"tags": [
"Estoques"
],
"summary": "Cria um registro de estoque",
"description": "Cria um registro de estoque.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EstoquesDadosDTO"
},
{
"$ref": "#/components/schemas/EstoquesDadosBaseDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Estoques",
"x-api-action": "Criar"
}
},
"/produtos/lotes": {
"get": {
"tags": [
"Produtos - Lotes"
],
"summary": "Obtém lotes de produtos",
"description": "Obtém lotes de produtos paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "idsProdutos[]",
"in": "query",
"description": "IDs dos produtos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"$ref": "#/components/parameters/idsLotes[]"
},
{
"$ref": "#/components/parameters/idsDepositos[]"
},
{
"$ref": "#/components/parameters/codigosLotes[]"
},
{
"$ref": "#/components/parameters/status"
},
{
"$ref": "#/components/parameters/dataValidadeInicial"
},
{
"$ref": "#/components/parameters/dataValidadeFinal"
},
{
"$ref": "#/components/parameters/dataFabricacaoInicial"
},
{
"$ref": "#/components/parameters/dataFabricacaoFinal"
},
{
"$ref": "#/components/parameters/dataCriacaoInicial"
},
{
"$ref": "#/components/parameters/dataCriacaoFinal"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LotesDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Lotes",
"x-api-action": "ObterMultiplos"
},
"put": {
"tags": [
"Produtos - Lotes"
],
"summary": "Salva lotes de produtos",
"description": "Cria/altera lotes de produtos.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LotesDTO"
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/SaveResponseLotsDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Lotes",
"x-api-action": "CriarMultiplos"
},
"delete": {
"tags": [
"Produtos - Lotes"
],
"summary": "Remove lotes de produtos",
"description": "Remove lotes de produtos pelos IDs.",
"parameters": [
{
"name": "idsLotes[]",
"in": "query",
"description": "IDs dos lotes",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Lotes",
"x-api-action": "RemoverMultiplos"
}
},
"/produtos/lotes/{idLote}": {
"get": {
"tags": [
"Produtos - Lotes"
],
"summary": "Obtém um lote de um produto",
"description": "Obtém um lote de um produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idLote"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LotesDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Lotes",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Produtos - Lotes"
],
"summary": "Altera um lote de um produto",
"description": "Altera um lote de um produto pelo ID.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LotePutRequestDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Lotes",
"x-api-action": "Alterar"
}
},
"/produtos/lotes/controla-lote": {
"get": {
"tags": [
"Produtos - Lotes"
],
"summary": "Obtém a informação se determinados produtos possuem controle de lote",
"description": "Obtém a informação se determinados produtos possuem controle de lote.",
"parameters": [
{
"name": "idsProdutos[]",
"in": "query",
"description": "IDs dos produtos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutoControlaLotesDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Lotes",
"x-api-action": "ObterMultiplosProdutoControlaLote"
}
},
"/produtos/{idProduto}/lotes/controla-lote/desativar": {
"post": {
"tags": [
"Produtos - Lotes"
],
"summary": "Desativa controle de lotes para o produto",
"description": "Desativa controle de lotes para o produto pelo ID do produto.",
"parameters": [
{
"$ref": "#/components/parameters/idProduto"
}
],
"responses": {
"200": {
"description": ""
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Lotes",
"x-api-action": "AlterarSituacao"
}
},
"/produtos/lotes/{idLote}/status": {
"patch": {
"tags": [
"Produtos - Lotes"
],
"summary": "Altera o status de um lote do produto",
"description": "Altera o status de um lote do produto pelo ID.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoteStatusDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Lotes",
"x-api-action": "AlterarSituacao"
}
},
"/produtos/lotes/{idLote}/lancamentos": {
"get": {
"tags": [
"Produtos - Lotes Lançamentos"
],
"summary": "Obtém os lançamentos de um lote de produto",
"description": "Obtém os lançamentos de um lote de produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idLote"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoteLancamentoDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "LotesLancamentos",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Produtos - Lotes Lançamentos"
],
"summary": "Cria um lançamento de um lote",
"description": "Inclui lançamento de um lote.",
"parameters": [
{
"$ref": "#/components/parameters/idLote"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoteLancamentoDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LoteLancamentoDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "LotesLancamentos",
"x-api-action": "Criar"
}
},
"/produtos/lotes/lancamentos/{idLancamento}": {
"get": {
"tags": [
"Produtos - Lotes Lançamentos"
],
"summary": "Obtém um lançamento de um lote de produto",
"description": "Obtém um lançamento de um lote de produto pelo ID do lançamento.",
"parameters": [
{
"$ref": "#/components/parameters/idLancamento"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LoteLancamentoDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "LotesLancamentos",
"x-api-action": "Obter"
},
"patch": {
"tags": [
"Produtos - Lotes Lançamentos"
],
"summary": "Altera a observação de um lançamento de um lote de um produto",
"description": "Altera a observação de um lançamento de um lote de um produto pelo ID do lançamento.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoteLancamentoObservacaoDTO"
}
}
}
},
"responses": {
"200": {
"description": ""
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "LotesLancamentos",
"x-api-action": "AlterarAtributo"
}
},
"/produtos/{idProduto}/lotes/{idLote}/depositos/{idDeposito}/saldo": {
"get": {
"tags": [
"Produtos - Lotes Lançamentos"
],
"summary": "Obtém o saldo de um lote de produto",
"description": "Obtém o saldo de um lote de produto.",
"parameters": [
{
"$ref": "#/components/parameters/idLote"
},
{
"$ref": "#/components/parameters/idProduto"
},
{
"$ref": "#/components/parameters/idDepositoInternal"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/SaldoLoteDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "LotesLancamentos",
"x-api-action": "ObterSaldosLote"
}
},
"/produtos/{idProduto}/lotes/depositos/{idDeposito}/saldo": {
"get": {
"tags": [
"Produtos - Lotes Lançamentos"
],
"summary": "Obtém os saldos dos lotes de um produto por depósito",
"description": "Obtém os saldos dos lotes de um produto por depósito.",
"parameters": [
{
"name": "idsLotes[]",
"in": "query",
"description": "IDs dos lotes",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"$ref": "#/components/parameters/idProduto"
},
{
"$ref": "#/components/parameters/idDepositoInternal"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SaldoLoteDTO"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "LotesLancamentos",
"x-api-action": "ObterSaldosLote"
}
},
"/produtos/{idProduto}/lotes/depositos/{idDeposito}/saldo/soma": {
"get": {
"tags": [
"Produtos - Lotes Lançamentos"
],
"summary": "Obtém a soma dos saldos dos lotes de um produto em um depósito",
"description": "Obtém a soma dos saldos dos lotes de um produto em um depósito.",
"parameters": [
{
"$ref": "#/components/parameters/idProduto"
},
{
"$ref": "#/components/parameters/idDepositoInternal"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SaldoSomaLotesDTO"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "LotesLancamentos",
"x-api-action": "ObterSaldosLote"
}
},
"/produtos/{idProduto}/lotes/saldo/soma": {
"get": {
"tags": [
"Produtos - Lotes Lançamentos"
],
"summary": "Obtém o saldo total dos lotes de um produto",
"description": "Obtém o saldo total dos lotes de um produto pelo ID do produto.",
"parameters": [
{
"$ref": "#/components/parameters/idProduto"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/SaldoSomaLotesTodosDepositosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "LotesLancamentos",
"x-api-action": "ObterSaldosLote"
}
},
"/formas-pagamentos": {
"get": {
"tags": [
"Formas de Pagamentos"
],
"summary": "Obtém formas de pagamentos",
"description": "Obtém formas de pagamentos paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "descricao",
"in": "query",
"description": "Descrição da forma de pagamento",
"required": false,
"schema": {
"type": "string",
"example": "Dinheiro"
}
},
{
"name": "tiposPagamentos[]",
"in": "query",
"description": "`1` Dinheiro
`2` Cheque
`3` Cartão de Crédito
`4` Cartão de Débito
`5` Cartão da Loja (Private Label)
`10` Vale Alimentação
`11` Vale Refeição
`12` Vale Presente
`13` Vale Combustível
`14` Duplicata Mercantil
`15` Boleto Bancário
`16` Depósito Bancário
`17` Pagamento Instantâneo (PIX) - Dinâmico
`18` Transferência Bancária, Carteira Digital
`19` Programa de Fidelidade, Cashback, Crédito Virtual
`20` Pagamento Instantâneo (PIX) – Estático
`21` Crédito em loja
`22` Pagamento Eletrônico não Informado - falha de hardware do sistema emissor
`90` Sem pagamento
`99` Outros",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"name": "situacao",
"in": "query",
"description": "`0` Inativa
`1` Ativa",
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormasPagamentosDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "FormasPagamentos",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Formas de Pagamentos"
],
"summary": "Cria uma forma de pagamento",
"description": "Cria uma forma de pagamento.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FormasPagamentosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/FormasPagamentosDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "FormasPagamentos",
"x-api-action": "Criar"
}
},
"/formas-pagamentos/{idFormaPagamento}": {
"get": {
"tags": [
"Formas de Pagamentos"
],
"summary": "Obtém uma forma de pagamento",
"description": "Obtém uma forma de pagamento pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idFormaPagamento"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FormasPagamentosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/FormasPagamentosDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "FormasPagamentos",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Formas de Pagamentos"
],
"summary": "Altera uma forma de pagamento",
"description": "Altera uma forma de pagamento pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idFormaPagamento"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FormasPagamentosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/FormasPagamentosDadosDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "FormasPagamentos",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Formas de Pagamentos"
],
"summary": "Remove uma forma de pagamento",
"description": "Remove uma forma de pagamento pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idFormaPagamento"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "FormasPagamentos",
"x-api-action": "Remover"
}
},
"/formas-pagamentos/{idFormaPagamento}/padrao": {
"patch": {
"tags": [
"Formas de Pagamentos"
],
"summary": "Altera o padrão de uma forma de pagamento",
"description": "Altera o padrão de uma forma de pagamento pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idFormaPagamento"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormasPagamentosDefinirPadraoDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "FormasPagamentos",
"x-api-action": "AlterarAtributo"
}
},
"/formas-pagamentos/{idFormaPagamento}/situacao": {
"patch": {
"tags": [
"Formas de Pagamentos"
],
"summary": "Altera a situação de uma forma de pagamento",
"description": "Altera a situação de uma forma de pagamento pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idFormaPagamento"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormasPagamentosAlterarSituacaoDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "FormasPagamentos",
"x-api-action": "AlterarSituacao"
}
},
"/homologacao/produtos": {
"get": {
"tags": [
"Homologação"
],
"summary": "Obtém o produto da homologação",
"description": "Obtém o produto que será utilizado durante os demais passos da homologação, e, inicia o processo de validação, o qual deve ser acompanhando via interface do cadastro de aplicativos.",
"responses": {
"200": {
"description": "",
"headers": {
"x-bling-homologacao": {
"$ref": "#/components/headers/x-bling-homologacao"
}
},
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/HomologacaoDadosBaseDTO"
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "Homologacao",
"x-api-action": "Obter"
},
"post": {
"tags": [
"Homologação"
],
"summary": "Cria o produto da homologação",
"description": "Cria o produto da homologação.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HomologacaoDadosBaseDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"headers": {
"x-bling-homologacao": {
"$ref": "#/components/headers/x-bling-homologacao"
}
},
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/HomologacaoDadosDTO"
},
{
"$ref": "#/components/schemas/HomologacaoDadosBaseDTO"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Homologacao",
"x-api-action": "Criar"
}
},
"/homologacao/produtos/{idProdutoHomologacao}": {
"put": {
"tags": [
"Homologação"
],
"summary": "Altera o produto da homologação",
"description": "Altera o produto da homologação pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoHomologacao"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HomologacaoDadosBaseDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content.",
"headers": {
"x-bling-homologacao": {
"$ref": "#/components/headers/x-bling-homologacao"
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Homologacao",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Homologação"
],
"summary": "Remove o produto da homologação",
"description": "Remove o produto da homologação pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoHomologacao"
}
],
"responses": {
"204": {
"description": "No content.",
"headers": {
"x-bling-homologacao": {
"$ref": "#/components/headers/x-bling-homologacao"
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Homologacao",
"x-api-action": "Remover"
}
},
"/homologacao/produtos/{idProdutoHomologacao}/situacoes": {
"patch": {
"tags": [
"Homologação"
],
"summary": "Altera a situação do produto da homologação",
"description": "Altera a situação do produto da homologação pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoHomologacao"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HomologacaoSituacaoDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content.",
"headers": {
"x-bling-homologacao": {
"$ref": "#/components/headers/x-bling-homologacao"
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Homologacao",
"x-api-action": "AlterarSituacao"
}
},
"/logisticas": {
"get": {
"tags": [
"Logísticas"
],
"summary": "Obtém logísticas",
"description": "Obtém logísticas paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "tipoIntegracao",
"in": "query",
"description": "Parâmetro para filtrar os registros através do tipo da logística.",
"required": false,
"schema": {
"type": "string",
"default": "",
"enum": [
"AmazonDBA",
"B2WEntrega",
"B2WO2O",
"Correios",
"CorreiosLog",
"CustomLogistic",
"DafitiMilkrun",
"Envvias",
"Frenet",
"FreteDescomplicado",
"Intelipost",
"Jadlog",
"Jamef",
"Kangu",
"LogisticaAliExpress",
"LogisticaShopee",
"Loggi",
"MagaluEntregas",
"Mandae",
"MelhorEnvio",
"MercadoEnvios",
"OlistFulfillment",
"TotalExpress"
]
}
},
{
"name": "tiposIntegracoes[]",
"in": "query",
"description": "Parâmetro para filtrar os registros através de uma lista de tipos de logística.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"MelhorEnvio",
"Correios"
]
}
},
{
"name": "situacao",
"in": "query",
"description": "Parâmetro para filtrar os registros através da situação
`H` Habilitado
`D` Desabilitado",
"required": false,
"schema": {
"type": "string",
"enum": [
"H",
"D"
]
}
},
{
"name": "logisticasReversas",
"in": "query",
"description": "Parâmetro para filtrar apenas as logísticas que possuem serviço de reversão. É sobrescrito pelo parâmetro tipoIntegracao, caso enviado junto.",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Logísticas"
],
"summary": "Cria logística",
"description": "Cria uma logística.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasDadosPostDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasLogisticaDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "Criar"
}
},
"/logisticas/{idLogistica}": {
"get": {
"tags": [
"Logísticas"
],
"summary": "Obtém uma logística",
"description": "Obtém uma logística pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idLogistica"
},
{
"name": "listarServicosInativos",
"in": "query",
"description": "Parâmetro para incluir serviços inativos na resposta.
`true` Inclui serviços ativos e inativos
`false` Inclui apenas serviços ativos (padrão)",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Logísticas"
],
"summary": "Altera uma logística",
"description": "Altera uma logística pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idLogistica"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasDadosPutDTO"
}
}
}
},
"responses": {
"200": {
"description": ""
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Logísticas"
],
"summary": "Remove uma logística",
"description": "Remove uma logística pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idLogistica"
}
],
"responses": {
"200": {
"description": ""
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "Remover"
}
},
"/logisticas/servicos": {
"get": {
"tags": [
"Logísticas - Serviços"
],
"summary": "Obtém serviços de logísticas",
"description": "Obtém serviços de logísticas paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "tipoIntegracao",
"in": "query",
"description": "Parâmetro para filtrar os registros através do tipo da logística.",
"required": false,
"schema": {
"type": "string",
"default": "",
"enum": [
"AmazonDBA",
"B2WEntrega",
"B2WO2O",
"Correios",
"CorreiosLog",
"CustomLogistic",
"DafitiMilkrun",
"Envvias",
"Frenet",
"FreteDescomplicado",
"Intelipost",
"Jadlog",
"Jamef",
"Kangu",
"LogisticaAliExpress",
"LogisticaShopee",
"Loggi",
"MagaluEntregas",
"Mandae",
"MelhorEnvio",
"MercadoEnvios",
"OlistFulfillment",
"TotalExpress",
""
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasServicosDadosDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "ObterServicoLogisticoMultiplos"
},
"post": {
"tags": [
"Logísticas - Serviços"
],
"summary": "Cria um serviço de logística",
"description": "Cria um serviço de logística personalizada.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasServicosDadosCreateRequestDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasServicosDadosSaveDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "CriarLogisticaServico"
}
},
"/logisticas/servicos/{idLogisticaServico}": {
"get": {
"tags": [
"Logísticas - Serviços"
],
"summary": "Obtém um servico de logística",
"description": "Obtém um servico de logística pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idLogisticaServico"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasServicosDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "ObterServicoLogistico"
},
"put": {
"tags": [
"Logísticas - Serviços"
],
"summary": "Altera um serviço de logística pelo ID",
"description": "Altera dados de um serviço de logística personalizada pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idLogisticaServico"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasServicosDadosSaveRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasServicosDadosSaveDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "AlterarLogisticaServico"
}
},
"/logisticas/{idLogisticaServico}/situacoes": {
"patch": {
"tags": [
"Logísticas - Serviços"
],
"summary": "Desativa ou ativa um serviço de uma logística",
"description": "Desativa ou ativa um serviço de uma logística personalizada pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idLogisticaServico"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasServicosDadosSituationDTO"
}
}
}
},
"responses": {
"204": {
"description": ""
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "AlterarSituacaoLogisticaServico"
}
},
"/logisticas/objetos/{idObjeto}": {
"get": {
"tags": [
"Logísticas - Objetos"
],
"summary": "Obtém um objeto de logística",
"description": "Obtém um objeto de logística pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idObjeto"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasObjetosDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "ObterObjetoLogistico"
},
"put": {
"tags": [
"Logísticas - Objetos"
],
"summary": "Altera um objeto de logística pelo ID",
"description": "Altera dados de um objeto de logística personalizada pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idObjeto"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasObjetosUpdateRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasObjetosObjetoDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "AlterarLogisticaObjeto"
},
"delete": {
"tags": [
"Logísticas - Objetos"
],
"summary": "Remove um objeto de logística personalizada",
"description": "Remove um objeto de logística personalizada que não esteja em uma PLP.",
"parameters": [
{
"$ref": "#/components/parameters/idObjeto"
}
],
"responses": {
"204": {
"description": ""
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "RemoverObjetoLogistico"
}
},
"/logisticas/objetos": {
"post": {
"tags": [
"Logísticas - Objetos"
],
"summary": "Cria um objeto de logística",
"description": "Cria um objeto de logística personalizada.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasObjetosDadosCreateRequestDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasObjetosObjetoDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "CriarLogisticaObjeto"
}
},
"/logisticas/etiquetas": {
"get": {
"tags": [
"Logísticas - Etiquetas"
],
"summary": "Obtém etiquetas das vendas",
"description": "Obtém as etiquetas dos pedidos de venda a partir dos ID's dos pedidos. No momento, o filtro está limitado para apenas um ID.",
"parameters": [
{
"name": "formato",
"in": "query",
"description": "Parâmetro para definir o formato do arquivo de impressão.
`PDF` - Formato PDF
`ZPL` - Formato ZPL",
"required": true,
"schema": {
"type": "string",
"enum": [
"PDF",
"ZPL"
]
}
},
{
"name": "idsVendas[]",
"in": "query",
"description": "IDs dos pedidos de venda para impressão",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
6423806085,
6423806084
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasEtiquetasDadosResponseDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "ObterEtiquetaMultiplos"
}
},
"/logisticas/remessas/{idRemessa}": {
"get": {
"tags": [
"Logísticas - Remessas"
],
"summary": "Obtém uma remessa de postagem",
"description": "Obtém uma remessa de postagem pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idRemessa"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasRemessasDadosBaseDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "ObterRemessa"
},
"put": {
"tags": [
"Logísticas - Remessas"
],
"summary": "Altera uma remessa de postagem",
"description": "Altera uma remessa de postagem pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idRemessa"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasRemessasDadosBaseDTOCommon"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasRemessaRemessaDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "AlterarRemessa"
},
"delete": {
"tags": [
"Logísticas - Remessas"
],
"summary": "Remove uma remessa de postagem",
"description": "Remove uma remessa de postagem pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idRemessa"
}
],
"responses": {
"204": {
"description": ""
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "RemoverRemessa"
}
},
"/logisticas/{idLogistica}/remessas": {
"get": {
"tags": [
"Logísticas - Remessas"
],
"summary": "Obtém as remessas de postagem de uma logística",
"description": "Obtém as remessas de postagem de uma logística pelo ID.",
"parameters": [
{
"name": "idLogistica",
"in": "path",
"description": "ID da logística",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasRemessasDadosDTO"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "ObterLogisticaRemessaMultiplos"
}
},
"/logisticas/remessas": {
"post": {
"tags": [
"Logísticas - Remessas"
],
"summary": "Cria uma remessa de postagem de uma logística",
"description": "Cria uma remessa de postagem de uma logística.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogisticasRemessasDadosPostDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/LogisticasRemessaRemessaDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Logisticas",
"x-api-action": "CriarRemessa"
}
},
"/naturezas-operacoes": {
"get": {
"tags": [
"Naturezas de Operações"
],
"summary": "Obtém naturezas de operações",
"description": "Obtém naturezas de operação paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "situacao",
"in": "query",
"description": "`0` Inativo
`1` Ativo",
"required": false,
"schema": {
"type": "integer",
"enum": [
0,
1
],
"example": 1
}
},
{
"name": "descricao",
"in": "query",
"description": "Descrição da natureza de operação",
"required": false,
"schema": {
"type": "string",
"example": "Compra de mercadoria"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NaturezasOperacoesDadosDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NaturezasOperacoes",
"x-api-action": "ObterMultiplos"
}
},
"/naturezas-operacoes/{idNaturezaOperacao}/obter-tributacao": {
"post": {
"tags": [
"Naturezas de Operações"
],
"summary": "Obtém regras de tributação da natureza de operação",
"description": "Obtém regras de tributação que incidem sobre o item, dada uma natureza de operação.",
"parameters": [
{
"name": "idNaturezaOperacao",
"in": "path",
"description": "ID da natureza de operação",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalculosImpostosCalculoDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/CalculosImpostosDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NaturezasOperacoes",
"x-api-action": "ObterTributacao"
}
},
"/nfce": {
"get": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Obtém notas fiscais de consumidor",
"description": "Obtém notas fiscais de consumidor paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "idTransportador",
"in": "query",
"description": "ID do contato do transportador",
"required": false,
"schema": {
"type": "integer",
"example": "12345678"
}
},
{
"name": "chaveAcesso",
"in": "query",
"description": "Chave de acesso",
"required": false,
"schema": {
"type": "integer",
"example": "35250145752681000182650010000266371238060760"
}
},
{
"name": "numero",
"in": "query",
"description": "Número da nota fiscal de consumidor",
"required": false,
"schema": {
"type": "integer",
"example": "1258"
}
},
{
"name": "serie",
"in": "query",
"description": "Série",
"required": false,
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "situacao",
"in": "query",
"description": "`1` Pendente
`2` Cancelada
`3` Aguardando recibo
`4` Rejeitada
`5` Autorizada
`6` Emitida DANFE
`7` Registrada
`8` Aguardando protocolo
`9` Denegada
`10` Consulta situação
`11` Bloqueada",
"required": false,
"schema": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"example": 1
}
},
{
"name": "dataEmissaoInicial",
"in": "query",
"description": "Data e hora inicial de emissão",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2021-12-01 00:00:00"
}
},
{
"name": "dataEmissaoFinal",
"in": "query",
"description": "Data e hora final de emissão",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2021-12-31 23:59:59"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Cria uma nota fiscal de consumidor",
"description": "Cria uma nota fiscal de consumidor.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NotasFiscaisDadosBaseDTO"
},
{
"$ref": "#/components/schemas/NotasFiscaisDadosPostDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/NotaFiscalResponse_POST"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "Criar"
}
},
"/nfce/{idNotaFiscalConsumidor}": {
"get": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Obtém uma nota fiscal de consumidor",
"description": "Obtém uma nota fiscal de consumidor pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscalConsumidor"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/NotasFiscaisDadosBaseDTO"
},
{
"$ref": "#/components/schemas/NotasFiscaisDadosGetDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Altera uma nota fiscal de consumidor",
"description": "Altera uma nota fiscal de consumidor.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscalConsumidor"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NotasFiscaisDadosBaseDTO"
},
{
"$ref": "#/components/schemas/NotasFiscaisDadosPostDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/NotaFiscalResponse_POST"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "Alterar"
}
},
"/nfce/{idNotaFiscalConsumidor}/enviar": {
"post": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Envia uma nota de consumidor",
"description": "Envia uma nota de consumidor pelo ID para emissão na Sefaz.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscalConsumidor"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"xml": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "Autorizar"
}
},
"/nfce/{idNotaFiscalConsumidor}/lancar-contas": {
"post": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Lança as contas de uma nota fiscal",
"description": "Lança as contas de uma nota fiscal pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscalConsumidor"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "LancarContas"
}
},
"/nfce/{idNotaFiscalConsumidor}/estornar-contas": {
"post": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Estorna as contas de uma nota fiscal",
"description": "Estorna as contas de uma nota fiscal pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscalConsumidor"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "EstornarContas"
}
},
"/nfce/{idNotaFiscalConsumidor}/lancar-estoque": {
"post": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Lança o estoque de uma nota fiscal no depósito padrão",
"description": "Lança o estoque de uma nota fiscal pelo ID, no depósito padrão.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscalConsumidor"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "LancarEstoque"
}
},
"/nfce/{idNotaFiscalConsumidor}/lancar-estoque/{idDeposito}": {
"post": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Lança o estoque de uma nota fiscal especificando o depósito",
"description": "Lança o estoque de uma nota fiscal pelo ID, especificando o ID do depósito.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscalConsumidor"
},
{
"$ref": "#/components/parameters/idDeposito"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "LancarEstoqueDeposito"
}
},
"/nfce/{idNotaFiscalConsumidor}/estornar-estoque": {
"post": {
"tags": [
"Notas Fiscais de Consumidor Eletrônicas"
],
"summary": "Estorna o estoque de uma nota fiscal",
"description": "Estorna o estoque de uma nota fiscal pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscalConsumidor"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "EstornarEstoque"
}
},
"/nfe": {
"get": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Obtém notas fiscais",
"description": "Obtém notas fiscais paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "numeroLoja",
"in": "query",
"description": "Número do pedido na loja",
"required": false,
"schema": {
"type": "string",
"example": "123455678"
}
},
{
"name": "idTransportador",
"in": "query",
"description": "ID do contato do transportador",
"required": false,
"schema": {
"type": "integer",
"example": "12345678"
}
},
{
"name": "chaveAcesso",
"in": "query",
"description": "Chave de acesso",
"required": false,
"schema": {
"type": "integer",
"example": "35250145752681000182650010000266371238060760"
}
},
{
"name": "numero",
"in": "query",
"description": "Número da nota fiscal",
"required": false,
"schema": {
"type": "integer",
"example": "158"
}
},
{
"name": "serie",
"in": "query",
"description": "Série",
"required": false,
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "situacao",
"in": "query",
"description": "`1` Pendente
`2` Cancelada
`3` Aguardando recibo
`4` Rejeitada
`5` Autorizada
`6` Emitida DANFE
`7` Registrada
`8` Aguardando protocolo
`9` Denegada
`10` Consulta situação
`11` Bloqueada
**Observação:** Caso este parâmetro não seja informado, as notas canceladas não serão incluídas na consulta.
",
"required": false,
"schema": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"example": 1
}
},
{
"name": "tipo",
"in": "query",
"description": "`0` Entrada
`1` Saída",
"required": false,
"schema": {
"type": "string",
"default": "1",
"enum": [
"0",
"1"
]
}
},
{
"name": "dataEmissaoInicial",
"in": "query",
"description": "Data e hora incial de emissão",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2021-12-01 00:00:00"
}
},
{
"name": "dataEmissaoFinal",
"in": "query",
"description": "Data e hora final de emissão",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2021-12-31 23:59:59"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Cria uma nota fiscal",
"description": "Cria uma nota fiscal.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NotasFiscaisDadosBaseDTO"
},
{
"$ref": "#/components/schemas/NotasFiscaisDadosPostDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/NotaFiscalResponse_POST"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "Criar"
},
"delete": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Remove múltiplas notas fiscais",
"description": "Remove múltiplas notas fiscais por IDs.",
"parameters": [
{
"name": "idsNotas[]",
"in": "query",
"description": "IDs das notas fiscais",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/NotasFiscaisExclusaoDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "RemoverMultiplos"
}
},
"/nfe/{idNotaFiscal}": {
"get": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Obtém uma nota fiscal",
"description": "Obtém uma nota fiscal pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscal"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/NotasFiscaisDadosBaseDTO"
},
{
"$ref": "#/components/schemas/NotasFiscaisDadosGetDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Altera uma nota fiscal",
"description": "Altera uma nota fiscal pelo ID. Notas com vínculos possuem restrições de atualização. Notas autorizadas não podem ter dados fiscais alterados: valores, impostos, informações do destinatário e qualquer outro dado transmitido no XML da nota.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscal"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NotasFiscaisDadosBaseDTO"
},
{
"$ref": "#/components/schemas/NotasFiscaisDadosPostDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/NotaFiscalResponse_POST"
},
{
"properties": {
"alertas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorField"
}
}
},
"type": "object"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "Alterar"
}
},
"/nfe/{idNotaFiscal}/enviar": {
"post": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Envia uma nota fiscal",
"description": "Envia uma nota fiscal pelo ID para emissão na Sefaz.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscal"
},
{
"name": "enviarEmail",
"in": "query",
"description": "Define se deve enviar email após a emissão da nota fiscal",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"xml": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "Autorizar"
}
},
"/nfe/{idNotaFiscal}/lancar-contas": {
"post": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Lança as contas de uma nota fiscal",
"description": "Lança as contas de uma nota fiscal pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscal"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "LancarContas"
}
},
"/nfe/{idNotaFiscal}/estornar-contas": {
"post": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Estorna as contas de uma nota fiscal",
"description": "Estorna as contas de uma nota fiscal pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscal"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "EstornarContas"
}
},
"/nfe/{idNotaFiscal}/lancar-estoque": {
"post": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Lança o estoque de uma nota fiscal no depósito padrão",
"description": "Lança o estoque de uma nota fiscal pelo ID, no depósito padrão.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscal"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "LancarEstoque"
}
},
"/nfe/{idNotaFiscal}/lancar-estoque/{idDeposito}": {
"post": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Lança o estoque de uma nota fiscal especificando o depósito",
"description": "Lança o estoque de uma nota fiscal pelo ID, especificando o ID do depósito.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscal"
},
{
"$ref": "#/components/parameters/idDeposito"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "LancarEstoqueDeposito"
}
},
"/nfe/{idNotaFiscal}/estornar-estoque": {
"post": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Estorna o estoque de uma nota fiscal",
"description": "Estorna o estoque de uma nota fiscal pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaFiscal"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "EstornarEstoque"
}
},
"/nfe/documento/{chaveAcesso}": {
"get": {
"tags": [
"Notas Fiscais Eletrônicas"
],
"summary": "Obtém o documento de uma nota fiscal",
"description": "Obtém o PDF ou XML de uma nota fiscal pela chave de acesso. O formato desejado deve ser informado via query param.",
"parameters": [
{
"$ref": "#/components/parameters/chaveAcesso"
},
{
"name": "formato",
"in": "query",
"description": "Formato do documento. `pdf` para o DANFE em PDF, `xml` para o XML da NF-e.",
"required": true,
"schema": {
"type": "string",
"enum": [
"pdf",
"xml"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisDocumentoDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NotasFiscais",
"x-api-action": "ObterDocumentoNotaFiscal"
}
},
"/nfse": {
"get": {
"tags": [
"Notas Fiscais de Serviço Eletrônicas"
],
"summary": "Obtém notas de serviços",
"description": "Obtém notas de serviços paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "situacao",
"in": "query",
"description": "`0` Pendente
`1` Emitida
`2` Disponível para consulta
`3` Cancelada",
"required": false,
"schema": {
"type": "integer",
"enum": [
1,
2,
3,
4
]
}
},
{
"name": "dataEmissaoInicial",
"in": "query",
"description": "Data incial do período de emissão",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-12-01"
}
},
{
"name": "dataEmissaoFinal",
"in": "query",
"description": "Data final do período de emissão",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-01"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosDadosBaseDTO"
}
]
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NFSe",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Notas Fiscais de Serviço Eletrônicas"
],
"summary": "Cria uma nota de serviço",
"description": "Cria uma nota de serviço.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosDadosBaseDTO_POST"
},
{
"$ref": "#/components/schemas/NotasServicosDadosDTO_POST"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/NotasServicosResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NFSe",
"x-api-action": "Criar"
}
},
"/nfse/{idNotaServico}": {
"get": {
"tags": [
"Notas Fiscais de Serviço Eletrônicas"
],
"summary": "Obtém uma nota de serviço",
"description": "Obtém uma nota de serviço pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaServico"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/NotasServicosDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NFSe",
"x-api-action": "Obter"
},
"delete": {
"tags": [
"Notas Fiscais de Serviço Eletrônicas"
],
"summary": "Exclui uma nota de serviço",
"description": "Exclui uma nota de serviço pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaServico"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NFSe",
"x-api-action": "Remover"
}
},
"/nfse/{idNotaServico}/enviar": {
"post": {
"tags": [
"Notas Fiscais de Serviço Eletrônicas"
],
"summary": "Envia uma nota de serviço",
"description": "Envia uma nota de serviço pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaServico"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/NotasServicosDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NFSe",
"x-api-action": "Autorizar"
}
},
"/nfse/{idNotaServico}/cancelar": {
"post": {
"tags": [
"Notas Fiscais de Serviço Eletrônicas"
],
"summary": "Cancela uma nota de serviço",
"description": "Cancela uma nota de serviço pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idNotaServico"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotasServicosCancelamentoDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NFSe",
"x-api-action": "Cancelar"
}
},
"/nfse/configuracoes": {
"get": {
"tags": [
"Notas Fiscais de Serviço Eletrônicas"
],
"summary": "Configurações de nota de serviço",
"description": "Obtém todas as configurações de nota de serviço.",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfiguracaoNotaServicoDadosBaseDTO"
}
}
}
}
},
"x-api-resource": "NFSe",
"x-api-action": "ObterConfiguracoes"
},
"put": {
"tags": [
"Notas Fiscais de Serviço Eletrônicas"
],
"summary": "Configurações de nota de serviço",
"description": "Cria e altera configurações para emissão de notas de serviço.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfiguracaoNotaServicoDadosBaseDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "NFSe",
"x-api-action": "AlterarConfiguracoes"
}
},
"/notificacoes": {
"get": {
"tags": [
"Notificações"
],
"summary": "Obtém todas as notificações de uma empresa em um período",
"description": "Obtém todas as notificações de uma empresa no período informado. Caso período não seja informado, será considerado o ano atual.",
"parameters": [
{
"name": "periodo",
"in": "query",
"description": "Apenas ano ou ano e mês em que a empresa foi notificada. Caso não informado, será utilizado o ano atual.",
"required": false,
"schema": {
"type": "string",
"example": "2023-01"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/NotificacoesUlidsDTO"
},
{
"$ref": "#/components/schemas/NotificacoesDadosBaseDTO"
}
]
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Notificacoes",
"x-api-action": "ObterMultiplos"
}
},
"/notificacoes/{idNotificacao}/confirmar-leitura": {
"post": {
"tags": [
"Notificações"
],
"summary": "Marca notificação como lida",
"description": "Marca a notificação relacionada à empresa como lida.",
"parameters": [
{
"name": "idNotificacao",
"in": "path",
"description": "ULID da notificação.",
"required": true,
"schema": {
"type": "string",
"example": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/NotificacoesUlidsDTO"
},
{
"$ref": "#/components/schemas/NotificacoesDadosBaseDTO"
}
]
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Notificacoes",
"x-api-action": "Alterar"
}
},
"/notificacoes/quantidade": {
"get": {
"tags": [
"Notificações"
],
"summary": "Obtém a quantidade de notificações de uma empresa em um período",
"description": "Obtém a quantidade de notificações de uma empresa no período informado. Caso período não seja informado, será considerado o ano atual.",
"parameters": [
{
"name": "periodo",
"in": "query",
"description": "Apenas ano ou ano e mês em que a empresa foi notificada. Caso não informado, será utilizado o ano atual.",
"required": false,
"schema": {
"type": "string",
"example": "2023-01"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/NotificacoesQuantidadeDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Notificacoes",
"x-api-action": "ObterMultiplos"
}
},
"/propostas-comerciais": {
"get": {
"tags": [
"Propostas Comerciais"
],
"summary": "Obtém propostas comerciais",
"description": "Obtém propostas comerciais paginadas.",
"parameters": [
{
"name": "situacao",
"in": "query",
"description": "O valor referente a situação da proposta: Pendente, Aguardando, Não aprovado, Aprovado, Concluido, Rascunho. Para mais situações, pesquisar pelo número separado por vírgula.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "idContato",
"in": "query",
"description": "ID do contato",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "dataInicial",
"in": "query",
"description": "Data inicial",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2020-08-24"
}
},
{
"name": "dataFinal",
"in": "query",
"description": "Data final",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2020-08-24"
}
},
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrcamentosDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "PropostasComerciais",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Propostas Comerciais"
],
"summary": "Cria uma proposta comercial",
"description": "Cria uma proposta comercial.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/OrcamentosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/OrcamentosDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PropostasComerciais",
"x-api-action": "Criar"
},
"delete": {
"tags": [
"Propostas Comerciais"
],
"summary": "Remove múltiplas propostas comerciais",
"description": "Remove múltiplas propostas comerciais pelos IDs.",
"parameters": [
{
"name": "idsPropostasComerciais[]",
"in": "query",
"description": "IDs das propostas comerciais",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"alertas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PropostasComerciais",
"x-api-action": "RemoverMultiplos"
}
},
"/propostas-comerciais/{idPropostaComercial}": {
"get": {
"tags": [
"Propostas Comerciais"
],
"summary": "Obtém uma proposta comercial",
"description": "Obtém uma proposta comercial pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPropostaComercial"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/OrcamentosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/OrcamentosDadosDTO"
}
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PropostasComerciais",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Propostas Comerciais"
],
"summary": "Altera uma proposta comercial",
"description": "Altera uma proposta comercial pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPropostaComercial"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/OrcamentosDadosBaseDTO"
},
{
"$ref": "#/components/schemas/OrcamentosDadosDTO"
}
]
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PropostasComerciais",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Propostas Comerciais"
],
"summary": "Remove uma proposta comercial",
"description": "Remove uma proposta comercial pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPropostaComercial"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PropostasComerciais",
"x-api-action": "Remover"
}
},
"/propostas-comerciais/{idPropostaComercial}/situacoes": {
"patch": {
"tags": [
"Propostas Comerciais"
],
"summary": "Altera a situação de uma proposta comercial",
"description": "Altera a situação de uma proposta comercial pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPropostaComercial"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrcamentosSituacaoDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PropostasComerciais",
"x-api-action": "AlterarSituacao"
}
},
"/pedidos/compras": {
"get": {
"tags": [
"Pedidos - Compras"
],
"summary": "Obtém pedidos de compras",
"description": "Obtém pedidos de compras paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "idFornecedor",
"in": "query",
"description": "ID do contato do tipo fornecedor",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "valorSituacao",
"in": "query",
"description": "Valor da situação",
"required": false,
"schema": {
"type": "integer",
"example": 1
}
},
{
"name": "idSituacao",
"in": "query",
"description": "ID da situação",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "dataInicial",
"in": "query",
"description": "Data inicial do período da compra",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-01"
}
},
{
"name": "dataFinal",
"in": "query",
"description": "Data final do período da compra",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-01"
}
},
{
"name": "idsNotasFiscais[]",
"in": "query",
"description": "IDs das notas fiscais de entrada",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/PedidosComprasDadosBaseDTO"
}
]
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Pedidos - Compras"
],
"summary": "Cria um pedido de compra",
"description": "Cria um pedido de compra.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PedidosComprasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/PedidosComprasDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/PedidosCompraResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "Criar"
}
},
"/pedidos/compras/{idPedidoCompra}": {
"get": {
"tags": [
"Pedidos - Compras"
],
"summary": "Obtém um pedido de compra",
"description": "Obtém um pedido de compra pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoCompra"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PedidosComprasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/PedidosComprasDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Pedidos - Compras"
],
"summary": "Altera um pedido de compra",
"description": "Altera um pedido de compra pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoCompra"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PedidosComprasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/PedidosComprasDadosDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/PedidosCompraResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Pedidos - Compras"
],
"summary": "Remove um pedido de compra",
"description": "Remove um pedido de compra pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoCompra"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "Remover"
}
},
"/pedidos/compras/{idPedidoCompra}/situacoes/{idSituacao}": {
"patch": {
"tags": [
"Pedidos - Compras"
],
"summary": "Altera a situação de um pedido de compra",
"description": "Altera a situação de um pedido de compra pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoCompra"
},
{
"name": "idSituacao",
"in": "path",
"description": "ID da situação do pedido de compra",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "AlterarSituacao"
}
},
"/pedidos/compras/{idPedidoCompra}/lancar-contas": {
"post": {
"tags": [
"Pedidos - Compras"
],
"summary": "Lança as contas de um pedido de compra",
"description": "Lança as contas de um pedido de compra pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoCompra"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "LancarContas"
}
},
"/pedidos/compras/{idPedidoCompra}/estornar-contas": {
"post": {
"tags": [
"Pedidos - Compras"
],
"summary": "Estorna as contas de um pedido de compra",
"description": "Estorna as contas de um pedido de compra pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoCompra"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "EstornarContas"
}
},
"/pedidos/compras/{idPedidoCompra}/lancar-estoque": {
"post": {
"tags": [
"Pedidos - Compras"
],
"summary": "Lança o estoque de um pedido de compra",
"description": "Lança o estoque de um pedido de compra pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoCompra"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "LancarEstoque"
}
},
"/pedidos/compras/{idPedidoCompra}/estornar-estoque": {
"post": {
"tags": [
"Pedidos - Compras"
],
"summary": "Estorna o estoque de um pedido de compra",
"description": "Estorna o estoque de um pedido de compra pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoCompra"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosCompra",
"x-api-action": "EstornarEstoque"
}
},
"/produtos/estruturas/{idProdutoEstrutura}": {
"get": {
"tags": [
"Produtos - Estruturas"
],
"summary": "Obtém a estrutura de um produto com composição",
"description": "Obtém a estrutura de um produto com composição pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoEstrutura"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProdutosEstruturaDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosEstruturas",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Produtos - Estruturas"
],
"summary": "Altera a estrutura de um produto com composição",
"description": "Altera a estrutura de um produto com composição pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoEstrutura"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosEstruturaDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosEstruturas",
"x-api-action": "Alterar"
}
},
"/produtos/estruturas/{idProdutoEstrutura}/componentes": {
"post": {
"tags": [
"Produtos - Estruturas"
],
"summary": "Adiciona componente(s) a uma estrutura",
"description": "Adiciona múltiplos componentes a uma estrutura pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoEstrutura"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosComponenteDTO"
}
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosEstruturas",
"x-api-action": "VincularComponenteMultiplos"
},
"delete": {
"tags": [
"Produtos - Estruturas"
],
"summary": "Remove componentes específicos de um produto com composição",
"description": "Remove os componentes de um produto com composição pelos IDs dos componentes.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoEstrutura"
},
{
"name": "idsComponentes[]",
"in": "query",
"description": "IDs dos produtos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosEstruturas",
"x-api-action": "RemoverComponenteMultiplos"
}
},
"/produtos/estruturas/{idProdutoEstrutura}/componentes/{idComponente}": {
"patch": {
"tags": [
"Produtos - Estruturas"
],
"summary": "Altera um componente de uma estrutura",
"description": "Altera um componente de uma estrutura pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoEstrutura"
},
{
"$ref": "#/components/parameters/idComponente"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosComponenteDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosEstruturas",
"x-api-action": "AlterarComponente"
}
},
"/produtos/estruturas": {
"delete": {
"tags": [
"Produtos - Estruturas"
],
"summary": "Remove a estrutura de múltiplos produtos",
"description": "Remove a estrutura de múltiplos produtos com composição pelos IDs.",
"parameters": [
{
"name": "idsProdutos[]",
"in": "query",
"description": "IDs dos produtos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"alertas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosEstruturas",
"x-api-action": "RemoverMultiplos"
}
},
"/produtos/fornecedores": {
"get": {
"tags": [
"Produtos - Fornecedores"
],
"summary": "Obtém produtos fornecedores",
"description": "Obtém produtos fornecedores paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "idProduto",
"in": "query",
"description": "ID do produto",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idFornecedor",
"in": "query",
"description": "ID do contato do tipo fornecedor",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ProdutosFornecedoresDadosBaseDTO"
}
]
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "ProdutosFornecedores",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Produtos - Fornecedores"
],
"summary": "Cria um produto fornecedor",
"description": "Cria um produto fornecedor.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProdutosFornecedoresDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ProdutosFornecedoresDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosFornecedores",
"x-api-action": "Criar"
}
},
"/produtos/fornecedores/{idProdutoFornecedor}": {
"get": {
"tags": [
"Produtos - Fornecedores"
],
"summary": "Obtém um produto fornecedor",
"description": "Obtém um produto fornecedor pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoFornecedor"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ProdutosFornecedoresDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ProdutosFornecedoresDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosFornecedores",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Produtos - Fornecedores"
],
"summary": "Altera um produto fornecedor",
"description": "Altera um produto fornecedor pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoFornecedor"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProdutosFornecedoresDadosBaseUpdateDTO"
},
{
"$ref": "#/components/schemas/ProdutosFornecedoresDadosUpdateDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosFornecedores",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Produtos - Fornecedores"
],
"summary": "Remove um produto fornecedor",
"description": "Remove um produto fornecedor pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoFornecedor"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosFornecedores",
"x-api-action": "Remover"
}
},
"/produtos/lojas": {
"get": {
"tags": [
"Produtos - Lojas"
],
"summary": "Obtém vínculos de produtos com lojas",
"description": "Obtém vínculos de produtos com lojas paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "idProduto",
"in": "query",
"description": "ID do produto",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idLoja",
"in": "query",
"description": "ID da loja",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idCategoriaProduto",
"in": "query",
"description": "ID da categoria do produto vinculada à loja",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "dataAlteracaoInicial",
"in": "query",
"description": "Data de alteração inicial",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2020-01-01 10:00:00"
}
},
{
"name": "dataAlteracaoFinal",
"in": "query",
"description": "Data de alteração final",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2020-01-01 11:00:00"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosLojasDadosDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosLojas",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Produtos - Lojas"
],
"summary": "Cria o vínculo de um produto com uma loja",
"description": "Cria o vínculo de um produto com uma loja.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProdutosLojasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ProdutosLojasDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/ProdutosLojasResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosLojas",
"x-api-action": "Criar"
}
},
"/produtos/lojas/{idProdutoLoja}": {
"get": {
"tags": [
"Produtos - Lojas"
],
"summary": "Obtém um vínculo de produto com loja",
"description": "Obtém um vínculo de produto com loja pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoLoja"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ProdutosLojasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ProdutosLojasDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosLojas",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Produtos - Lojas"
],
"summary": "Altera o vínculo de um produto com uma loja",
"description": "Altera o vínculo de um produto com uma loja pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoLoja"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProdutosLojasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ProdutosLojasDadosDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/ProdutosLojasResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosLojas",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Produtos - Lojas"
],
"summary": "Remove o vínculo de um produto com uma loja",
"description": "Remove o vínculo de um produto com uma loja pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoLoja"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosLojas",
"x-api-action": "Remover"
}
},
"/produtos": {
"get": {
"tags": [
"Produtos"
],
"summary": "Obtém produtos",
"description": "Obtém produtos paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "criterio",
"in": "query",
"description": "Critério de listagem
`1` Últimos incluídos
`2` Ativos
`3` Inativos
`4` Excluídos
`5` Todos",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"enum": [
1,
2,
3,
4,
5
]
}
},
{
"name": "tipo",
"in": "query",
"description": "`T` Todos
`P` Produtos
`S` Serviços
`E` Composições
`PS` Produtos simples
`C` Com variações
`V` Variações",
"required": false,
"schema": {
"type": "string",
"default": "T",
"enum": [
"T",
"P",
"S",
"E",
"PS",
"C",
"V"
]
}
},
{
"name": "idComponente",
"in": "query",
"description": "ID do componente. Utilizado quando o filtro **tipo** for `E`.",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "dataInclusaoInicial",
"in": "query",
"description": "Data de inclusão inicial",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2020-01-01 12:00:00"
}
},
{
"name": "dataInclusaoFinal",
"in": "query",
"description": "Data de inclusão final",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2020-01-01 13:00:00"
}
},
{
"name": "dataAlteracaoInicial",
"in": "query",
"description": "Data de alteração inicial",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2020-01-01 10:00:00"
}
},
{
"name": "dataAlteracaoFinal",
"in": "query",
"description": "Data de alteração final",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2020-01-01 11:00:00"
}
},
{
"name": "idCategoria",
"in": "query",
"description": "ID da categoria do produto",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idLoja",
"in": "query",
"description": "ID da loja",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "nome",
"in": "query",
"description": "Nome do produto",
"required": false,
"schema": {
"type": "string",
"example": " "
}
},
{
"name": "idsProdutos[]",
"in": "query",
"description": "IDs dos produtos",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"name": "codigos[]",
"in": "query",
"description": "Códigos (SKU) dos produtos",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SKU1",
"SKU2"
]
}
},
{
"name": "gtins[]",
"in": "query",
"description": "GTINs/EANs dos produtos",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"7891234567890",
"7891234567891"
]
}
},
{
"$ref": "#/components/parameters/filtroSaldoEstoque"
},
{
"$ref": "#/components/parameters/filtroSaldoEstoqueDeposito"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Produtos"
],
"summary": "Cria um produto",
"description": "Cria um produto.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosDadosDTO"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosResponse_POST_PUT"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "Criar"
},
"delete": {
"tags": [
"Produtos"
],
"summary": "Remove múltiplos produtos",
"description": "Remove múltiplos produtos pelos IDs.",
"parameters": [
{
"name": "idsProdutos[]",
"in": "query",
"description": "IDs dos produtos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProdutosAlertasResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "RemoverMultiplos"
}
},
"/produtos/{idProduto}": {
"get": {
"tags": [
"Produtos"
],
"summary": "Obtém um produto",
"description": "Obtém um produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProduto"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProdutosDadosDTO"
}
},
"type": "object"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Produtos"
],
"summary": "Altera um produto",
"description": "Altera um produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProduto"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosDadosDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosResponse_POST_PUT"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Produtos"
],
"summary": "Remove um produto",
"description": "Remove um produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProduto"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "Remover"
},
"patch": {
"tags": [
"Produtos"
],
"summary": "Altera parcialmente um produto",
"description": "Altera parcialmente um produto pelo ID. Somente os campos informados terão o valor alterado.",
"parameters": [
{
"$ref": "#/components/parameters/idProduto"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosDadosPatchDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosResponse_POST_PUT"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "Alterar"
}
},
"/produtos/{idProduto}/situacoes": {
"patch": {
"tags": [
"Produtos"
],
"summary": "Altera a situação de um produto",
"description": "Altera a situação de um produto pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idProduto"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"situacao": {
"description": "Situação do produto
`A` Ativo
`I` Inativo
'E' Excluído",
"type": "string",
"enum": [
"A",
"I",
"E"
],
"example": "A"
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "AlterarSituacao"
}
},
"/produtos/situacoes": {
"post": {
"tags": [
"Produtos"
],
"summary": "Altera a situação de múltiplos produtos",
"description": "Altera a situação de múltiplos produtos pelos IDs.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"idsProdutos": {
"type": "array",
"items": {
"type": "integer",
"example": 12345678
}
},
"situacao": {
"description": "Situação do produto
`A` Ativo
`I` Inativo
'E' Excluído",
"type": "string",
"enum": [
"A",
"I",
"E"
],
"example": "A"
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProdutosAlertasResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Produtos",
"x-api-action": "AlterarSituacaoMultiplos"
}
},
"/produtos/variacoes/{idProdutoPai}": {
"get": {
"tags": [
"Produtos - Variações"
],
"summary": "Obtém o produto e variações",
"description": "Obtém o produto e variações pelo ID do produto pai.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoPai"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProdutosDadosDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosVariacoes",
"x-api-action": "ObterMultiplos"
}
},
"/produtos/variacoes/atributos/gerar-combinacoes": {
"post": {
"tags": [
"Produtos - Variações"
],
"summary": "Retorna o produto pai com combinações de novas variações",
"description": "Ação responsável por retornar o produto pai com combinação de novas variações a partir dos atributos. Esta ação não persistirá os dados.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosVariacoesCombinacaoDadosDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProdutosDadosDTO"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosVariacoes",
"x-api-action": "GerarCombinacoes"
}
},
"/produtos/variacoes/{idProdutoPai}/atributos": {
"patch": {
"tags": [
"Produtos - Variações"
],
"summary": "Altera o nome do atributo nas variações",
"description": "Altera o nome do atributo nas variações de um produto pai.",
"parameters": [
{
"$ref": "#/components/parameters/idProdutoPai"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProdutosVariacoesDadosAtributoDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasePostResponse"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ProdutosVariacoes",
"x-api-action": "AlterarAtributo"
}
},
"/situacoes/modulos": {
"get": {
"tags": [
"Situações - Módulos"
],
"summary": "Obtém módulos",
"description": "Obtém módulos.",
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SituacoesModuloBaseDTO"
},
{
"$ref": "#/components/schemas/SituacoesModuloDTO"
}
]
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "SituacoesModulos",
"x-api-action": "ObterMultiplos"
}
},
"/situacoes/modulos/{idModuloSistema}": {
"get": {
"tags": [
"Situações - Módulos"
],
"summary": "Obtém situações de um módulo",
"description": "Obtém situações de um módulo pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idModuloSistema"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SituacoesDTO"
},
{
"$ref": "#/components/schemas/SituacoesDadosDTO"
}
]
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "SituacoesModulos",
"x-api-action": "Obter"
}
},
"/situacoes/modulos/{idModuloSistema}/acoes": {
"get": {
"tags": [
"Situações - Módulos"
],
"summary": "Obtém as ações de um módulo",
"description": "Obtém as ações de um módulo pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idModuloSistema"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SituacoesAcaoDTO"
}
]
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "SituacoesModulos",
"x-api-action": "ObterAcaoMultiplos"
}
},
"/situacoes/modulos/{idModuloSistema}/transicoes": {
"get": {
"tags": [
"Situações - Módulos"
],
"summary": "Obtém as transições de um módulo",
"description": "Obtém as transições de um módulo pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idModuloSistema"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/SituacoesTransicaoDTO"
}
]
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "SituacoesModulos",
"x-api-action": "ObterTransicaoMultiplos"
}
},
"/situacoes/{idSituacao}": {
"get": {
"tags": [
"Situações"
],
"summary": "Obtém uma situação",
"description": "Obtém uma situação pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idSituacao"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SituacoesDTO"
},
{
"$ref": "#/components/schemas/SituacoesDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Situacoes",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Situações"
],
"summary": "Altera uma situação",
"description": "Altera uma situação pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idSituacao"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"idModuloSistema": {
"type": "integer",
"example": 6423808065
},
"nome": {
"type": "string",
"example": "Finalizado"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/SituacoesDadosDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Situacoes",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Situações"
],
"summary": "Remove uma situação",
"description": "Remove uma situação pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idSituacao"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Situacoes",
"x-api-action": "Remover"
}
},
"/situacoes": {
"post": {
"tags": [
"Situações"
],
"summary": "Cria uma situação",
"description": "Cria uma situação.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"idModuloSistema": {
"type": "integer",
"example": 6423808065
},
"nome": {
"type": "string",
"example": "Finalizado"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/SituacoesDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Situacoes",
"x-api-action": "Criar"
}
},
"/situacoes/transicoes/{idTransicao}": {
"get": {
"tags": [
"Situações - Transições"
],
"summary": "Obtém uma transição",
"description": "Obtém uma transição pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idTransicao"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/SituacoesTransicaoDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "SituacoesTransicoes",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Situações - Transições"
],
"summary": "Altera uma transição",
"description": "Altera uma transição pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idTransicao"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SituacoesTransicaoDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "SituacoesTransicoes",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Situações - Transições"
],
"summary": "Remove uma transição",
"description": "Remove uma transição pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idTransicao"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "SituacoesTransicoes",
"x-api-action": "Remover"
}
},
"/situacoes/transicoes": {
"post": {
"tags": [
"Situações - Transições"
],
"summary": "Cria uma transição",
"description": "Cria uma transição.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SituacoesTransicaoDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "SituacoesTransicoes",
"x-api-action": "Criar"
}
},
"/usuarios/recuperar-senha": {
"post": {
"tags": [
"Usuários"
],
"summary": "Envia solicitação de recuperação de senha",
"description": "Envia solicitação de recuperação de senha por e-mail.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"email"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"message": {
"type": "string",
"example": "Caso o e-mail informado esteja cadastrado em nosso sistema, uma mensagem com instruções para a troca de senha será enviada."
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/usuarios/redefinir-senha": {
"patch": {
"tags": [
"Usuários"
],
"summary": "Redefine senha do usuário",
"description": "Redefine senha do usuário utilizando token enviado por e-mail.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"hash",
"password"
]
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/usuarios/verificar-hash": {
"get": {
"tags": [
"Usuários"
],
"summary": "Valida o hash recebido",
"description": "Valida o hash recebido por e-mail.",
"parameters": [
{
"name": "hash",
"in": "query",
"required": true,
"schema": {
"type": "string",
"example": "da24312119016fab3d3e8bf52409db4b"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"valido": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/pedidos/vendas": {
"get": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Obtém pedidos de vendas",
"description": "Obtém pedidos de vendas paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "idContato",
"in": "query",
"description": "ID do contato",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idsSituacoes[]",
"in": "query",
"description": "Conjunto de situações",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
{
"name": "dataInicial",
"in": "query",
"description": "Data incial",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-01"
}
},
{
"name": "dataFinal",
"in": "query",
"description": "Data final",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-15"
}
},
{
"name": "dataAlteracaoInicial",
"in": "query",
"description": "Data inicial da alteração",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2022-01-01 10:00:00"
}
},
{
"name": "dataAlteracaoFinal",
"in": "query",
"description": "Data final da alteração",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2022-01-15 11:00:00"
}
},
{
"name": "dataPrevistaInicial",
"in": "query",
"description": "Data inicial prevista",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-01"
}
},
{
"name": "dataPrevistaFinal",
"in": "query",
"description": "Data final prevista",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2022-01-15"
}
},
{
"name": "numero",
"in": "query",
"description": "Número do pedido de venda",
"required": false,
"schema": {
"type": "integer",
"example": "12345"
}
},
{
"name": "idLoja",
"in": "query",
"description": "ID da loja",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idVendedor",
"in": "query",
"description": "ID do vendedor",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idControleCaixa",
"in": "query",
"description": "ID do controle de caixa",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "numerosLojas[]",
"in": "query",
"description": "Conjunto de números de pedidos nas lojas",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12345",
"54321"
]
}
},
{
"name": "idUnidadeNegocio",
"in": "query",
"description": "ID da unidade de negócio (filial)",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/VendasDadosBaseDTO"
}
]
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Cria um pedido de venda",
"description": "Cria um pedido de venda.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/VendasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/VendasDadosDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/VendasResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "Criar"
},
"delete": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Remove pedidos de vendas",
"description": "Remove pedidos de vendas pelos IDs.",
"parameters": [
{
"name": "idsPedidosVendas[]",
"in": "query",
"description": "IDs dos pedidos de vendas",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"alertas": {
"type": "array",
"items": {
"type": "string",
"example": "A venda número 123 contém contas a receber..."
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "RemoverMultiplos"
}
},
"/pedidos/vendas/{idPedidoVenda}": {
"get": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Obtém um pedido de venda",
"description": "Obtém um pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/VendasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/VendasDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Altera um pedido de venda",
"description": "Altera um pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/VendasDadosBaseDTO_PUT"
},
{
"$ref": "#/components/schemas/VendasDadosDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BasePostResponse"
},
{
"$ref": "#/components/schemas/VendasResponse_POST_PUT"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Remove um pedido de venda",
"description": "Remove um pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "Remover"
}
},
"/pedidos/vendas/{idPedidoVenda}/situacoes/{idSituacao}": {
"patch": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Altera a situação de um pedido de venda",
"description": "Altera a situação de um pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
},
{
"name": "idSituacao",
"in": "path",
"description": "ID da situação do pedido de venda",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "AlterarSituacao"
}
},
"/pedidos/vendas/{idPedidoVenda}/lancar-estoque/{idDeposito}": {
"post": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Lança o estoque de um pedido de venda especificando o depósito",
"description": "Lança o estoque de um pedido de venda pelo ID, especificando o ID do depósito.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
},
{
"name": "idDeposito",
"in": "path",
"description": "ID do depósito de estoque",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "LancarEstoqueDeposito"
}
},
"/pedidos/vendas/{idPedidoVenda}/lancar-estoque": {
"post": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Lança o estoque de um pedido de venda no depósito padrão",
"description": "Lança o estoque de um pedido de venda pelo ID, no depósito padrão.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "LancarEstoque"
}
},
"/pedidos/vendas/{idPedidoVenda}/estornar-estoque": {
"post": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Estorna o estoque de um pedido de venda",
"description": "Estorna o estoque de um pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "EstornarEstoque"
}
},
"/pedidos/vendas/{idPedidoVenda}/lancar-contas": {
"post": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Lança as contas de um pedido de venda",
"description": "Lança as contas de um pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "LancarContas"
}
},
"/pedidos/vendas/{idPedidoVenda}/estornar-contas": {
"post": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Estorna as contas de um pedido de venda",
"description": "Estorna as contas de um pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "EstornarContas"
}
},
"/pedidos/vendas/{idPedidoVenda}/gerar-nfe": {
"post": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Gera nota fiscal eletrônica a partir do pedido de venda",
"description": "Gera nota fiscal eletrônica a partir do pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendasCreateInvoiceResponseDTO"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "GerarNotaFiscal"
}
},
"/pedidos/vendas/{idPedidoVenda}/gerar-nfce": {
"post": {
"tags": [
"Pedidos - Vendas"
],
"summary": "Gera nota fiscal de consumidor eletrônica a partir do pedido de venda",
"description": "Gera nota fiscal de consumidor eletrônica a partir do pedido de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idPedidoVenda"
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendasCreateInvoiceResponseDTO"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "PedidosVenda",
"x-api-action": "GerarNotaFiscalConsumidor"
}
},
"/vendedores": {
"get": {
"tags": [
"Vendedores"
],
"summary": "Obtém vendedores",
"description": "Obtém vendedores paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "nomeContato",
"in": "query",
"description": "Nome do contato do vendedor",
"required": false,
"schema": {
"type": "string",
"example": " "
}
},
{
"name": "situacaoContato",
"in": "query",
"description": "Situação do contato do vendedor
`A` Ativo
`I` Inativo
`S` Sem movimento
`E` Excluído
`T` Todos",
"required": false,
"schema": {
"type": "string",
"default": "A",
"enum": [
"A",
"I",
"S",
"E",
"T"
]
}
},
{
"name": "idContato",
"in": "query",
"description": "ID do contato do vendedor",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "idLoja",
"in": "query",
"description": "ID da loja vinculada ao vendedor",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
{
"name": "dataAlteracaoInicial",
"in": "query",
"description": "Data de alteração inicial",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
},
{
"name": "dataAlteracaoFinal",
"in": "query",
"description": "Data de alteração final",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "YYYY-MM-DD hh:mm:ss"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/VendedoresDadosBaseDTO"
}
]
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "Vendedores",
"x-api-action": "ObterMultiplos"
}
},
"/vendedores/{idVendedor}": {
"get": {
"tags": [
"Vendedores"
],
"summary": "Obtém um vendedor",
"description": "Obtém um vendedor pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idVendedor"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/VendedoresDadosBaseDTO"
},
{
"$ref": "#/components/schemas/VendedoresDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Vendedores",
"x-api-action": "Obter"
}
},
"/contas/pagar": {
"get": {
"tags": [
"Contas a Pagar"
],
"summary": "Obtém contas a pagar",
"description": "Obtém contas a pagar paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "dataEmissaoInicial",
"in": "query",
"description": "Data de emissão inicial da conta a pagar",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
{
"name": "dataEmissaoFinal",
"in": "query",
"description": "Data de emissão final da conta a pagar",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
{
"name": "dataVencimentoInicial",
"in": "query",
"description": "Data de vencimento inicial da conta a pagar",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
{
"name": "dataVencimentoFinal",
"in": "query",
"description": "Data de vencimento final da conta a pagar",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
{
"name": "dataPagamentoInicial",
"in": "query",
"description": "Data de pagamento inicial da conta",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
{
"name": "dataPagamentoFinal",
"in": "query",
"description": "Data de pagamento final da conta",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
{
"name": "situacao",
"in": "query",
"description": "`1` Em aberto
`2` Recebido
`3` Parcialmente recebido
`4` Devolvido
`5` Cancelado",
"required": false,
"schema": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5
],
"example": 1
}
},
{
"name": "idContato",
"in": "query",
"description": "ID do contato",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContasDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "ContasPagar",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Contas a Pagar"
],
"summary": "Cria uma conta a pagar",
"description": "Cria uma conta a pagar.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContasPagarDadosDTO"
},
{
"$ref": "#/components/schemas/ContasPagarDadosPostDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BasePostResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasPagar",
"x-api-action": "Criar"
}
},
"/contas/pagar/{idContaPagar}": {
"get": {
"tags": [
"Contas a Pagar"
],
"summary": "Obtém uma conta a pagar",
"description": "Obtém uma conta a pagar pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContaPagar"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ContasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContasPagarDadosDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasPagar",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Contas a Pagar"
],
"summary": "Atualiza uma conta a pagar",
"description": "Atualiza uma conta a pagar pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContaPagar"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContasDadosBaseDTO"
},
{
"$ref": "#/components/schemas/ContasPagarDadosDTO"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BasePostResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasPagar",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Contas a Pagar"
],
"summary": "Remove uma conta a pagar",
"description": "Remove uma conta a pagar pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idContaPagar"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasPagar",
"x-api-action": "Remover"
}
},
"/contas/pagar/{idContaPagar}/baixar": {
"post": {
"tags": [
"Contas a Pagar"
],
"summary": "Cria o recebimento de uma conta a pagar",
"description": "Cria o recebimento de uma conta a pagar.",
"parameters": [
{
"$ref": "#/components/parameters/idContaPagar"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContasBaixarContaDTO"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"bordero": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "ContasPagar",
"x-api-action": "BaixarConta"
}
},
"/canais-venda": {
"get": {
"tags": [
"Canais de Venda"
],
"summary": "Obtém canais de venda",
"description": "Obtém canais de venda paginados.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "tipos[]",
"in": "query",
"description": "Parâmetro para filtrar os registros através de uma lista de tipos de canal de venda.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"LojaIntegrada",
"Shopee"
]
}
},
{
"name": "situacao",
"in": "query",
"description": "Parâmetro para filtrar os registros através da situação
`1` Habilitado
`2` Desabilitado",
"required": false,
"schema": {
"type": "integer",
"enum": [
1,
2
]
}
},
{
"$ref": "#/components/parameters/agrupador"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CanalVendaDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CanaisVendas",
"x-api-action": "ObterMultiplos"
}
},
"/canais-venda/{idCanalVenda}": {
"get": {
"tags": [
"Canais de Venda"
],
"summary": "Obtém um canal de venda",
"description": "Obtém uma canal de venda pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idCanalVenda"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/CanalVendaCanalVendaDTO"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "CanaisVendas",
"x-api-action": "Obter"
}
},
"/canais-venda/tipos": {
"get": {
"tags": [
"Canais de Venda"
],
"summary": "Obtém os tipos de canais de venda",
"description": "Obtém os tipos de canais de venda paginados.",
"parameters": [
{
"$ref": "#/components/parameters/agrupador"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CanalVendaTipoIntegracaoDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "CanaisVendas",
"x-api-action": "ObterTiposCanaisVenda"
}
},
"/ordens-producao": {
"get": {
"tags": [
"Ordens de Produção"
],
"summary": "Obtém ordens de produção",
"description": "Obtém ordens de produção paginadas.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
},
{
"name": "idsSituacoes[]",
"in": "query",
"description": "IDs das situações",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrdensProducaoDadosBaseDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "OrdensProducao",
"x-api-action": "ObterAcaoMultiplos"
},
"post": {
"tags": [
"Ordens de Produção"
],
"summary": "Cria uma ordem de produção",
"description": "Cria uma ordem de produção.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/OrdensProducaoDadosBaseDTO"
},
{
"$ref": "#/components/schemas/OrdensProducaoDadosPostDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "OrdensProducao",
"x-api-action": "Criar"
}
},
"/ordens-producao/{idOrdemProducao}": {
"get": {
"tags": [
"Ordens de Produção"
],
"summary": "Obtém uma ordem de produção",
"description": "Obtém uma ordem de produção pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idOrdemProducao"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/OrdensProducaoDadosBaseDTO"
},
{
"$ref": "#/components/schemas/OrdensProducaoDadosDTO"
}
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "OrdensProducao",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Ordens de Produção"
],
"summary": "Altera uma ordem de produção",
"description": "Altera uma ordem de produção pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idOrdemProducao"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/OrdensProducaoDadosBaseDTO"
},
{
"$ref": "#/components/schemas/OrdensProducaoDadosPostDTO"
}
]
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "OrdensProducao",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Ordens de Produção"
],
"summary": "Remove uma ordem de produção",
"description": "Remove uma ordem de produção pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idOrdemProducao"
}
],
"responses": {
"204": {
"description": "No content."
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "OrdensProducao",
"x-api-action": "Remover"
}
},
"/ordens-producao/{idOrdemProducao}/situacoes": {
"put": {
"tags": [
"Ordens de Produção"
],
"summary": "Altera a situação de uma ordem de produção",
"description": "Altera a situação de uma ordem de produção pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idOrdemProducao"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrdensProducaoSituacaoDadosDTO"
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "OrdensProducao",
"x-api-action": "AlterarSituacao"
}
},
"/ordens-producao/gerar-sob-demanda": {
"post": {
"tags": [
"Ordens de Produção"
],
"summary": "Gera ordens de produção sob demanda",
"description": "Gera ordens de produção sob demanda (abaixo do estoque mínimo).",
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrdensProducaoDadosGeradosPorDemandaDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "OrdensProducao",
"x-api-action": "CriarMultiplos"
}
},
"/grupos-produtos": {
"get": {
"tags": [
"Grupos de Produtos"
],
"summary": "Obtém grupos de produtos",
"description": "Obtém grupos de produtos paginados.",
"parameters": [
{
"name": "nome",
"in": "query",
"description": "O nome do grupo",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "nomePai",
"in": "query",
"description": "O nome do grupo pai",
"required": false,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/pagina"
},
{
"$ref": "#/components/parameters/limite"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GruposProdutosDadosDTO"
}
}
},
"type": "object"
}
}
}
}
},
"x-api-resource": "GruposProdutos",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Grupos de Produtos"
],
"summary": "Cria um grupo de produtos",
"description": "Cria um grupo de produtos.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/GruposProdutosDadosDTO"
},
{
"$ref": "#/components/schemas/GruposProdutosGrupoProdutoPaiDTO"
}
]
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/BasePostResponse"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "GruposProdutos",
"x-api-action": "Criar"
},
"delete": {
"tags": [
"Grupos de Produtos"
],
"summary": "Remove múltiplos grupos de produtos",
"description": "Remove múltiplos grupos de produtos pelos IDs.",
"parameters": [
{
"name": "idsGruposProdutos[]",
"in": "query",
"description": "IDs dos grupos de produtos",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
}
],
"responses": {
"204": {
"description": "No content."
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"alertas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "GruposProdutos",
"x-api-action": "RemoverMultiplos"
}
},
"/grupos-produtos/{idGrupoProduto}": {
"get": {
"tags": [
"Grupos de Produtos"
],
"summary": "Obtém um grupo de produtos",
"description": "Obtém um grupo de produtos pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idGrupoProduto"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/components/schemas/GruposProdutosDadosDTO"
},
{
"$ref": "#/components/schemas/GruposProdutosGrupoProdutoPaiDTO"
}
]
}
},
"type": "object"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "GruposProdutos",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Grupos de Produtos"
],
"summary": "Altera um grupo de produtos",
"description": "Altera um grupo de produtos pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idGrupoProduto"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/GruposProdutosDadosDTO"
},
{
"$ref": "#/components/schemas/GruposProdutosGrupoProdutoPaiDTO"
}
]
}
}
}
},
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "GruposProdutos",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Grupos de Produtos"
],
"summary": "Remove um grupo de produtos",
"description": "Remove um grupo de produtos pelo ID.",
"parameters": [
{
"$ref": "#/components/parameters/idGrupoProduto"
}
],
"responses": {
"204": {
"description": "No content."
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "GruposProdutos",
"x-api-action": "Remover"
}
},
"/caixas": {
"get": {
"tags": [
"Caixas e Bancos"
],
"summary": "Obtém lista de lançamentos de caixas e bancos.",
"description": "Obtém lista de lançamentos de caixas e bancos.",
"parameters": [
{
"$ref": "#/components/parameters/pagina"
},
{
"name": "dataInicial",
"in": "query",
"description": "Data inicial de consulta de movimentações, só serão retornados os lançamento a partir dessa data. Caso não informado, o padrão será o primeiro dia do mês atual.",
"schema": {
"type": "string",
"format": "date",
"example": "01/12/2024"
}
},
{
"name": "dataFinal",
"in": "query",
"description": "Data final de consulta de movimentações, só serão retornados os lançamento até essa data. Caso não informado, o padrão será o último dia do mês atual.",
"schema": {
"type": "string",
"format": "date",
"example": "31/12/2024"
}
},
{
"name": "idsCategorias",
"in": "query",
"description": "IDs das categorias de movimentações.",
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": "[1,2,3]"
}
},
{
"name": "idContaFinanceira",
"in": "query",
"description": "ID da conta financeira.",
"schema": {
"type": "integer",
"example": 1
}
},
{
"name": "pesquisa",
"in": "query",
"description": "Pesquisa por descrição do lançamento.",
"schema": {
"type": "string",
"example": "Compra de mercadorias"
}
},
{
"name": "valor",
"in": "query",
"description": "Valor do lançamento.",
"schema": {
"type": "number",
"example": 100
}
},
{
"name": "situacaoConciliacao",
"in": "query",
"description": "Situação da conciliação do lançamento
`1` Registros conciliados
`2` Registros não conciliados
`3` Todos os registros",
"schema": {
"type": "integer",
"default": 3,
"enum": [
1,
2,
3
],
"example": 3
}
},
{
"name": "situacao",
"in": "query",
"description": "Situação do lançamento.
'R' para registros
'E' para excluídos",
"schema": {
"type": "string",
"default": "R",
"enum": [
"R",
"E"
],
"example": "R"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CaixasBancosItemLancamentoDTO"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Valor de filtro inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Caixas",
"x-api-action": "ObterMultiplos"
},
"post": {
"tags": [
"Caixas e Bancos"
],
"summary": "Cria um novo lançamento de caixa e banco.",
"description": "Cria um novo lançamento de caixa e banco com os dados fornecidos.",
"requestBody": {
"description": "Dados do lançamento a ser criado",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaixasBancosSalvarLancamentoDTO"
}
}
}
},
"responses": {
"201": {
"description": "Lançamento criado com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaixasBancosSalvarLancamentoResponseDTO"
}
}
}
},
"400": {
"description": "Dados inválidos ou campos obrigatórios não informados",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Caixas",
"x-api-action": "Criar"
}
},
"/caixas/{idCaixa}": {
"get": {
"tags": [
"Caixas e Bancos"
],
"summary": "Obtém um lançamento de caixa e banco.",
"description": "Obtém um lançamento de caixa e banco.",
"parameters": [
{
"$ref": "#/components/parameters/idLancamentoCaixa"
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaixasBancosLancamentoDTO"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Caixas",
"x-api-action": "Obter"
},
"put": {
"tags": [
"Caixas e Bancos"
],
"summary": "Atualiza um lançamento de caixa e banco.",
"description": "Atualiza um lançamento de caixa e banco existente com os dados fornecidos.",
"parameters": [
{
"$ref": "#/components/parameters/idLancamentoCaixa"
}
],
"requestBody": {
"description": "Dados do lançamento a ser atualizado",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaixasBancosSalvarLancamentoDTO"
}
}
}
},
"responses": {
"200": {
"description": "Lançamento atualizado com sucesso",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaixasBancosSalvarLancamentoResponseDTO"
}
}
}
},
"400": {
"description": "Dados inválidos ou campos obrigatórios não informados",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Lançamento não encontrado",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Caixas",
"x-api-action": "Alterar"
},
"delete": {
"tags": [
"Caixas e Bancos"
],
"summary": "Remove um lançamento de caixa e banco",
"description": "Remove um lançamento de caixa e banco pelo ID. O registro não é excluído permanentemente, apenas marcado como excluído (exclusão lógica).",
"parameters": [
{
"name": "idCaixa",
"in": "path",
"description": "ID do lançamento de caixa e banco a ser excluído.",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"example": 123
}
}
],
"responses": {
"204": {
"description": "No content. O lançamento foi excluído com sucesso."
},
"400": {
"description": "Erro de validação.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Lançamento não encontrado.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-api-resource": "Caixas",
"x-api-action": "Remover"
}
}
},
"components": {
"schemas": {
"BasePostResponse": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"AnunciosGetAllResponseDTO": {
"properties": {
"id": {
"description": "ID do anúncio.",
"type": "integer",
"example": 1
},
"titulo": {
"description": "Título do anúncio.",
"type": "string",
"example": "Anúncio 1"
},
"situacao": {
"description": "Situação do anúncio.",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"AnunciosGetAttributesFromCategoryResponseDTO": {
"properties": {
"id": {
"description": "ID do atributo.",
"type": "integer",
"example": 1
},
"nome": {
"description": "Nome do atributo.",
"type": "string",
"example": "Atributo 1"
},
"obrigatorio": {
"description": "Se o atributo é obrigatório.",
"type": "boolean",
"example": true
},
"tipo": {
"description": "Tipo do atributo.",
"type": "string",
"example": "string"
},
"unidadePadrao": {
"description": "Unidade padrão do atributo.",
"type": "string",
"example": "unidade"
},
"minimo": {
"description": "Mínimo do atributo.",
"type": "integer",
"example": 1
},
"maximo": {
"description": "Máximo do atributo.",
"type": "integer",
"example": 10
}
},
"type": "object"
},
"AnunciosAtributoDTO": {
"properties": {
"id": {
"description": "ID do atributo.",
"type": "integer",
"example": 123
},
"id_externo": {
"description": "ID externo do atributo.",
"type": "string",
"example": "COR"
},
"nome": {
"description": "Nome do atributo.",
"type": "string",
"example": "Cor"
},
"tipo": {
"description": "Tipo do atributo.",
"type": "string",
"example": "string"
},
"valor": {
"description": "Valor do atributo.",
"type": "string",
"example": "Azul"
},
"unidade": {
"description": "Unidade do atributo, se aplicável.",
"type": "string",
"example": "cm"
}
},
"type": "object"
},
"AnunciosImagemDTO": {
"properties": {
"id": {
"description": "ID da imagem.",
"type": "integer",
"example": 456
},
"url": {
"description": "URL da imagem.",
"type": "string",
"example": "https://exemplo.com/imagem.jpg"
},
"ordem": {
"description": "Ordem da imagem.",
"type": "integer",
"example": 1
},
"tipo": {
"description": "Tipo da imagem.",
"type": "string",
"example": "principal"
}
},
"type": "object"
},
"AnunciosVariacaoDTO": {
"properties": {
"id": {
"description": "ID da variação.",
"type": "integer",
"example": 789
},
"nome": {
"description": "Nome da variação.",
"type": "string",
"example": "Vermelho / P"
}
},
"type": "object"
},
"AnunciosGetByIdResponseDTO": {
"properties": {
"id": {
"description": "ID do anúncio.",
"type": "integer",
"example": 1
},
"produto": {
"properties": {
"id": {
"description": "ID do produto.",
"type": "integer",
"example": 12345
}
},
"type": "object"
},
"titulo": {
"description": "Título do anúncio.",
"type": "string",
"example": "Anúncio 1"
},
"descricao": {
"description": "Descrição do anúncio.",
"type": "string",
"example": "Descrição do anúncio."
},
"status": {
"description": "Situação do anúncio.",
"type": "integer",
"example": 1
},
"atributos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnunciosAtributoDTO"
}
},
"imagens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnunciosImagemDTO"
}
},
"variacoes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnunciosVariacaoDTO"
}
}
},
"type": "object"
},
"AnunciosCategoriaDTO": {
"properties": {
"id": {
"description": "ID da categoria.",
"type": "integer",
"example": 101
},
"nome": {
"description": "Nome da categoria.",
"type": "string",
"example": "Roupas"
}
},
"type": "object"
},
"AnunciosSaveRequestBase": {
"required": [
"produto",
"integracao",
"loja"
],
"properties": {
"produto": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID do produto pai",
"type": "integer",
"example": 123
}
},
"type": "object"
},
"integracao": {
"required": [
"tipo"
],
"properties": {
"tipo": {
"description": "Tipo da integração",
"type": "string",
"example": "MercadoLivre"
}
},
"type": "object"
},
"loja": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID da loja",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"nome": {
"type": "string",
"example": "Nome do anúncio"
},
"descricao": {
"type": "string",
"example": "Descrição do anúncio"
},
"preco": {
"properties": {
"valor": {
"type": "number",
"format": "float",
"example": 100.5
},
"promocional": {
"type": "number",
"format": "float",
"example": 90
}
},
"type": "object"
},
"anuncioLoja": {
"properties": {
"id": {
"type": "integer",
"example": 456
}
},
"type": "object"
},
"estoques": {
"properties": {
"itens": {
"type": "array",
"items": {
"description": "ID do depósito",
"type": "integer",
"example": 1
},
"example": [
1234567,
7654321
]
}
},
"type": "object"
},
"categoria": {
"properties": {
"id": {
"type": "string",
"example": "MLB123"
}
},
"type": "object"
},
"atributos": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"example": "COLOR"
},
"valor": {
"type": "string",
"example": "Azul"
}
},
"type": "object"
}
},
"imagens": {
"type": "array",
"items": {
"properties": {
"url": {
"type": "string",
"example": "https://exemplo.com/imagem.jpg"
},
"ordem": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
},
"mercadoLivre": {
"properties": {
"modalidade": {
"type": "string",
"example": "gold_pro"
},
"catalogo": {
"properties": {
"id": {
"type": "integer",
"example": 123
}
},
"type": "object"
},
"grade": {
"properties": {
"id": {
"type": "integer",
"example": 987
}
},
"type": "object"
},
"frete": {
"properties": {
"gratis": {
"type": "boolean",
"example": true
},
"tipo": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"produtoUsuario": {
"properties": {
"id": {
"type": "integer",
"example": 321
},
"ativo": {
"type": "boolean",
"example": true
}
},
"type": "object"
}
},
"type": "object",
"nullable": true
}
},
"type": "object"
},
"AnunciosSaveRequest": {
"allOf": [
{
"$ref": "#/components/schemas/AnunciosSaveRequestBase"
},
{
"properties": {
"variacoes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnunciosSaveRequestBase"
}
}
},
"type": "object"
}
]
},
"AnunciosSaveResponseDTO": {
"properties": {
"id": {
"description": "ID do anúncio salvo.",
"type": "integer",
"example": 123
},
"idsVariacoes": {
"description": "Lista de IDs das variações associadas ao anúncio.",
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
},
"BorderosCategoriaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"BorderosContatoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"BorderosDadosDTO": {
"required": [
"id",
"data",
"historico",
"portador",
"categoria",
"pagamentos"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"data": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"historico": {
"type": "string",
"example": "Referente ao pedido nº 12345678"
},
"portador": {
"$ref": "#/components/schemas/BorderosPortadorDTO"
},
"categoria": {
"$ref": "#/components/schemas/BorderosCategoriaDTO"
},
"pagamentos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BorderosPagamentoDTO"
}
}
},
"type": "object"
},
"BorderosPagamentoDTO": {
"required": [
"contato",
"numeroDocumento",
"valorPago",
"juros",
"desconto",
"acrescimo",
"tarifa"
],
"properties": {
"contato": {
"$ref": "#/components/schemas/BorderosContatoDTO"
},
"numeroDocumento": {
"type": "string",
"example": ""
},
"valorPago": {
"type": "number",
"format": "float",
"example": 1500.75
},
"juros": {
"type": "number",
"format": "float",
"example": 10
},
"desconto": {
"type": "number",
"format": "float",
"example": 10
},
"acrescimo": {
"type": "number",
"format": "float",
"example": 10
},
"tarifa": {
"description": "Tarifa da forma de pagamento",
"type": "number",
"format": "float",
"example": 10
}
},
"type": "object"
},
"BorderosPortadorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CaixasBancosDadosBasicoContatoDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"readOnly": true,
"example": "Pedro Silva"
},
"cnpj": {
"type": "string",
"readOnly": true,
"example": "30188025000121"
}
},
"type": "object"
},
"CaixasBancosDadosBasicosCategoriaDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"descricao": {
"type": "string",
"readOnly": true,
"example": "Vendas"
}
},
"type": "object"
},
"CaixasBancosDadosBasicosOrigemDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"tipo": {
"description": "Tipo da origem do lançamento
'caixa' para lançamento de caixas e bancos
'duplicata' para contas a receber/pagar
'bordero' para pagamento/recebimento
'estoque' para estoque",
"type": "string",
"enum": [
"caixa",
"duplicata",
"bordero",
"estoque"
],
"readOnly": true,
"example": "bordero"
}
},
"type": "object"
},
"CaixasBancosItemLancamentoDTO": {
"properties": {
"id": {
"description": "ID do lançamento de caixas e bancos",
"type": "string",
"example": "1234567"
},
"debCred": {
"description": "Débito ou crédito",
"type": "string",
"example": "D"
},
"situacao": {
"description": "Situação",
"type": "string",
"example": "R"
},
"valor": {
"description": "Valor",
"type": "number",
"format": "float",
"example": 100
},
"data": {
"description": "Data",
"type": "string",
"example": "2025-01-01"
},
"observacoes": {
"description": "Observações",
"type": "string",
"example": "Observações do lançamento"
},
"descricao": {
"description": "Descrição",
"type": "string",
"example": "Descrição do lançamento"
},
"origem": {
"$ref": "#/components/schemas/CaixasBancosDadosBasicosOrigemDTO"
},
"contato": {
"$ref": "#/components/schemas/CaixasBancosDadosBasicoContatoDTO"
},
"contaFinanceira": {
"$ref": "#/components/schemas/ContasFinanceirasDadosBasicosDTO"
}
},
"type": "object"
},
"CaixasBancosLancamentoConciliacaoMovimentacaoDTO": {
"properties": {
"id": {
"description": "Id da conciliação da movimentação",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CaixasBancosLancamentoDTO": {
"properties": {
"id": {
"description": "Id do lançamento",
"type": "integer",
"example": 12345678
},
"debCred": {
"description": "Tipo de lançamento
`D` - Débito
`C` - Crédito",
"type": "string",
"enum": [
"D",
"C"
],
"example": "D"
},
"saldo": {
"description": "É ajuste de saldo após o lançamento
`S` - Sim
`N` - Não",
"type": "string",
"enum": [
"S",
"N"
],
"example": "S"
},
"situacao": {
"description": "Situação do lançamento
`R` - Registrado
`E` - Excluído
`H` - Escondido
`N` - Não registrado
`P` - Processando (externa)
`C` - Cancelado (externa)",
"type": "string",
"enum": [
"R",
"E",
"H",
"N",
"P",
"C"
],
"example": "R"
},
"transferencia": {
"description": "Indica se o lançamento é uma transferência
`1` - Sim
`0` - Não",
"type": "string",
"enum": [
"1",
"0"
],
"example": "1"
},
"tipoLancamento": {
"description": "Tipo do lançamento
`1` - Débito
`2` - Crédito",
"type": "string",
"enum": [
"1",
"2"
],
"example": "1"
},
"data": {
"description": "Data do lançamento",
"type": "string",
"format": "date",
"example": "2025-01-01"
},
"competencia": {
"description": "Data de competência do lançamento",
"type": "string",
"format": "date",
"example": "2025-01-01"
},
"valor": {
"description": "Valor do lançamento",
"type": "number",
"format": "float",
"example": 100
},
"observacoes": {
"description": "Observações adicionais sobre o lançamento",
"type": "string",
"example": "Observações"
},
"parcela": {
"$ref": "#/components/schemas/CaixasBancosLancamentoParcelaDTO"
},
"categoria": {
"$ref": "#/components/schemas/CaixasBancosDadosBasicosCategoriaDTO"
},
"conciliacaoMovimentacao": {
"$ref": "#/components/schemas/CaixasBancosLancamentoConciliacaoMovimentacaoDTO"
},
"contato": {
"$ref": "#/components/schemas/CaixasBancosDadosBasicoContatoDTO"
},
"origem": {
"$ref": "#/components/schemas/CaixasBancosDadosBasicosOrigemDTO"
},
"contaFinanceira": {
"$ref": "#/components/schemas/ContasFinanceirasDadosBasicosDTO"
}
},
"type": "object"
},
"CaixasBancosLancamentoParcelaDTO": {
"properties": {
"id": {
"description": "Id da parcela do lançamento",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CaixasBancosSalvarLancamentoDTO": {
"required": [
"data",
"valor",
"debCred",
"competencia",
"observacoes",
"idContaContabil"
],
"properties": {
"id": {
"description": "ID do lançamento (deve corresponder ao ID da URL)",
"type": "integer",
"example": 12345678
},
"data": {
"description": "Data do lançamento",
"type": "string",
"format": "date",
"example": "2025-01-01"
},
"valor": {
"description": "Valor do lançamento",
"type": "number",
"format": "float",
"example": "123.00"
},
"debCred": {
"description": "Tipo de lançamento:
`C` - Crédito
`D` - Débito",
"type": "string",
"enum": [
"C",
"D"
],
"example": "C"
},
"competencia": {
"description": "Data de competência",
"type": "string",
"format": "date",
"example": "2025-01-01"
},
"observacoes": {
"description": "Observações do lançamento",
"type": "string",
"example": "Lançamento atualizado"
},
"transferencia": {
"description": "Indica se é uma transferência",
"type": "string",
"example": ""
},
"contaFinanceira": {
"$ref": "#/components/schemas/ContasFinanceirasDadosBasicosDTO"
},
"categoria": {
"$ref": "#/components/schemas/CaixasBancosDadosBasicosCategoriaDTO"
},
"origem": {
"$ref": "#/components/schemas/CaixasBancosDadosBasicosOrigemDTO"
},
"contato": {
"$ref": "#/components/schemas/CaixasBancosDadosBasicoContatoDTO"
}
},
"type": "object"
},
"CaixasBancosSalvarLancamentoResponseDTO": {
"properties": {
"id": {
"description": "ID do lançamento criado",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CalculosImpostosCalculoDTO": {
"required": [
"tipoNota",
"uf",
"municipio",
"loja",
"produto"
],
"properties": {
"tipoNota": {
"description": "`0` Entrada
`1` Saída",
"type": "integer",
"enum": [
0,
1
],
"example": 1
},
"uf": {
"description": "UF do destinatário",
"type": "string",
"example": "RS"
},
"municipio": {
"$ref": "#/components/schemas/CalculosImpostosMunicipioDTO"
},
"obterRegras": {
"description": "Se false, os valores das regras de tributação de cada imposto serão zerados (cst, alíquota, base, etc.)",
"type": "boolean",
"default": true,
"example": true
},
"crt": {
"description": "CRT da empresa
`1` Simples Nacional
`2` Simples Nacional - excesso de sublimite de receita bruta
`3` Regime Normal
`4` MEI",
"type": "integer",
"example": 1
},
"loja": {
"$ref": "#/components/schemas/CalculosImpostosLojaDTO"
},
"produto": {
"$ref": "#/components/schemas/CalculosImpostosProdutoDTO"
}
},
"type": "object"
},
"CalculosImpostosCbsDTO": {
"properties": {
"regraOperacao": {
"$ref": "#/components/schemas/CalculosImpostosRegraOperacaoDTO"
},
"percentualCbs": {
"description": "Percentual CBS",
"type": "number",
"format": "float",
"example": 0.9
},
"percentualReducaoAliquota": {
"description": "% Redução Alíquota",
"type": "number",
"format": "float",
"example": 0
},
"aliquotaEfetiva": {
"description": "Alíquota Efetiva",
"type": "number",
"format": "float",
"example": 0
},
"percentualDiferimento": {
"description": "% Diferimento",
"type": "number",
"format": "float",
"example": 0
},
"codigoCreditoPresumido": {
"description": "Código Crédito Presumido",
"type": "string",
"example": ""
},
"percentualCreditoPresumido": {
"description": "% Crédito Presumido CBS",
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
},
"CalculosImpostosCofinsDTO": {
"allOf": [
{
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
{
"properties": {
"valorCofinsFixo": {
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
}
]
},
"CalculosImpostosDadosDTO": {
"properties": {
"faturada": {
"type": "boolean",
"example": false
},
"observacoes": {
"type": "string",
"example": "Total aproximado de tributos: R$ [APROX_TRIB]. Fonte IBPT."
},
"pisCofinsPresumido": {
"type": "boolean",
"example": false
},
"somaImpostosTotal": {
"type": "boolean",
"example": false
},
"somaIcmsTotal": {
"type": "boolean",
"example": false
},
"aliquotaFunrural": {
"type": "number",
"format": "float",
"example": 0
},
"descontaFunrural": {
"type": "boolean",
"example": false
},
"consumidorFinal": {
"type": "boolean",
"example": false
},
"retImpostoRetido": {
"type": "boolean",
"example": false
},
"retAliquotaIr": {
"type": "number",
"format": "float",
"example": 0
},
"retValorIr": {
"type": "number",
"format": "float",
"example": 0
},
"retAliquotaCsll": {
"type": "number",
"format": "float",
"example": 0
},
"retValorCsll": {
"type": "number",
"format": "float",
"example": 0
},
"descontoCondicional": {
"type": "boolean",
"example": false
},
"baseComissao": {
"type": "number",
"format": "float",
"example": 0
},
"icms": {
"$ref": "#/components/schemas/CalculosImpostosIcmsDTO"
},
"valorPmc": {
"type": "number",
"format": "float",
"example": 0
},
"aliquotaValorAproxImpostos": {
"type": "number",
"format": "float",
"example": 0
},
"informacoesAdicionaisFisco": {
"type": "string",
"example": ""
},
"incluirFreteIpi": {
"type": "boolean",
"example": false
},
"simples": {
"$ref": "#/components/schemas/CalculosImpostosSimplesDTO"
},
"ipi": {
"$ref": "#/components/schemas/CalculosImpostosIpiDTO"
},
"issqn": {
"$ref": "#/components/schemas/CalculosImpostosIssqnDTO"
},
"pis": {
"$ref": "#/components/schemas/CalculosImpostosPisDTO"
},
"cofins": {
"$ref": "#/components/schemas/CalculosImpostosCofinsDTO"
},
"icmsSt": {
"$ref": "#/components/schemas/CalculosImpostosIcmsStDTO"
},
"pisSt": {
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
"cofinsSt": {
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
"ii": {
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
"codigoBeneficioFiscal": {
"type": "string",
"example": ""
},
"porcentagemFcp": {
"type": "number",
"format": "float",
"example": 0
},
"cfop": {
"type": "integer",
"example": 0
},
"simplesSt": {
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
"ibsCbs": {
"$ref": "#/components/schemas/CalculosImpostosIbsCbsDTO"
},
"ibs": {
"$ref": "#/components/schemas/CalculosImpostosIbsDTO"
},
"cbs": {
"$ref": "#/components/schemas/CalculosImpostosCbsDTO"
},
"ibsCbsReg": {
"$ref": "#/components/schemas/CalculosImpostosIbsCbsRegDTO"
}
},
"type": "object"
},
"CalculosImpostosIbsCbsDTO": {
"properties": {
"regraOperacao": {
"$ref": "#/components/schemas/CalculosImpostosRegraOperacaoDTO"
},
"cst": {
"description": "Código de Situação Tributária",
"type": "string",
"example": "000"
},
"classificacaoTributaria": {
"description": "Código de Classificação Tributária",
"type": "string",
"example": "000001"
},
"valorBaseCalculo": {
"description": "Valor Base de Cálculo IBS/CBS",
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
},
"CalculosImpostosIbsCbsRegDTO": {
"properties": {
"cstRegular": {
"description": "CST da Tributação Regular",
"type": "string",
"example": "000"
},
"classificacaoTributariaRegular": {
"description": "Classificação Tributária Regular",
"type": "string",
"example": "000001"
},
"aliquotaEfetivaRegularIbsUf": {
"description": "Alíquota Efetiva Regular IBS UF",
"type": "number",
"format": "float",
"example": 0
},
"aliquotaEfetivaRegularIbsMunicipio": {
"description": "Alíquota Efetiva Regular IBS Município",
"type": "number",
"format": "float",
"example": 0
},
"aliquotaEfetivaRegularCbs": {
"description": "Alíquota Efetiva Regular CBS",
"type": "number",
"format": "float",
"example": 0
},
"valorTributacaoRegularIbsUf": {
"description": "Valor Tributação Regular IBS UF",
"type": "number",
"format": "float",
"example": 0
},
"valorTributacaoRegularIbsMunicipio": {
"description": "Valor Tributação Regular IBS Município",
"type": "number",
"format": "float",
"example": 0
},
"valorTributacaoRegularCbs": {
"description": "Valor Tributação Regular CBS",
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
},
"CalculosImpostosIbsDTO": {
"properties": {
"regraOperacao": {
"$ref": "#/components/schemas/CalculosImpostosRegraOperacaoDTO"
},
"percentualIbsUf": {
"description": "Percentual IBS UF",
"type": "number",
"format": "float",
"example": 0.1
},
"percentualIbsMunicipio": {
"description": "Percentual IBS Município",
"type": "number",
"format": "float",
"example": 0
},
"percentualReducaoAliquotaUf": {
"description": "% Redução Alíquota UF",
"type": "number",
"format": "float",
"example": 0
},
"percentualReducaoAliquotaMunicipio": {
"description": "% Redução Alíquota Município",
"type": "number",
"format": "float",
"example": 0
},
"aliquotaEfetivaUf": {
"description": "Alíquota Efetiva UF",
"type": "number",
"format": "float",
"example": 0
},
"aliquotaEfetivaMunicipio": {
"description": "Alíquota Efetiva Município",
"type": "number",
"format": "float",
"example": 0
},
"percentualDiferimentoUf": {
"description": "% Diferimento UF",
"type": "number",
"format": "float",
"example": 0
},
"percentualDiferimentoMunicipio": {
"description": "% Diferimento Município",
"type": "number",
"format": "float",
"example": 0
},
"codigoCreditoPresumido": {
"description": "Código Crédito Presumido",
"type": "string",
"example": ""
},
"percentualCreditoPresumido": {
"description": "% Crédito Presumido IBS",
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
},
"CalculosImpostosIcmsDTO": {
"allOf": [
{
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
{
"properties": {
"porcentagemFcpDifal": {
"type": "number",
"format": "float",
"example": 0
},
"valorFcpDifal": {
"type": "number",
"format": "float",
"example": 0
},
"valorFcpEfetivo": {
"type": "number",
"format": "float",
"example": 0
},
"porcentagemFcp": {
"type": "number",
"format": "float",
"example": 0
},
"porcentagemFcpUfDestino": {
"type": "number",
"format": "float",
"example": 0
},
"modalidadeBaseCalculo": {
"type": "number",
"format": "float",
"example": 0
},
"valorPauta": {
"type": "number",
"format": "float",
"example": 0
},
"aliquotaPresumido": {
"type": "number",
"format": "float",
"example": 0
},
"porcentagemBaseCalculoUfDestino": {
"type": "number",
"format": "float",
"example": 0
},
"porcentagemIcmsUfDestino": {
"type": "number",
"format": "float",
"example": 0
},
"tipoPartilha": {
"description": "`0` Isento
`1` Normal",
"type": "integer",
"enum": [
0,
1
],
"example": 0
},
"valorIcmsDesonerado": {
"type": "number",
"format": "float",
"example": 0
},
"motivoDesoneracaoIcms": {
"description": "`0` Nenhum
`1` Táxi
`3` Produtor Agropecuário
`4` Frotista/Locadora
`5` Diplomático/Consular
`6` Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações)
`7` SUFRAMA
`8` Venda a Órgão Público
`9` Outros
`10` Deficiente Condutor
`11` Deficiente Não Condutor
`90` Solicitado pelo Fisco
",
"type": "integer",
"enum": [
0,
1,
3,
4,
5,
6,
7,
8,
9,
10,
11,
90
],
"example": 0
},
"baseDiferimento": {
"type": "number",
"format": "float",
"example": 0
},
"valorBaseDiferimento": {
"type": "number",
"format": "float",
"example": 0
},
"valorPresumido": {
"type": "number",
"format": "float",
"example": 0
},
"aliquotaPosicao": {
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
}
]
},
"CalculosImpostosIcmsStDTO": {
"allOf": [
{
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
{
"properties": {
"percentualAdicionado": {
"type": "number",
"format": "float",
"example": 0
},
"modalidadeBaseCalculo": {
"description": "`0` Margem Valor Agregado (%)
`1` Pauta (valor),
`2` Preço Tabelado Máximo (valor)
`3` Valor da operação",
"type": "integer",
"enum": [
0,
1,
2,
3
],
"example": 0
},
"valorPauta": {
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
}
]
},
"CalculosImpostosDadosBaseDTO": {
"properties": {
"regraOperacao": {
"$ref": "#/components/schemas/CalculosImpostosRegraOperacaoDTO"
},
"tributacao": {
"description": "`1` Tributado
`2` Isento
`3` Outra situação",
"type": "integer",
"enum": [
1,
2,
3
],
"example": 1
},
"cst": {
"type": "string",
"example": "49"
},
"aliquota": {
"type": "number",
"format": "float",
"example": 0
},
"base": {
"type": "number",
"format": "float",
"example": 0
},
"valorBaseCalculo": {
"type": "number",
"format": "float",
"example": 0
},
"valorImposto": {
"type": "number",
"format": "float",
"example": 0
},
"observacoes": {
"type": "string",
"example": ""
},
"informacoesAdicionaisFisco": {
"type": "string",
"example": ""
}
},
"type": "object"
},
"CalculosImpostosIpiDTO": {
"allOf": [
{
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
{
"properties": {
"valorIpiFixoUnitario": {
"type": "number",
"format": "float",
"example": 0
},
"classeEnquadramentoIpi": {
"type": "string",
"example": ""
},
"codigoEnquadramentoIpi": {
"type": "integer",
"example": 0
},
"codigoSelo": {
"type": "string",
"example": ""
},
"codigoExTipi": {
"type": "integer",
"example": 0
}
},
"type": "object"
}
]
},
"CalculosImpostosIssqnDTO": {
"allOf": [
{
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
{
"properties": {
"codigoListaServicos": {
"type": "string",
"example": "01.04"
},
"descontarIssTotalNota": {
"type": "boolean",
"example": false
},
"reterIss": {
"type": "boolean",
"example": false
}
},
"type": "object"
}
]
},
"CalculosImpostosLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"unidadeNegocio": {
"$ref": "#/components/schemas/CalculosImpostosUnidadeNegocioDTO"
}
},
"type": "object"
},
"CalculosImpostosMunicipioDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID do município segundo a Tabela de Código de Município do IBGE",
"type": "integer",
"example": 4302105
}
},
"type": "object"
},
"CalculosImpostosPisDTO": {
"allOf": [
{
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
{
"properties": {
"valorPisFixo": {
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
}
]
},
"CalculosImpostosProdutoDTO": {
"required": [
"id",
"valorUnitario",
"cupomFiscal",
"origem",
"quantidade"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"valorUnitario": {
"type": "number",
"format": "float",
"example": 0
},
"cupomFiscal": {
"type": "integer",
"example": 0
},
"origem": {
"description": "`0` Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8
`1` Estrangeira - Importação direta, exceto a indicada no código 6
`2` Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7
`3` Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%
`4` Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes
`5` Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
`6` Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX
`7` Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX
`8` Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"example": 0
},
"quantidade": {
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
},
"CalculosImpostosRegraOperacaoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CalculosImpostosSimplesDTO": {
"allOf": [
{
"$ref": "#/components/schemas/CalculosImpostosDadosBaseDTO"
},
{
"properties": {
"baseDiferimento": {
"type": "number",
"format": "float",
"example": 0
},
"modalidadeBaseCalculo": {
"type": "integer",
"example": 0
},
"valorPauta": {
"type": "number",
"format": "float",
"example": 0
},
"valorImpostoSt": {
"type": "number",
"format": "float",
"example": 0
},
"valorBaseCalculoSt": {
"type": "number",
"format": "float",
"example": 0
},
"baseCalculoSt": {
"type": "number",
"format": "float",
"example": 0
},
"percentualAdicionadoSt": {
"type": "number",
"format": "float",
"example": 0
},
"modalidadeBaseCalculoSt": {
"type": "number",
"format": "float",
"example": 0
},
"valorPautaSt": {
"type": "number",
"format": "float",
"example": 0
},
"aliquotaSt": {
"type": "number",
"format": "float",
"example": 0
},
"aliquotaStRetido": {
"type": "number",
"format": "float",
"example": 0
},
"baseStRetido": {
"type": "number",
"format": "float",
"example": 0
},
"valorUnitarioBaseCstRetencao": {
"type": "number",
"format": "float",
"example": 0
},
"valorUnitarioIcmsStRetencao": {
"type": "number",
"format": "float",
"example": 0
},
"valorUnitarioIcmsSubstituto": {
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
}
]
},
"CalculosImpostosUnidadeNegocioDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CamposCustomizadosAgrupadorDTO": {
"description": "Agrupadores por módulo
`produtos`: Categoria de produtos
`Contatos`: Tipos de contato",
"required": [
"id",
"agrupador"
],
"properties": {
"id": {
"description": "ID do agrupador",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CamposCustomizadosDadosBaseDTO": {
"required": [
"id",
"nome"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"nome": {
"description": "Ignorado no método PUT",
"type": "string",
"example": "Marca"
},
"situacao": {
"description": "`0` Inativo
`1` Ativo",
"type": "integer",
"enum": [
0,
1
],
"example": 1
}
},
"type": "object"
},
"CamposCustomizadosDadosDTO": {
"required": [
"modulo",
"tipoCampo"
],
"properties": {
"modulo": {
"$ref": "#/components/schemas/CamposCustomizadosModuloBaseDTO"
},
"tipoCampo": {
"$ref": "#/components/schemas/CamposCustomizadosTipoBaseDTO"
}
},
"type": "object"
},
"CamposCustomizadosDadosEdicaoDTO": {
"properties": {
"placeholder": {
"type": "string",
"default": "",
"example": "Informe a marca do produto"
},
"obrigatorio": {
"type": "boolean",
"default": false,
"example": false
},
"opcoes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CamposCustomizadosOpcaoDTO"
}
},
"tamanho": {
"$ref": "#/components/schemas/CamposCustomizadosTamanhoDTO"
},
"agrupadores": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CamposCustomizadosAgrupadorDTO"
}
}
},
"type": "object"
},
"CamposCustomizadosModuloBaseDTO": {
"description": "Módulo associado ao campo customizado.",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CamposCustomizadosModuloDTO": {
"required": [
"nome",
"modulo",
"permissoes"
],
"properties": {
"nome": {
"type": "string",
"example": "Clientes e Fornecedores"
},
"modulo": {
"type": "string",
"example": "Contatos"
},
"agrupador": {
"description": "Atributo do cadastro utilizado como agrupador.",
"type": "string",
"example": "Tipo de contato"
},
"permissoes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CamposCustomizadosPermissaoDTO"
}
}
},
"type": "object"
},
"CamposCustomizadosOpcaoDTO": {
"required": [
"id",
"nome"
],
"properties": {
"id": {
"description": "ID da opção",
"type": "integer",
"example": 12345678
},
"nome": {
"description": "Nome da opção",
"type": "string",
"example": "Opção 1"
}
},
"type": "object"
},
"CamposCustomizadosPermissaoDTO": {
"required": [
"nome",
"modulo",
"autorizado"
],
"properties": {
"nome": {
"type": "string",
"example": "Clientes e Fornecedores"
},
"modulo": {
"type": "string",
"example": "Contatos"
},
"autorizado": {
"type": "boolean",
"example": true
}
},
"type": "object"
},
"CamposCustomizadosTamanhoDTO": {
"description": "Número de caracteres ou valor mínimo e máximo",
"properties": {
"minimo": {
"type": "integer",
"example": 1
},
"maximo": {
"type": "integer",
"example": 10
}
},
"type": "object"
},
"CamposCustomizadosTipoBaseDTO": {
"description": "Tipo do campo customizado.",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CamposCustomizadosTipoDTO": {
"properties": {
"nome": {
"type": "string",
"example": "Inteiro"
},
"mascara": {
"type": "string",
"example": ""
}
},
"type": "object"
},
"CanalVendaCanalVendaDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CanalVendaDadosBaseDTO"
},
{
"properties": {
"filiais": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CanalVendaFilialDTO"
}
}
}
}
]
},
"CanalVendaDadosBaseDTO": {
"properties": {
"id": {
"description": "ID do canal de venda.",
"type": "integer",
"example": 12345678
},
"descricao": {
"description": "Descrição do canal de venda.",
"type": "string",
"example": "Loja de teste"
},
"tipo": {
"description": "Tipo do canal de venda.",
"type": "string",
"example": "Shopee"
},
"situacao": {
"description": "Situação do canal de venda
`1` Habilitado
`2` Desabilitado",
"type": "integer",
"enum": [
1,
2
],
"example": 1
}
},
"type": "object"
},
"CanalVendaDepositoDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CanalVendaFilialDTO": {
"properties": {
"cnpj": {
"description": "CNPJ da filial.",
"type": "string",
"example": "12.345.678/9012-34"
},
"idUnidadeNegocio": {
"description": "ID da unidade de negócio.",
"type": "integer",
"example": 12345678
},
"unidadeNegocio": {
"description": "Nome da unidade de negócio.",
"type": "string",
"example": "Empresa Teste"
},
"deposito": {
"$ref": "#/components/schemas/CanalVendaDepositoDTO"
},
"padrao": {
"type": "boolean",
"example": true
}
},
"type": "object"
},
"CanalVendaTipoIntegracaoDTO": {
"properties": {
"nome": {
"type": "string",
"example": "Loja Integrada"
},
"tipo": {
"type": "string",
"example": "LojaIntegrada"
},
"agrupador": {
"description": "Agrupador do canal de venda",
"type": "integer",
"enum": [
1,
2,
3,
4
],
"example": 1
}
},
"type": "object"
},
"CategoriasLojasCategoriaProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CategoriasLojasDadosDTO": {
"required": [
"loja",
"descricao",
"codigo",
"categoriaProduto"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"loja": {
"$ref": "#/components/schemas/CategoriasLojasLojaDTO"
},
"descricao": {
"type": "string",
"example": "Categoria de produto vinculado à loja"
},
"codigo": {
"description": "Código da categoria na loja.",
"type": "string",
"example": "12345678"
},
"categoriaProduto": {
"$ref": "#/components/schemas/CategoriasLojasCategoriaProdutoDTO"
}
},
"type": "object"
},
"CategoriasLojasLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CategoriasProdutosCategoriPaiDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Id da categoria do produto pai.",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CategoriasProdutosDadosDTO": {
"required": [
"id",
"descricao"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"descricao": {
"description": "Descrição da categoria",
"type": "string",
"example": "Eletrônicos"
}
},
"type": "object"
},
"CategoriasReceitasDespesasDadosBaseDTO": {
"required": [
"descricao",
"tipo"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"idCategoriaPai": {
"description": "Id da categoria pai. Se for a categoria raíz será 0.",
"type": "integer",
"example": 0
},
"descricao": {
"type": "string",
"example": "Vendas de mercadorias"
},
"tipo": {
"description": "`1` Despesa
`2` Receita
`3` Receita e despesa",
"type": "integer",
"enum": [
1,
2,
3
],
"example": 1
}
},
"type": "object"
},
"CategoriasReceitasDespesasDadosDTO": {
"properties": {
"situacao": {
"description": "`0` Inativa
`1` Ativa",
"type": "integer",
"enum": [
0,
1
],
"example": 1
}
},
"type": "object"
},
"CategoriasReceitasDespesasDadosPostDTO": {
"properties": {
"grupoDRE": {
"description": "`1` Não exibir DRE
`2` Receita Operacional Bruta
`3` Deduções da Receita Bruta
`7` Despesas Operacionais
`8` Receita Financeira
`9` Despesa Financeira
`10` Outras Receitas
`11` Outras Despesas
`13` IR e CSLL",
"type": "integer",
"default": 1,
"enum": [
1,
2,
3,
7,
8,
9,
10,
11,
13
],
"example": 1
}
},
"type": "object"
},
"ConfiguracaoAdicionalNotaServicoDTO": {
"properties": {
"CFPS": {
"description": "Código Fiscal de Prestação de Serviço",
"type": "string",
"example": "9.001"
},
"CFOP": {
"description": "Código Fiscal de Operações e Prestações",
"type": "string",
"example": "1.250"
},
"AEDF": {
"description": "Autorização de Emissão de Documento Fiscal Eletrônico",
"type": "string",
"example": ""
},
"proximoNumeroLote": {
"type": "integer",
"example": 78
},
"observacaoImpressaNota": {
"description": "Observação utilizada apenas para impressão",
"type": "string",
"example": "OBS"
},
"descricaoComplementar": {
"description": "Será adicionada abaixa da descrição do serviço em todas as notas",
"type": "string",
"example": "OBS"
},
"tipoEmissao": {
"description": "`T` Todos
`R` RPS e NFS-e
`N` Apenas NFS-e",
"type": "string",
"enum": [
"T",
"R",
"N"
],
"example": "R"
},
"campoNumeroDocContas": {
"description": "Escolha qual informação será utilizada como nº do documento ao lançar contas. Utilize o campo RPS caso o lançamento de contas ocorra antes do envio da nota",
"type": "boolean",
"example": "true"
},
"incentivadorFiscal": {
"type": "boolean",
"example": "true"
},
"alterarSituacao": {
"description": "Permitir alteração de situação por usuários",
"type": "boolean",
"example": "true"
},
"incluirParcelas": {
"description": "Incluir informação das parcelas na descrição dos serviços na emissão da NFS-e",
"type": "boolean",
"example": "false"
},
"considerarDataParcela": {
"description": "Permite utilizar a data de vencimento da parcela da venda na geração automática de parcelas da nota de serviço",
"type": "boolean",
"example": "true"
},
"considerarDataOrdemServico": {
"description": "Permite utilizar a data de vencimento da parcela da ordem de serviço na geração automática de parcelas da nota de serviço",
"type": "boolean",
"example": "true"
},
"cadastroPrefeitura": {
"$ref": "#/components/schemas/ConfiguracaoCadastroPrefeituraNotaServicoDTO"
}
},
"type": "object"
},
"ConfiguracaoAproximadoNotaServicoDTO": {
"properties": {
"utilizarAliqIBPT": {
"description": "Utilizar alíquotas da tabela do IBPT para cálculo de tributos aproximados",
"type": "boolean",
"example": "true"
},
"percentualAliq": {
"description": "Alíquota para cálculo de impostos aproximados",
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
},
"ConfiguracaoBasicaNotaServicoDTO": {
"properties": {
"emissorPadrao": {
"type": "integer",
"example": 3
},
"naturezaOperacao": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"ConfiguracaoCSLLPISCOFINSNotaServicoDTO": {
"properties": {
"calcular": {
"description": "Reter CSLL, PIS e COFINS para notas acima de R$ 5.000,00 (Descontinuado pela Lei 13.137)",
"type": "boolean",
"example": "true"
},
"reter": {
"description": "Reter CSLL, PIS e COFINS quando a soma desses impostos for maior que R$ 10,00(Lei 10.833)",
"type": "boolean",
"example": "false"
}
},
"type": "object"
},
"ConfiguracaoCadastroPrefeituraNotaServicoDTO": {
"properties": {
"login": {
"type": "string",
"example": "Login prefeitura"
},
"senha": {
"type": "string",
"example": "Senha prefeitura"
}
},
"type": "object"
},
"ConfiguracaoCodigoTributoNotaServicoDTO": {
"required": [
"listaServico"
],
"properties": {
"listaServico": {
"type": "string",
"example": "0107"
},
"tributacao": {
"type": "string",
"example": "0107"
}
},
"type": "object"
},
"ConfiguracaoControleNotaServicoDTO": {
"properties": {
"numeracaoRPS": {
"$ref": "#/components/schemas/ConfiguracaoNumeracaoRPSNotaServicoDTO"
}
},
"type": "object"
},
"ConfiguracaoNotaServicoDadosBaseDTO": {
"properties": {
"basicas": {
"$ref": "#/components/schemas/ConfiguracaoBasicaNotaServicoDTO"
},
"ISS": {
"$ref": "#/components/schemas/ConfiguracaoISSNotaServicoDTO"
},
"controle": {
"$ref": "#/components/schemas/ConfiguracaoControleNotaServicoDTO"
},
"impostos": {
"$ref": "#/components/schemas/ConfiguracaoImpostoNotaServicoDTO"
},
"envioEmail": {
"$ref": "#/components/schemas/ConfiguracaoEnvioEmailNotaServicoDTO"
},
"adicionais": {
"$ref": "#/components/schemas/ConfiguracaoAdicionalNotaServicoDTO"
}
},
"type": "object"
},
"ConfiguracaoEmailPadraoNotaFiscalServicoDTO": {
"properties": {
"copia": {
"type": "string",
"example": "E-mail padrão de cópia"
},
"resposta": {
"type": "string",
"example": "E-mail padrão de resposta"
}
},
"type": "object"
},
"ConfiguracaoEnvioEmailNotaServicoDTO": {
"properties": {
"enviarBoletoRPS": {
"description": "Enviar junto com o RPS o boleto das contas lançadas através do RPS ou do contrato",
"type": "boolean",
"example": "true"
},
"remetente": {
"type": "string",
"example": "Nome remetente padrão"
},
"assunto": {
"type": "string",
"example": "Assunto padrão"
},
"mensagem": {
"type": "string",
"example": "Mensagem padrão e-mail"
},
"padrao": {
"$ref": "#/components/schemas/ConfiguracaoEmailPadraoNotaFiscalServicoDTO"
}
},
"type": "object"
},
"ConfiguracaoINSSNotaServicoDTO": {
"properties": {
"reter": {
"description": "Determina se o INSS deve ser retido",
"type": "boolean",
"example": "true"
}
},
"type": "object"
},
"ConfiguracaoIRNotaServicoDTO": {
"properties": {
"percentual": {
"type": "number",
"format": "float",
"example": 0
},
"valorMinimoAlternativoDescontol": {
"type": "number",
"format": "float",
"example": 0
},
"descontar": {
"description": "Determina se o valor mínimo alternativo de desconto será aplicado",
"type": "boolean",
"example": "false"
},
"texto": {
"$ref": "#/components/schemas/ConfiguracaoTextoIRNotaServicoDTO"
}
},
"type": "object"
},
"ConfiguracaoISSNotaServicoDTO": {
"required": [
"tributos"
],
"properties": {
"zerar": {
"type": "boolean",
"example": "false"
},
"reter": {
"type": "boolean",
"example": "true"
},
"descontar": {
"type": "boolean",
"example": "true"
},
"tributos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfiguracaoTributoNotaServicoDTO"
}
}
},
"type": "object"
},
"ConfiguracaoImpostoNotaServicoDTO": {
"properties": {
"bloquearRetencaoPessoaFisica": {
"type": "boolean",
"example": "true"
},
"IR": {
"$ref": "#/components/schemas/ConfiguracaoIRNotaServicoDTO"
},
"outros": {
"$ref": "#/components/schemas/ConfiguracaoOutrosNotaServicoDTO"
}
},
"type": "object"
},
"ConfiguracaoNumeracaoRPSNotaServicoDTO": {
"properties": {
"cnpjEmitente": {
"type": "string",
"example": "48.426.683/0001-70"
},
"id": {
"type": "integer",
"example": 1
},
"numero": {
"type": "integer",
"example": 1
},
"serie": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"ConfiguracaoOutrosNotaServicoDTO": {
"properties": {
"CSLLPISCOFINSDTO": {
"$ref": "#/components/schemas/ConfiguracaoCSLLPISCOFINSNotaServicoDTO"
},
"INSS": {
"$ref": "#/components/schemas/ConfiguracaoINSSNotaServicoDTO"
},
"aproximados": {
"$ref": "#/components/schemas/ConfiguracaoAproximadoNotaServicoDTO"
}
},
"type": "object"
},
"ConfiguracaoTextoIRNotaServicoDTO": {
"properties": {
"padrao": {
"type": "string",
"example": "( - ) IRenda Fonte 1,5%"
},
"isento": {
"type": "string",
"example": "IR Isento Cfe. Lei nro. 9430/96 Art.64"
}
},
"type": "object"
},
"ConfiguracaoTributoNotaServicoDTO": {
"required": [
"CNAE",
"descricaoServico",
"codigo"
],
"properties": {
"id": {
"description": "ID é passado apenas para tributos existentes para fins de atualização",
"type": "integer",
"example": 1
},
"percentualISS": {
"type": "number",
"format": "float",
"example": 5
},
"CNAE": {
"type": "string",
"example": "82.99"
},
"descricaoServico": {
"type": "string",
"example": "Laudo de Vistoria Veicular"
},
"padrao": {
"description": "Determina se o tributo em questão será o padrão para criação de notas",
"type": "boolean",
"example": "false"
},
"indicadorOperacao": {
"description": "Indicador de operação da reforma tributária",
"type": "string",
"example": "010101"
},
"codigo": {
"$ref": "#/components/schemas/ConfiguracaoCodigoTributoNotaServicoDTO"
}
},
"type": "object"
},
"ContasBaixarContaDTO": {
"required": [
"data",
"usarDataVencimento",
"portador",
"categoria",
"historico"
],
"properties": {
"data": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"usarDataVencimento": {
"type": "boolean",
"example": false
},
"portador": {
"$ref": "#/components/schemas/ContasPortadorDTO"
},
"categoria": {
"$ref": "#/components/schemas/ContasCategoriaDTO"
},
"historico": {
"description": "Descriçao da conta para controle interno da empresa",
"type": "string",
"example": ""
},
"juros": {
"description": "Valor em reais dos juros.",
"type": "number",
"format": "float",
"default": 0,
"example": 10.5
},
"desconto": {
"description": "Valor em reais do desconto.",
"type": "number",
"format": "float",
"default": 0,
"example": 10.5
},
"acrescimo": {
"description": "Valor em reais do acréscimo.",
"type": "number",
"format": "float",
"default": 0,
"example": 10.5
},
"valorRecebido": {
"description": "Valor bruto da conta, incluindo a taxa do marketplace se aplicável. Se não for especificado, o valor total da conta será usado",
"type": "number",
"format": "float",
"example": 100.5
},
"tarifa": {
"description": "O valor da tarifa deve ser preenchido caso a forma de pagamento possua taxas de alíquota ou de valor fixo.",
"type": "number",
"format": "float",
"default": 0,
"example": 5
}
},
"type": "object"
},
"ContasCategoriaDTO": {
"description": "Categoria de receita e despesa",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContasContatoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContasDadosBaseDTO": {
"required": [
"situacao",
"vencimento",
"valor",
"contato"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"situacao": {
"description": "`1` Aberto
`2` Pago
`3` Parcial
`4` Devolvido
`5` Cancelado
`6` Devolvido parcial
`7` Confirmado",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"readOnly": true,
"example": 1
},
"vencimento": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"valor": {
"type": "number",
"format": "float",
"example": 1500.75
},
"contato": {
"$ref": "#/components/schemas/ContasContatoDTO"
},
"formaPagamento": {
"$ref": "#/components/schemas/ContasFormaPagamentoDTO"
}
},
"type": "object"
},
"ContasFormaPagamentoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContasPortadorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContasContabeisDadosDTO": {
"properties": {
"id": {
"description": "Id da conta financeira",
"type": "integer",
"example": 12345678
},
"descricao": {
"description": "Descrição personalizada da conta financeira",
"type": "string",
"example": "Contas a pagar"
},
"tipo": {
"description": "`banco` Para configuração de boleto CNAB
`caixa` Portador caixa sem integração
`conta-bancaria` Contas configuradas para cashout (TED ou pix)
`integracao-pagamento` Configurações de integração (Bling Conta, Vindi...)",
"type": "string",
"example": "integracao-pagamento"
},
"aliasIntegracao": {
"description": "Alias identificador da integração de pagamento",
"type": "string",
"example": "BlingPagamentos"
}
},
"type": "object"
},
"ContasPagarDadosDTO": {
"required": [
"vencimentoOriginal",
"numeroBanco",
"borderos"
],
"properties": {
"saldo": {
"description": "Valor total subtraído dos valores dos recebimentos",
"type": "number",
"format": "float",
"example": 100.75
},
"dataEmissao": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"vencimentoOriginal": {
"type": "string",
"format": "date",
"readOnly": true,
"example": "2023-01-12"
},
"numeroDocumento": {
"description": "Número para controle interno da empresa",
"type": "string",
"example": ""
},
"competencia": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"historico": {
"description": "Descriçao da conta para controle interno da empresa",
"type": "string",
"example": ""
},
"numeroBanco": {
"description": "Adicionado automaticamente com o número preenchido no cadastro do banco",
"type": "string",
"readOnly": true,
"example": ""
},
"portador": {
"$ref": "#/components/schemas/ContasPortadorDTO"
},
"categoria": {
"$ref": "#/components/schemas/ContasCategoriaDTO"
},
"borderos": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true
},
"ocorrencia": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaUnicaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaParceladaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaSemanalDTO"
}
]
}
},
"type": "object"
},
"ContasPagarDadosPostDTO": {
"properties": {
"ocorrencia": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaUnicaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaParceladaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaSemanalDTO"
}
]
}
},
"type": "object"
},
"ContasReceberAutenticacaoDTO": {
"required": [
"tipo",
"codigo"
],
"properties": {
"tipo": {
"description": "Tipo de autenticação:
`1` Código de autenticação por dois fatores
`4` Senha de 6 dígitos do app Bling Conta",
"type": "integer",
"enum": [
1,
4
],
"example": 1
},
"codigo": {
"type": "string",
"example": "111111"
}
},
"type": "object"
},
"ContasReceberBoletosCancelarDTO": {
"required": [
"motivo"
],
"properties": {
"autenticacao": {
"$ref": "#/components/schemas/ContasReceberAutenticacaoDTO"
},
"origem": {
"$ref": "#/components/schemas/ContasReceberOrigemDTO"
},
"conta": {
"$ref": "#/components/schemas/ContasReceberContaDTO"
},
"motivo": {
"type": "string",
"example": "Cancelado por força maior"
}
},
"type": "object"
},
"ContasReceberBoletosDadosBaseDTO": {
"properties": {
"venda": {
"$ref": "#/components/schemas/ContasReceberVendaDTO"
},
"notaFiscal": {
"$ref": "#/components/schemas/ContasReceberNotaFiscalDTO"
},
"valorTotal": {
"type": "number",
"format": "float",
"example": 111.2
},
"contas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContasReceberBoletosDadosDTO"
}
}
},
"type": "object"
},
"ContasReceberBoletosDadosDTO": {
"properties": {
"id": {
"type": "integer",
"example": 1328793273
},
"numeroExterno": {
"description": "Código de identificação do boleto",
"type": "string",
"example": "BWbXB"
},
"vencimento": {
"type": "string",
"example": "2023-09-12"
},
"valor": {
"type": "number",
"example": 111.2
},
"situacao": {
"description": "`1` Em aberto
`2` Recebido
`3` Parcialmente recebido
`4` Devolvido
`5` Parcialmente devolvido
`6` Cancelado",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6
],
"example": 1
}
},
"type": "object"
},
"ContasReceberContaContabilDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"descricao": {
"type": "string",
"example": "Contas a pagar"
}
},
"type": "object"
},
"ContasReceberContaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Para cancelar apenas uma conta, deve-se informar o ID da conta.",
"type": "integer",
"example": 6423836115
}
},
"type": "object"
},
"ContasReceberContatoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"example": "Contato Teste"
},
"numeroDocumento": {
"type": "string",
"example": "12345678910"
},
"tipo": {
"type": "string",
"example": "F"
}
},
"type": "object"
},
"ContasReceberDadosBaseDTO": {
"required": [
"vencimentoOriginal",
"numeroBanco",
"borderos",
"saldo"
],
"properties": {
"saldo": {
"description": "É calculado subtraindo os valores dos recebimentos do valor da conta",
"type": "number",
"format": "float",
"readOnly": true,
"example": 100.75
},
"dataEmissao": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"vencimentoOriginal": {
"type": "string",
"format": "date",
"readOnly": true,
"example": "2023-01-12"
},
"numeroDocumento": {
"description": "Número para controle interno da empresa",
"type": "string",
"example": ""
},
"competencia": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"historico": {
"description": "Descriçao da conta para controle interno da empresa",
"type": "string",
"example": ""
},
"numeroBanco": {
"description": "Adicionado automaticamente com o número preenchido no cadastro do banco",
"type": "string",
"readOnly": true,
"example": ""
},
"portador": {
"$ref": "#/components/schemas/ContasPortadorDTO"
},
"categoria": {
"$ref": "#/components/schemas/ContasCategoriaDTO"
},
"vendedor": {
"$ref": "#/components/schemas/ContasReceberVendedorDTO"
},
"borderos": {
"description": "IDs de borderos relacionados à conta caso ela possua pagamentos",
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true
}
},
"type": "object"
},
"ContasReceberDadosDTO": {
"properties": {
"ocorrencia": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaUnicaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaParceladaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaDTO"
},
{
"$ref": "#/components/schemas/ContasReceberOcorrenciaSemanalDTO"
}
]
}
},
"type": "object"
},
"ContasReceberDadosListDTO": {
"required": [
"situacao",
"vencimento",
"valor",
"contato"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"situacao": {
"description": "`1` Aberto
`2` Pago
`3` Parcial
`4` Devolvido
`5` Cancelado
`6` Devolvido parcial
`7` Confirmado",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"readOnly": true,
"example": 1
},
"vencimento": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"valor": {
"type": "number",
"format": "float",
"example": 1500.75
},
"idTransacao": {
"type": "string",
"example": "vX98D"
},
"linkQRCodePix": {
"type": "string",
"example": "doc.view.php?id=9ab1671b3f05765cb49fee83ee0f2496"
},
"linkBoleto": {
"type": "string",
"example": "doc.view.php?id=9ab1671b3f05765cb49fee83ee0f2496"
},
"dataEmissao": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"contato": {
"$ref": "#/components/schemas/ContasReceberContatoDTO"
},
"formaPagamento": {
"$ref": "#/components/schemas/ContasReceberFormaPagamentoDTO"
},
"contaContabil": {
"$ref": "#/components/schemas/ContasReceberContaContabilDTO"
},
"origem": {
"$ref": "#/components/schemas/ContasReceberDadosOrigemDTO"
}
},
"type": "object"
},
"ContasReceberDadosOrigemDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"tipoOrigem": {
"type": "string",
"example": "venda"
},
"numero": {
"type": "string",
"example": "0921132"
},
"dataEmissao": {
"type": "string",
"example": "2023-07-05"
},
"valor": {
"type": "number",
"format": "float",
"example": 45.76
},
"situacao": {
"description": "Situações da nota fiscal:
`1` Pendente: Situação inicial.
`3` Cancelada: Nota foi emitida e posteriormente cancelada.
`4` Aguardando recibo: Quando há uma tentativa de envio de uma nota pendente ou rejeitada.
`5` Rejeitada: Rejeição no envio.
`6` Autorizada: Sucesso no envio.
`7` Emitida DANFE: Após emitir a DANFE de uma nota autorizada.
`8` Registrada: Notas importadas no sistema.
`9` Aguardando protocolo: Durante uma tentativa de envio sem sucesso.
`10` Denegada: Devido a pendências do remetente ou destinatário junto à SEFAZ.
`11` Consulta situação: Quando a nota é rejeitada por duplicidade sem diferença na chave de acesso.
`12` Bloqueada: Quando ocorrem várias tentativas de envio que resultam na mesma rejeição.
`13` Contingência: Quando gerado xml e danfe em modo de contingência, aguardando envio da transmissão. Exclusiva da NFC-e.
Situações da venda:
`0` Em aberto
`1` Atendido
`2` Cancelado
`3` Em andamento
`5` Faturado parcialmente
`6` Atendido parcialmente
`7` Aguardando pagamento
`8` Pagamento confirmado
`10` Em digitação
`11` Verificado
`12` Checkout parcial",
"type": "integer",
"example": 1
},
"url": {
"type": "string",
"example": "doc.view.php?id=9ab1671b3f05765cb49fee83ee0f2496"
}
},
"type": "object"
},
"ContasReceberFormaPagamentoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"codigoFiscal": {
"description": "`1` Dinheiro
`2` Cheque
`3` Cartão de crédito
`4` Cartão de débito
`5` Crédito loja
`10` Vale alimentação
`11` Vale refeição
`12` Vale presente
`13` Vale combustível
`14` Duplicata mercantil
`15` Boleto bancário
`16` Depósito bancário
`17` PIX
`18` Transferência bancária
`19` Cartão virtual
`90` Sem pagamento
`99` Outros",
"type": "integer",
"readOnly": true,
"example": 15
}
},
"type": "object"
},
"ContasReceberNotaFiscalDTO": {
"required": [
"numero"
],
"properties": {
"numero": {
"type": "string",
"example": "000001"
}
},
"type": "object"
},
"ContasReceberOcorrenciaUnicaDTO": {
"required": [
"tipo"
],
"properties": {
"tipo": {
"description": "`1` Única
Ignorado no método PUT",
"type": "integer",
"enum": [
1
],
"example": 1
}
},
"type": "object"
},
"ContasReceberOcorrenciaParceladaDTO": {
"required": [
"tipo",
"diaVencimento"
],
"properties": {
"tipo": {
"description": "`2` Parcelada
Ignorado no método PUT",
"type": "integer",
"enum": [
2
],
"example": 2
},
"considerarDiasUteis": {
"description": "Ignorado no método PUT",
"type": "boolean",
"example": true
},
"diaVencimento": {
"type": "integer",
"example": "25"
},
"numeroParcelas": {
"description": "Ignorado no método PUT",
"type": "integer",
"example": 1
}
},
"type": "object"
},
"ContasReceberOcorrenciaDTO": {
"required": [
"tipo",
"diaVencimento"
],
"properties": {
"tipo": {
"description": "`3` Mensal
`4` Bimestral
`5` Trimestral
`6` Semestral
`7` Anual
`8` Quinzenal
Ignorado no método PUT",
"type": "integer",
"enum": [
3,
4,
5,
6,
7,
8
],
"example": 3
},
"considerarDiasUteis": {
"description": "Ignorado no método PUT",
"type": "boolean",
"example": true
},
"diaVencimento": {
"type": "integer",
"example": "25"
},
"dataLimite": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
"type": "object"
},
"ContasReceberOcorrenciaSemanalDTO": {
"required": [
"tipo",
"diaSemanaVencimento"
],
"properties": {
"tipo": {
"description": "`9` Semanal
Ignorado no método PUT",
"type": "integer",
"enum": [
9
],
"example": 9
},
"considerarDiasUteis": {
"description": "Ignorado no método PUT",
"type": "boolean",
"example": true
},
"diaSemanaVencimento": {
"type": "integer",
"example": "25"
},
"dataLimite": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
"type": "object"
},
"ContasReceberOrigemDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID da venda ou nota fiscal que originou a conta.",
"type": "integer",
"example": 5436875653
}
},
"type": "object"
},
"ContasReceberVendaDTO": {
"required": [
"numero"
],
"properties": {
"numero": {
"type": "string",
"example": "123"
}
},
"type": "object"
},
"ContasReceberVendedorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContatosDadoAdicionalDTO": {
"properties": {
"dataNascimento": {
"type": "string",
"format": "date",
"example": "1990-08-24"
},
"sexo": {
"description": "`M` Masculino
`F` Feminino",
"type": "string",
"enum": [
"M",
"F"
],
"example": "M"
},
"naturalidade": {
"type": "string",
"example": "Brasileira"
}
},
"type": "object"
},
"ContatosDadosBaseDTO": {
"required": [
"id",
"nome",
"situacao"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"nome": {
"type": "string",
"example": "Contato"
},
"codigo": {
"type": "string",
"example": "ASD001"
},
"situacao": {
"description": "Situação do contato
`A` Ativo
`E` Excluído
`I` Inativo
`S` Sem movimentação",
"type": "string",
"enum": [
"A",
"E",
"I",
"S"
],
"example": "A"
},
"numeroDocumento": {
"description": "CPF ou CNPJ do contato",
"type": "string",
"example": "123.456.789-10"
},
"telefone": {
"type": "string",
"example": "(54) 3333-4444"
},
"celular": {
"type": "string",
"example": "(54) 99999-8888"
}
},
"type": "object"
},
"ContatosDadosDTO": {
"required": [
"tipo"
],
"properties": {
"fantasia": {
"type": "string",
"example": "Nome fantasia"
},
"tipo": {
"description": "Tipo da pessoa
`J` Jurídica
`F` Física
`E` Estrangeira",
"type": "string",
"enum": [
"J",
"F",
"E"
],
"example": "J"
},
"indicadorIe": {
"description": "Indicador de inscrição estadual
`1` Contribuinte ICMS
`2` Contribuinte isento de Inscrição no cadastro de Contribuintes
`9` Não Contribuinte",
"type": "integer",
"enum": [
1,
2,
9
],
"example": 1
},
"ie": {
"description": "Inscrição estadual",
"type": "string",
"example": "123.456.789.101"
},
"rg": {
"description": "RG do contato caso for pessoa física",
"type": "string",
"example": "1234567890"
},
"inscricaoMunicipal": {
"description": "Inscrição Municipal da empresa. Apenas para pessoa jurídica",
"type": "string",
"example": "123456789012"
},
"orgaoEmissor": {
"description": "Órgão emissor caso for pessoa física",
"type": "string",
"example": "1234567890"
},
"email": {
"type": "string",
"example": "contato@email.com"
},
"emailNotaFiscal": {
"description": "E-mail para envio da NF-e",
"type": "string",
"example": "fiscal@email.com"
},
"numeroDocumento": {
"description": "CPF ou CNPJ do contato",
"type": "string",
"example": "12345678910"
},
"orgaoPublico": {
"description": "Órgão público?
`N` Não
`M` Municipal
`E` Estadual
`F` Federal",
"type": "string",
"enum": [
"N",
"M",
"E",
"F"
],
"example": "N"
},
"endereco": {
"$ref": "#/components/schemas/ContatosEnderecoDTO"
},
"vendedor": {
"$ref": "#/components/schemas/ContatosVendedorDTO"
},
"dadosAdicionais": {
"$ref": "#/components/schemas/ContatosDadoAdicionalDTO"
},
"financeiro": {
"$ref": "#/components/schemas/ContatosFinanceiroDTO"
},
"pais": {
"$ref": "#/components/schemas/ContatosPaisDTO"
},
"tiposContato": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContatosTipoContatoDTO"
}
},
"pessoasContato": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContatosPessoaContatoDTO"
}
}
},
"type": "object"
},
"ContatosEnderecoDTO": {
"properties": {
"geral": {
"$ref": "#/components/schemas/ContatosEnderecoDadosDTO"
},
"cobranca": {
"$ref": "#/components/schemas/ContatosEnderecoDadosDTO"
}
},
"type": "object"
},
"ContatosEnderecoDadosDTO": {
"properties": {
"endereco": {
"type": "string",
"example": "R. Olavo Bilac"
},
"cep": {
"type": "string",
"example": "95702-000"
},
"bairro": {
"type": "string",
"example": "Imigrante"
},
"municipio": {
"type": "string",
"example": "Bento Gonçalves"
},
"uf": {
"type": "string",
"example": "RS"
},
"numero": {
"type": "string",
"example": "914"
},
"complemento": {
"type": "string",
"example": "Sede 101"
}
},
"type": "object"
},
"ContatosFinanceiroCategoriaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContatosFinanceiroDTO": {
"properties": {
"limiteCredito": {
"description": "Limite de crédito do cliente",
"type": "number",
"format": "float",
"default": 0,
"example": 0
},
"condicaoPagamento": {
"description": "Número de parcelas ou prazos",
"type": "string",
"example": "30"
},
"categoria": {
"$ref": "#/components/schemas/ContatosFinanceiroCategoriaDTO"
}
},
"type": "object"
},
"ContatosPaisDTO": {
"properties": {
"nome": {
"description": "Nome do país do contato estrangeiro",
"type": "string",
"example": "ESTADOS UNIDOS"
}
},
"type": "object"
},
"ContatosPessoaContatoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"descricao": {
"type": "string",
"example": "Fornecedor Fulano"
}
},
"type": "object"
},
"ContatosTipoContatoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"descricao": {
"type": "string",
"example": "Fornecedor"
}
},
"type": "object"
},
"ContatosVendedorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContratosCategoriaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContratosCobrancaContatoDTO": {
"properties": {
"id": {
"description": "Deve ser informado apenas quando o contato de cobrança for diferente do contato vinculado ao contrato.",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContratosCobrancaDTO": {
"properties": {
"dataBase": {
"type": "string",
"format": "date",
"example": "2023-02-22"
},
"contato": {
"$ref": "#/components/schemas/ContratosCobrancaContatoDTO"
},
"vencimento": {
"$ref": "#/components/schemas/ContratosCobrancaVencimentoDTO"
}
},
"type": "object"
},
"ContratosCobrancaVencimentoDTO": {
"properties": {
"tipo": {
"description": "`1` No mês corrente
`2` No mês seguinte
`3` Em dois meses",
"type": "integer",
"enum": [
1,
2,
3
],
"example": 1
},
"dia": {
"description": "Caso o dia informado não exista em um determinado mês(29, 30, 31), o vencimento da cobrança utilizará o ultimo dia válido do mês.",
"type": "integer",
"example": 10
},
"periodicidade": {
"description": "`1` Mensal
`2` Bimestral
`3` Trimestral
`4` Semestral
`5` Anual
`6` Bianual
`7` Trianual",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"example": 1
}
},
"type": "object"
},
"ContratosContaContabilDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContratosContatoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContratosDadosBaseDTO": {
"required": [
"descricao",
"data",
"numero",
"valor",
"situacao",
"contato"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 123455678
},
"descricao": {
"type": "string",
"example": "Alugel do apartamento A102"
},
"data": {
"description": "Data de criação do contrato.",
"type": "string",
"format": "date",
"example": "2023-02-19"
},
"numero": {
"type": "string",
"example": "25"
},
"valor": {
"type": "number",
"format": "float",
"example": 59.99
},
"situacao": {
"description": "`0` Inativo
`1` Ativo
`2` Baixado
`3` Isento
`4` Em avaliação",
"type": "integer",
"enum": [
0,
1,
2,
3,
4
],
"example": 1
},
"contato": {
"$ref": "#/components/schemas/ContratosContatoDTO"
}
},
"type": "object"
},
"ContratosDadosDTO": {
"required": [
"dataFim",
"tipoManutencao",
"emitirOrdemServico",
"observacoes",
"vendedor",
"categoria",
"desconto",
"contaContabil",
"formaPagamento",
"cobranca"
],
"properties": {
"dataFim": {
"description": "Formato: YYYY-MM",
"type": "string",
"example": "2024-05"
},
"tipoManutencao": {
"description": "`1` Valor
`2` Indexação",
"type": "integer",
"enum": [
1,
2
],
"example": 1
},
"emitirOrdemServico": {
"type": "boolean",
"example": false
},
"observacoes": {
"type": "string",
"example": ""
},
"vendedor": {
"$ref": "#/components/schemas/ContratosVendedorDTO"
},
"categoria": {
"$ref": "#/components/schemas/ContratosCategoriaDTO"
},
"desconto": {
"$ref": "#/components/schemas/ContratosDescontoDTO"
},
"contaContabil": {
"$ref": "#/components/schemas/ContratosContaContabilDTO"
},
"formaPagamento": {
"$ref": "#/components/schemas/ContratosFormaPagamentoDTO"
},
"notaFiscal": {
"$ref": "#/components/schemas/ContratosNotaFiscalDTO"
},
"cobranca": {
"$ref": "#/components/schemas/ContratosCobrancaDTO"
}
},
"type": "object"
},
"ContratosDescontoDTO": {
"required": [
"valor",
"dataFim"
],
"properties": {
"valor": {
"type": "number",
"format": "float",
"example": 4.99
},
"dataFim": {
"description": "Formato: YYYY-MM",
"type": "string",
"example": "2023-02"
}
},
"type": "object"
},
"ContratosFormaPagamentoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContratosNotaFiscalDTO": {
"properties": {
"mes": {
"description": "`1` Não imprime
`2` Mês atual
`3` Mês anterior
Período de referência da cobrança que será incluído nas informações complementares das notas fiscais e observações da conta a receber.",
"type": "integer",
"enum": [
1,
2,
3
],
"example": 2
},
"gerar": {
"description": "`1` Não
`2` Ao gerar cobrança",
"type": "integer",
"enum": [
1,
2
],
"example": 1
},
"descontarImpostoRenda": {
"description": "`1` Sim
`2` Não
`3` Utilizar padrão da configuração da NFS-e
Reter o IR e descontar do total da NFS-e caso ultrapasse R$ 10,00.",
"type": "integer",
"enum": [
1,
2,
3
],
"example": 1
},
"texto": {
"description": "Texto a ser incluído nas informações complementares da NF-e ou como descrição do serviço na NFS-e.",
"type": "string",
"example": "Exemplo de texto."
},
"cfop": {
"description": "Código fiscal.",
"type": "string",
"example": "5.556"
},
"iss": {
"$ref": "#/components/schemas/ContratosNotaFiscalISSDTO"
},
"item": {
"$ref": "#/components/schemas/ContratosNotaFiscalItemDTO"
}
},
"type": "object"
},
"ContratosNotaFiscalISSDTO": {
"properties": {
"descontar": {
"description": "Reter o ISS e descontar do total da nota.",
"type": "boolean",
"example": false
},
"aliquota": {
"description": "Percentual ISS específico para este contrato. Deixe este campo zerado para utilizar o padrão.",
"type": "number",
"format": "float",
"example": 2.5
}
},
"type": "object"
},
"ContratosNotaFiscalItemDTO": {
"properties": {
"codigoServico": {
"description": "Código do serviço conforme tabela de serviços.",
"type": "string",
"example": "14.13"
},
"produto": {
"$ref": "#/components/schemas/ContratosNotaFiscalItemProdutoDTO"
}
},
"type": "object"
},
"ContratosNotaFiscalItemProdutoDTO": {
"properties": {
"id": {
"description": "ID do produto do tipo produto ou serviço.",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ContratosVendedorComissaoDTO": {
"required": [
"aliquota",
"numeroParcelas"
],
"properties": {
"aliquota": {
"type": "number",
"format": "float",
"example": 0.5
},
"numeroParcelas": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"ContratosVendedorDTO": {
"required": [
"id",
"comissao"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"comissao": {
"$ref": "#/components/schemas/ContratosVendedorComissaoDTO"
}
},
"type": "object"
},
"DepositosDadosDTO": {
"required": [
"descricao",
"situacao",
"padrao",
"desconsiderarSaldo"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"descricao": {
"type": "string",
"example": "Depósito Geral"
},
"situacao": {
"description": "`0` Inativo
`1` Ativo",
"type": "integer",
"enum": [
0,
1
],
"example": 1
},
"padrao": {
"type": "boolean",
"example": false
},
"desconsiderarSaldo": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"EmpresasDadosBasicosDTO": {
"properties": {
"id": {
"description": "ID da empresa.",
"type": "string",
"example": "436c56a5679921f5f13a3d6433561773"
},
"nome": {
"description": "Nome da empresa.",
"type": "string",
"example": "Empresa Teste LTDA"
},
"cnpj": {
"description": "CNPJ da empresa.",
"type": "string",
"example": "12.345.657/8910-11"
},
"email": {
"description": "Email da empresa.",
"type": "string",
"example": "empresa@email.com"
},
"dataContrato": {
"description": "Data de início do contrato do plano.",
"type": "string",
"format": "date",
"example": "2024-12-31"
}
},
"type": "object"
},
"EstoquesDadosBaseDTO": {
"required": [
"quantidade",
"operacao"
],
"properties": {
"operacao": {
"description": "`B` Balanço
`E` Entrada
`S` Saída",
"type": "string",
"enum": [
"B",
"E",
"S"
],
"example": "B"
},
"preco": {
"description": "Preço unitário",
"type": "number",
"format": "float",
"example": 1500.75
},
"custo": {
"description": "Custo unitário",
"type": "number",
"format": "float",
"example": 1500.75
},
"quantidade": {
"type": "number",
"format": "float",
"example": 50.75
},
"observacoes": {
"type": "string",
"example": "Observações de estoque"
}
},
"type": "object"
},
"EstoquesDadosDTO": {
"required": [
"produto",
"deposito"
],
"properties": {
"produto": {
"$ref": "#/components/schemas/EstoquesProdutoDTO"
},
"deposito": {
"$ref": "#/components/schemas/EstoquesDepositoBaseDTO"
}
},
"type": "object"
},
"EstoquesDepositoBaseDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"EstoquesDepositoDTO": {
"properties": {
"saldoFisico": {
"description": "Saldo físico do produto",
"type": "number",
"format": "float",
"example": 1250.75
},
"saldoVirtual": {
"description": "Saldo do produto desconsiderando produtos reservados",
"type": "number",
"format": "float",
"example": 1250.75
}
},
"type": "object"
},
"EstoquesProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"codigo": {
"type": "string",
"readOnly": true,
"example": "12345678"
}
},
"type": "object"
},
"EstoquesSaldosBaseDTO": {
"properties": {
"produto": {
"$ref": "#/components/schemas/EstoquesProdutoDTO"
},
"saldoFisicoTotal": {
"description": "Saldo físico total do produto",
"type": "number",
"format": "float",
"example": 1500.75
},
"saldoVirtualTotal": {
"description": "Saldo total do produto desconsiderando produtos reservados",
"type": "number",
"format": "float",
"example": 1500.75
}
},
"type": "object"
},
"EstoquesSaldosDTO": {
"properties": {
"depositos": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/EstoquesDepositoBaseDTO"
},
{
"$ref": "#/components/schemas/EstoquesDepositoDTO"
}
]
}
}
},
"type": "object"
},
"ContasFinanceirasDadosBasicosDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"descricao": {
"type": "string",
"readOnly": true,
"example": "Conta Contábil"
}
},
"type": "object"
},
"FormasPagamentosAlterarSituacaoDTO": {
"required": [
"situacao"
],
"properties": {
"situacao": {
"description": "Situação que será alterada
`1` Ativa
`0` Inativa",
"type": "integer",
"enum": [
0,
1
],
"example": 1
}
},
"type": "object"
},
"FormasPagamentosDadosBaseDTO": {
"required": [
"descricao",
"tipoPagamento",
"finalidade"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"descricao": {
"description": "",
"type": "string",
"example": "Dinheiro"
},
"tipoPagamento": {
"description": "`1` Dinheiro
`2` Cheque
`3` Cartão de Crédito
`4` Cartão de Débito
`5` Cartão da Loja (Private Label)
`10` Vale Alimentação
`11` Vale Refeição
`12` Vale Presente
`13` Vale Combustível
`14` Duplicata Mercantil
`15` Boleto Bancário
`16` Depósito Bancário
`17` Pagamento Instantâneo (PIX) - Dinâmico
`18` Transferência Bancária, Carteira Digital
`19` Programa de Fidelidade, Cashback, Crédito Virtual
`20` Pagamento Instantâneo (PIX) – Estático
`21` Crédito em loja
`22` Pagamento Eletrônico não Informado - falha de hardware do sistema emissor
`90` Sem pagamento
`99` Outros
",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
90,
99
],
"example": 1
},
"situacao": {
"description": "`0` Inativa
`1` Ativa
",
"type": "integer",
"enum": [
0,
1
],
"example": 1
},
"fixa": {
"type": "boolean",
"readOnly": true,
"example": false
},
"padrao": {
"description": "`0` Não
`1` Padrão
`2` Padrão devolução",
"type": "integer",
"enum": [
0,
1,
2
],
"example": 0
},
"finalidade": {
"description": "`1` Pagamentos
`2` Recebimentos
`3` Pagamentos e Recebimentos
",
"type": "integer",
"enum": [
1,
2,
3
],
"example": 1
},
"juros": {
"description": "Valor em porcentagem, com até 2 casas decimais.",
"type": "number",
"format": "float",
"example": 0
},
"multa": {
"description": "Valor em porcentagem, com até 2 casas decimais.",
"type": "number",
"format": "float",
"example": 0
}
},
"type": "object"
},
"FormasPagamentosDadosCartaoDTO": {
"required": [
"bandeira",
"tipo"
],
"properties": {
"bandeira": {
"description": "`1` Visa
`2` Mastercard
`3` American Express
`4` Sorocred
`5` Diners Club
`6` Elo
`7` Hipercard
`8` Aura
`9` Cabal
`99` Outros",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
99
],
"example": 1
},
"tipo": {
"description": "`1` TEF
`2` POS",
"type": "integer",
"enum": [
1,
2
],
"example": 1
},
"cnpjCredenciadora": {
"description": "CNPJ da credenciadora.",
"type": "string",
"example": "67168564000109"
},
"autoLiquidacao": {
"description": "`0` Não
`1` Sim - Liquidação automática dos recebíveis",
"type": "integer",
"enum": [
0,
1
],
"example": 1
}
},
"type": "object"
},
"FormasPagamentosDadosDTO": {
"description": "O campo `dadosCartao` é utilizado quando o `tipoPagamento` for `3` ou `4`.",
"required": [
"destino",
"finalidade"
],
"properties": {
"condicao": {
"description": "Condição de pagamento padrão.",
"type": "string",
"example": "1x"
},
"destino": {
"description": "`1` Conta a receber/pagar
`2` Ficha financeira
`3` Caixa e bancos",
"type": "integer",
"enum": [
1,
2,
3
],
"example": 1
},
"utilizaDiasUteis": {
"description": "Indica se a forma de pagamento utiliza lançamentos em dias úteis.",
"type": "boolean",
"example": true
},
"taxas": {
"$ref": "#/components/schemas/FormasPagamentosTaxaDTO"
},
"dadosCartao": {
"$ref": "#/components/schemas/FormasPagamentosDadosCartaoDTO"
}
},
"type": "object"
},
"FormasPagamentosDefinirPadraoDTO": {
"required": [
"padrao"
],
"properties": {
"padrao": {
"description": "`1` Pagamento
`2` Devolução
`3` Fiado",
"type": "integer",
"enum": [
1,
2,
3
],
"example": 1
}
},
"type": "object"
},
"FormasPagamentosTaxaDTO": {
"properties": {
"aliquota": {
"description": "Valor da alíquota sobre o valor da parcela.",
"type": "number",
"format": "float",
"example": 3.5
},
"valor": {
"description": "Valor em Reais somado ao valor total da parcela.",
"type": "number",
"format": "float",
"example": 1.99
},
"prazo": {
"description": "Prazo em dias que o dinheiro é retido antes de estar disponível para movimentação.",
"type": "integer",
"example": 2
}
},
"type": "object"
},
"GruposProdutosDadosDTO": {
"required": [
"nome"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 123456
},
"nome": {
"type": "string",
"example": "Grupo 1"
},
"grupoProdutoPai": {
"$ref": "#/components/schemas/GruposProdutosGrupoProdutoPaiDTO"
}
},
"type": "object"
},
"GruposProdutosGrupoProdutoPaiDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 123456
},
"nome": {
"type": "string",
"readOnly": true,
"example": "Grupo 1"
}
},
"type": "object"
},
"HomologacaoDadosBaseDTO": {
"properties": {
"nome": {
"type": "string",
"example": "Copo do Bling"
},
"preco": {
"type": "number",
"format": "float",
"example": 32.56
},
"codigo": {
"type": "string",
"example": "COD-4587"
}
},
"type": "object"
},
"HomologacaoDadosDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"HomologacaoSituacaoDTO": {
"properties": {
"situacao": {
"type": "string",
"example": "I"
}
},
"type": "object"
},
"LogisticasDadosBaseDTO": {
"required": [
"id",
"descricao",
"tipoIntegracao",
"integracaoNativa",
"situacao",
"integracao",
"servicos"
],
"properties": {
"id": {
"description": "ID da logística",
"type": "integer",
"example": 6423813145
},
"descricao": {
"description": "Descrição da logística",
"type": "string",
"example": "Correios Cliente"
},
"tipoIntegracao": {
"description": "Tipo da logística",
"type": "string",
"example": "Correios"
},
"integracaoNativa": {
"type": "boolean",
"example": false
},
"situacao": {
"description": "Situação da logística
`H` Habilitado
`D` Desabilitado",
"type": "string",
"example": "H"
},
"integracao": {
"$ref": "#/components/schemas/LogisticasIntegracaoDTO"
},
"servicos": {
"description": "ID dos serviços vinculados a logística",
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasServicoBaseDTO"
}
}
},
"type": "object"
},
"LogisticasDadosPutDTO": {
"required": [
"descricao",
"situacao"
],
"properties": {
"descricao": {
"description": "Descrição da logística",
"type": "string",
"example": "Correios Cliente"
},
"situacao": {
"description": "Situação da logística
`H` Habilitado
`D` Desabilitado",
"type": "string",
"example": "H"
}
},
"type": "object"
},
"LogisticasDadosPostDTO": {
"required": [
"descricao",
"situacao"
],
"properties": {
"descricao": {
"description": "Descrição da logística",
"type": "string",
"example": "Correios Cliente"
},
"situacao": {
"description": "Situação da logística
`H` Habilitado
`D` Desabilitado",
"type": "string",
"example": "H"
},
"servicos": {
"description": "Serviços vinculados à logística",
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticaServicoPostDTO"
}
}
},
"type": "object"
},
"LogisticasDadosDTO": {
"allOf": [
{
"$ref": "#/components/schemas/LogisticasDadosBaseDTO"
},
{
"properties": {
"servicos": {
"description": "Serviços vinculados à logística",
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasServicoDTO"
}
}
},
"type": "object"
}
]
},
"LogisticasIntegracaoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasLogisticaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasServicoBaseDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID do serviço da logística",
"type": "integer",
"example": 6423813145
}
},
"type": "object"
},
"LogisticasServicoDTO": {
"required": [
"descricao",
"freteItem",
"estimativaEntrega",
"codigo",
"logistica",
"transportador",
"aliases",
"ativo"
],
"allOf": [
{
"$ref": "#/components/schemas/LogisticasServicoBaseDTO"
},
{
"properties": {
"descricao": {
"description": "Descrição do serviço da logística",
"type": "string",
"example": "CARTA REG AR CONV B1 MFD"
},
"freteItem": {
"description": "Valor do frete que será calculado para cada item do pedido",
"type": "number",
"format": "float",
"example": 12.45
},
"estimativaEntrega": {
"description": "Será o prazo, em dias úteis, de entrega da mercadoria para esse serviço.",
"type": "integer",
"example": 2
},
"codigo": {
"description": "Código do serviço",
"type": "string",
"example": "ABC1234"
},
"logistica": {
"$ref": "#/components/schemas/LogisticasLogisticaDTO"
},
"transportador": {
"$ref": "#/components/schemas/LogisticasTransportadorDTO"
},
"aliases": {
"description": "Aliases do serviço",
"type": "array",
"items": {
"description": "Alias do serviço",
"type": "string",
"example": "ALIAS1"
}
},
"ativo": {
"description": "Indica se o serviço está ativo",
"type": "boolean",
"example": true
}
},
"type": "object"
}
]
},
"LogisticaServicoPostDTO": {
"required": [
"descricao"
],
"allOf": [
{
"properties": {
"descricao": {
"description": "Descrição do serviço da logística",
"type": "string",
"example": "CARTA REG AR CONV B1 MFD"
},
"freteItem": {
"description": "Valor do frete que será calculado para cada item do pedido",
"type": "number",
"format": "float",
"example": 12.45
},
"estimativaEntrega": {
"description": "Será o prazo, em dias úteis, de entrega da mercadoria para esse serviço.",
"type": "integer",
"example": 2
},
"codigo": {
"description": "Código do serviço",
"type": "string",
"example": "ABC1234"
},
"transportador": {
"$ref": "#/components/schemas/LogisticasTransportadorDTO"
},
"aliases": {
"description": "Aliases do serviço",
"type": "array",
"items": {
"description": "Alias do serviço",
"type": "string",
"example": "ALIAS1"
}
},
"ativo": {
"description": "Indica se o serviço está ativo",
"type": "boolean",
"example": true
}
},
"type": "object"
}
]
},
"LogisticasTransportadorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasEtiquetasDadosResponseDTO": {
"required": [
"id",
"link",
"observacao"
],
"properties": {
"id": {
"description": "ID da venda",
"type": "integer",
"example": 6423813145
},
"link": {
"description": "Link para obter a etiqueta",
"type": "string",
"example": "https://bling-storage-dev.s3.sa-east-1.amazonaws.com"
},
"observacao": {
"description": "Mensagem de observação",
"type": "string",
"example": "O formato de impressão selecionado difere do retornado pelo integrador ou pela configuração da logística."
}
},
"type": "object"
},
"LogisticasObjetosDadosCreateRequestDTO": {
"required": [
"pedidoVenda",
"notaFiscal",
"servico"
],
"allOf": [
{
"properties": {
"pedidoVenda": {
"$ref": "#/components/schemas/LogisticasObjetosPedidoVendaDTO"
},
"notaFiscal": {
"$ref": "#/components/schemas/LogisticasObjetosNotaFiscalDTO"
},
"servico": {
"$ref": "#/components/schemas/LogisticasObjetosServicoDTO"
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/LogisticasObjetosUpdateRequestDTO"
}
]
},
"LogisticasObjetosDadosDTO": {
"required": [
"pedidoVenda",
"notaFiscal",
"servico",
"dimensao",
"embalagem",
"dataSaida",
"prazoEntregaPrevisto",
"fretePrevisto",
"valorDeclarado",
"avisoRecebimento",
"maoPropria"
],
"properties": {
"pedidoVenda": {
"$ref": "#/components/schemas/LogisticasObjetosPedidoVendaDTO"
},
"notaFiscal": {
"$ref": "#/components/schemas/LogisticasObjetosNotaFiscalDTO"
},
"servico": {
"$ref": "#/components/schemas/LogisticasObjetosServicoDTO"
},
"rastreamento": {
"$ref": "#/components/schemas/LogisticasObjetosRastreamentoDTO"
},
"dimensao": {
"$ref": "#/components/schemas/LogisticasObjetosDimensaoDTO"
},
"embalagem": {
"$ref": "#/components/schemas/LogisticasObjetosEmbalagemDTO"
},
"dataSaida": {
"type": "string",
"format": "date",
"example": "2022-12-01"
},
"prazoEntregaPrevisto": {
"type": "integer",
"example": 15
},
"fretePrevisto": {
"type": "number",
"format": "float",
"example": 59.9
},
"valorDeclarado": {
"type": "number",
"format": "float",
"example": 55.9
},
"avisoRecebimento": {
"type": "boolean",
"example": false
},
"maoPropria": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"LogisticasObjetosUpdateRequestDTO": {
"required": [
"dimensao",
"embalagem",
"dataSaida",
"prazoEntregaPrevisto",
"fretePrevisto",
"valorDeclarado",
"avisoRecebimento",
"maoPropria"
],
"properties": {
"rastreamento": {
"$ref": "#/components/schemas/LogisticasObjetosRastreamentoDTO"
},
"dimensoes": {
"$ref": "#/components/schemas/LogisticasObjetosDimensaoDTO"
},
"embalagem": {
"$ref": "#/components/schemas/LogisticasObjetosEmbalagemDTO"
},
"dataSaida": {
"type": "string",
"format": "date",
"example": "2022-12-01"
},
"prazoEntregaPrevisto": {
"type": "integer",
"example": 15
},
"fretePrevisto": {
"type": "number",
"format": "float",
"example": 59.9
},
"valorDeclarado": {
"type": "number",
"format": "float",
"example": 55.9
},
"avisoRecebimento": {
"type": "boolean",
"example": false
},
"maoPropria": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"LogisticasObjetosDimensaoDTO": {
"required": [
"peso",
"altura",
"largura",
"comprimento",
"diametro"
],
"properties": {
"peso": {
"type": "number",
"format": "float",
"example": 1.5
},
"altura": {
"type": "number",
"format": "float",
"example": 1.5
},
"largura": {
"type": "number",
"format": "float",
"example": 1.5
},
"comprimento": {
"type": "number",
"format": "float",
"example": 1.5
},
"diametro": {
"type": "number",
"format": "float",
"example": 1.5
}
},
"type": "object"
},
"LogisticasObjetosEmbalagemDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID do produto utilizado como embalagem",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasObjetosNotaFiscalDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasObjetosObjetoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasObjetosPedidoVendaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasObjetosRastreamentoDTO": {
"required": [
"codigo",
"descricao",
"situacao",
"origem",
"destino",
"ultimaAlteracao",
"url"
],
"properties": {
"codigo": {
"type": "string",
"example": "EC272330554BR"
},
"descricao": {
"type": "string",
"example": "Criado"
},
"situacao": {
"description": "`0` Postado
`1` Em andamento
`2` Não entregue
`3` Entregue
`4` Aguardando retirada
`5` Etiqueta comprada
`6` Vinculado
`7` Atrasado
`8` Não postado (recomendado para objetos recém-criados)
`9` Entrega suspensa",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"example": "8"
},
"origem": {
"description": "Cidade e estado de origem",
"type": "string",
"example": "São Paulo, SP"
},
"destino": {
"description": "Cidade e estado de destino",
"type": "string",
"example": "São Paulo, SP"
},
"ultimaAlteracao": {
"description": "Data e hora em que ocorreu a atualização de rastreio.",
"type": "string",
"format": "date-time",
"example": "2020-11-11 16:40:33"
},
"url": {
"description": "URL de rastreamento",
"type": "string",
"example": "https://www.rastreamento.exemplo.com.br/EC272330554BR"
}
},
"type": "object"
},
"LogisticasObjetosServicoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasRemessasDadosBaseDTOCommon": {
"required": [
"id",
"numeroPlp",
"situacao",
"descricao",
"dataCriacao"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"numeroPlp": {
"type": "string",
"example": "749fdc73"
},
"situacao": {
"description": "`-3` A ser corrigida
`-2` Em processamento
`-1` Cancelado
`0` Em aberto
`1` Emitido
`2` Pronto para envio
`3` Despachado
`4` Pronto para envio
`5` Etiqueta comprada
`6` Etiqueta parcialmente comprada",
"type": "integer",
"enum": [
-3,
-2,
-1,
0,
1,
2,
3,
4
]
},
"descricao": {
"type": "string",
"example": "Remessa_18092023"
},
"dataCriacao": {
"type": "string",
"readOnly": true,
"example": "2023-09-18"
}
},
"type": "object"
},
"LogisticasRemessasDadosBaseDTO": {
"required": [
"logistica",
"objetos"
],
"allOf": [
{
"$ref": "#/components/schemas/LogisticasRemessasDadosBaseDTOCommon"
},
{
"properties": {
"logistica": {
"$ref": "#/components/schemas/LogisticasLogisticaRemessaDTO"
},
"objetos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasRemessasObjetosDTO"
}
}
},
"type": "object"
}
]
},
"LogisticasRemessasDadosDTO": {
"required": [
"objetos"
],
"allOf": [
{
"$ref": "#/components/schemas/LogisticasRemessasDadosBaseDTOCommon"
},
{
"properties": {
"objetos": {
"type": "array",
"items": {
"description": "ID do objeto de postagem",
"type": "integer",
"example": 6423813145
}
}
},
"type": "object"
}
]
},
"LogisticasRemessasDadosPostDTO": {
"required": [
"objetos"
],
"allOf": [
{
"$ref": "#/components/schemas/LogisticasRemessasDadosBaseDTOCommon"
},
{
"properties": {
"logistica": {
"$ref": "#/components/schemas/LogisticasLogisticaRemessaDTO"
},
"objetos": {
"type": "array",
"items": {
"type": "string",
"example": "12"
}
}
},
"type": "object"
}
]
},
"LogisticasRemessasDimensaoDTO": {
"required": [
"peso",
"altura",
"largura",
"comprimento",
"diametro"
],
"properties": {
"peso": {
"type": "number",
"format": "float",
"example": 1.5
},
"altura": {
"type": "number",
"format": "float",
"example": 1.5
},
"largura": {
"type": "number",
"format": "float",
"example": 1.5
},
"comprimento": {
"type": "number",
"format": "float",
"example": 1.5
},
"diametro": {
"type": "number",
"format": "float",
"example": 1.5
}
},
"type": "object"
},
"LogisticasRemessasEmbalagemDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID do produto utilizado como embalagem",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasLogisticaRemessaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasRemessasNotaFiscalDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasRemessasObjetosDTO": {
"required": [
"id",
"pedidoVenda",
"notaFiscal",
"servico",
"rastreamento",
"dimensao",
"embalagem",
"dataSaida",
"prazoEntregaPrevisto",
"fretePrevisto",
"valorDeclarado",
"avisoRecebimento",
"maoPropria"
],
"properties": {
"id": {
"type": "integer",
"example": "1235456"
},
"remessa": {
"$ref": "#/components/schemas/LogisticasRemessaRemessaDTO"
},
"pedidoVenda": {
"$ref": "#/components/schemas/LogisticasRemessasPedidoVendaDTO"
},
"notaFiscal": {
"$ref": "#/components/schemas/LogisticasRemessasNotaFiscalDTO"
},
"servico": {
"$ref": "#/components/schemas/LogisticasRemessasServicoDTO"
},
"rastreamento": {
"$ref": "#/components/schemas/LogisticasRemessasRastreamentoDTO"
},
"dimensao": {
"$ref": "#/components/schemas/LogisticasRemessasDimensaoDTO"
},
"embalagem": {
"$ref": "#/components/schemas/LogisticasRemessasEmbalagemDTO"
},
"dataSaida": {
"type": "string",
"format": "date",
"example": "2022-12-01"
},
"prazoEntregaPrevisto": {
"type": "integer",
"example": 15
},
"fretePrevisto": {
"type": "number",
"format": "float",
"example": 59.9
},
"valorDeclarado": {
"type": "number",
"format": "float",
"example": 55.9
},
"avisoRecebimento": {
"type": "boolean",
"example": false
},
"maoPropria": {
"type": "boolean",
"example": false
}
},
"type": "object"
},
"LogisticasRemessasPedidoVendaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasRemessasRastreamentoDTO": {
"required": [
"codigo",
"descricao",
"situacao",
"origem",
"destino",
"ultimaAlteracao",
"url"
],
"properties": {
"codigo": {
"type": "string",
"example": "EC272330554BR"
},
"descricao": {
"type": "string",
"example": "Criado"
},
"situacao": {
"description": "`0` Postado
`1` Em andamento
`2` Não entregue
`3` Entregue
`4` Aguardando retirada
`5` Em aberto
`6` Vinculado
`7` Atrasado
`8` Não postado
`9` Entrega suspensa",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"example": 1
},
"origem": {
"description": "Cidade e estado de origem",
"type": "string",
"example": "São Paulo, SP"
},
"destino": {
"description": "Cidade e estado de destino",
"type": "string",
"example": "São Paulo, SP"
},
"ultimaAlteracao": {
"description": "Data e hora em que ocorreu a atualização de rastreio.",
"type": "string",
"format": "date-time",
"example": "2020-11-11 16:40:33"
},
"url": {
"description": "URL de rastreamento",
"type": "string",
"example": "https://www.rastreamento.exemplo.com.br/EC272330554BR"
}
},
"type": "object"
},
"LogisticasRemessaRemessaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasRemessasServicoDTO": {
"required": [
"id",
"nome",
"codigo"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"example": "SEDEX 10 A VISTA"
},
"codigo": {
"type": "string",
"example": "04790"
}
},
"type": "object"
},
"LogisticasServicosDadosCreateRequestDTO": {
"required": [
"logistica",
"servicos"
],
"properties": {
"logistica": {
"$ref": "#/components/schemas/LogisticasServicosLogisticaDTO"
},
"servicos": {
"description": "Serviços da logística",
"type": "array",
"items": {
"$ref": "#/components/schemas/LogisticasServicosDadosSaveRequestDTO"
}
}
},
"type": "object"
},
"LogisticasServicosDadosDTO": {
"required": [
"descricao",
"freteItem",
"estimativaEntrega",
"codigo",
"logistica",
"transportador",
"aliases"
],
"properties": {
"id": {
"description": "Id do serviço",
"type": "integer",
"example": "123445"
},
"descricao": {
"description": "Descrição do serviço da logística",
"type": "string",
"example": "CARTA REG AR CONV B1 MFD"
},
"codigo": {
"description": "Código do serviço",
"type": "string",
"example": "ABC1234"
},
"aliases": {
"description": "Aliases do serviço",
"type": "array",
"items": {
"description": "Alias do serviço",
"type": "string",
"example": "ALIAS1"
}
},
"ativo": {
"description": "Define se está ativo ou não",
"type": "boolean",
"example": true
},
"freteItem": {
"description": "Valor do frete que será calculado para cada item do pedido",
"type": "number",
"format": "float",
"example": 12.45
},
"estimativaEntrega": {
"description": "Será o prazo, em dias úteis, de entrega da mercadoria para esse serviço.",
"type": "integer",
"example": 2
},
"idCodigoServico": {
"description": "Id do código do servico",
"type": "string",
"example": 13112
},
"logistica": {
"$ref": "#/components/schemas/LogisticasServicosLogisticaDTO"
},
"transportador": {
"$ref": "#/components/schemas/LogisticasServicosTransportadorDTO"
}
},
"type": "object"
},
"LogisticasServicosDadosSaveRequestDTO": {
"required": [
"descricao",
"freteItem",
"estimativaEntrega",
"codigo",
"aliases"
],
"properties": {
"descricao": {
"description": "Descrição do serviço da logística",
"type": "string",
"example": "CARTA REG AR CONV B1 MFD"
},
"codigo": {
"description": "Código do serviço",
"type": "string",
"example": "ABC1234"
},
"aliases": {
"description": "Aliases do serviço",
"type": "array",
"items": {
"description": "Alias do serviço",
"type": "string",
"example": "ALIAS1"
}
},
"ativo": {
"description": "Define se está ativo ou não",
"type": "boolean",
"example": true
},
"freteItem": {
"description": "Valor do frete que será calculado para cada item do pedido",
"type": "number",
"format": "float",
"example": 12.45
},
"estimativaEntrega": {
"description": "Será o prazo, em dias úteis, de entrega da mercadoria para esse serviço.",
"type": "integer",
"example": 2
},
"idCodigoServico": {
"description": "Id do código do servico",
"type": "string",
"example": 13112
},
"transportador": {
"$ref": "#/components/schemas/LogisticasServicosTransportadorDTO"
}
},
"type": "object"
},
"LogisticasServicosDadosSaveDTO": {
"properties": {
"id": {
"description": "Id do serviço",
"type": "integer",
"example": "123445"
}
},
"type": "object"
},
"LogisticasServicosDadosSituationDTO": {
"required": [
"ativo"
],
"properties": {
"ativo": {
"description": "Define se está ativo ou não",
"type": "boolean",
"example": true
}
},
"type": "object"
},
"LogisticasServicosLogisticaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LogisticasServicosTransportadorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"NaturezasOperacoesDadosDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"situacao": {
"description": "`0` Inativo
`1` Ativo",
"type": "integer",
"enum": [
0,
1
],
"example": 1
},
"padrao": {
"description": "`0` Sem padrão
`1` Padrão venda
`2` Padrão compra
`3` Padrão venda física
`4` Padrão venda jurídica
`5` Padrão compra física
`6` Padrão compra jurídica
`7` Padrão venda cupom
`8` Padrão devolução (entrada)
`9` Padrão devolução (saída) ",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
9
],
"example": 1
},
"descricao": {
"type": "string",
"example": "Compra de Mercadoria"
}
},
"type": "object"
},
"NotasFiscaisContatoDTO": {
"required": [
"nome",
"tipoPessoa",
"numeroDocumento",
"contribuinte"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"nome": {
"type": "string",
"example": "Contato do Bling"
},
"tipoPessoa": {
"description": "`F` Física
`J` Jurídica
`E` Estrangeira.",
"type": "string",
"enum": [
"F",
"J",
"E"
],
"writeOnly": true,
"example": "J"
},
"numeroDocumento": {
"description": "CNPJ ou CPF.",
"type": "string",
"example": "30188025000121"
},
"ie": {
"type": "string",
"example": "7364873393"
},
"rg": {
"type": "string",
"example": "451838701"
},
"contribuinte": {
"description": "`1` Contribuinte do ICMS
`2` Contribuinte isento de ICMS
`9` Não contribuinte.",
"type": "integer",
"enum": [
1,
2,
9
],
"writeOnly": true,
"example": 1
},
"telefone": {
"type": "string",
"example": "54 3771-7278"
},
"email": {
"type": "string",
"example": "pedrosilva@bling.com.br"
},
"endereco": {
"$ref": "#/components/schemas/NotasFiscaisContatoEnderecoDTO"
}
},
"type": "object"
},
"NotasFiscaisContatoEnderecoDTO": {
"required": [
"endereco",
"bairro",
"municipio"
],
"properties": {
"endereco": {
"type": "string",
"example": "Olavo Bilac"
},
"numero": {
"type": "string",
"example": "914"
},
"complemento": {
"type": "string",
"example": "Sala 101"
},
"bairro": {
"type": "string",
"example": "Imigrante"
},
"cep": {
"type": "string",
"example": "95702-000"
},
"municipio": {
"type": "string",
"example": "Bento Gonçalves"
},
"uf": {
"type": "string",
"example": "RS"
},
"pais": {
"description": "País do cliente, caso o cliente for estrangeiro (uf: UX)",
"type": "string",
"example": ""
}
},
"type": "object"
},
"NotasFiscaisDadosBaseDTO": {
"required": [
"tipo",
"contato",
"numero",
"dataOperacao",
"naturezaOperacao"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"tipo": {
"description": "`0` Entrada
`1` Saída",
"type": "integer",
"enum": [
0,
1
],
"example": 1
},
"situacao": {
"description": "`1` Pendente
`2` Cancelada
`3` Aguardando recibo
`4` Rejeitada
`5` Autorizada
`6` Emitida DANFE
`7` Registrada
`8` Aguardando protocolo
`9` Denegada
`10` Consulta situação
`11` Bloqueada",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"readOnly": true,
"example": 1
},
"numero": {
"type": "string",
"example": "6541"
},
"dataEmissao": {
"description": "Data e hora da emissão.",
"type": "string",
"format": "datetime",
"readOnly": true,
"example": "2023-01-12 09:52:12"
},
"dataOperacao": {
"description": "Data de saída/entrada de acordo com o tipo da nota.",
"type": "string",
"format": "datetime",
"example": "2023-01-12 09:52:12"
},
"chaveAcesso": {
"type": "string",
"readOnly": true
},
"contato": {
"$ref": "#/components/schemas/NotasFiscaisContatoDTO"
},
"naturezaOperacao": {
"$ref": "#/components/schemas/NotasFiscaisNaturezaOperacaoDTO"
},
"loja": {
"$ref": "#/components/schemas/NotasFiscaisLojaDTO"
}
},
"type": "object"
},
"NotasFiscaisDadosGetDTO": {
"required": [
"data",
"valor"
],
"properties": {
"serie": {
"type": "integer",
"example": "1"
},
"valorNota": {
"type": "number",
"format": "float",
"example": 10.3
},
"valorFrete": {
"type": "number",
"format": "float",
"example": 10.3
},
"finalidade": {
"description": "`1` Normal
`2` Complementar
`3` Ajuste
`4` Devolução
`5` Crédito
`6` Débito",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6
],
"example": 1
},
"tipoNota": {
"description": "Presente quando finalidade for 5 (Crédito) ou 6 (Débito).
**Crédito (finalidade 5):**
`01` Multa e juros
`02` Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM
`03` Retorno
`04` Redução de valores
**Débito (finalidade 6):**
`01` Transferência de créditos para Cooperativas
`02` Anulação de Crédito por Saídas Imunes/Isentas
`03` Débitos de notas fiscais não processadas na apuração
`04` Multa e juros
`05` Transferência de crédito de sucessão
`06` Pagamento antecipado
`07` Perda em estoque",
"type": "string",
"example": "01"
},
"xml": {
"type": "string",
"readOnly": true
},
"linkDanfe": {
"type": "string",
"readOnly": true
},
"linkPDF": {
"type": "string",
"readOnly": true
},
"optanteSimplesNacional": {
"type": "boolean",
"readOnly": true
},
"numeroPedidoLoja": {
"type": "string",
"readOnly": true
},
"transporte": {
"$ref": "#/components/schemas/NotasFiscaisTransporteGetDTO"
},
"vendedor": {
"$ref": "#/components/schemas/NotasFiscaisVendedorDTO"
},
"itens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisItemDTO"
}
},
"parcelas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisParcelaDTO"
}
}
},
"type": "object"
},
"NotasFiscaisDadosPostDTO": {
"required": [
"data",
"valor"
],
"properties": {
"finalidade": {
"description": "`1` Normal
`2` Complementar
`3` Ajuste
`4` Devolução
`5` Crédito
`6` Débito",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6
],
"writeOnly": true,
"example": 1
},
"tipoNota": {
"description": "Obrigatório quando finalidade for 5 (Crédito) ou 6 (Débito).
**Crédito (finalidade 5):**
`01` Multa e juros
`02` Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM
`03` Retorno
`04` Redução de valores
**Débito (finalidade 6):**
`01` Transferência de créditos para Cooperativas
`02` Anulação de Crédito por Saídas Imunes/Isentas
`03` Débitos de notas fiscais não processadas na apuração
`04` Multa e juros
`05` Transferência de crédito de sucessão
`06` Pagamento antecipado
`07` Perda em estoque",
"type": "string",
"writeOnly": true,
"example": "01"
},
"seguro": {
"type": "number",
"format": "float",
"writeOnly": true,
"example": 1.15
},
"despesas": {
"type": "number",
"format": "float",
"writeOnly": true,
"example": 5.08
},
"desconto": {
"type": "number",
"format": "float",
"writeOnly": true,
"example": 10.12
},
"observacoes": {
"type": "string",
"writeOnly": true,
"example": "Observação da nota."
},
"xml": {
"type": "string",
"readOnly": true
},
"linkDanfe": {
"type": "string",
"readOnly": true
},
"linkPDF": {
"type": "string",
"readOnly": true
},
"documentoReferenciado": {
"$ref": "#/components/schemas/NotasFiscaisDocumentoReferenciadoDTO"
},
"documentosReferenciados": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisDocumentoReferenciadoDTO"
}
},
"itens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisItemDTO"
},
"minItems": 1
},
"parcelas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisParcelaDTO"
}
},
"transporte": {
"$ref": "#/components/schemas/NotasFiscaisTransportePostDTO"
},
"notaFiscalProdutorRuralReferenciada": {
"$ref": "#/components/schemas/NotasFiscaisNotaFiscalProdutorRuralReferenciadaDTO"
},
"intermediador": {
"$ref": "#/components/schemas/NotasFiscaisIntermediadorDTO"
}
},
"type": "object"
},
"NotasFiscaisDocumentoDTO": {
"properties": {
"nome": {
"description": "Nome do documento.",
"type": "string"
},
"conteudo": {
"description": "Conteúdo do documento comprimido com GZIP e codificado em base64. Para obter o documento original, decodifique o base64 e descomprima o resultado com GZIP.",
"type": "string",
"example": "H4sIAAAAAAACA8z9BVgcTdc2iiIJGjxAsDBBg..."
}
},
"type": "object"
},
"NotasFiscaisDocumentoReferenciadoDTO": {
"required": [
"modelo"
],
"properties": {
"modelo": {
"description": "`1` Nota fiscal talão
`2` Nota fiscal de consumidor talão
`2D` Cupom fiscal
`4` Nota de produtor
`55` NF-e
`65` NFC-e",
"type": "string",
"enum": [
"1",
"2",
"2D",
"4",
"55",
"65"
],
"example": "55"
},
"data": {
"description": "Data da nota original no formato AAMM.",
"type": "string",
"example": "2401"
},
"numero": {
"description": "Número da nota original.",
"type": "string",
"example": "123"
},
"serie": {
"description": "Série da nota original.",
"type": "string",
"example": "1"
},
"contadorOrdemOperacao": {
"description": "Contador de Ordem de Operação (COO) do cupom original.",
"type": "string",
"example": "1"
},
"chaveAcesso": {
"description": "Chave de acesso da nota original.",
"type": "string",
"example": "62634519764512837946527549134679858182373412"
}
},
"type": "object"
},
"NotasFiscaisDocumentoReferenciadoItemDTO": {
"properties": {
"chaveAcesso": {
"description": "Chave de acesso da nota original.",
"type": "string",
"example": "62634519764512837946527549134679858182373412"
},
"numeroItem": {
"description": "Número do item na nota referenciada.",
"type": "string",
"example": "1"
}
},
"type": "object"
},
"NotasFiscaisExclusaoDTO": {
"required": [
"idsExcluidos"
],
"properties": {
"alertas": {
"type": "array",
"items": {
"type": "string",
"example": "12345677: Apenas notas pendentes podem ser excluídas."
}
},
"idsExcluidos": {
"type": "array",
"items": {
"type": "integer",
"example": 12345678
}
}
},
"type": "object"
},
"NotasFiscaisIcmsDTO": {
"properties": {
"st": {
"type": "integer",
"example": 60
},
"origem": {
"description": "`0` Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8
`1` Estrangeira - Importação direta, exceto a indicada no código 6; 2: Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7
`3` Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%
`4` Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes
`5` Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
`6` Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX
`7` Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX
`8`: Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"example": 0
},
"modalidade": {
"description": "`0` Margem Valor Agregado (%)
`1` Pauta (valor)
`2` Preço Tabelado Máx. (valor)
`3` Valor da operação",
"type": "integer",
"enum": [
0,
1,
2,
3
],
"example": 0
},
"aliquota": {
"type": "number",
"format": "float",
"example": 5
},
"valor": {
"type": "number",
"format": "float",
"example": 10.5
}
},
"type": "object"
},
"NotasFiscaisImpostoDTO": {
"properties": {
"valorAproximadoTotalTributos": {
"type": "number",
"format": "float",
"example": 1.2
},
"icms": {
"$ref": "#/components/schemas/NotasFiscaisIcmsDTO"
}
},
"type": "object",
"readOnly": true
},
"NotasFiscaisIntermediadorDTO": {
"required": [
"cnpj",
"nomeUsuario"
],
"properties": {
"cnpj": {
"type": "string",
"example": "13921649000197"
},
"nomeUsuario": {
"type": "string",
"example": "usuario"
}
},
"type": "object",
"writeOnly": true
},
"NotasFiscaisItemDTO": {
"required": [
"codigo"
],
"properties": {
"codigo": {
"type": "string",
"example": "BLG-5"
},
"descricao": {
"type": "string",
"example": "Produto do Bling"
},
"unidade": {
"type": "string",
"example": "UN"
},
"quantidade": {
"type": "number",
"format": "float",
"example": 1
},
"valor": {
"description": "Valor unitário do item.",
"type": "number",
"format": "float",
"example": 4.9
},
"valorTotal": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 5.9
},
"tipo": {
"description": "`P` Produto
`S` Serviço",
"type": "string",
"enum": [
"P",
"S"
],
"example": "P"
},
"pesoBruto": {
"type": "number",
"format": "float",
"example": 0.5
},
"pesoLiquido": {
"type": "number",
"format": "float",
"example": 0.5
},
"numeroPedidoCompra": {
"type": "string",
"example": "235"
},
"classificacaoFiscal": {
"description": "NCM do item.",
"type": "string",
"example": "9999.99.99"
},
"cest": {
"type": "string",
"example": "99.999.99"
},
"codigoServico": {
"type": "string",
"example": "99.99"
},
"origem": {
"description": "`0` Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8
`1` Estrangeira - Importação direta, exceto a indicada no código 6; 2: Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7
`3` Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%
`4` Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes
`5` Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
`6` Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX
`7` Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX
`8`: Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"example": 0
},
"informacoesAdicionais": {
"type": "string",
"example": "Descrição do item"
},
"gtin": {
"type": "string",
"readOnly": true,
"example": "7890403456855"
},
"cfop": {
"type": "string",
"readOnly": true,
"example": "6102"
},
"impostos": {
"$ref": "#/components/schemas/NotasFiscaisImpostoDTO"
},
"documentoReferenciado": {
"description": "Documento fiscal referenciado pelo item.",
"writeOnly": true,
"allOf": [
{
"$ref": "#/components/schemas/NotasFiscaisDocumentoReferenciadoItemDTO"
}
]
}
},
"type": "object"
},
"NotasFiscaisLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"numero": {
"type": "string",
"writeOnly": true,
"example": "LOJA_8864"
}
},
"type": "object"
},
"NotasFiscaisNaturezaOperacaoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"NotasFiscaisNotaFiscalProdutorRuralReferenciadaDTO": {
"required": [
"numero",
"serie",
"data"
],
"properties": {
"numero": {
"description": "Número da NF referenciada.",
"type": "string",
"example": "125"
},
"serie": {
"description": "Série da NF referenciada.",
"type": "string",
"example": "1"
},
"data": {
"type": "string",
"format": "date",
"example": "2023-01-12"
}
},
"type": "object",
"writeOnly": true
},
"NotasFiscaisParcelaDTO": {
"required": [
"data",
"valor"
],
"properties": {
"data": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"valor": {
"type": "number",
"format": "float",
"example": 123.45
},
"observacoes": {
"type": "string",
"example": "Observação da parcela."
},
"caut": {
"description": "cAut (ou NSU): código de autorização da operação financeira.",
"type": "string",
"example": "123456789"
},
"formaPagamento": {
"$ref": "#/components/schemas/NotasFiscaisParcelaFormaPagamentoDTO"
}
},
"type": "object"
},
"NotasFiscaisParcelaFormaPagamentoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"NotasFiscaisTransporteDadosVolumeDTO": {
"properties": {
"quantidade": {
"type": "integer",
"example": 5
},
"especie": {
"description": "
`1` Outro(s)
`2` Volume(s)
`3` Unidade(s)
`4` Caixa(s)
`5` Pacote(s)
`6` Envelope(s)
`7` Pallet(s)
`8` Saco(s)",
"type": "integer",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8
],
"example": 1
},
"numero": {
"type": "string",
"example": "1"
},
"pesoBruto": {
"type": "number",
"format": "float",
"example": 0.5
},
"pesoLiquido": {
"type": "number",
"format": "float",
"example": 0.35
}
},
"type": "object"
},
"NotasFiscaisTransporteEtiquetaDTO": {
"properties": {
"nome": {
"type": "string",
"example": "Transportador"
},
"endereco": {
"type": "string",
"example": "Olavo Bilac"
},
"numero": {
"type": "string",
"example": "914"
},
"complemento": {
"type": "string",
"example": "Sala 101"
},
"municipio": {
"type": "string",
"example": "Bento Gonçalves"
},
"uf": {
"type": "string",
"example": "RS"
},
"cep": {
"type": "string",
"example": "95702-000"
},
"bairro": {
"type": "string",
"example": "Imigrante"
}
},
"type": "object"
},
"NotasFiscaisTransporteGetDTO": {
"required": [
"numero",
"serie",
"data"
],
"properties": {
"fretePorConta": {
"description": "`0` Contratação do Frete por conta do Remetente (CIF)
`1` Contratação do Frete por conta do Destinatário (FOB)
`2` Contratação do Frete por conta de Terceiros
`3` Transporte Próprio por conta do Remetente
`4` Transporte Próprio por conta do Destinatário
`9` Sem Ocorrência de Transporte",
"type": "integer",
"default": 1,
"enum": [
0,
1,
2,
3,
4,
9
],
"example": 0
},
"transportador": {
"$ref": "#/components/schemas/NotasFiscaisTransporteTransportadorGetDTO"
},
"volumes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisTransporteVolumeGetDTO"
}
},
"etiqueta": {
"$ref": "#/components/schemas/NotasFiscaisTransporteEtiquetaDTO"
}
},
"type": "object"
},
"NotasFiscaisTransportePostDTO": {
"required": [
"numero",
"serie",
"data"
],
"properties": {
"fretePorConta": {
"description": "`0` Contratação do Frete por conta do Remetente (CIF)
`1` Contratação do Frete por conta do Destinatário (FOB)
`2` Contratação do Frete por conta de Terceiros
`3` Transporte Próprio por conta do Remetente
`4` Transporte Próprio por conta do Destinatário
`9` Sem Ocorrência de Transporte",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
9
],
"example": 0
},
"frete": {
"description": "Utilizado no método POST.",
"type": "number",
"format": "float",
"example": 20
},
"veiculo": {
"$ref": "#/components/schemas/NotasFiscaisTransporteVeiculoDTO"
},
"transportador": {
"$ref": "#/components/schemas/NotasFiscaisTransporteTransportadorPostDTO"
},
"volume": {
"$ref": "#/components/schemas/NotasFiscaisTransporteDadosVolumeDTO"
},
"volumes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasFiscaisTransporteVolumePostDTO"
}
},
"etiqueta": {
"$ref": "#/components/schemas/NotasFiscaisTransporteEtiquetaDTO"
}
},
"type": "object"
},
"NotasFiscaisTransporteTransportadorEnderecoDTO": {
"properties": {
"endereco": {
"type": "string",
"example": "Olavo Bilac"
},
"municipio": {
"type": "string",
"example": "Bento Gonçalves"
},
"uf": {
"type": "string",
"example": "RS"
}
},
"type": "object"
},
"NotasFiscaisTransporteTransportadorGetDTO": {
"required": [
"nome"
],
"properties": {
"nome": {
"type": "string",
"example": "Transportador"
},
"numeroDocumento": {
"description": "CNPJ ou CPF.",
"type": "string",
"example": "30188025000121"
}
},
"type": "object"
},
"NotasFiscaisTransporteTransportadorPostDTO": {
"required": [
"nome"
],
"properties": {
"nome": {
"type": "string",
"example": "Transportador"
},
"numeroDocumento": {
"description": "CNPJ ou CPF.",
"type": "string",
"example": "30188025000121"
},
"ie": {
"description": "Inscrição estadual.",
"type": "string",
"example": "949895756023"
},
"endereco": {
"$ref": "#/components/schemas/NotasFiscaisTransporteTransportadorEnderecoDTO"
}
},
"type": "object"
},
"NotasFiscaisTransporteVeiculoDTO": {
"properties": {
"placa": {
"type": "string",
"example": "LDO-2373"
},
"uf": {
"type": "string",
"example": "RS"
},
"marca": {
"type": "string",
"example": "Volvo"
}
},
"type": "object"
},
"NotasFiscaisTransporteVolumeGetDTO": {
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
}
},
"type": "object"
},
"NotasFiscaisTransporteVolumePostDTO": {
"required": [
"servico"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"servico": {
"description": "Utilizado no método POST.",
"type": "string",
"example": "ALIAS_123"
},
"codigoRastreamento": {
"description": "Utilizado no método POST.",
"type": "string",
"example": "COD123BR"
}
},
"type": "object"
},
"NotasFiscaisVendedorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345679
}
},
"type": "object"
},
"NotasServicosCancelamentoDTO": {
"description": "Campos utilizados no cancelamento. Os campos são obrigatórios e disponíveis apenas para o ambiente de emissão nacional.",
"properties": {
"codigoMotivo": {
"description": "`1` Erro na Emissão
`2` Serviço não Prestado
`9` Outros",
"type": "integer",
"enum": [
1,
2,
9
],
"example": 1
},
"justificativa": {
"description": "Justificativa do cancelamento.",
"type": "string",
"example": "Cancelamento de NFS-e"
}
},
"type": "object"
},
"NotasServicosContatoDTO": {
"description": "Campos utilizados no POST.",
"properties": {
"ie": {
"description": "Inscrição estadual.",
"type": "string",
"example": "949895756023"
},
"telefone": {
"type": "string",
"example": "54 3771-7278"
},
"im": {
"description": "Inscrição municipal.",
"type": "string",
"example": "145780150"
},
"endereco": {
"$ref": "#/components/schemas/NotasServicosContatoEnderecoDTO"
}
},
"type": "object"
},
"NotasServicosContatoEnderecoDTO": {
"required": [
"bairro",
"municipio"
],
"properties": {
"endereco": {
"type": "string",
"example": "Olavo Bilac"
},
"numero": {
"type": "string",
"example": "914"
},
"complemento": {
"type": "string",
"example": "Sala 101"
},
"bairro": {
"type": "string",
"example": "Imigrante"
},
"cep": {
"type": "string",
"example": "95702-000"
},
"municipio": {
"type": "string",
"example": "Bento Gonçalves"
},
"uf": {
"type": "string",
"example": "RS"
}
},
"type": "object"
},
"NotasServicosDadosBase": {
"required": [
"id",
"numeroRPS",
"serie",
"contato"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"numero": {
"type": "string",
"example": "123"
},
"numeroRPS": {
"type": "string",
"example": "32"
},
"serie": {
"type": "string",
"example": "1"
},
"situacao": {
"description": "`0` Pendente
`1` Emitida
`2` Disponível para consulta
`3` Cancelada",
"type": "integer",
"enum": [
0,
1,
2,
3
],
"readOnly": true,
"example": 0
},
"dataEmissao": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"valor": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 100
}
},
"type": "object"
},
"NotasServicosDadosBaseDTO": {
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosDadosBase"
},
{
"properties": {
"contato": {
"$ref": "#/components/schemas/NotasServicosContatoBaseDTO"
}
},
"type": "object"
}
]
},
"NotasServicosDadosBaseDTO_POST": {
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosDadosBase"
},
{
"properties": {
"contato": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosContatoBaseDTO"
},
{
"$ref": "#/components/schemas/NotasServicosContatoDTO"
}
]
}
},
"type": "object"
}
]
},
"NotasServicosDados": {
"properties": {
"link": {
"description": "Link para acesso e impressão da NFS-e.",
"type": "string",
"readOnly": true,
"example": "https://linkexemplo.com.br/nfse"
},
"codigoVerificacao": {
"type": "string",
"readOnly": true
}
},
"type": "object"
},
"NotasServicosDadosDTO": {
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosDados"
}
]
},
"NotasServicosDadosDTO_POST": {
"required": [
"servicos"
],
"allOf": [
{
"$ref": "#/components/schemas/NotasServicosDados"
},
{
"properties": {
"data": {
"description": "Utilizado no POST.",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"baseCalculo": {
"type": "number",
"format": "float",
"example": 100
},
"reterISS": {
"description": "Utilizado no POST. Caso não seja informado, será levado em consideração o valor do parâmetro no sistema.",
"type": "boolean",
"example": false
},
"desconto": {
"type": "number",
"format": "float",
"example": 15.45
},
"vendedor": {
"$ref": "#/components/schemas/NotasServicosVendedorDTO"
},
"servicos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasServicosServicoDTO"
}
},
"parcelas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotasServicosParcelaDTO"
}
},
"tributacaoIbsCbs": {
"$ref": "#/components/schemas/NotasServicosTributacaoIbsCbsDTO"
}
},
"type": "object"
}
]
},
"NotasServicosContatoBaseDTO": {
"required": [
"id",
"nome",
"numeroDocumento",
"email"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"example": "Pedro Silva"
},
"numeroDocumento": {
"description": "CNPJ ou CPF.",
"type": "string",
"example": "30188025000121"
},
"email": {
"type": "string",
"example": "pedrosilva@bling.com.br"
}
},
"type": "object"
},
"NotasServicosParcelaDTO": {
"required": [
"data",
"valor"
],
"properties": {
"data": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"valor": {
"type": "number",
"format": "float",
"example": 123.45
},
"observacoes": {
"type": "string",
"example": "Observação da parcela"
},
"formaPagamento": {
"$ref": "#/components/schemas/NotasServicosParcelaFormaPagamentoDTO"
}
},
"type": "object"
},
"NotasServicosParcelaFormaPagamentoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"NotasServicosServicoDTO": {
"required": [
"codigo",
"descricao",
"valor"
],
"properties": {
"codigo": {
"type": "string",
"example": "10301"
},
"descricao": {
"type": "string",
"example": "Pintura"
},
"valor": {
"type": "number",
"format": "float",
"example": 100.25
}
},
"type": "object"
},
"NotasServicosTributacaoIbsCbsDTO": {
"description": "Dados de tributação IBS/CBS para NFS-e.",
"required": [
"indicadorOperacao",
"tipoOperacao",
"tributacao"
],
"properties": {
"indicadorOperacao": {
"description": "Código que indica onde a operação será realizada (6 dígitos). Valores comuns: '100301' = Domicílio do adquirente, '100302' = Local da prestação do serviço, '100303' = Outro local no país. Consulte sua contabilidade ou a legislação vigente para determinar o código adequado.",
"type": "string",
"example": "100301"
},
"tipoOperacao": {
"description": "Tipo da operação tributável. Valores aceitos: '1' = Fornecimento de serviço (operação padrão onde o emitente é o prestador), '2' = Recebimento do pagamento (quando há intermediação ou pagamento diferido).",
"type": "string",
"example": "1"
},
"tipoEnteGovernamental": {
"description": "Tipo de ente governamental tomador do serviço. Informe APENAS quando o cliente for órgão público. Valores aceitos: '1' = União (órgão federal), '2' = Estado (órgão estadual), '3' = Distrito Federal, '4' = Município (órgão municipal). Se informado, pode haver redução ou isenção da alíquota conforme legislação.",
"type": "string",
"example": "4"
},
"tributacao": {
"$ref": "#/components/schemas/NotasServicosTributacaoIbsCbsValoresDTO"
}
},
"type": "object"
},
"NotasServicosTributacaoIbsCbsValoresDTO": {
"description": "Valores e percentuais de tributação IBS/CBS. Consulte sua contabilidade ou a legislação vigente para determinar os códigos adequados à sua operação.",
"required": [
"codigoSituacaoTributaria",
"classificacaoTributaria"
],
"properties": {
"codigoSituacaoTributaria": {
"description": "Código de Situação Tributária (CST) com 3 dígitos. Define o regime de tributação da operação. Exemplos: '000' = Tributação integral, '200' = Alíquota reduzida, '410' = Imunidade, '550' = Suspensão. Consulte sua contabilidade para determinar o CST correto conforme a natureza da operação.",
"type": "string",
"example": "000"
},
"classificacaoTributaria": {
"description": "Código da Classificação Tributária com 6 dígitos. Define a situação específica dentro do CST informado. Cada CST possui suas próprias classificações tributárias válidas. Exemplos: '000001' = Tributação integral, '200028' = Serviços de educação com redução de alíquota, '410004' = Exportação. Consulte sua contabilidade para o código correto conforme a natureza do serviço.",
"type": "string",
"example": "000001"
},
"codigoCreditoPresumido": {
"description": "Código do crédito presumido (2 dígitos). Informe APENAS quando a classificação tributária conceder direito a crédito presumido. Consulte sua contabilidade para verificar se sua operação tem direito a crédito presumido e qual código utilizar.",
"type": "string",
"example": "01"
},
"cstRegimeRegular": {
"description": "CST aplicável ao regime regular de tributação (3 dígitos). Utilize quando a operação estiver em regime especial mas precisa informar a situação no regime regular. Consulte sua contabilidade para determinar se este campo é necessário.",
"type": "string",
"example": "550"
},
"classificacaoTributariaRegular": {
"description": "Classificação tributária para o regime regular (6 dígitos). Deve ser compatível com o 'cstRegimeRegular' informado. Consulte sua contabilidade para o código correto.",
"type": "string",
"example": "550016"
},
"percentualDiferimentoEstadual": {
"description": "Percentual de diferimento do IBS estadual (parcela UF), de 0.00 a 100.00. O diferimento posterga o pagamento do imposto para etapa posterior da cadeia. Consulte sua contabilidade para verificar se há diferimento aplicável e qual percentual utilizar.",
"type": "number",
"format": "float",
"example": 10
},
"percentualDiferimentoMunicipal": {
"description": "Percentual de diferimento do IBS municipal, de 0.00 a 100.00. Aplica-se à parcela municipal do imposto sobre bens e serviços. Consulte sua contabilidade para verificar se há diferimento aplicável e qual percentual utilizar.",
"type": "number",
"format": "float",
"example": 5
},
"percentualDiferimentoCBS": {
"description": "Percentual de diferimento da Contribuição sobre Bens e Serviços (CBS), de 0.00 a 100.00. A CBS é o tributo federal da Reforma Tributária. Consulte sua contabilidade para verificar se há diferimento aplicável e qual percentual utilizar.",
"type": "number",
"format": "float",
"example": 8
}
},
"type": "object"
},
"NotasServicosVendedorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"NotificacoesDadosBaseDTO": {
"required": [
"emitente",
"modulo",
"titulo",
"descricao",
"dataEnvio"
],
"properties": {
"emitente": {
"description": "Nome do usuário que criou a notificação.",
"type": "string"
},
"modulo": {
"type": "string",
"example": "FISCAL"
},
"descricao": {
"description": "Mensagem do corpo da notificação.",
"type": "string"
},
"titulo": {
"description": "Título no cabeçalho da notificação.",
"type": "string"
},
"fonte": {
"description": "Nome do orgão ou entidade em que se baseia a informação.",
"type": "string",
"example": "SEFAZ"
},
"linkAjuda": {
"description": "Link para direcionar o cliente à mais informações.",
"type": "string"
},
"acao": {
"description": "Ação executada na notificação.",
"type": "string"
},
"dataCriacao": {
"description": "Data de criação da notificação.",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"dataEnvio": {
"description": "Data de publicação da notificação.",
"type": "string",
"format": "datetime",
"example": "2023-01-12 00:00:00"
},
"dataVigencia": {
"description": "Data em que uma possível alteração informada entrará em vigor.",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"dataAcao": {
"description": "Data em que a ação foi realizada pelo usuário.",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"dataLeitura": {
"description": "Data em que o usuário leu a notificação.",
"type": "string",
"format": "datetime",
"example": "2023-01-12 11:50:00"
},
"dataAlerta": {
"description": "Data em que a notificação ficará com a cor amarela para alertar usuário.",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"dataPerigo": {
"description": "Data em que a notificação ficará com a cor vermelha para alertar usuário.",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"enquadramentos": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/NotificacoesEnquadramentosFiscaisDTO"
}
]
}
}
},
"type": "object"
},
"NotificacoesEnquadramentosFiscaisDTO": {
"properties": {
"tamanhoEmpresa": {
"description": "Perfil no qual a empresa se encaixa.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"micro",
"pequena"
]
},
"idMunicipio": {
"description": "Código do município da empresa.",
"type": "array",
"items": {
"type": "integer"
},
"example": [
"2704104",
"2704203"
]
},
"uf": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SP",
"RS"
]
},
"crt": {
"description": "Código de Regime Tributário",
"type": "array",
"items": {
"type": "integer"
},
"example": [
1
]
}
},
"type": "object"
},
"NotificacoesQuantidadeDTO": {
"properties": {
"quantidade": {
"description": "Quantidade de notificações.",
"type": "integer",
"example": "10"
}
},
"type": "object"
},
"NotificacoesUlidsDTO": {
"properties": {
"id": {
"description": "ULID da notificação.",
"type": "string",
"example": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
},
"type": "object"
},
"OrcamentosContatoDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"OrcamentosDadosBaseDTO": {
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 123456789
},
"data": {
"type": "string",
"format": "date",
"example": "2024-04-29"
},
"situacao": {
"type": "string",
"example": "Concluído"
},
"total": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 251
},
"totalProdutos": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 500
},
"numero": {
"type": "integer",
"example": 13
},
"contato": {
"$ref": "#/components/schemas/OrcamentosContatoDTO"
},
"loja": {
"$ref": "#/components/schemas/OrcamentosLojaDTO"
}
},
"type": "object"
},
"OrcamentosDadosDTO": {
"required": [
"itens",
"parcelas"
],
"properties": {
"desconto": {
"type": "number",
"format": "float",
"example": 10
},
"outrasDespesas": {
"type": "number",
"format": "float",
"example": 11
},
"garantia": {
"type": "integer",
"example": 3
},
"dataProximoContato": {
"type": "string",
"example": "2024-05-01"
},
"observacoes": {
"type": "string",
"example": "Observações da proposta comercial"
},
"observacaoInterna": {
"type": "string",
"example": "Observações internas da proposta comercial"
},
"totalOutrosItens": {
"type": "integer",
"example": 1
},
"aosCuidadosDe": {
"type": "string",
"example": "Nome do Contato"
},
"introducao": {
"type": "string",
"example": "Introdução da proposta comercial"
},
"prazoEntrega": {
"type": "string",
"example": "Prazo de entrega proposta comercial"
},
"itens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrcamentosItemDTO"
}
},
"parcelas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrcamentosParcelaDTO"
}
},
"vendedor": {
"$ref": "#/components/schemas/OrcamentosVendedorDTO"
},
"transporte": {
"$ref": "#/components/schemas/OrcamentosTransporteDTO"
}
},
"type": "object"
},
"OrcamentosFormaPagamentoDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"OrcamentosItemDTO": {
"properties": {
"produto": {
"$ref": "#/components/schemas/OrcamentosProdutoDTO"
},
"codigo": {
"type": "string",
"example": "BLG-5"
},
"unidade": {
"type": "string",
"example": "UN"
},
"quantidade": {
"type": "number",
"format": "float",
"example": 1.1
},
"desconto": {
"type": "number",
"format": "float",
"example": 1.2
},
"valor": {
"type": "number",
"format": "float",
"example": 3.1
},
"descricaoDetalhada": {
"type": "string",
"example": "Descrição detalhada do produto"
}
},
"type": "object"
},
"OrcamentosLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"unidadeNegocio": {
"$ref": "#/components/schemas/LojaUnidadeNegocioDTO"
}
},
"type": "object"
},
"LojaUnidadeNegocioDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"OrcamentosParcelaDTO": {
"properties": {
"numeroDias": {
"type": "integer",
"example": 10
},
"dataVencimento": {
"type": "string",
"format": "date",
"example": "2024-04-29"
},
"valor": {
"type": "number",
"format": "float",
"example": 10.55
},
"observacoes": {
"type": "string",
"example": "Observacao da forma de pagamento"
},
"formaPagamento": {
"$ref": "#/components/schemas/OrcamentosFormaPagamentoDTO"
}
},
"type": "object"
},
"OrcamentosProdutoDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"descricao": {
"type": "string",
"example": "Bolo"
}
},
"type": "object"
},
"OrcamentosSituacaoDTO": {
"properties": {
"situacao": {
"type": "string",
"enum": [
"Pendente",
"Aguardando",
"Não aprovado",
"Aprovado",
"Concluído",
"Rascunho"
],
"example": "Aguardando"
}
},
"type": "object"
},
"OrcamentosTransporteContatoDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"example": "Nome do transportador"
}
},
"type": "object"
},
"OrcamentosTransporteDTO": {
"properties": {
"freteModalidade": {
"description": "`0` Contratação do Frete por conta do Remetente (CIF)
`1` Contratação do Frete por conta do Destinatário (FOB)
`2` Contratação do Frete por conta de Terceiros
`3` Transporte Próprio por conta do Remetente
`4` Transporte Próprio por conta do Destinatário
`9` Sem Ocorrência de Transporte.",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
9
],
"example": 0
},
"frete": {
"type": "number",
"format": "float",
"example": 2.34
},
"quantidadeVolumes": {
"type": "number",
"format": "float",
"example": 2.33
},
"prazoEntrega": {
"type": "integer",
"example": 2
},
"pesoBruto": {
"type": "number",
"format": "float",
"example": 2.4
},
"contato": {
"$ref": "#/components/schemas/OrcamentosTransporteContatoDTO"
},
"volumes": {
"$ref": "#/components/schemas/OrcamentosTransporteVolumeDTO"
}
},
"type": "object"
},
"OrcamentosTransporteVolumeDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"servico": {
"type": "string",
"readOnly": true,
"example": "Correios PAC"
},
"codigoRastreamento": {
"type": "string",
"readOnly": true,
"example": "R56563A"
}
},
"type": "object"
},
"OrcamentosVendedorDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"OrdensProducaoContatoDTO": {
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"nome": {
"type": "string",
"readOnly": true,
"example": "João da Silva"
}
},
"type": "object"
},
"OrdensProducaoDadosBaseDTO": {
"required": [
"id",
"numero",
"deposito",
"situacao"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"dataPrevisaoInicio": {
"type": "string",
"format": "date",
"example": "2021-01-01"
},
"dataPrevisaoFinal": {
"type": "string",
"format": "date",
"example": "2021-01-01"
},
"dataInicio": {
"type": "string",
"format": "date",
"example": "2021-01-01"
},
"dataFim": {
"type": "string",
"format": "date",
"example": "2021-01-01"
},
"numero": {
"type": "integer",
"example": 12345678
},
"responsavel": {
"type": "string",
"example": "Responsável pela ordem de produção"
},
"deposito": {
"$ref": "#/components/schemas/OrdensProducaoDepositoDTO"
},
"situacao": {
"$ref": "#/components/schemas/OrdensProducaoSituacaoDTO"
}
},
"type": "object"
},
"OrdensProducaoDadosDTO": {
"properties": {
"vendas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrdensProducaoVendaDTO"
}
},
"itens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrdensProducaoItemDTO"
}
},
"observacoes": {
"type": "string",
"example": "Observações"
}
},
"type": "object"
},
"OrdensProducaoDadosGeradosPorDemandaDTO": {
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"itens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrdensProducaoItemDTO"
}
},
"deposito": {
"$ref": "#/components/schemas/OrdensProducaoDepositoDTO"
}
},
"type": "object"
},
"OrdensProducaoDadosPostDTO": {
"properties": {
"itens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrdensProducaoItemDTO"
}
},
"observacoes": {
"type": "string",
"example": "Observações"
}
},
"type": "object"
},
"OrdensProducaoDepositoDTO": {
"required": [
"destino",
"origem"
],
"properties": {
"idDestino": {
"type": "integer",
"example": 12345678
},
"idOrigem": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"OrdensProducaoItemDTO": {
"properties": {
"produto": {
"$ref": "#/components/schemas/OrdensProducaoProdutoDTO"
},
"quantidade": {
"type": "number",
"format": "float",
"example": 1
}
},
"type": "object"
},
"OrdensProducaoProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"readOnly": true,
"example": "Nome do produto"
},
"codigo": {
"type": "string",
"readOnly": true,
"example": "Código do produto"
}
},
"type": "object"
},
"OrdensProducaoSituacaoDTO": {
"required": [
"id",
"valor",
"nome"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"valor": {
"type": "integer",
"readOnly": true,
"example": 1
},
"nome": {
"type": "string",
"readOnly": true,
"example": "Em aberto"
}
},
"type": "object"
},
"OrdensProducaoSituacaoDadosDTO": {
"required": [
"idSituacao"
],
"properties": {
"idSituacao": {
"type": "integer",
"example": 12345678
},
"quantidade": {
"type": "number",
"format": "float",
"example": 1
},
"observacoes": {
"type": "string",
"example": "Observação"
},
"considerarPerdas": {
"description": "Se deve considerar perdas na finalização da ordem de produção. (Válido apenas para finalização",
"type": "boolean",
"example": true
}
},
"type": "object"
},
"OrdensProducaoVendaDTO": {
"properties": {
"numero": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"contato": {
"$ref": "#/components/schemas/OrdensProducaoContatoDTO"
}
},
"type": "object"
},
"PedidosComprasDadosDTO": {
"required": [
"itens"
],
"properties": {
"ordemCompra": {
"type": "string",
"example": "351635"
},
"observacoes": {
"type": "string",
"example": "Observação sobre o pedido."
},
"observacoesInternas": {
"type": "string",
"example": "Observação interna sobre o pedido."
},
"desconto": {
"$ref": "#/components/schemas/PedidosComprasDescontoDTO"
},
"categoria": {
"$ref": "#/components/schemas/PedidosComprasCategoriaDTO"
},
"tributacao": {
"$ref": "#/components/schemas/PedidosComprasTributacaoDTO"
},
"transporte": {
"$ref": "#/components/schemas/PedidosComprasTransporteDTO"
},
"itens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PedidosComprasItemDTO"
}
},
"parcelas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PedidosComprasParcelaDTO"
}
}
},
"type": "object"
},
"PedidosComprasCategoriaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"PedidosComprasDadosBaseDTO": {
"required": [
"fornecedor"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"numero": {
"type": "integer",
"example": 12
},
"data": {
"type": "string",
"format": "date",
"example": "2020-08-24"
},
"dataPrevista": {
"type": "string",
"format": "date",
"example": "2020-08-30"
},
"totalProdutos": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 2090.66
},
"total": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 2090.66
},
"fornecedor": {
"$ref": "#/components/schemas/PedidosComprasFornecedorDTO"
},
"situacao": {
"$ref": "#/components/schemas/PedidosComprasSituacaoDTO"
}
},
"type": "object"
},
"PedidosComprasDescontoDTO": {
"required": [
"valor"
],
"properties": {
"valor": {
"type": "number",
"format": "float",
"example": 15.45
},
"unidade": {
"type": "string",
"default": "REAL",
"enum": [
"REAL",
"PERCENTUAL"
]
}
},
"type": "object"
},
"PedidosComprasFormaPagamentoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"PedidosComprasFornecedorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"PedidosComprasItemDTO": {
"required": [
"descricao",
"valor"
],
"properties": {
"descricao": {
"type": "string",
"example": "Copo do Bling"
},
"codigoFornecedor": {
"type": "string",
"example": "46546546"
},
"unidade": {
"type": "string",
"example": "Un"
},
"valor": {
"type": "number",
"format": "float",
"example": 149.99
},
"quantidade": {
"type": "number",
"format": "float",
"example": 12
},
"aliquotaIPI": {
"type": "number",
"format": "float",
"example": 15.85
},
"descricaoDetalhada": {
"type": "string",
"example": "Descrição do item do pedido."
},
"notaFiscal": {
"$ref": "#/components/schemas/PedidosComprasItemNotaFiscalDTO"
},
"produto": {
"$ref": "#/components/schemas/PedidosComprasProdutoDTO"
}
},
"type": "object"
},
"PedidosComprasItemNotaFiscalDTO": {
"properties": {
"id": {
"description": "ID da nota fiscal vinculada ao pedido de compra.",
"type": "integer",
"example": 12345678
},
"quantidade": {
"description": "Quantidade do item no pedido que foi vinculada a uma nota de entrada.",
"type": "number",
"format": "float",
"example": 5
}
},
"type": "object"
},
"PedidosComprasParcelaDTO": {
"required": [
"valor",
"dataVencimento"
],
"properties": {
"valor": {
"type": "number",
"format": "float",
"example": 2090.66
},
"dataVencimento": {
"type": "string",
"format": "date",
"example": "2020-09-23"
},
"observacao": {
"type": "string",
"example": "Observação da parcela."
},
"formaPagamento": {
"$ref": "#/components/schemas/PedidosComprasFormaPagamentoDTO"
}
},
"type": "object"
},
"PedidosComprasProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"codigo": {
"type": "string",
"readOnly": true,
"example": "CODE123"
}
},
"type": "object"
},
"PedidosComprasSituacaoDTO": {
"required": [
"id",
"valor"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"valor": {
"description": "`0` Em aberto
`1` Atendido
`2` Cancelado
`3` Em andamento
Ignorado no método POST.",
"type": "integer",
"enum": [
0,
1,
2,
3
],
"example": 0
}
},
"type": "object"
},
"PedidosComprasTransporteDTO": {
"properties": {
"frete": {
"type": "number",
"format": "float",
"example": 15.78
},
"transportador": {
"type": "string",
"example": "Zé Transportes"
},
"fretePorConta": {
"description": "`0` Contratação do Frete por conta do Remetente (CIF)
`1` Contratação do Frete por conta do Destinatário (FOB)
`2` Contratação do Frete por conta de Terceiros
`3` Transporte Próprio por conta do Remetente
`4` Transporte Próprio por conta do Destinatário
`9` Sem Ocorrência de Transporte",
"type": "integer",
"default": 1,
"enum": [
0,
1,
2,
3,
4,
9
],
"example": 0
},
"pesoBruto": {
"type": "number",
"format": "float",
"example": 15.78
},
"volumes": {
"type": "integer",
"example": 11
}
},
"type": "object"
},
"PedidosComprasTributacaoDTO": {
"properties": {
"totalICMS": {
"type": "number",
"format": "float",
"example": 5.55
},
"totalIPI": {
"description": "Calculado automaticamente com base no IPI dos itens.",
"type": "number",
"format": "float",
"readOnly": true,
"example": 5.55
}
},
"type": "object"
},
"ProdutosAnexoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
}
},
"type": "object",
"readOnly": true
},
"ProdutosAnexoVinculoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
}
},
"type": "object",
"readOnly": true
},
"ProdutosCampoCustomizadoDTO": {
"required": [
"idCampoCustomizado"
],
"properties": {
"idCampoCustomizado": {
"type": "integer",
"example": 123456789
},
"idVinculo": {
"type": "integer",
"example": "Utilize para atualizar o valor existente. Ex: 123456789"
},
"valor": {
"type": "string",
"example": "256GB"
},
"item": {
"type": "string",
"example": "Opção A"
}
},
"type": "object"
},
"ProdutosCategoriaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 123456789
}
},
"type": "object"
},
"ProdutosComponenteDTO": {
"required": [
"produto",
"quantidade"
],
"properties": {
"produto": {
"$ref": "#/components/schemas/ProdutosComponenteProdutoDTO"
},
"quantidade": {
"type": "number",
"format": "float",
"example": 2.1
}
},
"type": "object"
},
"ProdutosComponenteProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"ProdutosDadosBaseDTO": {
"required": [
"nome",
"tipo",
"situacao",
"formato"
],
"properties": {
"id": {
"type": "integer",
"example": 123456789
},
"idProdutoPai": {
"description": "ID do produto pai, caso seja uma variação.",
"type": "integer",
"readOnly": true,
"example": 123456789
},
"nome": {
"type": "string",
"maxLength": 120,
"example": "Produto 1"
},
"codigo": {
"type": "string",
"example": "CODE_123"
},
"preco": {
"type": "number",
"format": "float",
"example": 1
},
"precoCusto": {
"description": "Preço de custo do fornecedor padrão do produto.",
"type": "number",
"format": "float",
"readOnly": true,
"example": 1
},
"estoque": {
"$ref": "#/components/schemas/EstoqueGetAllResponseDTO"
},
"tipo": {
"description": "Tipo do produto
`S` Serviço
`P` Produto
`N` Serviço 06 21 22",
"type": "string",
"enum": [
"S",
"P",
"N"
],
"example": "P"
},
"situacao": {
"description": "Situação do produto
`A` Ativo
`I` Inativo",
"type": "string",
"default": "A",
"enum": [
"A",
"I"
],
"example": "A"
},
"formato": {
"description": "Formato do produto
`S` Simples
`V` Com variações
`E` Com composição
",
"type": "string",
"enum": [
"S",
"V",
"E"
],
"example": "S"
},
"descricaoCurta": {
"type": "string",
"example": "Descrição curta"
},
"imagemURL": {
"description": "Link da primeira imagem de acordo com tipo de armazenamento definido.",
"type": "string",
"readOnly": true,
"example": "https://www.bling.com.br/imagens/imagens-produtos/123456789.jpg"
}
},
"type": "object"
},
"ProdutosDadosDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ProdutosDadosBaseDTO_GetByID"
},
{
"$ref": "#/components/schemas/ProdutosDados"
},
{
"properties": {
"variacoes": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ProdutosDadosBaseDTO_GetByID"
},
{
"$ref": "#/components/schemas/ProdutosDados"
},
{
"$ref": "#/components/schemas/ProdutosDadosVariacaoDTO"
},
{
"properties": {
"formato": {
"description": "Formato do produto
`S` Simples
`E` Com composição
",
"type": "string",
"enum": [
"S",
"E"
],
"example": "S"
}
},
"type": "object"
}
]
}
}
},
"type": "object"
}
]
},
"ProdutosDados": {
"properties": {
"dataValidade": {
"type": "string",
"format": "date",
"example": "2020-01-01"
},
"unidade": {
"type": "string",
"example": "UN"
},
"pesoLiquido": {
"description": "Peso líquido em KG",
"type": "number",
"format": "float",
"example": 1
},
"pesoBruto": {
"description": "Peso bruto em KG",
"type": "number",
"format": "float",
"example": 1
},
"volumes": {
"type": "integer",
"example": 1
},
"itensPorCaixa": {
"type": "number",
"format": "float",
"example": "1.00"
},
"gtin": {
"description": "Código GTIN (GTIN-8, GTIN-12, GTIN-13 ou GTIN-14) do produto que está sendo comercializado",
"type": "string",
"default": "",
"example": "1234567890123"
},
"gtinEmbalagem": {
"description": "Código GTIN (GTIN-8, GTIN-12 ou GTIN-13) da menor unidade comercializada no varejo",
"type": "string",
"default": "",
"example": "1234567890123"
},
"tipoProducao": {
"description": "Tipo da produção
`P` Própria
`T` Terceiros",
"type": "string",
"default": "P",
"enum": [
"P",
"T"
],
"example": "P"
},
"condicao": {
"description": "Condição do produto
`0` Não especificado
`1` Novo
`2`Usado",
"type": "integer",
"default": 0,
"enum": [
0,
1,
2
],
"example": 0
},
"freteGratis": {
"description": "Frete grátis
Valor default: `false`",
"type": "boolean",
"example": false
},
"marca": {
"type": "string",
"example": "Marca"
},
"descricaoComplementar": {
"type": "string",
"example": "Descrição complementar"
},
"linkExterno": {
"type": "string",
"example": "https://www.google.com"
},
"observacoes": {
"type": "string",
"example": "Observações"
},
"descricaoEmbalagemDiscreta": {
"description": "Descrição discreta do produto para utilizar na declaração de conteúdo.",
"type": "string",
"example": "Produto teste"
},
"categoria": {
"$ref": "#/components/schemas/ProdutosCategoriaDTO"
},
"estoque": {
"$ref": "#/components/schemas/ProdutosEstoqueDTO"
},
"fornecedor": {
"$ref": "#/components/schemas/ProdutoFornecedorDTO"
},
"actionEstoque": {
"description": "Ação de estoque ao transformar produto Simples em Variação
`Z` Irá zerar os saldos de estoque
`T` Transfere o estoque do produto pai para a primeira variação informada",
"type": "string",
"enum": [
"Z",
"T"
],
"example": ""
},
"dimensoes": {
"$ref": "#/components/schemas/ProdutosDimensoesDTO"
},
"tributacao": {
"$ref": "#/components/schemas/ProdutosTributacaoDTO"
},
"midia": {
"$ref": "#/components/schemas/ProdutosMidiaDTO"
},
"linhaProduto": {
"$ref": "#/components/schemas/ProdutosLinhaProdutoDTO"
},
"estrutura": {
"$ref": "#/components/schemas/ProdutosEstruturaDTO"
},
"camposCustomizados": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosCampoCustomizadoDTO"
}
},
"artigoPerigoso": {
"description": "Indica se o produto é um artigo perigoso conforme regulamentação ANAC. Quando habilitado, adiciona automaticamente o código de serviço 095 nas etiquetas de envio.",
"type": "boolean",
"default": false,
"example": false
}
},
"type": "object"
},
"ProdutosDados_Patch": {
"properties": {
"dataValidade": {
"type": "string",
"format": "date",
"example": "2020-01-01"
},
"unidade": {
"type": "string",
"example": "UN"
},
"pesoLiquido": {
"description": "Peso líquido em KG",
"type": "number",
"format": "float",
"example": 1
},
"pesoBruto": {
"description": "Peso bruto em KG",
"type": "number",
"format": "float",
"example": 1
},
"volumes": {
"type": "integer",
"example": 1
},
"itensPorCaixa": {
"type": "number",
"format": "float",
"example": "1.00"
},
"gtin": {
"description": "Código GTIN (GTIN-8, GTIN-12, GTIN-13 ou GTIN-14) do produto que está sendo comercializado",
"type": "string",
"default": "",
"example": "1234567890123"
},
"gtinEmbalagem": {
"description": "Código GTIN (GTIN-8, GTIN-12 ou GTIN-13) da menor unidade comercializada no varejo",
"type": "string",
"default": "",
"example": "1234567890123"
},
"tipoProducao": {
"description": "Tipo da produção
`P` Própria
`T` Terceiros",
"type": "string",
"default": "P",
"enum": [
"P",
"T"
],
"example": "P"
},
"condicao": {
"description": "Condição do produto
`0` Não especificado
`1` Novo
`2`Usado",
"type": "integer",
"default": 0,
"enum": [
0,
1,
2
],
"example": 0
},
"freteGratis": {
"description": "Frete grátis
Valor default: `false`",
"type": "boolean",
"example": false
},
"marca": {
"type": "string",
"example": "Marca"
},
"descricaoComplementar": {
"type": "string",
"example": "Descrição complementar"
},
"linkExterno": {
"type": "string",
"example": "https://www.google.com"
},
"observacoes": {
"type": "string",
"example": "Observações"
},
"descricaoEmbalagemDiscreta": {
"description": "Descrição discreta do produto para utilizar na declaração de conteúdo.",
"type": "string",
"example": "Produto teste"
},
"categoria": {
"$ref": "#/components/schemas/ProdutosCategoriaDTO"
},
"estoque": {
"$ref": "#/components/schemas/ProdutosEstoqueDTO"
},
"fornecedor": {
"$ref": "#/components/schemas/ProdutoFornecedorDTO"
},
"actionEstoque": {
"description": "Ação de estoque ao transformar produto Simples em Variação
`Z` Irá zerar os saldos de estoque
`T` Transfere o estoque do produto pai para a primeira variação informada",
"type": "string",
"enum": [
"Z",
"T"
],
"example": ""
},
"dimensoes": {
"$ref": "#/components/schemas/ProdutosDimensoesDTO"
},
"tributacao": {
"$ref": "#/components/schemas/ProdutosTributacaoDTO"
},
"midia": {
"$ref": "#/components/schemas/ProdutosMidiaDTO"
},
"linhaProduto": {
"$ref": "#/components/schemas/ProdutosLinhaProdutoDTO"
},
"estrutura": {
"$ref": "#/components/schemas/ProdutosEstruturaDTO"
},
"camposCustomizados": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosCampoCustomizadoDTO"
}
},
"artigoPerigoso": {
"description": "Indica se o produto é um artigo perigoso conforme regulamentação ANAC. Quando habilitado, adiciona automaticamente o código de serviço 095 nas etiquetas de envio.",
"type": "boolean",
"default": false,
"example": false
}
},
"type": "object"
},
"ProdutosDadosBaseDTO_GetByID": {
"required": [
"nome",
"tipo",
"situacao",
"formato"
],
"properties": {
"id": {
"type": "integer",
"example": 123456789
},
"nome": {
"type": "string",
"maxLength": 120,
"example": "Produto 1"
},
"codigo": {
"type": "string",
"example": "CODE_123"
},
"preco": {
"type": "number",
"format": "float",
"example": 1
},
"tipo": {
"description": "Tipo do produto
`S` Serviço
`P` Produto
`N` Serviço 06 21 22",
"type": "string",
"enum": [
"S",
"P",
"N"
],
"example": "P"
},
"situacao": {
"description": "Situação do produto
`A` Ativo
`I` Inativo",
"type": "string",
"default": "A",
"enum": [
"A",
"I"
],
"example": "A"
},
"formato": {
"description": "Formato do produto
`S` Simples
`V` Com variações
`E` Com composição
",
"type": "string",
"enum": [
"S",
"V",
"E"
],
"example": "S"
},
"descricaoCurta": {
"type": "string",
"example": "Descrição curta"
},
"imagemURL": {
"description": "Link da primeira imagem de acordo com tipo de armazenamento definido.",
"type": "string",
"readOnly": true,
"example": "https://www.bling.com.br/imagens/imagens-produtos/123456789.jpg"
}
},
"type": "object"
},
"ProdutosDadosBaseDTO_Patch": {
"properties": {
"id": {
"type": "integer",
"example": 123456789
},
"nome": {
"type": "string",
"maxLength": 120,
"example": "Produto 1"
},
"codigo": {
"type": "string",
"example": "CODE_123"
},
"preco": {
"type": "number",
"format": "float",
"example": 1
},
"tipo": {
"description": "Tipo do produto
`S` Serviço
`P` Produto
`N` Serviço 06 21 22",
"type": "string",
"enum": [
"S",
"P",
"N"
],
"example": "P"
},
"situacao": {
"description": "Situação do produto
`A` Ativo
`I` Inativo",
"type": "string",
"default": "A",
"enum": [
"A",
"I"
],
"example": "A"
},
"formato": {
"description": "Formato do produto
`S` Simples
`V` Com variações
`E` Com composição
",
"type": "string",
"enum": [
"S",
"V",
"E"
],
"example": "S"
},
"descricaoCurta": {
"type": "string",
"example": "Descrição curta"
},
"imagemURL": {
"description": "Link da primeira imagem de acordo com tipo de armazenamento definido.",
"type": "string",
"readOnly": true,
"example": "https://www.bling.com.br/imagens/imagens-produtos/123456789.jpg"
}
},
"type": "object"
},
"ProdutosDadosPatchDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ProdutosDadosBaseDTO_Patch"
},
{
"$ref": "#/components/schemas/ProdutosDados_Patch"
},
{
"properties": {
"variacoes": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ProdutosDadosBaseDTO_Patch"
},
{
"$ref": "#/components/schemas/ProdutosDados_Patch"
},
{
"$ref": "#/components/schemas/ProdutosDadosVariacaoDTO_Patch"
},
{
"properties": {
"formato": {
"description": "Formato do produto
`S` Simples
`E` Com composição
",
"type": "string",
"enum": [
"S",
"E"
],
"example": "S"
}
},
"type": "object"
}
]
}
}
},
"type": "object"
}
]
},
"ProdutosDadosVariacaoDTO": {
"required": [
"variacao"
],
"properties": {
"variacao": {
"$ref": "#/components/schemas/ProdutosVariacaoDTO"
}
},
"type": "object"
},
"ProdutosDadosVariacaoDTO_Patch": {
"properties": {
"variacao": {
"$ref": "#/components/schemas/ProdutosVariacaoDTO"
}
},
"type": "object"
},
"ProdutosDimensoesDTO": {
"properties": {
"largura": {
"type": "number",
"format": "float",
"example": 1
},
"altura": {
"type": "number",
"format": "float",
"example": 1
},
"profundidade": {
"type": "number",
"format": "float",
"example": 1
},
"unidadeMedida": {
"description": "`0` Metros
`1` Centímetros
`2` Milímetros",
"type": "integer",
"enum": [
"0",
"1",
"2"
],
"example": 1
}
},
"type": "object"
},
"ProdutosEstoqueDTO": {
"properties": {
"minimo": {
"type": "number",
"format": "float",
"example": 1
},
"maximo": {
"type": "number",
"format": "float",
"example": 100
},
"crossdocking": {
"type": "integer",
"example": 1
},
"localizacao": {
"type": "string",
"example": "14A"
},
"saldoVirtualTotal": {
"description": "Saldo em estoque atual, considerando a reserva de estoque.",
"type": "number",
"format": "float",
"readOnly": true,
"example": "1.0"
}
},
"type": "object"
},
"EstoqueGetAllResponseDTO": {
"properties": {
"saldoVirtualTotal": {
"description": "Saldo em estoque atual, considerando a reserva de estoque.",
"type": "number",
"format": "float",
"readOnly": true,
"example": "1.0"
}
},
"type": "object",
"readOnly": true
},
"ProdutosEstruturaDTO": {
"required": [
"tipoEstoque",
"lancamentoEstoque",
"componentes"
],
"properties": {
"tipoEstoque": {
"description": "`F` Físico
`V` Virtual",
"type": "string",
"enum": [
"F",
"V"
],
"example": "F"
},
"lancamentoEstoque": {
"description": "`A` Produto e Componente
`M` Componente
`P` Produto",
"type": "string",
"enum": [
"A",
"M",
"P"
],
"example": "A"
},
"componentes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosComponenteDTO"
}
}
},
"type": "object"
},
"FornecedorContatoDTO": {
"properties": {
"id": {
"description": "ID do contato",
"type": "integer",
"example": 123456789
},
"nome": {
"description": "Nome do contato",
"type": "string",
"example": "Fornecedor padrão"
}
},
"type": "object",
"readOnly": true
},
"ProdutoFornecedorDTO": {
"properties": {
"id": {
"description": "ID do vínculo entre Produto e Fornecedor",
"type": "integer",
"example": 123456789
},
"contato": {
"$ref": "#/components/schemas/FornecedorContatoDTO"
},
"codigo": {
"description": "Código do produto no fornecedor",
"type": "string",
"example": "SKU-FORNECEDOR"
},
"precoCusto": {
"description": "Preço de custo do produto no fornecedor",
"type": "number",
"format": "float",
"example": 55.55
},
"precoCompra": {
"description": "Preço de compra do produto no fornecedor",
"type": "number",
"format": "float",
"example": 55.55
}
},
"type": "object",
"readOnly": true
},
"ProdutosGrupoProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 123456789
}
},
"type": "object"
},
"ProdutosImagemDTO": {
"required": [
"link"
],
"properties": {
"link": {
"type": "string",
"example": "https://shutterstock.com/lalala123"
}
},
"type": "object"
},
"ProdutosImagemInternaDTO": {
"required": [
"link",
"linkMiniatura",
"validade",
"ordem",
"anexo",
"anexoVinculo"
],
"properties": {
"link": {
"type": "string",
"example": "https://www.bling.com.br/imagens/miniatura.jpg"
},
"linkMiniatura": {
"type": "string",
"readOnly": true,
"example": "https://www.bling.com.br/imagens/miniatura.jpg"
},
"validade": {
"type": "string",
"readOnly": true,
"example": "2020-01-01 00:00:00"
},
"ordem": {
"type": "integer",
"readOnly": true,
"example": 1
},
"anexo": {
"$ref": "#/components/schemas/ProdutosAnexoDTO"
},
"anexoVinculo": {
"$ref": "#/components/schemas/ProdutosAnexoVinculoDTO"
}
},
"type": "object"
},
"ProdutosImagensDTO": {
"properties": {
"imagensURL": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosImagemDTO"
},
"writeOnly": true
},
"externas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosImagemDTO"
},
"readOnly": true
},
"internas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosImagemInternaDTO"
},
"readOnly": true
}
},
"type": "object"
},
"ProdutosLinhaProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 1
}
},
"type": "object"
},
"ProdutosMidiaDTO": {
"required": [
"video",
"imagens"
],
"properties": {
"video": {
"$ref": "#/components/schemas/ProdutosVideoDTO"
},
"imagens": {
"$ref": "#/components/schemas/ProdutosImagensDTO"
}
},
"type": "object"
},
"ProdutosProdutoPaiDTO": {
"required": [
"cloneInfo"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"cloneInfo": {
"type": "boolean",
"example": true
}
},
"type": "object"
},
"ProdutosTributacaoDTO": {
"properties": {
"origem": {
"type": "integer",
"example": 0
},
"nFCI": {
"type": "string",
"example": ""
},
"ncm": {
"type": "string",
"example": ""
},
"cest": {
"type": "string",
"example": ""
},
"codigoListaServicos": {
"type": "string",
"example": ""
},
"spedTipoItem": {
"type": "string",
"example": ""
},
"codigoItem": {
"type": "string",
"example": ""
},
"percentualTributos": {
"type": "number",
"format": "float",
"example": 0
},
"valorBaseStRetencao": {
"type": "number",
"format": "float",
"example": 0
},
"valorStRetencao": {
"type": "number",
"format": "float",
"example": 0
},
"valorICMSSubstituto": {
"type": "number",
"format": "float",
"example": 0
},
"codigoExcecaoTipi": {
"type": "string",
"example": ""
},
"classeEnquadramentoIpi": {
"type": "string",
"example": ""
},
"valorIpiFixo": {
"type": "number",
"format": "float",
"example": 0
},
"codigoSeloIpi": {
"type": "string",
"example": ""
},
"valorPisFixo": {
"type": "number",
"format": "float",
"example": 0
},
"valorCofinsFixo": {
"type": "number",
"format": "float",
"example": 0
},
"codigoANP": {
"type": "string",
"example": ""
},
"descricaoANP": {
"type": "string",
"example": ""
},
"percentualGLP": {
"type": "number",
"format": "float",
"example": 0
},
"percentualGasNacional": {
"type": "number",
"format": "float",
"example": 0
},
"percentualGasImportado": {
"type": "number",
"format": "float",
"example": 0
},
"valorPartida": {
"type": "number",
"format": "float",
"example": 0
},
"tipoArmamento": {
"description": "Preencher quando a classificação do produto for armamento
`0` Uso permitido
`1` Uso restrito",
"type": "integer",
"default": 0,
"enum": [
0,
1
],
"example": 0
},
"descricaoCompletaArmamento": {
"type": "string",
"example": ""
},
"dadosAdicionais": {
"description": "Campo referente a tag infAdProd da nota fiscal",
"type": "string",
"example": ""
},
"grupoProduto": {
"$ref": "#/components/schemas/ProdutosGrupoProdutoDTO"
}
},
"type": "object"
},
"ProdutosVariacaoDTO": {
"required": [
"nome",
"atributos",
"ordem",
"produtoPai"
],
"properties": {
"nome": {
"type": "string",
"example": "Tamanho:G;Cor:Verde"
},
"ordem": {
"type": "integer",
"example": 1
},
"produtoPai": {
"$ref": "#/components/schemas/ProdutosProdutoPaiDTO"
}
},
"type": "object"
},
"ProdutosVideoDTO": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"example": "https://www.youtube.com/watch?v=1"
}
},
"type": "object"
},
"ProdutosFornecedoresDadosBaseDTO": {
"properties": {
"id": {
"description": "Utilizado no GET.",
"type": "integer",
"example": 12345678
},
"descricao": {
"description": "Descrição do produto no fornecedor.",
"type": "string",
"example": "Copo do Bling"
},
"codigo": {
"description": "Código do produto no fornecedor.",
"type": "string",
"example": "COD-123"
},
"precoCusto": {
"description": "Valor de compra do produto com rateio de frete, descontos e impostos.",
"type": "number",
"format": "float",
"example": 5.9
},
"precoCompra": {
"description": "Valor de compra do produto.",
"type": "number",
"format": "float",
"example": 3.5
},
"padrao": {
"description": "Indica se é o fornecedor padrão do produto.",
"type": "boolean",
"example": false
},
"produto": {
"$ref": "#/components/schemas/ProdutosFornecedoresProdutoDTO"
},
"fornecedor": {
"$ref": "#/components/schemas/ProdutosFornecedoresFornecedorDTO"
}
},
"type": "object"
},
"ProdutosFornecedoresDadosBaseUpdateDTO": {
"properties": {
"id": {
"description": "Utilizado no GET.",
"type": "integer",
"example": 12345678
},
"descricao": {
"description": "Descrição do produto no fornecedor.",
"type": "string",
"example": "Copo do Bling"
},
"codigo": {
"description": "Código do produto no fornecedor.",
"type": "string",
"example": "COD-123"
},
"precoCusto": {
"description": "Valor de compra do produto com rateio de frete, descontos e impostos.",
"type": "number",
"format": "float",
"example": 5.9
},
"precoCompra": {
"description": "Valor de compra do produto.",
"type": "number",
"format": "float",
"example": 3.5
},
"padrao": {
"description": "Indica se é o fornecedor padrão do produto.",
"type": "boolean",
"example": false
},
"produto": {
"$ref": "#/components/schemas/ProdutosFornecedoresProdutoDTO"
},
"fornecedor": {
"$ref": "#/components/schemas/ProdutosFornecedoresFornecedorUpdateDTO"
}
},
"type": "object"
},
"ProdutosFornecedoresDadosDTO": {
"required": [
"produto",
"fornecedor"
],
"properties": {
"garantia": {
"description": "Quantidade de meses de garantia.",
"type": "integer",
"example": 3
}
},
"type": "object"
},
"ProdutosFornecedoresDadosUpdateDTO": {
"required": [
"produto"
],
"properties": {
"garantia": {
"description": "Quantidade de meses de garantia.",
"type": "integer",
"example": 3
}
},
"type": "object"
},
"ProdutosFornecedoresFornecedorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ProdutosFornecedoresFornecedorUpdateDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ProdutosFornecedoresProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ProdutosLojasCategoriaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID da categoria de produto",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ProdutosLojasDadosBaseDTO": {
"required": [
"codigo",
"produto",
"loja"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"codigo": {
"description": "Código do produto na loja virtual",
"type": "string",
"example": "ASDF1234"
},
"preco": {
"type": "number",
"format": "float",
"example": 25.99
},
"precoPromocional": {
"type": "number",
"format": "float",
"example": 22.99
},
"produto": {
"$ref": "#/components/schemas/ProdutosLojasProdutoDTO"
},
"loja": {
"$ref": "#/components/schemas/ProdutosLojasLojaDTO"
},
"fornecedorLoja": {
"$ref": "#/components/schemas/ProdutosLojasFornecedorLojaDTO"
},
"marcaLoja": {
"$ref": "#/components/schemas/ProdutosLojasMarcaLojaDTO"
},
"categoriasProdutos": {
"$ref": "#/components/schemas/ProdutosLojasCategoriaDTO"
}
},
"type": "object"
},
"ProdutosLojasDadosDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ProdutosLojasDadosBaseDTO"
},
{
"properties": {
"categoriasProdutos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosLojasCategoriaDTO"
}
}
},
"type": "object"
}
]
},
"ProdutosLojasFornecedorLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID do fornecedor na loja virtual",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ProdutosLojasLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID da loja no Bling",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ProdutosLojasMarcaLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID da marca do produto na loja virtual",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"ProdutosLojasProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"description": "ID do produto no Bling",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LotesDepositoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LotResponseDTO": {
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"codigoLote": {
"type": "string",
"example": "Lote 1"
},
"idProduto": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"LoteLancamentoDTO": {
"required": [
"idLote",
"observacao"
],
"properties": {
"id": {
"description": "ID do lancamento do lote",
"type": "integer",
"readOnly": true,
"example": 12345678
},
"idLote": {
"description": "ID do lote",
"type": "integer",
"readOnly": true,
"example": 12345678
},
"quantidade": {
"description": "Quantidade do lote",
"type": "integer",
"example": 12345678
},
"tipoLancamento": {
"description": "Tipo de lançamento
`1` Entrada
`2` Saída
`3` Balanço",
"type": "integer",
"enum": [
1,
2,
3
],
"example": "1"
},
"data": {
"description": "Data de lançamento",
"type": "string",
"readOnly": true,
"example": "2021-01-01 00:00:00"
},
"idOrigem": {
"description": "ID da origem",
"type": "integer",
"readOnly": true,
"example": 12345678
},
"observacao": {
"description": "Observação do lote",
"type": "string",
"example": "Observação do lote"
}
},
"type": "object"
},
"LoteLancamentoObservacaoDTO": {
"required": [
"observacao"
],
"properties": {
"observacao": {
"description": "Observação do lote",
"type": "string",
"example": "Observação do lote"
}
},
"type": "object"
},
"LotePutRequestDTO": {
"properties": {
"codigoLote": {
"type": "string",
"example": "Lote 1"
},
"dataFabricacao": {
"type": "string",
"example": "2021-01-01"
},
"dataValidade": {
"type": "string",
"example": "2021-01-01"
},
"diasPermitidoVenda": {
"type": "integer",
"example": 10
},
"codigoAgregacao": {
"type": "string",
"example": "12345678"
}
},
"type": "object"
},
"LoteStatusDTO": {
"required": [
"status"
],
"properties": {
"status": {
"description": "`1` Ativo
`2` Inativo",
"type": "integer",
"enum": [
1,
2
],
"example": 1
}
},
"type": "object"
},
"LotesDTO": {
"required": [
"produto",
"deposito",
"idLote",
"dataFabricacao",
"dataValidade"
],
"properties": {
"idLote": {
"type": "integer",
"example": "12345678"
},
"codigoLote": {
"type": "string",
"example": "Lote 1"
},
"dataFabricacao": {
"type": "string",
"example": "2021-01-01"
},
"dataValidade": {
"type": "string",
"example": "2021-01-01"
},
"diasPermitidoVenda": {
"type": "integer",
"example": 10
},
"codigoAgregacao": {
"type": "string",
"example": "12345678"
},
"produto": {
"$ref": "#/components/schemas/LotesProdutoDTO"
},
"deposito": {
"$ref": "#/components/schemas/LotesDepositoDTO"
},
"status": {
"description": "`1` Ativo
`2` Inativo",
"type": "integer",
"enum": [
1,
2
],
"readOnly": true,
"example": 1
}
},
"type": "object"
},
"ProdutoControlaLotesDTO": {
"required": [
"idProduto"
],
"properties": {
"idProduto": {
"description": "ID do produto",
"type": "integer",
"example": 12345678
},
"controlaLote": {
"description": "Indica se o produto controla lote",
"type": "boolean",
"readOnly": true,
"example": true
}
},
"type": "object"
},
"LotesProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"SaldoLoteDTO": {
"properties": {
"idLote": {
"description": "ID do lote",
"type": "integer",
"example": 12345678
},
"produto": {
"$ref": "#/components/schemas/LotesProdutoDTO"
},
"deposito": {
"$ref": "#/components/schemas/LotesDepositoDTO"
},
"saldoAtual": {
"description": "Saldo atual do lote",
"type": "number",
"format": "float",
"example": 12345678.12
}
},
"type": "object"
},
"SaldoSomaLotesDTO": {
"properties": {
"produto": {
"$ref": "#/components/schemas/LotesProdutoDTO"
},
"deposito": {
"$ref": "#/components/schemas/LotesDepositoDTO"
},
"saldoTotal": {
"description": "Soma dos saldos de lotes",
"type": "number",
"example": 12345678.12
}
},
"type": "object"
},
"SaldoSomaLotesTodosDepositosDTO": {
"properties": {
"produto": {
"$ref": "#/components/schemas/LotesProdutoDTO"
},
"saldoTotal": {
"description": "Soma dos saldos de lotes",
"type": "number",
"format": "float",
"example": 12345678.12
}
},
"type": "object"
},
"SaveResponseLotsDTO": {
"properties": {
"saved": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LotResponseDTO"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"type": "object"
},
"ProdutosVariacoesAtributoDTO": {
"required": [
"nome"
],
"properties": {
"nome": {
"type": "string",
"example": "Cor"
},
"opcoes": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Azul",
"Vermelho"
]
}
},
"type": "object"
},
"ProdutosVariacoesCombinacaoDadosDTO": {
"required": [
"produtoPai",
"atributos"
],
"properties": {
"produtoPai": {
"$ref": "#/components/schemas/ProdutosVariacoesProdutoPaiDTO"
},
"atributos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProdutosVariacoesAtributoDTO"
}
}
},
"type": "object"
},
"ProdutosVariacoesDadosAtributoDTO": {
"required": [
"atributoAntigo",
"atributoNovo"
],
"properties": {
"atributoAntigo": {
"type": "string",
"example": "Cor"
},
"atributoNovo": {
"type": "string",
"example": "Coloração"
}
},
"type": "object"
},
"ProdutosVariacoesProdutoPaiDTO": {
"properties": {
"id": {
"type": "integer",
"example": 123456789
}
},
"type": "object"
},
"SituacoesAcaoDTO": {
"required": [
"id",
"nome",
"descricao"
],
"properties": {
"id": {
"type": "integer",
"example": 6
},
"nome": {
"description": "Nome da ação.",
"type": "string",
"example": "estornarEstoque"
},
"descricao": {
"description": "Descrição da ação.",
"type": "string",
"example": "Estornar estoque"
}
},
"type": "object"
},
"SituacoesModuloBaseDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"SituacoesModuloDTO": {
"required": [
"nome",
"descricao",
"criarSituacoes"
],
"properties": {
"nome": {
"description": "Nome do módulo.",
"type": "string",
"example": "Vendas"
},
"descricao": {
"description": "Descrição do módulo.",
"type": "string",
"example": "Pedidos de Venda"
},
"criarSituacoes": {
"description": "Identifica a possibilidade de criar situações.",
"type": "boolean",
"example": false
}
},
"type": "object"
},
"SituacoesDTO": {
"required": [
"id",
"nome"
],
"properties": {
"id": {
"type": "integer",
"example": 9
},
"nome": {
"description": "Utilizado no GET.",
"type": "string",
"example": "Em aberto"
}
},
"type": "object"
},
"SituacoesDadosDTO": {
"properties": {
"idHerdado": {
"description": "ID da situação de referência.",
"type": "integer",
"example": 0
},
"cor": {
"description": "Código hexadecimal.",
"type": "string",
"example": "#E9DC40"
}
},
"type": "object"
},
"SituacoesTransicaoDTO": {
"required": [
"id",
"situacaoOrigem",
"situacaoDestino"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 9
},
"ativo": {
"description": "Identifica se a transição está ativa.",
"type": "boolean",
"example": true
},
"acoes": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12,
15
]
},
"modulo": {
"$ref": "#/components/schemas/SituacoesModuloBaseDTO"
},
"situacaoOrigem": {
"$ref": "#/components/schemas/SituacoesDTO"
},
"situacaoDestino": {
"$ref": "#/components/schemas/SituacoesDTO"
}
},
"type": "object"
},
"VendasCategoriaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"VendasCreateInvoiceResponseDTO": {
"required": [
"idNotaFiscal"
],
"properties": {
"idNotaFiscal": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"VendasDadosBaseDTO": {
"required": [
"contato",
"data",
"dataPrevista",
"dataSaida"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"numero": {
"type": "integer",
"example": 123
},
"numeroLoja": {
"type": "string",
"example": "Loja_123"
},
"data": {
"description": "Valor obrigatório caso parâmetro de geração de parcelas seja este",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"dataSaida": {
"description": "Valor obrigatório caso parâmetro de geração de parcelas seja este",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"dataPrevista": {
"description": "Valor obrigatório caso parâmetro de geração de parcelas seja este",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"totalProdutos": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 10
},
"total": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 12
},
"contato": {
"$ref": "#/components/schemas/VendasContatoDTO"
},
"situacao": {
"$ref": "#/components/schemas/VendasSituacaoDTO"
},
"loja": {
"$ref": "#/components/schemas/VendasLojaDTO"
}
},
"type": "object"
},
"VendasDadosBaseDTO_PUT": {
"required": [
"contato",
"data",
"dataPrevista",
"dataSaida"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"example": 12345678
},
"numero": {
"type": "integer",
"example": 123
},
"numeroLoja": {
"type": "string",
"example": "Loja_123"
},
"data": {
"description": "Valor obrigatório caso parâmetro de geração de parcelas seja este",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"dataSaida": {
"description": "Valor obrigatório caso parâmetro de geração de parcelas seja este",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"dataPrevista": {
"description": "Valor obrigatório caso parâmetro de geração de parcelas seja este",
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"totalProdutos": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 10
},
"total": {
"type": "number",
"format": "float",
"readOnly": true,
"example": 12
},
"contato": {
"$ref": "#/components/schemas/VendasContatoDTO"
},
"situacao": {
"$ref": "#/components/schemas/VendasSituacaoDTO_PUT"
},
"loja": {
"$ref": "#/components/schemas/VendasLojaDTO"
}
},
"type": "object"
},
"VendasDadosDTO": {
"required": [
"itens",
"parcelas"
],
"properties": {
"numeroPedidoCompra": {
"description": "Número da ordem de compra do pedido.",
"type": "string",
"example": "123"
},
"outrasDespesas": {
"type": "number",
"format": "float",
"example": 2
},
"observacoes": {
"type": "string",
"example": "Observações do pedido."
},
"observacoesInternas": {
"type": "string",
"example": "Observações internas do pedido."
},
"desconto": {
"$ref": "#/components/schemas/VendasDescontoDTO"
},
"categoria": {
"$ref": "#/components/schemas/VendasCategoriaDTO"
},
"notaFiscal": {
"$ref": "#/components/schemas/VendasNotaFiscalDTO"
},
"tributacao": {
"$ref": "#/components/schemas/VendasTributacaoDTO"
},
"itens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VendasItemDTO"
}
},
"parcelas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VendasParcelaDTO"
}
},
"transporte": {
"$ref": "#/components/schemas/VendasTransporteDTO"
},
"vendedor": {
"$ref": "#/components/schemas/VendasVendedorDTO"
},
"intermediador": {
"$ref": "#/components/schemas/VendasIntermediadorDTO"
},
"taxas": {
"$ref": "#/components/schemas/VendasTaxaDTO"
}
},
"type": "object"
},
"VendasDescontoDTO": {
"required": [
"valor"
],
"properties": {
"valor": {
"type": "number",
"format": "float",
"example": 15.45
},
"unidade": {
"type": "string",
"default": "REAL",
"enum": [
"REAL",
"PERCENTUAL"
]
}
},
"type": "object"
},
"VendasIntermediadorDTO": {
"properties": {
"cnpj": {
"type": "string",
"example": "13921649000197"
},
"nomeUsuario": {
"type": "string",
"example": "usuario"
}
},
"type": "object"
},
"VendasItemComissaoDTO": {
"properties": {
"base": {
"type": "number",
"format": "float",
"example": 10
},
"aliquota": {
"type": "number",
"format": "float",
"example": 2
},
"valor": {
"type": "number",
"format": "float",
"example": 0.2
}
},
"type": "object"
},
"VendasItemDTO": {
"required": [
"id",
"quantidade",
"valor",
"valorLista",
"descricao"
],
"properties": {
"id": {
"description": "Ignorado no método POST.",
"type": "integer",
"readOnly": true,
"example": 12345678
},
"codigo": {
"type": "string",
"example": "BLG-5"
},
"unidade": {
"type": "string",
"example": "UN"
},
"quantidade": {
"type": "number",
"format": "float",
"example": 1
},
"desconto": {
"description": "Valor percentual.",
"type": "number",
"format": "float",
"example": 2
},
"valor": {
"description": "Valor unitário do item. Preço de lista = 4.9 (valor) + 2% (desconto)",
"type": "number",
"format": "float",
"example": 4.9
},
"aliquotaIPI": {
"type": "number",
"format": "float",
"example": 0
},
"descricao": {
"type": "string",
"example": "Produto do Bling"
},
"descricaoDetalhada": {
"type": "string",
"example": "Brinde"
},
"produto": {
"$ref": "#/components/schemas/VendasItemProdutoDTO"
},
"comissao": {
"$ref": "#/components/schemas/VendasItemComissaoDTO"
},
"naturezaOperacao": {
"$ref": "#/components/schemas/VendasItemNaturezaOperacaoDTO"
}
},
"type": "object"
},
"VendasItemNaturezaOperacaoDTO": {
"properties": {
"id": {
"description": "ID da natureza de operação",
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"VendasItemProdutoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"VendasLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"unidadeNegocio": {
"$ref": "#/components/schemas/LojaUnidadeNegocioDTO"
}
},
"type": "object"
},
"VendasNotaFiscalDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object",
"readOnly": true
},
"VendasParcelaDTO": {
"required": [
"id",
"dataVencimento",
"valor",
"formaPagamento"
],
"properties": {
"id": {
"description": "Ignorado no método POST.",
"type": "integer",
"example": 12345678
},
"dataVencimento": {
"type": "string",
"format": "date",
"example": "2023-01-12"
},
"valor": {
"type": "number",
"format": "float",
"example": 123.45
},
"observacoes": {
"type": "string",
"example": "Observação da parcela"
},
"caut": {
"description": "cAut (ou NSU): código de autorização da operação financeira",
"type": "string",
"example": "123456789"
},
"formaPagamento": {
"$ref": "#/components/schemas/VendasParcelaFormaPagamentoDTO"
}
},
"type": "object"
},
"VendasParcelaFormaPagamentoDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"VendasSituacaoDTO": {
"required": [
"id",
"valor"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"valor": {
"type": "integer",
"readOnly": true,
"example": 1
}
},
"type": "object"
},
"VendasSituacaoDTO_PUT": {
"required": [
"id",
"valor"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"valor": {
"type": "integer",
"readOnly": true,
"example": 1
}
},
"type": "object",
"readOnly": true
},
"VendasTaxaDTO": {
"properties": {
"taxaComissao": {
"description": "Taxa de comissão perante ao total da venda.",
"type": "number",
"format": "float",
"example": 1
},
"custoFrete": {
"description": "Valor de custo do frete.",
"type": "number",
"format": "float",
"example": 9.99
},
"valorBase": {
"description": "Valor base da venda para demonstrativo de cálculo das taxas via interface (Se não informado considera o total da venda).",
"type": "number",
"format": "float",
"example": 129.9
}
},
"type": "object"
},
"VendasTransporteContatoDTO": {
"required": [
"nome"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"example": "Transportador"
}
},
"type": "object"
},
"VendasTransporteDTO": {
"properties": {
"fretePorConta": {
"description": "`0` Contratação do Frete por conta do Remetente (CIF)
`1` Contratação do Frete por conta do Destinatário (FOB)
`2` Contratação do Frete por conta de Terceiros
`3` Transporte Próprio por conta do Remetente
`4` Transporte Próprio por conta do Destinatário
`9` Sem Ocorrência de Transporte.",
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
9
],
"example": 0
},
"frete": {
"type": "number",
"format": "float",
"example": 20
},
"quantidadeVolumes": {
"type": "integer",
"example": 1
},
"pesoBruto": {
"type": "number",
"format": "float",
"example": 0.5
},
"prazoEntrega": {
"type": "integer",
"example": 10
},
"contato": {
"$ref": "#/components/schemas/VendasTransporteContatoDTO"
},
"etiqueta": {
"$ref": "#/components/schemas/VendasTransporteEtiquetaDTO"
},
"volumes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VendasTransporteVolumeDTO"
}
}
},
"type": "object"
},
"VendasTransporteEtiquetaDTO": {
"properties": {
"nome": {
"type": "string",
"example": "Transportador"
},
"endereco": {
"type": "string",
"example": "Olavo Bilac"
},
"numero": {
"type": "string",
"example": "914"
},
"complemento": {
"type": "string",
"example": "Sala 101"
},
"municipio": {
"type": "string",
"example": "Bento Gonçalves"
},
"uf": {
"type": "string",
"example": "RS"
},
"cep": {
"type": "string",
"example": "95702-000"
},
"bairro": {
"type": "string",
"example": "Imigrante"
},
"nomePais": {
"description": "Utilizado quando a UF for 'EX' (estrangeiro).",
"type": "string",
"example": "BRASIL"
}
},
"type": "object"
},
"VendasTransporteVolumeDTO": {
"required": [
"id",
"servico"
],
"properties": {
"id": {
"description": "Ignorado no método POST.",
"type": "integer",
"example": 12345678
},
"servico": {
"type": "string",
"example": "ALIAS_123"
},
"codigoRastreamento": {
"type": "string",
"example": "COD123BR"
}
},
"type": "object"
},
"VendasTributacaoDTO": {
"properties": {
"totalICMS": {
"type": "number",
"format": "float",
"example": 5.55
},
"totalIPI": {
"type": "number",
"format": "float",
"example": 5.55
}
},
"type": "object"
},
"VendasContatoDTO": {
"required": [
"id",
"nome"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"readOnly": true,
"example": "Contato do Bling"
},
"tipoPessoa": {
"description": "`F` Física
`J` Jurídica
`E` Estrangeira",
"type": "string",
"enum": [
"F",
"J",
"E"
],
"example": "J"
},
"numeroDocumento": {
"description": "CNPJ ou CPF.",
"type": "string",
"example": "30188025000121"
}
},
"type": "object"
},
"VendasVendedorDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"VendedoresComissaoDTO": {
"required": [
"descontoMaximo",
"aliquota"
],
"properties": {
"descontoMaximo": {
"type": "number",
"format": "float",
"example": 10
},
"aliquota": {
"type": "number",
"format": "float",
"example": 2
}
},
"type": "object"
},
"VendedoresContatoDTO": {
"required": [
"id",
"nome",
"situacao"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"nome": {
"type": "string",
"example": "Vendedor"
},
"situacao": {
"description": "`A` Ativo
`I` Inativo
`S` Sem movimento
`E` Excluído",
"type": "string",
"enum": [
"A",
"I",
"S",
"E"
],
"example": "A"
}
},
"type": "object"
},
"VendedoresDadosBaseDTO": {
"required": [
"contato"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"descontoLimite": {
"description": "Percentagem máxima para ceder como desconto, 0 para sem limite.",
"type": "number",
"format": "float",
"example": 10.12
},
"loja": {
"$ref": "#/components/schemas/VendedoresLojaDTO"
},
"contato": {
"$ref": "#/components/schemas/VendedoresContatoDTO"
}
},
"type": "object"
},
"VendedoresDadosDTO": {
"required": [
"comissoes"
],
"properties": {
"comissoes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VendedoresComissaoDTO"
}
}
},
"type": "object"
},
"VendedoresLojaDTO": {
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
"CamposCustomizadosResponse_POST_PUT": {
"properties": {
"idsVinculosAgrupadores": {
"type": "array",
"items": {
"type": "integer",
"example": 12345678
}
},
"idsOpcoes": {
"type": "array",
"items": {
"type": "integer",
"example": 12345678
}
}
},
"type": "object"
},
"ContatosAlertasResponse": {
"required": [
"alertas"
],
"properties": {
"alertas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"type": "object"
},
"NotaFiscalResponse_POST": {
"required": [
"numero",
"serie",
"contato"
],
"properties": {
"numero": {
"type": "string",
"example": "6541"
},
"serie": {
"type": "string",
"example": "1"
},
"contato": {
"properties": {
"nome": {
"type": "string",
"example": "Contato do Bling"
}
},
"type": "object"
}
},
"type": "object"
},
"NotasServicosResponse_POST_PUT": {
"required": [
"id",
"numeroRPS",
"serie"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"numeroRPS": {
"type": "string",
"example": "123"
},
"serie": {
"type": "string",
"example": "1"
}
},
"type": "object"
},
"PedidosCompraResponse_POST_PUT": {
"required": [
"id",
"numero"
],
"properties": {
"id": {
"type": "integer",
"example": 12345678
},
"numero": {
"type": "integer",
"example": 123
},
"alertas": {
"type": "array",
"items": {
"type": "string",
"example": "O número do seu pedido foi modificado para: 124"
}
},
"errosAnexo": {
"type": "array",
"items": {
"type": "string",
"example": "Arquivo comprovante.png : [erro]"
}
}
},
"type": "object"
},
"ProdutosLojasResponse_POST_PUT": {
"properties": {
"categoriasProdutos": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID da categoria de produto que foi vínculada com sucesso",
"type": "integer",
"example": 12345678
}
},
"type": "object"
}
}
},
"type": "object"
},
"ProdutosResponse_POST_PUT": {
"properties": {
"data": {
"properties": {
"id": {
"description": "ID do produto",
"type": "number",
"example": 6423817751
},
"variations": {
"type": "object",
"allOf": [
{
"properties": {
"deleted": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID do produto",
"type": "integer",
"example": 6423817579
},
"variations": {
"type": "object"
},
"warnings": {
"type": "array",
"items": {
"type": "string",
"example": "Mensagem de aviso."
}
}
},
"type": "object"
}
}
},
"type": "object"
},
{
"properties": {
"updated": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID do produto",
"type": "integer",
"example": 6423817579
},
"variations": {
"type": "object"
},
"warnings": {
"type": "array",
"items": {
"type": "string",
"example": "Mensagem de aviso."
}
}
},
"type": "object"
}
}
},
"type": "object"
},
{
"properties": {
"saved": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID do produto",
"type": "integer",
"example": 6423817579
},
"variations": {
"type": "object"
},
"warnings": {
"type": "array",
"items": {
"type": "string",
"example": "Mensagem de aviso."
}
}
},
"type": "object"
}
}
},
"type": "object"
}
]
},
"warnings": {
"type": "array",
"items": {
"type": "string",
"example": "Mensagem de aviso."
}
}
},
"type": "object"
}
},
"type": "object"
},
"ProdutosAlertasResponse": {
"properties": {
"alertas": {
"type": "array",
"items": {
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"example": 12345678
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/ErrorResponse"
}
]
}
}
},
"type": "object"
},
"VendasResponse_POST_PUT": {
"properties": {
"alertas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorField"
}
},
"rastreamento": {
"description": "Dados de rastreamento.",
"type": "object"
}
},
"type": "object"
},
"ErrorResponse": {
"required": [
"error.type",
"message",
"description"
],
"properties": {
"error": {
"$ref": "#/components/schemas/Error"
}
},
"type": "object"
},
"Error": {
"required": [
"type",
"message",
"description"
],
"properties": {
"type": {
"type": "string",
"enum": [
"BAD_REQUEST",
"VALIDATION_ERROR",
"MISSING_REQUIRED_FIELD_ERROR",
"EMPTY_REQUEST_BODY",
"INVALID_REQUEST_BODY",
"INVALID_APIKEY_ERROR",
"UNAUTHORIZED",
"UNAUTHENTICATED",
"FORBIDDEN",
"RESOURCE_NOT_FOUND",
"METHOD_NOT_ALLOWED",
"TOO_MANY_REQUESTS",
"UNKNOWN_ERROR",
"SERVER_ERROR",
"NOT_IMPLEMENTED"
],
"example": "VALIDATION_ERROR"
},
"message": {
"type": "string",
"example": "Não foi possível salvar a venda"
},
"description": {
"type": "string",
"example": "A venda não pode ser salva, pois ocorreram problemas em sua validação."
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorField"
}
}
},
"type": "object"
},
"ErrorField": {
"required": [
"code",
"msg"
],
"properties": {
"code": {
"type": "integer",
"example": 49
},
"msg": {
"type": "string",
"example": "Uma ou mais parcelas da venda possuem erros de validação"
},
"element": {
"type": "string",
"example": "parcelas"
},
"namespace": {
"description": "Referência ao objeto com erro.",
"type": "string",
"example": "VENDAS"
},
"collection": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorFieldCollection"
}
}
},
"type": "object"
},
"ErrorFieldCollection": {
"required": [
"index",
"code",
"msg"
],
"properties": {
"index": {
"type": "integer",
"example": 1
},
"code": {
"type": "integer",
"example": 12
},
"msg": {
"type": "string",
"example": "Id da forma de pagamento inválido."
},
"element": {
"type": "string",
"example": "formaPagamento"
},
"namespace": {
"description": "Referência ao objeto com erro.",
"type": "string",
"example": "VENDAS"
}
},
"type": "object"
}
},
"parameters": {
"page": {
"name": "page",
"in": "query",
"description": "N° da pagina da listagem",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
"limit": {
"name": "limit",
"in": "query",
"description": "Quantidade de registros que devem ser exibidos por listagem",
"schema": {
"type": "integer",
"default": 100,
"minimum": 1
}
},
"pagina": {
"name": "pagina",
"in": "query",
"description": "N° da página da listagem",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
},
"limite": {
"name": "limite",
"in": "query",
"description": "Quantidade de registros que devem ser exibidos por página",
"schema": {
"type": "integer",
"default": 100,
"minimum": 1
}
},
"fields": {
"name": "fields",
"in": "query",
"description": "Permite filtrar quais campo deseja retornar na requisição.",
"schema": {
"type": "string",
"example": "id,descricao,situacao"
}
},
"idOrigemContaReceber": {
"name": "idOrigem",
"in": "query",
"description": "ID da venda ou nota fiscal",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"situacoesContaReceber": {
"name": "situacoes[]",
"in": "query",
"description": "`1` Em aberto
`2` Recebido
`3` Parcialmente recebido
`4` Devolvido
`5` Parcialmente devolvido
`6` Cancelado",
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"default": 1,
"enum": [
1,
2,
3,
4,
5,
6
],
"example": [
1,
3
]
}
},
"idAnuncio": {
"name": "idAnuncio",
"in": "path",
"description": "ID do anúncio",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"tipoIntegracao": {
"name": "tipoIntegracao",
"in": "query",
"description": "Tipo de integração",
"required": true,
"schema": {
"type": "string",
"example": "MercadoLivre"
}
},
"idLojaQuery": {
"name": "idLoja",
"in": "query",
"description": "ID da loja",
"required": true,
"schema": {
"type": "integer",
"example": 1
}
},
"idBordero": {
"name": "idBordero",
"in": "path",
"description": "ID do bordero",
"required": true,
"schema": {
"type": "integer"
}
},
"idCampoCustomizado": {
"name": "idCampoCustomizado",
"in": "path",
"description": "ID do campo customizado",
"required": true,
"schema": {
"type": "integer",
"example": "12345678"
}
},
"idCategoriaLoja": {
"name": "idCategoriaLoja",
"in": "path",
"description": "ID do vínculo da categoria de produto com a da loja",
"required": true,
"schema": {
"type": "integer",
"example": "12345678"
}
},
"idCategoriaProduto": {
"name": "idCategoriaProduto",
"in": "path",
"description": "ID da categoria de produto",
"required": true,
"schema": {
"type": "integer",
"example": "12345678"
}
},
"idCategoria": {
"name": "idCategoria",
"in": "path",
"description": "ID da categoria de receita e despesa",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idContaContabil": {
"name": "idContaContabil",
"in": "path",
"description": "ID da conta financeira",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idContaReceber": {
"name": "idContaReceber",
"in": "path",
"description": "ID da conta a receber",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idContato": {
"name": "idContato",
"in": "path",
"description": "ID do contato",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idContrato": {
"name": "idContrato",
"in": "path",
"description": "ID do contrato",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idDeposito": {
"name": "idDeposito",
"in": "path",
"description": "ID do depósito",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"filtroSaldoEstoque": {
"name": "filtroSaldoEstoque",
"in": "query",
"description": "Filtra o saldo em estoque
`0` zerado
`1` positivo
`2` negativo",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"enum": [
0,
1,
2
]
}
},
"filtroSaldoEstoqueDeposito": {
"name": "filtroSaldoEstoqueDeposito",
"in": "query",
"description": "ID do depósito para considerar no filtro de saldo em estoque. Se omitido, considera todos os depósitos.",
"required": false,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idsProdutos[]": {
"name": "idsProdutos[]",
"in": "query",
"description": "IDs dos produtos",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
"idLote": {
"name": "idLote",
"in": "path",
"description": "ID do lote",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idsDepositos[]": {
"name": "idsDepositos[]",
"in": "query",
"description": "IDs dos depósitos",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345678,
87654321
]
}
},
"idsLotes[]": {
"name": "idsLotes[]",
"in": "query",
"description": "IDs dos lotes",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
12345678,
87654321
]
}
},
"codigosLotes[]": {
"name": "codigosLotes[]",
"in": "query",
"description": "Códigos dos lotes",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Lote A",
"Lote B"
]
}
},
"status": {
"name": "status",
"in": "query",
"description": "Status do lote",
"required": false,
"schema": {
"description": "`A` Ativo
`I` Inativo",
"type": "string",
"enum": [
"A",
"I"
],
"example": "A"
}
},
"dataValidadeInicial": {
"name": "dataValidadeInicial",
"in": "query",
"description": "Data de validade inicial",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2020-01-01"
}
},
"dataValidadeFinal": {
"name": "dataValidadeFinal",
"in": "query",
"description": "Data de validade final",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2020-01-01"
}
},
"dataFabricacaoInicial": {
"name": "dataFabricacaoInicial",
"in": "query",
"description": "Data de fabricação inicial",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2020-01-01"
}
},
"dataFabricacaoFinal": {
"name": "dataFabricacaoFinal",
"in": "query",
"description": "Data de fabricação final",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2020-01-01"
}
},
"dataCriacaoInicial": {
"name": "dataCriacaoInicial",
"in": "query",
"description": "Data de inclusão inicial",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2020-01-01 12:00:00"
}
},
"dataCriacaoFinal": {
"name": "dataCriacaoFinal",
"in": "query",
"description": "Data de inclusão final",
"required": false,
"schema": {
"type": "string",
"format": "datetime",
"example": "2020-01-01 13:00:00"
}
},
"idDepositoInternal": {
"name": "idDeposito",
"in": "path",
"description": "ID do depósito",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idLancamento": {
"name": "idLancamento",
"in": "path",
"description": "ID do lançamento",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idFormaPagamento": {
"name": "idFormaPagamento",
"in": "path",
"description": "ID da forma de pagamento",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idProdutoHomologacao": {
"name": "idProdutoHomologacao",
"in": "path",
"description": "ID do produto da homologação.",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idLogistica": {
"name": "idLogistica",
"in": "path",
"description": "ID da logística",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idLogisticaServico": {
"name": "idLogisticaServico",
"in": "path",
"description": "ID do serviço",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idObjeto": {
"name": "idObjeto",
"in": "path",
"description": "ID do objeto logístico",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idRemessa": {
"name": "idRemessa",
"in": "path",
"description": "ID da remessa de postagem",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idNotaFiscalConsumidor": {
"name": "idNotaFiscalConsumidor",
"in": "path",
"description": "ID da nota fiscal de consumidor",
"required": true,
"schema": {
"type": "integer",
"example": "12345678"
}
},
"idNotaFiscal": {
"name": "idNotaFiscal",
"in": "path",
"description": "ID da nota fiscal",
"required": true,
"schema": {
"type": "integer",
"example": "12345678"
}
},
"chaveAcesso": {
"name": "chaveAcesso",
"in": "path",
"description": "Chave de acesso da nota fiscal (44 dígitos)",
"required": true,
"schema": {
"type": "string",
"pattern": "^\\d{44}$",
"example": "42260290209032000194550010012900751642381235"
}
},
"idNotaServico": {
"name": "idNotaServico",
"in": "path",
"description": "ID da nota de serviço",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idPropostaComercial": {
"name": "idPropostaComercial",
"in": "path",
"description": "ID da proposta comercial",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
"idPedidoCompra": {
"name": "idPedidoCompra",
"in": "path",
"description": "ID do pedido de compra",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idProdutoEstrutura": {
"name": "idProdutoEstrutura",
"in": "path",
"description": "ID do produto com composição",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idComponente": {
"name": "idComponente",
"in": "path",
"description": "ID do componente",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idProdutoFornecedor": {
"name": "idProdutoFornecedor",
"in": "path",
"description": "ID do produto fornecedor",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idProdutoLoja": {
"name": "idProdutoLoja",
"in": "path",
"description": "ID do vínculo do produto com a loja",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idProduto": {
"name": "idProduto",
"in": "path",
"description": "ID do produto",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idProdutoPai": {
"name": "idProdutoPai",
"in": "path",
"description": "ID do produto pai",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idModuloSistema": {
"name": "idModuloSistema",
"in": "path",
"description": "ID do módulo do sistema",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idSituacao": {
"name": "idSituacao",
"in": "path",
"description": "ID da situação",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idTransicao": {
"name": "idTransicao",
"in": "path",
"description": "ID da transição",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idPedidoVenda": {
"name": "idPedidoVenda",
"in": "path",
"description": "ID do pedido de venda",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idVendedor": {
"name": "idVendedor",
"in": "path",
"description": "ID do vendedor",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idContaPagar": {
"name": "idContaPagar",
"in": "path",
"description": "ID da conta a pagar",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idCanalVenda": {
"name": "idCanalVenda",
"in": "path",
"description": "ID do canal de venda",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"agrupador": {
"name": "agrupador",
"in": "query",
"description": "Agrupador do canal de venda
`1` Loja virtual
`2` Hub
`3` Marketplace
`4` API",
"required": false,
"schema": {
"type": "integer",
"enum": [
1,
2,
3,
4
],
"example": 1
}
},
"idOrdemProducao": {
"name": "idOrdemProducao",
"in": "path",
"description": "ID da ordem de produção",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idGrupoProduto": {
"name": "idGrupoProduto",
"in": "path",
"description": "ID do grupo de produto",
"required": true,
"schema": {
"type": "integer",
"example": 12345678
}
},
"idLancamentoCaixa": {
"name": "idCaixa",
"in": "path",
"description": "ID do lançamento de caixas e bancos",
"required": true,
"schema": {
"type": "integer",
"example": "12345678"
}
}
},
"headers": {
"x-bling-homologacao": {
"description": "Hash que deve ser informado na próxima requisição da validação.",
"schema": {
"type": "string"
}
}
},
"securitySchemes": {
"OAuth2": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://bling.com.br/Api/v3/oauth/authorize",
"tokenUrl": "https://bling.com.br/Api/v3/oauth/token",
"refreshUrl": "https://bling.com.br/Api/v3/oauth/token",
"scopes": {}
}
}
},
"OAuth2-Docs": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://bling.com.br/Api/v3/oauth/authorize",
"tokenUrl": "https://developer.bling.com.br/api/bling/oauth/token",
"refreshUrl": "https://developer.bling.com.br/api/bling/oauth/token",
"scopes": {}
}
}
}
}
},
"security": [
{
"OAuth2": [],
"OAuth2-Docs": []
}
],
"tags": [
{
"name": "Anúncios - Categorias"
},
{
"name": "Anúncios"
},
{
"name": "Borderôs"
},
{
"name": "Campos Customizados"
},
{
"name": "Categorias - Lojas"
},
{
"name": "Categorias - Produtos"
},
{
"name": "Categorias - Receitas e Despesas"
},
{
"name": "Contas Financeiras"
},
{
"name": "Contas a Receber"
},
{
"name": "Contatos"
},
{
"name": "Contatos - Tipos"
},
{
"name": "Contratos"
},
{
"name": "Depósitos"
},
{
"name": "Empresas"
},
{
"name": "Estoques"
},
{
"name": "Produtos - Lotes"
},
{
"name": "Produtos - Lotes Lançamentos"
},
{
"name": "Formas de Pagamentos"
},
{
"name": "Homologação"
},
{
"name": "Logísticas"
},
{
"name": "Logísticas - Serviços"
},
{
"name": "Logísticas - Objetos"
},
{
"name": "Logísticas - Etiquetas"
},
{
"name": "Logísticas - Remessas"
},
{
"name": "Notas Fiscais de Consumidor Eletrônicas",
"description": ""
},
{
"name": "Notas Fiscais Eletrônicas"
},
{
"name": "Notas Fiscais de Serviço Eletrônicas"
},
{
"name": "Notificações"
},
{
"name": "Propostas Comerciais"
},
{
"name": "Pedidos - Compras"
},
{
"name": "Produtos - Estruturas"
},
{
"name": "Produtos - Fornecedores"
},
{
"name": "Produtos - Lojas"
},
{
"name": "Situações - Módulos"
},
{
"name": "Situações"
},
{
"name": "Situações - Transições"
},
{
"name": "Usuários",
"description": ""
},
{
"name": "Pedidos - Vendas"
},
{
"name": "Vendedores"
},
{
"name": "Contas a Pagar"
},
{
"name": "Canais de Venda"
},
{
"name": "Ordens de Produção"
},
{
"name": "Grupos de Produtos"
},
{
"name": "Caixas e Bancos"
}
]
}