Order-Service API Documentation API Reference

This document describes the hepster order api.

Version: 0.5

Authentication

basicAuth

type
basic

Paths

Retrieve order

GET /v1/orders/{id}

Fetches an existing order.

id: string (uuid)
in path

(no description)

200 OK
OrderDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "paymentReference": "string (uuid)",
  "orderNumber": "string",
  "salesPartnerId": "integer (int64)",
  "campaign": "string",
  "salesChannel": "string",
  "finalPrice": "number",
  "contract": {
    "installments": "integer (int32)",
    "type": "string",
    "shopperReference": "string (uuid)",
    "externalContractReference": "string"
  },
  "paymentMethod": "string",
  "paymentStatus": "string",
  "currencyCd": "string",
  "status": "BKD",
  "partnerId": "string (uuid)",
  "paymentCollection": "string",
  "customers": [
    {
      "id": "string (uuid)",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "hepNumber": "string",
      "birthDate": "string (date-time)",
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "email": "string",
      "countryCd": "string",
      "invoiceNumber": "string",
      "invoiceKey": "string",
      "cartItems": [
        {
          "id": "string (uuid)",
          "productId": "string (uuid)",
          "qualityId": "string (uuid)",
          "coverageSum": "number",
          "coverageDuration": "integer (int32)",
          "contractDuration": "integer (int32)",
          "coverageEndDate": "string (date-time)",
          "coverageAmount": "integer (int32)",
          "partners": [
            {
              "firstName": "string",
              "lastName": "string",
              "birthDate": "string (date-time)"
            }
          ],
          "durationTimeUnit": "string",
          "coverageType": "string",
          "price": "number",
          "originalPrice": "number",
          "certificateNumber": "string",
          "certificateKey": "string",
          "passkitKey": "string",
          "pibKey": "string",
          "policySummary": "string",
          "policyAttributes": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "variants": [
            {
              "key": "string",
              "value": "string",
              "options": [
                {
                  "id": "integer (int64)",
                  "key": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "contractStartDate": "string (date-time)",
          "contractEndDate": "string (date-time)",
          "customer": {
            "id": "string (uuid)",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "hepNumber": "string",
            "birthDate": "string (date-time)",
            "street": "string",
            "zipCode": "string",
            "city": "string",
            "email": "string",
            "countryCd": "string",
            "invoiceNumber": "string",
            "invoiceKey": "string",
            "cartItems": [
              {
                "id": "string (uuid)"
              }
            ]
          }
        }
      ]
    }
  ]
}
basicAuth

Get an existing contract

GET /v1/contracts/{contractId}

Get an existing contract.

contractId: string (uuid)
in path

(no description)

200 OK
ContractDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "certificateNumber": "string",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "type": "string",
  "status": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageSum": "number",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {}
            ]
          }
        ]
      }
    }
  ]
}
basicAuth

Cancel an active contract.

POST /v1/contracts/{contractId}/cancel

Cancel an active contract. There is no coverage anymore

ContractCancellationDto

undefined

contractId: string (uuid)
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "cancellationDate": "string (date-time)",
  "cancellationReason": "string"
}
200 OK
ContractDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "certificateNumber": "string",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "type": "string",
  "status": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageSum": "number",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {}
            ]
          }
        ]
      }
    }
  ]
}
basicAuth

Retrieve contracts of customer by email

GET /v1/contracts/lookup/email

Fetches all contracts of a customer by email.

email: string
in query

(no description)

200 OK
ContractDto

OK

type
ContractDto
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
[
  {
    "id": "string (uuid)",
    "certificateNumber": "string",
    "contractStartDate": "string (date-time)",
    "contractEndDate": "string (date-time)",
    "coverageAmount": "integer (int32)",
    "type": "string",
    "status": "string",
    "coverageDuration": "integer (int32)",
    "durationTimeUnit": "string",
    "coverageSum": "number",
    "cartItems": [
      {
        "id": "string (uuid)",
        "productId": "string (uuid)",
        "qualityId": "string (uuid)",
        "coverageSum": "number",
        "coverageDuration": "integer (int32)",
        "contractDuration": "integer (int32)",
        "coverageEndDate": "string (date-time)",
        "coverageAmount": "integer (int32)",
        "partners": [
          {
            "firstName": "string",
            "lastName": "string",
            "birthDate": "string (date-time)"
          }
        ],
        "durationTimeUnit": "string",
        "coverageType": "string",
        "price": "number",
        "originalPrice": "number",
        "certificateNumber": "string",
        "certificateKey": "string",
        "passkitKey": "string",
        "pibKey": "string",
        "policySummary": "string",
        "policyAttributes": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "variants": [
          {
            "key": "string",
            "value": "string",
            "options": [
              {
                "id": "integer (int64)",
                "key": "string",
                "value": "string"
              }
            ]
          }
        ],
        "contractStartDate": "string (date-time)",
        "contractEndDate": "string (date-time)",
        "customer": {
          "id": "string (uuid)",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "hepNumber": "string",
          "birthDate": "string (date-time)",
          "street": "string",
          "zipCode": "string",
          "city": "string",
          "email": "string",
          "countryCd": "string",
          "invoiceNumber": "string",
          "invoiceKey": "string",
          "cartItems": [
            {
              "id": "string (uuid)",
              "productId": "string (uuid)",
              "qualityId": "string (uuid)",
              "coverageSum": "number",
              "coverageDuration": "integer (int32)",
              "contractDuration": "integer (int32)",
              "coverageEndDate": "string (date-time)",
              "coverageAmount": "integer (int32)",
              "partners": [
                {
                  "firstName": "string",
                  "lastName": "string",
                  "birthDate": "string (date-time)"
                }
              ],
              "durationTimeUnit": "string",
              "coverageType": "string",
              "price": "number",
              "originalPrice": "number",
              "certificateNumber": "string",
              "certificateKey": "string",
              "passkitKey": "string",
              "pibKey": "string",
              "policySummary": "string",
              "policyAttributes": [
                null
              ]
            }
          ]
        }
      }
    ]
  }
]
basicAuth

Retrieve contracts of customer by organisation

GET /v1/contracts/lookup/organisation

Fetches all contracts of a customer by organisation.

organisation: string
in query

(no description)

subOrganisations: string[]
in query

(no description)

Array values passed as multiple parameters: ?subOrganisations=aaa&subOrganisations=bbb
page: integer (int32)
in query

(no description)

size: integer (int32)
in query

(no description)

status: string CANCELLED, ACTIVE, SUSPENDED, EXPIRED, PAYMENT_ERROR, REVIEW, RESTING
in query

(no description)

employeeLastName: string
in query

(no description)

contractStartDate: string
in query

(no description)

serialNumber: string
in query

(no description)

sortBy: string START_DATE, END_DATE, CREATED_DATE
in query

(no description)

sortDirection: string DESC, ASC
in query

(no description)

200 OK
PageableContractListDto

OK

type
PageableContractListDto
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
[
  {
    "contracts": [
      {
        "id": "string (uuid)",
        "certificateNumber": "string",
        "contractStartDate": "string (date-time)",
        "contractEndDate": "string (date-time)",
        "coverageAmount": "integer (int32)",
        "type": "string",
        "status": "string",
        "coverageDuration": "integer (int32)",
        "durationTimeUnit": "string",
        "coverageSum": "number",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "variants": [
              {
                "key": "string",
                "value": "string",
                "options": [
                  {
                    "id": "integer (int64)",
                    "key": "string",
                    "value": "string"
                  }
                ]
              }
            ],
            "contractStartDate": "string (date-time)",
            "contractEndDate": "string (date-time)",
            "customer": {
              "id": "string (uuid)",
              "firstName": "string",
              "lastName": "string",
              "company": "string",
              "hepNumber": "string",
              "birthDate": "string (date-time)",
              "street": "string",
              "zipCode": "string",
              "city": "string",
              "email": "string",
              "countryCd": "string",
              "invoiceNumber": "string",
              "invoiceKey": "string",
              "cartItems": [
                {
                  "id": "string (uuid)",
                  "productId": "string (uuid)",
                  "qualityId": "string (uuid)",
                  "coverageSum": "number",
                  "coverageDuration": "integer (int32)",
                  "contractDuration": "integer (int32)",
                  "coverageEndDate": "string (date-time)",
                  "coverageAmount": "integer (int32)",
                  "partners": [
                    {
                      "firstName": "string",
                      "lastName": "string",
                      "birthDate": "string (date-time)"
                    }
                  ],
                  "durationTimeUnit": "string",
                  "coverageType": "string",
                  "price": "number",
                  "originalPrice": "number",
                  "certificateNumber": "string",
                  "certificateKey": "string",
                  "passkitKey": "string",
                  "pibKey": "string"
                }
              ]
            }
          }
        ]
      }
    ]
  }
]
basicAuth

