ReceitaNet - URA - API API documentation version 1

https://sistema.receitanet.net/api/novo/ura

/clientes

busca de clientes usando o CPF/CNPJ

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required (string)

    token para autenticação, solicitar com o suporte

  • app: required (ura)

    nome da aplicação

  • cpfcnpj: (string)

    busca por CPF ou CNPJ

  • phone: (string)

    busca por numero de telefone/celular

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • success: required (boolean)
  • msg: required (string)
  • contratos: required (object)
    • idCliente: required (integer)

      código do cliente

    • razaoSocial: required (string)

      nome do cliente

    • contratoStatusDisplay: required (one of Ativo, Suspenso)

      status do cliente

    • isPromessaPagamento: required (boolean)

      promessa de pagamneto excedido (0) ou não (1)

    • contratoValorAberto: required (integer)

      valor do último boleto não pago

    • faturasEmAberto: required (array of assets.ItemFatura)

      itens de faturamento

      Items: ItemFatura

      • valor: required (integer)
      • vencimento: required (string)
    • cpfCnpj: required (integer)

      cpf/cnpj do cliente

    • contratoStatus: required (string)

      status do contrato

    • existeChamado: required (boolean)

      existe chamado aberto para o cliente?

    • isChamados: required (object)
      • 1: required (integer)

        quantidade de chamados em aberto para o tipo manutenção

      • 2: required (integer)

        quantidade de chamados em aberto para o tipo instalação

      • 4: required (integer)

        quantidade de chamados em aberto para o tipo retirada de equipamento, cancelamento

      • 5: required (integer)

        quantidade de chamados em aberto para o tipo financeiro

Example:

{
  "success": true,
  "msg": "Contrato Localizado",
  "contratos": {
    "idCliente": 36,
    "razaoSocial": "Nome Cliente",
    "contratoStatusDisplay": "Ativo",
    "isPromessaPagamento": true,
    "contratoValorAberto": 202.94,
    "faturasEmAberto": [
      {
        "valor": 202.94,
        "vencimento": "2018-11-03"
      }
    ],
    "cpfCnpj": "00000000000",
    "contratoStatus": 1,
    "existeChamado": 1,
    "contratoId": 36,
    "isChamados": {
      "1": 0,
      "2": 0,
      "4": 0,
      "5": 0
    }
  }
}

HTTP status code 401

não autenticado

HTTP status code 404

cliente não localizado na base de dados

Secured by auth

/boletos

enviar boleto pendente por email/sms

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required (string)

    token para autenticação, solicitar com o suporte

  • app: required (ura)

    nome da aplicação

  • contrato: required (integer)

    valor do campo contratoId do retorno ao busca Cliente

  • uracontato: required (string - maxLength: 20)

    telefone do cliente usado para fazer a ligação

  • tipo: required (one of email, sms)

    tipo de envio a ser realizado

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • success: required (boolean)

    sucesso ou falha na requisição, em caso de falha analisar o parametro msg

  • idCliente: required (integer)

    código do cliente

  • razaoSocial: required (string)

    nome do cliente

  • cpfCnpj: required (string)

    cpf/cnpj do cliente

  • msg: required (string)

    mensagem

  • uracontato: required (string)

    parametro uracontato enviado

  • protocolo: required (string)

    numero de protocolo da OS aberta

  • status: required (boolean)

    sucesso ou falha no envio do boleto

Example:

{
  "success": true,
  "idCliente": 36,
  "razaoSocial": "NOME CLIENTE",
  "cpfCnpj": "000.000.000-00",
  "msg": "Fatura enviada com sucesso",
  "uracontato": "18999998888",
  "protocolo": "20181116144220",
  "status": true
}

HTTP status code 401

não autenticado

Secured by auth

/verificar-acesso

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required (string)

    token para autenticação, solicitar com o suporte

  • app: required (ura)

    nome da aplicação

  • uracontato: required (string - maxLength: 20)

    telefone do cliente usado para fazer a ligação

  • contrato: required (integer)

    valor do campo contratoId do retorno ao busca Cliente

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • status: required (one of false, false)

    status do cliente online(1) ou offline(2)

  • idCliente: required (integer)

    código do cliente

  • razaoSocial: required (string)

    nome do cliente

  • cpfCnpj: required (integer)

    cpf/cnpj do cliente

  • msg: required (string)

    mensagem

  • uracontato: required (string)

    parametro uracontato enviado

Example:

{
  "status": 2,
  "idCliente": 97,
  "razaoSocial": "RUTH SILVA PENIDO NETO",
  "cpfCnpj": "629.375.537-53",
  "msg": "Cliente Offline",
  "uracontato": "18999998888"
}

HTTP status code 401

não autenticado

HTTP status code 404

contrato não localizado

Secured by auth

/notificacao-pagamento

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required (string)

    token para autenticação, solicitar com o suporte

  • app: required (ura)

    nome da aplicação

  • uracontato: required (string - maxLength: 20)

    telefone do cliente usado para fazer a ligação

  • contrato: required (integer)

    valor do campo contratoId do retorno ao busca Cliente

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • status: required (one of 0, 1, 2)

    status da requisição

  • liberado: required (boolean)

    cliente liberado com sucesso ou não

  • razaoSocial: required (string)

    nome do cliente

  • cpfCnpj: required (integer)

    cpf/cnpj do cliente

  • msg: required (string)

    mensagem

  • uracontato: required (string)

    parametro uracontato enviado

  • protocolo: required (string)

    número de protocolo

Example:

{
  "status": 1,
  "liberado": 1,
  "razaoSocial": "Nome Cliente",
  "cpfCnpj": "00000000000",
  "msg": "Liberação via URA",
  "contratoId": "1",
  "uracontato": "1199999999",
  "protocolo": "20180623085657"
}

HTTP status code 401

não autenticado

Secured by auth

/abertura-chamado

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required (string)

    token para autenticação, solicitar com o suporte

  • app: required (ura)

    nome da aplicação

  • uracontato: required (string - maxLength: 20)

    telefone do cliente usado para fazer a ligação

  • contrato: required (integer)

    valor do campo contratoId do retorno ao busca Cliente

  • ocorrenciatipo: required (one of 1, 2, 4, 5)

    tipo de chamados: 1: manutenção 2: instalação 4: retirada de equipamento, cancelamento 5: financeiro

  • motivoos: required (string)

    descrição do chamado

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • status: required (boolean)

    gravado com sucesso ou não

  • razaoSocial: required (string)

    nome do cliente

  • cpfCnpj: required (integer)

    cpf/cnpj do cliente

  • uracontato: required (string)

    parametro uracontato enviado

  • protocolo: required (string)

    número do protocolo

  • idSuporte: required (string)

    código do suporte para envio da gravação

Example:

{
  "status": 1,
  "razaoSocial": "Nome Cliente",
  "cpfCnpj": "00000000000",
  "uracontato": "11999999999",
  "protocolo": "20180623085657",
  "idSuporte": 999999
}

HTTP status code 401

não autenticado

Secured by auth

/chamado-gravacao

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required (string)

    token para autenticação, solicitar com o suporte

  • app: required (ura)

    nome da aplicação

  • idSuporte: required (integer)

    ID do suporte, parâmetro retornado ao abrir novo chamado

  • urlgravacao: required (string)

    url para reprodução da gravação da conversa com o cliente

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • success: required (boolean)

Example:

{
  "success": true
}

HTTP status code 401

não autenticado

HTTP status code 404

suporte não localizado

Body

Media type: application/json

Type: object

Properties
  • success: required (boolean)

Example:

{
  "success": false
}

Secured by auth