Depósitos

bling_erp_api.resources.depositos.DepositosResource

DepositosResource(transport: Transport)

Bases: BaseResource

Operações de depósitos do Bling.

Este recurso mapeia os endpoints /depositos. 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,
    descricao: str | None = None,
    situacao: int | None = None,
) -> DepositosGetResponse200

Lista depósitos.

Endpoint: GET /depositos

Lista os depósitos cadastrados.

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
descricao	str | None	Descrição do depósito (Bling: descricao, string, opcional)	None
situacao	int | None	0=Inativo, 1=Ativo (Bling: situacao, integer, opcional)	None

Returns:

Type	Description
DepositosGetResponse200	Bling API response. Response schemas: 200: DepositosDadosDTO

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

def listar(
    self,
    *,
    pagina: int = 1,
    limite: int = 100,
    descricao: str | None = None,
    situacao: int | None = None,
) -> DepositosGetResponse200:
    """Lista depósitos.

    Endpoint: GET /depositos

    Lista os depósitos cadastrados.

    Args:
        pagina: N° da página (Bling: ``pagina``, integer, opcional)
        limite: Registros por página (Bling: ``limite``, integer, opcional)
        descricao: Descrição do depósito (Bling: ``descricao``, string, opcional)
        situacao: 0=Inativo, 1=Ativo (Bling: ``situacao``, integer, opcional)

    Returns:
        Bling API response. Response schemas: 200: DepositosDadosDTO
    """
    params: QueryParams = {
        "pagina": pagina,
        "limite": limite,
        **_depositos_list_params(descricao=descricao, situacao=situacao),
    }
    raw = self._get("/depositos", params=params)
    return self._validate_response(DepositosGetResponse200, raw)

obter

obter(id_deposito: int) -> DepositosIdDepositoGetResponse200

Obtém um depósito.

Endpoint: GET /depositos/{idDeposito}

Obtém um depósito pelo ID.

Parameters:

Name	Type	Description	Default
id_deposito	int	ID do depósito (Bling: idDeposito, integer, obrigatório)	required

Returns:

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

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

def obter(self, id_deposito: int) -> DepositosIdDepositoGetResponse200:
    """Obtém um depósito.

    Endpoint: GET /depositos/{idDeposito}

    Obtém um depósito pelo ID.

    Args:
        id_deposito: ID do depósito (Bling: ``idDeposito``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: DepositosDadosDTO; 404: ErrorResponse
    """
    raw = self._get(f"/depositos/{id_deposito}")
    return self._validate_response(DepositosIdDepositoGetResponse200, raw)

criar

criar(dados: DepositosDadosDTO) -> DepositosPostResponse201

Cria um depósito.

Endpoint: POST /depositos

Cria um novo depósito.

Parameters:

Name	Type	Description	Default
dados	DepositosDadosDTO	Dados do depósito (Bling: request body, DepositosDadosDTO)	required

Returns:

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

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

def criar(self, dados: DepositosDadosDTO) -> DepositosPostResponse201:
    """Cria um depósito.

    Endpoint: POST /depositos

    Cria um novo depósito.

    Args:
        dados: Dados do depósito (Bling: request body, ``DepositosDadosDTO``)

    Returns:
        Bling API response. Response schemas: 201: BasePostResponse; 400: ErrorResponse
    """
    raw = self._post("/depositos", json=to_json_object(dados))
    return self._validate_response(DepositosPostResponse201, raw)

alterar

alterar(
    id_deposito: int, dados: DepositosDadosDTO
) -> DepositosIdDepositoPutResponse200

Altera um depósito.

Endpoint: PUT /depositos/{idDeposito}

Altera um depósito existente.

Parameters:

Name	Type	Description	Default
id_deposito	int	ID do depósito (Bling: idDeposito, integer, obrigatório)	required
dados	DepositosDadosDTO	Dados do depósito para atualização (Bling: request body, DepositosDadosDTO)	required

Returns:

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

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

def alterar(
    self, id_deposito: int, dados: DepositosDadosDTO
) -> DepositosIdDepositoPutResponse200:
    """Altera um depósito.

    Endpoint: PUT /depositos/{idDeposito}

    Altera um depósito existente.

    Args:
        id_deposito: ID do depósito (Bling: ``idDeposito``, integer, obrigatório)
        dados: Dados do depósito para atualização (Bling: request body, ``DepositosDadosDTO``)

    Returns:
        Bling API response. Response schemas: 200: DepositosIdDepositoPutResponse200; 400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._put(f"/depositos/{id_deposito}", json=to_json_object(dados))
    return self._validate_response(DepositosIdDepositoPutResponse200, raw)