Retrieve contracts by policy attributes

GET /v1/contracts/lookup/policyattributes

Fetches all contracts by policy attributes.

200 OK
ContractDto

OK

type
ContractDto
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
[
  {
    "id": "string (uuid)",
    "certificateNumber": "string",
    "contractStartDate": "string (date-time)",
    "contractEndDate": "string (date-time)",
    "coverageAmount": "integer (int32)",
    "type": "string",
    "status": "string",
    "coverageDuration": "integer (int32)",
    "durationTimeUnit": "string",
    "coverageSum": "number",
    "cartItems": [
      {
        "id": "string (uuid)",
        "productId": "string (uuid)",
        "qualityId": "string (uuid)",
        "coverageSum": "number",
        "coverageDuration": "integer (int32)",
        "contractDuration": "integer (int32)",
        "coverageEndDate": "string (date-time)",
        "coverageAmount": "integer (int32)",
        "partners": [
          {
            "firstName": "string",
            "lastName": "string",
            "birthDate": "string (date-time)"
          }
        ],
        "durationTimeUnit": "string",
        "coverageType": "string",
        "price": "number",
        "originalPrice": "number",
        "certificateNumber": "string",
        "certificateKey": "string",
        "passkitKey": "string",
        "pibKey": "string",
        "policySummary": "string",
        "policyAttributes": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "variants": [
          {
            "key": "string",
            "value": "string",
            "options": [
              {
                "id": "integer (int64)",
                "key": "string",
                "value": "string"
              }
            ]
          }
        ],
        "contractStartDate": "string (date-time)",
        "contractEndDate": "string (date-time)",
        "customer": {
          "id": "string (uuid)",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "hepNumber": "string",
          "birthDate": "string (date-time)",
          "street": "string",
          "zipCode": "string",
          "city": "string",
          "email": "string",
          "countryCd": "string",
          "invoiceNumber": "string",
          "invoiceKey": "string",
          "cartItems": [
            {
              "id": "string (uuid)",
              "productId": "string (uuid)",
              "qualityId": "string (uuid)",
              "coverageSum": "number",
              "coverageDuration": "integer (int32)",
              "contractDuration": "integer (int32)",
              "coverageEndDate": "string (date-time)",
              "coverageAmount": "integer (int32)",
              "partners": [
                {
                  "firstName": "string",
                  "lastName": "string",
                  "birthDate": "string (date-time)"
                }
              ],
              "durationTimeUnit": "string",
              "coverageType": "string",
              "price": "number",
              "originalPrice": "number",
              "certificateNumber": "string",
              "certificateKey": "string",
              "passkitKey": "string",
              "pibKey": "string",
              "policySummary": "string",
              "policyAttributes": [
                null
              ]
            }
          ]
        }
      }
    ]
  }
]
basicAuth

Retrieve a certificate

GET /v1/orders/{orderId}/customers/{customerId}/cartitems/{cartItemId}/certificate

Fetches a certificate of a cart item of an existing order.

orderId: string (uuid)
in path

(no description)

customerId: string (uuid)
in path

(no description)

cartItemId: string (uuid)
in path

(no description)

200 OK

OK

type
string (byte)
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Content-Types: application/json, application/pdf
Response Example (200 OK) 
"string (byte)"
basicAuth

Update a certificate

PUT /v1/orders/{orderId}/customers/{customerId}/cartitems/{cartItemId}/certificate

Updates the certificate of a cart item of an existing order after changes to an order.

CertificateUpdateDto

undefined

orderId: string (uuid)
in path

(no description)

customerId: string (uuid)
in path

(no description)

cartItemId: string (uuid)
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "sendOrderConfirmation": true
}
200 OK

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized
basicAuth

Retrieve invoice

GET /v1/orders/{id}/invoice

Fetches an invoice of an existing order.

id: string (uuid)
in path

(no description)

200 OK

OK

type
string (byte)
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Content-Types: application/json, application/pdf
Response Example (200 OK) 
"string (byte)"
basicAuth

Retrieve a product information sheet

GET /v1/orders/{orderId}/customers/{customerId}/cartitems/{cartItemId}/pib

Fetches a product information sheet of a cart item of an existing order.

orderId: string (uuid)
in path

(no description)

customerId: string (uuid)
in path

(no description)

cartItemId: string (uuid)
in path

(no description)

200 OK

OK

type
string (byte)
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Content-Types: application/json, application/pdf
Response Example (200 OK) 
"string (byte)"
basicAuth

Retrieve orders

GET /v1/orders

Fetches all existing orders.

200 OK
OrderDto

OK

type
OrderDto
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
[
  {
    "id": "string (uuid)",
    "paymentReference": "string (uuid)",
    "orderNumber": "string",
    "salesPartnerId": "integer (int64)",
    "campaign": "string",
    "salesChannel": "string",
    "finalPrice": "number",
    "contract": {
      "installments": "integer (int32)",
      "type": "string",
      "shopperReference": "string (uuid)",
      "externalContractReference": "string"
    },
    "paymentMethod": "string",
    "paymentStatus": "string",
    "currencyCd": "string",
    "status": "BKD",
    "partnerId": "string (uuid)",
    "paymentCollection": "string",
    "customers": [
      {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "variants": [
              {
                "key": "string",
                "value": "string",
                "options": [
                  {
                    "id": "integer (int64)",
                    "key": "string",
                    "value": "string"
                  }
                ]
              }
            ],
            "contractStartDate": "string (date-time)",
            "contractEndDate": "string (date-time)",
            "customer": {
              "id": "string (uuid)",
              "firstName": "string",
              "lastName": "string",
              "company": "string",
              "hepNumber": "string",
              "birthDate": "string (date-time)",
              "street": "string",
              "zipCode": "string",
              "city": "string",
              "email": "string",
              "countryCd": "string",
              "invoiceNumber": "string",
              "invoiceKey": "string",
              "cartItems": [
                {}
              ]
            }
          }
        ]
      }
    ]
  }
]
basicAuth

Create an order

POST /v1/orders

Creates a new order.

OrderDto

undefined

Idempotency-Key: string
in header

(no description)

