Histórico da Página

...

SubscriberId (path)		Número da carteirinha do beneficiário	*required
Authorization (header)		Cabeçalho usado para autorização das requisições	*required
Content-Type (header)		'application/json' é o formato do conteúdo	*required
baseMonth (query)		Mês base do valor de cobrança	*required
baseYear (query)		Ano base do valor de cobrança	*required
billingType (query)	Image Removed	Tipo de cobrança a ser retornada, sendo: 1 = Cobrança a Faturar 2 = Cobrança já Faturado	*required
fields (query)		Filtro de campos dos registros

...

Operação realizada com sucesso (200)

collectionNumberbaseMonth		Número do Lote de cobrança gerado Atributo retornado somente no tipo 2 = Cobrança já Faturado
title	Image Removed	Número do título de cobrança Atributo retornado somente no tipo 2 = Cobrança já Faturado Campo: E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO
Mês base da cobrança
baseYear	Image Added	Ano base da cobrança
billsToBill		Cobrança à faturar
billsToBill.credits	Image Modified	Valor total de créditos para mês/ano informado
billsToBill.debts		Valor total de débitos para mês/ano informado
billsToBill.familyAmount		Valor total da família para mês/ano informado Atributo retornado somente no tipo 1 = Cobrança a Faturar
billsToBill.employerCredits		Valor total de crédito patronal para mês/ano informado
billsToBill.employerDebts		Valor total de débito patronal para mês/ano informado
billsToBill.employerAmount		Valor total patronal para mês/ano informado Atributo retornado somente no tipo 1 = Cobrança a Faturar
billsToBill.amount	Image Added	amount	Image Removed	Valor total da cobrança para mês/ano informado
billsToBill.amountType		Tipo do valor total da cobrança, sendo D (Débito) ou C (Crédito)
billsToBill.beneficiaries		Beneficiários da cobrança
billsToBill.beneficiaries.subscriberId		Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO
billsToBill.beneficiaries.name		Nome do beneficiário Campo: BA1_NOMUSR
billsToBill.beneficiaries.amount		Valor total do beneficiário na cobrança
billsToBill.beneficiaries.compositions		Composição do beneficiário
billsToBill.beneficiaries.compositions.typeCode		Código do tipo de lançamento de faturamento
billsToBill.beneficiaries.compositions.typeDescription		Descrição do lançamento de faturamento
billsToBill.beneficiaries.compositions.type		Tipo do lançamento, sendo Débito ou Crédito
billsToBill.beneficiaries.compositions.retroactive		Indica se o lançamento de faturamento é do tipo retroativo. (Sim ou Não) Os lançamentos retroativos são: 118 e 146
billsToBill.beneficiaries.compositions.value		Valor do lançamento na composição.
billsToBill.beneficiaries.compositions.observation		Observação do lançamento, podendo ser retornado a idade do beneficiário, cobrança pro-rata etc.
billsToBill.beneficiaries.compositions.product		Código do Produto da nota fiscal (SB1). Esse atributo será preenchido se o parâmetro MV_PLSNFBR estiver ativado (1).
billsToBill.beneficiaries.compositions.outputType		Tipo de saída da nota fiscal (TES). Esse atributo será preenchido se o parâmetro MV_PLSNFBR estiver ativado (1).
billsToBill.accumulated		Valores acumulados dos beneficiários
billsToBill.accumulated.type		Tipo do Lançamento
billsToBill.accumulated.balance1		Saldo 1
billsToBill.accumulated.balance2		Saldo 2

...

