amortizationTypeReceivablesAdvanceCCB

Tipo de operação · ReceivablesAdvance

Antecipação de Recebíveis (desconto a valor presente, metodologia FGTS desacoplada do saldo FGTS) — Payload e campos

Quais campos envio em cada objeto.

Campos do cálculo

São 17 campos no total, 1 obrigatório(s), organizados da base comum até o que é exclusivo deste tipo. Só o que se aplica a ele aparece aqui.

Identificação, início e taxa

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`amortizationType`	`string`	opcional	Indica o tipo de tabela de amortização utilizada	—	`"texto"`
`startDate`	`string (date-time)`	opcional	Data de início	—	`"2025-08-11T13:45:00Z"`
`apr`	`number (double)`	opcional	Taxa de Juros	—	`1.99`
`includePaymentFixedCosts`	`boolean`	opcional	Incluir valor da parcela fixa na simulação	—	`true`
`validationErrors`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`agentCommissions`	`array de objeto`	opcional	Comissões devidas ao CORBAN/Parceiro originador da operação. Utilizado para compor o Custo de Emissão (TAC), observados os limites estabelecidos no produto	objeto — ver detalhe abaixo	`[ … ]`
`agentCommission`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`

Valor, IOF e indexador

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`financeTaxExempted`	`boolean`	opcional	Isenção de IOF	—	`true`
`fiduciaryGuarantee`	`number (double)`	opcional	Percentual de Garantia fiduciária	—	`1000`
`indexer`	`string`	opcional	Indexador Pós-Fixado que deve ser aplicado à cada parcela	—	`"texto"`
`indexerValue`	`number (double)`	opcional	Percentual Indexador Pós-fixado que deve ser aplicado à cada parcela	—	`1000`

Forma de cálculo do valor

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`calculateByValueType`	`string`	opcional	—	`Gross`, `Liquid`, `Payment`	`"Gross"`

Valor de referência, prazo e vencimento exclusivo deste tipo

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`requestedAmount`	`integer (int64)`	opcional	Valor de referência (parcela, bruto ou líquido conforme calculateByValueType), em centavos.	—	`0`
`numberOfPayments`	`integer`	opcional	Quantidade de parcelas (prazo).	—	`0`
`firstPaymentDate`	`string (date-time)`	obrigatório	Data de vencimento da primeira parcela.	—	`"2025-08-11T13:45:00Z"`
`periodicity`	`string`	opcional	—	`Monthly`, `Yearly`, `Daily`	`"Monthly"`

Regras e valores aceitos

Os campos abaixo aceitam um conjunto fechado de valores. A lista é a do contrato para este tipo — outros tipos podem aceitar conjuntos diferentes.

`calculateByValueType`

Valor	Significado
`Gross`	Valor bruto - O valor de principal informado será considerado o valor de face da dívida emitida, sem realizar o financiamento das tarifas (TACs e IOF). O valor líquido final será menor que o valor do principal.
`Liquid`	Valor líquido - O valor de principal informado será considerado o valor líquido final desejado pelo tomador. Para tanto, será realizado o financiamento das tarifas (TACs e IOF), majorando o valor de face da dívida emitida.
`Payment`	Valor da parcela - o valor da parcela que será pago pelo cliente em cada vencimento. Só é válido para cálculos do tipo PRICE

`periodicity`

Valor	Significado
`Monthly`	Mensal
`Yearly`	Anual
`Daily`	Daily

Exemplo de objeto de cálculo

Gerado do contrato. Valores são amostras: troque pelos dados reais da operação.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amortizationType": "texto",
  "startDate": "2025-08-11T13:45:00Z",
  "apr": 1.99,
  "includePaymentFixedCosts": true,
  "validationErrors": [
    {
      "memberNames": [
        "Fulano de Tal"
      ],
      "errorMessage": "texto"
    }
  ],
  "agentCommissions": [
    {
      "name": "Fulano de Tal",
      "amount": 1000,
      "type": "Absolute",
      "baseValue": "InitialValue",
      "chargeCommissionFrom": "All",
      "financeCost": true
    }
  ],
  "agentCommission": {
    "name": "Fulano de Tal",
    "amount": 1000,
    "type": "Absolute",
    "baseValue": "InitialValue",
    "chargeCommissionFrom": "All",
    "financeCost": true,
    "totalValue": 0
  },
  "requestedAmount": 0,
  "financeTaxExempted": true,
  "fiduciaryGuarantee": 1000,
  "indexer": "texto",
  "indexerValue": 1000,
  "calculateByValueType": "Gross",
  "numberOfPayments": 0,
  "firstPaymentDate": "2025-08-11T13:45:00Z",
  "periodicity": "Monthly"
}

Campos da garantia

A garantia vai na lista warranty do mesmo corpo de criação, ao lado do objeto de cálculo. Cada item leva o discriminador warrantyType, e uma operação pode ter mais de uma garantia.

Antecipação de recebíveis — `Factoring`

Antecipação de recebíveis: recebíveis cedidos como garantia, com registradora, arranjo de pagamento, método de divisão e indicação de recebível performado.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Vínculo e valor da margem

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`employeeCode`	`string`	opcional	—	—	`"texto"`
`admissionDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`totalValue`	`number (double)`	opcional	Valor total	—	`1000`

