API V1
===
## Schema
### Payload Data
> Schematic of data sent from sunwise
>
```swift=
type SavingsTable {
period: String
typeOfPeriod: Int
energyCostSaving: Float
percentageTaxEnergyCostSaving: Float
}
type ClientLocation [
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32
]
type PayloadCreateData {
projectId*: String($uuid)
projectTitle*: String
integratorName*: String
integratorPhone: String
integratorMail*: String
clientName*: String
clientPhone: String
clientMail*: String
clientLocation*: Int(ClientLocation)
brandsModelsSystem*: String
numberSolarPanels*: Int
powerSolarPanelsKw*: Float
solarPanelYearsDuration*: Int
baseValueSystem*: Float
taxValueSystem*: Float
percentageDownPayment*: Float
savingsTable*: [SavingsTable]
}
type PayloadUpdateData {
projectTitle*: String
integratorName*: String
integratorPhone: String
integratorMail*: String
clientName*: String
clientPhone: String
clientMail*: String
clientLocation*: Int(ClientLocation)
brandsModelsSystem*: String
numberSolarPanels*: Int
powerSolarPanelsKw*: Float
solarPanelYearsDuration*: Int
baseValueSystem*: Float
taxValueSystem*: Float
percentageDownPayment*: Float
savingsTable*: [SavingsTable]
}
```
### Response Data
> Schema of the expected data by sunwise
```swift=
type TAmortizacionSummary {
total_capital: Float
sum_insurance_payment: Int
sum_rate: Float
sum_tax_payment: Float
total_payment_sum: Float
original_amount: Float
hitch_amount: Int
capital_amount: Float
loan_amount: Float
monthly_payment: Float
average_monthly_payment: Float
}
type TAmortizationTable {
month: Int
capital_payment: Float
insurance_payment: Int
rate: Float
tax_payment: Float
total_payment: Float
capital: Float
accumulated_capital: Float
month_payment: Float
}
type TInitialPayments {
concept: String
baseAmount: Float
taxAmount: Float
percentage: Int
}
type Result1 {
idQuote: Int
projectId: String
creationDate: String
accountExecutiveName: String
accountExecutivePhone: String
accountExecutiveMail: String
productName: String
loanAmount: Float
downPayment: Int
percentageDownPayment: Int
currency: String
typeInterestRate: String
financialInstrument: String
spreadInterestRate: Float
variableInterestRate: Float
term: Int
initialDate: String
firstPayment: String
lastPayment: String
quoteFilePDF: String(Base64PDF)
tAmortizacionSummary: TAmortizacionSummary
tAmortizationTable: [TAmortizationTable]
tInitialPayments: [TInitialPayments]
}
type ResponseData {
statusCodeError: Int
isSuccess: Boolean
result1: Result1
errorMessages: [String]
}
```
## Example
### Payload
```json=
{
"projectId": "4d4356b0-d7f1-4c90-8e39-8f42da8454d1",
"projectTitle": "SMX-T1",
"integratorName": "Kyle Armstrong",
"integratorPhone": "9991831741",
"integratorMail": "abner+company@sunwise.io",
"clientName": "DEMO ",
"clientPhone": "",
"clientMail": "abner+kyle@sunwise.io",
"clientLocation": 12,
"brandsModelsSystem": "107,AE Solar",
"numberSolarPanels": 107,
"powerSolarPanelsKw": 38.52,
"solarPanelYearsDuration": 178,
"baseValueSystem": 458802.71908,
"taxValueSystem": 73408.4350528,
"savingsTable": [
{
"period": "2022-01-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 38725.22473016441,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-02-22T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 46131.95022456732,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-03-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 45464.50734542453,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-04-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 40950.86388986074,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-05-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 42881.074070581984,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-06-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 43415.67828729277,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-07-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 38659.01510207649,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-08-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 39826.59960700109,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-09-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 41343.34792710771,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-10-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 41181.08296425524,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-11-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 37963.59872663836,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2022-12-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 41136.60281543999,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-01-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 41588.92320030567,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-02-22T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 49543.23955866959,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-03-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 48826.31309586129,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-04-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 43978.798992761585,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-05-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 46051.60870724205,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-06-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 46625.617245140274,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-07-24T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 41517.16030528907,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-08-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 42770.95367858934,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-09-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 44399.71657643687,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-10-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 44225.33866726857,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-11-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 40769.89806506425,
"percentageTaxEnergyCostSaving": 0.16
},
{
"period": "2023-12-23T00:00:00.000000",
"typeOfPeriod": 1,
"energyCostSaving": 44177.33577335039,
"percentageTaxEnergyCostSaving": 0.16
}
],
"percentageDownPayment": 0
}
```
### Response
```json=
{
"statusCodeError": 200,
"isSuccess": true,
"errorMessages": [],
"result1": {
"idQuote": 3584,
"projectId": "4d4356b0-d7f1-4c90-8e39-8f42da8454d1",
"creationDate": "2024-01-09T10:02:48",
"accountExecutiveName": "JORGE PANFILO DOMINGUEZ RAMIREZ DE AGUILAR",
"accountExecutivePhone": "5550034890",
"accountExecutiveMail": "sistemas@serfimexcapital.com.mx",
"productName": "CREDITO PANELES SOLARES",
"loanAmount": 478990.0387,
"downPayment": 0,
"percentageDownPayment": 0,
"currency": "PESOS",
"typeInterestRate": "VARIABLE",
"financialInstrument": "TIIE 28",
"spreadInterestRate": 8.9,
"variableInterestRate": 11.2867,
"term": 18,
"initialDate": "2024-01-09T00:00:00",
"firstPayment": "2024-02-01T00:00:00",
"lastPayment": "2025-07-01T00:00:00",
"tInitialPayments": [
{
"concept": "COMISION POR APERTURA",
"baseAmount": 15966.33,
"taxAmount": 2554.61,
"percentage": 3
}
],
"tAmortizationTable": [
{
"month": 1,
"capital_payment": 16690.02,
"insurance_payment": 0,
"rate": 6863.95,
"tax_payment": 1098.23,
"total_payment": 24652.2,
"capital": 532211.15,
"accumulated_capital": 16690.02,
"month_payment": 23553.97
},
{
"month": 2,
"capital_payment": 15170.82,
"insurance_payment": 0,
"rate": 8383.19,
"tax_payment": 1341.31,
"total_payment": 24895.32,
"capital": 515521.13,
"accumulated_capital": 31860.84,
"month_payment": 23554.01
},
{
"month": 3,
"capital_payment": 14856.39,
"insurance_payment": 0,
"rate": 8697.67,
"tax_payment": 1391.62,
"total_payment": 24945.68,
"capital": 500350.31,
"accumulated_capital": 46717.23,
"month_payment": 23554.06
},
{
"month": 4,
"capital_payment": 15386.87,
"insurance_payment": 0,
"rate": 8167.22,
"tax_payment": 1306.75,
"total_payment": 24860.84,
"capital": 485493.92,
"accumulated_capital": 62104.1,
"month_payment": 23554.09
},
{
"month": 5,
"capital_payment": 15382.11,
"insurance_payment": 0,
"rate": 8172.02,
"tax_payment": 1307.52,
"total_payment": 24861.65,
"capital": 470107.05,
"accumulated_capital": 77486.21,
"month_payment": 23554.13
},
{
"month": 6,
"capital_payment": 15904.48,
"insurance_payment": 0,
"rate": 7649.68,
"tax_payment": 1223.94,
"total_payment": 24778.1,
"capital": 454724.94,
"accumulated_capital": 93390.69,
"month_payment": 23554.16
},
{
"month": 7,
"capital_payment": 15925.96,
"insurance_payment": 0,
"rate": 7628.23,
"tax_payment": 1220.51,
"total_payment": 24774.7,
"capital": 438820.46,
"accumulated_capital": 109316.65,
"month_payment": 23554.19
},
{
"month": 8,
"capital_payment": 16202.8,
"insurance_payment": 0,
"rate": 7351.42,
"tax_payment": 1176.22,
"total_payment": 24730.44,
"capital": 422894.5,
"accumulated_capital": 125519.45,
"month_payment": 23554.22
},
{
"month": 9,
"capital_payment": 16712.51,
"insurance_payment": 0,
"rate": 6841.74,
"tax_payment": 1094.67,
"total_payment": 24648.92,
"capital": 406691.7,
"accumulated_capital": 142231.96,
"month_payment": 23554.25
},
{
"month": 10,
"capital_payment": 40328.94,
"insurance_payment": 0,
"rate": 6779.3,
"tax_payment": 1084.68,
"total_payment": 48192.92,
"capital": 389979.19,
"accumulated_capital": 182560.9,
"month_payment": 47108.24
},
{
"month": 11,
"capital_payment": 41226.04,
"insurance_payment": 0,
"rate": 5882.19,
"tax_payment": 941.15,
"total_payment": 48049.38,
"capital": 349650.25,
"accumulated_capital": 223786.94,
"month_payment": 47108.23
},
{
"month": 12,
"capital_payment": 41746.61,
"insurance_payment": 0,
"rate": 5361.62,
"tax_payment": 857.85,
"total_payment": 47966.08,
"capital": 308424.21,
"accumulated_capital": 265533.55,
"month_payment": 47108.23
},
{
"month": 13,
"capital_payment": 42472.29,
"insurance_payment": 0,
"rate": 4635.93,
"tax_payment": 741.74,
"total_payment": 47849.96,
"capital": 266677.6,
"accumulated_capital": 308005.84,
"month_payment": 47108.22
},
{
"month": 14,
"capital_payment": 43587.75,
"insurance_payment": 0,
"rate": 3520.42,
"tax_payment": 563.26,
"total_payment": 47671.43,
"capital": 224205.31,
"accumulated_capital": 351593.59,
"month_payment": 47108.17
},
{
"month": 15,
"capital_payment": 43968.27,
"insurance_payment": 0,
"rate": 3139.89,
"tax_payment": 502.38,
"total_payment": 47610.54,
"capital": 180617.56,
"accumulated_capital": 395561.86,
"month_payment": 47108.16
},
{
"month": 16,
"capital_payment": 44809.2,
"insurance_payment": 0,
"rate": 2298.91,
"tax_payment": 367.82,
"total_payment": 47475.93,
"capital": 136649.29,
"accumulated_capital": 440371.06,
"month_payment": 47108.11
},
{
"month": 17,
"capital_payment": 45511.49,
"insurance_payment": 0,
"rate": 1596.58,
"tax_payment": 255.45,
"total_payment": 47363.52,
"capital": 91840.09,
"accumulated_capital": 485882.55,
"month_payment": 47108.07
},
{
"month": 18,
"capital_payment": 46328.6,
"insurance_payment": 0,
"rate": 779.41,
"tax_payment": 124.7,
"total_payment": 47232.71,
"capital": 46328.6,
"accumulated_capital": 532211.15,
"month_payment": 47108.01
}
],
"tAmortizacionSummary": {
"total_capital": 532211.15,
"sum_insurance_payment": 0,
"sum_rate": 103749.37,
"sum_tax_payment": 16599.8,
"total_payment_sum": 652560.32,
"original_amount": 478990.0387,
"hitch_amount": 0,
"capital_amount": 478990.0387,
"loan_amount": 478990.0387,
"monthly_payment": 47108.24,
"average_monthly_payment": 36253.351111111115
},
"quoteFilePDF": "Base64PdfFile"
}
}
```