ADDA API

API Endpoint

https://api.adda.io

Note

To access ADDA APIs you would need to be onboarded to the ADDA API platform. ADDA API Team will issue keys/credentials post onboarding, only using which you can access the APIs.

For getting access to APIs please CONTACT US

Authentication

This API uses JWT for authentication
Every token MUST be refreshed before its expiration time of 24 hours
Token MUST be provided in Authorization header
Token MUST be provided for each request that requires authentication
This API issues a long-lived access tokens for consumers. A long-lived JWT generally SHOULD lasts 365 days.
Once a token expires the user MUST go through the login flow again to get a new one.

Example Header

Authorization: Bearer <token>

Claims

exp - The exp ( expiration time ) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing.
iat - The iat ( issued at ) claim identifies the time at which the JWT was issued.
sub - The aud ( audience ) claim identifies the subject of this token (for e.g. a user id).
iss - The iss ( issuer ) claim identifies the principal that issued the JWT.

HTTP Methods

This API uses HTTP verbs (methods) as following:

GET - Read - used to read (or retrieve) a representation of a resource,
POST - Create - used to create new resources. In particular, it"s used to create subordinate resources.
PUT - Update/Replace - used for update capabilities, PUT-ing to a known resource URI with the request body containing the newly-updated representation of the original resource. On successful request, replaces identified resource with the request body.
PATCH - Update/Modify - used for modify capabilities. The PATCH request only needs to contain the changes to the resource, not the complete resource.
DELETE - Delete - used to delete a resource identified by a URI.

Media Type

Where applicable this API MUST use the JSON media-type. Requests with a message-body are using plain JSON to set or update resource states.

Content-type: application/json and Accept: application/json headers SHOULD be set on all requests if not stated otherwise.

Status Codes and Errors

This API uses HTTP status codes to communicate with the API consumer.

200 OK - Response to a successful GET, PUT, PATCH or DELETE.
201 Created - Response to a POST that results in a creation.
204 No Content - Response to a successful request that won"t be returning a body (like a DELETE request).
400 Bad Request - Malformed request; form validation errors.
401 Unauthorized - When no or invalid authentication details are provided.
403 Forbidden - When authentication succeeded but authenticated user doesn"t have access to the resource.
404 Not Found - When a non-existent resource is requested.
405 Method Not Allowed - Method not allowed.
406 Not Acceptable - Could not satisfy the request Accept header.
415 Unsupported Media Type - Unsupported media type in request.

General Notes

There are few common variables which are used across multiple APIs. The following are the explanations for the same.

apt_id / apt - This refers to an ID which is used to identify a particular Residential Community. This is a reference number used internally in ADDA system. For accessing our APIs, any partner would have to go through an onboarding process. These details can be shared during the same time with the partner.

flat_id / unit_id - This refers to an ID which is used to identify a particular Apartment/Villa/Condo inside Community. You can get the list of IDs for the Apartment/Villa/Condo inside a Community using the API: Units by Community

Vendor Authentication ¶

Access tokens are required to access nearly all endpoints of this API.

Retrieve a token ¶

POST https://api.adda.io/api/auth/login

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "email": "iot@adda.io",
  "password": "iot-api@adda"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "User email address"
    },
    "password": {
      "type": "string",
      "description": "User password"
    }
  },
  "required": [
    "email",
    "password"
  ]
}

Responses200

Headers

Content-Type: application/json

Body

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....",
  "token_type": "bearer",
  "expires_in": 86400
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "JSON Web Token."
    },
    "token_type": {
      "type": "string",
      "description": "Token type"
    },
    "expires_in": {
      "type": "number",
      "description": "Token expiry in seconds"
    }
  }
}

Retrieve a token
POST`/api/auth/login`

Allows to retrieve a valid JSON Web Token for email and password.

Endpoint information


Requires authentication	No
Has restricted scope	No

Refresh a token ¶

GET https://api.adda.io/api/auth/refresh

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200401

Headers

Content-Type: application/json

Body

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...."
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "New JWT"
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Refresh a token
GET`/api/auth/refresh`

Allows to retrieve a new, valid JSON Web Token based on a valid JSON Web Token.

Expired tokens MUST NOT be refreshed.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Change password ¶

PUT https://api.adda.io/api/auth/password

RequestsSample payload

Headers

Content-Type: application/json
Authorization: bearer <token>

Body

{
  "old_password": "secret",
  "new_password": "$3C6e7"
}

Responses200401

Headers

Content-Type: application/json

Body

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Change password
PUT`/api/auth/password`

Changes user password.

After password is changed all access tokens issued for this user prior to password change must be invalidated.

