amortizationTypePriceCoefficientCCB

Tipo de operação · PriceCoefficient

Price Coeficiente — Payload e campos

Quais campos envio em cada objeto.

Campos do cálculo

São 22 campos no total, 0 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"`

Cronograma por dia de vencimento

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`requestedAmount`	`integer (int64)`	opcional	Valor solicitado	—	`0`
`paymentDay`	`integer`	opcional	Dia de vencimento	—	`0`
`absAmortizationInMonths`	`integer`	opcional	Carência de Principal	—	`0`
`absInterestInMonths`	`integer`	opcional	Carência de Juros	—	`0`
`periodicity`	`string`	opcional	—	`Monthly`, `Yearly`, `Daily`	`"Monthly"`
`daysInYear`	`integer`	opcional	Base de cálculo	—	`0`
`firstPaymentInterest`	`boolean`	opcional	Cobra juros na primeira parcela (em caso de ajuste de dia de vencimento)	—	`true`

Prazo e ajuste de vencimento exclusivo deste tipo

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`dueDateOnBusinessDays`	`boolean`	opcional	Datas de vencimento são ajustadas para o próximo dia útil	—	`true`
`termInMonths`	`integer`	opcional	Duração em meses	—	`0`

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",
  "paymentDay": 0,
  "absAmortizationInMonths": 0,
  "absInterestInMonths": 0,
  "periodicity": "Monthly",
  "daysInYear": 0,
  "firstPaymentInterest": true,
  "dueDateOnBusinessDays": true,
  "termInMonths": 0
}

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.

Veículo — `Vehicle`

Veículos (financiamento): o bem financiado é a garantia. Traz a ficha completa do veículo, o fornecedor/revenda, o valor de entrada e as UFs de emplacamento e de registro do gravame.

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 do veículo financiado

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`renavam`	`string`	opcional	RENAVAM do Veículo	—	`"texto"`
`typeOfVehicle`	`string`	opcional	Tipo do Veículo	—	`"texto"`
`chassis`	`string`	opcional	Chassi do Veículo	—	`"texto"`
`board`	`string`	opcional	Placa do Veículo	—	`"texto"`
`supplier`	`string`	opcional	Fornecedor do Veículo	—	`"texto"`
`taxNumberOfSupplier`	`string`	opcional	CNPJ do Fornecedor	—	`"texto"`
`brand`	`string`	opcional	Marca do Veículo	—	`"texto"`
`color`	`string`	opcional	Cor do Veículo	—	`"texto"`
`model`	`string`	opcional	Modelo do Veículo	—	`"texto"`
`yearOfManufacture`	`integer`	opcional	Ano de Fabricação do Veículo	—	`0`
`yearOfModel`	`integer`	opcional	Ano de Modelo do Veículo	—	`0`
`typeOfFuel`	`string`	opcional	Tipo de Combustível do Veículo	—	`"texto"`
`downPayment`	`integer (int64)`	opcional	Valor de entrada	—	`0`
`sellerCompanyName`	`string`	opcional	Revenda	—	`"Fulano de Tal"`
`sellerRegistrationNumber`	`string`	opcional	CNPJ de quem efetuou a venda	—	`"texto"`
`valueInCash`	`integer (int64)`	opcional	Valor veículo à vista	—	`0`
`subtotalAmount`	`integer (int64)`	opcional	Subtotal (Veículo + acessórios + outras despesas incluídas na operação a pedido do consumidor)	—	`0`
`totalAmountFinancedTaxFree`	`integer (int64)`	opcional	Valor total a ser financiado sem impostos	—	`0`
`plateState`	`string`	opcional	UF de emplacamento do veículo (sigla, ex.: "MG"). Origem do siglaEstadoPlaca no registro do gravame.	—	`"texto"`
`operationState`	`string`	opcional	UF da operação / Detran de registro do gravame (sigla, ex.: "MG"). Origem do siglaEstadoOperacao.	—	`"texto"`

