This is a staging build of the docs
We've reorganized our products to make building with Codat easier than ever
Skip to main content

Refunds

Reference document for the endpoint that produces refunds data

The Refunds endpoint retrieves the number and total value of refunds, and the refund rate for a specific company's commerce connection, over one or more periods of time.

Refer to the Lending reporting structure page for more detail on reports in Lending.

For Refunds, these are the dimensions and measures:

Dimensions

  • Period
  • Refund metrics

Measures

  • Count
  • Value
  • Percentage

Report Data

  • Is structured based on dimension (index =“0”), i.e. Period.
  • The endpoint will return the number of refunds, value of refunds and refund rate for each period.

View the Refunds formulas.

The endpoint is available in our API reference.

GET /data/companies/{companyId}/connections/{connectionId}/lending/commerceMetrics/refunds

Parameters

ParameterTypeDescriptionRequired
reportDatestring
See Date
YYYY-MM-DD
Datetime or Date (inclusive of the whole day).
Required
periodUnitstringThe period unit of time returned, and it can be: “Day”, “Week”, “Month”, “Year”.Required
periodLengthintegerBased on the period unit provided. It must be positive, not zero and an integer.Required
numberOfPeriodsintegerThe number of periods to return. It must be positive, not zero and an integer.Required
includeDisplayNamesbooleanShows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. Default is false.Optional

Data model

The response structure is split into four areas: Report info, Dimensions, Measures and Report data.

Report info

FieldTypeDescription
namestring"refunds"
displayNamestring"Refunds"

Dimensions

Refunds consists of these dimensions: Period and Refund metrics.

Dimension (index = “0”): Period

FieldTypeDescription
displayNamestring"Period"
typestring"datespan"
itemsarray,
See Dimension (index = "0") items
Returns an array of "Period". This is driven by the query parameter values.
Ordered by latest to earliest periods.

Dimension (index = “0”) items

FieldTypeDescription
displayNamestring"Period n"
startstring,
See Date
YYYY-MM-DD, date in which the period begins (inclusive).
endstring,
See Date
YYYY-MM-DD, date in which the period ends (inclusive).

Dimension (index = “1”): Refund metrics

FieldTypeDescription
displayNamestring"Refund metrics"
typestring"string"
itemsarray
See Dimension (index = "1") items
Returns an array of refund metrics.

Dimension (index = “1”) items

FieldTypeDescription
valuestringNumber of refunds, Value of refunds or Refund rate.
These will always show for any response in this report. The dimension values are not dependent on the user's query parameters.

Measures

Measures provide information about the measures contained in the report data.

The three measures for this report are as follows:

Index “0” - Count

FieldTypeDescription
displayNamestring"Count"
typenumber"int"

Index “1” - Value

FieldTypeDescription
displayNamestring"Value"
unitsstringThe base currency of the company's commerce connection.
typestring"currency"

Index “2” - Percentage

FieldTypeDescription
displayNamestring"Percentage"
unitsstring"%"
typestring"percentage"

Report data

The report data combines multiple reporting dimensions and outputs the value of each combination. Each dimension reference is specified.

Since the report data is reflective of two dimensions and their measures, the tables below represent each component grouping.

Each object is grouped by dimension (index=“0”) which is the number of periods specified by the user in the query parameters.

Each period will be broken down into Refund metrics.

Components structure

FieldTypeDescription
dimensionnumberIndex 1
dimensionDisplayNamestringShows when includeDisplayNames is set to true.
itemnumber
itemDisplayNamestringShows when includeDisplayNames is set to true.
measuresSee Measures in components

All components have the structure described in the Measures in components data model below.

Measures in components

Index "0" - Count

FieldTypeDescription
measureDisplayNamestring"Count"
valuenumber

Index “1” - Value

FieldTypeDescription
measureDisplayNamestring"Value"
valuestring

Index “2” - Refund rate

FieldTypeDescription
measureDisplayNamestring"Percentage"
valuestring

Example data

{
"reportInfo": {
"name": "refunds",
"displayName": "Refunds"
},
"dimensions": [
{
"index": 0,
"displayName": "Period",
"type": "datespan",
"items": [
{
"index": 0,
"displayName": "Period 0",
"start": "2021-03-30",
"end": "2021-04-30"
},
{
"index": 1,
"displayName": "Period 1",
"start": "2021-04-30",
"end": "2021-05-31"
}
]
},
{
"index": 1,
"displayName": "Refund metrics",
"type": "string",
"items": [
{
"index": 0,
"value": "Number of refunds"
},
{
"index": 1,
"value": "Value of refunds"
},
{
"index": 2,
"value": "Refund rate"
}
]
}
],
"measures": [
{
"displayName": "Count",
"index": 0,
"type": "int"
},
{
"displayName": "Value",
"units": "GBP",
"index": 1,
"type": "currency"
},
{
"displayName": "Percentage",
"units": "%",
"index": 2,
"type": "percentage"
}
],
"reportData": [
{
"dimension": 0,
"dimensionDisplayName": "Period",
"item": 0,
"itemDisplayName": "Period 0",
"components": [
{
"dimension": 1,
"dimensionDisplayName": "Refund metrics",
"item": 0,
"itemDisplayName": "Number of refunds",
"measures": [
{
"index": 0,
"measureDisplayName": "Count",
"value": 6
}
]
},
{
"dimension": 1,
"dimensionDisplayName": "Refund metrics",
"item": 1,
"itemDisplayName": "Value of refunds",
"measures": [
{
"index": 1,
"measureDisplayName": "Value",
"value": 131.92
}
]
},
{
"dimension": 1,
"dimensionDisplayName": "Refund metrics",
"item": 2,
"itemDisplayName": "Refund rate",
"measures": [
{
"index": 2,
"measureDisplayName": "Percentage",
"value": 0.75
}
]
}
]
},
{
"dimension": 0,
"dimensionDisplayName": "Period",
"item": 1,
"itemDisplayName": "Period 1",
"components": [
{
"dimension": 1,
"dimensionDisplayName": "Refund metrics",
"item": 0,
"itemDisplayName": "Number of refunds",
"measures": [
{
"index": 0,
"measureDisplayName": "Count",
"value": 4
}
]
},
{
"dimension": 1,
"dimensionDisplayName": "Refund metrics",
"item": 1,
"itemDisplayName": "Value of refunds",
"measures": [
{
"index": 1,
"measureDisplayName": "Value",
"value": 95.14
}
]
},
{
"dimension": 1,
"dimensionDisplayName": "Refund metrics",
"item": 2,
"itemDisplayName": "Refund rate",
"measures": [
{
"index": 2,
"measureDisplayName": "Percentage",
"value": 0.40
}
]
}
]
}
]
}

Was this page useful?
❤️
👍
🤔
👎
😭