{
  "openapi": "3.0.0",
  "info": {
    "title": "API Endpoints",
    "description": "This page allows you to explore the available API endpoints. Select a resource (e.g. debtors) and an endpoint (e.g. /v1/debtors) to inspect an example response and available parameters. An authorization header containing a Bearer token is required, see [Authentication](/authentication/authorization).",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "administrations",
      "description": "Operations about administrations"
    },
    {
      "name": "companies",
      "description": "Operations about companies"
    },
    {
      "name": "contacts",
      "description": "Operations about contacts"
    },
    {
      "name": "credit_cases",
      "description": "Operations about credit_cases"
    },
    {
      "name": "debtors",
      "description": "Operations about debtors"
    },
    {
      "name": "files",
      "description": "Operations about files"
    },
    {
      "name": "orders",
      "description": "Operations about orders"
    },
    {
      "name": "order_lines",
      "description": "Operations about order_lines"
    },
    {
      "name": "invoices",
      "description": "Operations about invoices"
    },
    {
      "name": "messages",
      "description": "Operations about messages"
    },
    {
      "name": "notes",
      "description": "Operations about notes"
    },
    {
      "name": "notifications",
      "description": "Operations about notifications"
    },
    {
      "name": "payments",
      "description": "Operations about payments"
    },
    {
      "name": "payment_conditions",
      "description": "Operations about payment_conditions"
    },
    {
      "name": "payment_plans",
      "description": "Operations about payment_plans"
    },
    {
      "name": "psp_mandates",
      "description": "Operations about psp_mandates"
    },
    {
      "name": "psp_transactions",
      "description": "Operations about psp_transactions"
    },
    {
      "name": "sign_up",
      "description": "Operations about sign_ups"
    },
    {
      "name": "tasks",
      "description": "Operations about tasks"
    },
    {
      "name": "vat_rates",
      "description": "Operations about vat_rates"
    }
  ],
  "paths": {
    "/v1/administrations/{administration_id}": {
      "get": {
        "description": "Get administration by id",
        "parameters": [
          {
            "in": "path",
            "name": "administration_id",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Administration",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_AdministrationEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "administrations"
        ],
        "operationId": "getV1AdministrationsAdministrationId",
        "summary": "Get administration by id"
      }
    },
    "/v1/administrations": {
      "post": {
        "description": "Creates an administration",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1Administrations"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1Administrations"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Administration created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_AdministrationEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "422": {
            "description": "Validations errors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "administrations"
        ],
        "operationId": "postV1Administrations",
        "summary": "Creates an administration"
      },
      "get": {
        "description": "Get administrations",
        "parameters": [
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of administrations",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_AdministrationsPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "administrations"
        ],
        "operationId": "getV1Administrations",
        "summary": "Get administrations"
      }
    },
    "/v1/companies": {
      "get": {
        "summary": "Get companies connected to your application",
        "description": "**NOTE:** This endpoint uses [Basic authentication](https://docs.paytsoftware.com/authentication/basic-authorization).\n\nReturns a list of all companies with an active connection to your application.",
        "parameters": [
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of companies",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_CompaniesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "companies"
        ],
        "operationId": "getV1Companies"
      }
    },
    "/v1/companies/{id}": {
      "get": {
        "summary": "Get company by id",
        "description": "**NOTE:** This endpoint uses [Basic authentication](https://docs.paytsoftware.com/authentication/basic-authorization).\n\nGet company by id.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Company identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Company",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_CompanyEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "companies"
        ],
        "operationId": "getV1CompaniesId"
      }
    },
    "/v1/contacts": {
      "post": {
        "description": "Create or update administration contacts",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1Contacts"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1Contacts"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Create or update administration contacts"
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "contacts"
        ],
        "operationId": "postV1Contacts",
        "summary": "Create or update administration contacts"
      },
      "get": {
        "description": "Get administration contacts",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter contacts with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "contact_identifiers",
            "description": "Filter contacts with a comma separated list of contact identifiers from your accounting software",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_numbers",
            "description": "Filter contacts with a comma separated list of debtor numbers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of contacts",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ContactsPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "contacts"
        ],
        "operationId": "getV1Contacts",
        "summary": "Get administration contacts"
      }
    },
    "/v1/credit_cases/deleted": {
      "get": {
        "description": "Get credit cases deleted in the last 90 days",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "deleted_after",
            "description": "ISO8601 UTC Timestamp to filter records deleted after it",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "deleted_before",
            "description": "ISO8601 UTC Timestamp to filter records deleted before it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of deleted credit_cases",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_DeletedCreditCasesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "credit_cases"
        ],
        "operationId": "getV1CreditCasesDeleted",
        "summary": "Get credit cases deleted in the last 90 days"
      }
    },
    "/v1/credit_cases": {
      "get": {
        "description": "Get administration credit_cases",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter credit cases with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of credit cases",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_CreditCasesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "credit_cases"
        ],
        "operationId": "getV1CreditCases",
        "summary": "Get administration credit_cases"
      }
    },
    "/v1/credit_cases/{id}": {
      "get": {
        "description": "Get administration credit case by id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Credit case identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Credit case",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_CreditCaseEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "credit_cases"
        ],
        "operationId": "getV1CreditCasesId",
        "summary": "Get administration credit case by id"
      }
    },
    "/v1/debtors": {
      "post": {
        "description": "Create or update administration debtors",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1Debtors"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1Debtors"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Debtors created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "debtors"
        ],
        "operationId": "postV1Debtors",
        "summary": "Create or update administration debtors"
      },
      "get": {
        "description": "Get administration debtors",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter debtors with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_numbers",
            "description": "Filter debtors with a comma separated list of debtor numbers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_identifiers",
            "description": "Filter debtors with a comma separated list of debtor identifiers from your accounting software",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of debtors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_DebtorsPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "debtors"
        ],
        "operationId": "getV1Debtors",
        "summary": "Get administration debtors"
      }
    },
    "/v1/debtors/{id}": {
      "get": {
        "description": "Get administration debtor by id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Debtor identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "identifier_type",
            "description": "Type of debtor identifier to use (can be 'debtor_number', 'debtor_identifier' or left blank to use internal id)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Debtor",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_DebtorEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "debtors"
        ],
        "operationId": "getV1DebtorsId",
        "summary": "Get administration debtor by id"
      }
    },
    "/v1/files": {
      "post": {
        "description": "Create files to upload",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1Files"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1Files"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Files created, with URLs to upload",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_UploadableFileEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "files"
        ],
        "operationId": "postV1Files",
        "summary": "Create files to upload"
      }
    },
    "/v1/orders": {
      "post": {
        "description": "Create an order",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "administration_id": {
                    "description": "Administration identifier",
                    "type": "string"
                  },
                  "order[file]": {
                    "description": "Multipart file containing order details",
                    "type": "string",
                    "format": "binary"
                  }
                },
                "required": [
                  "administration_id",
                  "order[file]"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Order created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_OrderEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "422": {
            "description": "Validations errors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "orders"
        ],
        "operationId": "postV1Orders",
        "summary": "Create an order"
      }
    },
    "/v1/order_lines": {
      "get": {
        "description": "Get administration order lines",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "created_before",
            "description": "ISO8601 UTC Timestamp to filter records created before it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "created_after",
            "description": "ISO8601 UTC Timestamp to filter records created after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "order_line_identifiers",
            "description": "Filter order lines with a comma separated list of order line identifiers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter order lines with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "claim_status",
            "description": "Filter order lines by claim status",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "action_required",
                "auto_resubmit",
                "draft",
                "failed",
                "processed",
                "submitted"
              ]
            }
          },
          {
            "in": "query",
            "name": "invoice_identifiers",
            "description": "Filter order lines with a comma separated list of invoice identifiers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of order lines",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_OrderLinesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "order_lines"
        ],
        "operationId": "getV1OrderLines",
        "summary": "Get administration order lines"
      }
    },
    "/v1/invoices/block": {
      "patch": {
        "description": "Block invoices",
        "requestBody": {
          "$ref": "#/components/requestBodies/patchV1InvoicesBlock"
        },
        "responses": {
          "200": {
            "description": "Invoices blocked",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "invoices"
        ],
        "operationId": "patchV1InvoicesBlock",
        "summary": "Block invoices"
      }
    },
    "/v1/invoices": {
      "post": {
        "description": "Upsert invoices in bulk",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1Invoices"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1Invoices"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "List of created invoices",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "invoices"
        ],
        "operationId": "postV1Invoices",
        "summary": "Upsert invoices in bulk"
      },
      "patch": {
        "description": "Update administration invoices",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/patchV1Invoices"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/patchV1Invoices"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Invoices updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "invoices"
        ],
        "operationId": "patchV1Invoices",
        "summary": "Update administration invoices"
      },
      "get": {
        "description": "Get administration invoices",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "paid",
            "description": "Whether returned invoices should be paid/unpaid",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "book_amount_total_lte",
            "description": "Filter invoices with book_amount_total less than or equal to the provided amount",
            "required": false,
            "schema": {
              "type": "number",
              "format": "float"
            }
          },
          {
            "in": "query",
            "name": "book_amount_total_gte",
            "description": "Filter invoices with book_amount_total greater than or equal to the provided amount",
            "required": false,
            "schema": {
              "type": "number",
              "format": "float"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter invoices with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "invoice_numbers",
            "description": "Filter invoices with a comma separated list of invoice numbers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "invoice_identifiers",
            "description": "Filter invoices with a comma separated list of invoice identifiers from your accounting software",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_ids",
            "description": "Filter invoices with a comma separated list of internal debtor ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_numbers",
            "description": "Filter invoices with a comma separated list of debtor numbers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_identifiers",
            "description": "Filter invoices with a comma separated list of debtor identifiers from your accounting software",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "credit_case_ids",
            "description": "Filter invoices with a comma separated list of internal credit case ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "order",
            "description": "Order the list of invoices",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "invoice_date_asc",
                "invoice_date_desc",
                "due_date_asc",
                "due_date_desc"
              ]
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of invoices",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_InvoicesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "invoices"
        ],
        "operationId": "getV1Invoices",
        "summary": "Get administration invoices"
      }
    },
    "/v1/invoices/deleted": {
      "get": {
        "description": "Get invoices deleted in the last 90 days",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "deleted_after",
            "description": "ISO8601 UTC Timestamp to filter records deleted after it",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "deleted_before",
            "description": "ISO8601 UTC Timestamp to filter records deleted before it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of deleted invoices",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_DeletedInvoicesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "invoices"
        ],
        "operationId": "getV1InvoicesDeleted",
        "summary": "Get invoices deleted in the last 90 days"
      }
    },
    "/v1/invoices/resume": {
      "patch": {
        "description": "Resume invoices that are blocked through the API",
        "requestBody": {
          "$ref": "#/components/requestBodies/patchV1InvoicesBlock"
        },
        "responses": {
          "200": {
            "description": "Invoices resumed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "invoices"
        ],
        "operationId": "patchV1InvoicesResume",
        "summary": "Resume invoices that are blocked through the API"
      }
    },
    "/v1/invoices/{id}": {
      "get": {
        "description": "Get administration invoice by id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Invoice identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "identifier_type",
            "description": "Type of invoice identifier to use (can be 'invoice_number', 'invoice_identifier' or left blank to use internal id)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Invoice",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_InvoiceEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "invoices"
        ],
        "operationId": "getV1InvoicesId",
        "summary": "Get administration invoice by id"
      }
    },
    "/v1/messages": {
      "post": {
        "description": "Send a message to a debtor",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1Messages"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1Messages"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Message",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_MessageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "422": {
            "description": "Validation errors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "messages"
        ],
        "operationId": "postV1Messages",
        "summary": "Send a message to a debtor"
      },
      "patch": {
        "description": "Update messages",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/patchV1Messages"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/patchV1Messages"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Messages updated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "messages"
        ],
        "operationId": "patchV1Messages",
        "summary": "Update messages"
      },
      "get": {
        "description": "Get administration messages",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter messages with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_ids",
            "description": "Filter messages with a comma separated list of internal debtor ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "invoice_ids",
            "description": "Filter messages with a comma separated list of internal invoice ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "credit_case_ids",
            "description": "Filter messages with a comma separated list of internal credit_case ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of messages",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_MessagesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "messages"
        ],
        "operationId": "getV1Messages",
        "summary": "Get administration messages"
      }
    },
    "/v1/messages/{id}": {
      "get": {
        "description": "Get administration message by id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Message identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Message",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_MessageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "messages"
        ],
        "operationId": "getV1MessagesId",
        "summary": "Get administration message by id"
      }
    },
    "/v1/notes": {
      "get": {
        "description": "Get administration notes",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter notes with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_ids",
            "description": "Filter notes with a comma separated list of debtor internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "invoice_ids",
            "description": "Filter notes with a comma separated list of invoice internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "credit_case_ids",
            "description": "Filter notes with a comma separated list of credit case internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get administration notes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_NotesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "notes"
        ],
        "operationId": "getV1Notes",
        "summary": "Get administration notes"
      }
    },
    "/v1/notifications": {
      "get": {
        "description": "Get administration notifications",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter notifications with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_ids",
            "description": "Filter messages with a comma separated list of internal debtor ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "invoice_ids",
            "description": "Filter messages with a comma separated list of internal invoice ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "credit_case_ids",
            "description": "Filter messages with a comma separated list of internal credit_case ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of notifications",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_NotificationsPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "notifications"
        ],
        "operationId": "getV1Notifications",
        "summary": "Get administration notifications"
      }
    },
    "/v1/notifications/{id}": {
      "get": {
        "description": "Get administration notification by id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Notification identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Notification",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_NotificationEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "notifications"
        ],
        "operationId": "getV1NotificationsId",
        "summary": "Get administration notification by id"
      }
    },
    "/v1/payments/deleted": {
      "get": {
        "description": "Get payments deleted in the last 90 days",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "deleted_after",
            "description": "ISO8601 UTC Timestamp to filter records deleted after it",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "deleted_before",
            "description": "ISO8601 UTC Timestamp to filter records deleted before it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of deleted payments",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_DeletedPaymentsPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payments"
        ],
        "operationId": "getV1PaymentsDeleted",
        "summary": "Get payments deleted in the last 90 days"
      }
    },
    "/v1/payments": {
      "get": {
        "description": "Get administration payments",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter payments with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "invoice_identifiers",
            "description": "Filter payments with a comma separated list of invoice identifiers from your accounting software",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "invoice_numbers",
            "description": "Filter payments with a comma separated list of invoice numbers from your accounting software",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "credit_case_ids",
            "description": "Filter payments with a comma separated list of internal credit case ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "credit_case_numbers",
            "description": "Filter payments with a comma separated list of credit case numbers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get administration payments",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_PaymentsPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payments"
        ],
        "operationId": "getV1Payments",
        "summary": "Get administration payments"
      }
    },
    "/v1/payment_conditions": {
      "post": {
        "description": "Create payment conditions",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1PaymentConditions"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1PaymentConditions"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Payment conditions created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payment_conditions"
        ],
        "operationId": "postV1PaymentConditions",
        "summary": "Create payment conditions"
      }
    },
    "/v1/payment_plans/{id}/approve": {
      "patch": {
        "description": "Approve a proposed payment plan",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Payment plan identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/patchV1PaymentPlansIdApprove"
        },
        "responses": {
          "200": {
            "description": "Approve a proposed payment plan",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_PaymentPlanEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payment_plans"
        ],
        "operationId": "patchV1PaymentPlansIdApprove",
        "summary": "Approve a proposed payment plan"
      }
    },
    "/v1/payment_plans/{id}/deactivate": {
      "patch": {
        "description": "Deactivate an active payment plan",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Payment plan identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/patchV1PaymentPlansIdApprove"
        },
        "responses": {
          "200": {
            "description": "Deactivate an active payment plan",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_PaymentPlanEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payment_plans"
        ],
        "operationId": "patchV1PaymentPlansIdDeactivate",
        "summary": "Deactivate an active payment plan"
      }
    },
    "/v1/payment_plans/{id}/reject": {
      "patch": {
        "description": "Reject a proposed payment plan",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Payment plan identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/patchV1PaymentPlansIdApprove"
        },
        "responses": {
          "200": {
            "description": "Reject a proposed payment plan",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_PaymentPlanEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payment_plans"
        ],
        "operationId": "patchV1PaymentPlansIdReject",
        "summary": "Reject a proposed payment plan"
      }
    },
    "/v1/payment_plans/{id}": {
      "get": {
        "description": "Get administration payment plan by id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Payment plan identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get administration payment plan by id",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_PaymentPlanEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payment_plans"
        ],
        "operationId": "getV1PaymentPlansId",
        "summary": "Get administration payment plan by id"
      }
    },
    "/v1/payment_plans": {
      "post": {
        "description": "Create an approved payment plan",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1PaymentPlans"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1PaymentPlans"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Created payment plan",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_PaymentPlanEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payment_plans"
        ],
        "operationId": "postV1PaymentPlans",
        "summary": "Create an approved payment plan"
      },
      "get": {
        "description": "Get administration payment plans",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter payment plans with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_numbers",
            "description": "Filter payment plans with a comma separated list of debtor numbers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_identifiers",
            "description": "Filter payment plans with a comma separated list of debtor identifiers from your accounting software",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get administration payment plans",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_PaymentPlansPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payment_plans"
        ],
        "operationId": "getV1PaymentPlans",
        "summary": "Get administration payment plans"
      }
    },
    "/v1/payment_plans/deleted": {
      "get": {
        "description": "Get payment_plans deleted in the last 90 days",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "deleted_after",
            "description": "ISO8601 UTC Timestamp to filter records deleted after it",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "deleted_before",
            "description": "ISO8601 UTC Timestamp to filter records deleted before it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of deleted payment plans",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_Deleted_PaymentPlansPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "payment_plans"
        ],
        "operationId": "getV1PaymentPlansDeleted",
        "summary": "Get payment_plans deleted in the last 90 days"
      }
    },
    "/v1/psp_mandates": {
      "delete": {
        "summary": "Delete PSP mandates",
        "description": "Deactivate PSP mandates and schedule their revocation.",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "psp_mandate_ids",
            "description": "List of psp_mandate_ids to revoke",
            "required": false,
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "in": "query",
            "name": "mandate_identifiers",
            "description": "List of mandate identifiers to revoke",
            "required": false,
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "in": "query",
            "name": "mandate_references",
            "description": "List of mandate references to revoke",
            "required": false,
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "in": "query",
            "name": "debtor_numbers",
            "description": "List of debtor numbers to revoke",
            "required": false,
            "style": "form",
            "explode": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "PSP mandates deactivated and revoke scheduled",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "psp_mandates"
        ],
        "operationId": "deleteV1PspMandates"
      },
      "post": {
        "description": "Create signed psp mandates, these need to be verified before creating",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1PspMandates"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1PspMandates"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Create signed psp mandates, these need to be verified before creating",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_PspMandateEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "psp_mandates"
        ],
        "operationId": "postV1PspMandates",
        "summary": "Create signed psp mandates, these need to be verified before creating"
      },
      "get": {
        "description": "Get administration PSP mandates",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter PSP mandates with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_ids",
            "description": "Filter PSP mandates with a comma separated list of internal debtor ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "debtor_numbers",
            "description": "Filter PSP mandates with a comma separated list of debtor numbers",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get administration PSP mandates",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_PspMandatePageEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "psp_mandates"
        ],
        "operationId": "getV1PspMandates",
        "summary": "Get administration PSP mandates"
      }
    },
    "/v1/psp_mandates/deleted": {
      "get": {
        "description": "Get PSP mandates deleted in the last 90 days",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "deleted_after",
            "description": "ISO8601 UTC Timestamp to filter records deleted after it",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "deleted_before",
            "description": "ISO8601 UTC Timestamp to filter records deleted before it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of deleted PSP mandates",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_Deleted_PspMandatesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "psp_mandates"
        ],
        "operationId": "getV1PspMandatesDeleted",
        "summary": "Get PSP mandates deleted in the last 90 days"
      }
    },
    "/v1/psp_transactions": {
      "get": {
        "description": "Get administration PSP transactions",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter PSP transactions with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "payment_methods",
            "description": "Filter PSP transactions with a comma separated list of payment methods,  possible values: afterpay, alipay, amazonpay, applepay, bancomatpay, bacs_direct_debit, bancontact, banktransfer, belfius, billink, bitcoin, capayable, cashly, creditcard, creditclick, direct_debit, eps, focum, giropay, googlepay, ideal, in3, inghomepay, kbc, klarnapaylater, klarnasliceit, maestro, minitix, multibanco, mybank, paybybank, payconiq, payto, paypal, paysafecard, phone_payment, przelewy24, sofort, spraypay, trustly, twikey, unknown, voucher, wechat",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "statuses",
            "description": "Filter PSP transactions with a comma separated list of statuses, possible values: cancelled, charged_back, failed, paid, pending, processing, refunded",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get administration PSP transactions",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_PspTransactionsPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "psp_transactions"
        ],
        "operationId": "getV1PspTransactions",
        "summary": "Get administration PSP transactions"
      }
    },
    "/v1/psp_transactions/{id}": {
      "get": {
        "description": "Get administration PSP transaction by id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "PSP transaction identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get administration PSP transaction by id",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_PspTransactionEntity"
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "psp_transactions"
        ],
        "operationId": "getV1PspTransactionsId",
        "summary": "Get administration PSP transaction by id"
      }
    },
    "/v1/sign_up": {
      "post": {
        "summary": "Sign up a new Payt account",
        "description": "**NOTE:** This endpoint uses Basic authentication, just as the [token endpoints](https://docs.paytsoftware.com/authentication/tokens).\n\nCreates a Payt account containing a user, company and administration.\n\nAn OAuth authorization_code will be returned with which the first access_token can be created. This means that in order to complete the API authorization the confirm step must be made [as described here](https://docs.paytsoftware.com/authentication/authorization).\n\nIf connection parameters are given then these are added to the newly created administration and are validated during the signup. If the connection parameters are invalid a validation error will be returned.",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "administration[city]": {
                    "description": "Part of the administration address",
                    "type": "string"
                  },
                  "administration[commercial_registration_number]": {
                    "description": "Offical national commercial registration number",
                    "type": "string"
                  },
                  "administration[country_code]": {
                    "description": "ISO 3166 Alpha-2 country code, Part of the administration address",
                    "type": "string"
                  },
                  "administration[email_address]": {
                    "description": "Email address of the administration",
                    "type": "string"
                  },
                  "administration[house_number]": {
                    "description": "Part of the administration address",
                    "type": "string"
                  },
                  "administration[name]": {
                    "description": "Name of the administration",
                    "type": "string"
                  },
                  "administration[phone_number]": {
                    "description": "Phone number of the administration",
                    "type": "string"
                  },
                  "administration[postal_code]": {
                    "description": "Part of the administration address",
                    "type": "string"
                  },
                  "administration[street_name]": {
                    "description": "Part of the administration address",
                    "type": "string"
                  },
                  "administration[sender_email_address]": {
                    "description": "Sender email address which will be used for outgoing communication",
                    "type": "string"
                  },
                  "administration[bank_account_bic]": {
                    "description": "BIC of the bank. The BIC must match the bank_account_number. If it is not then the bank_account properties will be ignored.",
                    "type": "string"
                  },
                  "administration[bank_account_name]": {
                    "description": "Name of the bank account holder. The name must be as it is registered by the bank. If it is not then the bank_account properties will be ignored.",
                    "type": "string"
                  },
                  "administration[bank_account_number]": {
                    "description": "Number of the bank account. This must be an existing organizational bank account. If it is not then the bank_account properties will be ignored.",
                    "type": "string"
                  },
                  "administration[contact_name]": {
                    "description": "The name of the contact person for this administration",
                    "type": "string"
                  },
                  "administration[currency_code]": {
                    "description": "The accounting or reporting currency, ISO 4217",
                    "type": "string",
                    "default": "EUR"
                  },
                  "administration[timezone]": {
                    "description": "Timezone in which the administration primarily operates, canonical tz name",
                    "type": "string",
                    "default": "Europe/Amsterdam"
                  },
                  "administration[vat_number]": {
                    "description": "VAT number of the administration",
                    "type": "string"
                  },
                  "user[first_name]": {
                    "description": "First name of the user",
                    "type": "string"
                  },
                  "user[last_name]": {
                    "description": "Last name of the user",
                    "type": "string"
                  },
                  "user[email_address]": {
                    "description": "Email address the user will use to login into Payt",
                    "type": "string"
                  },
                  "user[locale]": {
                    "description": "Locale in which the user will use Payt, 'ISO 639-1' + 'ISO 3166 Alpha-2 country code' (nl|de|en-GB|es|fr|nl-BE).",
                    "type": "string",
                    "default": "en-GB"
                  },
                  "connection[resource_label]": {
                    "description": "Description of the resource in your app with which the administration is connected. This can be a code, name or combination thereof. It should be uniquely recognizable for the enduser.",
                    "type": "string"
                  },
                  "connection[resource_identifier]": {
                    "description": "The unique identifier of the connected resource. This identifier will be used to query your API.",
                    "type": "string"
                  },
                  "connection[credentials_label]": {
                    "description": "Description of the owner of the credentials. This can be a code, number or name and should be uniquely recognizable by the enduser. This field becomes required if the credentials owner is not the resource itself.",
                    "type": "string"
                  }
                },
                "required": [
                  "administration[city]",
                  "administration[commercial_registration_number]",
                  "administration[country_code]",
                  "administration[email_address]",
                  "administration[house_number]",
                  "administration[name]",
                  "administration[phone_number]",
                  "administration[postal_code]",
                  "administration[street_name]",
                  "user[first_name]",
                  "user[last_name]",
                  "user[email_address]",
                  "connection[resource_label]",
                  "connection[resource_identifier]"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Payt account created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_SignUpEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "422": {
            "description": "Validations errors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "sign_up"
        ],
        "operationId": "postV1SignUp"
      }
    },
    "/v1/tasks/{id}/comment": {
      "post": {
        "description": "Add a comment to a task",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Task identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1TasksIdComment"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1TasksIdComment"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Comment created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "422": {
            "description": "Validation errors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "tasks"
        ],
        "operationId": "postV1TasksIdComment",
        "summary": "Add a comment to a task"
      }
    },
    "/v1/tasks/{id}/mark_completed": {
      "patch": {
        "description": "Mark a task as completed",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Task identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/patchV1TasksIdMarkCompleted"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/patchV1TasksIdMarkCompleted"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Task",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_TaskEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "422": {
            "description": "Validation errors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "tasks"
        ],
        "operationId": "patchV1TasksIdMarkCompleted",
        "summary": "Mark a task as completed"
      }
    },
    "/v1/tasks/{id}/unmark_completed": {
      "patch": {
        "description": "Unmark a task as completed",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Task identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/patchV1PaymentPlansIdApprove"
        },
        "responses": {
          "200": {
            "description": "Task",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_TaskEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "tasks"
        ],
        "operationId": "patchV1TasksIdUnmarkCompleted",
        "summary": "Unmark a task as completed"
      }
    },
    "/v1/tasks/{id}": {
      "get": {
        "description": "Get administration task by id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Task identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Task",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_V1_TaskEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "tasks"
        ],
        "operationId": "getV1TasksId",
        "summary": "Get administration task by id"
      }
    },
    "/v1/tasks": {
      "get": {
        "description": "Get administration tasks",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "ids",
            "description": "Filter tasks with a comma separated list of internal ids",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "updated_after",
            "description": "ISO8601 UTC Timestamp to filter records updated after it",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "fields",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of tasks",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_TasksPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "tasks"
        ],
        "operationId": "getV1Tasks",
        "summary": "Get administration tasks"
      }
    },
    "/v1/vat_rates": {
      "post": {
        "description": "Create or update vat rates",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1VatRates"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/postV1VatRates"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Vat rates created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_SuccessEntity"
                }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          },
          "403": {
            "description": "Access not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_ErrorEntity"
                }
              }
            }
          }
        },
        "tags": [
          "vat_rates"
        ],
        "operationId": "postV1VatRates",
        "summary": "Create or update vat rates"
      },
      "get": {
        "description": "Get administration vat rates",
        "parameters": [
          {
            "in": "query",
            "name": "administration_id",
            "description": "Administration identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "The record identifier after which to start the page",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "per_page",
            "description": "How many records will be returned per page, (1..500), defaults to 100",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 500,
              "default": 100
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of vat rates",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApi_VatRatesPageEntity"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          }
        },
        "tags": [
          "vat_rates"
        ],
        "operationId": "getV1VatRates",
        "summary": "Get administration vat rates"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.paytsoftware.com",
      "description": "Production"
    },
    {
      "url": "https://demo-api.paytsoftware.com",
      "description": "Demo / testing"
    }
  ],
  "components": {
    "requestBodies": {
      "patchV1InvoicesBlock": {
        "content": {
          "application/x-www-form-urlencoded": {
            "schema": {
              "type": "object",
              "properties": {
                "administration_id": {
                  "description": "Administration identifier",
                  "type": "string"
                },
                "fields": {
                  "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
                  "type": "string"
                },
                "invoice_numbers": {
                  "description": "Unique number from your invoicing software that is communicated to the debtor",
                  "type": "array",
                  "maxItems": 1000,
                  "items": {
                    "type": "string"
                  }
                },
                "invoice_identifiers": {
                  "description": "Unique database identifier from your invoicing software",
                  "type": "array",
                  "maxItems": 1000,
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "administration_id"
              ]
            }
          }
        },
        "required": true
      },
      "patchV1PaymentPlansIdApprove": {
        "content": {
          "application/x-www-form-urlencoded": {
            "schema": {
              "type": "object",
              "properties": {
                "administration_id": {
                  "description": "Administration identifier",
                  "type": "string"
                },
                "fields": {
                  "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})",
                  "type": "string"
                }
              },
              "required": [
                "administration_id"
              ]
            }
          }
        },
        "required": true
      }
    },
    "schemas": {
      "CustomerApi_V1_AdministrationEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive",
              "deleted",
              "implementation"
            ],
            "description": "Status"
          },
          "email_address": {
            "type": "string",
            "description": "Email address of the administration"
          },
          "contact_name": {
            "type": "string",
            "description": "The name of the contact person for this administration"
          },
          "commercial_registration_number": {
            "type": "string",
            "description": "Offical national commercial registration number"
          },
          "country_code": {
            "type": "string",
            "description": "ISO 3166 Alpha-2 country code, Part of the administration address"
          },
          "city": {
            "type": "string",
            "description": "Part of the administration address"
          },
          "house_number": {
            "type": "string",
            "description": "Part of the administration address"
          },
          "internal_name": {
            "type": "string",
            "description": "Internal name"
          },
          "street_name": {
            "type": "string",
            "description": "Part of the administration address"
          },
          "postal_code": {
            "type": "string",
            "description": "Part of the administration address"
          },
          "bank_account_name": {
            "type": "string",
            "description": "Name of the bank account holder"
          },
          "bank_account_number": {
            "type": "string",
            "description": "Number of the bank account"
          },
          "bank_account_bic": {
            "type": "string",
            "description": "BIC of the bank"
          },
          "vat_number": {
            "type": "string",
            "description": "VAT number of the administration"
          },
          "timezone": {
            "type": "string",
            "description": "Timezone in which the administration primarily operates, canonical tz name"
          },
          "currency_code": {
            "type": "string",
            "description": "The accounting or reporting currency, ISO 4217"
          },
          "administration_url": {
            "type": "string",
            "description": "The url to the administration in the Payt interface"
          },
          "import_origin_identifier": {
            "type": "string",
            "description": "The identifier which is used for importing from origin (request with the 'fields' parameter)"
          },
          "last_successful_import_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of the last successful import (request with the 'fields' parameter)"
          },
          "paused_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the administration was paused"
          },
          "reminding_paused_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which sending reminders for the administration was paused"
          }
        },
        "required": [
          "id",
          "name",
          "status",
          "email_address",
          "contact_name",
          "commercial_registration_number",
          "country_code",
          "city",
          "house_number",
          "internal_name",
          "street_name",
          "postal_code",
          "timezone",
          "currency_code",
          "administration_url"
        ],
        "description": "CustomerApi_V1_AdministrationEntity model"
      },
      "CustomerApi_ErrorEntity": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code"
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        },
        "required": [
          "code",
          "message"
        ],
        "description": "CustomerApi_ErrorEntity model"
      },
      "postV1Administrations": {
        "type": "object",
        "properties": {
          "administration": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "description": "Part of the administration address"
              },
              "commercial_registration_number": {
                "type": "string",
                "description": "Official national commercial registration number"
              },
              "contact_name": {
                "type": "string",
                "description": "The name of the contact person for this administration"
              },
              "country_code": {
                "type": "string",
                "description": "ISO 3166 Alpha-2 country code, Part of the administration address"
              },
              "email_address": {
                "type": "string",
                "description": "Email address of the administration"
              },
              "house_number": {
                "type": "string",
                "description": "Part of the administration address"
              },
              "name": {
                "type": "string",
                "description": "Name of the administration"
              },
              "postal_code": {
                "type": "string",
                "description": "Part of the administration address"
              },
              "street_name": {
                "type": "string",
                "description": "Part of the administration address"
              },
              "sender_email_address": {
                "type": "string",
                "description": "Sender email address which will be used for outgoing communication"
              },
              "bank_account_bic": {
                "type": "string",
                "description": "BIC of the bank. The BIC must match the bank_account_number. If it is not then the bank_account properties will be ignored."
              },
              "bank_account_name": {
                "type": "string",
                "description": "Name of the bank account holder. The name must be as it is registered by the bank. If it is not then the bank_account properties will be ignored."
              },
              "bank_account_number": {
                "type": "string",
                "description": "Number of the bank account. This must be an existing organizational bank account. If it is not then the bank_account properties will be ignored."
              },
              "currency_code": {
                "type": "string",
                "description": "The accounting or reporting currency, ISO 4217",
                "default": "EUR"
              },
              "timezone": {
                "type": "string",
                "description": "Timezone in which the administration primarily operates, canonical tz name",
                "default": "Europe/Amsterdam"
              },
              "vat_number": {
                "type": "string",
                "description": "VAT number of the administration"
              }
            },
            "required": [
              "city",
              "commercial_registration_number",
              "contact_name",
              "country_code",
              "email_address",
              "house_number",
              "name",
              "postal_code",
              "street_name"
            ]
          },
          "connection": {
            "type": "object",
            "properties": {
              "resource_label": {
                "type": "string",
                "description": "Description of the resource in your app with which the administration is connected. This can be a code, name or combination thereof. It should be uniquely recognizable for the enduser."
              },
              "resource_identifier": {
                "type": "string",
                "description": "The unique identifier of the connected resource. This identifier will be used to query your API."
              },
              "credentials": {
                "type": "object",
                "description": "All keys and/or tokens required to establish a connection back to your application for the newly created administration. Which parameters are required depends on your application. Send a request and check the validation error messages to find out which parameters are expected."
              },
              "credentials_label": {
                "type": "string",
                "description": "Description of the owner of the credentials. This can be a code, number or name and should be uniquely recognizable by the enduser. This field becomes required if the credentials owner is not the resource itself."
              }
            },
            "required": [
              "resource_label",
              "resource_identifier"
            ]
          }
        },
        "required": [
          "administration"
        ],
        "description": "Creates an administration"
      },
      "CustomerApi_AdministrationsPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_AdministrationEntity"
            },
            "description": "Administration"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_AdministrationsPageEntity model"
      },
      "CustomerApi_PaginationEntity": {
        "type": "object",
        "properties": {
          "cursor": {
            "type": "string",
            "description": "Cursor for fetching the next page"
          }
        },
        "required": [
          "cursor"
        ]
      },
      "CustomerApi_CompaniesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_CompanyEntity"
            },
            "description": "Company"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_CompaniesPageEntity model"
      },
      "CustomerApi_V1_CompanyEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "implementation",
              "inactive",
              "deleted",
              "unconfirmed"
            ],
            "description": "Status"
          },
          "trial_ends_on": {
            "type": "string",
            "description": "The date at which the trial ends"
          },
          "trial": {
            "type": "boolean",
            "description": "Whether the Company is still in the trial period."
          }
        },
        "required": [
          "id",
          "name",
          "status",
          "trial_ends_on",
          "trial"
        ],
        "description": "CustomerApi_V1_CompanyEntity model"
      },
      "postV1Contacts": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "contacts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "contact_identifier": {
                  "type": "string",
                  "description": "Unique external code used to identify contact"
                },
                "id": {
                  "type": "string",
                  "description": "Internal identifier used to identify contact"
                },
                "birth_date": {
                  "type": "string",
                  "description": "Birth date of the contact"
                },
                "call_phone_number": {
                  "type": "string",
                  "description": "Phone number used for calls"
                },
                "default_email_address": {
                  "type": "string",
                  "description": "Default email address"
                },
                "firstname": {
                  "type": "string",
                  "description": "First name"
                },
                "gender": {
                  "type": "string",
                  "description": "Gender",
                  "enum": [
                    [
                      "female",
                      "male",
                      "male_female"
                    ]
                  ]
                },
                "infix": {
                  "type": "string",
                  "description": "Infix of the contact name"
                },
                "invoice_email_address": {
                  "type": "string",
                  "description": "Email address used for invoicing"
                },
                "invoice_cc_email_address": {
                  "type": "string",
                  "description": "CC Email address used for invoicing"
                },
                "invoice_bcc_email_address": {
                  "type": "string",
                  "description": "BCC Email address used for invoicing"
                },
                "lastname": {
                  "type": "string",
                  "description": "Last name of contact"
                },
                "middlename": {
                  "type": "string",
                  "description": "Middle name of contact"
                },
                "postal_address_street_1": {
                  "type": "string",
                  "description": "Street address"
                },
                "postal_address_street_2": {
                  "type": "string",
                  "description": "Street address (Second line)"
                },
                "postal_address_postal_code": {
                  "type": "string",
                  "description": "Postal Code"
                },
                "postal_address_city": {
                  "type": "string",
                  "description": "City"
                },
                "postal_address_country_code": {
                  "type": "string",
                  "description": "Country Code"
                },
                "postal_address_region": {
                  "type": "string",
                  "description": "Region"
                },
                "prefix": {
                  "type": "string",
                  "description": "Prefix of the contact name"
                },
                "reminder_email_address": {
                  "type": "string",
                  "description": "Email address used for reminders"
                },
                "reminder_cc_email_address": {
                  "type": "string",
                  "description": "CC Email address used for reminders"
                },
                "reminder_bcc_email_address": {
                  "type": "string",
                  "description": "BCC Email address used for reminders"
                },
                "sms_phone_number": {
                  "type": "string",
                  "description": "Phone number used for sms"
                }
              }
            }
          }
        },
        "required": [
          "administration_id",
          "contacts"
        ],
        "description": "Create or update administration contacts"
      },
      "CustomerApi_ContactsPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_ContactEntity"
            },
            "description": "Contact"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_ContactsPageEntity model"
      },
      "CustomerApi_V1_ContactEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "contact_identifier": {
            "type": "string",
            "description": "Unique external code used to identify contact"
          },
          "call_phone_number": {
            "type": "string",
            "description": "Phone number used for calls"
          },
          "debtor_numbers": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Associated debtor numbers"
          },
          "default_email_address": {
            "type": "string",
            "description": "Default email address"
          },
          "firstname": {
            "type": "string",
            "description": "First name"
          },
          "gender": {
            "type": "string",
            "description": "Gender"
          },
          "infix": {
            "type": "string",
            "description": "Name infix"
          },
          "invoice_email_address": {
            "type": "string",
            "description": "Email address used for invoicing"
          },
          "invoice_cc_email_address": {
            "type": "string",
            "description": "CC email address used for invoicing"
          },
          "invoice_bcc_email_address": {
            "type": "string",
            "description": "BCC email address used for invoicing"
          },
          "lastname": {
            "type": "string",
            "description": "Last name"
          },
          "middlename": {
            "type": "string",
            "description": "Middle name"
          },
          "postal_address_street_1": {
            "type": "string",
            "description": "Street address"
          },
          "postal_address_street_2": {
            "type": "string",
            "description": "Street address (Second line)"
          },
          "postal_address_postal_code": {
            "type": "string",
            "description": "Postal Code"
          },
          "postal_address_city": {
            "type": "string",
            "description": "City"
          },
          "postal_address_country_code": {
            "type": "string",
            "description": "Country Code"
          },
          "postal_address_region": {
            "type": "string",
            "description": "Region"
          },
          "prefix": {
            "type": "string",
            "description": "Name prefix"
          },
          "reminder_email_address": {
            "type": "string",
            "description": "Email address used for reminders"
          },
          "reminder_cc_email_address": {
            "type": "string",
            "description": "CC email address used for reminders"
          },
          "reminder_bcc_email_address": {
            "type": "string",
            "description": "BCC email address used for reminders"
          },
          "sms_phone_number": {
            "type": "string",
            "description": "Phone number used for sms"
          },
          "validation_errors": {
            "type": "object",
            "description": "Validation errors"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the contact was last updated"
          }
        },
        "required": [
          "id",
          "validation_errors",
          "updated_at"
        ]
      },
      "CustomerApi_DeletedCreditCasesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_DeletedCreditCaseEntity"
            },
            "description": "Deleted Credit Case"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_DeletedCreditCasesPageEntity model"
      },
      "CustomerApi_V1_DeletedCreditCaseEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Internal identifier"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated internal debtor identifier"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "description": "Deletion timestamp"
          }
        },
        "required": [
          "id",
          "administration_id",
          "debtor_id",
          "deleted_at"
        ]
      },
      "CustomerApi_CreditCasesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_CreditCaseEntity"
            },
            "description": "Credit case"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_CreditCasesPageEntity model"
      },
      "CustomerApi_V1_CreditCaseEntity": {
        "type": "object",
        "properties": {
          "labels": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_LabelEntity"
            },
            "description": "Labels (request with the 'fields' parameter)"
          },
          "case_number": {
            "type": "string",
            "description": "Case number"
          },
          "public_url": {
            "type": "string",
            "description": "Link to the debtor portal (request with the 'fields' parameter)"
          },
          "deeplink_url": {
            "type": "string",
            "description": "URL to the credit case in the debtor management interface (request with the 'fields' parameter)"
          },
          "credit_case_number": {
            "type": "string",
            "description": "Formatted credit case number"
          },
          "currency_code": {
            "type": "string",
            "description": "Currency code"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "debt_collection_costs": {
            "type": "string",
            "description": "Debt collection costs"
          },
          "open_interest_and_collection_costs": {
            "type": "string",
            "description": "Open interest and collection costs (request with the 'fields' parameter)"
          },
          "total_amount": {
            "type": "string",
            "description": "Total amount of the credit case"
          },
          "open_amount": {
            "type": "string",
            "description": "Total open amount of the credit case"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "interest_costs": {
            "type": "string",
            "description": "Interest"
          },
          "internal_note_email_address": {
            "type": "string",
            "description": "Internal note email address (request with the 'fields' parameter)"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated debtor identifier"
          },
          "payment_plan_id": {
            "type": "string",
            "description": "DEPRECATED, use active_payment_plan_id instead"
          },
          "active_payment_plan_id": {
            "type": "string",
            "description": "Associated active payment plan."
          },
          "forwarded_to_bailiff_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the credit case was forwarded to a bailiff"
          },
          "latest_summons_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the latest summons was sent.\nThis value will be higher than the highest summons_X_at when the credit_case is mentioned in a notice of default.\n"
          },
          "notice_of_default_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the notice of default was sent"
          },
          "pre_judicial_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the pre-judicial phase started"
          },
          "pre_summons_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the debt collection notice was performed"
          },
          "paused_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the credit case was last paused"
          },
          "deactivated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the credit case was deactivated"
          },
          "first_summons_at": {
            "type": "string",
            "format": "date-time",
            "description": "DEPRECATED: use `summons_1_at` instead"
          },
          "summons_1_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the first summons was sent"
          },
          "summons_2_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the second summons was sent"
          },
          "summons_3_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the third summons was sent"
          },
          "summons_4_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the fourth summons was sent"
          },
          "started_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the credit case was started"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the credit case was last updated"
          }
        },
        "required": [
          "case_number",
          "credit_case_number",
          "currency_code",
          "administration_id",
          "debt_collection_costs",
          "total_amount",
          "open_amount",
          "id",
          "interest_costs",
          "debtor_id",
          "started_at",
          "updated_at"
        ],
        "description": "CustomerApi_V1_CreditCaseEntity model"
      },
      "CustomerApi_V1_LabelEntity": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Label name"
          }
        },
        "required": [
          "name"
        ]
      },
      "postV1Debtors": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "debtors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "debtor_number": {
                  "type": "string",
                  "description": "Unique code used to identify debtor"
                },
                "name": {
                  "type": "string",
                  "description": "Name of debtor"
                },
                "debtor_identifier": {
                  "type": "string",
                  "description": "Unique external identifier used to identify debtor"
                },
                "bank_account_name": {
                  "type": "string",
                  "description": "Name of bank account"
                },
                "bank_account_number": {
                  "type": "string",
                  "description": "Number of bank account"
                },
                "category": {
                  "type": "string",
                  "description": "Category of debtor"
                },
                "coc_number": {
                  "type": "string",
                  "description": "Chamber of commerce number of debtor"
                },
                "contact_identifier": {
                  "type": "string",
                  "description": "Unique external identifier used to identify contact"
                },
                "country_code": {
                  "type": "string",
                  "description": "ISO 3166 Alpha-2 country code of debtor"
                },
                "language_code": {
                  "type": "string",
                  "description": "Language code of debtor"
                },
                "oin_number": {
                  "type": "string",
                  "description": "OIN number of debtor"
                },
                "peppol_identifier": {
                  "type": "string",
                  "description": "Peppol identifier of debtor"
                },
                "relation_manager": {
                  "type": "string",
                  "description": "Relation manager of debtor"
                },
                "remark": {
                  "type": "string",
                  "description": "Remark"
                },
                "vat_number": {
                  "type": "string",
                  "description": "VAT number of debtor"
                },
                "is_company": {
                  "type": "boolean",
                  "description": "Whether debtor is a company"
                },
                "peppol_enabled": {
                  "type": "boolean",
                  "description": "Enable or disable Peppol for debtor. Use null to use administration setting"
                },
                "labels": {
                  "type": "array",
                  "description": "Labels of the debtor. Providing labels replaces all existing debtor labels; omitting labels leaves existing labels unchanged.",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "debtor_number",
                "name",
                "debtor_identifier"
              ]
            }
          }
        },
        "required": [
          "administration_id",
          "debtors"
        ],
        "description": "Create or update administration debtors"
      },
      "CustomerApi_SuccessEntity": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Request was handled successfully"
          },
          "count": {
            "type": "integer",
            "format": "int32",
            "example": 98,
            "description": "Number of records processed, those without errors"
          },
          "errors": {
            "type": "object",
            "example": {
              "123456": [
                "Validation error 1",
                "Validation error 2"
              ],
              "123461": [
                "Validation error"
              ]
            },
            "description": "List of records that could not be processed and for which reasons"
          },
          "warnings": {
            "type": "object",
            "example": {
              "123457": [
                "Warning message 1",
                "Warning message 2"
              ]
            },
            "description": "List of records that were partially processed, the messages contain warnings"
          }
        },
        "required": [
          "success",
          "count",
          "errors"
        ],
        "description": "CustomerApi_SuccessEntity model"
      },
      "CustomerApi_DebtorsPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_DebtorEntity"
            },
            "description": "Debtor"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_DebtorsPageEntity model"
      },
      "CustomerApi_V1_DebtorEntity": {
        "type": "object",
        "properties": {
          "book_open_amount": {
            "type": "string",
            "description": "Open amount in administration currency (request with the 'fields' parameter)"
          },
          "call_phone_number": {
            "type": "string",
            "description": "Phone number to call"
          },
          "coc_number": {
            "type": "string",
            "description": "CoC number"
          },
          "autogenerated_credit_limit_amount": {
            "type": "string",
            "description": "Credit limit amount based on payment behaviour (request with the 'fields' parameter, only available when creditworthiness monitoring with autogenerated credit limits is enabled)"
          },
          "credit_limit_amount": {
            "type": "string",
            "description": "Credit limit amount from the accounting package in administration currency"
          },
          "external_credit_limit_amount": {
            "type": "string",
            "description": "Credit limit amount based on GraydonCreditsafe (request with the 'fields' parameter, only available when creditworthiness monitoring is enabled)"
          },
          "external_credit_limit_currency_code": {
            "type": "string",
            "description": "Credit limit currency code based on GraydonCreditsafe (request with the 'fields' parameter, only available when creditworthiness monitoring is enabled)"
          },
          "debtor_provided_email_address": {
            "type": "string",
            "description": "Email address provided by debtor"
          },
          "debtor_number": {
            "type": "string",
            "description": "Debtor number"
          },
          "public_url": {
            "type": "string",
            "description": "Link to the debtor portal (request with the 'fields' parameter)"
          },
          "deeplink_url": {
            "type": "string",
            "description": "URL to the debtor in the debtor management interface (request with the 'fields' parameter)"
          },
          "primary_email_address": {
            "type": "string",
            "description": "Primary email address"
          },
          "invoice_bcc_email_address": {
            "type": "string",
            "description": "Invoice BCC email address"
          },
          "invoice_cc_email_address": {
            "type": "string",
            "description": "Invoice CC email address"
          },
          "invoice_email_address": {
            "type": "string",
            "description": "Invoice email address"
          },
          "internal_note_email_address": {
            "type": "string",
            "description": "Internal note email address (request with the 'fields' parameter)"
          },
          "labels": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_LabelEntity"
            },
            "description": "Labels (request with the 'fields' parameter)"
          },
          "language_code": {
            "type": "string",
            "description": "Language used in communication"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "debtor_identifier": {
            "type": "string",
            "description": "Debtor identifier from accounting software"
          },
          "payment_behaviour": {
            "type": "integer",
            "format": "int32",
            "description": "Payment behaviour (request with the 'fields' parameter)"
          },
          "peppol_identifier": {
            "type": "string",
            "description": "Peppol identifier (request with the 'fields' parameter)"
          },
          "postal_address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_AddressEntity"
              }
            ],
            "description": "Postal address"
          },
          "relation_manager": {
            "type": "string",
            "description": "Relation manager"
          },
          "remark": {
            "type": "string",
            "description": "Remark (request with the 'fields' parameter)"
          },
          "reminder_bcc_email_address": {
            "type": "string",
            "description": "Reminder BCC email address"
          },
          "reminder_cc_email_address": {
            "type": "string",
            "description": "Reminder CC email address"
          },
          "reminder_email_address": {
            "type": "string",
            "description": "Reminder email address"
          },
          "sms_phone_number": {
            "type": "string",
            "description": "Phone number to send SMS to"
          },
          "vat_number": {
            "type": "string",
            "description": "VAT number"
          },
          "peppol_enabled": {
            "type": "boolean",
            "description": "Debtor Peppol override (true/false). Null means fallback to administration setting (request with the 'fields' parameter)"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "paused_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the debtor was paused"
          },
          "reminding_paused_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which sending reminders for the debtor was paused"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the debtor was last updated"
          }
        },
        "required": [
          "debtor_number",
          "name",
          "debtor_identifier",
          "postal_address",
          "administration_id",
          "id",
          "updated_at"
        ],
        "description": "CustomerApi_V1_DebtorEntity model"
      },
      "CustomerApi_V1_AddressEntity": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string",
            "description": "City"
          },
          "country_code": {
            "type": "string",
            "description": "ISO 3166 Alpha-2 country code"
          },
          "postal_code": {
            "type": "string",
            "description": "Postal code"
          },
          "region": {
            "type": "string",
            "description": "Region"
          },
          "street_1": {
            "type": "string",
            "description": "Streetname and housenumber"
          },
          "street_2": {
            "type": "string",
            "description": "Additional address details"
          }
        },
        "required": [
          "city",
          "country_code"
        ]
      },
      "postV1Files": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "files": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "byte_size": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Size of file in bytes"
                },
                "checksum": {
                  "type": "string",
                  "description": "Checksum of file hashed with SHA3-512 algorithm and encoded in base64"
                },
                "content_type": {
                  "type": "string",
                  "description": "Type of content"
                }
              },
              "required": [
                "byte_size",
                "checksum",
                "content_type"
              ]
            }
          }
        },
        "required": [
          "administration_id",
          "files"
        ],
        "description": "Create files to upload"
      },
      "CustomerApi_V1_UploadableFileEntity": {
        "type": "object",
        "properties": {
          "checksum": {
            "type": "string",
            "description": "File checksum"
          },
          "url": {
            "type": "string",
            "description": "URL to upload the file to"
          },
          "expires_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the URL expires"
          }
        },
        "required": [
          "checksum",
          "url",
          "expires_at"
        ],
        "description": "CustomerApi_V1_UploadableFileEntity model"
      },
      "CustomerApi_V1_OrderEntity": {
        "type": "object",
        "properties": {
          "deeplink_url": {
            "type": "string",
            "description": "URL to the order in the debtor management interface"
          }
        },
        "description": "CustomerApi_V1_OrderEntity model"
      },
      "CustomerApi_OrderLinesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_OrderLineEntity"
            },
            "description": "Order line"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_OrderLinesPageEntity model"
      },
      "CustomerApi_V1_OrderLineEntity": {
        "type": "object",
        "properties": {
          "claim": {
            "type": "boolean",
            "description": "Whether to claim the order line amount"
          },
          "claim_status": {
            "type": "string",
            "description": "Status of the claim"
          },
          "claim_response_codes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The response codes from the claim request"
          },
          "deeplink_url": {
            "type": "string",
            "description": "URL to the order line in the debtor management interface (request with the 'fields' parameter)"
          },
          "customer": {
            "type": "object",
            "properties": {
              "email_address": {
                "type": "string"
              }
            },
            "required": [
              "email_address"
            ],
            "description": "Customer  (request with the 'fields' parameter)"
          },
          "product_identifier": {
            "type": "string",
            "description": "Product identifier (request with the 'fields' parameter)"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "order_line_identifier": {
            "type": "string",
            "description": "The unique order line identifier"
          },
          "invoice_identifier": {
            "type": "string",
            "description": "The invoice identifier in the accounting system"
          },
          "credit_invoice_identifier": {
            "type": "string",
            "description": "The invoice identifier of the credit invoice in the accounting system"
          },
          "amount": {
            "type": "string",
            "description": "The total amount"
          },
          "credited_amount": {
            "type": "string",
            "description": "The total amount that is credited"
          },
          "credited_reimbursed_amount": {
            "type": "string",
            "description": "The total reimbursed amount that is credited"
          },
          "rejected_amount": {
            "type": "string",
            "description": "The amount that is rejected and not invoiced"
          },
          "reimbursed_amount": {
            "type": "string",
            "description": "The amount that is reimbursed"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the order line was created"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the order line was last updated"
          }
        },
        "required": [
          "claim",
          "claim_status",
          "administration_id",
          "id",
          "order_line_identifier",
          "amount",
          "credited_amount",
          "credited_reimbursed_amount",
          "rejected_amount",
          "created_at",
          "updated_at"
        ]
      },
      "postV1Invoices": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "invoices": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "currency_code": {
                  "type": "string",
                  "description": "Currency code of the invoice"
                },
                "invoice_number": {
                  "type": "string",
                  "description": "Unique number from your invoicing software that is communicated to the debtor"
                },
                "invoice_date": {
                  "type": "string",
                  "description": "Date at which the invoice becomes payable"
                },
                "invoice_identifier": {
                  "type": "string",
                  "description": "Unique database identifier from your invoicing software"
                },
                "debtor_number": {
                  "type": "string",
                  "description": "Number of the debtor"
                },
                "debtor_identifier": {
                  "type": "string",
                  "description": "Identifier of the debtor"
                },
                "order_number": {
                  "type": "string",
                  "description": "Order number of the invoice"
                },
                "peppol_identifier": {
                  "type": "string",
                  "description": "Peppol identifier of the invoice"
                },
                "description": {
                  "type": "string"
                },
                "category": {
                  "type": "string",
                  "description": "Category of the invoice"
                },
                "contact_identifier": {
                  "type": "string",
                  "description": "Identifier of the invoice contact, when not provided the debtor contact is used"
                },
                "payment_condition": {
                  "type": "string",
                  "description": "Payment condition of the invoice"
                },
                "due_date": {
                  "type": "string",
                  "description": "Date at which the invoice must have been paid"
                },
                "book_amount_total": {
                  "type": "string",
                  "description": "Total amount in the currency of the administration"
                },
                "book_amount_open": {
                  "type": "string",
                  "description": "Open amount in the currency of the administration"
                },
                "amount_open": {
                  "type": "string",
                  "description": "Open amount in the currency of the invoice"
                },
                "amount_total": {
                  "type": "string",
                  "description": "Total amount in the currency of the invoice"
                },
                "payment_method": {
                  "type": "string",
                  "description": "Payment method of the invoice",
                  "enum": [
                    "bank_transfer",
                    "direct_debit",
                    "cash",
                    "none",
                    "unknown"
                  ]
                },
                "sent_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "ISO8601 UTC Timestamp when the invoice was sent. If provided the invoice will not be sent to the debtor, can only be changed if the invoice is not sent yet"
                },
                "labels": {
                  "type": "array",
                  "description": "Labels of the invoice. If labels are provided then all must be provided, any labels not in the request are removed from the invoice.",
                  "items": {
                    "type": "string"
                  }
                },
                "payment_term": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Payment term of the invoice"
                },
                "document": {
                  "type": "object",
                  "description": "Invoice PDF document",
                  "properties": {
                    "checksum": {
                      "type": "string",
                      "description": "Checksum of the document file content in SHA3-512 Base64"
                    },
                    "filename": {
                      "type": "string",
                      "description": "Filename of the document"
                    },
                    "destroy": {
                      "type": "boolean",
                      "description": "If provided the document will be removed from the invoice, can be combined with checksum to remove a specific document"
                    }
                  }
                },
                "ubl_document": {
                  "type": "object",
                  "description": "UBL document",
                  "properties": {
                    "checksum": {
                      "type": "string",
                      "description": "Checksum of the document file content in SHA3-512 Base64"
                    },
                    "filename": {
                      "type": "string",
                      "description": "Filename of the document"
                    },
                    "destroy": {
                      "type": "boolean",
                      "description": "If provided the document will be removed from the invoice, can be combined with checksum to remove a specific document"
                    }
                  }
                },
                "payments": {
                  "type": "array",
                  "description": "If payments are provided then all payments for an invoice must be provided and these must be ordered chronological with the oldest first. If the open_amount of the invoice is changed, but no payments are  provided, then Payt will create a payment for the changed amount.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "amount": {
                        "type": "string",
                        "description": "The amount that was paid, in the currency of the invoice."
                      },
                      "origin_identifier": {
                        "type": "string",
                        "description": "Origin identifier of the payment, should be unique in the administration"
                      },
                      "cost_type": {
                        "type": "string",
                        "description": "Indicates whether payment is for the principal amount of the invoice of for one of the cost types added by Payt",
                        "enum": [
                          "principal",
                          "administration_costs",
                          "interest_costs",
                          "debt_collection_costs"
                        ],
                        "default": "principal"
                      },
                      "payment_date": {
                        "type": "string",
                        "description": "Date of the payment. If not provided the current date is used."
                      },
                      "transaction_type": {
                        "type": "string",
                        "description": "Indicates whether it was an actual payment or if there was a different reason to change the open amount of the invoice.",
                        "enum": [
                          "credit",
                          "payment",
                          "reversal",
                          "revaluation",
                          "settlement",
                          "write_off",
                          ""
                        ]
                      },
                      "book_amount": {
                        "type": "string",
                        "description": "The amount that was paid, in the currency of the administration. If not provided the book_amount is calculated based on the exchange rate of the invoice."
                      },
                      "description": {
                        "type": "string",
                        "description": "Description of the payment"
                      },
                      "payment_method": {
                        "type": "string",
                        "description": "The method that was used to perform the payment. This is only relevant when the transaction_type is `payment`."
                      },
                      "reversal_code": {
                        "type": "string",
                        "description": "The code provided by the bank which indicates the reason why the direct debit transaction was reversed. This is only relevant when the transaction_type is `reversal`"
                      }
                    },
                    "required": [
                      "amount",
                      "origin_identifier"
                    ]
                  }
                },
                "invoice_lines": {
                  "type": "array",
                  "description": "If invoice lines are provided then all lines for an invoice must be provided.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "description": {
                        "type": "string",
                        "description": "Text that describes the product or service that is invoiced."
                      },
                      "vat_rate_code": {
                        "type": "string",
                        "description": "The code of the vat rate applied to the invoice line. This vat rate must be present in the administration."
                      },
                      "total_excl_tax_amount": {
                        "type": "string",
                        "description": "The amount invoiced excluding VAT. If this amount is absent it will be calculated from the total_incl_tax_amount and vat_amount. Either total_excl_tax_amount, total_incl_tax_amount or both must be provided."
                      },
                      "total_incl_tax_amount": {
                        "type": "string",
                        "description": "The amount invoiced including VAT. If this amount is absent it will be calculated from the total_excl_tax_amount and vat_amount. Either total_incl_tax_amount, total_excl_tax_amount or both must be provided."
                      },
                      "product_price": {
                        "type": "string",
                        "description": "The price for a single unit of product."
                      },
                      "product_unit": {
                        "type": "string",
                        "description": "The unit in which the quantity of the invoiced products are counted. Default value is \"piece\"."
                      },
                      "product_quantity": {
                        "type": "string",
                        "description": "The amount of product that is invoiced, in the unit as provided in product_unit. Default value is \"1\"."
                      },
                      "vat_percentage": {
                        "type": "string",
                        "description": "The percentage of VAT applied. This percentage must match the percentage that is associated with the vat_rate_code. If not supplied the percentage that is associated with the vat_rate_code is used."
                      },
                      "vat_amount": {
                        "type": "string",
                        "description": "The amount of VAT charged. If not provided it is calculated from the other values."
                      },
                      "line_order": {
                        "type": "integer",
                        "format": "int32",
                        "description": "The position of the invoice_line within the set of invoice_lines of the invoice. If the line_order is not provided than the order in which the lines are provided will be used. If line_order is provided than each invoice_line must have a unique integer."
                      }
                    },
                    "required": [
                      "description",
                      "vat_rate_code"
                    ]
                  }
                }
              },
              "required": [
                "currency_code",
                "invoice_number",
                "invoice_date",
                "due_date",
                "book_amount_total",
                "book_amount_open",
                "amount_open",
                "amount_total"
              ]
            }
          }
        },
        "required": [
          "administration_id",
          "invoices"
        ],
        "description": "Upsert invoices in bulk"
      },
      "CustomerApi_DeletedInvoicesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_DeletedInvoiceEntity"
            },
            "description": "Deleted Invoice"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_DeletedInvoicesPageEntity model"
      },
      "CustomerApi_V1_DeletedInvoiceEntity": {
        "type": "object",
        "properties": {
          "invoice_number": {
            "type": "string",
            "description": "Invoice number"
          },
          "origin_identifier": {
            "type": "string",
            "description": "Invoice identifier from accounting software"
          },
          "id": {
            "type": "string",
            "description": "Internal identifier"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated internal debtor identifier"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "description": "Deletion timestamp"
          }
        },
        "required": [
          "invoice_number",
          "origin_identifier",
          "id",
          "administration_id",
          "debtor_id",
          "deleted_at"
        ]
      },
      "patchV1Invoices": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "invoices": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "invoice_number": {
                  "type": "string",
                  "description": "Unique number from your invoicing software that is communicated to the debtor"
                },
                "invoice_date": {
                  "type": "string",
                  "description": "Date at which the invoice becomes payable"
                },
                "amount_open": {
                  "type": "string",
                  "description": "Open amount in the currency of the invoice"
                },
                "amount_total": {
                  "type": "string",
                  "description": "Total amount in the currency of the invoice"
                },
                "book_amount_open": {
                  "type": "string",
                  "description": "Open amount in the currency of the administration"
                },
                "book_amount_total": {
                  "type": "string",
                  "description": "Total amount in the currency of the administration"
                },
                "category": {
                  "type": "string",
                  "description": "Category of the invoice"
                },
                "currency_code": {
                  "type": "string",
                  "description": "Currency code of the invoice"
                },
                "debtor_number": {
                  "type": "string",
                  "description": "Number of the debtor"
                },
                "debtor_identifier": {
                  "type": "string",
                  "description": "Identifier of the debtor"
                },
                "description": {
                  "type": "string"
                },
                "due_date": {
                  "type": "string",
                  "description": "Date at which the invoice must have been paid"
                },
                "invoice_identifier": {
                  "type": "string",
                  "description": "Unique database identifier from your invoicing software"
                },
                "order_number": {
                  "type": "string",
                  "description": "Order number of the invoice"
                },
                "peppol_identifier": {
                  "type": "string",
                  "description": "Peppol identifier of the invoice"
                },
                "contact_identifier": {
                  "type": "string",
                  "description": "Identifier of the invoice contact, when not provided the debtor contact is used"
                },
                "payment_condition": {
                  "type": "string",
                  "description": "Payment condition of the invoice"
                },
                "payment_method": {
                  "type": "string",
                  "description": "Payment method of the invoice",
                  "enum": [
                    "bank_transfer",
                    "direct_debit",
                    "cash",
                    "none",
                    "unknown"
                  ]
                },
                "sent_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "ISO8601 UTC Timestamp when the invoice was sent. If provided the invoice will not be sent to the debtor, can only be changed if the invoice is not sent yet"
                },
                "labels": {
                  "type": "array",
                  "description": "Labels of the invoice. If labels are provided then all must be provided, any labels not in the request are removed from the invoice.",
                  "items": {
                    "type": "string"
                  }
                },
                "payment_term": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Payment term of the invoice"
                },
                "document": {
                  "type": "object",
                  "description": "Invoice PDF document",
                  "properties": {
                    "checksum": {
                      "type": "string",
                      "description": "Checksum of the document file content in SHA3-512 Base64"
                    },
                    "filename": {
                      "type": "string",
                      "description": "Filename of the document"
                    },
                    "destroy": {
                      "type": "boolean",
                      "description": "If provided the document will be removed from the invoice, can be combined with checksum to remove a specific document"
                    }
                  }
                },
                "ubl_document": {
                  "type": "object",
                  "description": "UBL document",
                  "properties": {
                    "checksum": {
                      "type": "string",
                      "description": "Checksum of the document file content in SHA3-512 Base64"
                    },
                    "filename": {
                      "type": "string",
                      "description": "Filename of the document"
                    },
                    "destroy": {
                      "type": "boolean",
                      "description": "If provided the document will be removed from the invoice, can be combined with checksum to remove a specific document"
                    }
                  }
                },
                "payments": {
                  "type": "array",
                  "description": "If payments are provided then all payments for an invoice must be provided and these must be ordered chronological with the oldest first. If the open_amount of the invoice is changed, but no payments are  provided, then Payt will create a payment for the changed amount.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "amount": {
                        "type": "string",
                        "description": "The amount that was paid, in the currency of the invoice."
                      },
                      "origin_identifier": {
                        "type": "string",
                        "description": "Origin identifier of the payment, should be unique in the administration"
                      },
                      "cost_type": {
                        "type": "string",
                        "description": "Indicates whether payment is for the principal amount of the invoice of for one of the cost types added by Payt",
                        "enum": [
                          "principal",
                          "administration_costs",
                          "interest_costs",
                          "debt_collection_costs"
                        ],
                        "default": "principal"
                      },
                      "payment_date": {
                        "type": "string",
                        "description": "Date of the payment. If not provided the current date is used."
                      },
                      "transaction_type": {
                        "type": "string",
                        "description": "Indicates whether it was an actual payment or if there was a different reason to change the open amount of the invoice.",
                        "enum": [
                          "credit",
                          "payment",
                          "reversal",
                          "revaluation",
                          "settlement",
                          "write_off",
                          ""
                        ]
                      },
                      "book_amount": {
                        "type": "string",
                        "description": "The amount that was paid, in the currency of the administration. If not provided the book_amount is calculated based on the exchange rate of the invoice."
                      },
                      "description": {
                        "type": "string",
                        "description": "Description of the payment"
                      },
                      "payment_method": {
                        "type": "string",
                        "description": "The method that was used to perform the payment. This is only relevant when the transaction_type is `payment`."
                      },
                      "reversal_code": {
                        "type": "string",
                        "description": "The code provided by the bank which indicates the reason why the direct debit transaction was reversed. This is only relevant when the transaction_type is `reversal`"
                      }
                    },
                    "required": [
                      "amount",
                      "origin_identifier"
                    ]
                  }
                }
              },
              "required": [
                "invoice_number"
              ]
            }
          }
        },
        "required": [
          "administration_id",
          "invoices"
        ],
        "description": "Update administration invoices"
      },
      "CustomerApi_InvoicesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_InvoiceEntity"
            },
            "description": "Invoice"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_InvoicesPageEntity model"
      },
      "CustomerApi_V1_InvoiceEntity": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "description": "Category"
          },
          "currency_code": {
            "type": "string",
            "description": "Currency code in ISO 4217 format"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "public_url": {
            "type": "string",
            "description": "Link to the debtor portal (request with the 'fields' parameter)"
          },
          "deeplink_url": {
            "type": "string",
            "description": "URL to the invoice in the debtor management interface (request with the 'fields' parameter)"
          },
          "flow_code": {
            "type": "string",
            "description": "Code of current flow (request with the 'fields' parameter)"
          },
          "document_url": {
            "type": "string",
            "description": "URL to the invoice document (request with the 'fields' parameter)"
          },
          "ubl_document_url": {
            "type": "string",
            "description": "URL to the UBL invoice document (request with the 'fields' parameter)"
          },
          "internal_note_email_address": {
            "type": "string",
            "description": "Internal note email address (request with the 'fields' parameter)"
          },
          "invoice_number": {
            "type": "string",
            "description": "Invoice number"
          },
          "invoice_lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_InvoiceLineEntity"
            },
            "description": "Invoice lines (request with the 'fields' parameter)"
          },
          "purchase_order_number": {
            "type": "string",
            "description": "Purchase order number"
          },
          "labels": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_LabelEntity"
            },
            "description": "Labels (request with the 'fields' parameter)"
          },
          "order_number": {
            "type": "string",
            "description": "Order number"
          },
          "invoice_identifier": {
            "type": "string",
            "description": "Invoice identifier from accounting software"
          },
          "payment_method": {
            "type": "string",
            "enum": [
              "bank_transfer",
              "direct_debit",
              "cash",
              "none",
              "unknown"
            ],
            "description": "The method of payment as intended, not necessarily the actual method of payment"
          },
          "peppol_identifier": {
            "type": "string",
            "description": "Peppol identifier (request with the 'fields' parameter)"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "credit_case_id": {
            "type": "string",
            "description": "DEPRECATED, use active_credit_case_id instead"
          },
          "active_credit_case_id": {
            "type": "string",
            "description": "Associated active credit case."
          },
          "debtor_id": {
            "type": "string",
            "description": "Internal debtor identifier"
          },
          "debtor_number": {
            "type": "string",
            "description": "Number of the debtor"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "payment_plan_id": {
            "type": "string",
            "description": "DEPRECATED, use active_payment_plan_id instead"
          },
          "active_payment_plan_id": {
            "type": "string",
            "description": "Associated active payment plan."
          },
          "payment_date": {
            "type": "string",
            "description": "Date the invoice was fully paid"
          },
          "due_date": {
            "type": "string",
            "description": "Due date"
          },
          "invoice_date": {
            "type": "string",
            "description": "Invoice date"
          },
          "administration_costs_total": {
            "type": "string",
            "description": "Total administration costs amount in invoice currency"
          },
          "administration_costs_open": {
            "type": "string",
            "description": "Open administration costs amount in invoice currency"
          },
          "total_amount": {
            "type": "string",
            "description": "Total amount in invoice currency"
          },
          "open_amount": {
            "type": "string",
            "description": "Open amount in invoice currency"
          },
          "book_open_amount": {
            "type": "string",
            "description": "Open amount in administration currency"
          },
          "book_total_amount": {
            "type": "string",
            "description": "Total amount in administration currency"
          },
          "paused_by_user": {
            "type": "boolean",
            "description": "Whether the invoice was paused by a user"
          },
          "bailiff_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the invoice was forwarded to a bailiff"
          },
          "collectable_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp after which the invoice became ready for debt collection"
          },
          "debt_collection_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the invoice was sent to debt collection"
          },
          "end_of_service_announcement_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the end of service was announced"
          },
          "end_of_service_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the service was ended"
          },
          "final_reminder_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the final reminder was sent"
          },
          "pre_reminder_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the pre_reminder was sent.\nThis is a reminder sent on or before the due_date and is not considered a true reminder.\n"
          },
          "first_reminder_at": {
            "type": "string",
            "format": "date-time",
            "description": "DEPRECATED: use `reminder_1_at` instead"
          },
          "reminder_1_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the first reminder was sent"
          },
          "reminder_2_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the second reminder was sent"
          },
          "reminder_3_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the third reminder was sent"
          },
          "reminder_4_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the fourth reminder was sent"
          },
          "latest_reminder_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the latest reminder was sent.\nThis value will be higher than the highest reminder_X_at when the invoice is mentioned in a final reminder, or when more than 4 bundled reminders have been sent.\nA pre_reminder is not considered a true reminder so sending one will not result in the latest_reminder_at being set.\n"
          },
          "latest_summons_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the latest summons was sent.\nThis value will be higher than the highest summons_X_at when the credit_case of the invoice is mentioned in a notice of default.\n"
          },
          "notice_of_default_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the notice of default was sent"
          },
          "paused_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the invoice was paused"
          },
          "pre_judicial_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the pre-judicial phase started"
          },
          "pre_summons_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the debt collection notice was performed"
          },
          "sent_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the invoice was sent to the debtor"
          },
          "first_summons_at": {
            "type": "string",
            "format": "date-time",
            "description": "DEPRECATED: use `summons_1_at` instead"
          },
          "summons_1_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the first summons was sent"
          },
          "summons_2_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the second summons was sent"
          },
          "summons_3_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the third summons was sent"
          },
          "summons_4_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the fourth summons was sent"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the invoice was last updated"
          }
        },
        "required": [
          "currency_code",
          "invoice_number",
          "payment_method",
          "administration_id",
          "debtor_id",
          "id",
          "due_date",
          "invoice_date",
          "administration_costs_total",
          "administration_costs_open",
          "total_amount",
          "open_amount",
          "book_open_amount",
          "book_total_amount",
          "updated_at"
        ],
        "description": "CustomerApi_V1_InvoiceEntity model"
      },
      "CustomerApi_V1_InvoiceLineEntity": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "Description"
          },
          "product_unit": {
            "type": "string",
            "description": "Product unit"
          },
          "vat_percentage": {
            "type": "string",
            "description": "VAT percentage"
          },
          "vat_rate_code": {
            "type": "string",
            "description": "VAT rate code"
          },
          "product_quantity": {
            "type": "string",
            "description": "Product quantity"
          },
          "line_order": {
            "type": "integer",
            "format": "int32",
            "description": "Line order"
          },
          "product_price": {
            "type": "string",
            "description": "Product price"
          },
          "total_excl_tax_amount": {
            "type": "string",
            "description": "Total excl tax amount"
          },
          "total_incl_tax_amount": {
            "type": "string",
            "description": "Total incl tax amount"
          },
          "vat_amount": {
            "type": "string",
            "description": "Product tax amount"
          }
        },
        "required": [
          "description",
          "product_unit",
          "vat_percentage",
          "vat_rate_code",
          "product_quantity",
          "line_order",
          "product_price",
          "total_excl_tax_amount",
          "total_incl_tax_amount",
          "vat_amount"
        ]
      },
      "postV1Messages": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "debtor_number": {
            "type": "string",
            "description": "Number of the debtor to send a message to"
          },
          "debtor_identifier": {
            "type": "string",
            "description": "Identifier of the debtor to send a message to"
          },
          "invoice_number": {
            "type": "string",
            "description": "Number of the invoice to send a message to"
          },
          "invoice_identifier": {
            "type": "string",
            "description": "Identifier of the invoice to send a message to"
          },
          "credit_case_number": {
            "type": "string",
            "description": "Number of the credit case to send a message to"
          },
          "message": {
            "type": "object",
            "properties": {
              "body": {
                "type": "string",
                "description": "Message body"
              },
              "subject": {
                "type": "string",
                "description": "Subject of message"
              },
              "email": {
                "type": "string",
                "description": "Email address the message is sent to. When not provided,\n                                                               the message will be sent to the debtor email address,\n                                                               if present"
              },
              "cc_email": {
                "type": "string",
                "description": "CC email addresses separated by commas"
              },
              "bcc_email": {
                "type": "string",
                "description": "BCC email addresses separated by commas"
              },
              "attachments": {
                "type": "array",
                "description": "Multipart files containing message attachments",
                "items": {
                  "type": "string",
                  "format": "binary"
                }
              }
            },
            "required": [
              "body",
              "subject"
            ]
          }
        },
        "required": [
          "administration_id",
          "message"
        ],
        "description": "Send a message to a debtor"
      },
      "CustomerApi_V1_MessageEntity": {
        "type": "object",
        "properties": {
          "sender_type": {
            "type": "string",
            "description": "Sender type (creditor|debtor)"
          },
          "subject": {
            "type": "string",
            "description": "Message subject"
          },
          "read_by_user": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_UserEntity"
              }
            ],
            "description": "User who marked the message as read"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "credit_case_id": {
            "type": "string",
            "description": "Associated credit_case identifier"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated debtor identifier"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "invoice_id": {
            "type": "string",
            "description": "Associated invoice identifier"
          },
          "content": {
            "type": "string",
            "description": "The content of the message (request with the 'fields' parameter)"
          },
          "sent_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the message was sent"
          },
          "received_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the message was received"
          },
          "read_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the message was first read (please note that for some mail clients this field is not filled when an email is read)"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the message was last updated"
          }
        },
        "required": [
          "sender_type",
          "administration_id",
          "id",
          "updated_at"
        ],
        "description": "CustomerApi_V1_MessageEntity model"
      },
      "CustomerApi_V1_UserEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "email_address": {
            "type": "string",
            "description": "Email address"
          }
        },
        "required": [
          "id",
          "name",
          "email_address"
        ]
      },
      "patchV1Messages": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "messages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Message identifier"
                },
                "read": {
                  "type": "boolean",
                  "description": "Whether the message is read"
                }
              },
              "required": [
                "id",
                "read"
              ]
            }
          }
        },
        "required": [
          "administration_id",
          "messages"
        ],
        "description": "Update messages"
      },
      "CustomerApi_MessagesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_MessageEntity"
            },
            "description": "Message"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_MessagesPageEntity model"
      },
      "CustomerApi_NotesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_NoteEntity"
            },
            "description": "Note"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_NotesPageEntity model"
      },
      "CustomerApi_V1_NoteEntity": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "credit_case_id": {
            "type": "string",
            "description": "Associated credit_case identifier"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated debtor identifier"
          },
          "from_email_address": {
            "type": "string",
            "description": "Email address the note originated from"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "invoice_id": {
            "type": "string",
            "description": "Associated invoice identifier"
          },
          "content": {
            "type": "string",
            "description": "The content of the note"
          },
          "user": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_UserEntity"
              }
            ],
            "description": "User who created the note"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the note was created"
          },
          "completed_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the note was marked as completed"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the note was last updated"
          }
        },
        "required": [
          "administration_id",
          "id",
          "content",
          "created_at",
          "updated_at"
        ]
      },
      "CustomerApi_NotificationsPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_NotificationEntity"
            },
            "description": "Notification"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_NotificationsPageEntity model"
      },
      "CustomerApi_V1_NotificationEntity": {
        "type": "object",
        "properties": {
          "notification_type": {
            "type": "string",
            "description": "Notification type (see the [Notification model](https://docs.paytsoftware.com/models/notification))."
          },
          "resource_type": {
            "type": "string",
            "description": "Resource type the notification is about (administration|credit_case|debtor|invoice)"
          },
          "acknowledged_by_user": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_UserEntity"
              }
            ],
            "description": "User who acknowledged the notification"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_NotificationDetailsEntity"
              }
            ],
            "description": "Notification details"
          },
          "credit_case_id": {
            "type": "string",
            "description": "Associated credit_case identifier"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated debtor identifier"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "invoice_id": {
            "type": "string",
            "description": "Associated invoice identifier"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the notification was created"
          },
          "acknowledged_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the notification was acknowledged"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the notification was last updated"
          }
        },
        "required": [
          "notification_type",
          "resource_type",
          "acknowledged_by_user",
          "details",
          "administration_id",
          "id",
          "created_at"
        ],
        "description": "CustomerApi_V1_NotificationEntity model"
      },
      "CustomerApi_V1_NotificationDetailsEntity": {
        "type": "object",
        "properties": {
          "bounce_reason": {
            "type": "string",
            "description": "Reason for a bounced mail (only for mail_bounced notification_type)"
          }
        }
      },
      "CustomerApi_DeletedPaymentsPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_DeletedPaymentEntity"
            },
            "description": "Deleted Payment"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_DeletedPaymentsPageEntity model"
      },
      "CustomerApi_V1_DeletedPaymentEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Internal identifier"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "origin_identifier": {
            "type": "string",
            "description": "External identifier"
          },
          "invoice_id": {
            "type": "string",
            "description": "Associated internal invoice identifier"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "description": "Deletion timestamp"
          }
        },
        "required": [
          "id",
          "administration_id",
          "origin_identifier",
          "invoice_id",
          "deleted_at"
        ]
      },
      "CustomerApi_PaymentsPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_PaymentEntity"
            },
            "description": "Payment"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_PaymentsPageEntity model"
      },
      "CustomerApi_V1_PaymentEntity": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "cost_type": {
            "type": "string",
            "description": "Cost type"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "reason": {
            "type": "string",
            "description": "Reason"
          },
          "reversal_code": {
            "type": "string",
            "description": "Reversal code"
          },
          "transaction_type": {
            "type": "string",
            "description": "Transaction type"
          },
          "invoice_id": {
            "type": "string",
            "description": "Internal unique invoice identifier"
          },
          "payment_method": {
            "type": "string",
            "description": "Payment method"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the payment was last updated"
          },
          "total_amount": {
            "type": "string",
            "description": "Total amount in invoice currency"
          },
          "total_book_amount": {
            "type": "string",
            "description": "Total amount in administration currency"
          },
          "payment_date": {
            "type": "string",
            "description": "Date the payment was made"
          },
          "psp_transaction": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_PspTransactionEntity"
              }
            ],
            "description": "The psp transaction associated with the payment (request with the 'fields' parameter)"
          },
          "bank_transaction": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_BankTransactionEntity"
              }
            ],
            "description": "The bank transaction associated with the payment (request with the 'fields' parameter)"
          }
        },
        "required": [
          "administration_id",
          "id",
          "invoice_id",
          "updated_at",
          "total_amount",
          "total_book_amount",
          "payment_date"
        ]
      },
      "CustomerApi_V1_PspTransactionEntity": {
        "type": "object",
        "properties": {
          "bank_account_name": {
            "type": "string",
            "description": "Name of bank account holder"
          },
          "bank_account_number": {
            "type": "string",
            "description": "Bank account number"
          },
          "currency_code": {
            "type": "string",
            "description": "Currency code in ISO 4217 format"
          },
          "invoice_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Associated invoice identifiers"
          },
          "payment_method": {
            "type": "string",
            "description": "Transaction payment method"
          },
          "reversal_code": {
            "type": "string",
            "description": "Reversal code"
          },
          "status": {
            "type": "string",
            "description": "Transaction status (cancelled|charged_back|failed|paid|pending|processing|refunded)"
          },
          "amount": {
            "type": "string",
            "description": "Amount in invoice currency"
          },
          "book_amount": {
            "type": "string",
            "description": "Amount in administration currency"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated debtor identifier"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "paid_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the PSP transaction was paid"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the psp_transaction was last updated"
          }
        },
        "required": [
          "currency_code",
          "invoice_ids",
          "payment_method",
          "status",
          "amount",
          "book_amount",
          "administration_id",
          "debtor_id",
          "id",
          "updated_at"
        ],
        "description": "CustomerApi_V1_PspTransactionEntity model"
      },
      "CustomerApi_V1_BankTransactionEntity": {
        "type": "object",
        "properties": {
          "bank_account_name": {
            "type": "string",
            "description": "Name of bank account holder"
          },
          "bank_account_number": {
            "type": "string",
            "description": "Bank account number"
          },
          "description": {
            "type": "string",
            "description": "Description of the bank transaction"
          },
          "currency_code": {
            "type": "string",
            "description": "Currency code in ISO 4217 format"
          },
          "exchange_rate": {
            "type": "string",
            "description": "Exchange rate applied to convert from bank transaction currency to administration currency"
          },
          "payment_method": {
            "type": "string",
            "description": "Transaction payment method"
          },
          "amount": {
            "type": "string",
            "description": "Amount in invoice currency"
          },
          "book_amount": {
            "type": "string",
            "description": "Amount in administration currency"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "book_date": {
            "type": "string",
            "description": "Date at which the bank transaction was booked"
          }
        },
        "required": [
          "currency_code",
          "exchange_rate",
          "amount",
          "book_amount",
          "id",
          "book_date"
        ]
      },
      "postV1PaymentConditions": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "payment_conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Code of the payment condition"
                },
                "name": {
                  "type": "string",
                  "description": "Name of the payment condition"
                }
              },
              "required": [
                "code",
                "name"
              ]
            }
          }
        },
        "required": [
          "administration_id",
          "payment_conditions"
        ],
        "description": "Create payment conditions"
      },
      "CustomerApi_V1_PaymentPlanEntity": {
        "type": "object",
        "properties": {
          "payment_terms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_PlannedPaymentEntity"
            },
            "description": "Payment terms"
          },
          "active": {
            "type": "boolean",
            "description": "Whether the payment plan is active"
          },
          "auto_activated": {
            "type": "boolean",
            "description": "Whether the payment plan was auto-activated"
          },
          "reason": {
            "type": "string",
            "description": "Reason for proposing payment plan provided by debtor"
          },
          "rejected_by_user": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_UserEntity"
              }
            ],
            "description": "User who rejected the proposed payment plan"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated debtor identifier"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "approved_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the payment plan was approved"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the payment plan was created"
          },
          "deactivated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the payment plan was deactivated"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the payment_plan was last updated"
          },
          "proposed_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the payment plan was proposed"
          },
          "rejected_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the payment plan was rejected"
          },
          "public_url": {
            "type": "string",
            "description": "Link to the debtor portal (request with the 'fields' parameter)"
          }
        },
        "required": [
          "auto_activated",
          "administration_id",
          "debtor_id",
          "id",
          "created_at",
          "updated_at"
        ],
        "description": "CustomerApi_V1_PaymentPlanEntity model"
      },
      "CustomerApi_V1_PlannedPaymentEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "total_amount": {
            "type": "string",
            "description": "Total amount"
          },
          "amount_due": {
            "type": "string",
            "description": "Amount due"
          },
          "due_date": {
            "type": "string",
            "description": "Due date"
          },
          "payment_date": {
            "type": "string",
            "description": "Date the payment term was fully paid"
          }
        },
        "required": [
          "id",
          "total_amount",
          "amount_due",
          "due_date",
          "payment_date"
        ]
      },
      "postV1PaymentPlans": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "cc_email_address": {
            "type": "string",
            "description": "Email address to send a copy of the payment plan"
          },
          "invoice_numbers": {
            "type": "array",
            "description": "List of invoices by invoice_number to include in the payment plan",
            "items": {
              "type": "string"
            }
          },
          "invoice_identifiers": {
            "type": "array",
            "description": "List of invoices by invoice_identifier to include",
            "items": {
              "type": "string"
            }
          },
          "credit_case_numbers": {
            "type": "array",
            "description": "List of credit cases by credit_case_number to include",
            "items": {
              "type": "string"
            }
          },
          "terms": {
            "type": "array",
            "description": "List of terms for payment plan",
            "items": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "number",
                  "format": "double",
                  "description": "Amount to pay"
                },
                "due_date": {
                  "type": "string",
                  "format": "date",
                  "description": "Due date of the payment"
                }
              },
              "required": [
                "amount",
                "due_date"
              ]
            }
          }
        },
        "required": [
          "administration_id",
          "terms"
        ],
        "description": "Create an approved payment plan"
      },
      "CustomerApi_Deleted_PaymentPlansPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_Deleted_PaymentPlanEntity"
            },
            "description": "Deleted payment plan"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_Deleted_PaymentPlansPageEntity model"
      },
      "CustomerApi_V1_Deleted_PaymentPlanEntity": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "id": {
            "type": "string",
            "description": "Internal identifier"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "description": "Deletion timestamp"
          },
          "debtor_id": {
            "type": "string",
            "description": "Internal debtor identifier"
          }
        },
        "required": [
          "administration_id",
          "id",
          "deleted_at",
          "debtor_id"
        ]
      },
      "CustomerApi_PaymentPlansPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_PaymentPlanEntity"
            },
            "description": "Payment plan"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_PaymentPlansPageEntity model"
      },
      "CustomerApi_Deleted_PspMandatesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_Deleted_PspMandateEntity"
            },
            "description": "Deleted PSP mandate"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_Deleted_PspMandatesPageEntity model"
      },
      "CustomerApi_V1_Deleted_PspMandateEntity": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "id": {
            "type": "string",
            "description": "Internal identifier"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "description": "Deletion timestamp"
          },
          "debtor_id": {
            "type": "string",
            "description": "Internal debtor identifier"
          },
          "mandate_identifier": {
            "type": "string",
            "description": "Identifier from provider"
          },
          "provider": {
            "type": "string",
            "description": "Provider where mandate is registered"
          }
        },
        "required": [
          "administration_id",
          "id",
          "deleted_at",
          "debtor_id",
          "mandate_identifier",
          "provider"
        ]
      },
      "postV1PspMandates": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "fields": {
            "type": "string",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})"
          },
          "psp_mandates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "bank_account_name": {
                  "type": "string",
                  "description": "Bank account name"
                },
                "bank_account_number": {
                  "type": "string",
                  "description": "Bank account number"
                },
                "provider_code": {
                  "type": "string",
                  "description": "Provider code where mandate is registered",
                  "enum": [
                    "mollie",
                    "twikey"
                  ]
                },
                "mandate_identifier": {
                  "type": "string",
                  "description": "Identifier from provider"
                },
                "debtor_code": {
                  "type": "string",
                  "description": "External debtor identifier"
                },
                "debtor_id": {
                  "type": "string",
                  "description": "Internal debtor identifier"
                },
                "customer_identifier": {
                  "type": "string",
                  "description": "Identifier from the psp provider of the customer (for Mollie only)"
                },
                "mandate_reference": {
                  "type": "string",
                  "description": "Customer-supplied mandate reference (unique per administration)"
                }
              },
              "required": [
                "bank_account_name",
                "bank_account_number",
                "provider_code"
              ]
            }
          }
        },
        "required": [
          "administration_id",
          "psp_mandates"
        ],
        "description": "Create signed psp mandates, these need to be verified before creating"
      },
      "CustomerApi_V1_PspMandateEntity": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "bank_account_name": {
            "type": "string",
            "description": "Bank account name"
          },
          "bank_account_number": {
            "type": "string",
            "description": "Bank account number"
          },
          "debtor_id": {
            "type": "string",
            "description": "Internal debtor identifier"
          },
          "id": {
            "type": "string",
            "description": "Internal identifier"
          },
          "mandate_identifier": {
            "type": "string",
            "description": "Identifier from provider"
          },
          "mandate_reference": {
            "type": "string",
            "description": "Customer-supplied mandate reference"
          },
          "provider": {
            "type": "string",
            "description": "Provider where mandate is registered"
          },
          "debtor_number": {
            "type": "string",
            "description": "Debtor number (request with the 'fields' parameter)"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the psp_mandate was last updated"
          },
          "deactivated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the psp_mandate was deactivated"
          }
        },
        "required": [
          "administration_id",
          "bank_account_name",
          "bank_account_number",
          "debtor_id",
          "id",
          "mandate_identifier",
          "provider",
          "updated_at"
        ],
        "description": "CustomerApi_V1_PspMandateEntity model"
      },
      "CustomerApi_PspMandatePageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_PspMandateEntity"
            },
            "description": "Psp mandate"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_PspMandatePageEntity model"
      },
      "CustomerApi_PspTransactionsPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_PspTransactionEntity"
            },
            "description": "Psp transaction"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_PspTransactionsPageEntity model"
      },
      "CustomerApi_V1_SignUpEntity": {
        "type": "object",
        "properties": {
          "administration": {
            "$ref": "#/components/schemas/CustomerApi_V1_AdministrationEntity"
          },
          "company": {
            "$ref": "#/components/schemas/CustomerApi_V1_CompanyEntity"
          },
          "user": {
            "$ref": "#/components/schemas/CustomerApi_V1_SignUpUserEntity"
          },
          "access_grant": {
            "$ref": "#/components/schemas/CustomerApi_V1_AccessGrantEntity"
          }
        },
        "required": [
          "administration",
          "company",
          "user",
          "access_grant"
        ],
        "description": "CustomerApi_V1_SignUpEntity model"
      },
      "CustomerApi_V1_SignUpUserEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "email_address": {
            "type": "string",
            "description": "Email address"
          },
          "sign_up_token": {
            "type": "string",
            "description": "One time token used for in-app sign up"
          },
          "sign_up_url": {
            "type": "string",
            "description": "The url the user can be redirected to in order to complete the sign up."
          }
        },
        "required": [
          "id",
          "name",
          "email_address"
        ]
      },
      "CustomerApi_V1_AccessGrantEntity": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "The code that can be used to created the first access_token."
          },
          "expires_in": {
            "type": "integer",
            "format": "int32",
            "description": "The number of seconds the access_grant is valid."
          },
          "created_at": {
            "type": "string",
            "description": "The UNIX time at which the token was created."
          },
          "grant_type": {
            "type": "string",
            "description": "The OAuth flow the code can be used for, will always be 'authorization_code'."
          }
        },
        "required": [
          "code",
          "expires_in",
          "created_at",
          "grant_type"
        ]
      },
      "postV1TasksIdComment": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "comment": {
            "type": "string",
            "description": "Comment to add to the task"
          }
        },
        "required": [
          "administration_id",
          "comment"
        ],
        "description": "Add a comment to a task"
      },
      "patchV1TasksIdMarkCompleted": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "fields": {
            "type": "string",
            "description": "JSON object defining fields to receive (e.g {\"only\": [\"field1\", {\"field2\": [\"field3\"]}]})"
          },
          "completed_status": {
            "type": "string",
            "description": "Completion status of the task (succeeded, failed, cleaned_up)"
          },
          "completed_status_message": {
            "type": "string",
            "description": "Message explaining the completion status"
          },
          "comment": {
            "type": "string",
            "description": "Comment to add when completing the task"
          },
          "resume_dossiers": {
            "type": "boolean",
            "description": "Whether to resume blocked dossiers associated with the task"
          }
        },
        "required": [
          "administration_id"
        ],
        "description": "Mark a task as completed"
      },
      "CustomerApi_V1_TaskEntity": {
        "type": "object",
        "properties": {
          "assigned_to_user": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_V1_UserEntity"
              }
            ],
            "description": "User the task is assigned to"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "credit_case_id": {
            "type": "string",
            "description": "Associated credit_case identifier"
          },
          "debtor_id": {
            "type": "string",
            "description": "Associated debtor identifier"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "invoice_id": {
            "type": "string",
            "description": "Associated invoice identifier"
          },
          "description": {
            "type": "string",
            "description": "Description of the task"
          },
          "subject": {
            "type": "string",
            "description": "Subject of the task"
          },
          "expiry_date": {
            "type": "string",
            "description": "Expiry date of the task"
          },
          "comments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_CommentEntity"
            },
            "description": "Comments (request with the 'fields' parameter)"
          },
          "completed_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the task was completed"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the task was last updated"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the task was created"
          }
        },
        "required": [
          "administration_id",
          "id",
          "expiry_date",
          "updated_at",
          "created_at"
        ],
        "description": "CustomerApi_V1_TaskEntity model"
      },
      "CustomerApi_V1_CommentEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier"
          },
          "content": {
            "type": "string",
            "description": "Content of the comment"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp at which the comment was created"
          }
        },
        "required": [
          "id",
          "content",
          "created_at"
        ]
      },
      "CustomerApi_TasksPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_TaskEntity"
            },
            "description": "Task"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_TasksPageEntity model"
      },
      "postV1VatRates": {
        "type": "object",
        "properties": {
          "administration_id": {
            "type": "string",
            "description": "Administration identifier"
          },
          "vat_rates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Unique code to identify the vat rate"
                },
                "rate": {
                  "type": "string",
                  "description": "Vat rate in percentage, required on creation"
                },
                "name": {
                  "type": "string",
                  "description": "Name of the vat rate, required on creation"
                },
                "category": {
                  "type": "string",
                  "description": "Category of the vat rate",
                  "enum": [
                    "regular",
                    "zero",
                    "none",
                    "exempt",
                    "reversed",
                    "export",
                    "export_within_eea"
                  ],
                  "default": "regular"
                }
              }
            }
          }
        },
        "required": [
          "administration_id",
          "vat_rates"
        ],
        "description": "Create or update vat rates"
      },
      "CustomerApi_VatRatesPageEntity": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomerApi_V1_VatRateEntity"
            },
            "description": "VAT rate"
          },
          "pagination": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomerApi_PaginationEntity"
              }
            ],
            "description": "Pagination details"
          }
        },
        "required": [
          "data"
        ],
        "description": "CustomerApi_VatRatesPageEntity model"
      },
      "CustomerApi_V1_VatRateEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Internal identifier"
          },
          "administration_id": {
            "type": "string",
            "description": "Owning administration identifier"
          },
          "category": {
            "type": "string",
            "enum": [
              "regular",
              "zero",
              "none",
              "exempt",
              "reversed",
              "export",
              "export_within_eea"
            ],
            "description": "Category"
          },
          "code": {
            "type": "string",
            "description": "Code"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "rate": {
            "type": "number",
            "format": "float",
            "description": "Rate"
          },
          "exemption_reason_code": {
            "type": "string",
            "description": "A code from the VATEX code list. This field is only relevant when creating UBLs and when the `category` is 'exempt'"
          }
        },
        "required": [
          "id",
          "administration_id",
          "category",
          "code",
          "name",
          "rate"
        ]
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "OAuth2 access token or static API token. See [Authorization](/authentication/authorization) for how to obtain one."
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ]
}