HallPass API (version v1)

API Reference

The HallPass organized around REST API. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication.

Base URL

https://apidev.hallpasshq.com

Authentication

The HallPass API uses API keys to authenticate user requests. You can view and manage your API keys here Link Here. Test mode secret keys have the prefix HP_test_ and live mode secret keys have the prefix HP_live_.

All API requests must be made over HTTPS . Calls made over plain HTTP will no result/fail. API requests without authentication will also fail.

Access Token

{"access_token":"054bf8ee0664d30ac597abe6369d8c0b49f1d6e8","expires_in":3600,"token_type":"Bearer","scope":null}

Errors

HallPass uses conventional HTTP response codes to indicate the success or failure of an API request.

HTTP status code details

200 - success Everything worked as expected.
400 - "No record found!" The request was unacceptable, often due to missing a required parameter

Payee

The Payee object representing the payee pn Hallpass. You can retrieve it to see all payee.

The Payee can also be retrieve by ID and TYPE to see all payee.

End points

GET /payee/

GET /payee/:id    /payee/?id=1

GET /payee/:type    /payee/?type=1

The payeee object response


                        {
                          "response": "success",
                          "statusCode": "200",
                          "payees": [
                              {
                                  "payeeID": 1,
                                  "payeeType": 1,
                                  "posID": "",
                                  "locID": 1,
                                  "vendorName": "Birdie",
                                  "vendorEmail": "vincent.mota@gmail.com",
                                  "vendorLogo": "logo_birdie.png",
                                  "commish": "25%",
                                  "dailyrent": "0",
                                  "status": 1,
                                  "ip_adrs": "50.220.125.190",
                                  "dateCreated": "2023-04-18 04:00:30",
                                  "lastUpdated": "2023-06-19 17:18:44"
                              },
                          {.........}, 
                          {........}
                   ]
}

Users

The USERS object representing the all users in Hallpass. You can retrieve it to see all users.

The user can also be retrieve by ID

End points

GET /user/

GET /user/:id    /user/?id=1

The users object response


                        {"response":"success",
                        "statusCode":"200",
                        "users":[{"id":1,
                        "email":"hallpass@hallpass.com",
                        "accountType":"Admin",
                        "locationID":"Destin",
                        "status":1}
                        {.........}, 
                        {........}
          ]
}

Transactions

The Transaction object representing the all transactions in Hallpass. You can retrieve it to see all ransactions.

The transaction details can also be retrieve by ID

End points

GET /transaction/

GET /transaction/:id    /transaction/?id=399

The user object response


                          {"response":"success",
                          "statusCode":"200",
                          transactions":[{"paymentID":399,
                          "dailyrent":"20",
                          "processDate":"33",
                          "gross":"1000",
                          "taxes":"100",
                          "tips":"100",
                          "common":"100",
                          "commish":"24",
                          "cash":"100",
                          "weeklyrent":"140",
                          "penalty":"0",
                          "openbalance":"0",
                          "finalPayment":"587",
                          "dateCreated":"2023-08-21},
                    {.........}, 
                    {........}
                ]
}

Invoices

The Invoice object representing the all invoices in Hallpass. You can retrieve it to see all invoices.

The invoice details can also be retrieve by ID

End points

GET /invoice/

GET /invoice/:id    /invoice/?id=1

The invoices object response


{
    "response": "success",
    "statusCode": "200",
    "invoices": [
        {
            "id": 27,
            "gl_code": "123456",
            "Invoice notes": "INV-000001",
            "payeeID": 13,
            "vendorName": "Test Supplier 1",
            "processDate": "2023-07-11",
            "finalPayment": "203032",
            "dateCreated": "2023-07-18 06:06:16"
        },
        {.........}, 
        {........}
    ]
}