`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

Consultas e ofertas próprias deste lastro

Use antes de criar a operação, para obter margem, ficha do bem ou ofertas elegíveis.

POST /v{version}/Amortization/VehicleOffersCria um novo registro de Amortization.
POST /v{version}/Amortization/VehicleOffersWithoutLTVCria um novo registro de Amortization.
GET /v{version}/Amortization/VehicleBrandsLista e filtra registros de Amortization.
GET /v{version}/Amortization/VehicleModelsLista e filtra registros de Amortization.
GET /v{version}/Amortization/VehicleByPlate/{plate}Consulta Amortization pelo identificador informado na rota.

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "renavam": "texto",
  "typeOfVehicle": "texto",
  "chassis": "texto",
  "board": "texto",
  "supplier": "texto",
  "taxNumberOfSupplier": "texto",
  "brand": "texto",
  "color": "texto",
  "model": "texto",
  "yearOfManufacture": 0,
  "yearOfModel": 0,
  "typeOfFuel": "texto",
  "downPayment": 0,
  "sellerCompanyName": "Fulano de Tal",
  "sellerRegistrationNumber": "texto",
  "valueInCash": 0,
  "subtotalAmount": 0,
  "totalAmountFinancedTaxFree": 0,
  "plateState": "texto",
  "operationState": "texto"
}

Car Equity — `CarEquity`

Veículos (crédito com garantia do veículo): o veículo do tomador lastreia crédito novo. Exige ficha do veículo completa e acompanha o status da vistoria veicular; o registro do gravame roda dentro da etapa de garantia.

Averbação: CarEquity. A operação passa pela etapa de garantia aguardando o retorno do órgão averbador antes de seguir na esteira.

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 do veículo e da vistoria

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`renavam`	`string`	obrigatório	RENAVAM do Veículo	—	`"texto"`
`typeOfVehicle`	`string`	obrigatório	Tipo do Veículo	—	`"texto"`
`chassis`	`string`	obrigatório	Chassi do Veículo	—	`"texto"`
`board`	`string`	obrigatório	Placa do Veículo	—	`"texto"`
`brand`	`string`	obrigatório	Marca do Veículo	—	`"texto"`
`color`	`string`	obrigatório	Cor do Veículo	—	`"texto"`
`model`	`string`	obrigatório	Modelo do Veículo	—	`"texto"`
`yearOfManufacture`	`integer`	obrigatório	Ano de Fabricação do Veículo	—	`0`
`yearOfModel`	`integer`	obrigatório	Ano de Modelo do Veículo	—	`0`
`typeOfFuel`	`string`	obrigatório	Tipo de Combustível do Veículo	—	`"texto"`
`inspectionId`	`string`	opcional	Id da Vistoria Veicular	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`inspectionStatus`	`string`	opcional	—	`WAITING_SOLICITATIONS`, `WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION`, `WAITING_FOR_INITIAL_API_QUERIES`, `WAITING_FOR_SCHEDULE`, `WAITING_FOR_ANALYSIS_OF_RECEIVED_INFORMATION`, `WAITING_FOR_ADDITIONAL_SOLICITATIONS`, `WAITING_FOR_RISK_ANALYSIS_API_QUERIES`, `WAITING_FOR_PROCESSING`, `PARTIALLY_RECEIVED`, `WAITING_FOR_RESCHEDULE`, `WAITING_FOR_RISK_ANALYSIS`, `WAITING_FOR_AUTOMATIC_ANALYSIS`, `APPROVED`, `DISAPPROVED` +8	`"WAITING_SOLICITATIONS"`
`inspectionUpdatedAt`	`string (date-time)`	opcional	Data Última Atualização da Vistoria Veicular	—	`"2025-08-11T13:45:00Z"`
`plateState`	`string`	opcional	UF de emplacamento do veículo (sigla, ex.: "MG"). Origem do siglaEstadoPlaca no registro do gravame.	—	`"texto"`
`operationState`	`string`	opcional	UF da operação / Detran de registro do gravame (sigla, ex.: "MG"). Origem do siglaEstadoOperacao.	—	`"texto"`

`inspectionStatus`

Valor	Significado
`WAITING_SOLICITATIONS`	WAITING_SOLICITATIONS
`WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION`	WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION
`WAITING_FOR_INITIAL_API_QUERIES`	WAITING_FOR_INITIAL_API_QUERIES
`WAITING_FOR_SCHEDULE`	WAITING_FOR_SCHEDULE
`WAITING_FOR_ANALYSIS_OF_RECEIVED_INFORMATION`	WAITING_FOR_ANALYSIS_OF_RECEIVED_INFORMATION
`WAITING_FOR_ADDITIONAL_SOLICITATIONS`	WAITING_FOR_ADDITIONAL_SOLICITATIONS
`WAITING_FOR_RISK_ANALYSIS_API_QUERIES`	WAITING_FOR_RISK_ANALYSIS_API_QUERIES
`WAITING_FOR_PROCESSING`	WAITING_FOR_PROCESSING
`PARTIALLY_RECEIVED`	PARTIALLY_RECEIVED
`WAITING_FOR_RESCHEDULE`	WAITING_FOR_RESCHEDULE
`WAITING_FOR_RISK_ANALYSIS`	WAITING_FOR_RISK_ANALYSIS
`WAITING_FOR_AUTOMATIC_ANALYSIS`	WAITING_FOR_AUTOMATIC_ANALYSIS
`APPROVED`	APPROVED
`DISAPPROVED`	DISAPPROVED
`SUBJECT_TO_ANALYSIS`	SUBJECT_TO_ANALYSIS
`CANCELED`	CANCELED
`OUT_OF_VALIDITY_DATE`	OUT_OF_VALIDITY_DATE
`WAITING_STATUS`	WAITING_STATUS
`UNDER_ANALYSIS`	UNDER_ANALYSIS
`OUT_OF_VALIDITY_DATE_WITHOUT_ANALYSIS`	OUT_OF_VALIDITY_DATE_WITHOUT_ANALYSIS
`PARTIALLY_RECEIVED_ADDITIONAL_SOLICITATIONS`	PARTIALLY_RECEIVED_ADDITIONAL_SOLICITATIONS
`WAITING_FOR_PROCESSING_ADDITIONAL_SOLICITATIONS`	WAITING_FOR_PROCESSING_ADDITIONAL_SOLICITATIONS

`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

