Skip to content

Notas Fiscais de Serviço (NFS-e)

bling_erp_api.resources.nfse.NfseResource 

NfseResource(transport: Transport)

Bases: BaseResource

Operações de notas fiscais de serviço eletrônicas (NFS-e).

Este recurso mapeia os endpoints /nfse. Os métodos canônicos usam português para acompanhar a documentação oficial; os métodos em inglês continuam disponíveis como aliases de 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(
    *,
    pagina: int | None = None,
    limite: int | None = None,
    situacao: int | None = None,
    data_emissao_inicial: str | None = None,
    data_emissao_final: str | None = None,
) -> JsonObject

Lista notas fiscais de serviço (NFS-e).

Endpoint: GET /nfse

Obtém lista paginada de NFS-e.

Parameters:

Name Type Description Default
pagina int | None

N° da página (Bling: pagina, integer, opcional)

 None
limite int | None

Registros por página (Bling: limite, integer, opcional)

 None
situacao int | None

Situação (Bling: situacao, integer, opcional)

 None
data_emissao_inicial str | None

Data de emissão inicial (Bling: dataEmissaoInicial, string, opcional)

 None
data_emissao_final str | None

Data de emissão final (Bling: dataEmissaoFinal, string, opcional)

 None

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: NotasServicosDadosBaseDTO; 400: ErrorResponse
Source code in src/bling_erp_api/resources/nfse.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def listar(
    self,
    *,
    pagina: int | None = None,
    limite: int | None = None,
    situacao: int | None = None,
    data_emissao_inicial: str | None = None,
    data_emissao_final: str | None = None,
) -> JsonObject:
    """Lista notas fiscais de serviço (NFS-e).

    Endpoint: GET /nfse

    Obtém lista paginada de NFS-e.

    Args:
        pagina: N° da página (Bling: ``pagina``, integer, opcional)
        limite: Registros por página (Bling: ``limite``, integer, opcional)
        situacao: Situação (Bling: ``situacao``, integer, opcional)
        data_emissao_inicial: Data de emissão inicial (Bling: ``dataEmissaoInicial``, string, opcional)
        data_emissao_final: Data de emissão final (Bling: ``dataEmissaoFinal``, string, opcional)

    Returns:
        Bling API response. Response schemas: 200: NotasServicosDadosBaseDTO; 400: ErrorResponse
    """
    return self._get(
        "/nfse",
        params=_nfse_list_params(
            pagina=pagina,
            limite=limite,
            situacao=situacao,
            data_emissao_inicial=data_emissao_inicial,
            data_emissao_final=data_emissao_final,
        ),
    )

iterar 

iterar(
    *,
    pagina: int | None = None,
    limite: int | None = None,
    situacao: int | None = None,
    data_emissao_inicial: str | None = None,
    data_emissao_final: str | None = None,
) -> Iterator[JsonObject]

Itera pelas NFS-e página a página.

Endpoint: GET /nfse (via paginação automática)

Aceita os mesmos filtros de listar() e busca novas páginas enquanto o Bling retornar registros no envelope data.

Parameters:

Name Type Description Default
pagina int | None

N° da página (Bling: pagina, integer, opcional)

 None
limite int | None

Registros por página (Bling: limite, integer, opcional)

 None
situacao int | None

Situação (Bling: situacao, integer, opcional)

 None
data_emissao_inicial str | None

Data de emissão inicial (Bling: dataEmissaoInicial, string, opcional)

 None
data_emissao_final str | None

Data de emissão final (Bling: dataEmissaoFinal, string, opcional)

 None

Returns:

Type Description
Iterator[JsonObject]