Request Content-Types: application/json
Request Example
{
  "id": "string (uuid)",
  "paymentReference": "string (uuid)",
  "salesPartnerId": "integer (int64)",
  "campaign": "string",
  "salesChannel": "string",
  "finalPrice": "number",
  "contract": {
    "installments": "integer (int32)",
    "type": "string",
    "shopperReference": "string (uuid)",
    "externalContractReference": "string"
  },
  "paymentMethod": "string",
  "paymentStatus": "string",
  "currencyCd": "string",
  "status": "BKD",
  "partnerId": "string (uuid)",
  "paymentCollection": "string",
  "customers": [
    {
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "hepNumber": "string",
      "birthDate": "string (date-time)",
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "email": "string",
      "countryCd": "string",
      "invoiceNumber": "string",
      "invoiceKey": "string",
      "cartItems": [
        {
          "productId": "string (uuid)",
          "qualityId": "string (uuid)",
          "coverageSum": "number",
          "coverageDuration": "integer (int32)",
          "contractDuration": "integer (int32)",
          "coverageEndDate": "string (date-time)",
          "coverageAmount": "integer (int32)",
          "partners": [
            {
              "firstName": "string",
              "lastName": "string",
              "birthDate": "string (date-time)"
            }
          ],
          "durationTimeUnit": "string",
          "coverageType": "string",
          "policyAttributes": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "variants": [
            {
              "key": "string",
              "value": "string",
              "options": [
                {
                  "id": "integer (int64)",
                  "key": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "contractStartDate": "string (date-time)",
          "frameworkContract": "string (uuid)",
          "createdDate": "string (date-time)"
        }
      ],
      "invoiceRecipient": "boolean",
      "confirmationRecipient": "boolean",
      "isInvoiceRecipient": "boolean",
      "isConfirmationRecipient": "boolean"
    }
  ],
  "vouchers": [
    {
      "token": "string"
    }
  ],
  "organisation": "string",
  "qualifiers": [
    {
      "key": "string",
      "value": "boolean"
    }
  ]
}
201 Created
OrderResponseDto

Created

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

409 Conflict

Conflict, e.g. when a request with an equal Idempotency-Key was made in the last 5 minutes

Response Example (201 Created) 
{
  "id": "string (uuid)",
  "orderDate": "string (date-time)"
}
basicAuth

Retrieve orders of customer

GET /v1/lookup/email

Fetches all orders of a customer by email.

email: string
in query

(no description)

200 OK
OrderDto

OK

type
OrderDto
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
[
  {
    "id": "string (uuid)",
    "paymentReference": "string (uuid)",
    "orderNumber": "string",
    "salesPartnerId": "integer (int64)",
    "campaign": "string",
    "salesChannel": "string",
    "finalPrice": "number",
    "contract": {
      "installments": "integer (int32)",
      "type": "string",
      "shopperReference": "string (uuid)",
      "externalContractReference": "string"
    },
    "paymentMethod": "string",
    "paymentStatus": "string",
    "currencyCd": "string",
    "status": "BKD",
    "partnerId": "string (uuid)",
    "paymentCollection": "string",
    "customers": [
      {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "variants": [
              {
                "key": "string",
                "value": "string",
                "options": [
                  {
                    "id": "integer (int64)",
                    "key": "string",
                    "value": "string"
                  }
                ]
              }
            ],
            "contractStartDate": "string (date-time)",
            "contractEndDate": "string (date-time)",
            "customer": {
              "id": "string (uuid)",
              "firstName": "string",
              "lastName": "string",
              "company": "string",
              "hepNumber": "string",
              "birthDate": "string (date-time)",
              "street": "string",
              "zipCode": "string",
              "city": "string",
              "email": "string",
              "countryCd": "string",
              "invoiceNumber": "string",
              "invoiceKey": "string",
              "cartItems": [
                {}
              ]
            }
          }
        ]
      }
    ]
  }
]
basicAuth

Retrieve orders of customer

GET /v1/lookup/hepNumber

Fetches all orders of a customer by hepNumber.

hepNumber: string
in query

(no description)

200 OK
OrderDto

OK

type
OrderDto
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
[
  {
    "id": "string (uuid)",
    "paymentReference": "string (uuid)",
    "orderNumber": "string",
    "salesPartnerId": "integer (int64)",
    "campaign": "string",
    "salesChannel": "string",
    "finalPrice": "number",
    "contract": {
      "installments": "integer (int32)",
      "type": "string",
      "shopperReference": "string (uuid)",
      "externalContractReference": "string"
    },
    "paymentMethod": "string",
    "paymentStatus": "string",
    "currencyCd": "string",
    "status": "BKD",
    "partnerId": "string (uuid)",
    "paymentCollection": "string",
    "customers": [
      {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "variants": [
              {
                "key": "string",
                "value": "string",
                "options": [
                  {
                    "id": "integer (int64)",
                    "key": "string",
                    "value": "string"
                  }
                ]
              }
            ],
            "contractStartDate": "string (date-time)",
            "contractEndDate": "string (date-time)",
            "customer": {
              "id": "string (uuid)",
              "firstName": "string",
              "lastName": "string",
              "company": "string",
              "hepNumber": "string",
              "birthDate": "string (date-time)",
              "street": "string",
              "zipCode": "string",
              "city": "string",
              "email": "string",
              "countryCd": "string",
              "invoiceNumber": "string",
              "invoiceKey": "string",
              "cartItems": [
                {}
              ]
            }
          }
        ]
      }
    ]
  }
]
basicAuth

Retrieve a pass kit

GET /v1/orders/{orderId}/customers/{customerId}/cartitems/{cartItemId}/passKitCertificate

Fetches a pass kit of a cart item of an existing order.

orderId: string (uuid)
in path

(no description)

customerId: string (uuid)
in path

(no description)

cartItemId: string (uuid)
in path

(no description)

200 OK

OK

type
string (byte)
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Content-Types: application/json, application/vnd.apple.pkpass
Response Example (200 OK) 
"string (byte)"
basicAuth

Retrieve orders

GET /v1/orders/report

Fetches a report over all existing orders.

200 OK
SalesReportDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "dataset": [
    {
      "date": "string (date-time)",
      "amount": "integer (int32)"
    }
  ]
}
basicAuth

Prolong insurance coverage

POST /v1/orders/{orderId}/customers/{customerId}/cartitems/{cartItemId}/prolong

Prolongs the duration of an insurance certificate. This creates a new order.

OrderProlongDto

undefined

orderId: string (uuid)
in path

(no description)

customerId: string (uuid)
in path

(no description)

cartItemId: string (uuid)
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "salesPartnerId": "integer (int64)",
  "campaign": "string",
  "paymentReference": "string (uuid)",
  "finalPrice": "number",
  "currencyCd": "string",
  "salesChannel": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "policyAttributes": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vouchers": [
    {
      "token": "string"
    }
  ]
}
200 OK
OrderResponseDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "orderDate": "string (date-time)"
}
basicAuth

Send an order confirmation email

POST /v1/order/{orderId}/cartitem/{cartItemId}/confirmation

Send an order confirmation mail to customer.

orderId: string (uuid)
in path

(no description)

cartItemId: string (uuid)
in path

(no description)

200 OK

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized
basicAuth

Update certificate.

POST /v1/contracts/{contractId}/suspend

Updates a certificate suspend date.

ContractSuspendDto

undefined

contractId: string (uuid)
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "suspendDate": "string (date-time)"
}
200 OK
ContractDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "certificateNumber": "string",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "type": "string",
  "status": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageSum": "number",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {}
            ]
          }
        ]
      }
    }
  ]
}
basicAuth

Update contract status.

POST /v1/contracts/{contractId}/status

Updates a contract's status

UpdateContractStatusDto

undefined

contractId: string (uuid)
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "contractStatusChangeDate": "string (date-time)",
  "updatedContractStatus": "string"
}
200 OK
ContractDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "certificateNumber": "string",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "type": "string",
  "status": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageSum": "number",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {}
            ]
          }
        ]
      }
    }
  ]
}
basicAuth

Updates a customer

POST /v1/contracts/{contractUUID}/cartItems/{cartItemUUID}/customers/{customerUUID}

Updates a customer, optionally sending an order confirmation.

CustomerPatchDto

undefined

contractUUID: string (uuid)
in path

(no description)

cartItemUUID: string (uuid)
in path

(no description)

customerUUID: string (uuid)
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "updateDocuments": "boolean",
  "sendOrderConfirmation": "boolean"
}
200 OK
CustomerDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "hepNumber": "string",
  "birthDate": "string (date-time)",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "email": "string",
  "countryCd": "string",
  "invoiceNumber": "string",
  "invoiceKey": "string",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string"
          }
        ]
      }
    }
  ]
}
basicAuth

Updates docs

POST /v1/orders/{orderId}/customers/{customerId}/cartitems/{cartItemId}/userDocuments

Uploads one document for a certain Product in a certain Order from a certain Customer

orderId: string (uuid)
in path