Consultas e ofertas próprias deste lastro

Use antes de criar a operação, para obter margem, ficha do bem ou ofertas elegíveis.

POST /v{version}/Amortization/VehicleOffersCria um novo registro de Amortization.
GET /v{version}/Amortization/VehicleByPlate/{plate}Consulta Amortization pelo identificador informado na rota.

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "renavam": "texto",
  "typeOfVehicle": "texto",
  "chassis": "texto",
  "board": "texto",
  "brand": "texto",
  "color": "texto",
  "model": "texto",
  "yearOfManufacture": 0,
  "yearOfModel": 0,
  "typeOfFuel": "texto",
  "inspectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "inspectionStatus": "WAITING_SOLICITATIONS",
  "inspectionUpdatedAt": "2025-08-11T13:45:00Z",
  "plateState": "texto",
  "operationState": "texto"
}

Consignado INSS — `DataprevInss`

INSS: margem consignável do benefício previdenciário. Traz número e espécie do benefício, conta de pagamento, margem disponível, prazo máximo e o resultado do crivo de elegibilidade.

Averbação: SemearInss. A operação passa pela etapa de garantia aguardando o retorno do órgão averbador antes de seguir na esteira.

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`

Benefício INSS e margem

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`inss_RegistrationNumber`	`string`	opcional	CPF do beneficiário (11 dígitos).	—	`"texto"`
`inss_BenefitNumber`	`string`	opcional	Número do benefício (NB).	—	`"texto"`
`inss_Name`	`string`	opcional	Nome do beneficiário.	—	`"Fulano de Tal"`
`inss_BenefitType`	`string`	opcional	Espécie do benefício.	—	`"texto"`
`inss_BenefitTypeDescription`	`string`	opcional	Descrição da espécie do benefício.	—	`"texto"`
`inss_PaymentAccountType`	`string`	opcional	Tipo da conta bancária.	—	`"texto"`
`inss_PaymentAccountTypeDescription`	`string`	opcional	Descrição do tipo da conta bancária.	—	`"texto"`
`inss_PaymentBankCode`	`string`	opcional	Código do banco pagador.	—	`"texto"`
`inss_PaymentBankAgency`	`string`	opcional	Agência bancária.	—	`"texto"`
`inss_PaymentBankAccountNumber`	`string`	opcional	Número da conta bancária.	—	`"texto"`
`inss_AvailableMargin`	`number (double)`	opcional	Margem consignável disponível.	—	`1000`
`inss_OriginalMargin`	`number (double)`	opcional	Margem consignável original.	—	`1000`
`inss_MarginValue`	`number (double)`	opcional	Margem consignável utilizada na averbação.	—	`1000`
`inss_MaximumInstallments`	`integer`	opcional	Prazo máximo permitido.	—	`0`
`inss_IsIneligible`	`boolean`	opcional	Indica se o beneficiário é inelegível (resultado do crivo, vindo da consulta de margem).	—	`true`
`inss_IneligibilityReason`	`string`	opcional	Motivo da inelegibilidade do beneficiário.	—	`"texto"`

`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

