Skip to main content
GET
/
api
/
reports
/
financial
Generate financial report
curl --request GET \
  --url https://api.propops.app/api/reports/financial \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": [
    {
      "job_ref": "JOB-001",
      "job_title": "Boiler Service - Unit 001",
      "contractor_name": "Contractor_001",
      "invoice_no": "INV-001",
      "total_amount": 250,
      "contractor_budget": 180,
      "payment_received": true,
      "completed_date": "2024-06-02"
    }
  ],
  "count": 150
}

Authorizations

​
Authorization
string
header
required

All API requests must include a valid Bearer token in the Authorization header. Tokens are 64-character SHA-256 session hashes issued by the PropOps authentication system.

Example:

Authorization: Bearer a1b2c3d4e5f6...

Query Parameters

​
search
string
​
from_date
string<date>
Example:

"2024-01-01"

​
to_date
string<date>
Example:

"2024-06-30"

​
branch_id
integer
​
format
enum<string>
default:json
Available options:
json,
csv
​
limit
integer
default:50

Maximum number of records to return (default 50, max 200).

Required range: 1 <= x <= 200
​
offset
integer
default:0

Number of records to skip for pagination.

Required range: x >= 0

Response

Financial report data

​
success
boolean
Example:

true

​
message
string
Example:

"Operation completed successfully"

​
data
object[]
​
count
integer
Example:

150