Iterator sobre os itens da resposta.
Source code in src/bling_erp_api/resources/nfse.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def iterar(
    self,
    *,
    pagina: int | None = None,
    limite: int | None = None,
    situacao: int | None = None,
    data_emissao_inicial: str | None = None,
    data_emissao_final: str | None = None,
) -> Iterator[JsonObject]:
    """Itera pelas NFS-e página a página.

    Endpoint: GET /nfse (via paginação automática)

    Aceita os mesmos filtros de ``listar()`` e busca novas páginas enquanto
    o Bling retornar registros no envelope ``data``.

    Args:
        pagina: N° da página (Bling: ``pagina``, integer, opcional)
        limite: Registros por página (Bling: ``limite``, integer, opcional)
        situacao: Situação (Bling: ``situacao``, integer, opcional)
        data_emissao_inicial: Data de emissão inicial (Bling: ``dataEmissaoInicial``, string, opcional)
        data_emissao_final: Data de emissão final (Bling: ``dataEmissaoFinal``, string, opcional)

    Returns:
        Iterator sobre os itens da resposta.
    """
    params = _nfse_list_params(
        pagina=pagina,
        limite=limite,
        situacao=situacao,
        data_emissao_inicial=data_emissao_inicial,
        data_emissao_final=data_emissao_final,
    )
    return self._iterate("/nfse", page=pagina or 1, limit=limite or 100, params=params)

obter 

obter(id_nota_servico: int) -> JsonObject

Obtém uma NFS-e.

Endpoint: GET /nfse/{idNotaServico}

Obtém uma nota fiscal de serviço pelo ID.

Parameters:

Name Type Description Default
id_nota_servico int