Consultas e ofertas próprias deste lastro

Use antes de criar a operação, para obter margem, ficha do bem ou ofertas elegíveis.

POST /v{version}/Amortization/InssOffersCria um novo registro de Amortization.

Exemplo do objeto de garantia

{
  "warrantyType": "Warranty",
  "employeeCode": "texto",
  "admissionDate": "2025-08-11T13:45:00Z",
  "totalValue": 1000,
  "inss_RegistrationNumber": "texto",
  "inss_BenefitNumber": "texto",
  "inss_Name": "Fulano de Tal",
  "inss_BenefitType": "texto",
  "inss_BenefitTypeDescription": "texto",
  "inss_PaymentAccountType": "texto",
  "inss_PaymentAccountTypeDescription": "texto",
  "inss_PaymentBankCode": "texto",
  "inss_PaymentBankAgency": "texto",
  "inss_PaymentBankAccountNumber": "texto",
  "inss_AvailableMargin": 1000,
  "inss_OriginalMargin": 1000,
  "inss_MarginValue": 1000,
  "inss_MaximumInstallments": 0,
  "inss_IsIneligible": true,
  "inss_IneligibilityReason": "texto"
}

Consignado Público — `PublicPayroll`

Consignado público: averbação da margem do servidor no órgão empregador. Traz matrícula, código do órgão, código de averbação, dia do repasse, situação funcional e prazo limite de averbação.

Averbação: Siape. A operação passa pela etapa de garantia aguardando o retorno do órgão averbador antes de seguir na esteira.

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"`

Averbação no órgão público

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`employeeCode`	`string`	opcional	Código da Matrícula	—	`"texto"`
`agreementCode`	`string`	opcional	Código do Convênio	—	`"texto"`
`governmentDepartmentCode`	`string`	opcional	Código do Orgão	—	`"texto"`
`employeerInstCode`	`string`	opcional	Órgão + Matrícula do Instituidor	—	`"texto"`
`warrantyCode`	`string`	opcional	Código de averbação	—	`"texto"`
`paymentTransferDay`	`integer`	opcional	Dia do repasse	—	`0`
`paymentAmountInCents`	`integer (int64)`	opcional	Valor da Margem	—	`0`
`employmentStatusCode`	`string`	opcional	Código do tipo da situação funcional do vínculo funcional	—	`"texto"`
`employmentStatusDescription`	`string`	opcional	Descrição do tipo da situação funcional do vínculo funcional	—	`"texto"`
`previousAdeNumber`	`string`	opcional	Número ADE anterior	—	`"texto"`
`warrantyDeadline`	`string (date-time)`	opcional	Data limite de averbação	—	`"2025-08-11T13:45:00Z"`
`warrantyOption`	`string`	opcional	—	`None`, `FreeMargin`, `Portability`, `Peculio`	`"None"`
`simulationRegistrationNumber`	`string`	opcional	—	—	`"texto"`
`termInMonths`	`integer`	opcional	Prazo	—	`0`
`adeIdentifier`	`string`	opcional	Ade identificador da operação na zetra	—	`"texto"`
`governmentDepartmentWarrantyStatus`	`string`	opcional	—	`WaitingPurchase`, `WaitingBalance`, `WaitingPayment`, `WaitingLiquidation`, `Finished`, `Error`, `Deleted`, `Unified`, `WaitingForApproval`, `WaitingForPortedContractClosure`, `ConsentRefused`, `Canceled`, `PaymentRejection`	`"WaitingPurchase"`
`governmentDepartmentWarrantyStatusDisplay`	`string`	opcional	Descrição da situação	—	`"texto"`
`payingSourceRegistrationNumber`	`string`	opcional	—	—	`"texto"`
`payingSourceName`	`string`	opcional	Nome da Fonte Pagadora	—	`"Fulano de Tal"`

