Invoice Net Position Report

Production

GET

/api2/reports/invoice_net_position

One row per invoice with its debit notes, refunds, credit notes, completed payments and applied advance payments listed under it as sub-rows, and the net position the page prints: Net = (Amount + Debit) - Returns. Credit notes linked to no invoice are standalone rows (they reduce Amount) unless hide_credit_notes is on. Newest invoice first; one block per currency, with a Totals row for each.

Mirrors /owner/reports/report/invoice_net_position.

The report has no grouping, no ordering control and no summary view. It is not paginated.

Refused, not ignored: parameters this endpoint does not offer, including the page's display and export controls, are a 400 naming the parameter.

Bounded: a request matching more invoices than the endpoint can return in one response is a 400, never a partial report.

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.

Bodyapplication/json

🟠400Error400

🟠401Error401

🟠403Error403

🟠404Error404

🟠405Error405

🔴500Error500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api2/reports/invoice_net_position?from_date=2025-01-01&to_date=2025-03-31&payment_status=&client_id=&client_category=&staff_id=&hide_credit_notes=&e_invoice_status=&branch_id=&currency=' \
--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": "invoice_net_position",
            "title": "string",
            "base_currency": "string",
            "consolidated": true
        },
        "filters": {
            "from_date": "2019-08-24",
            "to_date": "2019-08-24",
            "payment_status": 0,
            "client_id": [
                0
            ],
            "client_category": [
                0
            ],
            "staff_id": [
                0
            ],
            "hide_credit_notes": true,
            "e_invoice_status": "string",
            "branch_id": [
                0
            ],
            "currency": "string"
        },
        "columns": [
            {
                "key": "string",
                "label": "string",
                "currency_suffixed": true
            }
        ],
        "currencies": [
            {
                "currency": "string",
                "totals": {
                    "amount": 0,
                    "debit": 0,
                    "gross": 0,
                    "paid": 0,
                    "returns": 0,
                    "net": 0,
                    "document_count": 0
                },
                "rows": [
                    {
                        "row_type": "main",
                        "id": 0,
                        "parent_id": 0,
                        "sub_kind": "document",
                        "no": "string",
                        "type_label": "string",
                        "date": "2019-08-24",
                        "client": "string",
                        "currency_code": "string",
                        "amount": 0,
                        "debit": 0,
                        "gross": 0,
                        "paid": 0,
                        "returns": 0,
                        "net": 0,
                        "returns_breakdown": {
                            "unpaid_refund": 0,
                            "paid_refund": 0,
                            "credit_note": 0
                        },
                        "net_negative": true,
                        "payment_status": 0,
                        "status_codes": [
                            0
                        ],
                        "status_labels": [
                            "string"
                        ],
                        "e_invoice_status": "string",
                        "e_invoice_status_label": "string"
                    }
                ]
            }
        ],
        "meta": {
            "currency_count": 0,
            "document_count": 0,
            "row_count": 0
        }
    }
}

Advance Payments Report

Invoice-Returns Cross-Reference Report