Reporting

Server

Download schema

Purchase summary reports and financial reporting

Get saved accounting export configuration for a location

GET

https://common-api.karma.life

/api/v1/reporting/export-settings

Get saved accounting export configuration for a location › query Parameters

locationId

integer · required

exportType

string · enum · required

Enum values:

sie

gbat10

Get saved accounting export configuration for a location › Responses

Default Response

status

string · enum

Enum values:

success

object

Save accounting export configuration for a location

PUT

https://common-api.karma.life

/api/v1/reporting/export-settings

Save accounting export configuration for a location › Request Body

locationId

integer · required

exportType

string · enum · required

Enum values:

sie

gbat10

object · required

includeKarmaFees

boolean · required

splitByCostCenter

boolean

Default: false

Save accounting export configuration for a location › Responses

Default Response

status

string · enum

Enum values:

success

object

PUT/api/v1/reporting/export-settings

curl --request PUT \
  --url https://common-api.karma.life/api/v1/reporting/export-settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "locationId": 0,
  "exportType": "sie",
  "mappings": {
    "key": "string"
  },
  "includeKarmaFees": true,
  "splitByCostCenter": false
}
'

Example Request Body

{
  "locationId": 0,
  "exportType": "sie",
  "mappings": {
    "key": "string"
  },
  "includeKarmaFees": true,
  "splitByCostCenter": false
}

json

Example Responses

{
  "status": "success",
  "data": {
    "exportSettings": {
      "locationId": 0,
      "exportType": "sie",
      "mappings": {
        "key": "string"
      },
      "includeKarmaFees": true,
      "splitByCostCenter": true,
      "updatedAt": "updatedAt",
      "updatedByRetailerUserId": 0,
      "updatedByName": "updatedByName"
    }
  },
  "meta": {
    "requestId": "requestId",
    "timestamp": "timestamp",
    "executionTimeMs": 0
  }
}

json

application/json

Get aggregated purchase data for accounting export

GET

https://common-api.karma.life

/api/v1/reporting/purchase-summary

Get aggregated purchase data for accounting export › query Parameters

locationId

integer · required

Location ID to get purchase summary for

startDate

string · pattern: ^\d{4}-\d{2}-\d{2}$ · required

Start date in YYYY-MM-DD format

endDate

string · pattern: ^\d{4}-\d{2}-\d{2}$ · required

End date in YYYY-MM-DD format (inclusive)

splitByCostCenter

boolean

When true, rows in items / vats / psp gain optional costCenterCode + costCenterName, and the response includes a top-level costCenters array. Defaults to false for byte-identical legacy behaviour.

Default: false

Get aggregated purchase data for accounting export › Responses

Default Response

status

string · enum

Enum values:

success

object

GET/api/v1/reporting/purchase-summary

curl --request GET \
  --url 'https://common-api.karma.life/api/v1/reporting/purchase-summary?locationId=%3Cnumber%3E&startDate=%3Cstring%3E&endDate=%3Cstring%3E'

Example Responses

{
  "status": "success",
  "data": {
    "purchaseSummary": {
      "items": [
        {
          "account": "account",
          "description": "description",
          "amount": 0,
          "comment": [
            {
              "id": 0,
              "name": "name"
            }
          ],
          "costCenterCode": "costCenterCode",
          "costCenterName": "costCenterName"
        }
      ],
      "vats": [
        {
          "vat": 0,
          "amount": 0,
          "costCenterCode": "costCenterCode",
          "costCenterName": "costCenterName"
        }
      ],
      "psp": [
        {
          "psp": "psp",
          "amount": 0,
          "tips": 0,
          "costCenterCode": "costCenterCode",
          "costCenterName": "costCenterName"
        }
      ],
      "fees": [
        {
          "psp": "psp",
          "vat": 0,
          "amount": 0
        }
      ],
      "costCenters": [
        {
          "code": "code",
          "name": "name"
        }
      ]
    }
  },
  "meta": {
    "requestId": "requestId",
    "timestamp": "timestamp",
    "executionTimeMs": 0
  }
}

json

application/json

Purchases Reviews

Get saved accounting export configuration for a location

GET

https://common-api.karma.life

/api/v1/reporting/export-settings

Get saved accounting export configuration for a location › query Parameters

locationId

integer · required

exportType

string · enum · required

Enum values:

sie

gbat10

Get saved accounting export configuration for a location › Responses

Default Response

status

string · enum

Enum values:

success

object

Save accounting export configuration for a location

PUT

https://common-api.karma.life

/api/v1/reporting/export-settings

Save accounting export configuration for a location › Request Body

locationId

integer · required

exportType

string · enum · required

Enum values:

sie

gbat10

object · required

includeKarmaFees

boolean · required

splitByCostCenter

boolean

Default: false

Save accounting export configuration for a location › Responses

Default Response

status

string · enum

Enum values:

success

object

Get aggregated purchase data for accounting export

GET

https://common-api.karma.life

/api/v1/reporting/purchase-summary

Get aggregated purchase data for accounting export › query Parameters

locationId

integer · required

Location ID to get purchase summary for

startDate

string · pattern: ^\d{4}-\d{2}-\d{2}$ · required

Start date in YYYY-MM-DD format

endDate

string · pattern: ^\d{4}-\d{2}-\d{2}$ · required

End date in YYYY-MM-DD format (inclusive)

splitByCostCenter

boolean

When true, rows in items / vats / psp gain optional costCenterCode + costCenterName, and the response includes a top-level costCenters array. Defaults to false for byte-identical legacy behaviour.

Default: false

Get aggregated purchase data for accounting export › Responses

Default Response

status

string · enum

Enum values:

success

object