Application

Get an application.

get

Path parameters

idinteger · int32Required

The id of the application to fetch

Query parameters

getLastApplicationInReplaceChainbooleanOptional

Responses

200

OK

text/plainapplication/jsontext/json

404

Resource not found

text/plainapplication/jsontext/json

get

/application/{id}

HTTPcURLJavaScriptPython

GET /application/{id} HTTP/1.1
Host: 
Accept: */*

{
  "applicationId": 1,
  "partnerServicesGuid": "123e4567-e89b-12d3-a456-426614174000",
  "productId": 1,
  "statusId": 1,
  "documentStatusId": 1,
  "externalOfferNumber": "text",
  "createdDate": "2026-01-20T21:42:20.307Z",
  "lastChanged": "2026-01-20T21:42:20.307Z",
  "applicationNumber": "text",
  "vendor": {
    "id": 1,
    "salesperson": {
      "id": 1
    }
  },
  "supplier": {
    "id": 1
  },
  "customer": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "coSigner": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "guarantors": [
    {
      "customer": {
        "$type": "text",
        "address": [
          {
            "addressType": "VisitingAddress",
            "addressLine1": "text",
            "addressLine2": "text",
            "zip": "text",
            "city": "text",
            "county": "text",
            "country": "text"
          }
        ],
        "externalReferences": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "locale": "text"
      }
    }
  ],
  "object": {
    "$type": "text",
    "purchasePrice": {
      "amount": 1,
      "vatAmount": 1
    },
    "objectTypeID": "Vehicle, boat, agriculture, aquaculture, construction machine",
    "objectSubTypeID": "ICE vehicle, electric vehicle, boat under 7 meters, MC",
    "objectCondition": "New, Used",
    "yearModel": 1,
    "make": "text",
    "model": "text",
    "engine": "text",
    "kmPerYear": 1,
    "modelCode": "text",
    "priceKmExceeded": 1,
    "objectCarExtras": [
      {
        "extrasCode": "text",
        "name": "text",
        "price": {
          "amount": 1,
          "vatAmount": 1
        }
      }
    ],
    "carExtrasPriceFactoryInstalled": 1,
    "carExtrasPriceDealerInstalled": 1,
    "fuelType": 1,
    "carRegNo": "text",
    "carKilometers": 1,
    "carChassisNo": "text",
    "kmTotal": 1,
    "carProdNo": "text"
  },
  "embeddedProducts": [
    {
      "code": "INVOICE_ESTIMATOR",
      "name": "Invoice estimator",
      "price": {
        "amount": 1,
        "vatAmount": 1
      },
      "customDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "priceDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "isIncludedInTermFee": true
    }
  ],
  "financials": {
    "startupFee": 1,
    "nominalInterestRate": 1,
    "effectiveInterestRate": 1,
    "loanAmount": 1,
    "equity": {
      "amount": 1,
      "vatAmount": 1
    },
    "equityPercent": 1,
    "vatAmount": 1,
    "vatRateFees": 1,
    "vatRate": 1,
    "nonRecurrentFee": 1,
    "payseries": [
      {
        "terms": 1,
        "termLength": 1,
        "termFee": {
          "amount": 1,
          "vatAmount": 1
        },
        "interestRate": 1,
        "startBalance": 1,
        "endBalance": 1,
        "termAmount": 1
      }
    ],
    "creditCost": 1,
    "creditPurchasePrice": 1,
    "documentFee": 1,
    "loanType": "Annuity",
    "conditions": {
      "fields": [
        {
          "$type": "text",
          "name": "text"
        }
      ]
    },
    "fundingInterest": {
      "fundingInterestId": 1,
      "fundingInterestName": "text"
    },
    "paymentPlan": {
      "payseries": [
        {
          "terms": 1,
          "termLength": 1,
          "termFee": {
            "amount": 1,
            "vatAmount": 1
          },
          "interestRate": 1,
          "startBalance": 1,
          "endBalance": 1,
          "termAmount": 1
        }
      ],
      "payments": [
        {
          "installment": 1,
          "interest": 1,
          "rate": 1,
          "fee": 1,
          "extra": 1,
          "residual": 1,
          "payout": 1,
          "noPayFee": 1,
          "year": 1,
          "term": 1
        }
      ]
    },
    "vatExemptAmount": 1
  },
  "context": {
    "externalSystemRef": 112233445566,
    "externalSystemRef2": "text",
    "externalSystemCode": "MNET, WEBCALC, LENDO",
    "integrationClientId": 1,
    "channel": 1
  },
  "deliveryDate": "2026-01-20T21:42:20.307Z",
  "commentToCustomer": "text",
  "reasonForDecision": "text"
}

Get an application using a filter.

get

Query parameters

applicationNumberstringOptional

ApplicationNumber of application to fetch

psGuidstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

No parameters, you need to specify a query.

text/plainapplication/jsontext/json

404

Resource not found

text/plainapplication/jsontext/json

get

/application

HTTPcURLJavaScriptPython

GET /application HTTP/1.1
Host: 
Accept: */*

