Situações

bling_erp_api.resources.situacoes.SituacoesResource

SituacoesResource(transport: Transport)

Bases: BaseResource

Situacoes API resource. Maps to /situacoes endpoints.

Provides CRUD operations for situations (situacoes) in the Bling API. Canonical methods are in pt-BR following the official Bling documentation; English aliases are available for compatibility.

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

criar

criar(dados: SituacoesPostRequest) -> SituacoesPostResponse201

Cria uma nova situação.

Endpoint: POST /situacoes

Cria uma nova situação no sistema.

Parameters:

Name	Type	Description	Default
dados	SituacoesPostRequest	Dados da situação. Use SituacoesPostRequest para uso tipado ou um objeto JSON com os nomes de campos do Bling.	required

Returns:

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

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

def criar(self, dados: SituacoesPostRequest) -> SituacoesPostResponse201:
    """Cria uma nova situação.

    Endpoint: POST /situacoes

    Cria uma nova situação no sistema.

    Args:
        dados: Dados da situação. Use ``SituacoesPostRequest`` para uso tipado
            ou um objeto JSON com os nomes de campos do Bling.

    Returns:
        Bling API response. Response schemas: 201: SituacoesPostResponse201;
        400: ErrorResponse
    """
    raw = self._post(self.BASE_PATH, json=to_json_object(dados))
    return SituacoesPostResponse201.model_validate(raw)

obter

obter(id_situacao: int) -> SituacoesIdSituacaoGetResponse200

Obtém uma situação pelo ID.

Endpoint: GET /situacoes/{idSituacao}

Obtém uma situação pelo ID.

Parameters:

Name	Type	Description	Default
id_situacao	int	ID da situação (Bling: idSituacao, integer, obrigatório)	required

Returns:

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

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

def obter(self, id_situacao: int) -> SituacoesIdSituacaoGetResponse200:
    """Obtém uma situação pelo ID.

    Endpoint: GET /situacoes/{idSituacao}

    Obtém uma situação pelo ID.

    Args:
        id_situacao: ID da situação (Bling: ``idSituacao``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesIdSituacaoGetResponse200;
        404: ErrorResponse
    """
    raw = self._get(f"{self.BASE_PATH}/{id_situacao}")
    try:
        return SituacoesIdSituacaoGetResponse200.model_validate(raw)
    except ValidationError:
        if raw == {"data": []}:
            return SituacoesIdSituacaoGetResponse200(data=None)
        raise

alterar

alterar(
    id_situacao: int, dados: SituacoesIdSituacaoPutRequest
) -> SituacoesIdSituacaoPutResponse200

Altera uma situação.

Endpoint: PUT /situacoes/{idSituacao}

Altera uma situação pelo ID.

Parameters:

Name	Type	Description	Default
id_situacao	int	ID da situação (Bling: idSituacao, integer, obrigatório)	required
dados	SituacoesIdSituacaoPutRequest	Dados atualizados da situação. Use SituacoesIdSituacaoPutRequest para uso tipado ou um objeto JSON com os nomes de campos do Bling.	required

Returns:

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

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

def alterar(
    self, id_situacao: int, dados: SituacoesIdSituacaoPutRequest
) -> SituacoesIdSituacaoPutResponse200:
    """Altera uma situação.

    Endpoint: PUT /situacoes/{idSituacao}

    Altera uma situação pelo ID.

    Args:
        id_situacao: ID da situação (Bling: ``idSituacao``, integer, obrigatório)
        dados: Dados atualizados da situação. Use ``SituacoesIdSituacaoPutRequest``
            para uso tipado ou um objeto JSON com os nomes de campos do Bling.

    Returns:
        Bling API response. Response schemas: 200: SituacoesIdSituacaoPutResponse200;
        400: ErrorResponse; 404: ErrorResponse
    """
    raw = self._put(f"{self.BASE_PATH}/{id_situacao}", json=to_json_object(dados))
    return SituacoesIdSituacaoPutResponse200.model_validate(raw)

remover

remover(id_situacao: int) -> JsonObject

Remove uma situação.

Endpoint: DELETE /situacoes/{idSituacao}

Remove uma situação pelo ID.

Parameters:

Name	Type	Description	Default
id_situacao	int	ID da situação (Bling: idSituacao, integer, obrigatório)	required

