Skip to content

Notificações

bling_erp_api.resources.notificacoes.NotificacoesResource 

NotificacoesResource(transport: Transport)

Bases: BaseResource

Notificações.

Endpoints mapeados: - GET /notificacoes - GET /notificacoes/quantidade - POST /notificacoes/{idNotificacao}/confirmar-leitura

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 
141
142
143
def __init__(self, transport: Transport) -> None:
    """Create a resource bound to a transport."""
    self._transport = transport

listar 

listar(*, periodo: str | None = None) -> NotificacoesGetResponse200

Lista notificações.

Endpoint: GET /notificacoes

Lista todas as notificações de uma empresa em um período.

Parameters:

Name Type Description Default
periodo str | None

Ano ou ano-mês (ex: "2025-01") (Bling: periodo, string, opcional)

 None

Returns:

Type Description
NotificacoesGetResponse200

Bling API response. Response schemas: 200: NotificacoesDadosDTO[]; 400: ErrorResponse
Source code in src/bling_erp_api/resources/notificacoes.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def listar(
    self,
    *,
    periodo: str | None = None,
) -> NotificacoesGetResponse200:
    """Lista notificações.

    Endpoint: GET /notificacoes

    Lista todas as notificações de uma empresa em um período.

    Args:
        periodo: Ano ou ano-mês (ex: "2025-01") (Bling: ``periodo``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: NotificacoesDadosDTO[]; 400: ErrorResponse
    """
    params = compact_params({"periodo": periodo})
    raw = self._get("/notificacoes", params=params)
    return self._validate_response(NotificacoesGetResponse200, raw)

obter_quantidade 

obter_quantidade(
    *, periodo: str | None = None
) -> NotificacoesQuantidadeGetResponse200

Obtém a quantidade de notificações.

Endpoint: GET /notificacoes/quantidade

Obtém a quantidade de notificações de uma empresa em um período.

Parameters:

Name Type Description Default
periodo str | None

Ano ou ano-mês (ex: "2025-01") (Bling: periodo, string, opcional)

 None

Returns:

Type Description
NotificacoesQuantidadeGetResponse200

Bling API response. Response schemas: 200: NotificacoesQuantidadeDTO; 400: ErrorResponse
Source code in src/bling_erp_api/resources/notificacoes.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def obter_quantidade(
    self,
    *,
    periodo: str | None = None,
) -> NotificacoesQuantidadeGetResponse200:
    """Obtém a quantidade de notificações.

    Endpoint: GET /notificacoes/quantidade

    Obtém a quantidade de notificações de uma empresa em um período.

    Args:
        periodo: Ano ou ano-mês (ex: "2025-01") (Bling: ``periodo``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: NotificacoesQuantidadeDTO; 400: ErrorResponse
    """
    params = compact_params({"periodo": periodo})
    raw = self._get("/notificacoes/quantidade", params=params)
    return self._validate_response(NotificacoesQuantidadeGetResponse200, raw)

alterar 

alterar(
    id_notificacao: str,
) -> NotificacoesIdNotificacaoConfirmarLeituraPostResponse200

Deprecated compatibility alias for confirmar_leitura().

Marca notificação como lida.

Endpoint: POST /notificacoes/{idNotificacao}/confirmar-leitura

Parameters:

Name Type Description Default
id_notificacao str

ULID da notificação (Bling: idNotificacao, string, obrigatório)

 required

Returns:

Type Description
NotificacoesIdNotificacaoConfirmarLeituraPostResponse200

Bling API response. Response schemas: 200: NotificacoesDadosDTO[]; 400: ErrorResponse
Source code in src/bling_erp_api/resources/notificacoes.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
def alterar(
    self,
    id_notificacao: str,
) -> NotificacoesIdNotificacaoConfirmarLeituraPostResponse200:
    """Deprecated compatibility alias for ``confirmar_leitura()``.

    Marca notificação como lida.

    Endpoint: POST /notificacoes/{idNotificacao}/confirmar-leitura

    Args:
        id_notificacao: ULID da notificação (Bling: ``idNotificacao``, string, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: NotificacoesDadosDTO[]; 400: ErrorResponse
    """
    return self.confirmar_leitura(id_notificacao=id_notificacao)

list 

list(*, period: str | None = None) -> NotificacoesGetResponse200

Compatibility alias for listar().

Lista notificações.

Endpoint: GET /notificacoes

Parameters:

Name Type Description Default
period str | None

Ano ou ano-mês (ex: "2025-01") (Bling: periodo, string, opcional)

 None

Returns:

Type Description
NotificacoesGetResponse200

Bling API response. Response schemas: 200: NotificacoesDadosDTO[]; 400: ErrorResponse
Source code in src/bling_erp_api/resources/notificacoes.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def list(
    self,
    *,
    period: str | None = None,
) -> NotificacoesGetResponse200:
    """Compatibility alias for ``listar()``.

    Lista notificações.

    Endpoint: GET /notificacoes

    Args:
        period: Ano ou ano-mês (ex: "2025-01") (Bling: ``periodo``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: NotificacoesDadosDTO[]; 400: ErrorResponse
    """
    return self.listar(periodo=period)

get_count 

get_count(*, period: str | None = None) -> NotificacoesQuantidadeGetResponse200

Compatibility alias for obter_quantidade().

Obtém a quantidade de notificações.

Endpoint: GET /notificacoes/quantidade

Parameters:

Name Type Description Default
period str | None

Ano ou ano-mês (ex: "2025-01") (Bling: periodo, string, opcional)

 None

Returns:

Type Description
NotificacoesQuantidadeGetResponse200

Bling API response. Response schemas: 200: NotificacoesQuantidadeDTO; 400: ErrorResponse
Source code in src/bling_erp_api/resources/notificacoes.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def get_count(
    self,
    *,
    period: str | None = None,
) -> NotificacoesQuantidadeGetResponse200:
    """Compatibility alias for ``obter_quantidade()``.

    Obtém a quantidade de notificações.

    Endpoint: GET /notificacoes/quantidade

    Args:
        period: Ano ou ano-mês (ex: "2025-01") (Bling: ``periodo``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: NotificacoesQuantidadeDTO; 400: ErrorResponse
    """
    return self.obter_quantidade(periodo=period)

mark_as_read 

mark_as_read(
    notification_id: str,
) -> NotificacoesIdNotificacaoConfirmarLeituraPostResponse200

Compatibility alias for confirmar_leitura().

Marca notificação como lida.

Endpoint: POST /notificacoes/{idNotificacao}/confirmar-leitura

Parameters:

Name Type Description Default
notification_id str

ULID da notificação (Bling: idNotificacao, string, obrigatório)

 required

Returns:

Type Description
NotificacoesIdNotificacaoConfirmarLeituraPostResponse200

Bling API response. Response schemas: 200: NotificacoesDadosDTO[]; 400: ErrorResponse
Source code in src/bling_erp_api/resources/notificacoes.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def mark_as_read(
    self,
    notification_id: str,
) -> NotificacoesIdNotificacaoConfirmarLeituraPostResponse200:
    """Compatibility alias for ``confirmar_leitura()``.

    Marca notificação como lida.

    Endpoint: POST /notificacoes/{idNotificacao}/confirmar-leitura

    Args:
        notification_id: ULID da notificação (Bling: ``idNotificacao``, string, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: NotificacoesDadosDTO[]; 400: ErrorResponse
    """
    return self.confirmar_leitura(id_notificacao=notification_id)