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)		Tipo de cobrança a ser retornada, sendo: 1 = Cobrança a Faturar 2 = Cobrança já Faturado	*required
fields (query)	Image Added	Filtro de campos dos registros

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

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

Bloco de código

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": [
        {
          "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",
          "value": 10,
          "observation": "42",
          "product": "000000000000000000000000000035",
          "outputType": "501"
        }
      ]
    }
  ],
  "accumulated": [
    {
      "type": "[151] - Serv. Aux. (SADT) (CO-P.)",
      "balance1": "50.00",
      "balance2": "10.00"
    }
  ]
}

...

Bloco de código

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

{
  "code": "E001E003",
  "message": "BeneficiárioSem Cobrança nãoa encontrado.Faturar",
  "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010 existe nenhuma cobrança a ser faturado para o mês e ano informado."
}

Tabela de Código de Erros

...

Não foi encontrado no contas a receber (Financeiro) o título {titleId}

Code	message	detailedMessage
E001	Beneficiário não encontrado.	Não foi encontrado nenhum Beneficiário com a matricula {subscriberId}
E002	Composição do título não encontrado.	Não foi encontrado nenhuma composição para o título {titleId}
E003	Não permitido a geração do PDF	Não é permitido gerar o pdf para o status atual do título {titleId}
Parâmetros obrigatórios	Obrigatório informar o ano base, 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.	E004	Título não encontrado.

03. TELA VALOR DE COBRANÇA

...

Principais Campos e Parâmetros

Campo	Descrição
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO	Carteirinha do beneficiário
MV_PLSNFBR	Possibilita a geração de Nota Fiscal através da rotina de lote de cobrança. 0 = Desativar; 1=Ativar

05. TABELAS UTILIZADAS

BA1 - Beneficiários
BM1 - Composição da Cobrança
SE1 - Títulos no Contas a Receber
BA3 - Famílias

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

Request

Operação realizada com sucesso (200)

Tabela de Código de Erros

03. TELA VALOR DE COBRANÇA

05. TABELAS UTILIZADAS