Returns:

Name	Type	Description
	JsonObject	Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse;
404	JsonObject	ErrorResponse

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

def remover(self, id_situacao: int) -> JsonObject:
    """Remove uma situação.

    Endpoint: DELETE /situacoes/{idSituacao}

    Remove uma situação pelo ID.

    Args:
        id_situacao: ID da situação (Bling: ``idSituacao``, integer, obrigatório)

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

create

create(data: SituacoesPostRequest) -> SituacoesPostResponse201

Compatibility alias for criar().

Cria uma nova situação.

Endpoint: POST /situacoes

Parameters:

Name	Type	Description	Default
data	SituacoesPostRequest	Dados da situação. Use SituacoesPostRequest para uso tipado ou um objeto JSON com os nomes de campos do Bling.	required

Returns:

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

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

def create(self, data: SituacoesPostRequest) -> SituacoesPostResponse201:
    """Compatibility alias for ``criar()``.

    Cria uma nova situação.

    Endpoint: POST /situacoes

    Args:
        data: Dados da situação. Use ``SituacoesPostRequest`` para uso tipado
            ou um objeto JSON com os nomes de campos do Bling.

    Returns:
        Bling API response. Response schemas: 201: SituacoesPostResponse201;
        400: ErrorResponse
    """
    return self.criar(dados=data)

get

get(situation_id: int) -> SituacoesIdSituacaoGetResponse200

Compatibility alias for obter().

Obtém uma situação pelo ID.

Endpoint: GET /situacoes/{idSituacao}

Parameters:

Name	Type	Description	Default
situation_id	int	ID da situação (Bling: idSituacao, integer, obrigatório)	required

Returns:

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

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

def get(self, situation_id: int) -> SituacoesIdSituacaoGetResponse200:
    """Compatibility alias for ``obter()``.

    Obtém uma situação pelo ID.

    Endpoint: GET /situacoes/{idSituacao}

    Args:
        situation_id: ID da situação (Bling: ``idSituacao``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesIdSituacaoGetResponse200;
        404: ErrorResponse
    """
    return self.obter(id_situacao=situation_id)

update

update(
    situation_id: int, data: SituacoesIdSituacaoPutRequest
) -> SituacoesIdSituacaoPutResponse200

Compatibility alias for alterar().

Altera uma situação.

Endpoint: PUT /situacoes/{idSituacao}

Parameters:

Name	Type	Description	Default
situation_id	int	ID da situação (Bling: idSituacao, integer, obrigatório)	required
data	SituacoesIdSituacaoPutRequest	Dados atualizados da situação. Use SituacoesIdSituacaoPutRequest para uso tipado ou um objeto JSON com os nomes de campos do Bling.	required

Returns:

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

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

def update(
    self, situation_id: int, data: SituacoesIdSituacaoPutRequest
) -> SituacoesIdSituacaoPutResponse200:
    """Compatibility alias for ``alterar()``.

    Altera uma situação.

    Endpoint: PUT /situacoes/{idSituacao}

    Args:
        situation_id: ID da situação (Bling: ``idSituacao``, integer, obrigatório)
        data: Dados atualizados da situação. Use ``SituacoesIdSituacaoPutRequest``
            para uso tipado ou um objeto JSON com os nomes de campos do Bling.

    Returns:
        Bling API response. Response schemas: 200: SituacoesIdSituacaoPutResponse200;
        400: ErrorResponse; 404: ErrorResponse
    """
    return self.alterar(id_situacao=situation_id, dados=data)

delete

delete(situation_id: int) -> JsonObject

Compatibility alias for remover().

Remove uma situação.

Endpoint: DELETE /situacoes/{idSituacao}

Parameters:

Name	Type	Description	Default
situation_id	int	ID da situação (Bling: idSituacao, integer, obrigatório)	required

Returns:

Name	Type	Description
	JsonObject	Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse;
404	JsonObject	ErrorResponse

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

def delete(self, situation_id: int) -> JsonObject:
    """Compatibility alias for ``remover()``.

    Remove uma situação.

    Endpoint: DELETE /situacoes/{idSituacao}

    Args:
        situation_id: ID da situação (Bling: ``idSituacao``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse;
        404: ErrorResponse
    """
    return self.remover(id_situacao=situation_id)