bling-mcp

{ "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": { "/": {}, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } }, "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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } }, "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" } } } } } }, "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" } } } } } } }, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } }, "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" } } } } } }, "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" } } } } } } }, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } }, "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" } } } } } } }, "/contas-contabeis": { "get": { "tags": [ "Contas Contábeis" ], "summary": "Obtém contas contábeis", "description": "Obtém contas contábeis paginadas.", "parameters": [ { "$ref": "#/components/parameters/pagina" }, { "$ref": "#/components/parameters/limite" }, { "name": "ocultarInvisiveis", "in": "query", "description": "Oculta contas contábeis invisíveis", "required": false, "schema": { "type": "boolean", "example": true } }, { "name": "ocultarTipoContaBancaria",