Registro e arranjo de recebíveis

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`register`	`string`	opcional	Registradora	—	`"texto"`
`type`	`string`	opcional	—	`Collateral`, `OwnershipChange`	`"Collateral"`
`splitMethodType`	`string`	opcional	—	`Percentage`, `Absolute`	`"Percentage"`
`paymentNetworks`	`array de string`	opcional	Arranjos de pagamento	—	`[ … ]`
`constituted`	`boolean`	opcional	Tipo de recebível Performado	—	`true`

`splitMethodType`

Valor	Significado
`Percentage`	Percentual
`Absolute`	Valor Fixo

`type`

Valor	Significado
`Collateral`	Garantia
`OwnershipChange`	Troca de Titularidade

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "employeeCode": "texto",
  "admissionDate": "2025-08-11T13:45:00Z",
  "totalValue": 1000,
  "register": "texto",
  "type": "Collateral",
  "splitMethodType": "Percentage",
  "paymentNetworks": [
    "texto"
  ],
  "constituted": true
}

Desconto de duplicatas — `InvoiceFactoring`

Desconto de duplicatas: uma duplicata por garantia, com pagador, número, valor de face, valor presente, desconto e vencimento.

Tipo de garantia

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`warrantyType`	`string`	opcional	—	`Warranty`, `Vehicle`, `HomeEquity`, `JudiciaryProcess`, `Factoring`, `PublicPayroll`, `InvoiceFactoring`, `Consortium`, `DataprevEmployee`, `Load`, `DataprevEmployeeRefinance`, `CarEquity`, `DataprevInss`, `BenefitCardRegistration`	`"Warranty"`

Dados da duplicata e do pagador

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`payerName`	`string`	opcional	Nome do pagador	—	`"Fulano de Tal"`
`payerRegistrationNumber`	`integer (int64)`	opcional	CPF/CNPJ do pagador	—	`0`
`contractNumber`	`string`	opcional	Número do contrato	—	`"texto"`
`invoiceNumber`	`string`	opcional	Número da duplicata	—	`"texto"`
`invoiceValue`	`integer (int64)`	opcional	Valor da duplicata	—	`0`
`discountValue`	`integer (int64)`	opcional	Valor de desconto	—	`0`
`presentValue`	`integer (int64)`	opcional	Valor presente	—	`0`
`dueDate`	`string (date-time)`	opcional	Data de vencimento	—	`"2025-08-11T13:45:00Z"`
`paymentAmountInCents`	`integer (int64)`	opcional	Valor nominal no vencimento	—	`0`
`paymentItemIndex`	`integer`	opcional	Número da parcela	—	`0`
`paymentItemTotal`	`integer`	opcional	Total de parcelas	—	`0`
`yourNumber`	`string`	opcional	Seu número	—	`"texto"`
`storeCode`	`integer`	opcional	Código da loja	—	`0`
`productCode`	`integer`	opcional	Código do produto	—	`0`
`creditType`	`string`	opcional	—	`Duplicata_Mercantil`, `Duplicata`, `Nota_Promissória`, `Recibo`, `Nota_de_Seguro`, `Cheque`, `Duplicata_de_Serviço`, `Letras_de_Câmbio`, `CPR_Rural`, `CCB`, `Parcela_de_Contrato`, `Outros`	`"Duplicata_Mercantil"`
`identification`	`string`	opcional	Identificação	—	`"texto"`
`emissionDate`	`string (date-time)`	opcional	Data de emissão do título	—	`"2025-08-11T13:45:00Z"`
`index`	`integer`	opcional	Índice	—	`0`
`payerDescription`	`string`	opcional	—	`NaturalPerson`, `LegalPerson`	`"NaturalPerson"`
`payerAdress`	`string`	opcional	Endereço do pagador	—	`"texto"`
`payerZipCodeAdress`	`integer (int64)`	opcional	CEP do pagador	—	`0`
`contractFee`	`number (double)`	opcional	Taxa do contrato	—	`1000`

