Caixas e Bancos

bling_erp_api.resources.caixas_bancos.CaixasBancosResource

CaixasBancosResource(transport: Transport)

Bases: BaseResource

Operações de caixas e bancos do Bling.

Este recurso mapeia os endpoints /caixas. 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

def __init__(self, transport: Transport) -> None:
    """Create a resource bound to a transport."""
    self._transport = transport

listar

listar(
    *,
    pagina: int = 1,
    data_inicial: str | None = None,
    data_final: str | None = None,
    ids_categorias: list[int] | None = None,
    id_conta_financeira: int | None = None,
    pesquisa: str | None = None,
    valor: float | None = None,
    situacao_conciliacao: int | None = None,
    situacao: str | None = None,
) -> CaixasGetResponse200

Lista lançamentos de caixas e bancos.

Endpoint: GET /caixas

Obtém lista paginada de lançamentos de caixas e bancos.

Parameters:

Name	Type	Description	Default
pagina	int	N° da página (Bling: pagina, integer, opcional)	1
data_inicial	str | None	Data inicial de consulta (Bling: dataInicial, string, opcional)	None
data_final	str | None	Data final de consulta (Bling: dataFinal, string, opcional)	None
ids_categorias	list[int] | None	IDs das categorias (Bling: idsCategorias, array, opcional)	None
id_conta_financeira	int | None	ID da conta financeira (Bling: idContaFinanceira, integer, opcional)	None
pesquisa	str | None	Pesquisa por descrição (Bling: pesquisa, string, opcional)	None
valor	float | None	Valor do lançamento (Bling: valor, number, opcional)	None
situacao_conciliacao	int | None	Situação da conciliação: 1=Conciliados, 2=Não conciliados, 3=Todos (Bling: situacaoConciliacao, integer, opcional)	None
situacao	str | None	Situação do lançamento: 'R'=Registros, 'E'=Excluídos (Bling: situacao, string, opcional)	None

Returns:

Type	Description
CaixasGetResponse200	Bling API response. Response schemas: 200: CaixasBancosItemLancamentoDTO; 400: ErrorResponse

Source code in src/bling_erp_api/resources/caixas_bancos.py

def listar(  # noqa: PLR0913
    self,
    *,
    pagina: int = 1,
    data_inicial: str | None = None,
    data_final: str | None = None,
    ids_categorias: list[int] | None = None,
    id_conta_financeira: int | None = None,
    pesquisa: str | None = None,
    valor: float | None = None,
    situacao_conciliacao: int | None = None,
    situacao: str | None = None,
) -> CaixasGetResponse200:
    """Lista lançamentos de caixas e bancos.

    Endpoint: GET /caixas

    Obtém lista paginada de lançamentos de caixas e bancos.

    Args:
        pagina: N° da página (Bling: ``pagina``, integer, opcional)
        data_inicial: Data inicial de consulta (Bling: ``dataInicial``, string, opcional)
        data_final: Data final de consulta (Bling: ``dataFinal``, string, opcional)
        ids_categorias: IDs das categorias (Bling: ``idsCategorias``, array, opcional)
        id_conta_financeira: ID da conta financeira (Bling: ``idContaFinanceira``, integer, opcional)
        pesquisa: Pesquisa por descrição (Bling: ``pesquisa``, string, opcional)
        valor: Valor do lançamento (Bling: ``valor``, number, opcional)
        situacao_conciliacao: Situação da conciliação: 1=Conciliados, 2=Não conciliados, 3=Todos (Bling: ``situacaoConciliacao``, integer, opcional)
        situacao: Situação do lançamento: 'R'=Registros, 'E'=Excluídos (Bling: ``situacao``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: CaixasBancosItemLancamentoDTO; 400: ErrorResponse
    """
    params: QueryParams = {
        "pagina": pagina,
        **_caixas_list_params(
            data_inicial=data_inicial,
            data_final=data_final,
            ids_categorias=ids_categorias,
            id_conta_financeira=id_conta_financeira,
            pesquisa=pesquisa,
            valor=valor,
            situacao_conciliacao=situacao_conciliacao,
            situacao=situacao,
        ),
    }
    raw = self._get("/caixas", params=params)
    return self._validate_response(CaixasGetResponse200, raw)

criar

criar(
    lancamento: CaixasBancosSalvarLancamentoDTO,
) -> CaixasBancosSalvarLancamentoResponseDTO

Cria um lançamento de caixa e banco.

Endpoint: POST /caixas

Cria um novo lançamento de caixa e banco.

Parameters:

Name	Type	Description	Default
lancamento	CaixasBancosSalvarLancamentoDTO	Dados do lançamento. Request body schema: CaixasBancosSalvarLancamentoDTO	required

