Invoice-Returns Cross-Reference Report

Production

GET

/api2/reports/invoice_return_cross_reference

Every invoice that has at least one non-draft credit note or refund receipt, with its returns nested under it, the net of the two, and subtotals and totals as the page prints them.

Mirrors /owner/reports/report/invoice_return_cross_reference and backs the Invoice-Returns Cross-Reference card on the Sales tab, whose own request is group_by=Invoice&currency=All.

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_return_cross_reference?from_date=2025-02-01&to_date=2025-05-31&client_id=&invoice_status=&return_type=&e_invoice_status=&branch_id=&currency=&group_by=&order_by=' \
--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_return_cross_reference",
            "title": "string",
            "group_by": "string",
            "base_currency": "string",
            "consolidated": true
        },
        "filters": {
            "from_date": "2019-08-24",
            "to_date": "2019-08-24",
            "client_id": [
                0
            ],
            "invoice_status": 0,
            "return_type": 0,
            "e_invoice_status": "string",
            "branch_id": [
                0
            ],
            "currency": "string",
            "group_by": "string",
            "order_by": [
                "string"
            ]
        },
        "columns": [
            {
                "key": "string",
                "label": "string",
                "currency_suffixed": true
            }
        ],
        "currencies": [
            {
                "currency": "string",
                "totals": {
                    "invoice_total": 0,
                    "return_amount": 0,
                    "net_amount": 0
                },
                "summary": {
                    "invoices_with_returns": 0,
                    "return_rate_pct": 0,
                    "shown": true
                },
                "groups": [
                    {
                        "key": "string",
                        "label": "string",
                        "subtotals": {
                            "invoice_total": 0,
                            "return_amount": 0,
                            "net_amount": 0
                        },
                        "invoices": [
                            {
                                "id": 0,
                                "no": "string",
                                "date": "2019-08-24",
                                "client": "string",
                                "type_label": "string",
                                "invoice_total": 0,
                                "return_amount": 0,
                                "net_amount": 0,
                                "payment_status": 0,
                                "payment_status_label": "string",
                                "sales_person": "string",
                                "e_invoice_status": "string",
                                "e_invoice_status_label": "string",
                                "branch": "string",
                                "currency_code": "string",
                                "returns_count": 0,
                                "returns": [
                                    {
                                        "id": 0,
                                        "no": "string",
                                        "date": "2019-08-24",
                                        "type": 5,
                                        "type_label": "string",
                                        "amount": 0,
                                        "e_invoice_status": "Not Submitted",
                                        "e_invoice_status_label": "string"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "meta": {
            "currency_count": 0,
            "group_count": 0,
            "invoice_count": 0,
            "return_count": 0,
            "conversion_rates": {
                "property1": {
                    "property1": 0,
                    "property2": 0
                },
                "property2": {
                    "property1": 0,
                    "property2": 0
                }
            }
        }
    }
}

Sales Revenue Report

Invoice Net Position Report