`governmentDepartmentWarrantyStatus`

Valor	Significado
`WaitingPurchase`	Aguardando Compra do Contrato
`WaitingBalance`	Aguardando Informação Saldo Devedor
`WaitingPayment`	Aguardando Pagamento Saldo Devedor
`WaitingLiquidation`	Aguardando Liberação da Margem
`Finished`	Averbado
`Error`	Erro
`Deleted`	Excluído
`Unified`	Contrato unificado
`WaitingForApproval`	Aguardando Anuência
`WaitingForPortedContractClosure`	Aguardando Encerramento do Contrato Portado
`ConsentRefused`	Anuência Recusada
`Canceled`	Cancelado
`PaymentRejection`	Rejeição de Pagamento do Saldo Devedor

`warrantyOption`

Valor	Significado
`None`	Nenhum
`FreeMargin`	Margem Livre
`Portability`	Portabilidade
`Peculio`	Pecúlio

`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",
  "agreementCode": "texto",
  "governmentDepartmentCode": "texto",
  "employeerInstCode": "texto",
  "warrantyCode": "texto",
  "paymentTransferDay": 0,
  "paymentAmountInCents": 0,
  "employmentStatusCode": "texto",
  "employmentStatusDescription": "texto",
  "previousAdeNumber": "texto",
  "warrantyDeadline": "2025-08-11T13:45:00Z",
  "warrantyOption": "None",
  "simulationRegistrationNumber": "texto",
  "termInMonths": 0,
  "adeIdentifier": "texto",
  "governmentDepartmentWarrantyStatus": "WaitingPurchase",
  "governmentDepartmentWarrantyStatusDisplay": "texto",
  "payingSourceRegistrationNumber": "texto",
  "payingSourceName": "Fulano de Tal"
}

Garantia — `Warranty`

Garantia genérica: registra apenas o tipo, sem campos específicos de bem ou margem. É o que se usa quando o lastro é descrito em texto livre no campo de garantia da operação.

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"`

`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"
}

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

Cronograma por dia de vencimento

Prazo e ajuste de vencimento exclusivo deste tipo

Regras e valores aceitos

calculateByValueType

periodicity

Exemplo de objeto de cálculo

Campos da garantia

Veículo — Vehicle

Tipo de garantia

Dados do veículo financiado

warrantyType

Consultas e ofertas próprias deste lastro

Exemplo do objeto de garantia

Car Equity — CarEquity

Tipo de garantia

Dados do veículo e da vistoria

inspectionStatus

warrantyType

Consultas e ofertas próprias deste lastro

Exemplo do objeto de garantia

Consignado INSS — DataprevInss

Tipo de garantia

Vínculo e valor da margem

Benefício INSS e margem

warrantyType

Consultas e ofertas próprias deste lastro

Exemplo do objeto de garantia

Consignado Público — PublicPayroll

Tipo de garantia

Averbação no órgão público

governmentDepartmentWarrantyStatus

warrantyOption

warrantyType

Exemplo do objeto de garantia

Garantia — Warranty

Tipo de garantia

warrantyType

Exemplo do objeto de garantia

`calculateByValueType`

`periodicity`

Veículo — `Vehicle`

`warrantyType`

Car Equity — `CarEquity`

`inspectionStatus`

`warrantyType`

Consignado INSS — `DataprevInss`

`warrantyType`

Consignado Público — `PublicPayroll`

`governmentDepartmentWarrantyStatus`

`warrantyOption`

`warrantyType`

Garantia — `Warranty`

`warrantyType`