Skip to content
API Registry
/
/
Get termination return pr...

Ledger/Sales service (1.0)

Using Swagger documentation in Postman


You can find instructions on how to convert swagger documentation to Postman collection here.
There is a known problem in Postman with env variables being imported as parameters (:schemaName instead of {{schemaName}}. More info on the issue can be found here.
Possible workaround is to find and replace all parameters with env variables inside Postman. For example search for :schemaName and replace with {{schemaName}}. Instructions how to do it in Postman are here.

Authorization

To obtain a token, start by visiting the identifier service documentation and make a request with your username and password.
Once you receive the response, copy the access_token and use it for making requests to ledger services.
Download OpenAPI description
bundled.json
bundled.yaml
Languages
Servers
Mock server

https://ledger.docs.insly.com/_mock/apis/ledger/bundled/

Beta

https://ledger.app.beta.insly.training/

Demo

https://ledger.app.demo.insly.com/

Quote Create

Operations

Quote Data

Operations

Quote Edit

Operations

Quote Calculation

Operations

Quote Documents

Operations

Quote Referrals

Operations

Quote Binding

Operations

Quote Issue

Operations

Policy Data

Operations

Policy Documents

Operations

Policy Termination

Operations

Get termination return premium

Request

Security
bearerAuth
Path
policyIdintegerrequired
Headers
X-TENANT-IDstringrequired

Tenant tag

Example: {$inputs.tenant}
Bodyapplication/jsonrequired
any

terminationSum needed in case of 'manual' type, shortRatePct is needed in case of 'short-rate' type

curl -i -X POST \
  'https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/policies/{policyId}/terminate/premiums' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-TENANT-ID: {$inputs.tenant}' \
  -d '{
    "policy": {
      "terminationDate": "2025-09-04",
      "terminationType": "pro-rata"
    }
  }'

Responses

A list of policy changes

Bodyapplication/json
Array of objects(policy-termination-premium-response)
Array [
[][].​policyobject
[][].​objectsArray of objects
]
Response
application/json
{
  "policy": {
    "terminationSum": -498.53,
    "returnAmount": -59.82
  }
}

Terminate policy with manual premium

Request

Security
bearerAuth
Path
policyIdintegerrequired
Headers
X-TENANT-IDstringrequired

Tenant tag

Example: {$inputs.tenant}
Bodyapplication/json
One of:
policyobject
policy.​terminationTypestring
Value"manual"
policy.​terminationDatestring(date)
policy.​financialsobject(financials-policy)
policy.​financials.​installmentsnumber
policy.​financials.​adminFeeSumnumber
policy.​financials.​feeVatPctnumber
objectsArray of objects
objects[].​idnumber
objects[].​productsobject
objects[].​products.​{productTag}object
curl -i -X POST \
  'https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/policies/{policyId}/terminate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-TENANT-ID: {$inputs.tenant}' \
  -d '{
    "policy": {
      "terminationType": "full-rollback",
      "terminationReason": "Optional reason"
    },
    "financials": {
      "adminFeeSum": 0
    }
  }'

Responses

Event id

Bodyapplication/json
event_idinteger
Example: "123"
Response
application/json
{
  "event_id": "123"
}

Schemes

Operations

Customers by identity

Operations

Payments

Operations

Invoice

Operations

Policy Technical MTA

Operations

Async Request

Operations