reports

Get the reports of a merchant

/reports

Returns a list of reports of a merchant

Responses

[
  {
    "mexcCustomerjournalsid": 146647,
    "type": "Month",
    "journalid": 1,
    "mexcModulesid": 46862,
    "mm3servicesid": 16596,
    "mexcCustomerinvoicesids": "2130361,2130487,2130496",
    "json": "{\"SEK\":{\"taxes\":{\"0\":0,\"25\":11.4},\"totals\":{\"0\":6,\"25\":45.6},\"totalnet\":51.6,\"totaltax\":11.4,\"totalreduction\":0,\"total\":63,\"topay\":63,\"rounding\":0,\"invoiceid_real\":\"\",\"invoicedate\":\"SUMMA\"}}",
    "filename": "135895340050fffbb1de7b0.pdf",
    "createddate": "2018-05-30T22:00:00.000Z",
    "timestamp": "2018-05-30T22:00:00.000Z"
  }
]

Get the number of matching reports according to the supplied filters

/reports/count

Returns object with a count representing the number of reports that matches the current filter.

Responses

{
  "count": 7
}

Find report by mexcCustomerjournalsid

/reports/{mexcCustomerjournalsid}

Returns a single report

Request parameters

Responses

Get the settlement report list

/reports/settlements

Returns the list of the settlement reports

Responses

{
  "count": 1,
  "contents": [
    {
      "Key": "123-2023-12-23.pdf",
      "settlementDate": "2023-12-23",
      "settlementId": 123,
      "count": 2,
      "total": 250,
      "types": "Purchase",
      "LastModified": "2022-08-25T11:57:37.000Z"
    }
  ]
}

Get the settlement report

/reports/settlements/{settlementId}

Returns the settlement reports

Request parameters

Responses

[
  {
    "invoiceno": "654321",
    "orderno": "123456",
    "invoicedate": "2023-12-24",
    "customername": "Nisse Hult",
    "amount": null,
    "fee": null,
    "type": "Paid",
    "paidInCapital": null
  }
]

Get the available dates for settlement reports

/reports/settlements/dates

Returns the dated for settlement reports

Responses

{
  "count": 5,
  "contents": [
    {
      "settlementDate": "2023-12-02"
    },
    {
      "settlementDate": "2023-12-09"
    },
    {
      "settlementDate": "2023-12-16"
    },
    {
      "settlementDate": "2023-12-23"
    },
    {
      "settlementDate": "2023-12-30"
    }
  ]
}

Export the settlement report in CSV format

/reports/settlements/{settlementId}/export/csv

Returns the settlement reports in CSV format

Request parameters

Responses

Export the settlement report in XML format

/reports/settlements/{settlementId}/export/xml

Returns the settlement reports in XML format

Request parameters

Responses

Export the settlement report as a PDF

/reports/settlements/{settlementId}/export/pdf

Returns the settlement reports as a PDF. This is the standard report that is generated by the system.

Request parameters

Responses

Get the statistics of reports weekly

/reports/statistics/weekly

Returns the statistics weekly

Responses

[
  {
    "week": 27,
    "total": 2312312.5
  }
]

Get the statistics of reports monthly

/reports/statistics/monthly

Returns the statistics monthly

Responses

{
  "2022": [
    {
      "month": 2,
      "total": 2312312.5
    }
  ]
}

Last modified: 13 September 2024