Benefit (INSS)
The Benefit entity is recovered from INSS institution. It represents a benefit received through INSS.
{
"id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
"itemId": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
"number": "000000721792794",
"type": "BENEFIT",
"beneficiaryName": "John Doe",
"marginBaseValue": 1000,
"availableMarginValue": 1000,
"usedMarginValue": 0,
"reservedMarginValue": 0,
"deductibleAvailableMarginValue": 1000,
"payingInstitution": {
"name": "Bank",
"code": "001",
"agency": "1234",
"account": "123456"
},
"loans": [
{
"contractCode": "123456",
"nominalInterestRate": 3,
"efectiveInterestRate": 10,
"cetAnnualRate": 12,
"cetMonthRate": 2,
"currencyCode": "BRL",
"amortizationRegime": "PRICE",
"operationHiringDate": "2021-01-01",
"installmentsQuantity": 12,
"installmentsValue": 1000,
"dueDateFirstInstallment": "2021-02-01",
"dueDateLastInstallment": "2022-01-01",
"cnpjCorrespondentBanking": "12345678901234",
"pdfContract": "cGRmIGV4YW1wbGU=",
"client": {
"document": "12345678901",
"name": "John Doe",
"phone": "11999999999",
"addressStreet": "Main Street",
"addressNumber": "123",
"addressCity": "Sao Paulo",
"addressZipCode": "12345678",
"addressState": "SP"
}
}
]
}
Property | Type | Optional | Description |
---|---|---|---|
id | string | No | Unique identifier of the Loan model |
itemId | string | No | Id of the item related to this loan |
number | string | No | Number of the benefit |
type | string | No | Benefit type supported |
beneficiaryName | string | No | Benefit Name |
marginBaseValue | number | Yes | Total benefit value |
availableMarginValue | number | Yes | Value available for new loan request. |
usedMarginValue | number | Yes | Value already used in a loan (consignated credit) |
reservedMarginValue | number | Yes | Value from the total available reserved not to be used. |
deductibleAvailableMarginValue | number | Yes | Total value available for getting credit. This value is 35% of the total benefit value (marginBaseValue) |
payingInstitution | object | Yes | PayingInstitutionType |
loans | array | Yes | BenefitLoanType |
Paying Institution
Property | Type | Optional | Description |
---|---|---|---|
name | string | Yes | Intitution's name in which which benefit is received |
code | string | Yes | Compe institution code |
agency | string | Yes | Bank agency number |
account | string | Yes | Bank account nunber |
Benefit Loan
Property | Type | Optional | Description |
---|---|---|---|
contractCode | string | No | Unique identifier for the contract |
cnpjOriginalContractCreditor | string | Yes | CNPJ (Brazilian company ID) of the original contract creditor |
effectiveInterestRate | number | Yes | Effective interest rate of the contract |
cetAnnualRate | number | Yes | Total Effective Cost (CET) annual rate |
cetMonthRate | number | Yes | Total Effective Cost (CET) month rate |
currencyCode | string | No | Currency code in which the contract is denominated |
amortizationRegime | string | Yes | Amortization regime of the loan |
operationHiringDate | string | No | Date when the contract was signed |
installmentsQuantity | number | No | Total number of installments for the loan |
installmentsValue | number | No | Value of each installment |
dueDateFirstInstallment | string | Yes | Due date of the first installment |
dueDateLastInstallment | string | Yes | Due date of the last installment |
cnpjCorrespondentBanking | string | Yes | CNPJ of the corresponding banking institution |
pdfContract | string | Yes | PDF Contract in base 64 |
client | object | No | ClientType |
Client
Property | Type | Optional | Description |
---|---|---|---|
document | string | No | Free field to complement the information regarding the Type of reference rate or indexer |
name | string | No | Client name in contract |
phone | string | Yes | Client phone in contract |
addressStreet | string | Yes | Address street name in contract |
addressNumber | string | Yes | Address number in contract |
addressCity | string | Yes | Address city in contract |
addressZipCode | string | Yes | Address zip code in contract |
addressState | string | Yes | Address state in contract |
Benefit types supported
These are the benefit types that we support and are the ones that could have payroll loans (Loans that are payed directly from the benefit). Here is all the existing benefit types.
Description |
---|
Aposentadoria por idade do trabalhador rural |
Aposentadoria por idade do empregador rural |
Aposentadoria por idade |
Aposentadoria por idade (Extinto Plano Básico) |
Aposentadoria por idade de ex-combatente marítimo (Lei nº 1.756/52) |
Aposentadoria por idade compulsória (Ex-SASSE) |
Aposentadoria por Invalidez |
Aposentadoria por invalidez do trabalhador rural |
Aposentadoria por invalidez do empregador rural |
Aposentadoria por invalidez previdenciária |
Aposentadoria por invalidez de aeronauta |
Aposentadoria por invalidez de ex-combatente marítimo (Lei nº 1.756/52) |
Aposentadoria por invalidez (Extinto Plano Básico) |
Aposentadoria por invalidez (Ex-SASSE) |
Aposentadoria por tempo de contribuição previdenciária |
Aposentadoria por tempo de contribuição de ex-combatente |
Aposentadoria por tempo de contribuição de aeronauta |
Aposentadoria por tempo de contribuição de jornalista profissional |
Aposentadoria por tempo de contribuição especial |
Aposentadoria por tempo de contribuição ordinária |
Aposentadoria por tempo de contribuição de professor (Emenda Const.18/81) |
Apos. por tempo de contribuição de ex-combatente marítimo (Lei 1.756/52) |
Aposentadoria por tempo de contribuição (Ex-SASSE) |
Pensão por morte do trabalhador rural |
Pensão por morte do empregador rural |
Pensão por morte previdenciária |
Pensão por morte de ex-combatente |
Pensão por morte de servidor público federal com dupla aposentadoria |
Pensão por morte do Regime Geral (Decreto nº 20.465/31) |
Pensão por morte de ex-combatente marítimo (Lei nº 1.756/52) |
Pensão por morte (Extinto Plano Básico) |
Pensão por morte (Ex-SASSE) |
Updated 5 months ago