billsAlreadyBilled		Cobrança já faturada
billsAlreadyBilled.collectionNumber	Image Added	Número do Lote de cobrança gerado
billsAlreadyBilled.title	Image Added	Número do título de cobrança Campo: E1_PREFIXO+E1_NUM+E1_PARCELA+E1_TIPO
billsAlreadyBilled.credits	Image Added	Valor total de créditos para mês/ano informado
billsAlreadyBilled.debts	Image Added	Valor total de débitos para mês/ano informado
billsAlreadyBilled.employerCredits	Image Added	Valor total de crédito patronal para mês/ano informado
billsAlreadyBilled.employerDebts	Image Added	Valor total de débito patronal para mês/ano informado
billsAlreadyBilled.employerAmount	Image Added	Valor total patronal para mês/ano informado Atributo retornado somente no tipo 1 = Cobrança a Faturar
billsAlreadyBilled.amount	Image Added	Valor total da cobrança para mês/ano informado
billsAlreadyBilled.amountType	Image Added	Tipo do valor total da cobrança, sendo D (Débito) ou C (Crédito)
billsAlreadyBilled.beneficiaries	Image Added	Beneficiários da cobrança
billsAlreadyBilled.beneficiaries.subscriberId	Image Added	Carteirinha do Beneficiário Campo: BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO
billsAlreadyBilled.beneficiaries.name	Image Added	Nome do beneficiário Campo: BA1_NOMUSR
billsAlreadyBilled.beneficiaries.amount	Image Added	Valor total do beneficiário na cobrança
billsAlreadyBilled.beneficiaries.compositions	Image Added	Composição do beneficiário
billsAlreadyBilled.beneficiaries.compositions.typeCode	Image Added	Código do tipo de lançamento de faturamento
billsAlreadyBilled.beneficiaries.compositions.typeDescription	Image Added	Descrição do lançamento de faturamento
billsAlreadyBilled.beneficiaries.compositions.type	Image Added	Tipo do lançamento, sendo Débito ou Crédito
billsAlreadyBilled.beneficiaries.compositions.retroactive	Image Added	Indica se o lançamento de faturamento é do tipo retroativo. (Sim ou Não) Os lançamentos retroativos são: 118 e 146
billsAlreadyBilled.beneficiaries.compositions.value	Image Added	Valor do lançamento na composição.
billsAlreadyBilled.beneficiaries.compositions.observation	Image Added	Observação do lançamento, podendo ser retornado a idade do beneficiário, cobrança pro-rata etc.
billsAlreadyBilled.beneficiaries.compositions.product	Image Added	Código do Produto da nota fiscal (SB1). Esse atributo será preenchido se o parâmetro MV_PLSNFBR estiver ativado (1).
billsAlreadyBilled.beneficiaries.compositions.outputType	Image Added	Tipo de saída da nota fiscal (TES). Esse atributo será preenchido se o parâmetro MV_PLSNFBR estiver ativado (1).
billsAlreadyBilled.accumulated	Image Added	Valores acumulados dos beneficiários
billsAlreadyBilled.accumulated.type	Image Added	Tipo do Lançamento
billsAlreadyBilled.accumulated.balance1	Image Added	Saldo 1
billsAlreadyBilled.accumulated.balance2	Image Added	Saldo 2

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (A Faturar)
linenumbers	true
collapse	true

