Contas Financeiras

bling_erp_api.resources.contas_contabeis.ContasContabeisResource

ContasContabeisResource(transport: Transport)

Bases: BaseResource

Operações de contas financeiras do Bling.

Este recurso mapeia os endpoints /contas-contabeis. 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,
    limite: int = 100,
    ocultar_invisiveis: bool | None = None,
    ocultar_tipo_conta_bancaria: bool | None = None,
    situacoes: list[int] | None = None,
    alias_integracao: str | None = None,
    ordenacao: str | None = None,
) -> ContasContabeisGetResponse200

Lista contas financeiras.

Endpoint: GET /contas-contabeis

Obtém lista paginada de contas financeiras.

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`
`ocultar_invisiveis`	`bool \| None`	Oculta contas invisíveis (Bling: `ocultarInvisiveis`, boolean, opcional)	`None`
`ocultar_tipo_conta_bancaria`	`bool \| None`	Oculta contas bancárias (Bling: `ocultarTipoContaBancaria`, boolean, opcional)	`None`
`situacoes`	`list[int] \| None`	1=Ativo, 2=Inativo, 3=Pendente, 4=Cancelada (Bling: `situacoes`, array, opcional)	`None`
`alias_integracao`	`str \| None`	Alias da integração (Bling: `aliasIntegracao`, string, opcional)	`None`
`ordenacao`	`str \| None`	Ordenação: descricao ou -descricao (Bling: `ordenacao`, string, opcional)	`None`

Returns:

Type	Description
`ContasContabeisGetResponse200`	Bling API response. Response schemas: 200: ContasContabeisDadosDTO

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

def listar(  # noqa: PLR0913
    self,
    *,
    pagina: int = 1,
    limite: int = 100,
    ocultar_invisiveis: bool | None = None,
    ocultar_tipo_conta_bancaria: bool | None = None,
    situacoes: list[int] | None = None,
    alias_integracao: str | None = None,
    ordenacao: str | None = None,
) -> ContasContabeisGetResponse200:
    """Lista contas financeiras.

    Endpoint: GET /contas-contabeis

    Obtém lista paginada de contas financeiras.

    Args:
        pagina: N° da página (Bling: ``pagina``, integer, opcional)
        limite: Registros por página (Bling: ``limite``, integer, opcional)
        ocultar_invisiveis: Oculta contas invisíveis (Bling: ``ocultarInvisiveis``, boolean, opcional)
        ocultar_tipo_conta_bancaria: Oculta contas bancárias (Bling: ``ocultarTipoContaBancaria``, boolean, opcional)
        situacoes: 1=Ativo, 2=Inativo, 3=Pendente, 4=Cancelada (Bling: ``situacoes``, array, opcional)
        alias_integracao: Alias da integração (Bling: ``aliasIntegracao``, string, opcional)
        ordenacao: Ordenação: descricao ou -descricao (Bling: ``ordenacao``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: ContasContabeisDadosDTO
    """
    params: QueryParams = {
        "pagina": pagina,
        "limite": limite,
        **_contas_contabeis_list_params(
            ocultar_invisiveis=ocultar_invisiveis,
            ocultar_tipo_conta_bancaria=ocultar_tipo_conta_bancaria,
            situacoes=situacoes,
            alias_integracao=alias_integracao,
            ordenacao=ordenacao,
        ),
    }
    raw = self._get("/contas-contabeis", params=params)
    return self._validate_response(ContasContabeisGetResponse200, raw)

obter

obter(id_conta_contabil: int) -> ContasContabeisIdContaContabilGetResponse200

Obtém uma conta financeira.

Endpoint: GET /contas-contabeis/{idContaContabil}

Obtém uma conta financeira pelo ID.

Parameters:

Name	Type	Description	Default
`id_conta_contabil`	`int`	ID da conta financeira (Bling: `idContaContabil`, integer, obrigatório)	required

Returns:

Type	Description
`ContasContabeisIdContaContabilGetResponse200`	Bling API response. Response schemas: 200: ContasContabeisDadosDTO; 404: ErrorResponse

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

def obter(self, id_conta_contabil: int) -> ContasContabeisIdContaContabilGetResponse200:
    """Obtém uma conta financeira.

    Endpoint: GET /contas-contabeis/{idContaContabil}

    Obtém uma conta financeira pelo ID.

    Args:
        id_conta_contabil: ID da conta financeira (Bling: ``idContaContabil``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: ContasContabeisDadosDTO; 404: ErrorResponse
    """
    raw = self._get(f"/contas-contabeis/{id_conta_contabil}")
    return self._validate_response(ContasContabeisIdContaContabilGetResponse200, raw)