Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Operation

Criar operação

Esta rota serve para criar operações de antecipação com os recebíveis selecionados.

post/operations

Request body

AgreementIdstring

Identificador do convênio

ExternalIdstring

Identificador do parceiro para envios de hooks

TaxIdCounterpartystring

Cnpj/Cpf do tomador do emprestimo

Termnumber

Quatidade de parcelas

TotalAmountnumber double

Valor total do Empréstimo + Juros + Comissao + Impostos. Soma de todas as PMTs

Amountnumber double

Valor do emprestimo

Ratenumber double

Substituido por "Interest"."PreIndexRate"

AssignmentRatenumber double

Taxa da cessão

Taxnumber double

Valor de imposto aplicada. IOF

Arrearsnumber double

Mora

Penaltynumber double

Multa

LatePaymentRatenumber double

Substituido por "LatePaymentCharges"."PreIndexRate" Taxa de juros por atraso

Chargesnumber double

Valor dos Encargos. Soma dos FEEs/Ágio/Deságio

Cetnumber double

Custo Efetivo Total

BaseDayCountnumber

Substituido por "Interest"."BaseDayCount"

AcquisitionAmountnumber double

Valor de aquisição da operação. Amount + FEEs + Ágio/Deságio

ClientNetAmountnumber double

Valor liquido desembolsado para a contraparte do emprestimo

BaseDatestring date

Start Accrual da operação

SettlementDatestring date

Data de vencimento da operação. End Accrual da operação

FundingDatestring date

Data de Liquidacao para a contraparte

FirtsInstallmentDatestring date

Data de end accrual da primeira parcela

OperationTypestring

Tipo do operação. Ex: NEW, PORTABILITY, REFINANCING.

WarrantyIdentificationstring

Identificador da garantia

Example request

{
  "AgreementId": "XXXXXXXXXXXXXXXXXX",
  "ExternalId": "IDENTIFICADOR_UNICO_PARCEIRO",
  "TaxIdCounterparty": "XXXXXXXXXXX",
  "TotalAmount": 10.01,
  "Interest": {
    "PreIndexRate": 0.0225,
    "PosIndexPercentage": 1,
    "BaseDayCount": 30
  },
  "LatePaymentCharges": {
    "PreIndexRate": 0.0225,
    "PosIndexPercentage": 1
  },
  "Amount": 10.01,
  "AssignmentRate": 0.0247,
  "Tax": 10.01,
  "Arrears": 0.01,
  "Penalty": 0.02,
  "LatePaymentRate": 0.02,
  "Charges": 10.01,
  "Cet": 0.0369,
  "BaseDayCount": 30,
  "AcquisitionAmount": 10.01,
  "ClientNetAmount": 10.01,
  "OperationType": "NEW",
  "Settlement": {
    "Account": {
      "BankCode": "208",
      "Agency": "0001",
      "DigitAgency": "2",
      "Number": "22501",
      "DigitAccount": "3"
    }
  },
  "Disbursement": {
    "Type": "Corrente",
    "Account": {
      "BankCode": "208",
      "Agency": "0001",
      "DigitAgency": "2",
      "Number": "22501",
      "DigitAccount": "3"
    },
    "AdditionalDisbursements": [
      {
        "Type": "SSIS",
        "TaxId": "XXXXXXXXXXX",
        "Account": {
          "BankCode": "208",
          "Agency": "0001",
          "DigitAgency": "2",
          "Number": "22501",
          "DigitAccount": "3"
        }
      }
    ]
  },
  "Contract": {
    "ExternalId": "IDENTIFICADOR_UNICO_PARCEIRO",
    "Number": "NUMERO_CONTRATO",
    "Guarantees": [
      {
        "Name": "NOME_AVALISTA",
        "TaxId": "XXXXXXXXXXX",
        "Amount": 10.01
      }
    ],
    "EmissionType": "CARTULAR"
  },
  "Installments": [
    {
      "Code": 1,
      "Amortization": 10.01,
      "Amount": 10.01,
      "Interest": 10.01,
      "Tax": 0.63
    }
  ],
  "OtherFees": [
    {
      "Type": "BROKER",
      "Value": 10.01
    }
  ],
  "Fees": [
    {
      "Type": "TAC",
      "Value": 10.01
    }
  ],
  "GenericIdentifiers": [
    {
      "Type": "IPOC",
      "Value": "XXXXXXXXXXXXXXXXXX"
    }
  ],
  "RelatedOperations": [
    {
      "PositionAmount": 100.25,
      "PositionDate": "2024-01-01",
      "ContractNumber": "NUMERO_CONTRATO"
    }
  ],
  "WarrantyIdentification": "cfd57a8d-20b6-45d3-8c4e-bd688425e31a"
}

Response

Sucesso

operationIdinteger

Id da Operação

Example response

{
  "receivableErrors": [
    {
      "receivable": {
        "identification": "5120070562"
      }
    }
  ]
}