{"openapi":"3.0.0","info":{"title":"5.9.3 - Financial Reporting - Payment","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.0.0"},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/brmalls/5.9.3-FinancialReporting-Payment/1.0.0"},{"url":"https://services.brmalls.com.br/customer/FinancialReportingPayment/1.0.0"}],"tags":[{"name":"PaymentInstallment"},{"name":"CustomerTrx"},{"name":"CustomerTrxType"}],"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"}}}}}}}},"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}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://integration.brmalls.com.br/token","scopes":{}}}}}},"security":[{"oauth2":[]}]}