Financial Transactions Report

Production

GET

/api2/reports/financial_transactions

Every customer payment, supplier payment, income, expense and time-tracking cost in one currency, oldest first, each with the balance after it. opening_balance is the balance before the first row of the requested page; totals cover the rows of that page only, as the page's Total Income, Total Expenses and End of period balance do.

Mirrors /owner/reports/financial_report. Money in is positive, money out negative.

Paged: 300 rows per page; pagination says how many pages there are.

One currency per request; nothing is converted between currencies.

Request

Authorization

OAuth 2.0

Password

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://www.daftra.com/v2/oauth/token

API Key

Add parameter in header

apikey

Example:

apikey: ********************

API Key

Add parameter in cookie

OISystem

Example:

OISystem: ********************

Query Params

Header Params

Responses

🟢200

application/json

The report page.

Bodyapplication/json

🟠400Error400

🟠401Error401

🟠403Error403

🟠404Error404

🟠405Error405

🔴500Error500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api2/reports/financial_transactions?date_range_selector=lastyear&currency=SAR&branch_id=&work_order_id=&page=' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "data": {
        "report": {
            "key": "financial_transactions",
            "title": "string",
            "currency": "string"
        },
        "filters": {
            "date_range_selector": "lastyear",
            "date_range_from": "2019-08-24",
            "date_range_to": "2019-08-24",
            "period": {
                "from": "2019-08-24",
                "to": "2019-08-24"
            },
            "currency": "string",
            "work_order_id": 0,
            "branch_id": [
                0
            ],
            "page": 0
        },
        "opening_balance": 0,
        "rows": [
            {
                "date": "2019-08-24",
                "type": "invoice",
                "id": 0,
                "document_id": 0,
                "document_no": "string",
                "payment_method": {
                    "key": "string",
                    "label": "string"
                },
                "reference": "string",
                "category": "string",
                "vendor": "string",
                "note": "string",
                "notes": "string",
                "description": "string",
                "amount": 0,
                "balance_after": 0
            }
        ],
        "totals": {
            "scope": "page",
            "income": 0,
            "expenses": 0,
            "closing_balance": 0
        },
        "pagination": {
            "page": 0,
            "per_page": 300,
            "total_rows": 0,
            "total_pages": 0
        }
    }
}

Cash Flow Report

Email Sender