{"openapi":"3.0.0","info":{"title":"1.2.7- Negotiation Generation - ERP Cloud","description":"# O objetivo desta integração é receber todos os dados de determinada negociação e realizar todas as operações de criação e ajustes de transações/parcelas no ERPCloud, assim como o processo de Aporte e Boletos.","version":"1.2.7"},"servers":[{"url":"https://gimidqzaexwf4t6fl7ypxsdom4.apigateway.us-ashburn-1.oci.customer-oci.com/api/debt-deal/1.0"}],"tags":[{"name":"Debt Deal"}],"paths":{"/generate-deal":{"post":{"tags":["Debt Deal"],"summary":"Gerir dados de uma determinada negociação no ERPCloud, Aporte e Boletos.","description":"Criar transações, ajustes e creditos no ERPCloud, para gestão dos dados de uma negociação, assim como gerir as parcelas aportadas e a gestão dos boletos. O Serviço é  assíncrono, e o retorno do processamento será provido por callback.","requestBody":{"description":"Dados para gerir uma negociação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebtDeal"}}}},"responses":{"202":{"description":"Requisição para criação de Negociação aceita com sucesso.","content":{}}},"callbacks":{"responseInvoiceBatch":{"{/invoices/callback}":{"post":{"requestBody":{"required":true,"description":"Callback com o resultado do processamento da negociação, informando no Summary Status o resultado geral do processamento. \n<br>Caso sucesso, summaryStatus = <b>SUCCESS</b. \n<br>Em caso de falha, summaryStatus = <b>FAILED</b>.\n<br>Em cada conjunto de dados retornado, haverá o campo de mensagem do erro durante o processamento.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CallbackDebtDeal"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}}}}}}},"components":{"schemas":{"DebtDeal":{"type":"object","required":["debtDeal"],"properties":{"debtDeal":{"type":"integer","description":"debtDeal","example":"1010"},"user":{"type":"string","description":"Número da Conta","example":"user"},"invoices":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"adjusts":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Adjust"}},"bindFinSupPaymentsRemaining":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/FinancialSupportRemaining"}},"unbindFinSupPayments":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/FinancialSupportAdjustment"}},"bankslipCancellations":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/BankslipCancellation"}},"bankslipCreations":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/Bankslip"}}}},"FinancialSupportAdjustment":{"type":"object","required":["sequence","financialSupport","payment"],"properties":{"sequence":{"type":"integer","description":"Sequencia do item na lista. É o sequencial enviado no payload. Utilizado como chave de identificação no retorno.","example":1},"financialSupport":{"type":"integer","format":"int64","description":"financialSupport","example":3907},"payment":{"type":"integer","format":"int64","description":"Id da parcela onde a alteração será realizada","example":30909092323238}}},"FinancialSupportRemaining":{"type":"object","required":["financialSupport","payment","financialSupportAmount"],"properties":{"financialSupport":{"type":"integer","format":"int64","description":"financialSupport","example":3907},"payment":{"type":"integer","format":"int64","description":"Id da parcela onde a alteração será realizada","example":30909092323238},"financialSupportAmount":{"type":"number","description":"Valor remanescente da parcela original, e que deve ser mantido na mesma parcela para o aporte correspondente","example":42.19}}},"Invoice":{"type":"object","required":["sequence","companyName","billCustomerAccountNumber","billCustomerSiteNumber","trxDate","competencyDate","glDate","term","custTrxTypeName","batchSourceName","amount","trxReference","listSlipRefId","lines"],"properties":{"sequence":{"type":"integer","description":"Sequencia do item na lista. É o sequencial da invoice enviado no payload. Utilizado como chave de identificação no retorno da criação.","example":1},"companyName":{"type":"string","description":"Nome da empresa (business Unit) no ERPCloud.","example":"SHOPPING TIJUCA - CONSORCIO"},"billCustomerAccountNumber":{"type":"string","description":"Número da Conta do Cliente da Faturamento.","example":"06077850"},"billCustomerSiteNumber":{"type":"string","description":"Número do Local (endereço) do Cliente de Faturamento","example":"06077850-STJ00028"},"trxDate":{"type":"string","description":"Data da Transação (formato YYYY-MM-DD) ","format":"date","example":"2019-11-28"},"competencyDate":{"type":"string","description":"Data Competência (formato YYYY-MM-DD) ","format":"date","example":"2019-11-28"},"glDate":{"type":"string","description":"Data Contábil (formato YYYY-MM-DD) ","format":"date","example":"2019-11-28"},"term":{"type":"string","description":"Nome da Condição de Pagamento (\"36X IGUAIS CDU\",\"A VISTA\", etc)","example":"A VISTA"},"custTrxTypeName":{"type":"string","description":"Nome do Tipo de Transação","example":"CANCELAMENTO"},"batchSourceName":{"type":"string","description":"Nome da Origem da Transação. A origem configurada deve ser do tipo Manual","example":"STJCG AUTO"},"amount":{"type":"number","description":"Valor","example":100.1},"trxReference":{"type":"string","description":"Descrição para o header da transação. Texto livre para identificar por ex. a negociação associada a transação. No ERPCloud valor atribuído ao atributo \"Comments\"","example":"Negociação associada a transação 1200"},"listSlipRefId":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/SlipPayment"}},"paymentsOrigLinkFinSupport":{"type":"array","items":{"type":"integer"},"description":"Lista de Parcelas a serem vinculadas ao Aporte sendo desvinculado no objeto finSupPayments","example":"[1233,223,323232,455454]"},"dueDate":{"type":"array","items":{"type":"string","format":"date"},"description":"Data de Vencimento das parcelas (formato YYYY-MM-DD)","example":"[\"2020-02-16\",\"2020-03-10\"]"},"lines":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/InvoiceLine"}}}},"InvoiceLine":{"type":"object","required":["lineDescription","memoLineName","quantity","revenueTypeCode","unitSellingPrice"],"properties":{"lineDescription":{"type":"string","description":"Descrição da Linha","example":"ALUGUEL MINIMO"},"memoLineName":{"type":"string","description":"Nome do Memo Line","example":"ALUGUEL MINIMO"},"quantity":{"type":"integer","description":"Quantidade","example":1},"revenueTypeCode":{"type":"string","description":"Tipo de Receita","example":"ADMCPI"},"unitSellingPrice":{"type":"number","description":"Valor Unitário da Linha. Se a transação tiver somente uma linha, valor igual ao amount ","example":100.1}}},"SlipPayment":{"type":"object","required":["paymentSeq","slipRefId"],"properties":{"paymentSeq":{"type":"number","description":"Sequencial da parcela gerada","example":1},"slipRefId":{"type":"string","description":"Identificador do Boleto","example":"Z2QCK"}}},"Adjust":{"type":"object","required":["sequence","paymentSchedule","adjustmentAmount","receivableTrx","adjustmentType","customerTrx","applyDate","company","setOfBooksId"],"properties":{"sequence":{"type":"integer","description":"Sequencia do item na lista. É o sequencial do ajuste enviado no payload. Utilizado como chave de identificação no retorno.","example":1},"paymentSchedule":{"type":"integer","format":"int64","description":"Id da parcela do contas a receber onde o ajuste será aplicado.","example":12345},"adjustmentAmount":{"type":"number","format":"double","description":"Valor do ajuste a ser criado.","example":"1500.00"},"receivableTrx":{"type":"integer","format":"int64","description":"Id (ERPCloud) da Atividade do Ajuste (valor definido conforme setup).","example":300000004699348},"adjustmentType":{"type":"string","description":"Tipo do ajuste a ser aplicado no contas a receber do cliente. Os valores possíveis são \"LINE\", \"TAX\", \"FREIGHT\" e \"INVOICE\".","example":"LINE"},"createdFrom":{"type":"string","description":"Tipo do usuário criador do ajuste.","example":"NEGOCIACAO"},"customerTrx":{"type":"integer","format":"int64","description":"Id do cabeçalho da transação.","example":12449},"applyDate":{"type":"string","description":"Data de Aplicação do Ajuste (formato YYYY-MM-DD) - Informar a maior data entre trxDate da Parcela e data atual. ","format":"date","example":"2019-11-28"},"glDate":{"type":"string","description":"Data Contábil (formato YYYY-MM-DD) - Informar a maior data entre trxDate da Parcela e data atual.","format":"date","example":"2019-11-28"},"company":{"type":"integer","description":"Identificador de empresa no ERP Cloud.","example":300000003777319},"setOfBooksId":{"type":"integer","description":"Identificador (ERPCloud) do Livro Fiscal associado a Atividade de Ajuste. Valor único para cada Atividade de Ajuste - informado na API get adjustment-type.","example":300000003791578}}},"BankslipCancellation":{"type":"object","required":["slip"],"properties":{"slip":{"type":"integer","format":"int64","example":3503343}}},"Bankslip":{"type":"object","required":["slipDueDate","slipType","slipLimitDate","username","slipComment","refId"],"properties":{"slipDueDate":{"type":"string","format":"date","description":"Data Vencimento (formato YYYY-MM-DD) "},"slipType":{"type":"string","enum":["C","A"]},"slipLimitDate":{"type":"string","format":"date","description":"Data Limite (formato YYYY-MM-DD) "},"username":{"type":"string","example":"brneg"},"slipComment":{"type":"string","example":"Não aceitar após data de vencimento"},"refId":{"type":"string","description":"Id de Referência para agrupamento de Boletos"},"paymentsOrig":{"type":"array","items":{"type":"integer"},"description":"Lista de parcelas originais a serem agrupadas no Boleto","example":"[323232,455454]"}}},"CallbackDebtDeal":{"type":"object","required":["debtDeal"],"properties":{"debtDeal":{"type":"integer","description":"debtDeal"},"summaryStatus":{"type":"string","description":"Status do processamento da negociação: ROLLBACK|SUCCESS|FAILED","example":"SUCCESS"},"summaryMessage":{"type":"string","description":"Caso ocorra erro no processo de negociação não específico a etapas do processo, será informado neste atributo.","example":"Negociação 2130 já enviada anteriormente."},"user":{"type":"string","description":"Número da Conta","example":"user"},"invoices":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/CallbackInvoice"}},"adjusts":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/CallbackAdjust"}},"finSupPayments":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/CallbackFinancialSupport"}},"bankslipCancellations":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/CallbackBankslipCancellation"}},"bankslipCreations":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/CallbackBankslip"}}}},"CallbackAdjust":{"type":"object","required":["customerTrx"],"properties":{"sequence":{"type":"integer","description":"Sequencia do item na lista. É o sequencial enviado no payload. Utilizado como chave de identificação no retorno.","example":1},"status":{"type":"string","description":"Status do processamento: SUCCESS|FAILED|ROLLBACK|NOT_EXECUTED","example":"SUCCESS"},"messageError":{"type":"string","description":"Mensagem de erro, caso ocorra"},"adjustment":{"type":"integer","format":"int64","description":"adjustment","example":300000006936864},"customerTrx":{"type":"integer","format":"int64","description":"Id do cabeçalho da transação.","example":12449}}},"CallbackBankslip":{"type":"object","properties":{"refId":{"type":"string","description":"Id de Referência para agrupamento de Boletos"},"status":{"type":"string","description":"Status do processamento: SUCCESS|FAILED|ROLLBACK|NOT_EXECUTED","example":"SUCCESS"},"messageError":{"type":"string","description":"Mensagem de erro, caso ocorra"},"slip":{"type":"integer","format":"int64","example":3503343},"slipNumber":{"type":"integer","format":"int64","example":123036635},"customer":{"type":"integer","format":"int64","example":7739},"luc":{"type":"string","example":"SNS0AE11"},"customerInscription":{"type":"string","example":"042591651006931"},"slipDueDate":{"type":"string","description":"Data (formato YYYY-MM-DD) "},"slipType":{"type":"string","enum":["C","A"],"example":"C"},"slipStatus":{"type":"string","enum":["R","C","E","G","UNKNOWN"],"example":"E"},"slipGranteeBankAccount":{"type":"number","example":11639},"slipGrantee":{"type":"string","example":"CONSORCIO EMPREENDEDOR DO SHOPPING TAMBORE"},"slipOurNumber":{"type":"string","example":"109/20037330-5"},"slipBankNumber":{"type":"string","example":"341"},"slipLimitDate":{"type":"string","description":"Data (formato YYYY-MM-DD) ","format":"date","example":"2019-11-28"},"slipWriteLine":{"type":"string","example":"34191.09107 00491.572939 80867.700009 8 48860002988405"},"slipBarCodeText":{"type":"string","example":"34198488600029884051091000491572938086770000"}}},"CallbackBankslipCancellation":{"type":"object","required":["slip"],"properties":{"status":{"type":"string","description":"Status do processamento: SUCCESS|FAILED|ROLLBACK|NOT_EXECUTED","example":"SUCCESS"},"messageError":{"type":"string","description":"Mensagem de erro, caso ocorra"},"slip":{"type":"integer","format":"int64","example":3503343}}},"CallbackFinancialSupport":{"type":"object","required":["financialSupport"],"properties":{"sequence":{"type":"integer","description":"Sequencia do item na lista. É o sequencial enviado no payload. Utilizado como chave de identificação no retorno.","example":1},"status":{"type":"string","description":"Status do processamento: SUCCESS|FAILED|ROLLBACK|NOT_EXECUTED","example":"SUCCESS"},"messageError":{"type":"string","description":"Mensagem de erro, caso ocorra"},"financialSupport":{"type":"integer","format":"int64","description":"financialSupport","example":3907},"payments":{"type":"array","items":{"type":"integer"},"description":"Lista de Parcelas vinculadas ao Aporte (novas e original)","example":"[1233,223,323232,455454]"}}},"CallbackInvoice":{"type":"object","required":["customerTrx"],"properties":{"sequence":{"type":"integer","description":"Sequencia do item na lista. É o sequencial enviado no payload. Utilizado como chave de identificação no retorno.","example":1},"status":{"type":"string","description":"Status do processamento: SUCCESS|FAILED|ROLLBACK|NOT_EXECUTED","example":"SUCCESS"},"messageError":{"type":"string","description":"Mensagem de erro, caso ocorra"},"customerTrx":{"type":"integer","description":"customerTrx","example":300000008051799},"trxNumber":{"type":"string","description":"trxNumber","example":123.7},"payments":{"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/CallbackPayment"}}}},"CallbackPayment":{"type":"object","required":["payment","dueDate","sequence"],"properties":{"payment":{"type":"integer","example":252897},"dueDate":{"type":"string","description":"dueDate (formato YYYY-MM-DD)","format":"date","example":"2019-11-28"},"sequence":{"type":"integer","example":2},"amountDueRemaining":{"description":"Amount Due Remaining","type":"number","example":987.9}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://idcs-f01737c604b644a8a96d7b3677fa5abe.identity.oraclecloud.com/oauth2/v1/token","scopes":{}}}}}},"security":[{"oauth2":[]}]}