Skip to content

Borderôs

bling_erp_api.resources.borderos.BorderosResource

BorderosResource(transport: Transport)

Bases: BaseResource

Operações de borderôs do Bling.

Este recurso mapeia os endpoints /borderos. Métodos canônicos em pt-BR; aliases em inglês disponíveis para 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

obter

obter(id_bordero: int) -> BorderosIdBorderoGetResponse200

Obtém um borderô.

Endpoint: GET /borderos/{idBordero}

Obtém os detalhes de um borderô pelo ID.

Parameters:

Name Type Description Default
id_bordero int

ID do borderô (Bling: idBordero, integer, obrigatório)

required

Returns:

Type Description
BorderosIdBorderoGetResponse200

Bling API response. Response schemas: 200: BorderosDadosDTO; 404: ErrorResponse

Source code in src/bling_erp_api/resources/borderos.py
def obter(self, id_bordero: int) -> BorderosIdBorderoGetResponse200:
    """Obtém um borderô.

    Endpoint: GET /borderos/{idBordero}

    Obtém os detalhes de um borderô pelo ID.

    Args:
        id_bordero: ID do borderô (Bling: ``idBordero``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: BorderosDadosDTO; 404: ErrorResponse
    """
    raw = self._get(f"/borderos/{id_bordero}")
    return self._validate_response(BorderosIdBorderoGetResponse200, raw)

remover

remover(id_bordero: int) -> JsonObject

Remove um borderô.

Endpoint: DELETE /borderos/{idBordero}

Remove um borderô pelo ID.

Parameters:

Name Type Description Default
id_bordero int

ID do borderô (Bling: idBordero, 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/borderos.py
def remover(self, id_bordero: int) -> JsonObject:
    """Remove um borderô.

    Endpoint: DELETE /borderos/{idBordero}

    Remove um borderô pelo ID.

    Args:
        id_bordero: ID do borderô (Bling: ``idBordero``, integer, obrigatório)

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