API REST

Acesso a documentação para acesso à Api Rest

  • Clientes
  • Títulos
  • Baixas
  • Grupos Econômicos
  • Acordos
  • Cobranças
  • Empresa
  • Beneficiários
  • Geral

    • Beneficiários

    Métodos:

  • Buscar lista de beneficiários de um cliente
  • Buscar lista de beneficiários de uma lista de clientes
  • Enviar/atualizar lista de beneficiários de clientes
  • Remover lista de beneficiários de clientes

    • Buscar lista de beneficiários de um cliente

    GET: Buscar lista de beneficiários de um cliente

    https://www.dunning.com.br/api/v2/cliente-beneficiario/enviar?token={TOKEN}&codigoCliente={codigoCliente}
        curl --include \
         --request GET \
         --header "Content-Type: application/json" \
    'https://www.dunning.com.br/api/v2/cliente-beneficiario/enviar?token=OTA0NV82MDA0j8pmKbNwEb0fdKJCvv&codigoCliente=12345'
    Nome Tipo Descrição
    codigoCliente String Código do cliente/responsável pelo plano 
    [
	{
        "numeroRegistroNomePlano": "123",
        "contrato": "123abc",
        "beneficiario": "Beneficiário Fulano",
        "cpf": "12345678911",
        "codigoResponsavel": "cliente1234",
        "cpfResponsavel": "99988877755"

    },
	{
        "numeroRegistroNomePlano": "456",
        "contrato": "456abc",
        "beneficiario": "Beneficiário Beltrano",
        "cpf": "98765432100",
        "codigoResponsavel": "cliente1234",
        "cpfResponsavel": "99988877755"
    }
]


    Buscar lista de beneficiários de uma lista de clientes

    POST: Buscar lista de beneficiários de uma lista de clientes

    https://www.dunning.com.br/api/v2/cliente-beneficiario/enviar?token={TOKEN}
        curl --include \
         --request POST \
         --header "Content-Type: application/json" \
    'https://www.dunning.com.br/api/v2/cliente-beneficiario/enviar?token=OTA0NV82MDA0j8pmKbNwEb0fdKJCvv'
    Nome Tipo Descrição
    ["abc", "12345"] Lista String Lista de Códigos do clientes/responsáveis pelos planos 
    [
	{
        "numeroRegistroNomePlano": "123",
        "contrato": "123abc",
        "beneficiario": "Beneficiário Fulano",
        "cpf": "12345678911",
        "codigoResponsavel": "cliente1234",
        "cpfResponsavel": "99988877755"

    },
	{
        "numeroRegistroNomePlano": "456",
        "contrato": "456abc",
        "beneficiario": "Beneficiário Beltrano",
        "cpf": "98765432100",
        "codigoResponsavel": "cliente56789",
        "cpfResponsavel": "12345678911"
    }
]


    Enviar/atualizar lista de beneficiários de clientes

    POST: enviar/atualizar lista de beneficiários de clientes

    https://www.dunning.com.br/api/v2/cliente-beneficiario/enviar?token={TOKEN}
        curl --include \
         --request POST \
         --header "Content-Type: application/json" \
    'https://www.dunning.com.br/api/v2/cliente-beneficiario/enviar?token=OTA0NV82MDA0j8pmKbNwEb0fdKJCvv'
    Nome Tipo Descrição
    numeroRegistroNomePlano String Número do registro/Nome do plano
    contrato String Número do contrato
    beneficiario String Nome do beneficiário do plano
    cpf String CPF do beneficiário do plano
    codigoResponsavel String Código do cliente responsável pelo beneficiário
    cpfResponsavel String CPF do cliente responsável pelo beneficiário 
    [
	{
        "numeroRegistroNomePlano": "123",
        "contrato": "123abc",
        "beneficiario": "Beneficiário Fulano",
        "cpf": "12345678911",
        "codigoResponsavel": "cliente1234",
        "cpfResponsavel": "99988877755"

    },
	{
        "numeroRegistroNomePlano": "456",
        "contrato": "456abc",
        "beneficiario": "Beneficiário Beltrano",
        "cpf": "98765432100",
        "codigoResponsavel": "cliente567",
        "cpfResponsavel": "11122233344"
    }
]


    Remover lista de beneficiários de clientes

    DELETE: remover um ou mais beneficiários de um ou mais clientes

    https://www.dunning.com.br/api/v2/cliente-beneficiario/enviar?token={TOKEN}
        curl --include \
         --request DELETE \
         --header "Content-Type: application/json" \
    'https://www.dunning.com.br/api/v2/cliente-beneficiario/enviar?token=OTA0NV82MDA0j8pmKbNwEb0fdKJCvv'
    Nome Tipo Descrição
    cpf String CPF do beneficiário do plano
    codigoResponsavel String Código do cliente responsável pelo beneficiário 
    [
    {
        "cpf": "12345678911",
        "codigoResponsavel": "cliente1234",
    },
	{
        "cpf": "98765432100",
        "codigoResponsavel": "cliente567",
    }
]






    © Copyright 2015-2025 Direitos Reservados.