{
  "applicationId": 1,
  "partnerServicesGuid": "123e4567-e89b-12d3-a456-426614174000",
  "productId": 1,
  "statusId": 1,
  "documentStatusId": 1,
  "externalOfferNumber": "text",
  "createdDate": "2026-01-20T21:42:20.307Z",
  "lastChanged": "2026-01-20T21:42:20.307Z",
  "applicationNumber": "text",
  "vendor": {
    "id": 1,
    "salesperson": {
      "id": 1
    }
  },
  "supplier": {
    "id": 1
  },
  "customer": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "coSigner": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "guarantors": [
    {
      "customer": {
        "$type": "text",
        "address": [
          {
            "addressType": "VisitingAddress",
            "addressLine1": "text",
            "addressLine2": "text",
            "zip": "text",
            "city": "text",
            "county": "text",
            "country": "text"
          }
        ],
        "externalReferences": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "locale": "text"
      }
    }
  ],
  "object": {
    "$type": "text",
    "purchasePrice": {
      "amount": 1,
      "vatAmount": 1
    },
    "objectTypeID": "Vehicle, boat, agriculture, aquaculture, construction machine",
    "objectSubTypeID": "ICE vehicle, electric vehicle, boat under 7 meters, MC",
    "objectCondition": "New, Used",
    "yearModel": 1,
    "make": "text",
    "model": "text",
    "engine": "text",
    "kmPerYear": 1,
    "modelCode": "text",
    "priceKmExceeded": 1,
    "objectCarExtras": [
      {
        "extrasCode": "text",
        "name": "text",
        "price": {
          "amount": 1,
          "vatAmount": 1
        }
      }
    ],
    "carExtrasPriceFactoryInstalled": 1,
    "carExtrasPriceDealerInstalled": 1,
    "fuelType": 1,
    "carRegNo": "text",
    "carKilometers": 1,
    "carChassisNo": "text",
    "kmTotal": 1,
    "carProdNo": "text"
  },
  "embeddedProducts": [
    {
      "code": "INVOICE_ESTIMATOR",
      "name": "Invoice estimator",
      "price": {
        "amount": 1,
        "vatAmount": 1
      },
      "customDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "priceDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "isIncludedInTermFee": true
    }
  ],
  "financials": {
    "startupFee": 1,
    "nominalInterestRate": 1,
    "effectiveInterestRate": 1,
    "loanAmount": 1,
    "equity": {
      "amount": 1,
      "vatAmount": 1
    },
    "equityPercent": 1,
    "vatAmount": 1,
    "vatRateFees": 1,
    "vatRate": 1,
    "nonRecurrentFee": 1,
    "payseries": [
      {
        "terms": 1,
        "termLength": 1,
        "termFee": {
          "amount": 1,
          "vatAmount": 1
        },
        "interestRate": 1,
        "startBalance": 1,
        "endBalance": 1,
        "termAmount": 1
      }
    ],
    "creditCost": 1,
    "creditPurchasePrice": 1,
    "documentFee": 1,
    "loanType": "Annuity",
    "conditions": {
      "fields": [
        {
          "$type": "text",
          "name": "text"
        }
      ]
    },
    "fundingInterest": {
      "fundingInterestId": 1,
      "fundingInterestName": "text"
    },
    "paymentPlan": {
      "payseries": [
        {
          "terms": 1,
          "termLength": 1,
          "termFee": {
            "amount": 1,
            "vatAmount": 1
          },
          "interestRate": 1,
          "startBalance": 1,
          "endBalance": 1,
          "termAmount": 1
        }
      ],
      "payments": [
        {
          "installment": 1,
          "interest": 1,
          "rate": 1,
          "fee": 1,
          "extra": 1,
          "residual": 1,
          "payout": 1,
          "noPayFee": 1,
          "year": 1,
          "term": 1
        }
      ]
    },
    "vatExemptAmount": 1
  },
  "context": {
    "externalSystemRef": 112233445566,
    "externalSystemRef2": "text",
    "externalSystemCode": "MNET, WEBCALC, LENDO",
    "integrationClientId": 1,
    "channel": 1
  },
  "deliveryDate": "2026-01-20T21:42:20.307Z",
  "commentToCustomer": "text",
  "reasonForDecision": "text"
}

