API Presentation
API Presentation
Breadcrumbs

API - Security deposit APIs

Deposits is a current liability account in the general ledger, in which is stored the amount of funds paid by customers in advance of a product or service delivery.

Security Deposit APIs

Method

Resource Path

Payload

Description

Response code

Swagger link

Since

PUT

https://{host}/opencell/api/rest/v2/accountReceivable/financeSettings/1

 
{
    "useSecurityDeposit": true,
    "maxAmountPerSecurityDeposit": 100000,
    "maxAmountPerCustomer": 10000000,
    "autoRefund": false
}


Activate and Update the Security Deposit settings

  • 200

  • 400


V12.0

POST

https://{host}/opencell/api/rest/v2/securityDeposit/securityDepositTemplate

 


{
"templateName":"Test",
"currency": {
        "code": "EUR"
  },
"allowValidityDate": true,
"allowValidityPeriod": false,
"minAmount": 100,
"maxAmount": 20000,
"status": "ACTIVE",
"numberOfInstantiation": 10
}


Create a Security Deposit Template.

  • allowValidityDate /allowValidityPeriod : At least one of the two options should be checked!

  • Status : has type SecurityTemplateStatusEnum (Draft, Active,Archived)

  • 200

  • 400


V12.0

POST

https://{host}/opencell/api/rest/v2/securityDeposit/instantiateSecurityDeposit

 


{
    "amount": 500,
    "customerAccount": {"code":"AR_CUSTOMER"},
    "description": "security deposit instance",
    "externalReference": "SD-1",
    "serviceInstance": {
        "code": "PR_USG_PLAN"
    },
    "subscription": {
        "code": "MAIN_SELLER_CLASSIC-C00_1"
    },
    "template": {
        "id": 2
    },
    "validityPeriodUnit": "MONTHS",
    "code": "Test-11"
}

Instanciate a Security Deposit Template

  • 200

  • 400


V12.0

POST

https://{host}/opencell/api/rest/v2/securityDeposit/credit/{securityDepositInstanceId}

 


{
"amountToCredit": 1000,
"bankLot": "@today-opencell.admin",
"customerAccountCode": "AR_CUSTOMER",
"isToMatching": false,
"occTemplateCode": "CRD_SD",
"paymentInfo": "opencell.admin",
"paymentInfo1": "",
"paymentInfo2": 1200,
"paymentInfo3": "owner string",
"paymentInfo4": "address of owner string",
"paymentInfo5": "bank name string",
"paymentMethod": "CHECK",
"reference": "check reference string"
}

Credit a Security Deposit

  • 200

  • 400

  • 404


V12.0

POST

https://{host}/opencell/api/rest/v2/securityDeposit/refund/{securityDepositInstanceId}

 
{
"id":"216",
"code":"DEFAULT_SD_TEMPLATE-196",
"refundReason":"refund "
}

Refund a security deposit

  • 200

  • 400

  • 404


V15.0

POST

https://{host}/opencell/api/rest/v2/securityDeposit/cancel/{securityDepositInstanceId}

 
{
"id":"216",
"code":"DEFAULT_SD_TEMPLATE-196",
"cancelReason":"reason for cancel"
}

Cancel a security deposit

  • 200

  • 400

  • 404


V15.0