Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
TurnoverGroup

TurnoverGroups:Browse

Retrieve all turnover groups. You can supply a merchant code to retrieve the turnover groups for that merchant. If no merchant code is provided, the turnover groups associated with your own merchant registration will be returned.

get/v2/turnovergroups

Query parameters

pageinteger

The collection page number

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

{
  "eq": "M-1234-4321"
}

Response

OK

totalinteger nullable

The total items the collection contains

Example response

{
  "turnoverGroups": [
    {
      "code": "CT-1234-4321",
      "name": "New Turnover Group for Great Cookies Inc.",
      "description": "This is a new turnover group for Great Cookies Inc.",
      "paymentDescription": "Payment description for Great Cookies Inc.",
      "merchant": {
        "code": "M-1234-4321",
        "name": "GMS Demo Merchant",
        "status": "ACTIVE"
      },
      "bankAccount": {
        "code": "BA-1234-4321",
        "method": "iban",
        "iban": {
          "iban": "NL91ABNA0417164300",
          "bic": "ABNANL2A",
          "owner": "Robbert van der Werf"
        },
        "status": "APPROVED"
      },
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedAt": "2024-06-04T08:15:00+01:00",
      "modifiedBy": "A-1234-4321",
      "deletedAt": "A-1234-4321",
      "deletedBy": "A-1234-4321"
    }
  ],
  "total": 10
}