Recorrência & Mensalidades (NFS-e)

Consultar Contrato e Histórico

Retorna a ficha cadastral completa do contrato recorrente, métricas acumuladas (total emitido, última nota gerada) e a trilha de auditoria (logs) de todas as execuções mensais já realizadas.

GET
https://api.nfer.me
/v1/recurring-contracts/{id}

Authorizations

X-API-Key
string
header
required

Chave de API emitida no painel NFER enviada no header da requisição.

Path Parameters

id
string<uuid>
required

UUID do contrato recorrente.

Exemplo:a819c940-bf72-46a2-9659-192518e11a91

Response

application/json

Dados do contrato e histórico cronológico de emissões.

contract
object
opcional
logs
object[]
opcional
Consultar Contrato e Histórico
curl --request GET \
  --url https://api.nfer.me/v1/recurring-contracts/{id} \
  --header 'X-API-Key: <sua_chave_api>'
{
  "contract": {
    "id": "a819c940-bf72-46a2-9659-192518e11a91",
    "customer_name": "Poliana Lima",
    "customer_document": "04022170123",
    "customer_email": "poliana@exemplo.com.br",
    "amount": 1500,
    "service_code": "010701",
    "day_of_month": 10,
    "next_issue_date": "2026-11-10",
    "active": true,
    "total_issued_count": 3,
    "total_issued_amount": 4500,
    "last_issued_at": "2026-10-10T09:00:00.000Z",
    "last_nfse_id": "e9b5a201-9231-4828-b0a3-a7c3df95a001"
  },
  "logs": [
    {
      "id": "log_01",
      "status": "success",
      "reference_period": "10/2026",
      "amount": 1500,
      "nfse_id": "e9b5a201-9231-4828-b0a3-a7c3df95a001",
      "message": "NFS-e autorizada e despachada por e-mail",
      "created_at": "2026-10-10T09:00:00.000Z"
    }
  ]
}