(no description)

customerId: string (uuid)
in path

(no description)

cartItemId: string (uuid)
in path

(no description)

attachment: file
in formData

(no description)

200 OK
DocumentUploadDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "success": "boolean",
  "code": "integer (int32)"
}
basicAuth

Update an order status

PATCH /v1/orders/{orderId}

Updates an order status.

OrderPatchDto

undefined

orderId: string (uuid)
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "status": "BKD",
  "successiveOrderId": "string (uuid)"
}
202 Accepted
OrderResponseDto

Accepted

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

409 Conflict

Conflict, e.g. when the order status was already set

Response Example (202 Accepted) 
{
  "id": "string (uuid)",
  "orderDate": "string (date-time)"
}
basicAuth

Generate a certificate

PUT /v1/documents/certificates

Creates a new certificate.

DocumentCertDto

undefined

Request Content-Types: application/json
Request Example
{
  "uuid": "string (uuid)",
  "certificateUUID": "string (uuid)",
  "orderDate": "string (date-time)",
  "salesChannel": "string",
  "certNumber": "string",
  "contractType": "string",
  "durationTimeUnit": "string",
  "coverageAmount": "integer (int32)",
  "currencyCd": "string",
  "customers": [
    {
      "uuid": "string (uuid)",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "birthDate": "string (date-time)",
      "hepNumber": "string",
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "countryCd": "string"
    }
  ],
  "partners": [
    {
      "firstName": "string",
      "lastName": "string",
      "birthDate": "string (date-time)"
    }
  ],
  "product": {
    "qualityName": "string",
    "productName": "string",
    "shortProductName": "string",
    "emergencyContactNumber": "string",
    "contractStartDate": "string (date-time)",
    "contractEndDate": "string (date-time)",
    "finalPrice": "number",
    "originalPrice": "number",
    "insuranceTax": "number",
    "taxRate": "number",
    "serviceFees": "number",
    "transferFees": "number",
    "insuranceFees": "number",
    "riskPremium": "number",
    "addPrice": "boolean",
    "damageReportHint": "string",
    "coverageType": "string",
    "coverageSum": "number",
    "insuranceBase": "string",
    "riskCarrierName": "string",
    "riskCarrierAddress": "string",
    "riskCarrierVatId": "string",
    "riskCarrierInsuranceTaxNumber": "string",
    "insuranceIntermediaryName": "string",
    "insuranceIntermediaryAddress": "string",
    "insuranceBenefits": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "pibHeadline": "string",
    "pib": {
      "title": "string",
      "productTitle": "string",
      "preliminaryNote": "string",
      "insuranceType": "string",
      "insured": "string",
      "notInsured": "string",
      "coverRestrictions": "string",
      "where": "string",
      "obligations": "string",
      "payment": "string",
      "coverageDates": "string",
      "cancellation": "string",
      "notes": "string"
    },
    "pibAttributes": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "coverageDuration": "integer (int32)",
    "durationTimeUnit": "string",
    "variants": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "insuranceUserFirstName": "string",
    "insuranceUserLastName": "string",
    "insuranceUserCompanyName": "string",
    "policyAttributes": [
      {
        "key": "string",
        "value": "string",
        "type": "string",
        "document": "boolean"
      }
    ]
  }
}
200 OK

OK

type
string (byte)
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Content-Types: application/json, application/pdf
Response Example (200 OK) 
"string (byte)"
basicAuth

Generate an invoice

PUT /v1/documents/invoices

Creates a new invoice.

DocumentOrderDto

undefined

Request Content-Types: application/json
Request Example
{
  "uuid": "string (uuid)",
  "salesChannel": "string",
  "orderNumber": "string",
  "invoiceNumber": "string",
  "orderDate": "string (date-time)",
  "finalPrice": "number",
  "originalPrice": "number",
  "insuranceTax": "number",
  "taxRate": "number",
  "serviceFees": "number",
  "transferFees": "number",
  "insuranceFees": "number",
  "riskPremium": "number",
  "discountAppliedAmount": "number",
  "currencyCd": "string",
  "customer": {
    "uuid": "string (uuid)",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "birthDate": "string (date-time)",
    "hepNumber": "string",
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "countryCd": "string"
  },
  "cartItems": [
    {
      "uuid": "string (uuid)",
      "productName": "string",
      "qualityName": "string",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "insuranceTax": "number",
      "taxRate": "number",
      "serviceFees": "number",
      "transferFees": "number",
      "insuranceFees": "number",
      "riskPremium": "number",
      "discountAppliedAmount": "number",
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "customer": {
        "uuid": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "birthDate": "string (date-time)",
        "hepNumber": "string",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "countryCd": "string"
      }
    }
  ]
}
200 OK

OK

type
string (byte)
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Content-Types: application/json, application/pdf
Response Example (200 OK) 
"string (byte)"
basicAuth

Generate a certificate

PUT /v1/documents/wallet

Creates a new certificate.

DocumentCertDto

undefined

Request Content-Types: application/json
Request Example
{
  "uuid": "string (uuid)",
  "certificateUUID": "string (uuid)",
  "orderDate": "string (date-time)",
  "salesChannel": "string",
  "certNumber": "string",
  "contractType": "string",
  "durationTimeUnit": "string",
  "coverageAmount": "integer (int32)",
  "currencyCd": "string",
  "customers": [
    {
      "uuid": "string (uuid)",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "birthDate": "string (date-time)",
      "hepNumber": "string",
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "countryCd": "string"
    }
  ],
  "partners": [
    {
      "firstName": "string",
      "lastName": "string",
      "birthDate": "string (date-time)"
    }
  ],
  "product": {
    "qualityName": "string",
    "productName": "string",
    "shortProductName": "string",
    "emergencyContactNumber": "string",
    "contractStartDate": "string (date-time)",
    "contractEndDate": "string (date-time)",
    "finalPrice": "number",
    "originalPrice": "number",
    "insuranceTax": "number",
    "taxRate": "number",
    "serviceFees": "number",
    "transferFees": "number",
    "insuranceFees": "number",
    "riskPremium": "number",
    "addPrice": "boolean",
    "damageReportHint": "string",
    "coverageType": "string",
    "coverageSum": "number",
    "insuranceBase": "string",
    "riskCarrierName": "string",
    "riskCarrierAddress": "string",
    "riskCarrierVatId": "string",
    "riskCarrierInsuranceTaxNumber": "string",
    "insuranceIntermediaryName": "string",
    "insuranceIntermediaryAddress": "string",
    "insuranceBenefits": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "pibHeadline": "string",
    "pib": {
      "title": "string",
      "productTitle": "string",
      "preliminaryNote": "string",
      "insuranceType": "string",
      "insured": "string",
      "notInsured": "string",
      "coverRestrictions": "string",
      "where": "string",
      "obligations": "string",
      "payment": "string",
      "coverageDates": "string",
      "cancellation": "string",
      "notes": "string"
    },
    "pibAttributes": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "coverageDuration": "integer (int32)",
    "durationTimeUnit": "string",
    "variants": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "insuranceUserFirstName": "string",
    "insuranceUserLastName": "string",
    "insuranceUserCompanyName": "string",
    "policyAttributes": [
      {
        "key": "string",
        "value": "string",
        "type": "string",
        "document": "boolean"
      }
    ]
  }
}
200 OK

OK

type
string (byte)
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Content-Types: application/json, application/pdf
Response Example (200 OK) 
"string (byte)"
basicAuth

Generate a pib

PUT /v1/documents/pibs

Creates a new PIB.

DocumentCertDto

undefined

