Configuration¶
Introducer¶
Get your Office ID(s)¶
Depending on your set up in SieSmart you may have one or more offices. 'Offices' don't just refer to physical locations, they may be used to assign different configurations for different industries, for example.
[
{
"id": 1,
"name": "ACME Industries - Commercial Brokers",
"postalAddress": {
...
}
},
{
"id": 2,
"name": "ACME Industries - Machine Tools",
"postalAddress": {
...
}
}
]
Get your Sales contact IDs¶
When creating a proposal, you have to set the sales person who is creating the deal*. Omitting this will set the sales person to the generic API User.
Sales people could vary across offices (if you have more than one office), so a required parameter is the office ID.
* Mandatory in all countries except UK
[
{
"id": 23076571,
"firstName": "API",
"lastName": "TechUser",
"title": {
"id": 45,
"name": "Ms"
},
"email": "api-user@siemens.com",
"phone": null,
"cellPhone": "",
"fax": null,
"role": {
"alias": "ROC_SAM",
"name": "Sales Manager"
},
"blocked": false,
"blockedReason": null,
"loginPresent": true,
"officeIds": [1234]
}
]
Assets¶
To create a proposal for most financial products, at least one asset is necessary. These are added to the proposal using their unique IAC code. The list of IAC codes that are available to you are dependent on the office, as different offices may deal with different sectors
[
{
"iacCode": "ITE2201",
"name": "Desktop standalone PC"
},
{
"iacCode": "ITE",
"name": "Computer Equipment"
}
]
Calculation¶
To create a calculation (and a proposal), there are several configurations that you will need to use. In general, these are the available market products, pricelists, payment methods, terms etc.
These configurations can vary across offices, so it is important you check the config endpoint to make sure you can successfully create a calculation.
{
"config": {
"officeId": 0,
"office": {
...
},
"marketProducts": [
...
],
"pricelists": [
{
"id": 0,
"name": "string"
}
],
"paymentPeriods": [
"MONTHLY",
"BIMONTHLY",
"QUARTER",
"TRIANNUALLY",
"HALFANNUALLY",
"ANNUALLY",
null
],
"paymentMethods": [
{
"id": 0,
"name": "string"
}
],
"currency": {
"currencyCode": "string",
"format": "string",
"fractionDigits": 0
},
"interestRateConfig": {
"min": 0,
"max": 0,
"fractionDigits": 0
},
"tariffConfig": {
"fractionDigits": 0,
"fractionDigitsNordics": 0
},
"assetValueConfig": {
"min": 0,
"max": 0
},
"residualValueConfig": {
"percentageMin": 0,
"percentageMax": 0,
"readonly": true
},
"termConfig": {
"min": 0,
"max": 0
},
"postponedStartAffectedParties": [
{
"id": 0,
"name": "string"
}
],
"commissionTypes": [
{
"id": 0,
"name": "string",
"readonly": true,
"editable": true
}
],
"feeTypes": [
{
"id": 0,
"name": "string",
"readonly": true,
"editable": true,
"code": "string"
}
],
"specialPaymentTypes": [
{
"id": 0,
"name": "string",
"readonly": true,
"editable": true,
"downPaymentType": true,
"code": "string"
}
],
"allowedOperations": [
"CALC_RENTAL"
],
"autoCalculateVat": true
},
"calculationSheet": {
...
}
}
| Name | Type | Description |
|---|---|---|
| officeId | Integer | The office that this configuration is valid for |
| office | object | Details about the office |
| marketProducts | object array | see Market products |
| priceLists | object array | see Price lists |
| paymentPeriods | object array | see Payment periods |
Market products¶
We offer different market products for financing, for example Leasing (fixed and minimum term), hire purchase. This array will show what products you are able to use.
{
"marketProducts": [
{
"id": 0,
"name": "string",
"loanOrHirePurchaseInNordics": true,
"hpAnnuityOrStraightAmortization": true,
"hirePurchaseInNordics": true
}
]
}
| Name | Type | Description |
|---|---|---|
| id | Integer | Unique ID of the product. Necessary for proposal creation |
| name | string | Name of the product (eg. HP) |
| loanOrHirePurchaseInNordics | boolean | TODO |
| hpAnnuityOrStraightAmortization | boolean | TODO |
| hirePurchaseInNordics | boolean | TODO |
Price lists¶
Typically there is one price list for an office, but there could be more than one, for instance for different market products. The price list affects the calculation.
Payment periods¶
The available payment periods.
Community
Connect and Collaborate with Industrial Professionals and Join the Community!