Baypayo Meter Reading Program WEB API Developer
Integrate meter consumption data and monthly heat cost invoices into your own software
Integration via Web API
With the Baypayo Meter Reading System Web API, you can integrate meter consumption data and monthly heat cost invoices into third-party software.
Real-Time Data Access
Through the Baypayo Web API integration, developers can access Baypayo meter reading data in their own software in real time. Central systems can retrieve heat cost invoices on a regular basis. (A real-time data access system for heat cost invoices and meter reading data.)
Automatic Billing
By accessing Baypayo heat cost invoice data, you can automatically bill fuel dues; using the Baypayo Web API, you can also show invoice details to your users for debt breakdowns.
Who Integrates With It?
Real-time meter and invoice data integration for dues-tracking applications.
Integrate Baypayo data directly into their own proprietary software.
Automatically feed heat cost invoice data into accounting workflows.
API Query Examples
To pull your registered site's heat cost allocation data through our system, you must first contact us to register as a user. After registration you'll receive a username and password, which you can use with the queries below to bring site-level data into your own system.
For user registration, contact: 0541 229 7296
http://api.baypayo.net/api/Aute/GetUser?username={username}&password={password}Retrieves login and UserId information, along with the Token used in subsequent queries.
{
"Data": {
"UserId": 46274,
"DisplayName": "Full Name",
"UserName": "{username}",
"RoleName": "Manager",
"Token": "{access_token}"
},
"IsSuccess": true,
"Message": "Operation successful."
}http://api.baypayo.net/api/AidatTakip/GetUserSiteList?userId={userId}Returns the registered sites and their buildings/units for the given UserId. Fetch this once and store the site/building/unit codes in your own system — no need to call it repeatedly.
{
"Data": {
"UserId": 46274,
"SiteList": [
{
"SiteAdi": "Sample Site",
"SiteKod": "BP-S-10526",
"BlokList": [
{ "BinaAdi": "BLOCK A", "BinaKod": "BP-B-13636" }
],
"DaireList": [
{ "BinaKod": "BP-B-13636", "DaireAdi": "A1", "DaireKod": "BP-D-75701" }
]
}
]
},
"IsSuccess": true
}http://api.baypayo.net/api/AidatTakip/GetSiteLastIsiPayList?userId={userId}&sitekod={siteCode}Returns the latest per-unit heat cost allocation amounts, due date and invoice view link for the given site code.
{
"Data": [
{
"SiteKod": "BP-S-10526",
"DaireKod": "BP-D-75701",
"AidatDonemAdi": "January 2024",
"DaireIsiPay": {
"IsiPayOrtakTutar": 473.33,
"IsiPayTuketimTutar": 2209.36,
"SuPayTutar": 364.71
},
"OdeneceTutar": {
"SonOdemeTarihi": "05.01.2024",
"ToplamPayTutar": 2793.00
},
"IsiPayPdfViewURL": "https://baypayo.com.tr/online-faturasorgulama?..."
}
],
"IsSuccess": true
}After the token query (Query 1), all subsequent queries must include the Authorization: Bearer {token} and Content-Type: application/json headers.
You can share the link under "IsiPayPdfViewURL" with your users so they can view detailed invoice information.
For Property Management Companies and Dues-Tracking Software Developers
The Baypayo Web API brings great convenience to property management companies and managers. Leading the industry, the Baypayo meter reading Web API system allows real-time meter data and heat cost invoices to work in integration with dues-tracking software.