Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
TurnoverGroup

TurnoverGroup:Update

Update an existing turnover group. You can only update the turnover group if it is associated with your own merchant registration. If the turnover group is not associated with your own merchant registration, you must have access to the corresponding merchant.

patch/v2/turnovergroups/{turnoverGroupCode}

Path parameters

turnoverGroupCodestring required

TurnoverGroup identifier

Request body

merchantCodestring nullable

The merchant id of your company starting with M.

Example request

{
  "merchantCode": "M-1234-4321",
  "turnoverGroup": {
    "bankAccountCode": "BA-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."
  }
}

Response

OK

codestring

The CT-code for a turn over group.

namestring

The name of the turnover group

defaultboolean

Is this the default turnover group?

descriptionstring nullable

The description of the turnover group

paymentDescriptionstring nullable

The payment description of the turnover group. This will be displayed on your clearing records.

createdAtstring date-time nullable

The date and time at which this entity was created in ISO-8601 (ATOM) notation

createdBystring nullable

The reference to an account or token whom created the entity

modifiedAtstring date-time nullable

The date and time at which this entity was modified in ISO-8601 (ATOM) notation.

modifiedBystring nullable

The reference to an account or token whom modified this entity

deletedAtstring date-time nullable

The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.

deletedBystring nullable

The reference to an account or token whom deleted the entity

Example response

{
  "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"
}