The password contains characters from at least three of the following five categories:
English uppercase characters (A – Z)
English lowercase characters (a – z)
Base 10 digits (0 – 9)
Non-alphanumeric (For example: !, $, #, or %)
Unicode characters

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Get profile ¶

GET https://api.adda.io/api/auth/me

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200401

Headers

Content-Type: application/json

Body

{
  "vendor_user_id": 1,
  "is_primary": 1,
  "is_admin": 1,
  "name": "John Doe",
  "phone": "080 1234 5678",
  "email": "john@doe.com",
  "vendor": {
    "vendor_id": 1,
    "vendor_name": "Adda",
    "is_active": 1,
    "address1": "No. 518, 4th & 5th Floor, V V Arcade",
    "address2": "1st Main Road, AECS Layout, B Block, Kundalahalli",
    "zip": "560037",
    "city": "Bangalore",
    "state": "Karnataka",
    "country": "India",
    "landline": "080 9876 4321"
  }
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Get profile
GET`/api/auth/me`

Shows user profile information

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Get Community List ¶

GET https://api.adda.io/api/admin/vendor/apartments/list

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200403401

Headers

Content-Type: application/json

Body

{
  "message": "Vendor Apartment List",
  "data": {
    "vendor": {
      "vendor_id": 1,
      "vendor_name": "Adda",
      "is_active": 1,
      "address1": "No. 518, 4th & 5th Floor, V V Arcade",
      "address2": "1st Main Road, AECS Layout, B Block, Kundalahalli",
      "zip": "560037",
      "city": "Bangalore",
      "state": "Karnataka",
      "country": "India",
      "landline": "080 3923 6362"
    },
    "apt": [
      {
        "vendor_apartment_id": 1,
        "apt_name": "Sharlow Apartments",
        "apt_id": 1,
        "address2": "Traver",
        "city": "Bangalore",
        "state": "Karnataka",
        "country": "India",
        "no_of_units": "",
        "zip": "560037"
      },
      {
        "vendor_apartment_id": 2,
        "apt_name": "Oasis Breeze",
        "apt_id": 2,
        "address2": "AECS Layout,Kundalahalli",
        "city": "Bangalore",
        "state": "Karnataka",
        "country": "India",
        "no_of_units": "165",
        "zip": "560037"
      }
    ]
  }
}

This response has no content.

Body

{
  "error": "Unauthorized"
}

Get Community List
GET`/api/admin/vendor/apartments/list`

Get list of all communities which are part of an Enterprise Organisation or Integration partner

Endpoint information


Requires authentication	Yes
Has restricted scope	No

ADDA UNIT APIs ¶

UNITS USING MEMBER PHONE ¶

GET https://api.adda.io/api/adda/flats?owner_phone=919876543210?count=100

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200404401

Headers

Content-Type: application/json

Body

{
  "current_page": 1,
  "data": [
    {
      "apt_id": 1,
      "flat_id": 33,
      "block": "A",
      "aptno": "01",
      "firstname": "Lalita's",
      "lastname": "Murthy",
      "owner_phone": "9916840012",
      "owner_email": "addatest1@gmail.com"
    },
    {
      "apt_id": 1,
      "flat_id": 0,
      "block": "A",
      "aptno": "02",
      "firstname": "Murthy",
      "lastname": "Kumar",
      "owner_phone": "9916840012",
      "owner_email": "addatest1@gmail.com"
    }
  ],
  "first_page_url": "http://localhost:8001/api/adda/flats?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://localhost:8001/api/adda/flats?page=1",
  "next_page_url": null,
  "path": "http://localhost:8001/api/adda/flats",
  "per_page": 15,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}

Headers

Content-Type: application/json

Body

{
  "message": "No flats found"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

UNITS USING MEMBER PHONE
GET`/api/adda/flats{?owner_phone}{?count}`

This API can be used to get all unit details by using any member’s phone number (member can be an Owner or a Tenant).

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

owner_phone: string (optional) Example: 919876543210
Member phone number including country code.
count: number (optional) Example: 100

Units by Community ¶

GET https://api.adda.io/api/adda/flats/?apt_id=155?count=100

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200404401

Headers

Content-Type: application/json

Body

{
  "current_page": 1,
  "data": [
    {
      "apt_id": 1,
      "flat_id": 33,
      "block": "A",
      "aptno": "01",
      "firstname": "Lalita's",
      "lastname": "Murthy",
      "owner_phone": "9916840012",
      "owner_email": "addatest1@gmail.com"
    },
    {
      "apt_id": 1,
      "flat_id": 0,
      "block": "",
      "aptno": "",
      "firstname": "Lalita's",
      "lastname": "Murthy",
      "owner_phone": "9916840012",
      "owner_email": "addatest1@gmail.com"
    }
  ],
  "first_page_url": "http://localhost:8001/api/adda/flats?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://localhost:8001/api/adda/flats?page=1",
  "next_page_url": null,
  "path": "http://localhost:8001/api/adda/flats",
  "per_page": 15,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}

Headers

Content-Type: application/json

Body

{
  "message": "No flats found"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Units by Community
GET`/api/adda/flats/{?apt_id}{?count}`

This API can be used to get list of all units and unit details by Community, by passing a Community ID as part of the API call. This also lists all users in a unit.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

apt_id: number (optional) Example: 155
count: number (optional) Example: 100

Members in a Unit ¶

GET https://api.adda.io/api/adda/flats?flat_id=?count=100

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200404401

Headers

Content-Type: application/json

Body

[
  {
    "apt_id": 1,
    "flat_id": 446,
    "block": "D",
    "aptno": "02",
    "firstname": "Mynak",
    "lastname": "Gupta",
    "owner_phone": "99",
    "owner_email": "addatest3@gmail.com"
  },
  {
    "apt_id": 1,
    "flat_id": 446,
    "block": "D",
    "aptno": "02",
    "firstname": "Mynak",
    "lastname": "Gupta",
    "owner_phone": "99",
    "owner_email": "addatest3@gmail.com"
  }
]

Headers

Content-Type: application/json

Body

{
  "error": "No flats found"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Members in a Unit
GET`/api/adda/flats{?flat_id}{?count}`

This lists all users in a unit, by passing the unit number (flat_id) in the API. The reference numbers for the units (flat_id) can be obtained from this API: Units by Community

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

flat_id: number (optional)
ADDA Flat ID
count: number (optional) Example: 100

ADDA ACCOUNTING APIs ¶

Post Invoices to units ¶

POST https://api.adda.io/api/adda/flat/invoices

Requestsexample 1

Headers

Authorization: bearer <token>
Content-Type: application/json

Body

{
  "payload_ref_id": "123412df2",
  "invoices": [
    {
      "flat_id": "217",
      "bill_date": "2019-12-14",
      "bill_duedate": "2019-12-31",
      "items": [
        {
          "accountNo": "20006",
          "amount": "500",
          "comment": "600 Units"
        },
        {
          "accountNo": "10000",
          "amount": "1000",
          "comment": "400 Units"
        }
      ]
    },
    {
      "flat_id": "218",
      "bill_date": "2019-12-14",
      "bill_duedate": "2019-12-31",
      "items": [
        {
          "accountNo": "20006",
          "amount": "500",
          "comment": "600 Units"
        },
        {
          "accountNo": "10000",
          "amount": "1000",
          "comment": "400 Units"
        }
      ]
    }
  ]
}

Responses200500401

Headers

Content-Type: application/json

Body

{
  "status": "success",
  "message": "Posted Successfully",
  "data": {
    "invoice_ids": [
      "5643",
      "5644"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": "Server Error"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Post Invoices to units
POST`/api/adda/flat/invoices`

Post Invoices for multiple units with lineitems for each invoice.

Maximum 100 requests allowed for minute.

payload_ref_id:
It’s an alphanumeric ref_id send by you. Make sure it is unique and changes on change of invoice payload. Or else you will get an error.

invoices:
This is an array of invoices for a units as in example.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Post Receipts to units ¶

POST https://api.adda.io/api/adda/flat/receipts

Requestsexample 1

Headers

Authorization: bearer <token>
Content-Type: application/json

Body

{
    "payload_ref_id": "123412df2",
    "receipts":[
  {
    "flat_id": "217",
    "receipt_date": "2019-12-14",
    "receipt_amount": "4000.58",
    "instrument_no": "5005",
    "instrument_type": "1",
    "instrument_bank": "SBI",
  },
  {
    "flat_id": "218",
    "receipt_date": "2019-12-14",
    "receipt_amount": "3000.58",
    "instrument_no": "500522",
    "instrument_type": "2",
    "instrument_bank": "HDFC",
  }
]
}

Responses200500401

Headers

Content-Type: application/json

Body

{
  "status": "success",
  "message": "Posted Successfully",
  "data": {}
}

Headers

Content-Type: application/json

Body

{
  "error": "Server Error"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Post Receipts to units
POST`/api/adda/flat/receipts`

Post Receipts for multiple units

Maximum 100 requests allowed for minute.

payload_ref_id:
It’s an alphanumeric ref_id send by you. Make sure it is unique and changes on change of receipt payload. Or else you will get an error.

Receipts:
This is an array of Receipts for a units as in example.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Defaulter Units by Community ¶

GET https://api.adda.io/api/adda/flat/defaulters?apt_id=&count=100

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200404401

Headers

Content-Type: application/json

Body

{
  "current_page": 1,
  "data": [
    {
      "apt_id": 1,
      "flat_id": 33,
      "block": "A",
      "aptno": "01",
      "firstname": "Lalita's",
      "lastname": "Murthy",
      "owner_phone": "9916840012",
      "owner_email": "addatest1@gmail.com"
    },
    {
      "apt_id": 1,
      "flat_id": 0,
      "block": "",
      "aptno": "",
      "firstname": "Lalita's",
      "lastname": "Murthy",
      "owner_phone": "9916840012",
      "owner_email": "addatest1@gmail.com"
    }
  ],
  "first_page_url": "http://localhost:8001/api/adda/flats?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://localhost:8001/api/adda/flats?page=1",
  "next_page_url": null,
  "path": "http://localhost:8001/api/adda/flats",
  "per_page": 15,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}

Headers

Content-Type: application/json

Body

{
  "message": "No flats found"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Defaulter Units by Community
GET`/api/adda/flat/defaulters{?apt_id}{&count}`

Get a list of units that have defaulted, and contact details of Primary Contact member

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

apt_id: number (optional)
ADDA Flat ID
count: number (optional) Example: 100

Unit Account Statement ¶

GET https://api.adda.io/api/adda/accountStatement/?apt_id=123

Requestsexample 1

Headers

Authorization: bearer <token>

Body

{
  "units": "68716",
  "from": "2022-04-01",
  "to": "2022-09-30"
}

Responses200404401

Headers

Content-Type: application/json

Body

{
    "unit_id": "68716",
    "account_stmt": [
        {
            "transaction_id": 6343708,
            "type": "Invoice",
            "income_account": "Water Fixed",
            "amount": 500,
            "posted_date": "2022-09-09",
            "reference_no" : 12354
        },
        {
            "transaction_id": 6307996,
            "type": "Receipt",
            "income_account": "Water,Late Payment Interest",
            "amount": 1256,
            "posted_date": "2022-09-01",
            "reference_no" : 658
        },
        {
            "transaction_id": 6307980,
            "type": "Invoice",
            "income_account": "Water",
            "amount": 100,
            "posted_date": "2022-09-01",
            "reference_no" : 12125
        },
        {
            "transaction_id": 6307974,
            "type": "Invoice",
            "income_account": "Maintenance Fee",
            "amount": 2000.01,
            "posted_date": "2022-09-01",
            "reference_no" : 11895
        },
        {
            "transaction_id": 6140429,
            "type": "Invoice",
            "income_account": "Facility",
            "amount": 956,
            "posted_date": "2022-06-01",
            "reference_no" : 9586
        },
    ]
}
],
"statusCode": 200
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "apt_id": [
      "The apt id field is required."
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Unit Account Statement
GET`/api/adda/accountStatement/{?apt_id}`

Gets the Unit Account Statement

This API gets the Account Statement for one or multiple units. For getting account statement for multiple units, send the unit ids as comma separated values.

Example:

“units”: “68716,5678,9876”,

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

apt_id: number (required) Example: 123
ADDA apt ID

Unit Invoice and Receipt List ¶

POST https://api.adda.io/api/adda/invoiceReceiptList

Requestsexample 1

Headers

Authorization: bearer <token>

Body

{
  "apt_id": "123",
  "type": "Invoice",
  "units": "68716",
  "from": "2022-04-01",
  "to": "2022-09-30"
}

Responses200404401

Headers

Content-Type: application/json

Body

{
    "unit_id": "68716",
    "account_stmt": [
        {
            "transaction_id": 6343708,
            "income_account": "Water Fixed",
            "amount": 500,
            "posted_date": "2022-09-09",
            "reference_no" : 12354
        },
        {
            "transaction_id": 6307996,
            "income_account": "Water,Late Payment Interest",
            "amount": 1256,
            "posted_date": "2022-09-01",
            "reference_no" : 658
        },
        {
            "transaction_id": 6307980,
            "income_account": "Water",
            "amount": 100,
            "posted_date": "2022-09-01",
            "reference_no" : 12125
        },
        {
            "transaction_id": 6307974,
            "income_account": "Maintenance Fee",
            "amount": 2000.01,
            "posted_date": "2022-09-01",
            "reference_no" : 11895
        },
        {
            "transaction_id": 6140429,
            "income_account": "Facility",
            "amount": 956,
            "posted_date": "2022-06-01",
            "reference_no" : 9586
        },
    ]
}
],
"statusCode": 200
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "apt_id": [
      "The apt id field is required."
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Unit Invoice and Receipt List
POST`/api/adda/invoiceReceiptList`

Gets the Unit Invoice and Receipt List

This API gets the list of Invoices and Receipts based on the Type sent for one or multiple units. For getting list for multiple units, send the Type(Invoice or Receipt), unit ids as comma separated values.

Example:

“type”: “Invoice”,

“units”: “68716,5678,9876”,

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

apt_id: number (required) Example: 123
ADDA apt ID

Get Invoice Details ¶

GET https://api.adda.io/api/adda/invoice/?apt_id=123&invoice_id=123

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200404401

Headers

Content-Type: application/json

Body

{
    "invoice_no": "123456",
    "invoice_date": "2022-08-25",
    "invoice_due_date": "2022-09-25",
    "invoice_amount": "2500",
    "items": [
        {
            "account": "Service Charge",
            "amount": 1500,
        },
        {
            "account": "Reserved Fund",
            "amount": 1000,
        },
    ]
}
],
"statusCode": 200
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "apt_id": [
      "The apt id field is required."
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Get Invoice Details
GET`/api/adda/invoice/{?apt_id}{&invoice_id}`

Gets Invoice Details

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

apt_id: number (required) Example: 123
ADDA apt ID
invoice_id: number (required) Example: 123
Invoice ID

Get Receipt Details ¶

GET https://api.adda.io/api/adda/receipt/?apt_id=123&receipt_id=123

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200404401

Headers

Content-Type: application/json

Body

{
    "receipt_no": "890",
    "receipt_date": "2022-08-25",
    "receipt_amount": "2500",
    "receipt_instrument_no": "#94949",
    "receipt_instrument_type": "Cheque",
    "receipt_instrument_bank": "Citibank",
    "items": [
        {
            "account": "Service Charge",
            "amount": 1500,
        },
        {
            "account": "Reserved Fund",
            "amount": 1000,
        },
    ]
}
],
"statusCode": 200
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "apt_id": [
      "The apt id field is required."
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Get Receipt Details
GET`/api/adda/receipt/{?apt_id}{&receipt_id}`

Gets Receipt Details

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

apt_id: number (required) Example: 123
ADDA apt ID
receipt_id: number (required) Example: 123
Invoice ID

Collection Summary Report ¶

GET https://api.adda.io/api/admin/vendor/summary/report&limit=500&offset=0

Requestsexample 1

Headers

Authorization: bearer <token>

Responses200404401

Headers

Content-Type: application/json

Body

{
"status": "success",
"message": "Fetched Summary Report",
"data": {
"Total Receivables": " 62,362,449.76",
"Total Received": 43,786,515.68,
"Balance": " 18,575937.08"
}
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "apt_id": [
      "The apt id field is required."
    ],
    "from": [
      "The from field is required."
    ],
    "to": [
      "The to field is required."
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Collection Summary Report
GET`/api/admin/vendor/summary/report{&limit}{&offset}`

This API fetches the Collection Summary Report for an Community using its ID. You can use the API: “Get Community List for this Information”

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

apt_id: number (required) Example: 123
ADDA apt ID
from: date (required) Example: 2022
From Date value
to: date (required) Example: 2022
To Date value
limit: number (optional) Example: 500
offset: number (optional) Example: 0

ADDA Visitor APIs ¶

Create an expected visitor ¶

POST https://api.adda.io/api/adda/visitor/add

Requestsexample 1

Headers

Content-Type: multipart/form-data
Authorization: bearer <token>
Content-Type: application/json

Body

{
  "property_ref": "1xxx0",
  "name": "Random GUY",
  "no_of_visitors": 0,
  "phone_number": 9999999999,
  "visiting_date": "abc1234",
  "reason": "Delivery",
  "flat": "12",
  "is_guest": true
}

Schema

{
  "type": "object",
  "properties": {
    "property_ref": {
      "type": "string",
      "description": "Property Ref Number"
    },
    "name": {
      "type": "string",
      "description": "Visitor Name"
    },
    "no_of_visitors": {
      "type": "number",
      "description": "Send number of visitors"
    },
    "phone_number": {
      "type": "number",
      "description": "Make sure number is not masked. Also mobile number is valid one."
    },
    "visiting_date": {
      "type": "string",
      "description": "Format YYYY-MM-DD"
    },
    "reason": {
      "type": "string",
      "description": "Event Unix timestamp in sec (Indian Epoch Timestamp)"
    },
    "flat": {
      "type": "string",
      "description": "Flat Ref Number"
    },
    "is_guest": {
      "type": "boolean",
      "description": "Send true in-case of visitor is a guest"
    }
  },
  "required": [
    "property_ref",
    "name",
    "phone_number",
    "visiting_date",
    "flat"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Responses200500401

Headers

Content-Type: application/json

Body

{
  "status": "success",
  "message": "Visitor Added Successfully",
  "otp": "140716"
}

Headers

Content-Type: application/json

Body

{
  "error": "Server Error"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Create an expected visitor
POST`/api/adda/visitor/add`

Add an expected visitor for an community.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Parameter	Description
property_ref	A unique ref id for a community in ADDA system
name	Visitor name
no_of_visitors	Can be min 1 or more
phone_number	10 digit(for India) mobile number
visiting_date	Day visitor is expected (YYYY-MM-DD)
reason	Purpose of visit
flat	Every Unit of A community has a unique identifier. That can be collected from other endpoint(https://indiaapi.adda.io/docs/vendor/#adda-flat-apis-flats-by-adda-id-get)
is_guest	value (true/false) If this is set to true. Mobile number will be masked

ADDA Staff APIs ¶

Get staffs data ¶

GET https://api.adda.io/api/adda/staffs?apt_id=123&limit=500&offset=0

Requestsexample 1

Headers

Authorization: bearer <token>
Content-Type: application/json

Responses200500401

Headers

Content-Type: application/json

Body

{
  "status": "success",
  "message": "Fetched Staff Successfully",
  "data": {
    "activeStaff": [
      {
        "_id": "128853",
        "staff_badge": "2",
        "staff_name": "Kanta",
        "staff_category": "Maid",
        "staff_mobile": "99",
        "staff_dob": "1980-10-10",
        "staff_image": "default_staff.jpg",
        "staff_rfid": "",
        "staff_gender": "F",
        "staff_apt_id": "117110",
        "working_flats": ""
      },
      {
        "_id": "127102",
        "staff_badge": "PEB-1",
        "staff_name": "Gilakun",
        "staff_category": "Housekeeping",
        "staff_mobile": "0000000000",
        "staff_dob": "0000-00-00",
        "staff_image": "default_staff.jpg",
        "staff_rfid": "",
        "staff_gender": "M",
        "staff_apt_id": "117110",
        "working_flats": ""
      }
    ],
    "offset": "-1"
  }
}

Headers

Content-Type: application/json

Body

{
  "error": "Server Error"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Get staffs data
GET`/api/adda/staffs{?apt_id}{&limit}{&offset}`

Get all staffs for an apartment.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Link for authentication data: http://indiaapi.adda.io/docs/vendor/#vendor-authentication-retrieve-a-token-post

URI Parameters

HideShow

apt_id: number (required) Example: 123
ADDA apt ID
limit: number (optional) Example: 500
offset: number (optional) Example: 0

Post staff check in/out ¶

POST https://api.adda.io/api/adda/staff/checkInOut

Requestsexample 1

Headers

Authorization: bearer <token>
Content-Type: application/json

Body

{
  "apt_id": "117110",
  "staff_status": 0,
  "staff_date": "2020-07-14 19:35:19",
  "gateIn": "Gate-1",
  "gateOut": "",
  "staff_id": 128853
}

Responses200500401

Headers

Content-Type: application/json

Body

{
  "status": "success",
  "message": "Staff Processed Successfully"
}

Headers

Content-Type: application/json

Body

{
  "error": "Server Error"
}

Headers

Content-Type: application/json

Body

{
  "status": "Unauthorized"
}

Post staff check in/out
POST`/api/adda/staff/checkInOut`

Post staff check in/out for apartment.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Parameter	Description
staff_status	O for check-in 1 for checkout
staff_date	Check in/out Datatime
staff_id	Staff ID
gateIn	Staff check in Gate
gateOut	Staff check out Gate

Lattice APIs ¶

Access tokens are required to access nearly all endpoints of this API.

Update Work Order ¶

POST https://api.adda.io/api/lattice/WOUpdate

RequestsSample Payload

Headers

Content-Type: application/json
Authorization: bearer <token>

Body

{
    "adda_id": 132016, //Test ADDA created for Lattice
    "adda_wo_id": 123456,
    "wo_number": 1234,
    "status": "Closed",
    "status_remarks": "Pipe leakage has been fixed by John Doe at 12.12.12 10:15:00",
    "photos": [
        {
            "url": "https:\/\/addapublicmumbai.s3.ap-south-1.amazonaws.com\/mum\/brk\/2019\/5\/complaint\/4eb1e0650128f21c536980fbdecf3c11-1576741472-71547270_2462198770495653_1678855024689545216_n.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJHT5X55J3NXCUPBQ%2F20191219%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20191219T074434Z&X-Amz-SignedHeaders=Host&X-Amz-Expires=86400&X-Amz-Signature=e99a6a72dad352742b7f5da4fafcf463d303b47cc79bd04fd3260e781c1a6aa5",
            "format": "image",
            "name": "71547270_2462198770495653_1678855024689545216_n.jpg"
        },
        {
            "url": "https:\/\/addapublicmumbai.s3.ap-south-1.amazonaws.com\/mum\/brk\/2019\/5\/complaint\/4eb1e0650128f21c536980fbdecf3c11-1576741472-71547270_2462198770495653_1678855024689545216_n.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJHT5X55J3NXCUPBQ%2F20191219%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20191219T074434Z&X-Amz-SignedHeaders=Host&X-Amz-Expires=86400&X-Amz-Signature=e99a6a72dad352742b7f5da4fafcf463d303b47cc79bd04fd3260e781c1a6aa5",
            "format": "image",
            "name": "71547270_2462198770495653_1678855024689545216_n.jpg"
        }
    ],
    "status_timestamp": "YYYY-MM-DD HH:mm:ss"
}

Responses200422

Headers

Content-Type: application/json

Body

{
  "adda_wo_id": 123456,
  "updated": true,
  "reason": "Work order updated on ADDA"
}

Headers

Content-Type: application/json

Body

{
    "adda_wo_id": 123456,
    "updated", false,
    "reason": "Work order doesn't exist"
}

Update Work Order
POST`/api/lattice/WOUpdate`

Updates a work order

Payload Parameters

adda_id - ADDA Property ID
adda_wo_id - ADDA work order ID
wo_number - Work order Lattice reference number
status - Status of the work order
status_remarks - Update for the work order [‘New’, ‘In Progress’, ‘On Hold’, ‘Closed’]
photos - Array of photo file ID(s) [use File uload API for file ID]
status_timestamp - Status timestamp in GMT

Endpoint information


Requires authentication	Yes
Has restricted scope	No

SR Purchase Request ¶

POST https://api.adda.io/api/lattice/PRCreate

RequestsSample Payload

Headers

Content-Type: application/json
Authorization: bearer <token>

Body

{
    "adda_id": 132016, //Test ADDA created for Lattice
    "rf_pr_id": 1234,
    "pr_date": "YYYY-MM-DD",
    "pr_type": "Period Based Contract",
    "oa_supplier_id": 412312,
    "contract_period_from": "YYYY-MM-DD",
    "contract_period_to": "YYYY-MM-DD",
    "budget_type": "Budget Type",
    "pr_line": [
        {
            "category": "Category"
            "expense_head": "Expense Head",
            "description": "Description",
            "amount": 12.50
        },
        {
            "category": "Category 2",
            "expense_head": "Expense Head 2",
            "description": "Description 2",
            "amount": 34.50
        }
    ],
    "rf_approval_history": [
        {
            "timestamp": "2020-12-30 12-12-12",
            "actioned_by": "Actioned By",
            "action": "Approved",
            "remarks": "Remarks"
    ]
}

Responses200422

Headers

Content-Type: application/json

Body

{
  "rf_pr_id": 123456,
  "created": true,
  "reason": "Work order created on ADDA"
}

Headers

Content-Type: application/json

Body

{
    "rf_pr_id": 123456,
    "created", false,
    "reason": "Work order doesn't exist"
}

SR Purchase Request
POST`/api/lattice/PRCreate`

Create a new purchase request

Payload Parameters

rf_pr_id - Reflexion Purchase Request ID
adda_id - ADDA Property ID
pr_date - Purchase request creation date (YYYY-MM-DD)
pr_type - Purchase request type (“Period Based Contract”, “Out of Scope / Additional Work”)
oa_supplier_id - Reflexion Supplier Code
contract_period_from - Contract Period From (YYYY-MM-DD)
contract_period_to - Contract Period To (YYYY-MM-DD)
budget_type - Budget Type
pr_line - Array of PR line items
pr_line_item
- category - Category
- expense_head - Expense Head
- description - Description
- amount - Amount
rf_approval_history - Array of Reflexion Approval History
rf_approval_history_item
- timestamp - Date & Time
- actioned_by - Actioned by
- action - Action (Approved / Rejected / Rejected to Resubmit / Clarification etc.)
- remarks - Remarks

Endpoint information


Requires authentication	Yes
Has restricted scope	No

File upload ¶

POST https://api.adda.io/api/lattice/WOFile/132016

Requestsexample 1

Headers

Content-Type: multipart/form-data; boundary=---BOUNDARY

Body

-----BOUNDARY
Content-Disposition: form-data; name="image[file]"; filename="image.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: base64

/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
-----BOUNDARY

Responses200

Headers

Content-Type: application/json

Body

{
    "adda_id": 132016, //Test ADDA created for Lattice
    "id": 9876,
    "file_name": "image.jpg"
 }

File upload
POST`/api/lattice/WOFile/{adda_id}`

Upload files to ADDA platform

Endpoint information


Requires authentication	Yes
Has restricted scope	No

URI Parameters

HideShow

adda_id: number (required) Example: 132016
ADDA Property ID

Facility APIs ¶

Authentication is required to access nearly all endpoints of this API.

Get Clubhouse Membership Details ¶

GET https://api.adda.io/api/adda/clubhouse/members

Requestsexample 1

Headers

Content-Type: multipart/form-data
Authorization: bearer <token>

Responses200401500

Headers

Content-Type: application/json

Body

[
  {
    "membership_name": "3 months membership",
    "user_name": "John",
    "member_start_date": "2023-01-01",
    "member_end_date": "2023-05-30"
  },
  {
    "membership_name": "6 months membership",
    "user_name": "Steve",
    "member_start_date": "2023-01-01",
    "member_end_date": "2023-05-30"
  }
]

Headers

Content-Type: application/json

Body

{
  "error": "Unauthorized"
}

Headers

Content-Type: application/json

Body

{
  "error": [
    "Server Error",
    ""
  ]
}

Get Clubhouse Membership Details
GET`/api/adda/clubhouse/members`

Get the list of memberships and Active subscribers for a Clubhouse.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Parameter	Description
membership_name	Name of the Membership user is part of.
user_name	Name of the User
member_start_date	Start date of the Membership of the user
member_end_date	End date of the Membership of the user

Get Facility List ¶

GET https://api.adda.io/api/adda/facility/list

Requestsexample 1

Headers

Content-Type: multipart/form-data
Authorization: bearer <token>

Responses200401500

Headers

Content-Type: application/json

Body

[
  {
    "facility_id": 1,
    "facility_name": "Swimming pool Date",
    "facility_type": "Date",
    "facility_owner_cost": "10.00",
    "facility_tenant_cost": "20.00",
    "facility_refundable_deposit": "0.00"
  },
  {
    "facility_id": 2,
    "facility_name": "Gym Time",
    "facility_type": "Hour",
    "facility_owner_cost": "10.00",
    "facility_tenant_cost": "20.00",
    "facility_refundable_deposit": "0.00"
  }
]

Headers

Content-Type: application/json

Body

{
  "error": "Unauthorized"
}

Headers

Content-Type: application/json

Body

{
  "error": [
    "Server Error",
    ""
  ]
}

Get Facility List
GET`/api/adda/facility/list`

Get the list of common facilities which are available for booking in a Community and it’s corresponding details.

Endpoint information


Requires authentication	Yes
Has restricted scope	No

Parameter	Description
facility_id	Unique ID of the facility
facility_name	Name of the facility
facility_type	Type of the Facility (Hour, Date & Slot based)
facility_owner_cost	Cost applicable for the Owner of the Flat
facility_tenant_cost	Cost applicable for the Tenant of the Flat
facility_refundable_deposit	Refundable Deposit of the Facility

Generated by aglio on 25 Jul 2024

API Endpoint

Note ¶

Authentication ¶

Example Header ¶

Claims ¶

HTTP Methods ¶

Media Type ¶

Status Codes and Errors ¶

General Notes ¶

Vendor Authentication ¶

Retrieve a token ¶

Headers

Body

Schema

Headers

Body

Schema

Retrieve a tokenPOST/api/auth/login

Refresh a token ¶

Headers

Headers

Body

Schema

Headers

Body

Refresh a tokenGET/api/auth/refresh

Change password ¶

Headers

Body

Headers

Body

Headers

Body

Change passwordPUT/api/auth/password

Get profile ¶

Headers

Headers

Body

Headers

Body

Get profileGET/api/auth/me

Get Community List ¶

Headers

Headers

Body

Body

Get Community ListGET/api/admin/vendor/apartments/list

ADDA UNIT APIs ¶

UNITS USING MEMBER PHONE ¶

Headers

Headers

Body

Headers

Body

Headers

Body

UNITS USING MEMBER PHONEGET/api/adda/flats{?owner_phone}{?count}

Units by Community ¶

Headers

Headers

Body

Headers

Body

Headers

Body

Units by CommunityGET/api/adda/flats/{?apt_id}{?count}

Members in a Unit ¶

Headers

Headers

Body

Headers

Body

Headers

Body

Members in a UnitGET/api/adda/flats{?flat_id}{?count}

ADDA ACCOUNTING APIs ¶

Post Invoices to units ¶

Headers

Body

Headers

Note

Authentication

Example Header

Claims

HTTP Methods

Media Type

Status Codes and Errors

General Notes

Retrieve a token
POST`/api/auth/login`

Refresh a token
GET`/api/auth/refresh`

Change password
PUT`/api/auth/password`

Get profile
GET`/api/auth/me`

Get Community List
GET`/api/admin/vendor/apartments/list`

UNITS USING MEMBER PHONE
GET`/api/adda/flats{?owner_phone}{?count}`

Units by Community
GET`/api/adda/flats/{?apt_id}{?count}`

Members in a Unit
GET`/api/adda/flats{?flat_id}{?count}`

Post Invoices to units
POST`/api/adda/flat/invoices`

Post Receipts to units
POST`/api/adda/flat/receipts`

Defaulter Units by Community
GET`/api/adda/flat/defaulters{?apt_id}{&count}`

Unit Account Statement
GET`/api/adda/accountStatement/{?apt_id}`

Unit Invoice and Receipt List
POST`/api/adda/invoiceReceiptList`

Get Invoice Details
GET`/api/adda/invoice/{?apt_id}{&invoice_id}`

Get Receipt Details
GET`/api/adda/receipt/{?apt_id}{&receipt_id}`