Creates an application, and raises the default submit-event.

post

Body

application/jsontext/jsonapplication/*+json

productIdinteger · int32Optional

The ID of the financial product to calculate for.

payRuleIdinteger · int32 | nullableOptional

An optional pay rule to set as active for the application.

campaignIdinteger · int32 | nullableOptional

An ID for a campaign to set as active for the application.

externalOfferNumberstring | nullableOptional

An external identifier for the application, which may be on the integrator's desired format.

customerone of | nullableOptional

The main customer of the application.

or

or

or

coSignerone of | nullableOptional

The co-signer of the application.

or

or

or

objectone of | nullableOptional

The loan or lease object.

or

deliveryDatestring · date-time | nullableOptional

The date the loan or lease object is delivered to the customer.

Responses

200

The application was created successfully

text/plainapplication/jsontext/json

408

Violation of business flow rules. The application cannot be altered in the requested manner due to it's state

text/plainapplication/jsontext/json

422

Violation of business validation rule, the given input cannot be processed.

text/plainapplication/jsontext/json

post

/application

HTTPcURLJavaScriptPython

POST /application HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2352

{
  "productId": 1,
  "payRuleId": 1,
  "campaignId": 1,
  "externalOfferNumber": "text",
  "vendor": {
    "id": 1,
    "salesperson": {
      "id": 1
    }
  },
  "supplier": {
    "id": 1
  },
  "customer": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "coSigner": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "guarantors": [
    {
      "customer": {
        "$type": "text",
        "address": [
          {
            "addressType": "VisitingAddress",
            "addressLine1": "text",
            "addressLine2": "text",
            "zip": "text",
            "city": "text",
            "county": "text",
            "country": "text"
          }
        ],
        "externalReferences": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "locale": "text"
      }
    }
  ],
  "beneficialOwners": [
    {
      "ssn": "text",
      "share": 1
    }
  ],
  "object": {
    "$type": "text",
    "purchasePrice": {
      "amount": 1,
      "vatAmount": 1
    },
    "objectTypeID": "Vehicle, boat, agriculture, aquaculture, construction machine",
    "objectSubTypeID": "ICE vehicle, electric vehicle, boat under 7 meters, MC",
    "objectCondition": "New, Used",
    "yearModel": 1,
    "make": "text",
    "model": "text",
    "engine": "text",
    "kmPerYear": 1,
    "modelCode": "text",
    "priceKmExceeded": 1,
    "objectCarExtras": [
      {
        "extrasCode": "text",
        "name": "text",
        "price": {
          "amount": 1,
          "vatAmount": 1
        }
      }
    ],
    "carExtrasPriceFactoryInstalled": 1,
    "carExtrasPriceDealerInstalled": 1,
    "fuelType": 1,
    "carRegNo": "text",
    "carKilometers": 1,
    "carChassisNo": "text",
    "kmTotal": 1,
    "carProdNo": "text"
  },
  "embeddedProducts": [
    {
      "code": "INVOICE_ESTIMATOR",
      "name": "Invoice estimator",
      "price": {
        "amount": 1,
        "vatAmount": 1
      },
      "customDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "priceDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "isIncludedInTermFee": true
    }
  ],
  "financials": {
    "equity": {
      "amount": 1,
      "vatAmount": 1
    },
    "startupFee": {
      "amount": 1,
      "vatAmount": 1
    },
    "terms": {
      "$type": "text",
      "termCount": 1,
      "termLength": 1
    },
    "interestRate": 1,
    "termFee": {
      "amount": 1,
      "vatAmount": 1
    },
    "residualValue": {
      "amount": 1,
      "vatAmount": 1
    },
    "residualValuePercent": 1,
    "nonRecurrentFee": 1,
    "loanType": "Annuity",
    "fundingInterestId": 1
  },
  "context": {
    "externalSystemRef": 112233445566,
    "externalSystemRef2": "text",
    "externalSystemCode": "MNET, WEBCALC, LENDO",
    "integrationClientId": 1,
    "channel": 1
  },
  "deliveryDate": "2026-01-20T21:42:20.307Z"
}

application/jsontext/jsonapplication/*+json

{
  "applicationId": 1,
  "applicationNumber": "text",
  "externalOfferNumber": "text",
  "shortReference": "text",
  "context": {
    "externalSystemRef": 112233445566,
    "externalSystemRef2": "text",
    "externalSystemCode": "MNET, WEBCALC, LENDO",
    "integrationClientId": 1,
    "channel": 1
  },
  "validationParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "min": 1,
      "max": 1
    }
  }
}

Performs a calculation.

post

Body

application/jsontext/jsonapplication/*+json

productIdinteger · int32Optional

The ID of the financial product to calculate for

campaignIdinteger · int32 | nullableOptional

An ID for a campaign to set as active for the application.

vendorIdinteger · int32 | nullableOptional

The vendor for the application.

salespersonIdinteger · int32 | nullableOptional

customerTypestring · enumOptionalPossible values:

customerone of | nullableOptional

The customer for calculation

or

or

or

objectone of | nullableOptional

The loan or lease object.

or

includePaymentPlanbooleanOptional

Parameter for including complete paymenplan of calculated application in calculation response

deliveryDatestring · date-time | nullableOptional

The date the loan or lease object is delivered to the customer.

Responses

200

OK

text/plainapplication/jsontext/json

422

Violation of business validation rule, the given input cannot be processed.

text/plainapplication/jsontext/json

post

/application/calculate

HTTPcURLJavaScriptPython

POST /application/calculate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1781

{
  "productId": 1,
  "campaignId": 1,
  "vendorId": 1,
  "salespersonId": 1,
  "customerType": "NotSet",
  "customer": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "object": {
    "$type": "text",
    "purchasePrice": {
      "amount": 1,
      "vatAmount": 1
    },
    "objectTypeID": "Vehicle, boat, agriculture, aquaculture, construction machine",
    "objectSubTypeID": "ICE vehicle, electric vehicle, boat under 7 meters, MC",
    "objectCondition": "New, Used",
    "yearModel": 1,
    "make": "text",
    "model": "text",
    "engine": "text",
    "kmPerYear": 1,
    "modelCode": "text",
    "priceKmExceeded": 1,
    "objectCarExtras": [
      {
        "extrasCode": "text",
        "name": "text",
        "price": {
          "amount": 1,
          "vatAmount": 1
        }
      }
    ],
    "carExtrasPriceFactoryInstalled": 1,
    "carExtrasPriceDealerInstalled": 1,
    "fuelType": 1,
    "carRegNo": "text",
    "carKilometers": 1,
    "carChassisNo": "text",
    "kmTotal": 1,
    "carProdNo": "text"
  },
  "financialParameters": {
    "equity": {
      "amount": 1,
      "vatAmount": 1
    },
    "startupFee": {
      "amount": 1,
      "vatAmount": 1
    },
    "terms": {
      "$type": "text",
      "termCount": 1,
      "termLength": 1
    },
    "interestRate": 1,
    "termFee": {
      "amount": 1,
      "vatAmount": 1
    },
    "residualValue": {
      "amount": 1,
      "vatAmount": 1
    },
    "residualValuePercent": 1,
    "nonRecurrentFee": 1,
    "loanType": "Annuity",
    "fundingInterestId": 1
  },
  "embeddedProducts": [
    {
      "code": "INVOICE_ESTIMATOR",
      "name": "Invoice estimator",
      "price": {
        "amount": 1,
        "vatAmount": 1
      },
      "customDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "priceDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "isIncludedInTermFee": true
    }
  ],
  "context": {
    "externalSystemRef": 112233445566,
    "externalSystemRef2": "text",
    "externalSystemCode": "MNET, WEBCALC, LENDO",
    "integrationClientId": 1,
    "channel": 1
  },
  "includePaymentPlan": true,
  "deliveryDate": "2026-01-20T21:42:20.307Z"
}

application/jsontext/jsonapplication/*+json

{
  "calculation": {
    "startupFee": 1,
    "nominalInterestRate": 1,
    "effectiveInterestRate": 1,
    "loanAmount": 1,
    "equity": {
      "amount": 1,
      "vatAmount": 1
    },
    "equityPercent": 1,
    "vatAmount": 1,
    "vatRateFees": 1,
    "vatRate": 1,
    "nonRecurrentFee": 1,
    "payseries": [
      {
        "terms": 1,
        "termLength": 1,
        "termFee": {
          "amount": 1,
          "vatAmount": 1
        },
        "interestRate": 1,
        "startBalance": 1,
        "endBalance": 1,
        "termAmount": 1
      }
    ],
    "creditCost": 1,
    "creditPurchasePrice": 1,
    "documentFee": 1,
    "loanType": "Annuity",
    "conditions": {
      "fields": [
        {
          "$type": "text",
          "name": "text"
        }
      ]
    },
    "fundingInterest": {
      "fundingInterestId": 1,
      "fundingInterestName": "text"
    },
    "paymentPlan": {
      "payseries": [
        {
          "terms": 1,
          "termLength": 1,
          "termFee": {
            "amount": 1,
            "vatAmount": 1
          },
          "interestRate": 1,
          "startBalance": 1,
          "endBalance": 1,
          "termAmount": 1
        }
      ],
      "payments": [
        {
          "installment": 1,
          "interest": 1,
          "rate": 1,
          "fee": 1,
          "extra": 1,
          "residual": 1,
          "payout": 1,
          "noPayFee": 1,
          "year": 1,
          "term": 1
        }
      ]
    },
    "vatExemptAmount": 1
  },
  "object": {
    "$type": "text",
    "purchasePrice": {
      "amount": 1,
      "vatAmount": 1
    },
    "objectTypeID": "Vehicle, boat, agriculture, aquaculture, construction machine",
    "objectSubTypeID": "ICE vehicle, electric vehicle, boat under 7 meters, MC",
    "objectCondition": "New, Used",
    "yearModel": 1,
    "make": "text",
    "model": "text",
    "engine": "text",
    "kmPerYear": 1,
    "modelCode": "text",
    "priceKmExceeded": 1,
    "objectCarExtras": [
      {
        "extrasCode": "text",
        "name": "text",
        "price": {
          "amount": 1,
          "vatAmount": 1
        }
      }
    ],
    "carExtrasPriceFactoryInstalled": 1,
    "carExtrasPriceDealerInstalled": 1,
    "fuelType": 1,
    "carRegNo": "text",
    "carKilometers": 1,
    "carChassisNo": "text",
    "kmTotal": 1,
    "carProdNo": "text"
  },
  "embeddedProducts": [
    {
      "code": "INVOICE_ESTIMATOR",
      "name": "Invoice estimator",
      "price": {
        "amount": 1,
        "vatAmount": 1
      },
      "customDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "priceDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "isIncludedInTermFee": true
    }
  ],
  "validationParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "min": 1,
      "max": 1
    }
  }
}

Search for applications.

post

Body

application/jsontext/jsonapplication/*+json

pageIndexinteger · int32Optional

pageSizeinteger · int32Optional

applicationStatusinteger · int32[] | nullableOptional

documentStatusinteger · int32[] | nullableOptional

allSignTasksCompleteboolean | nullableOptional

customerNumberstring | nullableOptional

vendorsinteger · int32[] | nullableOptional

applicationNumberstring | nullableOptional

backOfficeNumberstring | nullableOptional

customerNamestring | nullableOptional

externalSystemRefstring | nullableOptional

fromDatestring · date-time | nullableOptional

toDatestring · date-time | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

post

/application/search

HTTPcURLJavaScriptPython

POST /application/search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 315

{
  "pageIndex": 1,
  "pageSize": 1,
  "applicationStatus": [
    1
  ],
  "documentStatus": [
    1
  ],
  "allSignTasksComplete": true,
  "customerNumber": "text",
  "vendors": [
    1
  ],
  "applicationNumber": "text",
  "backOfficeNumber": "text",
  "customerName": "text",
  "externalSystemRef": "text",
  "fromDate": "2026-01-20T21:42:20.307Z",
  "toDate": "2026-01-20T21:42:20.307Z"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "pageIndex": 1,
  "recordCount": 1,
  "results": [
    {
      "vendorId": 1,
      "loanAmount": 1,
      "responsibleId": 1,
      "responsibleName": "text",
      "finalized": true,
      "externalOfferNumber": "text",
      "applicationId": 1,
      "backOfficeAccountId": "text",
      "applicationNumber": "text",
      "siblingApplicationNumber": "text",
      "customerName": "text",
      "customerNumber": "text",
      "customerCompanyNumber": "text",
      "customerId": 1,
      "createdDate": "2026-01-20T21:42:20.307Z",
      "documentStatusId": 1,
      "applicationStatusId": 1,
      "salesPersonName": "text",
      "salesPersonId": 1,
      "productId": 1,
      "coSignerId": 1,
      "channel": 1,
      "context": {
        "externalSystemRef": 112233445566,
        "externalSystemRef2": "text",
        "externalSystemCode": "MNET, WEBCALC, LENDO",
        "integrationClientId": 1,
        "channel": 1
      },
      "applicationLastChanged": "2026-01-20T21:42:20.307Z",
      "paidDate": "2026-01-20T21:42:20.307Z"
    }
  ]
}

Updates an existing application.

put

Path parameters

applicationIdinteger · int32Required

Body

application/jsontext/jsonapplication/*+json

productIdinteger · int32Optional

The ID of the financial product to calculate for.

payRuleIdinteger · int32 | nullableOptional

An optional pay rule to set as active for the application.

campaignIdinteger · int32 | nullableOptional

An ID for a campaign to set as active for the application.

externalOfferNumberstring | nullableOptional

An external identifier for the application, which may be on the integrator's desired format.

customerone of | nullableOptional

The main customer of the application.

or

or

or

coSignerone of | nullableOptional

The co-signer of the application.

or

or

or

objectone of | nullableOptional

The loan or lease object.

or

deliveryDatestring · date-time | nullableOptional

The date the loan or lease object is delivered to the customer.

Responses

200

OK

text/plainapplication/jsontext/json

408

Violation of business flow rules. The application cannot be altered in the requested manner due to it's state

text/plainapplication/jsontext/json

422

Violation of business validation rule, the given input cannot be processed.

text/plainapplication/jsontext/json

put

/application/{applicationId}

HTTPcURLJavaScriptPython

PUT /application/{applicationId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2352

{
  "productId": 1,
  "payRuleId": 1,
  "campaignId": 1,
  "externalOfferNumber": "text",
  "vendor": {
    "id": 1,
    "salesperson": {
      "id": 1
    }
  },
  "supplier": {
    "id": 1
  },
  "customer": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "coSigner": {
    "$type": "text",
    "address": [
      {
        "addressType": "VisitingAddress",
        "addressLine1": "text",
        "addressLine2": "text",
        "zip": "text",
        "city": "text",
        "county": "text",
        "country": "text"
      }
    ],
    "externalReferences": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "locale": "text"
  },
  "guarantors": [
    {
      "customer": {
        "$type": "text",
        "address": [
          {
            "addressType": "VisitingAddress",
            "addressLine1": "text",
            "addressLine2": "text",
            "zip": "text",
            "city": "text",
            "county": "text",
            "country": "text"
          }
        ],
        "externalReferences": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "locale": "text"
      }
    }
  ],
  "beneficialOwners": [
    {
      "ssn": "text",
      "share": 1
    }
  ],
  "object": {
    "$type": "text",
    "purchasePrice": {
      "amount": 1,
      "vatAmount": 1
    },
    "objectTypeID": "Vehicle, boat, agriculture, aquaculture, construction machine",
    "objectSubTypeID": "ICE vehicle, electric vehicle, boat under 7 meters, MC",
    "objectCondition": "New, Used",
    "yearModel": 1,
    "make": "text",
    "model": "text",
    "engine": "text",
    "kmPerYear": 1,
    "modelCode": "text",
    "priceKmExceeded": 1,
    "objectCarExtras": [
      {
        "extrasCode": "text",
        "name": "text",
        "price": {
          "amount": 1,
          "vatAmount": 1
        }
      }
    ],
    "carExtrasPriceFactoryInstalled": 1,
    "carExtrasPriceDealerInstalled": 1,
    "fuelType": 1,
    "carRegNo": "text",
    "carKilometers": 1,
    "carChassisNo": "text",
    "kmTotal": 1,
    "carProdNo": "text"
  },
  "embeddedProducts": [
    {
      "code": "INVOICE_ESTIMATOR",
      "name": "Invoice estimator",
      "price": {
        "amount": 1,
        "vatAmount": 1
      },
      "customDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "priceDataFields": [
        {
          "$type": "text",
          "name": "text",
          "value": 1
        }
      ],
      "isIncludedInTermFee": true
    }
  ],
  "financials": {
    "equity": {
      "amount": 1,
      "vatAmount": 1
    },
    "startupFee": {
      "amount": 1,
      "vatAmount": 1
    },
    "terms": {
      "$type": "text",
      "termCount": 1,
      "termLength": 1
    },
    "interestRate": 1,
    "termFee": {
      "amount": 1,
      "vatAmount": 1
    },
    "residualValue": {
      "amount": 1,
      "vatAmount": 1
    },
    "residualValuePercent": 1,
    "nonRecurrentFee": 1,
    "loanType": "Annuity",
    "fundingInterestId": 1
  },
  "context": {
    "externalSystemRef": 112233445566,
    "externalSystemRef2": "text",
    "externalSystemCode": "MNET, WEBCALC, LENDO",
    "integrationClientId": 1,
    "channel": 1
  },
  "deliveryDate": "2026-01-20T21:42:20.307Z"
}

application/jsontext/jsonapplication/*+json

{
  "validationParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "min": 1,
      "max": 1
    }
  }
}

get

Path parameters

applicationIdinteger · int32Required

Query parameters

getLatestInReplaceChainbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

404

Resource not found

text/plainapplication/jsontext/json

get

/application/{applicationId}/status

HTTPcURLJavaScriptPython

GET /application/{applicationId}/status HTTP/1.1
Host: 
Accept: */*

{
  "statusId": 1,
  "statusName": "text",
  "statusCausalOrder": 1,
  "finalized": true,
  "isApproved": true
}

get

Path parameters

applicationIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

404

Resource not found

text/plainapplication/jsontext/json

get

/application/{applicationId}/document-status

HTTPcURLJavaScriptPython

GET /application/{applicationId}/document-status HTTP/1.1
Host: 
Accept: */*

{
  "documentStatusId": 1,
  "statusName": "text",
  "statusCausalOrder": 1
}