Show / Hide Table of Contents

    Title

    Serviço responsável pela visualização de sócios e cobranças de um título

    Apenas contas de acesso que possuem um título poderão utilizar estes serviços.

    GetMembers

    Consulta todos os sócios para o título informado.

    POST {baseAddress}/getMembers
    
    {
      "CloudAccountEid": 0,
      "TitleId": 0
    }
    

    Parâmetros

    Nome Tipo Descrição
    data MemberData Dados para identificação do título. Obrigatório.

    Retorno

    [
      {
        "Titular": false,
        "Id": 0,
        "Name": "{{texto}}",
        "BirthDate": "\/Date(1768791600000)\/"
      }
    ]
    
    Tipo Descrição
    MemberResult[] Se informado conta de acesso e título válidos, retorna os dados dos sócios do título. Senão dispara erro.

    GetMemberPhoto

    Consulta foto de um sócio

    POST {baseAddress}/getMemberPhoto
    
    {
      "CloudAccountEid": 0,
      "MemberId": 0,
      "Height": 0,
      "Width": 0,
      "LastUpdateDate": "\/Date(1768791600000)\/"
    }
    

    Parâmetros

    Nome Tipo Descrição
    data MemberPhotoData Dados para identificação do sócio. Obrigatório.

    Retorno

    {
      "HasChanged": false,
      "Photo": "AA==",
      "LastUpdateDate": "\/Date(1768791600000)\/"
    }
    
    Tipo Descrição
    MemberPhotoResult Retorna a foto do sócio, em seu tamanho original.
            É possivel informar um tamanho, caso queira redimensionar foto (Tamanho máximo 3000).
            Se for informado a última data de atualização, e a foto do sócio possuir mesma data, foto não será retornada para reduzir consumo de dados. |
    

    GetDuns

    Consulta todas as cobranças do título para o ano informado

    POST {baseAddress}/getDuns
    
    {
      "CloudAccountEid": 0,
      "TitleId": 0,
      "Year": 0
    }
    

    Parâmetros

    Nome Tipo Descrição
    data DunData Dados para identificação das cobranças. Obrigatório.

    Retorno

    [
      {
        "Id": 0,
        "TitleCode": "{{texto}}",
        "DueDate": "\/Date(1768791600000)\/",
        "Status": 0,
        "Value": {
          "Value": 0.0,
          "CorrectedValue": 0.0,
          "InterestValue": 0.0,
          "ArrearsValue": 0.0,
          "DiscountValue": 0.0
        },
        "PaidValue": {
          "PaymentDate": "\/Date(1768791600000)\/",
          "Value": 0.0,
          "PaidValue": 0.0,
          "InterestValue": 0.0,
          "ArrearsValue": 0.0,
          "DiscountValue": 0.0,
          "PaymentModes": [
            {
              "Id": 0,
              "Name": "{{texto}}",
              "PaymentType": 0
            }
          ]
        },
        "Items": [
          {
            "ParcelNumber": 0,
            "ParcelQuantity": 0,
            "Description": "{{texto}}",
            "Value": 0.0,
            "MemberName": "{{texto}}",
            "MemberType": 0
          }
        ],
        "DunType": 0,
        "TypeableLine": "{{texto}}"
      }
    ]
    
    Tipo Descrição
    DunResult[] Retorna todas as cobranças do título para o ano informado.

    GetDunsYears

    Consulta os anos que o título possui cobrança

    POST {baseAddress}/getDunsYears
    
    {
      "CloudAccountEid": 0,
      "TitleId": 0
    }
    

    Parâmetros

    Nome Tipo Descrição
    data MemberData Dados para identificação do título. Obrigatório.

    Retorno

    [
      0
    ]
    
    Tipo Descrição
    Int32[] Retorna todos os anos no qual o título possue cobranças

    PayDuns

    Realiza pagamento para todas as cobranças informadas.

    POST {baseAddress}/payDuns
    
    {
      "Duns": [
        0
      ],
      "CloudAccountEid": 0,
      "Value": 0.0,
      "Parcels": 0,
      "ExistingCard": {
        "Eid": 0,
        "SecurityCode": "{{texto}}"
      },
      "NewCard": {
        "CardType": 0,
        "CardHolderName": "{{texto}}",
        "CardNumber": "{{texto}}",
        "ExpiryMonth": 0,
        "ExpiryYear": 0,
        "SecurityCode": "{{texto}}",
        "StoreCard": false
      }
    }
    

    Parâmetros

    Nome Tipo Descrição
    data PerformPaymentData Dados para pagamento de cobranças. Obrigatório.

    Retorno

    {
      "Approved": false,
      "Message": "{{texto}}"
    }
    
    Tipo Descrição
    PaymentResult Retorna status da tentativa de pagamento. Senão dispara erro.

    GetMemberCard

    Retorna as imagens das carteirinhas digitais.

    POST {baseAddress}/getMemberCard
    
    {
      "CloudAccountEid": 0,
      "MemberId": 0,
      "TextHash": "{{texto}}",
      "TemplateHash": "{{texto}}"
    }
    

    Parâmetros

    Nome Tipo Descrição
    data MemberCardData Dados para identificação do título. Obrigatório.

    Retorno

    {
      "Card": "AA==",
      "TextHash": "{{texto}}",
      "TemplateHash": "{{texto}}"
    }
    
    Tipo Descrição
    MemberCardResult Se informado conta de acesso e título válidos, retorna as imagens das carteirinhas. Senão dispara erro.
    Back to top Um produto MultiClubes