Request Content-Types: application/json
Request Example
{
  "uuid": "string (uuid)",
  "certificateUUID": "string (uuid)",
  "orderDate": "string (date-time)",
  "salesChannel": "string",
  "certNumber": "string",
  "contractType": "string",
  "durationTimeUnit": "string",
  "coverageAmount": "integer (int32)",
  "currencyCd": "string",
  "customers": [
    {
      "uuid": "string (uuid)",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "birthDate": "string (date-time)",
      "hepNumber": "string",
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "countryCd": "string"
    }
  ],
  "partners": [
    {
      "firstName": "string",
      "lastName": "string",
      "birthDate": "string (date-time)"
    }
  ],
  "product": {
    "qualityName": "string",
    "productName": "string",
    "shortProductName": "string",
    "emergencyContactNumber": "string",
    "contractStartDate": "string (date-time)",
    "contractEndDate": "string (date-time)",
    "finalPrice": "number",
    "originalPrice": "number",
    "insuranceTax": "number",
    "taxRate": "number",
    "serviceFees": "number",
    "transferFees": "number",
    "insuranceFees": "number",
    "riskPremium": "number",
    "addPrice": "boolean",
    "damageReportHint": "string",
    "coverageType": "string",
    "coverageSum": "number",
    "insuranceBase": "string",
    "riskCarrierName": "string",
    "riskCarrierAddress": "string",
    "riskCarrierVatId": "string",
    "riskCarrierInsuranceTaxNumber": "string",
    "insuranceIntermediaryName": "string",
    "insuranceIntermediaryAddress": "string",
    "insuranceBenefits": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "pibHeadline": "string",
    "pib": {
      "title": "string",
      "productTitle": "string",
      "preliminaryNote": "string",
      "insuranceType": "string",
      "insured": "string",
      "notInsured": "string",
      "coverRestrictions": "string",
      "where": "string",
      "obligations": "string",
      "payment": "string",
      "coverageDates": "string",
      "cancellation": "string",
      "notes": "string"
    },
    "pibAttributes": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "coverageDuration": "integer (int32)",
    "durationTimeUnit": "string",
    "variants": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "insuranceUserFirstName": "string",
    "insuranceUserLastName": "string",
    "insuranceUserCompanyName": "string",
    "policyAttributes": [
      {
        "key": "string",
        "value": "string",
        "type": "string",
        "document": "boolean"
      }
    ]
  }
}
200 OK

OK

type
string (byte)
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Content-Types: application/json, application/pdf
Response Example (200 OK) 
"string (byte)"
basicAuth

Retrieve a contract

GET /v1/orders/{orderId}/customers/{customerId}/cartitems/{cartItemId}/contract

Fetches the contract corresponding to the current order and customer.

orderId: string (uuid)
in path

(no description)

customerId: string (uuid)
in path

(no description)

cartItemId: string (uuid)
in path

(no description)

200 OK
ContractDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "certificateNumber": "string",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "type": "string",
  "status": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageSum": "number",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {}
            ]
          }
        ]
      }
    }
  ]
}
basicAuth

Gets Change Payment link

GET /v1/contracts/{contractId}/paymentlink/{linkType}

Gets Change Payment link

contractId: string (uuid)
in path

(no description)

linkType: string DUNNING, NORMAL
in path

(no description)

eventDate: string
in query

(no description)

200 OK

OK

type
string
400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
"string"
basicAuth

Get an existing contract

GET /v1/contracts/certificatenumber/{certificateNumber}

Get an existing contract.

certificateNumber: string
in path

(no description)

200 OK
ContractDto

OK

400 Bad Request

Invalid data

401 Unauthorized

Not authorized

Response Example (200 OK) 
{
  "id": "string (uuid)",
  "certificateNumber": "string",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "type": "string",
  "status": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageSum": "number",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {}
            ]
          }
        ]
      }
    }
  ]
}
basicAuth

Schema Definitions

CartItemDto: object

id: string (uuid)
productId: string (uuid)
qualityId: string (uuid)
coverageSum: number x ≥ 0
coverageDuration: integer (int32) x ≥ 1
contractDuration: integer (int32)
coverageEndDate: string (date-time)
coverageAmount: integer (int32) x ≥ 1
partners: PartnerDto
PartnerDto
durationTimeUnit: string HOURS, DAYS, MONTHS, YEARS, END_DATE, MINUTES
coverageType: string THING, PERSON, EVENT
price: number
originalPrice: number
certificateNumber: string
certificateKey: string
passkitKey: string
pibKey: string
policySummary: string
policyAttributes: PolicyAttributeDto
PolicyAttributeDto
variants: VariantDto
VariantDto
contractStartDate: string (date-time)
contractEndDate: string (date-time)
customer: CustomerDto
userDocumentCount: integer (int32)
frameworkContract: string (uuid)
createdDate: string (date-time)
Example
{
  "id": "string (uuid)",
  "productId": "string (uuid)",
  "qualityId": "string (uuid)",
  "coverageSum": "number",
  "coverageDuration": "integer (int32)",
  "contractDuration": "integer (int32)",
  "coverageEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "partners": [
    {
      "firstName": "string",
      "lastName": "string",
      "birthDate": "string (date-time)"
    }
  ],
  "durationTimeUnit": "string",
  "coverageType": "string",
  "price": "number",
  "originalPrice": "number",
  "certificateNumber": "string",
  "certificateKey": "string",
  "passkitKey": "string",
  "pibKey": "string",
  "policySummary": "string",
  "policyAttributes": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "variants": [
    {
      "key": "string",
      "value": "string",
      "options": [
        {
          "id": "integer (int64)",
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "customer": {
    "id": "string (uuid)",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "hepNumber": "string",
    "birthDate": "string (date-time)",
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "email": "string",
    "countryCd": "string",
    "invoiceNumber": "string",
    "invoiceKey": "string",
    "cartItems": [
      {
        "id": "string (uuid)",
        "productId": "string (uuid)",
        "qualityId": "string (uuid)",
        "coverageSum": "number",
        "coverageDuration": "integer (int32)",
        "contractDuration": "integer (int32)",
        "coverageEndDate": "string (date-time)",
        "coverageAmount": "integer (int32)",
        "partners": [
          {
            "firstName": "string",
            "lastName": "string",
            "birthDate": "string (date-time)"
          }
        ],
        "durationTimeUnit": "string",
        "coverageType": "string",
        "price": "number",
        "originalPrice": "number",
        "certificateNumber": "string",
        "certificateKey": "string",
        "passkitKey": "string",
        "pibKey": "string",
        "policySummary": "string",
        "policyAttributes": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "variants": [
          {
            "key": "string",
            "value": "string",
            "options": [
              {
                "id": "integer (int64)",
                "key": "string",
                "value": "string"
              }
            ]
          }
        ],
        "contractStartDate": "string (date-time)"
      }
    ]
  }
}

ContractOrderDto: object

installments: integer (int32) 1 ≤ x ≤ 12
type: string RECURRING, SINGLE
shopperReference: string (uuid)
externalContractReference: string
Example
{
  "installments": "integer (int32)",
  "type": "string",
  "shopperReference": "string (uuid)",
  "externalContractReference": "string"
}

CustomerDto: object

id: string (uuid)
firstName: string
lastName: string
company: string
hepNumber: string
birthDate: string (date-time)
street: string
zipCode: string
city: string
email: string
countryCd: string
invoiceNumber: string
invoiceKey: string
cartItems: CartItemDto
CartItemDto
order: OrderDto
invoiceRecipient: boolean
confirmationRecipient: boolean
isInvoiceRecipient: boolean
isConfirmationRecipient: boolean
Example
{
  "id": "string (uuid)",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "hepNumber": "string",
  "birthDate": "string (date-time)",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "email": "string",
  "countryCd": "string",
  "invoiceNumber": "string",
  "invoiceKey": "string",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              null
            ]
          }
        ]
      }
    }
  ]
}

OptionDto: object

id: integer (int64)
key: string
value: string
Example
{
  "id": "integer (int64)",
  "key": "string",
  "value": "string"
}

OrderDto: object

