openapi: 3.0.1
info:
  title: Blauwe Knop API
  description: Blauwe Knop proof of concept service definitie.
  version: 0.0.3
externalDocs:
  description: Lees meer over de Blauwe Knop
  url: https://www.vngrealisatie.nl/producten/blauweknop
servers:
- url: https://je.eigen.host.name.nl/v003
- url: http://je.eigen.host.name.nl/v003
paths:
  /schulden:
    post:
      summary: Vraagt schulden op voor een opgegeven BSN.
      operationId: getSchulden
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/RequestGetSchulden'
        required: true
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schuld'
        405:
          description: Invalid input
          content: {}
  /betalingsregelingen:
    post:
      summary: Vraagt betalingsregelingen op voor een opgegeven BSN.
      operationId: getBetalingsregelingen
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestGetBelangsregelingen'
        required: true
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Betalingsregeling'
        405:
          description: Invalid input
          content: {}
components:
  schemas:
    RequestGetSchulden:
      type: object
      properties:
        bsn:
          type: string
    RequestGetBelangsregelingen:
      type: object
      properties:
        bsn:
          type: string
    Betalingsregeling:
      type: object
      properties:
        id:
          type: string
        bedragPerPeriode:
          type: number
          format: float
        periodiciteit:
          type: string
          enum:
          - Maand
          - Kwartaal
          - Jaar
    OrganisatieSchuldeiser:
      type: object
      properties:
        id:
          type: string
        naam:
          type: string
        organisatieonderdeel:
          type: string
    Schuld:
      required:
      - datumOpenstaandBedragLaatstBijgewerkt
      - omschrijving
      - organisatieSchuldeiser
      - typeSchuld
      type: object
      properties:
        organisatieSchuldeiser:
          $ref: '#/components/schemas/OrganisatieSchuldeiser'
        typeSchuld:
          type: string
          enum:
          - Terugvordering
          - Bestuurlijke boete
          - Geld lening
          - BBZ lening
          - Verhaal
          - Krediethypotheek
          - Overige
        omschrijving:
          type: string
        openstaandBedrag:
          type: number
          format: float
        datumOpenstaandBedragLaatstBijgewerkt:
          type: string
          format: date
        betalingsregelingId:
          type: string