Returns:

Type	Description
CaixasBancosSalvarLancamentoResponseDTO	Bling API response. Response schemas: 201: CaixasBancosSalvarLancamentoResponseDTO; 400: ErrorResponse

Source code in src/bling_erp_api/resources/caixas_bancos.py

def criar(
    self,
    lancamento: CaixasBancosSalvarLancamentoDTO,
) -> CaixasBancosSalvarLancamentoResponseDTO:
    """Cria um lançamento de caixa e banco.

    Endpoint: POST /caixas

    Cria um novo lançamento de caixa e banco.

    Args:
        lancamento: Dados do lançamento. Request body schema: CaixasBancosSalvarLancamentoDTO

    Returns:
        Bling API response. Response schemas: 201: CaixasBancosSalvarLancamentoResponseDTO; 400: ErrorResponse
    """
    raw = self._post("/caixas", json=to_json_object(lancamento))
    return self._validate_response(CaixasBancosSalvarLancamentoResponseDTO, raw)

obter

obter(id_caixa: int) -> CaixasBancosIdCaixaGetResponse200

Obtém um lançamento de caixa e banco.

Endpoint: GET /caixas/{idCaixa}

Obtém os detalhes de um lançamento pelo ID.

Parameters:

Name	Type	Description	Default
id_caixa	int	ID do lançamento (Bling: idCaixa, integer, obrigatório)	required

Returns:

Type	Description
CaixasBancosIdCaixaGetResponse200	Bling API response. Response schemas: 200: CaixasBancosIdCaixaGetResponse200; 404: ErrorResponse

Source code in src/bling_erp_api/resources/caixas_bancos.py

def obter(self, id_caixa: int) -> CaixasBancosIdCaixaGetResponse200:
    """Obtém um lançamento de caixa e banco.

    Endpoint: GET /caixas/{idCaixa}

    Obtém os detalhes de um lançamento pelo ID.

    Args:
        id_caixa: ID do lançamento (Bling: ``idCaixa``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: CaixasBancosIdCaixaGetResponse200; 404: ErrorResponse
    """
    raw = self._get(f"/caixas/{id_caixa}")
    return self._validate_response(CaixasBancosIdCaixaGetResponse200, raw)

alterar

alterar(
    id_caixa: int, lancamento: CaixasBancosSalvarLancamentoDTO
) -> CaixasBancosSalvarLancamentoResponseDTO

Altera um lançamento de caixa e banco.

Endpoint: PUT /caixas/{idCaixa}

Altera um lançamento pelo ID.

Parameters:

Name	Type	Description	Default
id_caixa	int	ID do lançamento (Bling: idCaixa, integer, obrigatório)	required
lancamento	CaixasBancosSalvarLancamentoDTO	Dados do lançamento para atualização. Request body schema: CaixasBancosSalvarLancamentoDTO	required

Returns:

Type	Description
CaixasBancosSalvarLancamentoResponseDTO	Bling API response. Response schemas: 200: CaixasBancosSalvarLancamentoResponseDTO; 400: ErrorResponse; 404: ErrorResponse

Source code in src/bling_erp_api/resources/caixas_bancos.py

def alterar(
    self,
    id_caixa: int,
    lancamento: CaixasBancosSalvarLancamentoDTO,
) -> CaixasBancosSalvarLancamentoResponseDTO:
    """Altera um lançamento de caixa e banco.

    Endpoint: PUT /caixas/{idCaixa}

    Altera um lançamento pelo ID.

    Args:
        id_caixa: ID do lançamento (Bling: ``idCaixa``, integer, obrigatório)
        lancamento: Dados do lançamento para atualização. Request body schema: CaixasBancosSalvarLancamentoDTO

    Returns:
        Bling API response. Response schemas: 200: CaixasBancosSalvarLancamentoResponseDTO; 400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._put(f"/caixas/{id_caixa}", json=to_json_object(lancamento))
    return self._validate_response(CaixasBancosSalvarLancamentoResponseDTO, raw)

remover

remover(id_caixa: int) -> JsonObject

Remove um lançamento de caixa e banco.

Endpoint: DELETE /caixas/{idCaixa}

Remove um lançamento pelo ID.

Parameters:

Name	Type	Description	Default
id_caixa	int	ID do lançamento (Bling: idCaixa, 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/caixas_bancos.py

def remover(self, id_caixa: int) -> JsonObject:
    """Remove um lançamento de caixa e banco.

    Endpoint: DELETE /caixas/{idCaixa}

    Remove um lançamento pelo ID.

    Args:
        id_caixa: ID do lançamento (Bling: ``idCaixa``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse
    """
    return self._delete(f"/caixas/{id_caixa}")