Get Accounting Report

Purpose: Retrieves a detailed financial report listing all completed Orders and their associated payment transactions for a specified client and time period.

---

Endpoint Details

• HTTP Verb: GET
• URL Segment: /v3/client/{clientId}/accountingreport
• OpenAPI Spec: View in Swagger UI
• Notes: This requires the application to have reached the Completed status, and the relevant transaction date (e.g., date of funding or payout) must fall within the inclusive from and to date range.

---

Path Parameters

Field Name	Description	Type	Additional Information
clientId	The unique ID of the client to generate the report for.	string ($uuid)	Required.

---

Query Parameters

Field Name	Description	Type	Additional Information
from	The start date/time (inclusive) of the period for the report.	string ($date-time)	Required. ISO 8601 format.
to	The end date/time (inclusive) of the period for the report.	string ($date-time)	Required. ISO 8601 format.

---

Request Body

No Request Body Required.

---

Response Body

The API returns a financial report object of type AccountingReportResponse upon successful retrieval (HTTP 200 OK).

AccountingReportResponse Schema

Field Name	Description	Type	Additional Information
totalAmountPaidOut	The sum of all amountPaidOut in the report period.	number ($double)
totalAmountPaid	The sum of all amountPaid in the report period.	number ($double)
totalDebitedFee	The sum of all debitedFee in the report period.	number ($double)
clientId	The unique ID of the client the report belongs to.	string ($uuid)
transactions	The period's completed, and started contracts. (completed orders/applications).	array of AccountingReportItem	Nullable. See AccountingReportItem Schema

AccountingReportItem Schema

Field Name	Description	Type	Additional Information
orderId	The unique ID of the order related to the transaction.	string ($uuid)
refNo	The client's own reference number for the order.	string	Nullable.
orderDate	The creation date of the order.	string ($date-time)
orderInfo	Custom merchant-specific data.	Object	Nullable. See OrderInfo Schema
transaction	The payment and fee details associated with the started contract.	Object	See AccountingReportPayment Schema

AccountingReportPayment Schema

Field Name	Description	Type	Additional Information
amountPaid	The amount paid by the customer.	number ($double)
amountPaidOut	The amount paid out to the merchant.	number ($double)
debitedFee	The fee debited by the finance provider.	number ($double)
currency	The currency of the transaction.	string
date	The date the transaction occurred (e.g., capture date).	string ($date-time)
paidOutDate	The date the funds were paid out to the merchant.	string ($date-time)

---

Example Successful Response (200 OK)

{
  "totalAmountPaidOut": 49000.0,
  "totalAmountPaid": 50000.0,
  "totalDebitedFee": 1000.0,
  "clientId": "a1b1c1d1-e2f2-3g4h-5i6j-7k8l9m0n1o2p",
  "transactions": [
    {
      "orderId": "b8a8b8b8-c1c1-d2d2-e3e3-f4f4f4f4f4f4",
      "refNo": "AB-10001",
      "orderDate": "2024-01-01T01:23:45.678Z",
      "orderInfo": {
        "salesPersonId": "51"
      },
      "transaction": {
        "amountPaid": 50000,
        "amountPaidOut": 49000,
        "debitedFee": 1000,
        "currency": "SEK",
        "date": "2024-01-05T10:00:00.000Z",
        "paidOutDate": "2024-01-06T00:00:00.000Z"
      }
    }
  ]
}

---

Error Responses

The following HTTP status codes are explicitly documented for this method:

Status Code	Description
400 Bad Request	The request was invalid (e.g., required query strings are missing or date formats are incorrect).
401 Unauthorized	Authentication failure (e.g., missing or invalid API key/credentials).
404 Not Found	The specified clientId does not exist.