`creditType`

Valor	Significado
`Duplicata_Mercantil`	Duplicata_Mercantil
`Duplicata`	Duplicata
`Nota_Promissória`	Nota_Promissória
`Recibo`	Recibo
`Nota_de_Seguro`	Nota_de_Seguro
`Cheque`	Cheque
`Duplicata_de_Serviço`	Duplicata_de_Serviço
`Letras_de_Câmbio`	Letras_de_Câmbio
`CPR_Rural`	CPR_Rural
`CCB`	CCB
`Parcela_de_Contrato`	Parcela_de_Contrato
`Outros`	Outros

`payerDescription`

Valor	Significado
`NaturalPerson`	Natural Person
`LegalPerson`	Legal Person

`warrantyType`

Valor	Significado
`Warranty`	Garantia
`Vehicle`	Veículo
`HomeEquity`	Imóvel
`JudiciaryProcess`	Processo Judicial
`Factoring`	Antecipação de recebíveis
`PublicPayroll`	Consignado Público
`InvoiceFactoring`	Desconto de duplicatas
`Consortium`	Consórcio
`DataprevEmployee`	Crédito do Trabalhador
`Load`	Carga
`DataprevEmployeeRefinance`	Crédito Trabalhador Refinanciamento
`CarEquity`	Car Equity
`DataprevInss`	Consignado INSS
`BenefitCardRegistration`	Registro de Cartão de Benefício

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "payerName": "Fulano de Tal",
  "payerRegistrationNumber": 0,
  "contractNumber": "texto",
  "invoiceNumber": "texto",
  "invoiceValue": 0,
  "discountValue": 0,
  "presentValue": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "paymentAmountInCents": 0,
  "paymentItemIndex": 0,
  "paymentItemTotal": 0,
  "yourNumber": "texto",
  "storeCode": 0,
  "productCode": 0,
  "creditType": "Duplicata_Mercantil",
  "identification": "texto",
  "emissionDate": "2025-08-11T13:45:00Z",
  "index": 0,
  "payerDescription": "NaturalPerson",
  "payerAdress": "texto",
  "payerZipCodeAdress": 0,
  "contractFee": 1000
}

IntroduçãoO que é, quando usar e se exige garantia IntegraçãoComo integro, do zero à primeira operação Payload e camposQuais campos envio em cada objeto

Campos do cálculo

Identificação, início e taxa

Valor, IOF e indexador

Forma de cálculo do valor

Valor de referência, prazo e vencimento exclusivo deste tipo

Regras e valores aceitos

calculateByValueType

periodicity

Exemplo de objeto de cálculo

Campos da garantia

Antecipação de recebíveis — Factoring

Tipo de garantia

Vínculo e valor da margem

Registro e arranjo de recebíveis

splitMethodType

type

warrantyType

Exemplo do objeto de garantia

Desconto de duplicatas — InvoiceFactoring

Tipo de garantia

Dados da duplicata e do pagador

creditType

payerDescription

warrantyType

Exemplo do objeto de garantia

`calculateByValueType`

`periodicity`

Antecipação de recebíveis — `Factoring`

`splitMethodType`

`type`

`warrantyType`

Desconto de duplicatas — `InvoiceFactoring`

`creditType`

`payerDescription`

`warrantyType`