Skip to content

Transições de Situações

bling_erp_api.resources.situacoes_transicoes.SituacoesTransicoesResource 

SituacoesTransicoesResource(transport: Transport)

Bases: BaseResource

Situacoes Transicoes API resource. Maps to /situacoes/transicoes endpoints.

Provides CRUD operations for situation transitions (transicoes de 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 
141
142
143
def __init__(self, transport: Transport) -> None:
    """Create a resource bound to a transport."""
    self._transport = transport

criar 

criar(dados: Any) -> JsonObject

Cria uma nova transição de situação.

Endpoint: POST /situacoes/transicoes

Cria uma nova transição de situação no sistema.

Parameters:

Name Type Description Default
dados Any

Dados da transição. Use SituacoesTransicoesPostRequest para uso tipado ou um objeto JSON com os nomes de campos do Bling.

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 201: SituacoesTransicoesPostResponse201;
400 JsonObject

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_transicoes.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def criar(self, dados: Any) -> JsonObject:
    """Cria uma nova transição de situação.

    Endpoint: POST /situacoes/transicoes

    Cria uma nova transição de situação no sistema.

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

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

obter 

obter(id_transicao: int) -> JsonObject

Obtém uma transição pelo ID.

Endpoint: GET /situacoes/transicoes/{idTransicao}

Obtém uma transição de situação pelo ID.

Parameters:

Name Type Description Default
id_transicao int

ID da transição (Bling: idTransicao, integer, obrigatório)

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: SituacoesTransicoesIdTransicaoGetResponse200;
404 JsonObject

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_transicoes.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def obter(self, id_transicao: int) -> JsonObject:
    """Obtém uma transição pelo ID.

    Endpoint: GET /situacoes/transicoes/{idTransicao}

    Obtém uma transição de situação pelo ID.

    Args:
        id_transicao: ID da transição (Bling: ``idTransicao``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesTransicoesIdTransicaoGetResponse200;
        404: ErrorResponse
    """
    return self._get(f"{self.BASE_PATH}/{id_transicao}")

alterar 

alterar(id_transicao: int, dados: Any) -> JsonObject

Altera uma transição.

Endpoint: PUT /situacoes/transicoes/{idTransicao}

Altera uma transição de situação pelo ID.

Parameters:

Name Type Description Default
id_transicao int

ID da transição (Bling: idTransicao, integer, obrigatório)

 required
dados Any

Dados atualizados da transição. Use SituacoesTransicoesIdTransicaoPutRequest para uso tipado ou um objeto JSON com os nomes de campos do Bling.

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: SituacoesTransicoesIdTransicaoPutResponse200;
400 JsonObject

ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_transicoes.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
def alterar(self, id_transicao: int, dados: Any) -> JsonObject:
    """Altera uma transição.

    Endpoint: PUT /situacoes/transicoes/{idTransicao}

    Altera uma transição de situação pelo ID.

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

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

remover 

remover(id_transicao: int) -> JsonObject

Remove uma transição.

Endpoint: DELETE /situacoes/transicoes/{idTransicao}

Remove uma transição de situação pelo ID.

Parameters:

Name Type Description Default
id_transicao int

ID da transição (Bling: idTransicao, 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_transicoes.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
def remover(self, id_transicao: int) -> JsonObject:
    """Remove uma transição.

    Endpoint: DELETE /situacoes/transicoes/{idTransicao}

    Remove uma transição de situação pelo ID.

    Args:
        id_transicao: ID da transição (Bling: ``idTransicao``, integer, obrigatório)

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

create 

create(data: Any) -> JsonObject

Compatibility alias for criar().

Cria uma nova transição de situação.

Endpoint: POST /situacoes/transicoes

Parameters:

Name Type Description Default
data Any

Dados da transição. Use SituacoesTransicoesPostRequest para uso tipado ou um objeto JSON com os nomes de campos do Bling.

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 201: SituacoesTransicoesPostResponse201;
400 JsonObject

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_transicoes.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def create(self, data: Any) -> JsonObject:
    """Compatibility alias for ``criar()``.

    Cria uma nova transição de situação.

    Endpoint: POST /situacoes/transicoes

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

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

get 

get(transition_id: int) -> JsonObject

Compatibility alias for obter().

Obtém uma transição pelo ID.

Endpoint: GET /situacoes/transicoes/{idTransicao}

Parameters:

Name Type Description Default
transition_id int

ID da transição (Bling: idTransicao, integer, obrigatório)

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: SituacoesTransicoesIdTransicaoGetResponse200;
404 JsonObject

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_transicoes.py 
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def get(self, transition_id: int) -> JsonObject:
    """Compatibility alias for ``obter()``.

    Obtém uma transição pelo ID.

    Endpoint: GET /situacoes/transicoes/{idTransicao}

    Args:
        transition_id: ID da transição (Bling: ``idTransicao``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesTransicoesIdTransicaoGetResponse200;
        404: ErrorResponse
    """
    return self.obter(id_transicao=transition_id)

update 

update(transition_id: int, data: Any) -> JsonObject

Compatibility alias for alterar().

Altera uma transição.

Endpoint: PUT /situacoes/transicoes/{idTransicao}

Parameters:

Name Type Description Default
transition_id int

ID da transição (Bling: idTransicao, integer, obrigatório)

 required
data Any

Dados atualizados da transição. Use SituacoesTransicoesIdTransicaoPutRequest para uso tipado ou um objeto JSON com os nomes de campos do Bling.

 required

Returns:

Name Type Description
JsonObject

Bling API response. Response schemas: 200: SituacoesTransicoesIdTransicaoPutResponse200;
400 JsonObject

ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_transicoes.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def update(self, transition_id: int, data: Any) -> JsonObject:
    """Compatibility alias for ``alterar()``.

    Altera uma transição.

    Endpoint: PUT /situacoes/transicoes/{idTransicao}

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

    Returns:
        Bling API response. Response schemas: 200: SituacoesTransicoesIdTransicaoPutResponse200;
        400: ErrorResponse; 404: ErrorResponse
    """
    return self.alterar(id_transicao=transition_id, dados=data)

delete 

delete(transition_id: int) -> JsonObject

Compatibility alias for remover().

Remove uma transição.

Endpoint: DELETE /situacoes/transicoes/{idTransicao}

Parameters:

Name Type Description Default
transition_id int

ID da transição (Bling: idTransicao, 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_transicoes.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def delete(self, transition_id: int) -> JsonObject:
    """Compatibility alias for ``remover()``.

    Remove uma transição.

    Endpoint: DELETE /situacoes/transicoes/{idTransicao}

    Args:
        transition_id: ID da transição (Bling: ``idTransicao``, integer, obrigatório)

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