id: string (uuid)
paymentReference: string (uuid)
orderNumber: string
salesPartnerId: integer (int64)
campaign: string
salesChannel: string
finalPrice: number
contract: ContractOrderDto
paymentMethod: string MASTERCARD, VISA, AMERICAN_EXPRESS, PAYPAL, SEPA_DIRECT_DEBIT, DIRECT_EBANKING, INVOICE, VOUCHER, SOFORT, APPLEPAY, GOOGLEPAY, AMAZONPAY
paymentStatus: string AUTHORISATION, PENDING, REFUND, CAPTURE_FAILED, CHARGEBACK, SECOND_CHARGEBACK, NOTIFICATION_OF_CHARGEBACK, CHARGEBACK_REVERSED, PAYMENT_ERROR
currencyCd: string
status: string PDG, BKD, CXL, CSD, PRL
partnerId: string (uuid)
paymentCollection: string DIRECT, PARTNER
customers: CustomerDto
CustomerDto
vouchers: VoucherDto
VoucherDto
orderDate: string (date-time)
createdDate: string (date-time)
organisation: string
qualifiers: QualifierDto
QualifierDto
Example
{
  "id": "string (uuid)",
  "paymentReference": "string (uuid)",
  "orderNumber": "string",
  "salesPartnerId": "integer (int64)",
  "campaign": "string",
  "salesChannel": "string",
  "finalPrice": "number",
  "contract": {
    "installments": "integer (int32)",
    "type": "string",
    "shopperReference": "string (uuid)",
    "externalContractReference": "string"
  },
  "paymentMethod": "string",
  "paymentStatus": "string",
  "currencyCd": "string",
  "status": "BKD",
  "partnerId": "string (uuid)",
  "paymentCollection": "string",
  "customers": [
    {
      "id": "string (uuid)",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "hepNumber": "string",
      "birthDate": "string (date-time)",
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "email": "string",
      "countryCd": "string",
      "invoiceNumber": "string",
      "invoiceKey": "string",
      "cartItems": [
        {
          "id": "string (uuid)",
          "productId": "string (uuid)",
          "qualityId": "string (uuid)",
          "coverageSum": "number",
          "coverageDuration": "integer (int32)",
          "contractDuration": "integer (int32)",
          "coverageEndDate": "string (date-time)",
          "coverageAmount": "integer (int32)",
          "partners": [
            {
              "firstName": "string",
              "lastName": "string",
              "birthDate": "string (date-time)"
            }
          ],
          "durationTimeUnit": "string",
          "coverageType": "string",
          "price": "number",
          "originalPrice": "number",
          "certificateNumber": "string",
          "certificateKey": "string",
          "passkitKey": "string",
          "pibKey": "string",
          "policySummary": "string",
          "policyAttributes": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "variants": [
            {
              "key": "string",
              "value": "string",
              "options": [
                {
                  "id": "integer (int64)",
                  "key": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "contractStartDate": "string (date-time)",
          "contractEndDate": "string (date-time)",
          "customer": {
            "id": "string (uuid)",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "hepNumber": "string",
            "birthDate": "string (date-time)",
            "street": "string",
            "zipCode": "string",
            "city": "string",
            "email": "string",
            "countryCd": "string",
            "invoiceNumber": "string",
            "invoiceKey": "string",
            "cartItems": [
              {
                "id": "string (uuid)",
                "productId": "string (uuid)"
              }
            ]
          }
        }
      ]
    }
  ]
}

PartnerDto: object

firstName: string
lastName: string
birthDate: string (date-time)
Example
{
  "firstName": "string",
  "lastName": "string",
  "birthDate": "string (date-time)"
}

PolicyAttributeDto: object

key: string
value: string
Example
{
  "key": "string",
  "value": "string"
}

QualifierDto: object

key: string
value: boolean
Example
{
  "key": "string",
  "value": "boolean"
}

VariantDto: object

key: string
value: string
options: OptionDto
OptionDto
Example
{
  "key": "string",
  "value": "string",
  "options": [
    {
      "id": "integer (int64)",
      "key": "string",
      "value": "string"
    }
  ]
}

VoucherDto: object

token: string
Example
{
  "token": "string"
}

ContractDto: object

id: string (uuid)
certificateNumber: string
contractStartDate: string (date-time)
contractEndDate: string (date-time)
coverageAmount: integer (int32)
type: string RECURRING, SINGLE
status: string CANCELLED, ACTIVE, SUSPENDED, EXPIRED, PAYMENT_ERROR, REVIEW, RESTING
coverageDuration: integer (int32)
durationTimeUnit: string HOURS, DAYS, MONTHS, YEARS, END_DATE, MINUTES
coverageSum: number
cartItems: CartItemDto
CartItemDto
organisation: string
frameworkContract: string (uuid)
cancellationDate: string (date-time)
suspendDate: string (date-time)
cancellationReason: string WITHDRAWAL, NONPAYMENT, LAPSEOFRISK, NEGLECTOFDUTY
contractPaymentEvents: ContractPaymentEventDto
ContractPaymentEventDto
Example
{
  "id": "string (uuid)",
  "certificateNumber": "string",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "type": "string",
  "status": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageSum": "number",
  "cartItems": [
    {
      "id": "string (uuid)",
      "productId": "string (uuid)",
      "qualityId": "string (uuid)",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "contractDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "certificateNumber": "string",
      "certificateKey": "string",
      "passkitKey": "string",
      "pibKey": "string",
      "policySummary": "string",
      "policyAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "variants": [
        {
          "key": "string",
          "value": "string",
          "options": [
            {
              "id": "integer (int64)",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "customer": {
        "id": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "hepNumber": "string",
        "birthDate": "string (date-time)",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "email": "string",
        "countryCd": "string",
        "invoiceNumber": "string",
        "invoiceKey": "string",
        "cartItems": [
          {
            "id": "string (uuid)",
            "productId": "string (uuid)",
            "qualityId": "string (uuid)",
            "coverageSum": "number",
            "coverageDuration": "integer (int32)",
            "contractDuration": "integer (int32)",
            "coverageEndDate": "string (date-time)",
            "coverageAmount": "integer (int32)",
            "partners": [
              {
                "firstName": "string",
                "lastName": "string",
                "birthDate": "string (date-time)"
              }
            ],
            "durationTimeUnit": "string",
            "coverageType": "string",
            "price": "number",
            "originalPrice": "number",
            "certificateNumber": "string",
            "certificateKey": "string",
            "passkitKey": "string",
            "pibKey": "string",
            "policySummary": "string",
            "policyAttributes": [
              {
                "key": "string"
              }
            ]
          }
        ]
      }
    }
  ]
}

ContractPaymentEventDto: object

id: string (uuid)
eventDate: string (date-time)
status: string AUTHORISED, DUNNING_1, DUNNING_2, PENDING, TERMINATED, PAYMENT_CHANGED
dunningFee: number
chargebackFee: number
orderId: string (uuid)
receivableId: string (uuid)
contractStatus: string CANCELLED, ACTIVE, SUSPENDED, EXPIRED, PAYMENT_ERROR, REVIEW, RESTING
Example
{
  "id": "string (uuid)",
  "eventDate": "string (date-time)",
  "status": "string",
  "dunningFee": "number",
  "chargebackFee": "number",
  "orderId": "string (uuid)",
  "receivableId": "string (uuid)",
  "contractStatus": "string"
}

ContractCancellationDto: object

cancellationDate: string (date-time)
cancellationReason: string WITHDRAWAL, NONPAYMENT, LAPSEOFRISK, NEGLECTOFDUTY
Example
{
  "cancellationDate": "string (date-time)",
  "cancellationReason": "string"
}

PageableContractListDto: object

contracts: ContractDto
ContractDto
totalPages: integer (int32)
totalElements: integer (int32)
currentPage: integer (int32)
currentPageSize: integer (int32)
Example
{
  "contracts": [
    {
      "id": "string (uuid)",
      "certificateNumber": "string",
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "type": "string",
      "status": "string",
      "coverageDuration": "integer (int32)",
      "durationTimeUnit": "string",
      "coverageSum": "number",
      "cartItems": [
        {
          "id": "string (uuid)",
          "productId": "string (uuid)",
          "qualityId": "string (uuid)",
          "coverageSum": "number",
          "coverageDuration": "integer (int32)",
          "contractDuration": "integer (int32)",
          "coverageEndDate": "string (date-time)",
          "coverageAmount": "integer (int32)",
          "partners": [
            {
              "firstName": "string",
              "lastName": "string",
              "birthDate": "string (date-time)"
            }
          ],
          "durationTimeUnit": "string",
          "coverageType": "string",
          "price": "number",
          "originalPrice": "number",
          "certificateNumber": "string",
          "certificateKey": "string",
          "passkitKey": "string",
          "pibKey": "string",
          "policySummary": "string",
          "policyAttributes": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "variants": [
            {
              "key": "string",
              "value": "string",
              "options": [
                {
                  "id": "integer (int64)",
                  "key": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "contractStartDate": "string (date-time)",
          "contractEndDate": "string (date-time)",
          "customer": {
            "id": "string (uuid)",
            "firstName": "string",
            "lastName": "string",
            "company": "string",
            "hepNumber": "string",
            "birthDate": "string (date-time)",
            "street": "string",
            "zipCode": "string",
            "city": "string",
            "email": "string",
            "countryCd": "string",
            "invoiceNumber": "string",
            "invoiceKey": "string",
            "cartItems": [
              {
                "id": "string (uuid)",
                "productId": "string (uuid)",
                "qualityId": "string (uuid)",
                "coverageSum": "number",
                "coverageDuration": "integer (int32)",
                "contractDuration": "integer (int32)",
                "coverageEndDate": "string (date-time)",
                "coverageAmount": "integer (int32)",
                "partners": [
                  {
                    "firstName": "string",
                    "lastName": "string",
                    "birthDate": "string (date-time)"
                  }
                ],
                "durationTimeUnit": "string",
                "coverageType": "string",
                "price": "number",
                "originalPrice": "number",
                "certificateNumber": "string",
                "certificateKey": "string",
                "passkitKey": "string",
                "pibKey": "string",
                "policySummary": "string",
                "policyAttributes": [
                  null
                ]
              }
            ]
          }
        }
      ]
    }
  ]
}

SalesReportDto: object

dataset: SalesReportLine
SalesReportLine
Example
{
  "dataset": [
    {
      "date": "string (date-time)",
      "amount": "integer (int32)"
    }
  ]
}

SalesReportLine: object

date: string (date-time)
amount: integer (int32)
Example
{
  "date": "string (date-time)",
  "amount": "integer (int32)"
}

OrderResponseDto: object

id: string (uuid)
orderDate: string (date-time)
Example
{
  "id": "string (uuid)",
  "orderDate": "string (date-time)"
}

OrderProlongDto: object

salesPartnerId: integer (int64)
campaign: string
paymentReference: string (uuid)
finalPrice: number
currencyCd: string
salesChannel: string
coverageDuration: integer (int32) x ≥ 1
durationTimeUnit: string HOURS, DAYS, MONTHS, YEARS, END_DATE, MINUTES
policyAttributes: PolicyAttributeDto
PolicyAttributeDto
vouchers: VoucherDto
VoucherDto
Example
{
  "salesPartnerId": "integer (int64)",
  "campaign": "string",
  "paymentReference": "string (uuid)",
  "finalPrice": "number",
  "currencyCd": "string",
  "salesChannel": "string",
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "policyAttributes": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vouchers": [
    {
      "token": "string"
    }
  ]
}

ContractSuspendDto: object

suspendDate: string (date-time)
Example
{
  "suspendDate": "string (date-time)"
}

UpdateContractStatusDto: object

contractStatusChangeDate: string (date-time)
updatedContractStatus: string CANCELLED, ACTIVE, SUSPENDED, EXPIRED, PAYMENT_ERROR, REVIEW, RESTING
Example
{
  "contractStatusChangeDate": "string (date-time)",
  "updatedContractStatus": "string"
}

CustomerPatchDto: object

firstName: string
lastName: string
email: string
updateDocuments: boolean
sendOrderConfirmation: boolean
Example
{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "updateDocuments": "boolean",
  "sendOrderConfirmation": "boolean"
}

CertificateUpdateDto: object

sendOrderConfirmation: boolean
Example
{
  "sendOrderConfirmation": true
}

DocumentUploadDto: object

success: boolean
code: integer (int32)
Example
{
  "success": "boolean",
  "code": "integer (int32)"
}

OrderPatchDto: object

status: string PDG, BKD, CXL, CSD, PRL
successiveOrderId: string (uuid)
Example
{
  "status": "BKD",
  "successiveOrderId": "string (uuid)"
}

DocumentCertDto: object

uuid: string (uuid)
certificateUUID: string (uuid)
orderDate: string (date-time)
salesChannel: string
certNumber: string
contractType: string RECURRING, SINGLE
durationTimeUnit: string HOURS, DAYS, MONTHS, YEARS, END_DATE, MINUTES
coverageAmount: integer (int32)
currencyCd: string
customers: DocumentCustomerDto
DocumentCustomerDto
partners: DocumentPartnerDto
DocumentPartnerDto
product: DocumentProductDto
Example
{
  "uuid": "string (uuid)",
  "certificateUUID": "string (uuid)",
  "orderDate": "string (date-time)",
  "salesChannel": "string",
  "certNumber": "string",
  "contractType": "string",
  "durationTimeUnit": "string",
  "coverageAmount": "integer (int32)",
  "currencyCd": "string",
  "customers": [
    {
      "uuid": "string (uuid)",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "birthDate": "string (date-time)",
      "hepNumber": "string",
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "countryCd": "string"
    }
  ],
  "partners": [
    {
      "firstName": "string",
      "lastName": "string",
      "birthDate": "string (date-time)"
    }
  ],
  "product": {
    "qualityName": "string",
    "productName": "string",
    "shortProductName": "string",
    "emergencyContactNumber": "string",
    "contractStartDate": "string (date-time)",
    "contractEndDate": "string (date-time)",
    "finalPrice": "number",
    "originalPrice": "number",
    "insuranceTax": "number",
    "taxRate": "number",
    "serviceFees": "number",
    "transferFees": "number",
    "insuranceFees": "number",
    "riskPremium": "number",
    "addPrice": "boolean",
    "damageReportHint": "string",
    "coverageType": "string",
    "coverageSum": "number",
    "insuranceBase": "string",
    "riskCarrierName": "string",
    "riskCarrierAddress": "string",
    "riskCarrierVatId": "string",
    "riskCarrierInsuranceTaxNumber": "string",
    "insuranceIntermediaryName": "string",
    "insuranceIntermediaryAddress": "string",
    "insuranceBenefits": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "pibHeadline": "string",
    "pib": {
      "title": "string",
      "productTitle": "string",
      "preliminaryNote": "string",
      "insuranceType": "string",
      "insured": "string",
      "notInsured": "string",
      "coverRestrictions": "string",
      "where": "string",
      "obligations": "string",
      "payment": "string",
      "coverageDates": "string",
      "cancellation": "string",
      "notes": "string"
    },
    "pibAttributes": [
      {
        "name": "string",
        "description": "string"
      }
    ],
    "coverageDuration": "integer (int32)",
    "durationTimeUnit": "string",
    "variants": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "insuranceUserFirstName": "string",
    "insuranceUserLastName": "string",
    "insuranceUserCompanyName": "string",
    "policyAttributes": [
      {
        "key": "string",
        "value": "string",
        "type": "string",
        "document": "boolean"
      }
    ],
    "productAttributes": [
      null
    ]
  }
}

DocumentCustomerDto: object

uuid: string (uuid)
firstName: string
lastName: string
company: string
birthDate: string (date-time)
hepNumber: string
street: string
zipCode: string
city: string
countryCd: string
Example
{
  "uuid": "string (uuid)",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "birthDate": "string (date-time)",
  "hepNumber": "string",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "countryCd": "string"
}

DocumentPartnerDto: object

firstName: string
lastName: string
birthDate: string (date-time)
Example
{
  "firstName": "string",
  "lastName": "string",
  "birthDate": "string (date-time)"
}

DocumentPibDto: object

title: string
productTitle: string
preliminaryNote: string
insuranceType: string
insured: string
notInsured: string
coverRestrictions: string
where: string
obligations: string
payment: string
coverageDates: string
cancellation: string
notes: string
Example
{
  "title": "string",
  "productTitle": "string",
  "preliminaryNote": "string",
  "insuranceType": "string",
  "insured": "string",
  "notInsured": "string",
  "coverRestrictions": "string",
  "where": "string",
  "obligations": "string",
  "payment": "string",
  "coverageDates": "string",
  "cancellation": "string",
  "notes": "string"
}

DocumentPolicyAttributeDto: object

key: string
value: string
type: string
document: boolean
Example
{
  "key": "string",
  "value": "string",
  "type": "string",
  "document": "boolean"
}

DocumentProductAttributeDto: object

key: string
value: string
Example
{
  "key": "string",
  "value": "string"
}

DocumentProductDto: object

qualityName: string
productName: string
shortProductName: string
emergencyContactNumber: string
contractStartDate: string (date-time)
contractEndDate: string (date-time)
finalPrice: number
originalPrice: number
insuranceTax: number
taxRate: number
serviceFees: number
transferFees: number
insuranceFees: number
riskPremium: number
addPrice: boolean
damageReportHint: string
coverageType: string THING, PERSON, EVENT
coverageSum: number
insuranceBase: string
riskCarrierName: string
riskCarrierAddress: string
riskCarrierVatId: string
riskCarrierInsuranceTaxNumber: string
insuranceIntermediaryName: string
insuranceIntermediaryAddress: string
insuranceBenefits: MediaItemDto
MediaItemDto
pibHeadline: string
pib: DocumentPibDto
pibAttributes: MediaItemDto
MediaItemDto
coverageDuration: integer (int32)
durationTimeUnit: string HOURS, DAYS, MONTHS, YEARS, END_DATE, MINUTES
variants: DocumentVariantDto
DocumentVariantDto
insuranceUserFirstName: string
insuranceUserLastName: string
insuranceUserCompanyName: string
policyAttributes: DocumentPolicyAttributeDto
DocumentPolicyAttributeDto
productAttributes: DocumentProductAttributeDto
DocumentProductAttributeDto
Example
{
  "qualityName": "string",
  "productName": "string",
  "shortProductName": "string",
  "emergencyContactNumber": "string",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "finalPrice": "number",
  "originalPrice": "number",
  "insuranceTax": "number",
  "taxRate": "number",
  "serviceFees": "number",
  "transferFees": "number",
  "insuranceFees": "number",
  "riskPremium": "number",
  "addPrice": "boolean",
  "damageReportHint": "string",
  "coverageType": "string",
  "coverageSum": "number",
  "insuranceBase": "string",
  "riskCarrierName": "string",
  "riskCarrierAddress": "string",
  "riskCarrierVatId": "string",
  "riskCarrierInsuranceTaxNumber": "string",
  "insuranceIntermediaryName": "string",
  "insuranceIntermediaryAddress": "string",
  "insuranceBenefits": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "pibHeadline": "string",
  "pib": {
    "title": "string",
    "productTitle": "string",
    "preliminaryNote": "string",
    "insuranceType": "string",
    "insured": "string",
    "notInsured": "string",
    "coverRestrictions": "string",
    "where": "string",
    "obligations": "string",
    "payment": "string",
    "coverageDates": "string",
    "cancellation": "string",
    "notes": "string"
  },
  "pibAttributes": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "coverageDuration": "integer (int32)",
  "durationTimeUnit": "string",
  "variants": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "insuranceUserFirstName": "string",
  "insuranceUserLastName": "string",
  "insuranceUserCompanyName": "string",
  "policyAttributes": [
    {
      "key": "string",
      "value": "string",
      "type": "string",
      "document": "boolean"
    }
  ],
  "productAttributes": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

DocumentVariantDto: object

key: string
value: string
Example
{
  "key": "string",
  "value": "string"
}

MediaItemDto: object

name: string
description: string
Example
{
  "name": "string",
  "description": "string"
}

DocumentCartItemDto: object

uuid: string (uuid)
productName: string
qualityName: string
coverageSum: number
coverageDuration: integer (int32)
coverageEndDate: string (date-time)
coverageAmount: integer (int32)
durationTimeUnit: string HOURS, DAYS, MONTHS, YEARS, END_DATE, MINUTES
coverageType: string THING, PERSON, EVENT
price: number
originalPrice: number
insuranceTax: number
taxRate: number
serviceFees: number
transferFees: number
insuranceFees: number
riskPremium: number
discountAppliedAmount: number
contractStartDate: string (date-time)
contractEndDate: string (date-time)
partners: DocumentPartnerDto
DocumentPartnerDto
customer: DocumentCustomerDto
Example
{
  "uuid": "string (uuid)",
  "productName": "string",
  "qualityName": "string",
  "coverageSum": "number",
  "coverageDuration": "integer (int32)",
  "coverageEndDate": "string (date-time)",
  "coverageAmount": "integer (int32)",
  "durationTimeUnit": "string",
  "coverageType": "string",
  "price": "number",
  "originalPrice": "number",
  "insuranceTax": "number",
  "taxRate": "number",
  "serviceFees": "number",
  "transferFees": "number",
  "insuranceFees": "number",
  "riskPremium": "number",
  "discountAppliedAmount": "number",
  "contractStartDate": "string (date-time)",
  "contractEndDate": "string (date-time)",
  "partners": [
    {
      "firstName": "string",
      "lastName": "string",
      "birthDate": "string (date-time)"
    }
  ],
  "customer": {
    "uuid": "string (uuid)",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "birthDate": "string (date-time)",
    "hepNumber": "string",
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "countryCd": "string"
  }
}

DocumentOrderDto: object

uuid: string (uuid)
salesChannel: string
orderNumber: string
invoiceNumber: string
orderDate: string (date-time)
finalPrice: number
originalPrice: number
insuranceTax: number
taxRate: number
serviceFees: number
transferFees: number
insuranceFees: number
riskPremium: number
discountAppliedAmount: number
currencyCd: string
customer: DocumentCustomerDto
cartItems: DocumentCartItemDto
DocumentCartItemDto
Example
{
  "uuid": "string (uuid)",
  "salesChannel": "string",
  "orderNumber": "string",
  "invoiceNumber": "string",
  "orderDate": "string (date-time)",
  "finalPrice": "number",
  "originalPrice": "number",
  "insuranceTax": "number",
  "taxRate": "number",
  "serviceFees": "number",
  "transferFees": "number",
  "insuranceFees": "number",
  "riskPremium": "number",
  "discountAppliedAmount": "number",
  "currencyCd": "string",
  "customer": {
    "uuid": "string (uuid)",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "birthDate": "string (date-time)",
    "hepNumber": "string",
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "countryCd": "string"
  },
  "cartItems": [
    {
      "uuid": "string (uuid)",
      "productName": "string",
      "qualityName": "string",
      "coverageSum": "number",
      "coverageDuration": "integer (int32)",
      "coverageEndDate": "string (date-time)",
      "coverageAmount": "integer (int32)",
      "durationTimeUnit": "string",
      "coverageType": "string",
      "price": "number",
      "originalPrice": "number",
      "insuranceTax": "number",
      "taxRate": "number",
      "serviceFees": "number",
      "transferFees": "number",
      "insuranceFees": "number",
      "riskPremium": "number",
      "discountAppliedAmount": "number",
      "contractStartDate": "string (date-time)",
      "contractEndDate": "string (date-time)",
      "partners": [
        {
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string (date-time)"
        }
      ],
      "customer": {
        "uuid": "string (uuid)",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "birthDate": "string (date-time)",
        "hepNumber": "string",
        "street": "string",
        "zipCode": "string",
        "city": "string",
        "countryCd": "string"
      }
    }
  ]
}
Documentation by Spectacle