Operações (playground)

Consultar nota pelo id

GET
/invoices/{id}

Autorização

bearer
headerAutorizaçãoBearer <token>

Token gerado no painel (Integrações → Tokens de API), começa com nf_

Parâmetros de caminho

id*integer

id da nota no nfse-digital

Faixa1 <= value

Corpo da resposta

Nota

application/json
  1. response
id*integer
idempotency_key?string
status*InvoiceStatus
Value in"pending""authorized""rejected""cancelled"
status_label*string
environment*Environment
Value in"homologation""production"
dps_series*string
dps_number*integer
nfse_number?string

número da NFS-e (autorizada)

access_key?string

chave de acesso de 50 dígitos (autorizada)

amount*string

ponto decimal, duas casas

competence?string
Formatodate
issued_at?string
Formatodate-time
customer_id*integer
template_id*integer
description*string
error_code?string

código da SEFIN (rejeitada)

message?string

erro da SEFIN traduzido, ou aviso de resposta pendente

Exemplo de requisição
curl -X GET 'https://nfse.bassi.engineer/api/v1/invoices/1'
Exemplo de resposta
{  "id": 0,  "idempotency_key": "string",  "status": "pending",  "status_label": "string",  "environment": "homologation",  "dps_series": "string",  "dps_number": 0,  "nfse_number": "string",  "access_key": "string",  "amount": "string",  "competence": "2019-08-24",  "issued_at": "2019-08-24T14:15:22Z",  "customer_id": 0,  "template_id": 0,  "description": "string",  "error_code": "string",  "message": "string"}