albis.findApplication - ALBIS-GROUP/LeaseKitSDK-JS GitHub Wiki

albis.findApplication(id, albisToken) ⇒ ResponseFindApplication

findApplication(id, albisToken) finds application by its id

Kind: instance method of Albis
Returns: ResponseFindApplication - response - An object with application data

Param Type Description
id number
albisToken Object object with Albis token, which lets to communicate with Albis API

Example

Albis.findApplication(54321, { token: '12345' })

ResponseFindApplication : Object

Kind: global typedef
Properties

Name Type Description
response.jsonrpc string "2.0"
response.id string json rpc lib id
response.result Object object with application data
response.result.applicationId number application id i.e. 54321
response.result.applicationStatus number application status number i.e. 1150 (you can compare the result with getApplicationsStatus method)
response.result.applicationStatusDesc string application status description i.e. 'in Bearbeitung' (you can compare the result with getApplicationsStatus method)
response.result.applicationReceptionDate string when application data were received i.e. '2020-12-21 09:04:11'
response.result.bankName string bank name, which will cover the transation i.e. 'Berliner Volksbank'
response.result.bankIdentifierCode string bank identifier code i.e. 'BEVODEBBXYZ'
response.result.contractDocuments Array.<Object> list of missing or incorrect contract documents. Array with objects, i.e. { errorNumber: 1, errorText: 'Id document is needed to proceed the application', value: 'some more information about the document error', documentReceptionDate: '2021-02-20', documentType: 'id' }
response.result.contractType number contract type i.e. 1 (you can compare the result with getContractTypes method)
response.result.decisionDocuments Array.<string> list of missing documents for the decision i.e. ['id']
response.result.downPayment number down payment id i.e. 500
response.result.finalPayment number possible final payment if the term is shortened. This field is only available to be filled if the contract is cancellable id i.e. 2831.08
response.result.iban string IBAN of account to be charged with contract instalments i.e. 'DE88100900001234567892'
response.result.insurance boolean is insurance i.e. true
response.result.isContactByEmail boolean indicator that the leasing contract should be sent to the lessee by e-mail after approval i.e. true
response.result.isLesseeEmailContact boolean did lessee agreed to receive an email i.e. true
response.result.leaseTerm number term of lease in months i.e. 54
response.result.lessee Object object with lessee data
response.result.lessee.city string lessee city i.e. 'New York'
response.result.lessee.email string lessee email i.e. '[email protected]'
response.result.lessee.fax string lessee fax i.e. '0123 123 123'
response.result.lessee.manager Object lessee manager data
response.result.lessee.manager.birthDate string lessee manager birth date, i.e. '1960-12-24' (format YYYY-MM-DD)
response.result.lessee.manager.city string lessee manager city, i.e. 'New York'
response.result.lessee.manager.firstName string lessee manager first name, i.e. 'Susane'
response.result.lessee.manager.fullName string lessee manager full name, i.e. 'Susane Cooper'
response.result.lessee.manager.lastName string lessee manager last name, i.e. 'Cooper'
response.result.lessee.manager.salutation number lessee manager salutation, i.e. 2 (you can compare the result with getSalutations method)
response.result.lessee.manager.salutationDesc string lessee manager salutation description, i.e. 'Frau' (you can compare the result with getSalutations method)
response.result.lessee.manager.street string lessee manager street, i.e. 'Fifth Avenue'
response.result.lessee.manager.zipCode string lessee manager zip code, i.e. '50123'
response.result.lessee.mobileNumber string lessee mobile number, i.e. '+49 543 123 123'
response.result.lessee.name string lessee name, i.e. 'John Doe'
response.result.lessee.legalForm number lessee legal form, i.e. 1 (you can compare the result with getLegalFroms method)
response.result.lessee.phoneNumber string lessee phone number, i.e. '030 1234 1234'
response.result.lessee.street string lessee street, i.e. 'Fifth Avenue'
response.result.lessee.zipCode string lessee zip code, i.e. '50125'
response.result.object string designation of object of lease i.e. 'Fridge Samsung model XYZ'
response.result.paymentMethod string payment method i.e. 2 (you can compare the result with getPaymentMethods method)
response.result.productGroup string product group of object of lease i.e. 1
response.result.promotionId string promotionId (if conditions matched any promotion) i.e. 'xyz'
response.result.provision number commission, i.e. 4.5
response.result.purchasePrice number purchase price for object of lease, i.e. 5000
response.result.rate number monthly leasing rate i.e. 117.87
response.result.receiverEndpoint string endpoint address where requests about application/documentation updates should be delivered i.e. 'https://companyName.com/shop1'
response.result.receiverFailEmails Array.<string> array of string emails where info about connection with reveiver endpoint should be delivered i.e. ['[email protected]']
response.result.receiverToken string a string, which can be used by a client to ensure that the notification concerns his application i.e. 'xyz123'
response.result.reference string application reference (helper for shop employees) i.e. '123abc'
response.result.residualValue number residual value i.e. 300 (0 if contract type different than 2)
response.result.residualValuePercent number residual value percent i.e. 3.0 (null if contract type different than 2)
response.result.saleAndLeaseBack boolean is application of type sale and lease back i.e. true
response.result.salesmanId number salesman id which created the application i.e. 12345
response.result.terminationTerm number when the lease is possible to terminate i.e. 30
⚠️ **GitHub.com Fallback** ⚠️