---
title: "Collection periods (Sammlungsperioden)"
url: "https://developer-qual.migros.ch/apis/layout-api-1/versions/fcc71337-b27c-4bc7-8aea-a50107bf562d/operations/accountstatementPeriod"
---

> Full API specification: https://developer-qual.migros.ch/apis/layout-api-1/versions/fcc71337-b27c-4bc7-8aea-a50107bf562d.md

# Collection periods (Sammlungsperioden)

`GET` `/migros/customers/account-statements/v1/collection-period`

Operation ID: `accountstatementPeriod`

'Each ''collection period'' is identified by a 5-digit number: 4 digits of the year and 1 digit for the period. Which month belongs to which of the six periods per year is complicated. This service helps finding the period ID, start- and end-date of the period and whether the account statement is available for the last n periods.'

## Query parameters

- `total` (integer, optional) - Number of periods with available account statements (flag=1), default is 6 (which corresponds to one year). Often total+1 periods are returned with the most recent having flag=0, indicationg that the account statement (Kontoauszug) is not ready yet.

## Responses

- `200` - list of collection periods

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Layout-API
  version: 1.3.0
servers:
  - description: URL of upstream
    url: https://api-qual.migros.ch
paths:
  /migros/customers/account-statements/v1/collection-period:
    get:
      description: >-
        'Each ''collection period'' is identified by a 5-digit number: 4 digits
        of the year and 1 digit for the period. Which month belongs to which of
        the six periods per year is complicated.


        This service helps finding the period ID, start- and end-date of the
        period and whether the account statement is available for the last n
        periods.'
      operationId: accountstatementPeriod
      parameters:
        - description: Number of periods with available account statements (flag=1),
            default is 6 (which corresponds to one year). Often total+1 periods
            are returned with the most recent having flag=0, indicationg that
            the account statement (Kontoauszug) is not ready yet.
          in: query
          name: total
          schema:
            default: 6
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CollectionPeriodResponse"
          description: list of collection periods
      summary: Collection periods (Sammlungsperioden)
      tags:
        - Account-Statement
security:
  - Kong-Api-Key: []
components:
  schemas:
    CollectionPeriodResponse:
      items:
        properties:
          dateFrom:
            type: string
          dateTo:
            type: string
          flag:
            description: "1: Accountstatement available for this period. 0: Accountstatemen
              not yet available."
            type: number
          periodId:
            type: number
        required:
          - dateFrom
          - dateTo
          - flag
          - periodId
        type: object
      type: array
  securitySchemes:
    Kong-Api-Key:
      description: Kong key-auth authentication
      in: header
      name: X-Api-Key
      type: apiKey
```