Skip to content

Módulos de Situações

bling_erp_api.resources.situacoes_modulos.SituacoesModulosResource 

SituacoesModulosResource(transport: Transport)

Bases: BaseResource

Situacoes Modulos API resource. Maps to /situacoes/modulos endpoints.

Provides operations for situation modules (modulos 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

listar 

listar() -> SituacoesModulosGetResponse200

Lista todos os módulos de situações.

Endpoint: GET /situacoes/modulos

Lista todos os módulos de situações disponíveis no sistema.

Returns:

Type Description
SituacoesModulosGetResponse200

Bling API response. Response schemas: 200: SituacoesModulosGetResponse200
Source code in src/bling_erp_api/resources/situacoes_modulos.py 
28
29
30
31
32
33
34
35
36
37
38
39
def listar(self) -> SituacoesModulosGetResponse200:
    """Lista todos os módulos de situações.

    Endpoint: GET /situacoes/modulos

    Lista todos os módulos de situações disponíveis no sistema.

    Returns:
        Bling API response. Response schemas: 200: SituacoesModulosGetResponse200
    """
    raw = self._get(self.BASE_PATH)
    return SituacoesModulosGetResponse200.model_validate(raw)

obter 

obter(id_modulo_sistema: int) -> SituacoesModulosIdModuloSistemaGetResponse200

Obtém as situações de um módulo específico.

Endpoint: GET /situacoes/modulos/{idModuloSistema}

Obtém as situações de um módulo específico pelo ID.

Parameters:

Name Type Description Default
id_modulo_sistema int

ID do módulo do sistema (Bling: idModuloSistema, integer, obrigatório)

 required

Returns:

Name Type Description
SituacoesModulosIdModuloSistemaGetResponse200

Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaGetResponse200;
404 SituacoesModulosIdModuloSistemaGetResponse200

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_modulos.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def obter(self, id_modulo_sistema: int) -> SituacoesModulosIdModuloSistemaGetResponse200:
    """Obtém as situações de um módulo específico.

    Endpoint: GET /situacoes/modulos/{idModuloSistema}

    Obtém as situações de um módulo específico pelo ID.

    Args:
        id_modulo_sistema: ID do módulo do sistema
            (Bling: ``idModuloSistema``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaGetResponse200;
        404: ErrorResponse
    """
    raw = self._get(f"{self.BASE_PATH}/{id_modulo_sistema}")
    return SituacoesModulosIdModuloSistemaGetResponse200.model_validate(raw)

listar_acoes 

listar_acoes(
    id_modulo_sistema: int,
) -> SituacoesModulosIdModuloSistemaAcoesGetResponse200

Lista as ações disponíveis para um módulo.

Endpoint: GET /situacoes/modulos/{idModuloSistema}/acoes

Lista as ações disponíveis para um módulo de situação específico.

Parameters:

Name Type Description Default
id_modulo_sistema int

ID do módulo do sistema (Bling: idModuloSistema, integer, obrigatório)

 required

Returns:

Name Type Description
SituacoesModulosIdModuloSistemaAcoesGetResponse200

Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaAcoesGetResponse200;
404 SituacoesModulosIdModuloSistemaAcoesGetResponse200

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_modulos.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def listar_acoes(
    self, id_modulo_sistema: int
) -> SituacoesModulosIdModuloSistemaAcoesGetResponse200:
    """Lista as ações disponíveis para um módulo.

    Endpoint: GET /situacoes/modulos/{idModuloSistema}/acoes

    Lista as ações disponíveis para um módulo de situação específico.

    Args:
        id_modulo_sistema: ID do módulo do sistema
            (Bling: ``idModuloSistema``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaAcoesGetResponse200;
        404: ErrorResponse
    """
    raw = self._get(f"{self.BASE_PATH}/{id_modulo_sistema}/acoes")
    return SituacoesModulosIdModuloSistemaAcoesGetResponse200.model_validate(raw)

listar_transicoes 

listar_transicoes(
    id_modulo_sistema: int,
) -> SituacoesModulosIdModuloSistemaTransicoesGetResponse200

Lista as transições de um módulo.

Endpoint: GET /situacoes/modulos/{idModuloSistema}/transicoes

Lista as transições disponíveis para um módulo de situação específico.

Parameters:

Name Type Description Default
id_modulo_sistema int

ID do módulo do sistema (Bling: idModuloSistema, integer, obrigatório)

 required

Returns:

Name Type Description
SituacoesModulosIdModuloSistemaTransicoesGetResponse200

Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaTransicoesGetResponse200;
404 SituacoesModulosIdModuloSistemaTransicoesGetResponse200

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_modulos.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
def listar_transicoes(
    self, id_modulo_sistema: int
) -> SituacoesModulosIdModuloSistemaTransicoesGetResponse200:
    """Lista as transições de um módulo.

    Endpoint: GET /situacoes/modulos/{idModuloSistema}/transicoes

    Lista as transições disponíveis para um módulo de situação específico.

    Args:
        id_modulo_sistema: ID do módulo do sistema
            (Bling: ``idModuloSistema``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaTransicoesGetResponse200;
        404: ErrorResponse
    """
    raw = self._get(f"{self.BASE_PATH}/{id_modulo_sistema}/transicoes")
    return SituacoesModulosIdModuloSistemaTransicoesGetResponse200.model_validate(raw)

list 

list() -> SituacoesModulosGetResponse200

Compatibility alias for listar().

Lista todos os módulos de situações.

Endpoint: GET /situacoes/modulos

Returns:

Type Description
SituacoesModulosGetResponse200

Bling API response. Response schemas: 200: SituacoesModulosGetResponse200
Source code in src/bling_erp_api/resources/situacoes_modulos.py 
41
42
43
44
45
46
47
48
49
50
51
def list(self) -> SituacoesModulosGetResponse200:
    """Compatibility alias for ``listar()``.

    Lista todos os módulos de situações.

    Endpoint: GET /situacoes/modulos

    Returns:
        Bling API response. Response schemas: 200: SituacoesModulosGetResponse200
    """
    return self.listar()

get 

get(module_id: int) -> SituacoesModulosIdModuloSistemaGetResponse200

Compatibility alias for obter().

Obtém as situações de um módulo específico.

Endpoint: GET /situacoes/modulos/{idModuloSistema}

Parameters:

Name Type Description Default
module_id int

ID do módulo do sistema (Bling: idModuloSistema, integer, obrigatório)

 required

Returns:

Name Type Description
SituacoesModulosIdModuloSistemaGetResponse200

Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaGetResponse200;
404 SituacoesModulosIdModuloSistemaGetResponse200

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_modulos.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def get(self, module_id: int) -> SituacoesModulosIdModuloSistemaGetResponse200:
    """Compatibility alias for ``obter()``.

    Obtém as situações de um módulo específico.

    Endpoint: GET /situacoes/modulos/{idModuloSistema}

    Args:
        module_id: ID do módulo do sistema
            (Bling: ``idModuloSistema``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaGetResponse200;
        404: ErrorResponse
    """
    return self.obter(id_modulo_sistema=module_id)

list_actions 

list_actions(
    module_id: int,
) -> SituacoesModulosIdModuloSistemaAcoesGetResponse200

Compatibility alias for listar_acoes().

Lista as ações disponíveis para um módulo.

Endpoint: GET /situacoes/modulos/{idModuloSistema}/acoes

Parameters:

Name Type Description Default
module_id int

ID do módulo do sistema (Bling: idModuloSistema, integer, obrigatório)

 required

Returns:

Name Type Description
SituacoesModulosIdModuloSistemaAcoesGetResponse200

Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaAcoesGetResponse200;
404 SituacoesModulosIdModuloSistemaAcoesGetResponse200

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_modulos.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def list_actions(self, module_id: int) -> SituacoesModulosIdModuloSistemaAcoesGetResponse200:
    """Compatibility alias for ``listar_acoes()``.

    Lista as ações disponíveis para um módulo.

    Endpoint: GET /situacoes/modulos/{idModuloSistema}/acoes

    Args:
        module_id: ID do módulo do sistema
            (Bling: ``idModuloSistema``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaAcoesGetResponse200;
        404: ErrorResponse
    """
    return self.listar_acoes(id_modulo_sistema=module_id)

list_transitions 

list_transitions(
    module_id: int,
) -> SituacoesModulosIdModuloSistemaTransicoesGetResponse200

Compatibility alias for listar_transicoes().

Lista as transições de um módulo.

Endpoint: GET /situacoes/modulos/{idModuloSistema}/transicoes

Parameters:

Name Type Description Default
module_id int

ID do módulo do sistema (Bling: idModuloSistema, integer, obrigatório)

 required

Returns:

Name Type Description
SituacoesModulosIdModuloSistemaTransicoesGetResponse200

Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaTransicoesGetResponse200;
404 SituacoesModulosIdModuloSistemaTransicoesGetResponse200

ErrorResponse
Source code in src/bling_erp_api/resources/situacoes_modulos.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def list_transitions(
    self, module_id: int
) -> SituacoesModulosIdModuloSistemaTransicoesGetResponse200:
    """Compatibility alias for ``listar_transicoes()``.

    Lista as transições de um módulo.

    Endpoint: GET /situacoes/modulos/{idModuloSistema}/transicoes

    Args:
        module_id: ID do módulo do sistema
            (Bling: ``idModuloSistema``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: SituacoesModulosIdModuloSistemaTransicoesGetResponse200;
        404: ErrorResponse
    """
    return self.listar_transicoes(id_modulo_sistema=module_id)