{"openapi":"3.0.0","info":{"title":"5.9.3 - Financial Reporting","description":"# **Esta API tem a função de relatório financeiro para fornecer dados apresentando resumos das atividades financeiras das contas dos clientes. Inclui um conjunto de relatórios de vencimento da dívida e relatórios de prova e saldo.**\n\n> _Para utilização do serviço é necessário cadastro em nossa API Manager\n(https://integration.brmalls.com.br/store/site/pages/sign-up.jag) e\ninscrever a aplicação no serviço, o mesmo será aprovado por **TICORE**._","contact":{"name":"Integração","email":"gd_ti_integracao@brmalls.com.br"},"version":"1.1.0"},"servers":[{"description":"API no API Manager","url":"https://api-gtw.integracao.brmalls.com.br/customer/FinancialReporting"},{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/brmalls/5.9.3-FinancialReporting/1.1.0"}],"tags":[{"name":"PaymentInstallment"},{"name":"CustomerTrx"},{"name":"CustomerTrxType"},{"name":"BankSlip"}],"paths":{"/payment-installments":{"get":{"tags":["PaymentInstallment"],"summary":"Lista de parcelas de transações de faturamento.","description":"Lista de Parcela de uma transação de faturamento. \n<br> Observações importantes: \n1. companyId: Deve estar sempre presente em todos filtros.\n2. Caso a busca seja de boletos com **SALDO EM ABERTO** sempre será preciso informar os seguintes parâmetros com os valores constantes e respeitar algumas combinações para otimizações do tempo de busca: \n\n    - paymentClass = lista de 'CM', 'DM' e 'INV'\n    - paymentStatus = 'OP'\n    - paymentGlDateClosed = '4712-12-31' - se não informar data de vencimento da parcela\n    - paymentAmountDueRemainingNonZero = true - se informar data de vencimento da parcela","parameters":[{"name":"companyIds","in":"query","description":"Lista de ids de empresas. Parâmetro obrigatório.","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"paymentIds","in":"query","description":"Lista de ids de parcelas de transações de faturamento.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"customerId","in":"query","description":"Id da Conta do Cliente.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"customerSiteUseId","in":"query","description":"Id do objetivo comercial da conta do cliente.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"paymentDueDateFrom","in":"query","description":"Data de vencimento inicial da parcela de uma transação no formato AAAA-MM-DD","schema":{"type":"string","format":"date"}},{"name":"paymentdueDateTo","in":"query","description":"Data de vencimento final da parcela de uma transação no formato AAAA-MM-DD","schema":{"type":"string","format":"date"}},{"name":"paymentClass","in":"query","required":false,"description":"Classe da Parcela de uma transação. <br>**Constantes obrigatórias para busca de parcelas com saldo em aberto de transações de faturamento são: \"CM\", \"DM\" e \"INV\"**","schema":{"type":"array","items":{"type":"string"}}},{"name":"paymentStatus","in":"query","description":"Status da parcela. Possiveis valores: OP para Open Status ou CL para Closed. <br>**Usar OP obrigatoriamente para busca de saldo em aberto.**","required":false,"schema":{"type":"string"}},{"name":"paymentGlDateClosed","in":"query","description":"Data de fechamento de uma parcela de uma transação. <br>Este atributo tem uma data futura como valor padrão (4712-12-31) no formato AAAA-MM-DD, portanto é um parâmetro obrigatório para buscas de parcelas com SALDO EM ABERTO. Se esta informação na parcela está diferente desta data padrão, ela já foi paga. <br>**ATENÇÃO: Não informar esse parametro se estiver usando as datas de vencimento na parcela (paymentDueDateFrom e paymentDueDateTo), para isso usar o parametro paymentAmountDueRemainingNonZero**","schema":{"type":"string","format":"date"}},{"name":"paymentAmountDueRemainingNonZero","in":"query","description":"Condição para valor em aberto da parcela diferente de zero. Possiveis valores: true. <br>**Somente usar para busca de SALDO EM ABERTO se foi informado as datas de vencimento na parcela (paymentDueDateFrom e paymentDueDateTo). Nesse caso não passar o parâmetro paymentGlDateClosed**","required":false,"schema":{"type":"boolean","enum":[true]}},{"name":"page","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Nomes dos atributos que serão usados para ordenar a lista, separados por vírgula, cada um com um possível unário negativo para indicar ordem descendente. Ex. sort=trxNumber ou sort=-trxNumber indicando ordenação decrescente.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de parcelas de uma transação de faturamento.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInstallmentResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/payment-installments/bankslips/{slipId}":{"get":{"tags":["PaymentInstallment"],"summary":"Lista de parcelas de um boleto de faturamento.","description":"Retorna as parcelas de um boleto de faturamento. <br>**É necessário buscar por pelo menos um parâmetro.**","parameters":[{"name":"slipId","in":"path","description":"Id de um boleto.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"paymentClass","in":"query","required":false,"description":"Classe da Parcela de uma transação. <br>**Constantes obrigatórias para busca de parcelas com saldo em aberto de transações de faturamento são: \"CM\", \"DM\" e \"INV\"**","schema":{"type":"array","items":{"type":"string"}}},{"name":"paymentGlDateClosed","in":"query","description":"Data de fechamento de uma parcela de uma transação. <br>Este atributo tem uma data futura como valor padrão (4712-12-31) no formato AAAA-MM-DD, portanto é um **parâmetro obrigatório para buscas de parcelas com saldo em aberto.** Se esta informação na parcela está diferente desta data padrão, ela já foi paga.","schema":{"type":"string","format":"date"}},{"name":"paymentStatus","in":"query","description":"Status da parcela. Possiveis valores: OP para Open Status ou CL para Closed. <br>**Usar OP obrigatoriamente para busca de saldo em aberto.**","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Nomes dos atributos que serão usados para ordenar a lista, separados por vírgula, cada um com um possível unário negativo para indicar ordem descendente. Ex. sort=trxNumber ou sort=-trxNumber indicando ordenação decrescente.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de parcelas de um boleto de faturamento.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInstallmentResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/payment-installments/{paymentId}":{"get":{"tags":["PaymentInstallment"],"summary":"Parcela de uma transação de faturamento.","description":"Parcela de uma transação de faturamento.","parameters":[{"name":"paymentId","in":"path","description":"Id da parcela da transação de faturamento.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Parcela de uma transação de faturamento.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentInstallment"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/customer-trx/{customerTrxId}":{"get":{"tags":["CustomerTrx"],"summary":"Cabeçalho de uma transação de faturamento","description":"Cabeçalho de uma transação de faturamento.","parameters":[{"name":"customerTrxId","in":"path","description":"Id do cabeçalho da transação de faturamento.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Cabeçalho de uma transação de faturamento.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerTrx"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/customer-trx-types":{"get":{"tags":["CustomerTrxType"],"summary":"Tipo de uma transação de faturamento","description":"Tipo de uma transação de faturamento.","parameters":[{"name":"custTrxTypeId","in":"query","description":"Id do tipo de uma transação de faturamento.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"companyId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Tipo de uma transação de faturamento.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerTrxType"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/bankslips/payment-installments":{"get":{"tags":["BankSlip"],"summary":"Lista de boletos de faturamento considerando suas parcelas.","description":"Lista Boletos de faturamento considerando suas parcelas. \n<br> Observações importantes: \n1. companyId: Deve estar sempre presente em todos filtros.\n2. Caso a busca seja de boletos com **SALDO EM ABERTO** sempre será preciso informar os seguintes parâmetros com os valores constantes e respeitar algumas combinações para otimizações do tempo de busca: \n\n    - paymentClass = lista de 'CM', 'DM' e 'INV'\n    - paymentStatus = 'OP'\n    - paymentGlDateClosed = '4712-12-31' - se não informar data de vencimento da parcela\n    - paymentAmountDueRemainingNonZero = true - se informar data de vencimento da parcela\n    ","parameters":[{"name":"companyIds","in":"query","description":"Lista de ids de empresas. Parâmetro obrigatório.","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"slipNumber","in":"query","description":"Numero do Boleto de faturamento.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"customerId","in":"query","description":"Id da Conta do Cliente.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"luc","in":"query","description":"Código da LUC da conta do cliente. Exemplo: SNS04103","required":false,"schema":{"type":"string"}},{"name":"slipType","in":"query","description":"Tipo do boleto. Possíveis valores: \"A\" de Administrativo ou \"C\" de cobrança. Condição feita sobre o Nosso numero do Boleto. Quando este valor for nulo, trata-se de um boleto Administrativo, caso contrario, é um boleto de Cobrança.","required":false,"schema":{"type":"string","enum":["A","C"]}},{"name":"slipDueDateFrom","in":"query","description":"Data de vencimento inicial do boleto no formato AAAA-MM-DD","schema":{"type":"string","format":"date"}},{"name":"slipDueDateTo","in":"query","description":"Data de vencimento final do boleto no formato AAAA-MM-DD","schema":{"type":"string","format":"date"}},{"name":"paymentDueDateFrom","in":"query","description":"Data de vencimento inicial da parcela de transação no formato AAAA-MM-DD","schema":{"type":"string","format":"date"}},{"name":"paymentDueDateTo","in":"query","description":"Data de vencimento final da parcela de transação no formato AAAA-MM-DD","schema":{"type":"string","format":"date"}},{"name":"paymentClass","in":"query","required":false,"description":"Classe da Parcela de uma transação. <br>**Constantes obrigatórias para busca de parcelas com saldo em aberto de transações de faturamento são: \"CM\", \"DM\" e \"INV\"**","schema":{"type":"array","items":{"type":"string"}}},{"name":"paymentStatus","in":"query","description":"Status da parcela. Possiveis valores: OP para Open Status ou CL para Closed. <br>**Usar OP obrigatoriamente para busca de saldo em aberto.**","required":false,"schema":{"type":"string"}},{"name":"paymentGlDateClosed","in":"query","description":"Data de fechamento de uma parcela de uma transação. <br>Este atributo tem uma data futura como valor padrão (4712-12-31) no formato AAAA-MM-DD, portanto é um parâmetro obrigatório para buscas de parcelas com SALDO EM ABERTO. Se esta informação na parcela está diferente desta data padrão, ela já foi paga. <br>**ATENÇÃO: Não informar esse parâmetro se estiver usando as datas de vencimento na parcela (paymentDueDateFrom e paymentDueDateTo), para isso usar o parâmetro paymentAmountDueRemainingNonZero**","schema":{"type":"string","format":"date"}},{"name":"paymentAmountDueRemainingNonZero","in":"query","description":"Condição para valor em aberto da parcela diferente de zero. Possiveis valores: true. <br>**Somente usar para busca de SALDO EM ABERTO se foi informado as datas de vencimento na parcela (paymentDueDateFrom e paymentDueDateTo). Nesse caso não passar o parâmetro paymentGlDateClosed**","required":false,"schema":{"type":"boolean","enum":[true]}},{"name":"page","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Nomes dos atributos que serão usados para ordenar a lista, separados por vírgula, cada um com um possível unário negativo para indicar ordem descendente. Ex. sort=trxNumber ou sort=-trxNumber indicando ordenação decrescente.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de Boletos de faturamento.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankSlipHeaderEssentialResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/bankslips":{"get":{"tags":["BankSlip"],"summary":"Boleto de faturamento","description":"Retorna um Boleto de faturamento.<br>**É necessário buscar por pelo menos um parâmetro.**","parameters":[{"name":"slipNumber","in":"query","description":"Numero do boleto","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"slipId","in":"query","description":"Id de um boleto.","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Boleto de faturamento.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankSlipHeader"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/non-payment-resume/mesAnoRef/{mesAnoRef}/dataRef/{dataRef}":{"get":{"tags":["NonPaymentRegister"],"summary":"Resumo da Base de Inadimplência","description":"Retorna os dados da base de inadimplência baseado na data de referência.","parameters":[{"name":"dataRef","in":"path","description":"Data de referência, no formato YYYY-MM-DD.","required":true,"schema":{"type":"string","format":"datetime","example":"2020-04-01"}},{"name":"mesAnoRef","in":"path","description":"Mês avaliado, no formato MM-YYYY.","required":true,"schema":{"type":"string","example":"04-2020"}},{"name":"pageNo","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Resumo de Inadimplentes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NonPaymentResponse"}}}},"400":{"description":"Requisição Inválida."},"401":{"description":"Não autenticado."},"404":{"description":"Não encontrado."},"422":{"description":"Formato do parâmetro de data inválido."},"500":{"description":"Erro Interno."}}}}},"components":{"schemas":{"PageInfo":{"type":"object","properties":{"totalItems":{"description":"Total de itens","type":"integer","format":"int64","example":250},"currentPage":{"description":"Número da página corrente","type":"integer","format":"int64","example":1},"pageSize":{"type":"integer","format":"int64","example":20},"sort":{"description":"Ordenação usada de acordo com o parametro sort","type":"string"}}},"Error":{"title":"Error","type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"message":{"type":"string"}}},"PaymentInstallmentResponse":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentInstallment"}}}},"PaymentInstallment":{"type":"object","properties":{"paymentId":{"type":"integer","format":"int64","description":"Id da parcela de uma transacao de faturamento.","example":35960172},"companyId":{"type":"integer","format":"int64","description":"Id da organização de um shopping.","example":106},"customerTrxId":{"type":"integer","format":"int64","description":"Id do cabeçalho da transação de faturamento.","example":35111891},"customerSiteUseId":{"type":"integer","format":"int64","description":"Id do objetivo comercial da conta do cliente.","example":27248},"customerId":{"type":"integer","format":"int64","description":"Id da conta do cliente.","example":8075},"custTrxTypeId":{"type":"integer","format":"int64","description":"Id do tipo da transação de faturamento.","example":23967},"termId":{"type":"integer","format":"int64","description":"Id da forma de pagamento da transação de faturamento.","example":1001},"trxNumber":{"type":"string","description":"Numero da transação de faturamento","example":"8075"},"termsSequenceNumber":{"type":"integer","format":"int32","description":"Sequencial das parcelas de uma transação.","example":1},"numberOfDueDates":{"type":"integer","format":"int32","description":"Sequencial das parcelas de uma transação.","example":1},"amountDueOriginal":{"type":"number","description":"Valor original da parcela da transação de faturamento.","example":43.71},"amountDueRemaining":{"type":"number","description":"Valor em aberto da parcela da transação de faturamento.","example":43.71},"dueDate":{"type":"string","format":"date","description":"Data de vencimento da parcela da transação de faturamento no formato AAAA-MM-DD.","example":"2017-09-02"},"glDate":{"type":"string","format":"date","description":"Data contábil da parcela da transação de faturamento no formato AAAA-MM-DD.","example":"2016-08-11"},"creationDate":{"type":"string","format":"datetime","description":"Data de criaçao da parcela da transação de faturamento no formato AAAA-MM-DD hh:mm:ss.","example":"2016-08-11 10:12:39"},"createdBy":{"type":"integer","format":"int64","description":"Id do usuario no EBS que criou o registro.","example":7577},"especieCredito":{"type":"string","description":"Especie de crédito.","example":"Sem Garantia"},"tipoAcao":{"type":"string","description":"Tipo de ação jurídica.","example":"Execução de Título Extrajudicial"},"numProcesso":{"type":"string","description":"Número do processo jurídico.","example":"1036506520178190000"},"tendencia":{"type":"string","description":"Tendencia de recebimento. Y=Sim, N=Não","example":"Y"},"statusAporte":{"type":"string","description":"Status com valor \"APORTADO\" para quando a parcela se encontra aportada.","example":"APORTADO"},"tipoNeg":{"type":"string","description":"Tipo da Negociação de Divida ocorrida na parcela. Exemplos: Prorrogação, Confissão, Parcelamento","example":"Confissão"},"numNeg":{"type":"string","description":"Numero da Negociação ocorrida na parcela de transação.","example":"579492"},"statusNeg":{"type":"string","description":"Status da Negociação ocorrida na parcela de transação.","example":"Negociado"}}},"CustomerTrx":{"type":"object","properties":{"customerTrxId":{"type":"integer","format":"int64","description":"Id do cabeçalho da transação de faturamento.","example":35111891},"trxNumber":{"type":"string","description":"Numero da transação","example":"261156"},"companyId":{"type":"integer","format":"int64","description":"Id da organização de um shopping.","example":106},"custTrxTypeId":{"type":"integer","format":"int64","description":"Id do tipo da transação de faturamento. Exemplos de tipos de transacao: Parcelamento, Confissão","example":23967},"competencyDate":{"type":"string","format":"date","description":"Data de competencia da transação no formato AAAA-MM-DD.","example":"2006-03-01"},"revenueTypeCode":{"type":"string","description":"Código do tipo de receita da transação de faturamento. Ex. Almin, CONDDC, FPPCO, FPPCE.","example":"CONDAR"},"codeCombinationId":{"type":"integer","format":"int64","description":"Id da combinação contabil de uma transação","example":1048}}},"CustomerTrxType":{"type":"object","properties":{"custTrxTypeId":{"type":"integer","format":"int64","description":"Id do tipo de transação","example":23967},"trxTypeName":{"type":"string","description":"Nome do tipo de transação. Ex. Almin, CONDDC, FPPCO, FPPCE","example":"CONFISSAO_ASSUNÇÃO"},"companyId":{"type":"integer","format":"int64","description":"Id da empresa deste tipo de transação.","example":106}}},"BankSlipHeaderEssentialResponse":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BankSlipHeaderEssential"}}}},"BankSlipHeaderEssential":{"type":"object","properties":{"slipId":{"type":"integer","format":"int64","description":"Id do boleto de faturamento.","example":3503343},"slipNumber":{"type":"integer","format":"int64","description":"Número do boleto de faturamento.","example":123036635},"customerId":{"type":"integer","format":"int64","description":"Id da conta do cliente.","example":7739},"luc":{"type":"string","description":"Código da LUC (Alias) da linha da conta do cliente.","example":"SNS0AE11"},"customerInscription":{"type":"string","description":"CNPJ ou CPF completos de um cliente sem formatação.<br>CPNJ: 14 digitos. No EBS essa informação, somente para CNPJ está prefixada com digito 0, retornando 15 caracteres.<br>CPF: 11 digitos.","example":"042591651006931"},"slipDueDate":{"description":"Data de vencimento do boleto no formato AAAA-MM-DD","type":"string","format":"date","example":"2021-11-03"},"slipType":{"description":"Tipo do boleto. Possíveis valores: \"A\" de Administrativo ou \"C\" de cobrança. Condição feita sobre o Nosso numero do Boleto. Quando este valor for nulo, trata-se de um boleto Administrativo, caso contrario, é um boleto de Cobrança.","type":"string","example":"C"},"slipStatus":{"description":"Status do Boleto. <br>Possiveis valores: <br>R - Retornado; <br>C - Cancelado; <br>E - Enviado;<br>G - Gerado","type":"string","example":"E"}}},"BankSlipHeader":{"type":"object","properties":{"slipId":{"type":"integer","format":"int64","description":"Id do boleto de faturamento.","example":3503343},"slipNumber":{"type":"integer","format":"int64","description":"Número do boleto de faturamento.","example":123036635},"customerId":{"type":"integer","format":"int64","description":"Id da conta do cliente.","example":7739},"luc":{"type":"string","description":"Código da LUC (Alias) da linha da conta do cliente.","example":"SNS0AE11"},"customerInscription":{"type":"string","description":"CNPJ ou CPF completos de um cliente sem formatação.<br>CPNJ: 14 digitos. No EBS essa informação, somente para CNPJ está prefixada com digito 0, retornando 15 caracteres.<br>CPF: 11 digitos.","example":"042591651006931"},"slipDueDate":{"description":"Data de vencimento do boleto no formato AAAA-MM-DD","type":"string","format":"datetime","example":"2021-11-03"},"slipType":{"description":"Tipo do boleto. Possíveis valores: \"A\" de Administrativo ou \"C\" de cobrança. Condição feita sobre o Nosso numero do Boleto. Quando este valor for nulo, trata-se de um boleto Administrativo, caso contrario, é um boleto de Cobrança.","type":"string","example":"C"},"slipStatus":{"description":"Status do Boleto. <br>Possiveis valores: <br>R - Retornado; <br>C - Cancelado; <br>E - Enviado;<br>G - Gerado","type":"string","example":"E"},"slipGranteeBankAccountId":{"type":"integer","format":"int64","description":"Id da conta do cedente bancario do boleto.","example":11639},"slipGrantee":{"type":"string","description":"Cedente do Boleto.","example":"CONSORCIO EMPREENDEDOR DO SHOPPING TAMBORE"},"slipOurNumber":{"description":"Nosso numero do boleto. Também usado para classificar o tipo do boleto. Quando este valor for nulo, é um boleto Administrativo, caso contrario, boleto de Cobrança.","type":"string","example":"109/20037330-5"},"slipBankNumber":{"type":"string","description":"Numero do banco do Boleto.","example":"341"},"slipLimitDate":{"description":"Data limite do boleto no formato AAAA-MM-DD","type":"string","format":"date","example":"2021-11-03"},"slipWriteLine":{"type":"string","description":"Linha do Boleto.","example":"34191.09107 00491.572939 80867.700009 8 48860002988405"},"slipBarCodeText":{"type":"string","description":"Codigo de barra do Boleto.","example":"34198488600029884051091000491572938086770000"},"remitId":{"type":"integer","format":"int64","description":"Id da remessa bancaria do boleto.","example":123},"batchId":{"type":"integer","format":"int64","description":"Id do lote do boleto.","example":321},"reportId":{"type":"integer","format":"int64","description":"Id de impressao do boleto.","example":321}}},"NonPaymentResponse":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfoNonPayment"},"data":{"type":"array","items":{"$ref":"#/components/schemas/NonPaymentItem"}}}},"PageInfoNonPayment":{"type":"object","properties":{"currentPage":{"description":"Número da página corrente","type":"integer","format":"int64","example":1},"pageSize":{"description":"Tamanho da página","type":"integer","format":"int64","example":20},"next":{"description":"Controle para identificar se possui regitros","type":"boolean","example":true}}},"NonPaymentItem":{"title":"NonPaymentItem","type":"object","properties":{"requestId":{"type":"integer","format":"int32","description":"ID da Requisição.","example":208528968},"mesAnoRef":{"type":"string","description":"Mês avaliado, no formato MM-AAAA.","example":"04-2020"},"dataRef":{"type":"string","format":"datetime","description":"Data de referência do processamento, no formato DD/MM/YYYY.","example":"01/04/2020"},"shopping":{"type":"string","description":"Nome do shopping.","example":"NORTESHOPPING"},"codEmpresa":{"type":"string","description":"Código da empresa no módulo GL do Oracle EBS.","example":"6001"},"empresa":{"type":"string","description":"Tipo de empresa onde a transação foi criada, com os valores CG, FPP ou EMPREENDEDOR.","example":"CG"},"agrupador":{"type":"string","description":"Agrupamento dos registros, com os valores CONDOMINIO, FUNDO, EMPREENDEDOR, CONFISSAO, LUCS_CORP, LUCS_JURIDICO ou SHOPPING.","example":"CONFISSAO"},"contaReceber":{"type":"string","description":"Conta contábil da classe Contas a Receber da transação.","example":"618199988"},"contaReceita":{"type":"string","description":"Conta contábil da classe Conta de Receita da transação.","example":"618199989"},"contaAjuste":{"type":"string","description":"Conta contábil utilizada no ajuste.","example":"618199990"},"nomeIndicador":{"type":"string","description":"Nome do indicador ao qual o registro pertente, com os valores FAT_MES, REC_ATE_VENC, REC_MES, REC_LIQ, REC_MES_PROJETADO, REC_LIQ_PROJETADO, LUCS_INAD_NEG ou LUCS_INAD_NAO_NEG.","example":"FAT_MES"},"corporativo":{"type":"string","enum":["Sim","Não"],"description":"Indicador para saber se a parcela da transação pertence a cobrança corporativa ou não.","example":"Não"},"juridico":{"type":"string","enum":["Sim","Não"],"description":"Indicador para saber se a parcela da transação está com algum processo no jurídico ou não.","example":"Não"},"origem":{"type":"string","enum":["DM","CM","ADJ","REC","BOLBA"],"description":"Informa de qual base de dados a parcela da transação foi obtida, com os valores DM (Aviso de Debito), CM (Aviso de Crédito), REC (Recebimento), BOLBA (Base de boletos) ou ADJ (Ajustes).","example":"BOLBA"},"nrTransacao":{"type":"string","description":"Número da transação e sequência da parcela, caso exista mais de uma.","example":"29658"},"nrTransacaoAplicada":{"type":"string","description":"Quando a origem for dos tipos CM (Aviso de Crédito), REC (Recebimento) ou ADJ (Ajustes), informa o número da transação e sequência da parcela aplicada.","example":"29659"},"tipoReceita":{"type":"string","description":"Tipo de receita da transação, com os valores ALMIN, ALPERC, CONDDC, FPPCO, etc.","example":"MERCHAN"},"dataGl":{"type":"string","format":"datetime","description":"Data GL das parcelas das transações ou do recebimento, no formato DD/MM/YYYY.","example":"01/04/2020"},"dataCompetencia":{"type":"string","format":"datetime","description":"Data de Competência das transações, no formato DD/MM/YYYY.","example":"01/04/2020"},"vctoParcela":{"type":"string","format":"datetime","description":"Data de vencimento da parcela da transação, no formato DD/MM/YYYY.","example":"01/04/2020"},"vctoBoleto":{"type":"string","format":"datetime","description":"Data de vencimento do boleto ativo, quando aplicável, no formato DD/MM/YYYY.","example":"01/04/2020"},"numeroBoleto":{"type":"integer","format":"int32","description":"Número do boleto ativo, quando aplicável.","example":123036999},"dataAplicacao":{"type":"string","format":"datetime","description":"Data em que o ajuste, aviso de crédito ou recebimento foi aplicado na parcela da transação, no formato DD/MM/YYYY.","example":"01/04/2020"},"valor":{"type":"integer","format":"int32","description":"Valor original da parcela da transação, valor do ajuste, valor do aviso de crédito ou recebimento aplicado na parcela da transação ou saldo em aberto da parcela da transação.","example":16.11},"saldoAberto":{"type":"integer","format":"int32","description":"Valor em aberto da parcela da transação no momento do processamento da solicitação concorrente BRM - Cobrança - Resumo de Inadimplência.","example":16.11},"tendencia":{"type":"string","enum":["Sim","Não"],"description":"Indicador para saber se a parcela da transação está tendenciada ou não.","example":"Y"},"tipoAjusteCredito":{"type":"string","description":"Nome do tipo de ajuste, aviso de crédito ou método de recebimento aplicado na parcela da transação","example":"ESTORNO NEGOCIACAO"},"razaoSocial":{"type":"string","description":"Razão Social do Cliente.","example":"LOJA XPTO LDTA."},"loja":{"type":"string","description":"Código do local de faturamento do cliente da transação.","example":"SIP00357"},"inicioCnpj":{"type":"string","description":"Inicio do CNPJ ou CPF do cliente da transação.","example":"999276555"},"meioCnpj":{"type":"string","description":"Meio do CNPJ do cliente da transação. Aplicável somente se for PJ.","example":"0001"},"dvCnpj":{"type":"string","description":"Dígitos verificadores do CNPJ ou CPF do cliente da transação.","example":"99"},"nomeFantasia":{"type":"string","description":"Nome do Destinatário do endereço do local do cliente da transação.","example":"XPTO"},"paymentScheduleId":{"type":"integer","format":"int64","description":"ID da parcela da transação.","example":47763024},"appliedPaymentScheduleId":{"type":"integer","format":"int64","description":"ID da parcela da transação que recebeu a aplicação do Aviso de Crédito ou Recebimento.","example":42066823}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api-gtw.integracao.brmalls.com.br/token","scopes":{}}}}}},"security":[{"oauth2":[]}]}