{"openapi":"3.0.0","info":{"title":"5.9.3 - Financial Reporting - BankSlip","description":"# **Esta API tem a função de relatório financeiro para fornecer dados apresentando resumos das atividades financeiras de boletos 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.0.0"},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/brmalls/5.9.3-FinancialReporting-BankSlip/1.0.0"},{"url":"https://services.brmalls.com.br/customer/FinancialReportingBankSlip/1.0.0"}],"tags":[{"name":"BankSlip"}],"paths":{"/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"}}}}}}}},"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"}}},"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"},"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"},"slipStatus":{"description":"Status do Boleto. <br>Possiveis valores: <br>R - Retornado; <br>C - Cancelado; <br>E - Enviado;<br>G - Gerado","type":"string","example":"E"}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://integration.brmalls.com.br/token","scopes":{}}}}}},"security":[{"oauth2":[]}]}