ID da NFS-e (Bling: idNotaServico, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: NotasServicosDadosDTO; 404: ErrorResponse
Source code in src/bling_erp_api/resources/nfse.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
def obter(self, id_nota_servico: int) -> JsonObject:
    """Obtém uma NFS-e.

    Endpoint: GET /nfse/{idNotaServico}

    Obtém uma nota fiscal de serviço pelo ID.

    Args:
        id_nota_servico: ID da NFS-e (Bling: ``idNotaServico``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: NotasServicosDadosDTO; 404: ErrorResponse
    """
    return self._get(f"/nfse/{id_nota_servico}")

criar 

criar(dados: NfsePostRequest) -> NfsePostResponse201

Cria uma NFS-e.

Endpoint: POST /nfse

Cria uma nova nota fiscal de serviço.

Parameters:

Name Type Description Default
dados NfsePostRequest

Dados da NFS-e. Request body schema: NfsePostRequest

 required

Returns:

Type Description
NfsePostResponse201

Bling API response. Response schemas: 201: NfsePostResponse201; 400: ErrorResponse
Source code in src/bling_erp_api/resources/nfse.py 
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
def criar(self, dados: NfsePostRequest) -> NfsePostResponse201:
    """Cria uma NFS-e.

    Endpoint: POST /nfse

    Cria uma nova nota fiscal de serviço.

    Args:
        dados: Dados da NFS-e. Request body schema: NfsePostRequest

    Returns:
        Bling API response. Response schemas: 201: NfsePostResponse201; 400: ErrorResponse
    """
    raw = self._post("/nfse", json=to_json_object(dados))
    return self._validate_response(NfsePostResponse201, raw)

remover 

remover(id_nota_servico: int) -> JsonObject

Remove uma NFS-e.

Endpoint: DELETE /nfse/{idNotaServico}

Remove uma nota fiscal de serviço pelo ID.

Parameters:

Name Type Description Default
id_nota_servico int

ID da NFS-e (Bling: idNotaServico, 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/nfse.py 
233
234
235
236
237
238
239
240
241
242
243
244
245
246
def remover(self, id_nota_servico: int) -> JsonObject:
    """Remove uma NFS-e.

    Endpoint: DELETE /nfse/{idNotaServico}

    Remove uma nota fiscal de serviço pelo ID.

    Args:
        id_nota_servico: ID da NFS-e (Bling: ``idNotaServico``, integer, obrigatório)

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

autorizar 

autorizar(id_nota_servico: int) -> JsonObject

Autoriza (envia) uma NFS-e.

Endpoint: POST /nfse/{idNotaServico}/enviar

Envia uma NFS-e para autorização.

Parameters:

Name Type Description Default
id_nota_servico int

ID da NFS-e (Bling: idNotaServico, integer, obrigatório)

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: NotasServicosDadosDTO; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/nfse.py 
265
266
267
268
269
270
271
272
273
274
275
276
277
278
def autorizar(self, id_nota_servico: int) -> JsonObject:
    """Autoriza (envia) uma NFS-e.

    Endpoint: POST /nfse/{idNotaServico}/enviar

    Envia uma NFS-e para autorização.

    Args:
        id_nota_servico: ID da NFS-e (Bling: ``idNotaServico``, integer, obrigatório)

    Returns:
        Bling API response. Response schemas: 200: NotasServicosDadosDTO; 400: ErrorResponse; 404: ErrorResponse
    """
    return self._post(f"/nfse/{id_nota_servico}/enviar")

cancelar 

cancelar(id_nota_servico: int, dados: JsonObject) -> JsonObject

Cancela uma NFS-e.

Endpoint: POST /nfse/{idNotaServico}/cancelar

Cancela uma nota fiscal de serviço.

Parameters:

Name Type Description Default
id_nota_servico int

ID da NFS-e (Bling: idNotaServico, integer, obrigatório)

 required
dados JsonObject

Dados de cancelamento. Request body schema: NotasServicosCancelamentoDTO

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse
Source code in src/bling_erp_api/resources/nfse.py 
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
def cancelar(self, id_nota_servico: int, dados: JsonObject) -> JsonObject:
    """Cancela uma NFS-e.

    Endpoint: POST /nfse/{idNotaServico}/cancelar

    Cancela uma nota fiscal de serviço.

    Args:
        id_nota_servico: ID da NFS-e (Bling: ``idNotaServico``, integer, obrigatório)
        dados: Dados de cancelamento. Request body schema: NotasServicosCancelamentoDTO

    Returns:
        Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse; 404: ErrorResponse
    """
    return self._post(
        f"/nfse/{id_nota_servico}/cancelar",
        json=to_json_object(dados),
    )

obter_configuracoes 

obter_configuracoes() -> JsonObject

Obtém as configurações de NFS-e.

Endpoint: GET /nfse/configuracoes

Obtém as configurações atuais de NFS-e da empresa.

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 200: ConfiguracaoNotaServicoDadosBaseDTO
Source code in src/bling_erp_api/resources/nfse.py 
334
335
336
337
338
339
340
341
342
343
344
def obter_configuracoes(self) -> JsonObject:
    """Obtém as configurações de NFS-e.

    Endpoint: GET /nfse/configuracoes

    Obtém as configurações atuais de NFS-e da empresa.

    Returns:
        Bling API response. Response schemas: 200: ConfiguracaoNotaServicoDadosBaseDTO
    """
    return self._get("/nfse/configuracoes")

alterar_configuracoes 

alterar_configuracoes(dados: JsonObject) -> JsonObject

Altera as configurações de NFS-e.

Endpoint: PUT /nfse/configuracoes

Altera as configurações de NFS-e da empresa.

Parameters:

Name Type Description Default
dados JsonObject

Dados de configuração. Request body schema: ConfiguracaoNotaServicoDadosBaseDTO

 required

Returns:

Type Description
JsonObject

Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse
Source code in src/bling_erp_api/resources/nfse.py 
360
361
362
363
364
365
366
367
368
369
370
371
372
373
def alterar_configuracoes(self, dados: JsonObject) -> JsonObject:
    """Altera as configurações de NFS-e.

    Endpoint: PUT /nfse/configuracoes

    Altera as configurações de NFS-e da empresa.

    Args:
        dados: Dados de configuração. Request body schema: ConfiguracaoNotaServicoDadosBaseDTO

    Returns:
        Bling API response. Response schemas: 204: NoContent; 400: ErrorResponse
    """
    return self._put("/nfse/configuracoes", json=to_json_object(dados))