Skip to content

Categorias - Receitas e Despesas

bling_erp_api.resources.income_expense_categories.IncomeExpenseCategoriesResource 

IncomeExpenseCategoriesResource(transport: Transport)

Bases: BaseResource

Operações de categorias de receitas e despesas do Bling.

Este recurso mapeia os endpoints /categorias/receitas-despesas. Os métodos canônicos usam português para acompanhar a documentação oficial; os métodos em inglês continuam disponíveis como aliases de compatibilidade.

Source code in src/bling_erp_api/resources/base.py 
141
142
143
def __init__(self, transport: Transport) -> None:
    """Create a resource bound to a transport."""
    self._transport = transport

listar 

listar(
    *,
    pagina: int = 1,
    limite: int = 100,
    tipo: int | None = None,
    situacao: int | None = None,
) -> JsonObject

Lista categorias de receitas e despesas.

Endpoint: GET /categorias/receitas-despesas

Obtém lista paginada de categorias de receitas e despesas.

Parameters:

Name Type Description Default
pagina int

N° da página (Bling: pagina, integer, opcional)

 1
limite int

Registros por página (Bling: limite, integer, opcional)

 100
tipo int | None

0=Todas, 1=Despesa, 2=Receita, 3=Receita e despesa (Bling: tipo, integer, opcional)

 None
situacao int | None

0=Ativas e Inativas, 1=Ativas, 2=Inativas (Bling: situacao, integer, opcional)

 None

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: CategoriasReceitasDespesasDadosBaseDTO
Source code in src/bling_erp_api/resources/income_expense_categories.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def listar(
    self,
    *,
    pagina: int = 1,
    limite: int = 100,
    tipo: int | None = None,
    situacao: int | None = None,
) -> JsonObject:
    """Lista categorias de receitas e despesas.

    Endpoint: GET /categorias/receitas-despesas

    Obtém lista paginada de categorias de receitas e despesas.

    Args:
        pagina: N° da página (Bling: ``pagina``, integer, opcional)
        limite: Registros por página (Bling: ``limite``, integer, opcional)
        tipo: 0=Todas, 1=Despesa, 2=Receita, 3=Receita e despesa (Bling: ``tipo``, integer, opcional)
        situacao: 0=Ativas e Inativas, 1=Ativas, 2=Inativas (Bling: ``situacao``, integer, opcional)

    Returns:
        Bling API response. Response schemas: 200: CategoriasReceitasDespesasDadosBaseDTO
    """
    params: QueryParams = {
        "pagina": pagina,
        "limite": limite,
        **_income_expense_list_params(tipo=tipo, situacao=situacao),
    }
    return self._get("/categorias/receitas-despesas", params=params)

obter 

obter(id_categoria: int) -> JsonObject

Obtém uma categoria de receita e despesa.

Endpoint: GET /categorias/receitas-despesas/{idCategoria}

Obtém uma categoria de receita e despesa pelo ID.

Parameters:

Name Type Description Default
id_categoria int

ID da categoria (Bling: idCategoria, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: CategoriasReceitasDespesasDadosDTO; 404: ErrorResponse
Source code in src/bling_erp_api/resources/income_expense_categories.py 
164
165
166
167
168
169
170
171
172
173
174
175
176
177
def obter(self, id_categoria: int) -> JsonObject:
    """Obtém uma categoria de receita e despesa.

    Endpoint: GET /categorias/receitas-despesas/{idCategoria}

    Obtém uma categoria de receita e despesa pelo ID.

    Args:
        id_categoria: ID da categoria (Bling: ``idCategoria``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: CategoriasReceitasDespesasDadosDTO; 404: ErrorResponse
    """
    return self._get(f"/categorias/receitas-despesas/{id_categoria}")

criar 

criar(dados: CategoriasReceitasDespesasDadosPostDTO) -> JsonObject

Cria uma categoria de receita e despesa.

Endpoint: POST /categorias/receitas-despesas

Cria uma categoria de receita e despesa.

Parameters:

Name Type Description Default
dados CategoriasReceitasDespesasDadosPostDTO

Dados da categoria. Request body schema: CategoriasReceitasDespesasDadosPostDTO

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 201: CategoriasReceitasDespesasDadosBaseDTO; 400: ErrorResponse
Source code in src/bling_erp_api/resources/income_expense_categories.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
def criar(
    self,
    dados: CategoriasReceitasDespesasDadosPostDTO,
) -> JsonObject:
    """Cria uma categoria de receita e despesa.

    Endpoint: POST /categorias/receitas-despesas

    Cria uma categoria de receita e despesa.

    Args:
        dados: Dados da categoria. Request body schema: CategoriasReceitasDespesasDadosPostDTO

    Returns:
        Bling API response. Response schemas: 201: CategoriasReceitasDespesasDadosBaseDTO; 400: ErrorResponse
    """
    return self._post("/categorias/receitas-despesas", json=to_json_object(dados))

alterar 

alterar(
    id_categoria: int, dados: CategoriasReceitasDespesasDadosPostDTO
) -> JsonObject

Altera uma categoria de receita e despesa.

Endpoint: PUT /categorias/receitas-despesas/{idCategoria}

Altera uma categoria de receita e despesa a partir do ID.

Parameters:

Name Type Description Default
id_categoria int

ID da categoria (Bling: idCategoria, integer, obrigatório)

 required
dados CategoriasReceitasDespesasDadosPostDTO

Dados da categoria para atualização. Request body schema: CategoriasReceitasDespesasDadosPostDTO

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: CategoriasReceitasDespesasDadosBaseDTO; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/income_expense_categories.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
def alterar(
    self,
    id_categoria: int,
    dados: CategoriasReceitasDespesasDadosPostDTO,
) -> JsonObject:
    """Altera uma categoria de receita e despesa.

    Endpoint: PUT /categorias/receitas-despesas/{idCategoria}

    Altera uma categoria de receita e despesa a partir do ID.

    Args:
        id_categoria: ID da categoria (Bling: ``idCategoria``, integer, obrigatório)
        dados: Dados da categoria para atualização. Request body schema: CategoriasReceitasDespesasDadosPostDTO

    Returns:
        Bling API response. Response schemas: 200: CategoriasReceitasDespesasDadosBaseDTO; 400: ErrorResponse; 404: ErrorResponse
    """
    return self._put(
        f"/categorias/receitas-despesas/{id_categoria}", json=to_json_object(dados)
    )

remover 

remover(id_categoria: int) -> JsonObject

Remove uma categoria de receita e despesa.

Endpoint: DELETE /categorias/receitas-despesas/{idCategoria}

Remove uma categoria de receita e despesa pelo ID.

Parameters:

Name Type Description Default
id_categoria int

ID da categoria (Bling: idCategoria, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/income_expense_categories.py 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
def remover(self, id_categoria: int) -> JsonObject:
    """Remove uma categoria de receita e despesa.

    Endpoint: DELETE /categorias/receitas-despesas/{idCategoria}

    Remove uma categoria de receita e despesa pelo ID.

    Args:
        id_categoria: ID da categoria (Bling: ``idCategoria``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse
    """
    return self._delete(f"/categorias/receitas-despesas/{id_categoria}")