{
   "baseMonth":"12",
   "baseYear":"2023",
   "billsToBill":{
      "credits":50,
      "debts":810,
      "familyAmount":760,
      "employerCredits":0,
      "employerDebts":0,
      "employerAmount":0,
      "amount":760,
      "amountType":"D",
      "beneficiaries":[
         {
            "subscriberId":"00011008000030010",
            "name":"NOAH CAIO BRITO",
            "amount":440,
            "compositions":[
               {
                  "typeCode":"101",
                  "typeDescription":"PRODUTO/PLANO (MENSALIDADE)",
                  "type":"Débito",
                  "retroactive":"Não",
                  "value":480,
                  "observation":"60",
                  "product":"000000000000000000000000000035",
                  "outputType":"501"
               },
               {
                  "typeCode":"103",
                  "typeDescription":"TAXA INSCRICAO/ADESAO",
                  "type":"Débito",
                  "retroactive":"Não",
                  "value":10,
                  "observation":"60",
                  "product":"000000000000000000000000000035",
                  "outputType":"501"
               },
               {
                  "typeCode":"130",
                  "typeDescription":"CREDITO SERV ACESSORIO",
                  "type":"Crédito",
                  "retroactive":"Não",
                  "value":50,
                  "observation":"",
                  "product":"000000000000000000000000000035",
                  "outputType":"501"
               }
            ]
         },
         {
            "subscriberId":"00011008000030029",
            "name":"CAUE MATEUS FILIPE PEREIRA",
            "amount":320,
            "compositions":[
               {
                  "typeCode":"101",
                  "typeDescription":"PRODUTO/PLANO (MENSALIDADE)",
                  "type":"Débito",
                  "retroactive":"Não",
                  "value":310,
                  "observation":"42",
                  "product":"000000000000000000000000000035",
                  "outputType":"501"
               },
               {
                  "typeCode":"103",
                  "typeDescription":"TAXA INSCRICAO/ADESAO",
                  "type":"Débito",
                  "retroactive":"Não",

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (A Faturar)
linenumbers	true
collapse	true

{
  "credits": 50,
  "debts": 810,
  "familyAmount": 760,
  "employerCredits": 0,
  "employerDebts": 0,
  "employerAmount": 0,
  "amount": 760,
  "amountType": "D",
  "beneficiaries": [
    {
      "subscriberId": "00011008000030010",
      "name": "NOAH CAIO BRITO",
      "amount": 440,
      "compositions": [
        {
          "typeCodevalue": "101"10,
                  "typeDescriptionobservation": "PRODUTO/PLANO (MENSALIDADE)"42",
          "type": "Débito",
          "retroactiveproduct": "Não000000000000000000000000000035",
          "value": 480,
          "observationoutputType": "60501",
              "product": "000000000000000000000000000035",
 }
           "outputType": "501"
 ]
         },
      ],
  {
    "accumulated":[
        "typeCode": "103",
 {
            "typeDescriptiontype": "TAXA INSCRICAO/ADESAO"[151] - Serv. Aux. (SADT) (CO-P.)",
            "typebalance1": "Débito50.00",
            "retroactivebalance2": "Não10.00",
         }
 "value": 10,
    ]
   },
   "observationbillsAlreadyBilled": "60",
    {
      "productcollectionNumber": "000000000000000000000000000035",
          "outputTypetitle": "501",
        }"credits":0,
        {"debts":0,
          "typeCodeemployerCredits": "130",
    0,
      "typeDescriptionemployerDebts": "CREDITO SERV ACESSORIO"0,
          "typeamount": "Crédito"0,
          "retroactiveamountType": "NãoD",
          "valuebeneficiaries": 50,[
         
 "observation": "",
    ],
      "productaccumulated": "000000000000000000000000000035",[
          "outputType": "501"

      ]
   }
}

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (Já Faturado)
linenumbers	true
collapse	true

{
   "baseMonth":"12",
   ]
    }"baseYear":"2022",
    "billsToBill":{
      "subscriberIdcredits": "00011008000030029"0,
      "namedebts":0,
   "CAUE MATEUS FILIPE PEREIRA"familyAmount":0,
      "amountemployerCredits": 3200,
      "compositionsemployerDebts": [0,
      "employerAmount":0,
    {
    "amount":0,
      "typeCodeamountType": "101D",
      "beneficiaries":[
       "typeDescription": "PRODUTO/PLANO (MENSALIDADE)",
      ],
      "typeaccumulated": "Débito",[
         
 "retroactive": "Não",
    ]
   },
   "valuebillsAlreadyBilled": 310,
    {
      "observationcollectionNumber": "42000100000232",
          "producttitle":"PLS000007052 "000000000000000000000000000035DP",
      "credits":0,
      "outputTypedebts": "501"475,
        }"employerCredits":0,
      "employerDebts":0,
  {
    "amount":475,
      "typeCodeamountType": "103D",
          "typeDescriptionbeneficiaries": "TAXA INSCRICAO/ADESAO",[
         {
 "type": "Débito",
          "retroactivesubscriberId": "Não00011008000027010",
            "valuename": 10"HERNANDES ALVES DA SILVA",
            "observationamount": "42"196,
           "product": "000000000000000000000000000035compositions",:[
          "outputType": "501"
    {
    }
      ]
    }
  ],
  "accumulatedtypeCode": [
"101",
       {
      "type": "[151] - Serv. Aux. (SADT) (CO-P. "typeDescription":"PRODUTO/PLANO (MENSALIDADE)",
           "balance1": "50.00",
      "balance2type": "10.00Débito",
        }
  ]
}

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso (Já Faturado)
linenumbers	true
collapse	true

{
  "collectionNumber": "000100000232",
  "title": "PLS000007052 DP",
  "credits": 0,
  "debts": 475,
  "employerCredits": 0,
  "employerDebts": 0,
  "amount": 475,
  "amountType": "D",
  "beneficiaries": [
    {
          "retroactive":"Não",
                  "value":196,
                  "observation":"21",
                  "product":"000000000000000000000000000035",
                  "subscriberIdoutputType": "00011008000027010",
"501"
           "name": "HERNANDES ALVES DA SILVA",
}
           "amount": 196,
 ]
        "compositions": [
 },
         {
            "typeCodesubscriberId": "10100011008000027028",
            "typeDescriptionname": "PRODUTO/PLANO (MENSALIDADE)"FABIANA SOPHIA MELO",
          "type":  "Débitoamount":279,
            "retroactivecompositions":[
 "Não",
          "value": 196,
   {
       "observation": "21",
          "producttypeCode": "000000000000000000000000000035101",
          "outputType": "501"
        }
  "typeDescription":"PRODUTO/PLANO (MENSALIDADE)",
    ]
    },
    {
      "subscriberIdtype": "00011008000027028Débito",
      "name": "FABIANA SOPHIA MELO",
      "amount": 279,
      "compositionsretroactive": ["Não",
        {
          "typeCodevalue": "101"279,
          "typeDescription": "PRODUTO/PLANO (MENSALIDADE)",
          "typeobservation": "Débito35",
                  "retroactiveproduct": "Não000000000000000000000000000035",
                  "valueoutputType": 279,
"501"
              "observation": "35",
 }
           "product": "000000000000000000000000000035",
 ]
         }
     "outputType": "501"
 ],
      "accumulated":[
   }
      ]
    }
  ],
  "accumulated": [] }
}

...

Dados Inválidos (404)

code		Código identificador do erro. (Tabela de Erros)
message		Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage		Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E003",
  "message": "SemFalha ao Cobrançaprocessar a FaturarCobrança",
  "detailedMessage": "Não existe nenhuma foi possivel processar o valor de cobrança ado serbeneficiário, faturadoverifique paraas oconfigurações mêsde efaturamento anoda informadocobrança."
}

Tabela de Código de Erros

...

Code	message	detailedMessage
E001	Beneficiário não encontrado.	Não foi encontrado nenhum Beneficiário com a matricula {subscriberId}
E002	Parâmetros obrigatórios	Obrigatório informar o ano base , e mês base e tipo da cobrança
E003	Sem Cobrança a Faturar	Não existe nenhuma cobrança a ser faturado para o mês e ano informado.
E004	Nenhuma Cobrança já Faturada	Não existe nenhuma cobrança já faturada para o mês e ano informado.
E005	Falha ao processar a Cobrança	Não foi possível processar o valor de cobrança do beneficiário, verifique as configurações de faturamento da cobrança.

...

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão 5

Chave

Operação realizada com sucesso (200)

Dados Inválidos (404)

Tabela de Código de Erros