openapi: 3.0.0
servers:
  - url: https://api.test.payrun.io
info:
  contact:
    x-twitter: PayRun_io
  description: Open, scableable, transparent payroll API.
  title: PayRun.IO
  version: 23.24.2.136
  x-apisguru-categories:
    - financial
  x-logo:
    url: https://twitter.com/PayRun_io/profile_image?size=original
  x-origin:
    - format: openapi
      url: https://api.test.payrun.io/swagger/json
      version: "3.0"
  x-providerName: payrun.io
externalDocs:
  description: External Documents
  url: https://developer.test.payrun.io/docs
paths:
  "/Employer/{EmployerId}":
    delete:
      description: Delete the specified employer
      operationId: DeleteEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an Employer
      tags:
        - Employer
    get:
      description: Get the specified employer object
      operationId: GetEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employer"
          description: The employer object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the employer
      tags:
        - Employer
    patch:
      description: Patches the specified employer with the supplied values
      operationId: PatchEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Employer"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employer"
          description: The employer object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patches the employer
      tags:
        - Employer
    put:
      description: Updates the existing specified employer object
      operationId: PutEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Employer"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employer"
          description: The employer object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates the Employer
      tags:
        - Employer
  "/Employer/{EmployerId}/CisLineType/{CisLineTypeId}":
    delete:
      description: Delete the specified CIS line type
      operationId: DeleteCisLineType
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS line type unique identifier. E.g. TYPEA
          in: path
          name: CisLineTypeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an CIS line type
      tags:
        - CIS
    get:
      description: Gets the specified CIS line type from employer.
      operationId: GetCisLineTypeFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS line type unique identifier. E.g. TYPEA
          in: path
          name: CisLineTypeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CisLineType"
          description: The cis line type object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS line type from employer
      tags:
        - CIS
    put:
      description: Updates the existing specified CIS line type object
      operationId: PutCisLineTypeIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS line type unique identifier. E.g. TYPEA
          in: path
          name: CisLineTypeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/CisLineType"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CisLineType"
          description: The cis line type object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates the CIS line type
      tags:
        - CIS
  "/Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the CIS line type
      operationId: DeleteCisLineTypeTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS line type unique identifier. E.g. TYPEA
          in: path
          name: CisLineTypeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete CIS line type tag
      tags:
        - Tagging
        - CIS
    get:
      description: Gets the tag from the CIS line type
      operationId: GetTagFromCisLineType
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS line type unique identifier. E.g. TYPEA
          in: path
          name: CisLineTypeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS line type tag
      tags:
        - Tagging
        - CIS
    put:
      description: Inserts a new tag on the CIS line type
      operationId: PutCisLineTypeTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS line type unique identifier. E.g. TYPEA
          in: path
          name: CisLineTypeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert CIS line type tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tags":
    get:
      description: Gets all the tags from the CIS line type
      operationId: GetTagsFromCisLineType
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS line type unique identifier. E.g. TYPEA
          in: path
          name: CisLineTypeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all tags from the CIS line type
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/CisLineTypes":
    get:
      description: Get links to all CIS line types for the specified employer.
      operationId: GetCisLineTypesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS line types from employer.
      tags:
        - CIS
    post:
      description: Create a new CIS line type object
      operationId: PostCisLineTypeIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/CisLineType"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new CIS line type
      tags:
        - CIS
  "/Employer/{EmployerId}/CisLineTypes/Tag/{TagId}":
    get:
      description: Gets the CIS line type with the tag
      operationId: GetCisLineTypesWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS line types with tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/CisLineTypes/Tags":
    get:
      description: Gets all the CIS line type tags
      operationId: GetAllCisLineTypeTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all CIS line type tags
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/CisTransaction/{CisTransactionId}":
    delete:
      description: Deletes the specified CIS transaction
      operationId: DeleteCisTransaction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS transaction unique identifier. E.g. CISTRAN001
          in: path
          name: CisTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete the CIS transaction
      tags:
        - CIS
    get:
      description: Returns the specified CIS transaction
      operationId: GetCisTransactionFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The CIS transaction unique identifier. E.g. CISTRAN001
          in: path
          name: CisTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CisTransaction"
          description: The cis transaction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the CIS transaction
      tags:
        - CIS
  "/Employer/{EmployerId}/CisTransactions":
    get:
      description: Get links for all CIS transactions for the specified employer
      operationId: GetCisTransactionsFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all CIS transactions for the employer
      tags:
        - CIS
  "/Employer/{EmployerId}/DpsMessage/{DpsMessageId}":
    delete:
      description: Deletes the DPS message
      operationId: DeleteDpsMessage
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The DPS message unique identifier. E.g. DPS001
          in: path
          name: DpsMessageId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes the DPS message
      tags:
        - DpsMessage
    get:
      description: Gets the DPS message
      operationId: GetDpsMessageFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The DPS message unique identifier. E.g. DPS001
          in: path
          name: DpsMessageId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DpsMessage"
          description: The dps message object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the DPS message
      tags:
        - DpsMessage
    patch:
      description: Patches the specified DPS message with the supplied values
      operationId: PatchDpsMessage
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The DPS message unique identifier. E.g. DPS001
          in: path
          name: DpsMessageId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DpsMessage"
          description: The dps message object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patches the DPS message
      tags:
        - DpsMessage
    put:
      description: Puts the DPS message
      operationId: PutDpsMessage
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The DPS message unique identifier. E.g. DPS001
          in: path
          name: DpsMessageId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DpsMessage"
          description: The dps message object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Puts the DPS message
      tags:
        - DpsMessage
  "/Employer/{EmployerId}/DpsMessages":
    get:
      description: Gets the DPS message links
      operationId: GetDpsMessagesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the DPS messages
      tags:
        - DpsMessage
    post:
      description: Insert new DPS message
      operationId: PostDpsMessage
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Posta the DPS message
      tags:
        - DpsMessage
  "/Employer/{EmployerId}/Employee/{EmployeeId}":
    delete:
      description: Delete the specified employee
      operationId: DeleteEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an Employee
      tags:
        - Employee
    get:
      description: Gets the specified employee from employer by employee code.
      operationId: GetEmployeeFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employee"
          description: The employee object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee from employer
      tags:
        - Employee
    patch:
      description: Patches the specified employee with the supplied values
      operationId: PatchEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Employee"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employee"
          description: The employee object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patches the employee
      tags:
        - Employee
    put:
      description: Updates the existing specified employee object
      operationId: PutEmployeeIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Employee"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employee"
          description: The employee object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates the Employee
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}":
    delete:
      description: Deletes an existing auto enrolment assessment for the employee. Used to remove historical assessments
      operationId: DeleteAEAssessment
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The auto enrolment assessment unique identifier. E.g. AE001
          in: path
          name: AEAssessmentId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete auto enrolment assessment
      tags:
        - AEAssessment
    get:
      description: Gets the auto enrolment assessment from the specified employee
      operationId: GetAEAssessmentFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The auto enrolment assessment unique identifier. E.g. AE001
          in: path
          name: AEAssessmentId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AEAssessment"
          description: The a e assessment object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the auto enrolment assessment
      tags:
        - AEAssessment
        - Employee
    put:
      description: Creates a new auto enrolment assessment for the employee. Used to insert historical assessments
      operationId: PutNewAEAssessment
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The auto enrolment assessment unique identifier. E.g. AE001
          in: path
          name: AEAssessmentId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/AEAssessment"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AEAssessment"
          description: The a e assessment object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert new auto enrolment assessment
      tags:
        - AEAssessment
  "/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments":
    get:
      description: Gets all auto enrolment assessments from the specified employee
      operationId: GetAEAssessmentsFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the auto enrolment assessments
      tags:
        - AEAssessment
        - Employee
    post:
      description: Creates a new auto enrolment assessment for the employee. Used to insert historical assessments
      operationId: PostNewAEAssessment
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/AEAssessment"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert new auto enrolment assessment
      tags:
        - AEAssessment
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Commentaries":
    get:
      description: Get links to all commentaries for the specified employee.
      operationId: GetCommentariesFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get links to all commentaries for the specified employee
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Commentary/{CommentaryId}":
    get:
      description: Gets the specified commentary report from the employee
      operationId: GetCommentaryFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The commentary unique identifier. E.g. C001
          in: path
          name: CommentaryId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Commentary"
          description: The commentary object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get commentary from employee
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/JournalLines":
    get:
      description: Get links to all journal lines for the specified employee
      operationId: GetJournalLinesFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the journal Lines from the specified employee
      tags:
        - Journals
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}":
    delete:
      description: Delete the specified pay instruction
      operationId: DeletePayInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay instruction unique identifier. E.g. SAL001
          in: path
          name: PayInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a pay instruction
      tags:
        - PayInstruction
    get:
      description: Returns the specified pay instruction from employee
      operationId: GetPayInstructionFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay instruction unique identifier. E.g. SAL001
          in: path
          name: PayInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayInstruction"
          description: The pay instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the specified pay instruction from the employee
      tags:
        - PayInstruction
    patch:
      description: Patches the specified pay instruction with the supplied values
      operationId: PatchPayInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay instruction unique identifier. E.g. SAL001
          in: path
          name: PayInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/PayInstruction"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayInstruction"
          description: The pay instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Sparse Update of a Pay Instruction
      tags:
        - PayInstruction
    put:
      description: Updates the existing specified pay instruction object
      operationId: PutPayInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay instruction unique identifier. E.g. SAL001
          in: path
          name: PayInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/PayInstruction"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayInstruction"
          description: The pay instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Update a Pay Instruction
      tags:
        - PayInstruction
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the pay instruction
      operationId: DeletePayInstructionTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay instruction unique identifier. E.g. SAL001
          in: path
          name: PayInstructionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete pay instruction tag
      tags:
        - Tagging
    get:
      description: Gets the tag from the pay instruction
      operationId: GetTagFromPayInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay instruction unique identifier. E.g. SAL001
          in: path
          name: PayInstructionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay instruction tag
      tags:
        - Tagging
    put:
      description: Inserts a new tag on the pay instruction
      operationId: PutPayInstructionTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay instruction unique identifier. E.g. SAL001
          in: path
          name: PayInstructionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert pay instruction tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tags":
    get:
      description: Gets all the tags from the pay instruction
      operationId: GetTagsFromPayInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay instruction unique identifier. E.g. SAL001
          in: path
          name: PayInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all tags from the pay instruction
      tags:
        - Tagging
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions":
    get:
      description: Get links to all pay instructions for the specified employee
      operationId: GetPayInstructionsFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay instructions from the specified employee
      tags:
        - PayInstruction
    post:
      description: Creates a new pay instruction object
      operationId: PostPayInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/PayInstruction"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Creates a new Pay Instruction
      tags:
        - PayInstruction
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tag/{TagId}":
    get:
      description: Gets the pay instructions with the tag
      operationId: GetPayInstructionsWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay instructions with tag
      tags:
        - Tagging
        - PayInstruction
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tags":
    get:
      description: Gets all the pay instruction tags
      operationId: GetAllPayInstructionTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pay instruction tags
      tags:
        - Tagging
        - PayInstruction
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}":
    get:
      description: Returns the specified pay line from employee
      operationId: GetPayLineFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay line unique identifier. E.g. PL001
          in: path
          name: PayLineId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayLine"
          description: The pay line object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the specified pay line from the employee
      tags:
        - PayLine
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the pay line
      operationId: DeletePayLineTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay line unique identifier. E.g. PL001
          in: path
          name: PayLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete pay line tag
      tags:
        - Tagging
    get:
      description: Gets the tag from the pay line
      operationId: GetTagFromPayLine
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay line unique identifier. E.g. PL001
          in: path
          name: PayLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay line tag
      tags:
        - Tagging
    put:
      description: Inserts a new tag on the pay line
      operationId: PutPayLineTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay line unique identifier. E.g. PL001
          in: path
          name: PayLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert pay line tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tags":
    get:
      description: Gets all the tags from the pay line
      operationId: GetTagsFromPayLine
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The pay line unique identifier. E.g. PL001
          in: path
          name: PayLineId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all tags from the pay line
      tags:
        - Tagging
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayLines":
    get:
      description: Get links to all pay lines for the specified employee
      operationId: GetPayLinesFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay lines from the specified employee
      tags:
        - PayLine
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayLines/Tag/{TagId}":
    get:
      description: Gets the pay line with the tag
      operationId: GetPayLinesWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay lines with tag
      tags:
        - Tagging
        - PayLine
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayLines/Tags":
    get:
      description: Gets all the pay line tags
      operationId: GetAllPayLineTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pay line tags
      tags:
        - Tagging
        - PayLine
  "/Employer/{EmployerId}/Employee/{EmployeeId}/PayRuns":
    get:
      description: Get links to all pay runs for the specified employee.
      operationId: GetPayRunsFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay runs from the employee
      tags:
        - PayRun
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}":
    delete:
      description: Deletes the specified employee revision for the matching revision number
      operationId: DeleteEmployeeRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an Employee revision matching the specified revision number.
      tags:
        - Employee
    get:
      description: Get the employee revision matching the specified revision number
      operationId: GetEmployeeRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employee"
          description: The employee object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the employee by revision number
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}/Summary":
    get:
      description: Get the employee revision summary matching the specified revision number
      operationId: GetEmployeeRevisionSummaryByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployeeSummary"
          description: The employee summary object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the employee summary by revision number
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Revisions":
    get:
      description: Gets links to all employee revisions
      operationId: GetEmployeeRevisions
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employee revisions
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Revisions/Summary":
    get:
      description: Gets links to all employee revision summaries
      operationId: GetEmployeeRevisionSummaries
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employee revision summaries
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId}":
    delete:
      description: Deletes an employee secret from the given resource location
      operationId: DeleteEmployeeSecret
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes employee secret
      tags:
        - Employee
    get:
      description: Get the public visible employee secret object
      operationId: GetEmployeeSecret
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployeeSecret"
          description: The employee secret object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee secret
      tags:
        - Employee
    put:
      description: Create / update an employee secret at the given resource location
      operationId: PutEmployeeSecret
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployeeSecret"
          description: The employee secret object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new employee secret
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Secrets":
    get:
      description: Get all the employee secret links
      operationId: GetEmployeeSecrets
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employee secret links
      tags:
        - Employee
    post:
      description: Create new employee secret using auto generated resource location key
      operationId: PostEmployeeSecret
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new employee secret
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Summary":
    get:
      description: Gets the specified employee summary data from employer by employee code.
      operationId: GetEmployeeSummaryFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployeeSummary"
          description: The employee summary object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee summary from employer
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the employee
      operationId: DeleteEmployeeTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete employee tag
      tags:
        - Tagging
    get:
      description: Gets the tag from the employee
      operationId: GetTagFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee tag
      tags:
        - Tagging
    put:
      description: Inserts a new tag on the employee
      operationId: PutEmployeeTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert employee tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}/{EffectiveDate}":
    get:
      description: Gets the tag from the employee revision
      operationId: GetTagFromEmployeeRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee revision tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Tags":
    get:
      description: Gets all the tags from the employee
      operationId: GetTagsFromEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employee tags
      tags:
        - Tagging
  "/Employer/{EmployerId}/Employee/{EmployeeId}/Tags/{EffectiveDate}":
    get:
      description: Gets all the tags from the employee revision
      operationId: GetTagsFromEmployeeRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employee revision tags
      tags:
        - Tagging
  "/Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}":
    delete:
      description: Deletes the specified employee revision for the matching revision date
      operationId: DeleteEmployeeRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an Employee revision matching the specified revision date.
      tags:
        - Employee
    get:
      description: Returns the employee's state at the specified effective date.
      operationId: GetEmployeeByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employee"
          description: The employee object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee by effective date.
      tags:
        - Employee
  "/Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}/Summary":
    get:
      description: Gets the employee summary for the specified effective date.
      operationId: GetEmployeeSummaryByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployeeSummary"
          description: The employee summary object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee summary by effective date.
      tags:
        - Employee
  "/Employer/{EmployerId}/Employees":
    get:
      description: Get links to all employees for the specified employer.
      operationId: GetEmployeesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employees from employer.
      tags:
        - Employee
    post:
      description: Create a new employee object
      operationId: PostEmployeeIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Employee"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new Employee
      tags:
        - Employee
  "/Employer/{EmployerId}/Employees/Summary":
    get:
      description: Get links to all employee summaries for the specified employer.
      operationId: GetEmployeeSummariesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee summaries from employer.
      tags:
        - Employee
  "/Employer/{EmployerId}/Employees/Tag/{TagId}":
    get:
      description: Gets the employees with the tag
      operationId: GetEmployeesWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employees with tag
      tags:
        - Tagging
        - Employee
  "/Employer/{EmployerId}/Employees/Tags":
    get:
      description: Gets all the employee tags
      operationId: GetAllEmployeeTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employee tags
      tags:
        - Tagging
        - Employee
  "/Employer/{EmployerId}/Employees/{EffectiveDate}":
    get:
      description: Get links to all employees for the employer on specified effective date.
      operationId: GetEmployeesByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employees from employer at a given effective date.
      tags:
        - Employee
  "/Employer/{EmployerId}/Employees/{EffectiveDate}/Summary":
    get:
      description: Get links to all employee summaries for the employer on specified effective date.
      operationId: GetEmployeeSummariesByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employee summaries from employer at a given effective date.
      tags:
        - Employee
  "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}":
    delete:
      description: Delete the specified holiday scheme
      operationId: DeleteHolidayScheme
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an holiday scheme
      tags:
        - HolidayScheme
    get:
      description: Gets the specified holiday scheme from employer.
      operationId: GetHolidaySchemeFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HolidayScheme"
          description: The holiday scheme object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get holiday scheme from employer
      tags:
        - HolidayScheme
    patch:
      description: Patches the specified holiday scheme with the supplied values
      operationId: PatchHolidayScheme
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/HolidayScheme"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HolidayScheme"
          description: The holiday scheme object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patches the holiday scheme
      tags:
        - HolidayScheme
    put:
      description: Updates the existing specified holiday scheme object
      operationId: PutHolidaySchemeIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/HolidayScheme"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HolidayScheme"
          description: The holiday scheme object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates the holiday scheme
      tags:
        - HolidayScheme
  "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revision/{RevisionNumber}":
    delete:
      description: Deletes the specified holiday scheme revision for the matching revision number
      operationId: DeleteHolidaySchemeRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an HolidayScheme revision matching the specified revision number.
      tags:
        - HolidayScheme
    get:
      description: Get the holiday scheme revision matching the specified revision number
      operationId: GetHolidaySchemeRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HolidayScheme"
          description: The holiday scheme object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the holiday scheme revision by revision number
      tags:
        - HolidayScheme
  "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revisions":
    get:
      description: Gets links to all the holiday scheme revisions
      operationId: GetHolidaySchemeRevisions
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all holiday scheme revisions
      tags:
        - HolidayScheme
  "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the holiday scheme
      operationId: DeleteHolidaySchemeTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete holiday scheme tag
      tags:
        - Tagging
        - HolidayScheme
    get:
      description: Gets the tag from the holiday scheme
      operationId: GetTagFromHolidayScheme
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get holiday scheme tag
      tags:
        - Tagging
        - HolidayScheme
    put:
      description: Inserts a new tag on the holiday scheme
      operationId: PutHolidaySchemeTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert holiday scheme tag
      tags:
        - Tagging
        - HolidayScheme
  "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}/{EffectiveDate}":
    get:
      description: Gets the tag from the holiday scheme revision
      operationId: GetTagFromHolidaySchemeRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get holiday scheme revision tag
      tags:
        - Tagging
        - HolidayScheme
  "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tags":
    get:
      description: Gets all the tags from the holiday scheme
      operationId: GetTagsFromHolidayScheme
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all tags from the holiday scheme
      tags:
        - Tagging
        - HolidayScheme
  "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tags/{EffectiveDate}":
    get:
      description: Gets all the tags from the holiday scheme revision
      operationId: GetTagsFromHolidaySchemeRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all holiday scheme revision tags
      tags:
        - Tagging
        - HolidayScheme
  "/Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/{EffectiveDate}":
    delete:
      description: Deletes the specified holiday scheme revision for the matching revision date
      operationId: DeleteHolidaySchemeRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an holiday scheme revision matching the specified revision date.
      tags:
        - HolidayScheme
    get:
      description: Returns the holiday scheme's state at the specified effective date.
      operationId: GetHolidaySchemeByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The holiday schemes' unique identifier. E.g HOLSCH001
          in: path
          name: HolidaySchemeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HolidayScheme"
          description: The holiday scheme object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get holiday scheme by effective date.
      tags:
        - HolidayScheme
  "/Employer/{EmployerId}/HolidaySchemes":
    get:
      description: Get links to all holiday schemes for the specified employer.
      operationId: GetHolidaySchemesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get holiday schemes from employer.
      tags:
        - HolidayScheme
    post:
      description: Create a new holiday scheme object
      operationId: PostHolidaySchemeIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/HolidayScheme"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new holiday scheme
      tags:
        - HolidayScheme
  "/Employer/{EmployerId}/HolidaySchemes/Tag/{TagId}":
    get:
      description: Gets the holiday scheme with the tag
      operationId: GetHolidaySchemesWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get holiday schemes with tag
      tags:
        - Tagging
        - HolidayScheme
  "/Employer/{EmployerId}/HolidaySchemes/Tags":
    get:
      description: Gets all the holiday scheme tags
      operationId: GetAllHolidaySchemeTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all holiday scheme tags
      tags:
        - Tagging
        - HolidayScheme
  "/Employer/{EmployerId}/HolidaySchemes/{EffectiveDate}":
    get:
      description: Get links to all holiday schemes for the employer on specified effective date.
      operationId: GetHolidaySchemesByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get holiday schemes from employer at a given effective date.
      tags:
        - HolidayScheme
  "/Employer/{EmployerId}/JournalInstruction/{JournalInstructionId}":
    delete:
      description: Delete the specified Journal instruction
      operationId: DeleteJournalInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The journal instruction unique identifier. E.g JI001
          in: path
          name: JournalInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a Journal instruction
      tags:
        - Journals
    get:
      description: Returns the specified journal instruction from employer
      operationId: GetJournalInstructionFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The journal instruction unique identifier. E.g JI001
          in: path
          name: JournalInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JournalInstruction"
          description: The journal instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the specified journal instruction from the employer
      tags:
        - Journals
    put:
      description: Updates the existing specified Journal instruction object
      operationId: PutJournalInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The journal instruction unique identifier. E.g JI001
          in: path
          name: JournalInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JournalInstruction"
          description: The journal instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Update a Journal Instruction
      tags:
        - Journals
  "/Employer/{EmployerId}/JournalInstructions":
    get:
      description: Get links to all journal instructions for the specified employer
      operationId: GetJournalInstructionsFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the Journal instructions from the specified employer
      tags:
        - Journals
    post:
      description: Creates a new Journal instruction object
      operationId: PostJournalInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Creates a new Journal Instruction
      tags:
        - Journals
  "/Employer/{EmployerId}/JournalLine/{JournalLineId}":
    get:
      description: Returns the specified journal Line from employer
      operationId: GetJournalLineFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The journal line unique identifier. E.g JL001
          in: path
          name: JournalLineId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JournalLine"
          description: The journal line object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the specified journal Line from the employer
      tags:
        - Journals
  "/Employer/{EmployerId}/JournalLine/{JournalLineId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the journal line
      operationId: DeleteJournalLineTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The journal line unique identifier. E.g JL001
          in: path
          name: JournalLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete journal line tag
      tags:
        - Tagging
        - JournalLine
    get:
      description: Gets a tag from the journal line
      operationId: GetTagFromJournalLine
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The journal line unique identifier. E.g JL001
          in: path
          name: JournalLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get journal line tag
      tags:
        - Tagging
        - JournalLine
    put:
      description: Inserts a tag on the journal line
      operationId: PutJournalLineTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The journal line unique identifier. E.g JL001
          in: path
          name: JournalLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert journal line tag
      tags:
        - Tagging
        - JournalLine
  "/Employer/{EmployerId}/JournalLine/{JournalLineId}/Tags":
    get:
      description: Gets all tags from the journal line
      operationId: GetTagsFromJournalLine
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The journal line unique identifier. E.g JL001
          in: path
          name: JournalLineId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get tags from journal line
      tags:
        - Tagging
        - JournalLine
  "/Employer/{EmployerId}/JournalLines":
    get:
      description: Get links to all journal Lines for the specified employer
      operationId: GetJournalLinesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the Journal Lines from the specified employer
      tags:
        - Journals
  "/Employer/{EmployerId}/JournalLines/Tag/{TagId}":
    get:
      description: Gets the journal lines with the specified tag
      operationId: GetAllJournalLinesWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get links to tagged journal lines
      tags:
        - Tagging
        - JournalLine
  "/Employer/{EmployerId}/JournalLines/Tags":
    get:
      description: Gets all the journal line tags
      operationId: GetAllJournalLineTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all journal line tags
      tags:
        - Tagging
        - JournalLine
  "/Employer/{EmployerId}/NominalCode/{NominalCodeId}":
    delete:
      description: Deletes the nominal code
      operationId: DeleteNominalCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The nominal code unique identifier. E.g. NOM001
          in: path
          name: NominalCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes the nominal codes
      tags:
        - NominalCode
    get:
      description: Gets the nominal code
      operationId: GetNominalCodeFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The nominal code unique identifier. E.g. NOM001
          in: path
          name: NominalCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NominalCode"
          description: The nominal code object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the nominal code
      tags:
        - NominalCode
    put:
      description: Inserts a new nominal code at the specified resource location
      operationId: PutNominalCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The nominal code unique identifier. E.g. NOM001
          in: path
          name: NominalCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/NominalCode"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NominalCode"
          description: The nominal code object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert nominal code
      tags:
        - NominalCode
  "/Employer/{EmployerId}/NominalCode/{NominalCodeId}/PayCodes":
    get:
      description: Get the pay codes that share the specified nominal code
      operationId: GetPayCodesFromNominalCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The nominal code unique identifier. E.g. NOM001
          in: path
          name: NominalCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay codes by nominal code
      tags:
        - PayCode
  "/Employer/{EmployerId}/NominalCodes":
    get:
      description: Gets the nominal code links
      operationId: GetNominalCodesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the nominal codes
      tags:
        - NominalCode
    post:
      description: Inserts a new nominal code
      operationId: PostNominalCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/NominalCode"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert nominal code
      tags:
        - NominalCode
  "/Employer/{EmployerId}/PayCode/{PayCodeId}":
    delete:
      description: Delete the specified pay code
      operationId: DeletePayCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a pay code
      tags:
        - PayCode
    get:
      description: Returns the specified pay code from the employer
      operationId: GetPayCodeFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayCode"
          description: The pay code object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the specified pay code from the employer
      tags:
        - PayCode
    patch:
      description: Patches the specified pay code object with the supplied values
      operationId: PatchPayCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/PayCode"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayCode"
          description: The pay code object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patches the pay code
      tags:
        - PayCode
    put:
      description: Updates the existing specified pay code object
      operationId: PutPayCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/PayCode"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayCode"
          description: The pay code object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates a pay code
      tags:
        - PayCode
  "/Employer/{EmployerId}/PayCode/{PayCodeId}/Revision/{RevisionNumber}":
    delete:
      description: Deletes the specified pay code revision for the matching revision number
      operationId: DeletePayCodeRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an PayCode revision matching the specified revision number.
      tags:
        - PayCode
    get:
      description: Get the pay code revision matching the specified revision number
      operationId: GetPayCodeRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayCode"
          description: The pay code object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay code by revision number
      tags:
        - PayCode
  "/Employer/{EmployerId}/PayCode/{PayCodeId}/Revisions":
    get:
      description: Returns links to all revisions of the pay code
      operationId: GetPayCodeRevisions
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all revisions of the Pay Code
      tags:
        - PayCode
  "/Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the pay code
      operationId: DeletePayCodeTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete pay code tag
      tags:
        - Tagging
    get:
      description: Gets the tag from the pay code
      operationId: GetTagFromPayCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay code tag
      tags:
        - Tagging
    put:
      description: Inserts a new tag on the pay code
      operationId: PutPayCodeTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert pay code tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/PayCode/{PayCodeId}/Tags":
    get:
      description: Gets all the tags from the pay code
      operationId: GetTagsFromPayCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pay code tags
      tags:
        - Tagging
  "/Employer/{EmployerId}/PayCode/{PayCodeId}/{EffectiveDate}":
    delete:
      description: Delete the pay code revision for the specified date
      operationId: DeletePayCodeRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a pay code revision
      tags:
        - PayCode
    get:
      description: Gets the pay code revision for the specified effective date
      operationId: GetPayCodeByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay code unique identifier. E.g. BASIC
          in: path
          name: PayCodeId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayCode"
          description: The pay code object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets pay code for specified date
      tags:
        - PayCode
  "/Employer/{EmployerId}/PayCodes":
    get:
      description: Get links to all the pay codes for the specified employer
      operationId: GetPayCodesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay codes from the employer
      tags:
        - PayCode
    post:
      description: Create a new pay code object
      operationId: PostPayCode
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/PayCode"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new pay code
      tags:
        - PayCode
  "/Employer/{EmployerId}/PayCodes/Tag/{TagId}":
    get:
      description: Gets the pay codes with the tag
      operationId: GetPayCodesWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay codes with tag
      tags:
        - Tagging
        - PayCode
  "/Employer/{EmployerId}/PayCodes/Tags":
    get:
      description: Gets all the pay code tags
      operationId: GetAllPayCodeTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pay code tags
      tags:
        - Tagging
        - PayCode
  "/Employer/{EmployerId}/PayCodes/{EffectiveDate}":
    get:
      description: Gets the effective pay code revision for the specified date
      operationId: GetPayCodesByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets all pay codes for specified date
      tags:
        - PayCode
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}":
    delete:
      description: Delete the specified pay schedule
      operationId: DeletePaySchedule
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a pay schedule
      tags:
        - PaySchedule
    get:
      description: Returns the specified pay schedule object from employer
      operationId: GetPayScheduleFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PaySchedule"
          description: The pay schedule object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the specified pay schedule from the employer
      tags:
        - PaySchedule
    put:
      description: Updates the existing specified pay schedule object
      operationId: PutPaySchedule
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/PaySchedule"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PaySchedule"
          description: The pay schedule object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates a pay schedule
      tags:
        - PaySchedule
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees":
    get:
      description: Gets links to all employee revisions that have ever existed in the specified pay schedule.
      operationId: GetEmployeesFromPaySchedule
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employees revisions from a pay schedule.
      tags:
        - Employee
        - PaySchedule
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees/{EffectiveDate}":
    get:
      description: Gets links to all employee revisions in the specified pay schedule for the given effective date.
      operationId: GetEmployeesFromPayScheduleOnEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employees from a pay schedule on effective date.
      tags:
        - Employee
        - PaySchedule
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}":
    delete:
      description: Delete the specified pay run
      operationId: DeletePayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a pay run
      tags:
        - PayRun
    get:
      description: Returns the pay run from the pay schedule
      operationId: GetPayRunFromPaySchedule
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PayRun"
          description: The pay run object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay run from the pay schedule
      tags:
        - PayRun
        - PaySchedule
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/AEAssessments":
    get:
      description: Gets all auto enrolment assessments from the specified pay run
      operationId: GetAEAssessmentsFromPayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the auto enrolment assessments
      tags:
        - AEAssessment
        - PayRun
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Commentaries":
    get:
      description: Get links to all commentaries for the specified pay run.
      operationId: GetCommentariesFromPayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get links to all commentaries for the specified pay run
      tags:
        - PayRun
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employee/{EmployeeId}":
    delete:
      description: Delete pay run results for a single employee
      operationId: DeletePayRunEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a pay run employee
      tags:
        - PayRun
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employee/{EmployeeId}/Commentary":
    get:
      description: Get commentary from payrun by specified employee.
      operationId: GetCommentaryFromPayRunByEmployee
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The employees' unique identifier. E.g EE001
          in: path
          name: EmployeeId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Commentary"
          description: The commentary object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get commentary from payrun by specified employee.
      tags:
        - Employee
        - PayRun
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employees":
    get:
      description: Gets links to all employees included in the specified pay run.
      operationId: GetEmployeesFromPayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employees from the pay run
      tags:
        - Employee
        - PayRun
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/JournalLines":
    get:
      description: Get links to all journal lines for the specified pay run
      operationId: GetJournalLinesFromPayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the journal Lines from the specified pay run
      tags:
        - Journals
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/PayLines":
    get:
      description: Get links to all pay lines for the specified pay run
      operationId: GetPayLinesFromPayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay lines from the specified pay run
      tags:
        - PayLine
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/ReportLines":
    get:
      description: Returns all report lines associated with the specified pay run
      operationId: GetReportLinesFromPayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the report lines from the specified pay run
      tags:
        - ReportLine
        - PayRun
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the pay run
      operationId: DeletePayRunTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete pay run tag
      tags:
        - Tagging
    get:
      description: Gets the tag from the pay run
      operationId: GetTagFromPayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay run tag
      tags:
        - Tagging
    put:
      description: Inserts a new tag on the pay run
      operationId: PutPayRunTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert pay run tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tags":
    get:
      description: Gets all the tags from the pay run
      operationId: GetTagsFromPayRun
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The pay runs' unique identifier. E.g. PR001
          in: path
          name: PayRunId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pay run tags
      tags:
        - Tagging
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns":
    get:
      description: Get links to all pay runs for the specified pay schedule
      operationId: GetPayRunsFromPaySchedule
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay runs from the pay schedule
      tags:
        - PayRun
        - PaySchedule
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tag/{TagId}":
    get:
      description: Gets the pay runs with the tag
      operationId: GetPayRunsWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay runs with tag
      tags:
        - Tagging
        - PayRun
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tags":
    get:
      description: Gets all the pay run tags
      operationId: GetAllPayRunTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pay run tags
      tags:
        - Tagging
        - PayRun
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the pay schedule
      operationId: DeletePayScheduleTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete pay schedule tag
      tags:
        - Tagging
    get:
      description: Gets the tag from the pay schedule
      operationId: GetTagFromPaySchedule
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay schedule tag
      tags:
        - Tagging
    put:
      description: Inserts a new tag on the pay schedule
      operationId: PutPayScheduleTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert pay schedule tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tags":
    get:
      description: Gets all the tags from the pay schedule
      operationId: GetTagsFromPaySchedule
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pay schedules' unique identifier. E.g SCH001
          in: path
          name: PayScheduleId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pay schedule tags
      tags:
        - Tagging
  "/Employer/{EmployerId}/PaySchedules":
    get:
      description: Get links to all pay schedules for the specified employer
      operationId: GetPaySchedulesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pay schedule from the specified employer
      tags:
        - PaySchedule
    post:
      description: Create a new pay schedule object
      operationId: PostPaySchedule
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/PaySchedule"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new pay schedule
      tags:
        - PaySchedule
  "/Employer/{EmployerId}/PaySchedules/Tag/{TagId}":
    get:
      description: Gets the pay schedules with the tag
      operationId: GetPaySchedulesWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pay schedule with tag
      tags:
        - Tagging
        - PaySchedule
  "/Employer/{EmployerId}/PaySchedules/Tags":
    get:
      description: Gets all the pay schedule tags
      operationId: GetAllPayScheduleTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pay schedule tags
      tags:
        - Tagging
        - PaySchedule
  "/Employer/{EmployerId}/Pension/{PensionId}":
    delete:
      description: Delete the specified ppension
      operationId: DeletePension
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete a Pension
      tags:
        - Pension
    get:
      description: Gets the specified pension from employer by pension code.
      operationId: GetPensionFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pension"
          description: The pension object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pension from employer
      tags:
        - Pension
    patch:
      description: Patches the specified pension with the supplied values
      operationId: PatchPension
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Pension"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pension"
          description: The pension object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patches the pension
      tags:
        - Pension
    put:
      description: Updates existing or inserts the specified pension object
      operationId: PutPensionIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Pension"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pension"
          description: The pension object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates the Pension
      tags:
        - Pension
  "/Employer/{EmployerId}/Pension/{PensionId}/Revision/{RevisionNumber}":
    delete:
      description: Deletes the specified pension revision for the matching revision number
      operationId: DeletePensionRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an Pension revision matching the specified revision number.
      tags:
        - Pension
    get:
      description: Get the pension revision matching the specified revision number
      operationId: GetPensionRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pension"
          description: The pension object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the pension by revision number
      tags:
        - Pension
  "/Employer/{EmployerId}/Pension/{PensionId}/Revisions":
    get:
      description: Returns links to all revisions of the pension
      operationId: GetPensionRevisions
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all pension revisions
      tags:
        - Pension
  "/Employer/{EmployerId}/Pension/{PensionId}/{EffectiveDate}":
    delete:
      description: Deletes the specified pension revision for the matching revision date
      operationId: DeletePensionRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an Pension revision matching the specified revision date.
      tags:
        - Pension
    get:
      description: Returns the penion's state at the specified effective date.
      operationId: GetPensionByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The pensions' unique identifier. E.g PEN001
          in: path
          name: PensionId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pension"
          description: The pension object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pension by effective date.
      tags:
        - Pension
  "/Employer/{EmployerId}/Pensions":
    get:
      description: Get links to all pensions for the specified employer.
      operationId: GetPensionsFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pensions from employer.
      tags:
        - Pension
    post:
      description: Create a new pension object
      operationId: PostPensionIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Pension"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new Pension
      tags:
        - Pension
  "/Employer/{EmployerId}/Pensions/{EffectiveDate}":
    get:
      description: Get links to all pensions for the employer on specified effective date.
      operationId: GetPensionsByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get pensions from employer at a given effective date.
      tags:
        - Pension
  "/Employer/{EmployerId}/ReportLine/{ReportLineId}":
    get:
      description: Returns the specified pay line from employee
      operationId: GetReportLineFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The report line unique identifier. E.g. RTL001
          in: path
          name: ReportLineId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReportLine"
          description: The report line object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the specified report line from the employer
      tags:
        - ReportLine
  "/Employer/{EmployerId}/ReportLines":
    get:
      description: Get links to all report lines for the specified employee
      operationId: GetReportLinesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the report lines from the specified employer
      tags:
        - ReportLine
  "/Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId}":
    delete:
      description: Delete the specified reporting instruction
      operationId: DeleteReportingInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The reporting instruction unique identifier. E.g. SERRPT001
          in: path
          name: ReportingInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a reporting instruction
      tags:
        - ReportLineInstruction
    get:
      description: Returns the specified pay instruction from employee
      operationId: GetReportingInstructionFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The reporting instruction unique identifier. E.g. SERRPT001
          in: path
          name: ReportingInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReportingInstruction"
          description: The reporting instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the specified reporting instruction from the employer
      tags:
        - ReportLineInstruction
    put:
      description: Updates the existing specified reporting instruction object
      operationId: PutReportingInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The reporting instruction unique identifier. E.g. SERRPT001
          in: path
          name: ReportingInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/ReportingInstruction"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReportingInstruction"
          description: The reporting instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Update a reporting Instruction
      tags:
        - ReportLineInstruction
  "/Employer/{EmployerId}/ReportingInstructions":
    get:
      description: Get links to all pay instructions for the specified employee
      operationId: GetReportingInstructionsFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the reporting instructions from the specified employer
      tags:
        - ReportLineInstruction
    post:
      description: Creates a new reporting instruction object
      operationId: PostReportingInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/ReportingInstruction"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Creates a new Reporting Instruction
      tags:
        - ReportLineInstruction
  "/Employer/{EmployerId}/Revision/{RevisionNumber}":
    delete:
      description: Deletes the specified employer revision for the matching revision number
      operationId: DeleteEmployerRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an Employer revision matching the specified revision number.
      tags:
        - Employer
    get:
      description: Get the employer revision matching the specified revision number
      operationId: GetEmployerRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employer"
          description: The employer object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the employer by revision number
      tags:
        - Employer
  "/Employer/{EmployerId}/Revision/{RevisionNumber}/Summary":
    get:
      description: Get the employer revision summary matching the specified revision number
      operationId: GetEmployerRevisionSummaryByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployerSummary"
          description: The employer summary object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the employer summary by revision number
      tags:
        - Employer
  "/Employer/{EmployerId}/Revisions":
    get:
      description: Gets links to all the employer revisions
      operationId: GetEmployerRevisions
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the employer revisions
      tags:
        - Employer
  "/Employer/{EmployerId}/Revisions/Summary":
    get:
      description: Gets links to all employer revision summaries
      operationId: GetEmployerRevisionSummaries
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employer revision summaries
      tags:
        - Employer
  "/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}":
    delete:
      description: Deletes the specified RTI transaction
      operationId: DeleteRtiTransaction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The RTI transaction unique identifier. E.g. FPS001
          in: path
          name: RtiTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete the RTI transaction
      tags:
        - RTI
    get:
      description: Returns the specified RTI transaction
      operationId: GetRtiTransactionFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The RTI transaction unique identifier. E.g. FPS001
          in: path
          name: RtiTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RtiTransactionBase"
          description: The rti transaction base object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the RTI transaction
      tags:
        - RTI
  "/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Summary":
    get:
      description: Returns the specified RTI transaction summary data excluding some poroperties
      operationId: GetRtiTransactionSummaryFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The RTI transaction unique identifier. E.g. FPS001
          in: path
          name: RtiTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RtiTransactionBase"
          description: The rti transaction base object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the RTI transaction summary
      tags:
        - RTI
  "/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the RTI transaction
      operationId: DeleteRtiTransactionTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The RTI transaction unique identifier. E.g. FPS001
          in: path
          name: RtiTransactionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete RTI transaction tag
      tags:
        - Tagging
    get:
      description: Gets the tag from the RTI transaction
      operationId: GetTagFromRtiTransaction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The RTI transaction unique identifier. E.g. FPS001
          in: path
          name: RtiTransactionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get RTI transaction tag
      tags:
        - Tagging
    put:
      description: Inserts a new tag on the RTI transaction
      operationId: PutRtiTransactionTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The RTI transaction unique identifier. E.g. FPS001
          in: path
          name: RtiTransactionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert RTI transaction tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tags":
    get:
      description: Gets all the tags from the RTI transaction
      operationId: GetTagsFromRtiTransaction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The RTI transaction unique identifier. E.g. FPS001
          in: path
          name: RtiTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all tags from RTI transaction
      tags:
        - Tagging
  "/Employer/{EmployerId}/RtiTransactions":
    get:
      description: Get links for all RTI transactions for the specified employer
      operationId: GetRtiTransactionsFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all RTI transactions for the employer
      tags:
        - RTI
  "/Employer/{EmployerId}/RtiTransactions/Summary":
    get:
      description: Get links for all RTI transaction summaries for the specified employer
      operationId: GetRtiTransactionSummariesFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all RTI transaction summaries for the employer
      tags:
        - RTI
  "/Employer/{EmployerId}/RtiTransactions/Tag/{TagId}":
    get:
      description: Gets the RTI transactions with the tag
      operationId: GetRtiTransactionsWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get RTI transactions with tag
      tags:
        - Tagging
        - RTI
  "/Employer/{EmployerId}/RtiTransactions/Tags":
    get:
      description: Gets all the RTI transaction tags
      operationId: GetAllRtiTransactionTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all RTI transaction tags
      tags:
        - Tagging
        - RTI
  "/Employer/{EmployerId}/Secret/{SecretId}":
    delete:
      description: Deletes an employer secret from the given resource location
      operationId: DeleteEmployerSecret
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes employer secret
      tags:
        - Employer
    get:
      description: Get the public visible employer secret object
      operationId: GetEmployerSecret
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployerSecret"
          description: The employer secret object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employer secret
      tags:
        - Employer
    put:
      description: Create / update an employer secret at the given resource location
      operationId: PutEmployerSecret
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployerSecret"
          description: The employer secret object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new employer secret
      tags:
        - Employer
  "/Employer/{EmployerId}/Secrets":
    get:
      description: Get all the employer secret links
      operationId: GetEmployerSecrets
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employer secret links
      tags:
        - Employer
    post:
      description: Create new employer secret using auto generated resource location key
      operationId: PostEmployerSecret
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new employer secret
      tags:
        - Employer
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}":
    delete:
      description: Delete the specified sub contractor
      operationId: DeleteSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an sub contractor
      tags:
        - SubContractor
    get:
      description: Gets the specified sub contractor from employer.
      operationId: GetSubContractorFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SubContractor"
          description: The sub contractor object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get sub contractor from employer
      tags:
        - SubContractor
    patch:
      description: Patches the specified sub contractor with the supplied values
      operationId: PatchSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/SubContractor"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SubContractor"
          description: The sub contractor object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patches the sub contractor
      tags:
        - SubContractor
    put:
      description: Updates the existing specified sub contractor object
      operationId: PutSubContractorIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/SubContractor"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SubContractor"
          description: The sub contractor object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates the sub contractor
      tags:
        - SubContractor
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}":
    delete:
      description: Delete the specified CIS instruction
      operationId: DeleteCisInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS instruction unique identifier. E.g. CIS001
          in: path
          name: CisInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete a CIS instruction
      tags:
        - CIS
    get:
      description: Gets the specified CIS instruction from sub contractor.
      operationId: GetCisInstructionFromSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS instruction unique identifier. E.g. CIS001
          in: path
          name: CisInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CisInstruction"
          description: The cis instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS instruction from sub contractor
      tags:
        - CIS
    patch:
      description: Update an existing CIS instruction object
      operationId: PatchCisInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS instruction unique identifier. E.g. CIS001
          in: path
          name: CisInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CisInstruction"
          description: The cis instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patches the CIS instruction
      tags:
        - CIS
    put:
      description: Insert or update existing CIS instruction object
      operationId: PutCisInstructionIntoSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS instruction unique identifier. E.g. CIS001
          in: path
          name: CisInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/CisInstruction"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CisInstruction"
          description: The cis instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates the CIS instruction
      tags:
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the CIS instruction
      operationId: DeleteCisInstructionTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS instruction unique identifier. E.g. CIS001
          in: path
          name: CisInstructionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete CIS instruction tag
      tags:
        - Tagging
        - CIS
    get:
      description: Gets the tag from the CIS instruction
      operationId: GetTagFromCisInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS instruction unique identifier. E.g. CIS001
          in: path
          name: CisInstructionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS instruction tag
      tags:
        - Tagging
        - CIS
    put:
      description: Inserts a new tag on the CIS instruction
      operationId: PutCisInstructionTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS instruction unique identifier. E.g. CIS001
          in: path
          name: CisInstructionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert CIS instruction tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tags":
    get:
      description: Gets all the tags from the CIS instruction
      operationId: GetTagsFromCisInstruction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS instruction unique identifier. E.g. CIS001
          in: path
          name: CisInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all tags from the CIS instruction
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions":
    get:
      description: Get links to all CIS instructions for the specified sub contractor.
      operationId: GetCisInstructionsFromSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS instructions from sub contractor.
      tags:
        - CIS
    post:
      description: Create a new CIS instruction object
      operationId: PostCisInstructionIntoSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/CisInstruction"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new CIS instruction
      tags:
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions/Tag/{TagId}":
    get:
      description: Gets the CIS instruction with the tag
      operationId: GetCisInstructionsWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS instructions with tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions/Tags":
    get:
      description: Gets all the CIS instruction tags
      operationId: GetAllCisInstructionTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all CIS instruction tags
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}":
    delete:
      description: Delete the specified CIS line
      operationId: DeleteCisLine
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS line unique identifier. E.g. CISLN001
          in: path
          name: CisLineId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete a CIS line
      tags:
        - CIS
    get:
      description: Gets the specified CIS line from sub contractor.
      operationId: GetCisLineFromSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS line unique identifier. E.g. CISLN001
          in: path
          name: CisLineId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CisLine"
          description: The cis line object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS line from sub contractor
      tags:
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the CIS line
      operationId: DeleteCisLineTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS line unique identifier. E.g. CISLN001
          in: path
          name: CisLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete CIS line tag
      tags:
        - Tagging
        - CIS
    get:
      description: Gets the tag from the CIS line
      operationId: GetTagFromCisLine
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS line unique identifier. E.g. CISLN001
          in: path
          name: CisLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS line tag
      tags:
        - Tagging
        - CIS
    put:
      description: Inserts a new tag on the CIS line
      operationId: PutCisLineTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS line unique identifier. E.g. CISLN001
          in: path
          name: CisLineId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert CIS line tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tags":
    get:
      description: Gets all the tags from the CIS line
      operationId: GetTagsFromCisLine
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The CIS line unique identifier. E.g. CISLN001
          in: path
          name: CisLineId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all tags from the CIS line
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines":
    get:
      description: Get links to all CIS lines for the specified sub contractor.
      operationId: GetCisLinesFromSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS lines from sub contractor.
      tags:
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines/Tag/{TagId}":
    get:
      description: Gets the CIS line with the tag
      operationId: GetCisLinesWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get CIS lines with tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines/Tags":
    get:
      description: Gets all the CIS line tags
      operationId: GetAllCisLineTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all CIS line tags
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/JournalLines":
    get:
      description: Get links to all journal lines for the specified sub contractor
      operationId: GetJournalLinesFromSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the journal Lines from the specified sub contractor
      tags:
        - Journals
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/Revision/{RevisionNumber}":
    delete:
      description: Deletes the specified sub contractor revision for the matching revision number
      operationId: DeleteSubContractorRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an SubContractor revision matching the specified revision number.
      tags:
        - SubContractor
    get:
      description: Get the sub contractor revision matching the specified revision number
      operationId: GetSubContractorRevisionByNumber
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The revision number. E.g. 1
          in: path
          name: RevisionNumber
          required: true
          schema:
            format: int32
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SubContractor"
          description: The sub contractor object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the sub contractor by revision number
      tags:
        - SubContractor
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/Revisions":
    get:
      description: Gets links to all the sub contractor revisions
      operationId: GetSubContractorRevisions
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all sub contractor revisions
      tags:
        - SubContractor
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the sub contractor
      operationId: DeleteSubContractorTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete sub contractor tag
      tags:
        - Tagging
        - CIS
    get:
      description: Gets the tag from the sub contractor
      operationId: GetTagFromSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get sub contractor tag
      tags:
        - Tagging
        - CIS
    put:
      description: Inserts a new tag on the sub contractor
      operationId: PutSubContractorTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert sub contractor tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}/{EffectiveDate}":
    get:
      description: Gets the tag from the sub contractor revision
      operationId: GetTagFromSubContractorRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get sub contractor revision tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tags":
    get:
      description: Gets all the tags from the sub contractor
      operationId: GetTagsFromSubContractor
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all tags from the sub contractor
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/Tags/{EffectiveDate}":
    get:
      description: Gets all the tags from the sub contractor revision
      operationId: GetTagsFromSubContractorRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all sub contractor revision tags
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractor/{SubContractorId}/{EffectiveDate}":
    delete:
      description: Deletes the specified sub contractor revision for the matching revision date
      operationId: DeleteSubContractorRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an sub contractor revision matching the specified revision date.
      tags:
        - SubContractor
    get:
      description: Returns the sub contractor's state at the specified effective date.
      operationId: GetSubContractorByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The sub contractors' unique identifier. E.g SUB001
          in: path
          name: SubContractorId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SubContractor"
          description: The sub contractor object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get sub contractor by effective date.
      tags:
        - SubContractor
  "/Employer/{EmployerId}/SubContractors":
    get:
      description: Get links to all sub contractors for the specified employer.
      operationId: GetSubContractorsFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get sub contractors from employer.
      tags:
        - SubContractor
    post:
      description: Create a new sub contractor object
      operationId: PostSubContractorIntoEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/SubContractor"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new sub contractor
      tags:
        - SubContractor
  "/Employer/{EmployerId}/SubContractors/Tag/{TagId}":
    get:
      description: Gets the sub contractor with the tag
      operationId: GetSubContractorsWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get sub contractors with tag
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractors/Tags":
    get:
      description: Gets all the sub contractor tags
      operationId: GetAllSubContractorTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all sub contractor tags
      tags:
        - Tagging
        - CIS
  "/Employer/{EmployerId}/SubContractors/{EffectiveDate}":
    get:
      description: Get links to all sub contractors for the employer on specified effective date.
      operationId: GetSubContractorsByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get sub contractors from employer at a given effective date.
      tags:
        - SubContractor
  "/Employer/{EmployerId}/Summary":
    get:
      description: Gets the specified employer summary data.
      operationId: GetEmployerSummary
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployerSummary"
          description: The employer summary object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employer summary
      tags:
        - Employer
  "/Employer/{EmployerId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the employer
      operationId: DeleteEmployerTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete employer tag
      tags:
        - Tagging
    get:
      description: Gets the tag from the employer
      operationId: GetTagFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employer tag
      tags:
        - Tagging
    put:
      description: Inserts a new tag on the employer
      operationId: PutEmployerTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert employer tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/Tag/{TagId}/{EffectiveDate}":
    get:
      description: Gets the tag from the employer revision
      operationId: GetTagFromEmployerRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employer revision tag
      tags:
        - Tagging
  "/Employer/{EmployerId}/Tags":
    get:
      description: Gets all the tags from the employer
      operationId: GetTagsFromEmployer
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employer tags
      tags:
        - Tagging
  "/Employer/{EmployerId}/Tags/{EffectiveDate}":
    get:
      description: Gets all the tags from the employer revision
      operationId: GetTagsFromEmployerRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employer revision tags
      tags:
        - Tagging
  "/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}":
    delete:
      description: Deletes a third party transaction record from the given resource location
      operationId: DeleteThirdPartyTransaction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The third party transaction unique identifier. E.g TP001
          in: path
          name: ThirdPartyTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete third party transaction
      tags:
        - ThirdPartyTransmission
    get:
      description: Get a third party transaction
      operationId: GetThirdPartyTransaction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The third party transaction unique identifier. E.g TP001
          in: path
          name: ThirdPartyTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThirdPartyTransaction"
          description: The third party transaction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get a third party transaction
      tags:
        - ThirdPartyTransmission
  "/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the third party transaction
      operationId: DeleteThirdPartyTransactionTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The third party transaction unique identifier. E.g TP001
          in: path
          name: ThirdPartyTransactionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete third party transaction tag
      tags:
        - Tagging
        - ThirdPartyTransaction
    get:
      description: Gets a tag from the third party transaction
      operationId: GetTagFromThirdPartyTransaction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The third party transaction unique identifier. E.g TP001
          in: path
          name: ThirdPartyTransactionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get third party transaction tag
      tags:
        - Tagging
        - ThirdPartyTransaction
    put:
      description: Inserts a tag on the third party transaction
      operationId: PutThirdPartyTransactionTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The third party transaction unique identifier. E.g TP001
          in: path
          name: ThirdPartyTransactionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: insert third party transaction tag
      tags:
        - Tagging
        - ThirdPartyTransaction
  "/Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tags":
    get:
      description: Gets all tags from the third party transaction
      operationId: GetTagsFromThirdPartyTransaction
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The third party transaction unique identifier. E.g TP001
          in: path
          name: ThirdPartyTransactionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get tags from third party transaction
      tags:
        - Tagging
        - ThirdPartyTransaction
  "/Employer/{EmployerId}/ThirdPartyTransactions":
    get:
      description: Get all third party transaction links
      operationId: GetThirdPartyTransactions
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all third party transaction links
      tags:
        - ThirdPartyTransmission
  "/Employer/{EmployerId}/ThirdPartyTransactions/Tag/{TagId}":
    get:
      description: Gets the third party transactions with the specified tag
      operationId: GetAllThirdPartyTransactionsWithTag
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get links to tagged third party transactions
      tags:
        - Tagging
        - ThirdPartyTransaction
  "/Employer/{EmployerId}/ThirdPartyTransactions/Tags":
    get:
      description: Gets all the third party transaction tags
      operationId: GetAllThirdPartyTransactionTags
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all third party transaction tags
      tags:
        - Tagging
        - ThirdPartyTransaction
  "/Employer/{EmployerId}/{EffectiveDate}":
    delete:
      description: Deletes the specified employer revision for the matching revision date
      operationId: DeleteEmployerRevision
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete an Employer revision matching the specified revision date.
      tags:
        - Employer
    get:
      description: Returns the employer's state at the specified effective date.
      operationId: GetEmployerByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Employer"
          description: The employer object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the employer at the specified effective
      tags:
        - Employer
  "/Employer/{EmployerId}/{EffectiveDate}/Summary":
    get:
      description: Gets the employer summary for the specified effective date.
      operationId: GetEmployerSummaryByEffectiveDate
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EmployerSummary"
          description: The employer summary object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employer summary by effective date.
      tags:
        - Employer
  /Employers:
    get:
      description: Gets links to all employers contained under the authorised application scope
      operationId: GetEmployers
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets all employers
      tags:
        - Employer
    post:
      description: Create a new employer object
      operationId: PostEmployer
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/Employer"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new Employer
      tags:
        - Employer
  /Employers/Summary:
    get:
      description: Get links to all employer summaries.
      operationId: GetEmployerSummaries
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employer summaries.
      tags:
        - Employer
  "/Employers/Tag/{TagId}":
    get:
      description: Gets the employers with the tag
      operationId: GetEmployersWithTag
      parameters:
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employers with tag
      tags:
        - Tagging
        - Employer
  /Employers/Tags:
    get:
      description: Gets all the employer tags
      operationId: GetAllEmployerTags
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all employer tags
      tags:
        - Tagging
        - Employer
  "/Employers/{EffectiveDate}":
    get:
      description: Gets links to all employers contained under the authorised application scope for the specified effective date.
      operationId: GetEmployersByEffectiveDate
      parameters:
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets all employers at the specified effective date
      tags:
        - Employer
  "/Employers/{EffectiveDate}/Summary":
    get:
      description: Get links to all employer summaries on specified effective date.
      operationId: GetEmployerSummariesByEffectiveDate
      parameters:
        - description: The effective date to be applied. E.g 2016-04-06
          in: path
          name: EffectiveDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get employer summaries at a given effective date.
      tags:
        - Employer
  /Healthcheck:
    get:
      description: Returns the health status of the application
      operationId: GetHealthCheck
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HealthCheck"
          description: The health check object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get health check status
      tags:
        - Healthcheck
  /Jobs/Batch:
    get:
      description: Gets all the Batch jobs
      operationId: GetBatchJobs
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all Batch jobs
      tags:
        - Jobs
    post:
      description: Adds a new Batch job to the queue and returns the job info
      operationId: PostNewBatchJob
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BatchJobInstruction"
        description: The the batch job instruction object.
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create new Batch job
      tags:
        - Jobs
  "/Jobs/Batch/{JobId}":
    delete:
      description: Deletes the the Batch job
      operationId: DeleteBatchJob
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete the Batch job
      tags:
        - Jobs
  "/Jobs/Batch/{JobId}/Info":
    get:
      description: Return the the Batch job information
      operationId: GetBatchJobInfo
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobInfo"
          description: The job info object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the Batch job information
      tags:
        - Jobs
  "/Jobs/Batch/{JobId}/Progress":
    get:
      description: Return the the Batch job progress
      operationId: GetBatchJobProgress
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current progress of the job expressed as a percentage
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the Batch job progress
      tags:
        - Jobs
  "/Jobs/Batch/{JobId}/Status":
    get:
      description: Return the the Batch job status
      operationId: GetBatchJobStatus
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current status of the job
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the Batch job status
      tags:
        - Jobs
  /Jobs/Cis:
    get:
      description: Gets all the CIS jobs
      operationId: GetCisJobs
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all CIS jobs
      tags:
        - Jobs
    post:
      description: Adds a new CIS job to the queue and returns the job info
      operationId: PostNewCisJob
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CisJobInstructionBase"
        description: The the CIS job instruction object.
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create new CIS job
      tags:
        - Jobs
  "/Jobs/Cis/{JobId}":
    delete:
      description: Deletes the the CIS job
      operationId: DeleteCisJob
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete the CIS job
      tags:
        - Jobs
  "/Jobs/Cis/{JobId}/Info":
    get:
      description: Return the the CIS job information
      operationId: GetCisJobInfo
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobInfo"
          description: The job info object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the CIS job information
      tags:
        - Jobs
  "/Jobs/Cis/{JobId}/Progress":
    get:
      description: Return the the CIS job progress
      operationId: GetCisJobProgress
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current progress of the job expressed as a percentage
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the CIS job progress
      tags:
        - Jobs
  "/Jobs/Cis/{JobId}/Status":
    get:
      description: Return the the CIS job status
      operationId: GetCisJobStatus
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current status of the job
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the CIS job status
      tags:
        - Jobs
  /Jobs/Dps:
    get:
      description: Gets all the DPS jobs
      operationId: GetDpsJobs
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all DPS jobs
      tags:
        - Jobs
    post:
      description: Creates the new DPS job to the queue and returns the job info
      operationId: PostNewDpsJob
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DpsJobInstruction"
        description: The the DPS job instruction object.
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create new DPS job
      tags:
        - Jobs
  "/Jobs/Dps/{JobId}":
    delete:
      description: Deletes the the DPS job
      operationId: DeleteDpsJob
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete the DPS job
      tags:
        - Jobs
  "/Jobs/Dps/{JobId}/Info":
    get:
      description: Return the the DPS job information
      operationId: GetDpsJobInfo
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobInfo"
          description: The job info object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the DPS job information
      tags:
        - Jobs
  "/Jobs/Dps/{JobId}/Progress":
    get:
      description: Return the the DPS job progress
      operationId: GetDpsJobProgress
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current progress of the job expressed as a percentage
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the DPS job progress
      tags:
        - Jobs
  "/Jobs/Dps/{JobId}/Status":
    get:
      description: Return the the DPS job status
      operationId: GetDpsJobStatus
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current status of the job
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the DPS job status
      tags:
        - Jobs
  "/Jobs/Employer/{EmployerId}":
    get:
      description: Returns all job information objects for the specified employer.
      operationId: GetEmployerJobs
      parameters:
        - description: The employers' unique identifier. E.g ER001
          in: path
          name: EmployerId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The serialised array of JobInfo objects
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets all jobs relating to the employer.
      tags:
        - Jobs
  /Jobs/PayRuns:
    get:
      description: Gets all the pay run jobs
      operationId: GetPayRunJobs
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all PayRun jobs
      tags:
        - Jobs
    post:
      description: Creates the new pay run job to the queue and returns the job info
      operationId: PostNewPayRunJob
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PayRunJobInstruction"
        description: The pay run job instruction object.
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create new PayRun job
      tags:
        - Jobs
  "/Jobs/PayRuns/{JobId}":
    delete:
      description: Deletes the the payrun job
      operationId: DeletePayRunJob
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete the pay run job
      tags:
        - Jobs
  "/Jobs/PayRuns/{JobId}/Info":
    get:
      description: Return the the payrun job information
      operationId: GetPayRunJobInfo
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobInfo"
          description: The job info object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the pay run job information
      tags:
        - Jobs
  "/Jobs/PayRuns/{JobId}/Progress":
    get:
      description: Return the the payrun job progress
      operationId: GetPayRunJobProgress
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current progress of the job expressed as a percentage
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the pay run job progress
      tags:
        - Jobs
  "/Jobs/PayRuns/{JobId}/Status":
    get:
      description: Return the the payrun job status
      operationId: GetPayRunJobStatus
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current status of the job
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the pay run job status
      tags:
        - Jobs
  /Jobs/Rti:
    get:
      description: Gets all the RTI jobs
      operationId: GetRtiJobs
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all RTI jobs
      tags:
        - Jobs
    post:
      description: Creates the new RTI job to the queue and returns the job info
      operationId: PostNewRtiJob
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RtiJobInstruction"
        description: The the RTI job instruction object.
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create new RTI job
      tags:
        - Jobs
  "/Jobs/Rti/{JobId}":
    delete:
      description: Deletes the the RTI job
      operationId: DeleteRtiJob
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete the RTI job
      tags:
        - Jobs
  "/Jobs/Rti/{JobId}/Info":
    get:
      description: Return the the RTI job information
      operationId: GetRtiJobInfo
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobInfo"
          description: The job info object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the RTI job information
      tags:
        - Jobs
  "/Jobs/Rti/{JobId}/Progress":
    get:
      description: Return the the RTI job progress
      operationId: GetRtiJobProgress
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current progress of the job expressed as a percentage
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the RTI job progress
      tags:
        - Jobs
  "/Jobs/Rti/{JobId}/Status":
    get:
      description: Return the the RTI job status
      operationId: GetRtiJobStatus
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current status of the job
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the RTI job status
      tags:
        - Jobs
  /Jobs/ThirdParty:
    get:
      description: Gets all the Third Party jobs
      operationId: GetThirdPartyJobs
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all Third Party jobs
      tags:
        - Jobs
    post:
      description: Adds a new Third Party job to the queue and returns the job info
      operationId: PostNewThirdPartyJob
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ThirdPartyJobInstruction"
        description: The the third party job instruction object.
        required: true
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create new Third Party job
      tags:
        - Jobs
  "/Jobs/ThirdParty/{JobId}":
    delete:
      description: Deletes the the Third Party job
      operationId: DeleteThirdPartyJob
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete the Third Party job
      tags:
        - Jobs
  "/Jobs/ThirdParty/{JobId}/Info":
    get:
      description: Return the the Third Party job information
      operationId: GetThirdPartyJobInfo
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JobInfo"
          description: The job info object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the Third Party job information
      tags:
        - Jobs
  "/Jobs/ThirdParty/{JobId}/Progress":
    get:
      description: Return the the Third Party job progress
      operationId: GetThirdPartyJobProgress
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current progress of the job expressed as a percentage
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the Third Party job progress
      tags:
        - Jobs
  "/Jobs/ThirdParty/{JobId}/Status":
    get:
      description: Return the the Third Party job status
      operationId: GetThirdPartyJobStatus
      parameters:
        - description: The job unique identifier.
          in: path
          name: JobId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: The current status of the job
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the Third Party job status
      tags:
        - Jobs
  "/JournalInstruction/{JournalInstructionId}":
    delete:
      description: Delete the specified Journal instruction template object
      operationId: DeleteJournalInstructionTemplate
      parameters:
        - description: The journal instruction unique identifier. E.g JI001
          in: path
          name: JournalInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a Journal instruction template
      tags:
        - Journals
    get:
      description: Retrurns the specified journal instruction from the application
      operationId: GetJournalInstructionTemplate
      parameters:
        - description: The journal instruction unique identifier. E.g JI001
          in: path
          name: JournalInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JournalInstruction"
          description: The journal instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the Journal instructions template for the application
      tags:
        - Journals
    put:
      description: Updates the existing specified Journal instruction template object
      operationId: PutJournalInstructionTemplate
      parameters:
        - description: The journal instruction unique identifier. E.g JI001
          in: path
          name: JournalInstructionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JournalInstruction"
          description: The journal instruction object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Update a Journal Instruction template
      tags:
        - Journals
  /JournalInstructions:
    get:
      description: Get links to all journal instruction templates for the application
      operationId: GetJournalInstructionTemplates
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the Journal instructions templates for the application
      tags:
        - Journals
    post:
      description: Creates a new Journal instruction teamplte object
      operationId: PostJournalInstructionTemplate
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Creates a new Journal Instruction template
      tags:
        - Journals
  "/Permission/{PermissionId}":
    delete:
      description: Deletes the permission object from the application
      operationId: DeletePermission
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes the permission object
      tags:
        - Permission
    get:
      description: Gets the permission object for application
      operationId: GetPermission
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Permission"
          description: The permission object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the permission object
      tags:
        - Permission
    patch:
      description: Patch the permission object at the specified resource location
      operationId: PatchPermission
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Permission"
          description: The permission object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patch permission object
      tags:
        - Permission
    put:
      description: Puts the permission object into the specified resource location
      operationId: PutPermission
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Permission"
          description: The permission object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Puts permisson object
      tags:
        - Permission
  "/Permission/{PermissionId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the Permission
      operationId: DeletePermissionTag
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete Permission tag
      tags:
        - Tagging
        - Permission
    get:
      description: Gets a tag from the Permission
      operationId: GetTagFromPermission
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get Permission tag
      tags:
        - Tagging
        - Permission
    put:
      description: Inserts a tag on the Permission
      operationId: PutPermissionTag
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert Permission tag
      tags:
        - Tagging
        - Permission
  "/Permission/{PermissionId}/Tags":
    get:
      description: Gets all tags from the Permission
      operationId: GetTagsFromPermission
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get tags from Permission
      tags:
        - Tagging
        - Permission
  "/Permission/{PermissionId}/Users":
    get:
      description: Gets the users with the specified permission
      operationId: GetUsersFromPermission
      parameters:
        - description: The permission unique identifier. E.g PERM001
          in: path
          name: PermissionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the users with the specified permission
      tags:
        - Permission
  /Permissions:
    get:
      description: Gets all permission objects for application
      operationId: GetPermissions
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets all permission objects
      tags:
        - Permission
    post:
      description: Post the new permission object into the application
      operationId: PostPermission
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Post permisson object
      tags:
        - Permission
  "/Permissions/Tag/{TagId}":
    get:
      description: Gets the Permissions with the specified tag
      operationId: GetAllPermissionsWithTag
      parameters:
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get links to tagged Permissions
      tags:
        - Tagging
        - Permission
  /Permissions/Tags:
    get:
      description: Get all tags from all Permissions
      operationId: GetAllPermissionTags
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all Permission tags
      tags:
        - Tagging
        - Permission
  /Query:
    post:
      description: Get the results for the specified query
      operationId: GetQueryResponse
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Query"
        description: The query object to be executed against the application data.
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the query execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the query result
      tags:
        - Query
  /ReferenceData/JournalExpressionDataTable:
    get:
      description: Gets the data schema for all available journal expression values. Includes table names, column names and data types.
      operationId: GetJournalExpressionSchema
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JournalExpressionDataTable"
          description: The journal expression data table object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the journal expression data schema
      tags:
        - Reference
  /Report/ACTPAYINS/run:
    get:
      description: Returns the result of the executed active pay instructions report for the given query parameters
      operationId: GetActivePayInstructionsReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The employee unique key. E.g. EE001
          in: query
          name: EmployeeKey
          required: true
          schema:
            type: string
        - description: The active date to consider. E.g 2017-04-05
          in: query
          name: ActiveOn
          required: false
          schema:
            format: date
            type: string
        - description: The lower filter date. E.g 2016-04-06
          in: query
          name: FromDate
          required: true
          schema:
            format: date
            type: string
        - description: The upper filter date. E.g 2017-04-05
          in: query
          name: ToDate
          required: false
          schema:
            format: date
            type: string
        - description: the data type to filter on. E.g. TaxPayInstruction
          in: query
          name: Type
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the active pay instructions report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the active pay instructions report
      tags:
        - Reports
  /Report/AOELIABILITY/run:
    get:
      description: Returns the result of the executed AOE liability report for the given query parameters
      operationId: GetAoeLiabilityReportOuput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The tax period number.
          in: query
          name: TaxPeriod
          required: false
          schema:
            format: integer
            type: string
        - description: The transform definition unique key. E.g. P45-Pdf
          in: query
          name: TransformDefinitionKey
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the AOE liability report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the AOE liability report
      tags:
        - Reports
  /Report/DPSMSG/run:
    get:
      description: Returns the result of the executed DPS message report for the given query parameters
      operationId: GetDpsMessageReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The lower filter date. E.g 2016-04-06
          in: query
          name: FromDate
          required: true
          schema:
            format: date
            type: string
        - description: The upper filter date. E.g 2017-04-05
          in: query
          name: ToDate
          required: false
          schema:
            format: date
            type: string
        - description: The DPS message types as a CSV list. E.g. P6,P9,SL1,SL2
          in: query
          name: MessageTypes
          required: false
          schema:
            type: string
        - description: The DPS message status as a CSV list. E.g. Retrieved,Processed,Blocked,Ignored
          in: query
          name: MessageStatuses
          required: false
          schema:
            type: string
        - description: The element index to begin the report. Used to control paging within large data sets. E.g. 1
          in: query
          name: StartIndex
          required: false
          schema:
            type: string
        - description: The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
          in: query
          name: MaxIndex
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the DPS message report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the DPS message report
      tags:
        - Reports
  /Report/EMPSUM/run:
    get:
      description: Returns the result of the employer summary report for the given query parameters
      operationId: GetEmployerSummaryReportOuput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The date context for the report. E.g. 2018-04-30
          in: query
          name: ContextDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the employer summary report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the employer summary report
      tags:
        - Reports
  /Report/GRO2NET/run:
    get:
      description: Returns the result of the executed gross to net report for the given query parameters
      operationId: GetGrossToNetReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The tax period number.
          in: query
          name: TaxPeriod
          required: false
          schema:
            format: integer
            type: string
        - description: The element index to begin the report. Used to control paging within large data sets. E.g. 1
          in: query
          name: StartIndex
          required: false
          schema:
            type: string
        - description: The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
          in: query
          name: MaxIndex
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the gross to net report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the gross to net report
      tags:
        - Reports
  /Report/HOLBAL/run:
    get:
      description: Returns the result of the executed holiday balance report for the given query parameters
      operationId: GetHolidayBalanceReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The holiday year end for the report. E.g. 2018-12-31
          in: query
          name: HolidayYearEnd
          required: true
          schema:
            format: date
            type: string
        - description: A comma separated list of the employee codes. E.g. EMP001,EMP002
          in: query
          name: EmployeeCodes
          required: false
          schema:
            type: string
        - description: The element index to begin the report. Used to control paging within large data sets. E.g. 1
          in: query
          name: StartIndex
          required: false
          schema:
            type: string
        - description: The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
          in: query
          name: MaxIndex
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the holiday balance report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the holiday balance report
      tags:
        - Reports
  /Report/JOURNAL/run:
    get:
      description: Returns the result of the journal report for the given query parameters
      operationId: GetJournalReportOuput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay frequency option. E.g. Monthly
          in: query
          name: PayFrequency
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The tax period number.
          in: query
          name: TaxPeriod
          required: false
          schema:
            format: integer
            type: string
        - description: Specific to JOURNAL report, a filter used to select the journal lines for the specified ledger target. E.g. [Default]
          in: query
          name: LedgerTarget
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the journal report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the journal report
      tags:
        - Reports
  /Report/LASTPAYDATE/run:
    get:
      description: Returns the result of the executed last pay date report for the given query parameters
      operationId: GetLastPayDateReportOuput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The employee unique key. E.g. EE001
          in: query
          name: EmployeeKey
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the last pay date report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the last pay date report
      tags:
        - Reports
  /Report/NETPAY/run:
    get:
      description: Returns the result of the executed net pay report for the given query parameters
      operationId: GetNetPayReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The tax period number.
          in: query
          name: TaxPeriod
          required: false
          schema:
            format: integer
            type: string
        - description: The element index to begin the report. Used to control paging within large data sets. E.g. 1
          in: query
          name: StartIndex
          required: false
          schema:
            type: string
        - description: The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
          in: query
          name: MaxIndex
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the net pay report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the net pay report
      tags:
        - Reports
  /Report/NEXTPERIOD/run:
    get:
      description: Returns the result of the executed next pay period report for the given query parameters
      operationId: GetNextPayPeriodDatesReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the next pay period report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the next pay period report
      tags:
        - Reports
  /Report/P11SUM/run:
    get:
      description: Returns the result of the executed P11 summary report for the given query parameters
      operationId: GetP11SummaryReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The element index to begin the report. Used to control paging within large data sets. E.g. 1
          in: query
          name: StartIndex
          required: false
          schema:
            type: string
        - description: The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
          in: query
          name: MaxIndex
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the P11 report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the P11 summary report
      tags:
        - Reports
  /Report/P32/run:
    get:
      description: Returns the result of the executed P32 report for the given query parameters
      operationId: GetP32NetReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the P32 report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the P32 report
      tags:
        - Reports
  /Report/P32SUM/run:
    get:
      description: Returns the result of the executed P32 summary report for the given query parameters
      operationId: GetP32SummaryNetReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the P32 summary report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the P32 summary report
      tags:
        - Reports
  /Report/P45/run:
    get:
      description: Returns the result of the executed P45 report for the given query parameters
      operationId: GetP45ReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The employee unique key. E.g. EE001
          in: query
          name: EmployeeKey
          required: true
          schema:
            type: string
        - description: The transform definition unique key. E.g. P45-Pdf
          in: query
          name: TransformDefinitionKey
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the P45 report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the P45 report
      tags:
        - Reports
  /Report/P60/run:
    get:
      description: Returns the result of the executed P60 report for the given query parameters
      operationId: GetP60ReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: A comma separated list of the employee codes. E.g. EMP001,EMP002
          in: query
          name: EmployeeCodes
          required: false
          schema:
            type: string
        - description: The transform definition unique key. E.g. P45-Pdf
          in: query
          name: TransformDefinitionKey
          required: false
          schema:
            type: string
        - description: The element index to begin the report. Used to control paging within large data sets. E.g. 1
          in: query
          name: StartIndex
          required: false
          schema:
            type: string
        - description: The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
          in: query
          name: MaxIndex
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the P60 report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the P60 report
      tags:
        - Reports
  /Report/PAPDIS/run:
    get:
      description: Returns the result of the executed PAPDIS report. PAPDIS is a free and open data interface standard designed to allow payroll and middleware software developers to create a file that can be used by pension providers to exchange data. http://www.papdis.org/
      operationId: GetPapdisReportOuput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The payment date context for the report. E.g. 2018-04-30
          in: query
          name: PaymentDate
          required: false
          schema:
            format: date
            type: string
        - description: The pension scheme unique key. E.g. PENSCH001
          in: query
          name: PensionKey
          required: true
          schema:
            type: string
        - description: Specific to PAPDIS report, specifies the business function that the sender is requesting. If left BLANK it will be assumed to be 0 (Enrol / Receive Contributions).
          in: query
          name: MessageFunctionCode
          required: true
          schema:
            type: string
        - description: The transform definition unique key. E.g. P45-Pdf
          in: query
          name: TransformDefinitionKey
          required: false
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the PAPDIS report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the PAPDIS report
      tags:
        - Reports
  /Report/PASS/run:
    get:
      description: Returns the result of the executed PASS report. PASS stands for Payroll and Systemsync. PASS 1.1 is an extension of the PAPDIS V1.1 schema. https://pensionsynckb.systemsyncsolutions.com/display/PKB/PASS+1.1
      operationId: GetPassReportOuput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The payment date context for the report. E.g. 2018-04-30
          in: query
          name: PaymentDate
          required: false
          schema:
            format: date
            type: string
        - description: The pension scheme unique key. E.g. PENSCH001
          in: query
          name: PensionKey
          required: true
          schema:
            type: string
        - description: Specific to PAPDIS report, specifies the business function that the sender is requesting. If left BLANK it will be assumed to be 0 (Enrol / Receive Contributions).
          in: query
          name: MessageFunctionCode
          required: true
          schema:
            type: string
        - description: Specific to PensionSync PASS report, a unique identifier for the Intermediary who is acting on behalf of the employer.
          in: query
          name: IntermediaryId
          required: true
          schema:
            type: string
        - description: Specific to PensionSync PASS report, a document identifier unique for this document within the Intermediary.
          in: query
          name: DocumentId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the PASS report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the PASS report
      tags:
        - Reports
  /Report/PAYDASHBOARD/run:
    get:
      description: Returns the result of the executed Pay Dashboard payslip report for the given query parameters. See https://api.paydashboard.com for details. For compatability should be returned as JSON with TransformDefinitionKey=Json-Clean.
      operationId: GetPayDashboardPayslipReportOuput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: A comma separated list of the employee codes. E.g. EMP001,EMP002
          in: query
          name: EmployeeCodes
          required: false
          schema:
            type: string
        - description: The transform definition unique key. E.g. P45-Pdf
          in: query
          name: TransformDefinitionKey
          required: false
          schema:
            type: string
        - description: The element index to begin the report. Used to control paging within large data sets. E.g. 1
          in: query
          name: StartIndex
          required: false
          schema:
            type: string
        - description: The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
          in: query
          name: MaxIndex
          required: false
          schema:
            type: string
        - description: The payment date context for the report. E.g. 2018-04-30
          in: query
          name: PaymentDate
          required: false
          schema:
            format: date
            type: string
        - description: Specific to the Pay Dashboard report, allows the specification of a future payslip publication date. E.g. 2018-12-31
          in: query
          name: PublicationDate
          required: true
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the Pay Dashboard payslip report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the Pay Dashboard payslips report
      tags:
        - Reports
  /Report/PAYSLIP3/run:
    get:
      description: Returns the result of the executed verbose payslip report for the given query parameters
      operationId: GetPayslip3ReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The pay schedule unique key. E.g. SCH001
          in: query
          name: PayScheduleKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: A comma separated list of the employee codes. E.g. EMP001,EMP002
          in: query
          name: EmployeeCodes
          required: false
          schema:
            type: string
        - description: The transform definition unique key. E.g. P45-Pdf
          in: query
          name: TransformDefinitionKey
          required: false
          schema:
            type: string
        - description: The element index to begin the report. Used to control paging within large data sets. E.g. 1
          in: query
          name: StartIndex
          required: false
          schema:
            type: string
        - description: The highest element index to return from the report. Used to control paging within large data sets. E.g. 100
          in: query
          name: MaxIndex
          required: false
          schema:
            type: string
        - description: The payment date context for the report. E.g. 2018-04-30
          in: query
          name: PaymentDate
          required: false
          schema:
            format: date
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the verbose payslip report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the verbose payslip report
      tags:
        - Reports
  /Report/PENLIABILITY/run:
    get:
      description: Returns the result of the executed pension liability report for the given query parameters
      operationId: GetPensionLiabilityReportOutput
      parameters:
        - description: The employer unique key. E.g. ER001
          in: query
          name: EmployerKey
          required: true
          schema:
            type: string
        - description: The tax year. E.g. 2017 = 2017/18 year.
          in: query
          name: TaxYear
          required: true
          schema:
            format: integer
            type: string
        - description: The pension scheme unique key. E.g. PENSCH001
          in: query
          name: PensionKey
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the pension liability report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the pension liability report
      tags:
        - Reports
  "/Report/{ReportDefinitionId}":
    delete:
      description: Delete the specified report definition
      operationId: DeleteReportDefinition
      parameters:
        - description: The report definition unique identifier.
          in: path
          name: ReportDefinitionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a report definition
      tags:
        - Reports
    get:
      description: Returns the specified report definition from the authroised application
      operationId: GetReportDefinitionFromApplication
      parameters:
        - description: The report definition unique identifier.
          in: path
          name: ReportDefinitionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReportDefinition"
          description: The report definition object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the report definition
      tags:
        - Reports
    put:
      description: Updates the existing specified report definition object
      operationId: PutReportDefinition
      parameters:
        - description: The report definition unique identifier.
          in: path
          name: ReportDefinitionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/ReportDefinition"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ReportDefinition"
          description: The report definition object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates a report definition
      tags:
        - Reports
  "/Report/{ReportDefinitionId}/run":
    get:
      description: Returns the result of the executed report definition
      operationId: GetReportOutput
      parameters:
        - description: The report definition unique identifier.
          in: path
          name: ReportDefinitionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The result of the report execution
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Runs the specified report definition
      tags:
        - Reports
  /Reports:
    get:
      description: Get links to all saved report definitions under authorised application
      operationId: GetReportDefinitionsFromApplication
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets all reports
      tags:
        - Reports
    post:
      description: Creates a new report defintion object
      operationId: PostReportDefinition
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/ReportDefinition"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new report definition
      tags:
        - Reports
  /Schemas:
    get:
      description: Returns a collection of links to all the available data object schemas
      operationId: GetSchemas
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get a list of all available schemas
      tags:
        - Schemas
  "/Schemas/{DtoDataType}":
    get:
      description: Returns the XSD schema for the specified data type
      operationId: GetSchema
      parameters:
        - description: The data transfer object type name. E.g PensionPayInstruction
          in: path
          name: DtoDataType
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The data type XSD schema
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get XSD schema
      tags:
        - Schemas
  "/Secret/{SecretId}":
    delete:
      description: Deletes an Application secret from the given resource location
      operationId: DeleteApplicationSecret
      parameters:
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes Application secret
      tags:
        - Application
    get:
      description: Get the public visible Application secret object
      operationId: GetApplicationSecret
      parameters:
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicationSecret"
          description: The application secret object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get Application secret
      tags:
        - Application
    put:
      description: Create / update an Application secret at the given resource location
      operationId: PutApplicationSecret
      parameters:
        - description: The secret unique identifier. E.g ERSEC001
          in: path
          name: SecretId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicationSecret"
          description: The application secret object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new Application secret
      tags:
        - Application
  /Secrets:
    get:
      description: Get all the Application secret links
      operationId: GetApplicationSecrets
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all Application secret links
      tags:
        - Application
    post:
      description: Create new Application secret using auto generated resource location key
      operationId: PostApplicationSecret
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new Application secret
      tags:
        - Application
  "/Template/{DtoDataType}":
    get:
      description: Returns a template instance of the specified data type
      operationId: GetTemplateModel
      parameters:
        - description: The data transfer object type name. E.g PensionPayInstruction
          in: path
          name: DtoDataType
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                format: binary
                type: string
          description: The data type template
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the object template
      tags:
        - Templates
  /Templates:
    get:
      description: Returns a collection of links to all the available data object templates
      operationId: GetTemplates
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get a list of all available data object tempaltes
      tags:
        - Templates
  "/Transform/{TransformDefinitionId}":
    delete:
      description: Delete the specified transform definition
      operationId: DeleteTransformDefinition
      parameters:
        - description: The transform definition unique identifier.
          in: path
          name: TransformDefinitionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes a transform definition
      tags:
        - Reports
    get:
      description: Returns the specified transform definition from the authroised application
      operationId: GetTransformDefinitionFromApplication
      parameters:
        - description: The transform definition unique identifier.
          in: path
          name: TransformDefinitionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransformDefinition"
          description: The transform definition object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get the transform definition
      tags:
        - Reports
    put:
      description: Updates the existing specified transform definition object
      operationId: PutTransformDefinition
      parameters:
        - description: The transform definition unique identifier.
          in: path
          name: TransformDefinitionId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/TransformDefinition"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransformDefinition"
          description: The transform definition object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Updates a transform definition
      tags:
        - Reports
  /Transforms:
    get:
      description: Get links to all saved transform definitions under authorised application
      operationId: GetTransformDefinitionsFromApplication
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets all transform definitions
      tags:
        - Reports
    post:
      description: Creates a new transform defintion object
      operationId: PostTransformDefinition
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      requestBody:
        $ref: "#/components/requestBodies/TransformDefinition"
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Create a new transform definition
      tags:
        - Reports
  "/User/{UserId}":
    delete:
      description: Deletes the user object from the application
      operationId: DeleteUser
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Deletes the user object
      tags:
        - User
    get:
      description: Gets the user object for application
      operationId: GetUser
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/User"
          description: The user object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the user object
      tags:
        - User
    patch:
      description: Patch the user object at the specified resource location
      operationId: PatchUser
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/User"
          description: The user object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Patch user object
      tags:
        - User
    put:
      description: Puts the user object into the specified resource location
      operationId: PutUser
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/User"
          description: The user object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Puts user object
      tags:
        - User
  "/User/{UserId}/Permissions":
    get:
      description: Gets the user permission instances
      operationId: GetUserPermissions
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets the user permissions
      tags:
        - Permission
        - User
  "/User/{UserId}/Tag/{TagId}":
    delete:
      description: Deletes a tag from the user
      operationId: DeleteUserTag
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Delete user tag
      tags:
        - Tagging
        - User
    get:
      description: Gets a tag from the user
      operationId: GetTagFromUser
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get user tag
      tags:
        - Tagging
        - User
    put:
      description: Inserts a tag on the user
      operationId: PutUserTag
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Tag"
          description: The tag object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Insert user tag
      tags:
        - Tagging
        - User
  "/User/{UserId}/Tags":
    get:
      description: Gets all tags from the user
      operationId: GetTagsFromUser
      parameters:
        - description: The user unique identifier. E.g USER001
          in: path
          name: UserId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get tags from user
      tags:
        - Tagging
        - User
  /Users:
    get:
      description: Gets all user objects for application
      operationId: GetUsers
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Gets all user objects
      tags:
        - User
    post:
      description: Post the new user object into the application
      operationId: PostUser
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Link"
          description: The link object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Post user object
      tags:
        - User
  "/Users/Tag/{TagId}":
    get:
      description: Gets the users with the specified tag
      operationId: GetAllUsersWithTag
      parameters:
        - description: The tag unique identifier. E.g. MyTag
          in: path
          name: TagId
          required: true
          schema:
            type: string
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get links to tagged users
      tags:
        - Tagging
        - User
  /Users/Tags:
    get:
      description: Get all tags from all users
      operationId: GetAllUserTags
      parameters:
        - description: The OAuth 1 authorization header. &apos;Auto&apos; enables auto complete.
          in: header
          name: Authorization
          required: true
          schema:
            default: Auto
            format: string
            type: string
        - description: The version of the api to target. Omit or set as &apos;default&apos; to target the current api version.
          in: header
          name: Api-Version
          required: true
          schema:
            default: default
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LinkCollection"
          description: The link collection object.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Unauthorized
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorModel"
          description: Internal Server Error
      summary: Get all user tags
      tags:
        - Tagging
        - User
components:
  requestBodies:
    AEAssessment:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AEAssessment"
      description: The auto enrolment assessment object.
      required: true
    CisInstruction:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CisInstruction"
      description: The CIS instruction object.
      required: true
    CisLineType:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CisLineType"
      description: The CIS line type object.
      required: true
    Employee:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Employee"
      description: The employee object.
      required: true
    Employer:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Employer"
      description: The employer object.
      required: true
    HolidayScheme:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/HolidayScheme"
      description: The holiday scheme object.
      required: true
    NominalCode:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/NominalCode"
      description: The nominal code object.
      required: true
    PayCode:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PayCode"
      description: The pay code object.
      required: true
    PayInstruction:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PayInstruction"
      description: The pay instruction object.
      required: true
    PaySchedule:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PaySchedule"
      description: The pay schedule object.
      required: true
    Pension:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Pension"
      description: The pension object.
      required: true
    ReportDefinition:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ReportDefinition"
      description: The report definition object.
      required: true
    ReportingInstruction:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ReportingInstruction"
      description: The reporting instruction object.
      required: true
    SubContractor:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/SubContractor"
      description: The sub contractor object.
      required: true
    TransformDefinition:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/TransformDefinition"
      description: The transform definition object to be executed against the report data.
      required: true
  schemas:
    AEAssessment:
      properties:
        AEAssessment:
          properties:
            Age:
              description: The a e assessments' age
              format: int32
              title: Age
              type: integer
            AssessmentCode:
              description: The a e assessments' assessment code
              enum:
                - Excluded
                - EligibleJobHolder
                - NonEligibleJobHolder
                - EntitledWorker
              title: AssessmentCode
              type: string
            AssessmentDate:
              description: The a e assessments' assessment date
              format: date
              title: AssessmentDate
              type: string
            AssessmentEvent:
              description: The a e assessments' assessment event
              enum:
                - NonEnrolmentEvent
                - AutomaticEnrolment
                - OptIn
                - VoluntaryJoiner
                - ContractualEnrolment
              title: AssessmentEvent
              type: string
            AssessmentOverride:
              description: The a e assessments' assessment override
              enum:
                - None
                - OptOut
                - OptIn
                - VoluntaryJoiner
                - ContractualPension
                - CeasedMembership
                - Leaver
                - Excluded
              title: AssessmentOverride
              type: string
            AssessmentResult:
              description: The a e assessments' assessment result
              enum:
                - Inconclusive
                - NoChange
                - Enrol
                - Exit
              title: AssessmentResult
              type: string
            IsMemberOfAlternativePensionScheme:
              description: The a e assessments' is member of alternative pension scheme
              title: IsMemberOfAlternativePensionScheme
              type: boolean
            OptOutWindowEndDate:
              description: The a e assessments' opt out window end date
              format: date
              title: OptOutWindowEndDate
              type: string
            QualifyingEarnings:
              description: The a e assessments' qualifying earnings
              format: double
              title: QualifyingEarnings
              type: number
            ReenrolmentDate:
              description: The a e assessments' reenrolment date
              format: date
              title: ReenrolmentDate
              type: string
            StatePensionAge:
              description: The a e assessments' state pension age
              format: int32
              title: StatePensionAge
              type: integer
            StatePensionDate:
              description: The a e assessments' state pension date
              format: date
              title: StatePensionDate
              type: string
            TaxPeriod:
              description: The a e assessments' tax period
              format: int32
              title: TaxPeriod
              type: integer
            TaxYear:
              description: The a e assessments' tax year
              format: int32
              title: TaxYear
              type: integer
          title: AEAssessment
          type: object
      type: object
      xml:
        name: AEAssessment
    ApplicationSecret:
      properties:
        ApplicationSecret:
          properties:
            Created:
              description: The application secrets' created
              format: date-time
              title: Created
              type: string
            Name:
              description: The application secrets' name
              title: Name
              type: string
            Value:
              description: The application secrets' value
              title: Value
              type: string
          title: ApplicationSecret
          type: object
      type: object
      xml:
        name: ApplicationSecret
    BatchItemBase:
      properties:
        BatchItemBase:
          properties:
            "@Href":
              description: The batch item bases' href
              title: "@Href"
              type: string
          title: BatchItemBase
          type: object
      type: object
      xml:
        name: BatchItemBase
    BatchJobInstruction:
      properties:
        BatchJobInstruction:
          properties:
            HoldingDate:
              description: The batch job instructions' holding date
              format: date-time
              title: HoldingDate
              type: string
            Instructions:
              description: The batch job instructions' instructions
              properties:
                DELETE:
                  items:
                    properties:
                      "@Href":
                        description: The batch item bases' href
                        title: "@Href"
                        type: string
                  type: array
              title: DELETE
              type: object
            ValidateOnly:
              description: The batch job instructions' validate only
              title: ValidateOnly
              type: boolean
          title: BatchJobInstruction
          type: object
      type: object
      xml:
        name: BatchJobInstruction
    CisInstruction:
      properties:
        CisInstruction:
          properties:
            CisLineTag:
              description: The cis instructions' cis line tag
              title: CisLineTag
              type: string
            CisLineType:
              description: The cis instructions' cis line type
              title: CisLineType
              type: string
            Description:
              description: The cis instructions' description
              title: Description
              type: string
            PayFrequency:
              description: The cis instructions' pay frequency
              enum:
                - Monthly
                - Weekly
              title: PayFrequency
              type: string
            PeriodEnd:
              description: The cis instructions' period end
              format: int32
              title: PeriodEnd
              type: integer
            PeriodStart:
              description: The cis instructions' period start
              format: int32
              title: PeriodStart
              type: integer
            TaxYearEnd:
              description: The cis instructions' tax year end
              format: int32
              title: TaxYearEnd
              type: integer
            TaxYearStart:
              description: The cis instructions' tax year start
              format: int32
              title: TaxYearStart
              type: integer
            UOM:
              description: The cis instructions' u o m
              enum:
                - NotSet
                - Minute
                - Hour
                - Day
                - Week
                - Month
                - Year
                - Unit
              title: UOM
              type: string
            Units:
              description: The cis instructions' units
              format: double
              title: Units
              type: number
            VAT:
              description: The cis instructions' v a t
              format: double
              title: VAT
              type: number
            Value:
              description: The cis instructions' value
              format: double
              title: Value
              type: number
          title: CisInstruction
          type: object
      type: object
      xml:
        name: CisInstruction
    CisJobInstructionBase:
      properties:
        CisJobInstructionBase:
          properties:
            Employer:
              description: The cis job instruction bases' employer
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: Employer
              type: object
            HoldingDate:
              description: The cis job instruction bases' holding date
              format: date-time
              title: HoldingDate
              type: string
            SubContractors:
              description: The cis job instruction bases' sub contractors
              properties:
                SubContractor:
                  items:
                    properties:
                      "@href":
                        description: The links' href
                        title: "@href"
                        type: string
                      "@rel":
                        description: The links' target type
                        title: "@rel"
                        type: string
                      "@title":
                        description: The links' title
                        title: "@title"
                        type: string
                  type: array
              title: SubContractor
              type: object
          title: CisJobInstructionBase
          type: object
      type: object
      xml:
        name: CisJobInstructionBase
    CisLine:
      properties:
        CisLine:
          properties:
            CisDeduction:
              description: The cis lines' cis deduction
              format: double
              title: CisDeduction
              type: number
            CisLineType:
              description: The cis lines' cis line type
              title: CisLineType
              type: string
            Description:
              description: The cis lines' description
              title: Description
              type: string
            Generated:
              description: The cis lines' generated
              format: date-time
              title: Generated
              type: string
            GrossPay:
              description: The cis lines' gross pay
              format: double
              title: GrossPay
              type: number
            NominalCodeKey:
              description: The cis lines' nominal code key
              title: NominalCodeKey
              type: string
            PayFrequency:
              description: The cis lines' pay frequency
              enum:
                - Monthly
                - Weekly
              title: PayFrequency
              type: string
            TaxMonth:
              description: The cis lines' tax month
              format: int32
              title: TaxMonth
              type: integer
            TaxPeriod:
              description: The cis lines' tax period
              format: int32
              title: TaxPeriod
              type: integer
            TaxTreatment:
              description: The cis lines' tax treatment
              enum:
                - Taxable
                - NonTaxable
                - Notional
                - Materials
              title: TaxTreatment
              type: string
            TaxYear:
              description: The cis lines' tax year
              format: int32
              title: TaxYear
              type: integer
            UOM:
              description: The cis lines' u o m
              enum:
                - NotSet
                - Minute
                - Hour
                - Day
                - Week
                - Month
                - Year
                - Unit
              title: UOM
              type: string
            UnitRate:
              description: The cis lines' unit rate
              format: double
              title: UnitRate
              type: number
            Units:
              description: The cis lines' units
              format: double
              title: Units
              type: number
            VAT:
              description: The cis lines' v a t
              format: double
              title: VAT
              type: number
          title: CisLine
          type: object
      type: object
      xml:
        name: CisLine
    CisLineType:
      properties:
        CisLineType:
          properties:
            Description:
              description: The cis line types' description
              title: Description
              type: string
            LineType:
              description: The cis line types' line type
              title: LineType
              type: string
            NominalCode:
              description: The cis line types' nominal code
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: NominalCode
              type: object
            TaxTreatment:
              description: The cis line types' tax treatment
              enum:
                - Taxable
                - NonTaxable
                - Notional
                - Materials
              title: TaxTreatment
              type: string
          title: CisLineType
          type: object
      type: object
      xml:
        name: CisLineType
    CisTransaction:
      properties:
        CisTransaction:
          properties:
            CisMessageType:
              description: The cis transactions' cis message type
              enum:
                - Verification
                - Return
              title: CisMessageType
              type: string
            EmployerCore:
              description: The cis transactions' employer core
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: EmployerCore
              type: object
            RequestData:
              description: The cis transactions' request data
              title: RequestData
              type: string
            ResponseData:
              description: The cis transactions' response data
              title: ResponseData
              type: string
            TaxYear:
              description: The cis transactions' tax year
              format: int32
              title: TaxYear
              type: integer
            Timestamp:
              description: The cis transactions' timestamp
              format: date-time
              title: Timestamp
              type: string
            TransactionStatus:
              description: The cis transactions' transaction status
              enum:
                - New
                - RequestGenerated
                - CompletedWithError
                - CompletedWithSuccess
                - TimeOut
              title: TransactionStatus
              type: string
            TransmissionDate:
              description: The cis transactions' transmission date
              format: date-time
              title: TransmissionDate
              type: string
          title: CisTransaction
          type: object
      type: object
      xml:
        name: CisTransaction
    Commentary:
      properties:
        Commentary:
          properties:
            Created:
              description: The commentarys' created
              format: date-time
              title: Created
              type: string
            Detail:
              description: The commentarys' detail
              title: Detail
              type: string
            Employee:
              description: The commentarys' employee
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: Employee
              type: object
            PayRun:
              description: The commentarys' pay run
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: PayRun
              type: object
          title: Commentary
          type: object
      type: object
      xml:
        name: Commentary
    DpsJobInstruction:
      properties:
        DpsJobInstruction:
          properties:
            Apply:
              description: The dps job instructions' apply
              title: Apply
              type: boolean
            Employer:
              description: The dps job instructions' employer
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: Employer
              type: object
            FromDate:
              description: The dps job instructions' from date
              format: date
              title: FromDate
              type: string
            HoldingDate:
              description: The dps job instructions' holding date
              format: date-time
              title: HoldingDate
              type: string
            MessageTypes:
              description: The dps job instructions' message types
              properties:
                Type:
                  items:
                    properties: {}
                  type: array
              title: Type
              type: object
            MessagesToProcess:
              description: The dps job instructions' messages to process
              properties:
                Message:
                  items:
                    properties:
                      "@href":
                        description: The links' href
                        title: "@href"
                        type: string
                      "@rel":
                        description: The links' target type
                        title: "@rel"
                        type: string
                      "@title":
                        description: The links' title
                        title: "@title"
                        type: string
                  type: array
              title: Message
              type: object
            Retrieve:
              description: The dps job instructions' retrieve
              title: Retrieve
              type: boolean
          title: DpsJobInstruction
          type: object
      type: object
      xml:
        name: DpsJobInstruction
    DpsMessage:
      properties:
        DpsMessage:
          properties:
            FormType:
              description: The dps messages' form type
              title: FormType
              type: string
            IssueDate:
              description: The dps messages' issue date
              format: date
              title: IssueDate
              type: string
            LastUpdated:
              description: The dps messages' last updated
              format: date-time
              title: LastUpdated
              type: string
            Message:
              description: The dps messages' message
              title: Message
              type: string
            MessageStatus:
              description: The dps messages' message status
              enum:
                - Retrieved
                - Applied
                - Unresolved
                - Ignored
                - Information
              title: MessageStatus
              type: string
            MessageType:
              description: The dps messages' message type
              title: MessageType
              type: string
            ProcessingResult:
              description: The dps messages' processing result
              title: ProcessingResult
              type: string
            RetrieveDate:
              description: The dps messages' retrieve date
              format: date-time
              title: RetrieveDate
              type: string
            SequenceNumber:
              description: The dps messages' sequence number
              format: int32
              title: SequenceNumber
              type: integer
          title: DpsMessage
          type: object
      type: object
      xml:
        name: DpsMessage
    Employee:
      properties:
        Employee:
          properties:
            AEAssessmentOverride:
              description: The employees' a e assessment override
              enum:
                - None
                - OptOut
                - OptIn
                - VoluntaryJoiner
                - ContractualPension
                - CeasedMembership
                - Leaver
                - Excluded
              title: AEAssessmentOverride
              type: string
            AEAssessmentOverrideDate:
              description: The employees' a e assessment override date
              format: date
              title: AEAssessmentOverrideDate
              type: string
            AEExclusionReasonCode:
              description: The employees' a e exclusion reason code
              enum:
                - OtherNotKnown
                - NotAWorker
                - NotUKWorker
                - TemporaryUKWorker
                - OutsideAgeRange
                - SingleEmployeeDirector
                - CeasedMembershipWithin12Months
                - CeasedMembershipBeyond12Months
                - WorkerWULSWithin12Month
                - WorkerWULSBeyond12Month
                - WorkerInNoticePeriod
                - WorkerTaxProtection
              title: AEExclusionReasonCode
              type: string
            AEPostponementDate:
              description: The employees' a e postponement date
              format: date
              title: AEPostponementDate
              type: string
            Address:
              description: The employees' address
              properties:
                Address1:
                  description: The addresss' line 1
                  title: Address1
                  type: string
                Address2:
                  description: The addresss' line 2
                  title: Address2
                  type: string
                Address3:
                  description: The addresss' line 3
                  title: Address3
                  type: string
                Address4:
                  description: The addresss' line 4
                  title: Address4
                  type: string
                Country:
                  description: The addresss' country
                  title: Country
                  type: string
                Postcode:
                  description: The addresss' postcode
                  title: Postcode
                  type: string
              title: Address
              type: object
            BankAccount:
              description: The employees' bank account
              properties:
                AccountName:
                  description: The bank accounts' account name
                  title: AccountName
                  type: string
                AccountNumber:
                  description: The bank accounts' account number
                  title: AccountNumber
                  type: string
                BranchName:
                  description: The bank accounts' branch name
                  title: BranchName
                  type: string
                Reference:
                  description: The bank accounts' reference
                  title: Reference
                  type: string
                SortCode:
                  description: The bank accounts' sort code
                  title: SortCode
                  type: string
              title: BankAccount
              type: object
            Code:
              description: The employees' code
              title: Code
              type: string
            DateOfBirth:
              description: The employees' date of birth
              format: date
              title: DateOfBirth
              type: string
            Deactivated:
              description: The employees' deactivated
              title: Deactivated
              type: boolean
            DirectorshipAppointmentDate:
              description: The employees' directorship appointment date
              format: date
              title: DirectorshipAppointmentDate
              type: string
            EEACitizen:
              description: The employees' e e a citizen
              title: EEACitizen
              type: boolean
            EPM6:
              description: The employees' e p m6
              title: EPM6
              type: boolean
            EffectiveDate:
              description: The employees' effective date
              format: date
              title: EffectiveDate
              type: string
            EmployeePartner:
              description: The employees' employee partner
              properties:
                FirstName:
                  description: The employee partners' first name
                  title: FirstName
                  type: string
                Initials:
                  description: The employee partners' initials
                  title: Initials
                  type: string
                LastName:
                  description: The employee partners' last name
                  title: LastName
                  type: string
                MiddleName:
                  description: The employee partners' middle name
                  title: MiddleName
                  type: string
                NiNumber:
                  description: The employee partners' ni number
                  title: NiNumber
                  type: string
              title: EmployeePartner
              type: object
            FirstName:
              description: The employees' the first name
              title: FirstName
              type: string
            Gender:
              description: The employees' gender
              enum:
                - Unknown
                - Male
                - Female
              title: Gender
              type: string
            HoursPerWeek:
              description: The employees' hours per week
              format: double
              title: HoursPerWeek
              type: number
            Initials:
              description: The employees' initials
              title: Initials
              type: string
            IrregularEmployment:
              description: The employees' irregular employment
              title: IrregularEmployment
              type: boolean
            IsAgencyWorker:
              description: The employees' is agency worker
              title: IsAgencyWorker
              type: boolean
            LastName:
              description: The employees' last name
              title: LastName
              type: string
            LeaverReason:
              description: The employees' leaver reason
              enum:
                - Resigned
                - Dismissed
                - Redundant
                - Retired
                - Deceased
                - LegalCustody
                - Other
              title: LeaverReason
              type: string
            LeavingDate:
              description: The employees' leaving date
              format: date
              title: LeavingDate
              type: string
            MaritalStatus:
              description: The employees' marital status
              enum:
                - NotSet
                - Single
                - Married
                - Divorced
                - Widowed
              title: MaritalStatus
              type: string
            MetaData:
              description: The employees' meta data
              properties: {}
              title: MetaData
              type: object
            MiddleName:
              description: The employees' middle name
              title: MiddleName
              type: string
            NextRevisionDate:
              description: The employees' next revision date
              format: date
              title: NextRevisionDate
              type: string
            NiNumber:
              description: The employees' ni number
              title: NiNumber
              type: string
            NicLiability:
              description: The employees' nic liability
              enum:
                - HasOtherJob
                - IsFemaleEntitledToReducedRate
                - IsNotLiable
                - IsContractedOut
                - IsFullyLiable
                - IsApprentice
                - LeaverBeyond6Weeks
                - PaymentAfterLeavingIrregular
                - IsFreePortWorker
                - IsNotLiableForEmployerNi
              title: NicLiability
              type: string
            OffPayrollWorker:
              description: The employees' off payroll worker
              title: OffPayrollWorker
              type: boolean
            OnStrike:
              description: The employees' on strike
              title: OnStrike
              type: boolean
            P45IssuedDate:
              description: The employees' p45 issued date
              format: date
              title: P45IssuedDate
              type: string
            PassportNumber:
              description: The employees' passport number
              title: PassportNumber
              type: string
            PaySchedule:
              description: The employees' pay schedule
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: PaySchedule
              type: object
            PaymentMethod:
              description: The employees' payment method
              enum:
                - NotSet
                - Cash
                - Cheque
                - BACS
                - FasterPayments
                - Other
              title: PaymentMethod
              type: string
            PaymentToANonIndividual:
              description: The employees' payment to a non individual
              title: PaymentToANonIndividual
              type: boolean
            Region:
              description: The employees' region
              enum:
                - NotSet
                - England
                - Scotland
                - Wales
              title: Region
              type: string
            Revision:
              description: The employees' revision
              format: int32
              title: Revision
              type: integer
            RuleExclusions:
              description: The employees' rule exclusions
              enum:
                - None
                - NiMissingPayInstructionRule
                - TaxMissingPayInstructionRule
                - TaxCodeUpliftRule
                - NiSetExpectedLetterRule
                - NiDateOfBirthChangeRetrospectiveCRule
                - NiDefermentStatusChangeRule
                - NiEndContractedOutTransferRule
                - PaymentAfterLeavingTaxCodeRule
                - LeaverEndInstructionsRule
                - P45StudentLoanInstructionRule
                - P45TaxInstructionRule
                - P45YtdTaxRule
                - YtdInstructionRule
                - TaxCodeRegionChangeRule
                - AutoEnrolmentStatusChangeRule
                - EmployeeDeceasedRule
                - BenefitInstructionAutoEndRule
              title: RuleExclusions
              type: string
            Seconded:
              description: The employees' seconded
              enum:
                - NotSet
                - Stay183DaysOrMore
                - StayLessThan183Days
                - InOutUk
              title: Seconded
              type: string
            StartDate:
              description: The employees' start date
              format: date
              title: StartDate
              type: string
            StarterDeclaration:
              description: The employees' starter declaration
              enum:
                - PreviouslyReported
                - A
                - B
                - C
              title: StarterDeclaration
              type: string
            Territory:
              description: The employees' territory
              enum:
                - UnitedKingdom
              title: Territory
              type: string
            Title:
              description: The employees' title
              title: Title
              type: string
            VeteranPeriodStartDate:
              description: The employees' veteran period start date
              format: date
              title: VeteranPeriodStartDate
              type: string
            WorkingWeek:
              description: The employees' working week
              enum:
                - None
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - AllWeekDays
                - Saturday
                - Sunday
                - AllDays
              title: WorkingWeek
              type: string
          title: Employee
          type: object
      type: object
      xml:
        name: Employee
    EmployeeSecret:
      properties:
        EmployeeSecret:
          properties:
            Created:
              description: The employee secrets' created
              format: date-time
              title: Created
              type: string
            Name:
              description: The employee secrets' name
              title: Name
              type: string
            Value:
              description: The employee secrets' value
              title: Value
              type: string
          title: EmployeeSecret
          type: object
      type: object
      xml:
        name: EmployeeSecret
    EmployeeSummary:
      properties:
        EmployeeSummary:
          properties:
            Code:
              description: The employee summarys' code
              title: Code
              type: string
            EffectiveDate:
              description: The employee summarys' effective date
              format: date
              title: EffectiveDate
              type: string
            EmployeeLink:
              description: The employee summarys' employee link
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: EmployeeLink
              type: object
            EmployerLink:
              description: The employee summarys' employer link
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: EmployerLink
              type: object
            FirstName:
              description: The employee summarys' first name
              title: FirstName
              type: string
            Initials:
              description: The employee summarys' initials
              title: Initials
              type: string
            LastName:
              description: The employee summarys' last name
              title: LastName
              type: string
            LastPayDay:
              description: The employee summarys' last pay day
              format: date
              title: LastPayDay
              type: string
            LastPayDaySchedule:
              description: The employee summarys' last pay day schedule
              title: LastPayDaySchedule
              type: string
            LastPayDayTaxYear:
              description: The employee summarys' last pay day tax year
              format: int32
              title: LastPayDayTaxYear
              type: integer
            LeavingDate:
              description: The employee summarys' leaving date
              format: date
              title: LeavingDate
              type: string
            MetaData:
              description: The employee summarys' meta data
              properties: {}
              title: MetaData
              type: object
            NextPayDay:
              description: The employee summarys' next pay day
              format: date
              title: NextPayDay
              type: string
            NextRevisionDate:
              description: The employee summarys' next revision date
              format: date
              title: NextRevisionDate
              type: string
            NiLetter:
              description: The employee summarys' ni letter
              title: NiLetter
              type: string
            NiNumber:
              description: The employee summarys' ni number
              title: NiNumber
              type: string
            PayScheduleLink:
              description: The employee summarys' pay schedule link
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: PayScheduleLink
              type: object
            PayScheduleName:
              description: The employee summarys' pay schedule name
              title: PayScheduleName
              type: string
            Revision:
              description: The employee summarys' revision
              format: int32
              title: Revision
              type: integer
            StartDate:
              description: The employee summarys' start date
              format: date
              title: StartDate
              type: string
            Status:
              description: The employee summarys' status
              title: Status
              type: string
            TaxBasis:
              description: The employee summarys' tax basis
              enum:
                - Cumulative
                - Week1Month1
              title: TaxBasis
              type: string
            TaxCode:
              description: The employee summarys' tax code
              title: TaxCode
              type: string
            Title:
              description: The employee summarys' title
              title: Title
              type: string
            UniqueKey:
              description: The employee summarys' unique key
              title: UniqueKey
              type: string
          title: EmployeeSummary
          type: object
      type: object
      xml:
        name: EmployeeSummary
    Employer:
      properties:
        Employer:
          properties:
            Address:
              description: The employers' address
              properties:
                Address1:
                  description: The addresss' line 1
                  title: Address1
                  type: string
                Address2:
                  description: The addresss' line 2
                  title: Address2
                  type: string
                Address3:
                  description: The addresss' line 3
                  title: Address3
                  type: string
                Address4:
                  description: The addresss' line 4
                  title: Address4
                  type: string
                Country:
                  description: The addresss' country
                  title: Country
                  type: string
                Postcode:
                  description: The addresss' postcode
                  title: Postcode
                  type: string
              title: Address
              type: object
            ApprenticeshipLevyAllowance:
              description: The employers' apprenticeship levy allowance
              format: double
              title: ApprenticeshipLevyAllowance
              type: number
            AutoEnrolment:
              description: The employers' auto enrolment
              properties:
                Pension:
                  description: The employer auto enrolments' pension
                  properties:
                    "@href":
                      description: The links' href
                      title: "@href"
                      type: string
                    "@rel":
                      description: The links' target type
                      title: "@rel"
                      type: string
                    "@title":
                      description: The links' title
                      title: "@title"
                      type: string
                  title: Pension
                  type: object
                PostponementDate:
                  description: The employer auto enrolments' postponement date
                  format: date
                  title: PostponementDate
                  type: string
                PrimaryAddress:
                  description: The employer auto enrolments' primary address
                  properties:
                    Address1:
                      description: The addresss' line 1
                      title: Address1
                      type: string
                    Address2:
                      description: The addresss' line 2
                      title: Address2
                      type: string
                    Address3:
                      description: The addresss' line 3
                      title: Address3
                      type: string
                    Address4:
                      description: The addresss' line 4
                      title: Address4
                      type: string
                    Country:
                      description: The addresss' country
                      title: Country
                      type: string
                    Postcode:
                      description: The addresss' postcode
                      title: Postcode
                      type: string
                  title: PrimaryAddress
                  type: object
                PrimaryEmail:
                  description: The employer auto enrolments' primary email
                  title: PrimaryEmail
                  type: string
                PrimaryFirstName:
                  description: The employer auto enrolments' primary first name
                  title: PrimaryFirstName
                  type: string
                PrimaryJobTitle:
                  description: The employer auto enrolments' primary job title
                  title: PrimaryJobTitle
                  type: string
                PrimaryLastName:
                  description: The employer auto enrolments' primary last name
                  title: PrimaryLastName
                  type: string
                PrimaryTelephone:
                  description: The employer auto enrolments' primary telephone
                  title: PrimaryTelephone
                  type: string
                ReEnrolmentDayOffset:
                  description: The employer auto enrolments' re enrolment day offset
                  format: int32
                  title: ReEnrolmentDayOffset
                  type: integer
                ReEnrolmentMonthOffset:
                  description: The employer auto enrolments' re enrolment month offset
                  format: int32
                  title: ReEnrolmentMonthOffset
                  type: integer
                RecentOptOutReEnrolmentExcluded:
                  description: The employer auto enrolments' recent opt out re enrolment excluded
                  title: RecentOptOutReEnrolmentExcluded
                  type: boolean
                SecondaryAddress:
                  description: The employer auto enrolments' secondary address
                  properties:
                    Address1:
                      description: The addresss' line 1
                      title: Address1
                      type: string
                    Address2:
                      description: The addresss' line 2
                      title: Address2
                      type: string
                    Address3:
                      description: The addresss' line 3
                      title: Address3
                      type: string
                    Address4:
                      description: The addresss' line 4
                      title: Address4
                      type: string
                    Country:
                      description: The addresss' country
                      title: Country
                      type: string
                    Postcode:
                      description: The addresss' postcode
                      title: Postcode
                      type: string
                  title: SecondaryAddress
                  type: object
                SecondaryEmail:
                  description: The employer auto enrolments' secondary email
                  title: SecondaryEmail
                  type: string
                SecondaryFirstName:
                  description: The employer auto enrolments' secondary first name
                  title: SecondaryFirstName
                  type: string
                SecondaryJobTitle:
                  description: The employer auto enrolments' secondary job title
                  title: SecondaryJobTitle
                  type: string
                SecondaryLastName:
                  description: The employer auto enrolments' secondary last name
                  title: SecondaryLastName
                  type: string
                SecondaryTelephone:
                  description: The employer auto enrolments' secondary telephone
                  title: SecondaryTelephone
                  type: string
                StagingDate:
                  description: The employer auto enrolments' staging date
                  format: date
                  title: StagingDate
                  type: string
              title: AutoEnrolment
              type: object
            BacsServiceUserNumber:
              description: The employers' bacs service user number
              title: BacsServiceUserNumber
              type: string
            BankAccount:
              description: The employers' bank account
              properties:
                AccountName:
                  description: The bank accounts' account name
                  title: AccountName
                  type: string
                AccountNumber:
                  description: The bank accounts' account number
                  title: AccountNumber
                  type: string
                BranchName:
                  description: The bank accounts' branch name
                  title: BranchName
                  type: string
                Reference:
                  description: The bank accounts' reference
                  title: Reference
                  type: string
                SortCode:
                  description: The bank accounts' sort code
                  title: SortCode
                  type: string
              title: BankAccount
              type: object
            CalculateApprenticeshipLevy:
              description: The employers' calculate apprenticeship levy
              title: CalculateApprenticeshipLevy
              type: boolean
            ClaimEmploymentAllowance:
              description: The employers' claim employment allowance
              title: ClaimEmploymentAllowance
              type: boolean
            ClaimSmallEmployerRelief:
              description: The employers' claim small employer relief
              title: ClaimSmallEmployerRelief
              type: boolean
            EffectiveDate:
              description: The employers' effective date
              format: date
              title: EffectiveDate
              type: string
            HmrcSettings:
              description: The employers' hmrc settings
              properties:
                AccountingOfficeRef:
                  description: The hmrc settingss' accounting office ref
                  title: AccountingOfficeRef
                  type: string
                COTAXRef:
                  description: The hmrc settingss' c o t a x ref
                  title: COTAXRef
                  type: string
                ContactEmail:
                  description: The hmrc settingss' contact email
                  title: ContactEmail
                  type: string
                ContactFax:
                  description: The hmrc settingss' contact fax
                  title: ContactFax
                  type: string
                ContactFirstName:
                  description: The hmrc settingss' contact first name
                  title: ContactFirstName
                  type: string
                ContactLastName:
                  description: The hmrc settingss' contact last name
                  title: ContactLastName
                  type: string
                ContactTelephone:
                  description: The hmrc settingss' contact telephone
                  title: ContactTelephone
                  type: string
                EmploymentAllowanceOverride:
                  description: The hmrc settingss' employment allowance override
                  format: double
                  title: EmploymentAllowanceOverride
                  type: number
                Password:
                  description: The hmrc settingss' password
                  format: password
                  title: Password
                  type: string
                SAUTR:
                  description: The hmrc settingss' s a u t r
                  title: SAUTR
                  type: string
                Sender:
                  description: The hmrc settingss' sender
                  enum:
                    - Employer
                    - Individual
                    - Company
                    - Agent
                    - Bureau
                    - Partnership
                    - Trust
                    - Government
                    - ActingInCapacity
                    - Other
                  title: Sender
                  type: string
                SenderId:
                  description: The hmrc settingss' sender id
                  title: SenderId
                  type: string
                StateAidSector:
                  description: The hmrc settingss' state aid sector
                  enum:
                    - Agriculture
                    - FisheriesAquaculture
                    - RoadTransport
                    - Industrial
                    - NotApplicable
                  title: StateAidSector
                  type: string
                TaxOfficeNumber:
                  description: The hmrc settingss' tax office number
                  title: TaxOfficeNumber
                  type: string
                TaxOfficeReference:
                  description: The hmrc settingss' tax office reference
                  title: TaxOfficeReference
                  type: string
              title: HmrcSettings
              type: object
            MetaData:
              description: The employers' meta data
              properties: {}
              title: MetaData
              type: object
            Name:
              description: The employers' name
              title: Name
              type: string
            NextRevisionDate:
              description: The employers' next revision date
              format: date
              title: NextRevisionDate
              type: string
            Region:
              description: The employers' region
              enum:
                - NotSet
                - England
                - Scotland
                - Wales
              title: Region
              type: string
            Revision:
              description: The employers' revision
              format: int32
              title: Revision
              type: integer
            RuleExclusions:
              description: The employers' rule exclusions
              enum:
                - None
                - NiMissingPayInstructionRule
                - TaxMissingPayInstructionRule
                - TaxCodeUpliftRule
                - NiSetExpectedLetterRule
                - NiDateOfBirthChangeRetrospectiveCRule
                - NiDefermentStatusChangeRule
                - NiEndContractedOutTransferRule
                - PaymentAfterLeavingTaxCodeRule
                - LeaverEndInstructionsRule
                - P45StudentLoanInstructionRule
                - P45TaxInstructionRule
                - P45YtdTaxRule
                - YtdInstructionRule
                - TaxCodeRegionChangeRule
                - AutoEnrolmentStatusChangeRule
                - EmployeeDeceasedRule
                - BenefitInstructionAutoEndRule
              title: RuleExclusions
              type: string
            Territory:
              description: The employers' territory
              enum:
                - UnitedKingdom
              title: Territory
              type: string
          title: Employer
          type: object
      type: object
      xml:
        name: Employer
    EmployerSecret:
      properties:
        EmployerSecret:
          properties:
            Created:
              description: The employer secrets' created
              format: date-time
              title: Created
              type: string
            Name:
              description: The employer secrets' name
              title: Name
              type: string
            Value:
              description: The employer secrets' value
              title: Value
              type: string
          title: EmployerSecret
          type: object
      type: object
      xml:
        name: EmployerSecret
    EmployerSummary:
      properties:
        EmployerSummary:
          properties:
            EffectiveDate:
              description: The employer summarys' effective date
              format: date
              title: EffectiveDate
              type: string
            MetaData:
              description: The employer summarys' meta data
              properties: {}
              title: MetaData
              type: object
            Name:
              description: The employer summarys' name
              title: Name
              type: string
            NextRevisionDate:
              description: The employer summarys' next revision date
              format: date
              title: NextRevisionDate
              type: string
            Revision:
              description: The employer summarys' revision
              format: int32
              title: Revision
              type: integer
            UniqueKey:
              description: The employer summarys' unique key
              title: UniqueKey
              type: string
          title: EmployerSummary
          type: object
      type: object
      xml:
        name: EmployerSummary
    ErrorModel:
      properties:
        ErrorModel:
          properties:
            Description:
              description: The error models' description
              title: Description
              type: string
            ErrorCategory:
              description: The error models' error category
              enum:
                - General
                - NotFound
                - NotAuthorised
                - ValidationFailure
              title: ErrorCategory
              type: string
            Errors:
              description: The error models' errors
              properties:
                Error:
                  items:
                    type: string
                  type: array
              title: Errors
              type: object
          title: ErrorModel
          type: object
      type: object
      xml:
        name: ErrorModel
    HealthCheck:
      properties:
        HealthCheck:
          properties:
            Info:
              description: The health checks' info
              title: Info
              type: string
            Version:
              description: The health checks' version
              title: Version
              type: string
          title: HealthCheck
          type: object
      type: object
      xml:
        name: HealthCheck
    HolidayScheme:
      properties:
        HolidayScheme:
          properties:
            AccrualPayCodes:
              description: The holiday schemes' accrual pay codes
              properties:
                PayCode:
                  items:
                    type: string
                  type: array
              title: AccrualPayCodes
              type: object
            AllowExceedAnnualEntitlement:
              description: The holiday schemes' allow exceed annual entitlement
              title: AllowExceedAnnualEntitlement
              type: boolean
            AllowNegativeBalance:
              description: The holiday schemes' allow negative balance
              title: AllowNegativeBalance
              type: boolean
            AnnualEntitlementWeeks:
              description: The holiday schemes' annual entitlement weeks
              format: double
              title: AnnualEntitlementWeeks
              type: number
            BankHolidayInclusive:
              description: The holiday schemes' bank holiday inclusive
              title: BankHolidayInclusive
              type: boolean
            Code:
              description: The holiday schemes' code
              title: Code
              type: string
            EffectiveDate:
              description: The holiday schemes' effective date
              format: date
              title: EffectiveDate
              type: string
            MaxCarryOverDays:
              description: The holiday schemes' max carry over days
              format: double
              title: MaxCarryOverDays
              type: number
            NextRevisionDate:
              description: The holiday schemes' next revision date
              format: date
              title: NextRevisionDate
              type: string
            OffsetPayment:
              description: The holiday schemes' offset payment
              title: OffsetPayment
              type: boolean
            Revision:
              description: The holiday schemes' revision
              format: int32
              title: Revision
              type: integer
            SchemeCeasedDate:
              description: The holiday schemes' scheme ceased date
              format: date
              title: SchemeCeasedDate
              type: string
            SchemeKey:
              description: The holiday schemes' scheme key
              title: SchemeKey
              type: string
            SchemeName:
              description: The holiday schemes' scheme name
              title: SchemeName
              type: string
            YearStartDay:
              description: The holiday schemes' year start day
              format: int32
              title: YearStartDay
              type: integer
            YearStartMonth:
              description: The holiday schemes' year start month
              format: int32
              title: YearStartMonth
              type: integer
          title: HolidayScheme
          type: object
      type: object
      xml:
        name: HolidayScheme
    JobInfo:
      properties:
        JobInfo:
          properties:
            Created:
              description: The job infos' created
              format: date-time
              title: Created
              type: string
            EmployerKey:
              description: The job infos' employer key
              title: EmployerKey
              type: string
            Errors:
              description: The job infos' errors
              properties:
                Error:
                  items:
                    type: string
                  type: array
              title: Errors
              type: object
            HoldingDate:
              description: The job infos' holding date
              format: date-time
              title: HoldingDate
              type: string
            JobId:
              description: The job infos' job id
              title: JobId
              type: string
            JobStatus:
              description: The job infos' job status
              enum:
                - New
                - Pending
                - InProgress
                - Success
                - Failed
                - OnHold
              title: JobStatus
              type: string
            JobType:
              description: The job infos' job type
              title: JobType
              type: string
            LastUpdated:
              description: The job infos' last updated
              format: date-time
              title: LastUpdated
              type: string
            Progress:
              description: The job infos' progress
              format: double
              title: Progress
              type: number
          title: JobInfo
          type: object
      type: object
      xml:
        name: JobInfo
    JournalExpressionDataTable:
      properties:
        JournalExpressionDataTable:
          properties:
            TableName:
              description: The journal expression data tables' table name
              title: TableName
              type: string
          title: JournalExpressionDataTable
          type: object
      type: object
      xml:
        name: JournalExpressionDataTable
    JournalInstruction:
      properties:
        JournalInstruction:
          properties:
            AccountingType:
              description: The journal instructions' accounting type
              enum:
                - Credit
                - Debit
              title: AccountingType
              type: string
            Description:
              description: The journal instructions' description
              title: Description
              type: string
            EndDate:
              description: The journal instructions' end date
              format: date
              title: EndDate
              type: string
            Expression:
              description: The journal instructions' expression
              title: Expression
              type: string
            JournalLineTag:
              description: The journal instructions' journal line tag
              title: JournalLineTag
              type: string
            LedgerTarget:
              description: The journal instructions' ledger target
              title: LedgerTarget
              type: string
            NomCode:
              description: The journal instructions' nom code
              title: NomCode
              type: string
            StartDate:
              description: The journal instructions' start date
              format: date
              title: StartDate
              type: string
            SubNomCode:
              description: The journal instructions' sub nom code
              title: SubNomCode
              type: string
          title: JournalInstruction
          type: object
      type: object
      xml:
        name: JournalInstruction
    JournalLine:
      properties:
        JournalLine:
          properties:
            Credit:
              description: The journal lines' credit
              format: double
              title: Credit
              type: number
            Debit:
              description: The journal lines' debit
              format: double
              title: Debit
              type: number
            Description:
              description: The journal lines' description
              title: Description
              type: string
            Employee:
              description: The journal lines' employee
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: Employee
              type: object
            Generated:
              description: The journal lines' generated
              format: date-time
              title: Generated
              type: string
            Grouping:
              description: The journal lines' grouping
              title: Grouping
              type: string
            LedgerTarget:
              description: The journal lines' ledger target
              title: LedgerTarget
              type: string
            NomCode:
              description: The journal lines' nom code
              title: NomCode
              type: string
            PayFrequency:
              description: The journal lines' pay frequency
              enum:
                - Weekly
                - Monthly
                - TwoWeekly
                - FourWeekly
                - Yearly
              title: PayFrequency
              type: string
            PayRun:
              description: The journal lines' pay run
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: PayRun
              type: object
            SubContractor:
              description: The journal lines' sub contractor
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: SubContractor
              type: object
            SubNomCode:
              description: The journal lines' sub nom code
              title: SubNomCode
              type: string
            TaxPeriod:
              description: The journal lines' tax period
              format: int32
              title: TaxPeriod
              type: integer
            TaxYear:
              description: The journal lines' tax year
              format: int32
              title: TaxYear
              type: integer
          title: JournalLine
          type: object
      type: object
      xml:
        name: JournalLine
    Link:
      properties:
        Link:
          properties:
            "@href":
              description: The links' href
              title: "@href"
              type: string
            "@rel":
              description: The links' target type
              title: "@rel"
              type: string
            "@title":
              description: The links' title
              title: "@title"
              type: string
          title: Link
          type: object
      type: object
      xml:
        name: Link
    LinkCollection:
      properties:
        LinkCollection:
          properties:
            Links:
              description: The link collections' links
              properties:
                Link:
                  items:
                    properties:
                      "@href":
                        description: The links' href
                        title: "@href"
                        type: string
                      "@rel":
                        description: The links' target type
                        title: "@rel"
                        type: string
                      "@title":
                        description: The links' title
                        title: "@title"
                        type: string
                  type: array
              title: Link
              type: object
          title: LinkCollection
          type: object
      type: object
      xml:
        name: LinkCollection
    NominalCode:
      properties:
        NominalCode:
          properties:
            Description:
              description: The nominal codes' description
              title: Description
              type: string
            Key:
              description: The nominal codes' key
              title: Key
              type: string
          title: NominalCode
          type: object
      type: object
      xml:
        name: NominalCode
    PayCode:
      properties:
        PayCode:
          properties:
            Benefit:
              description: The pay codes' benefit
              title: Benefit
              type: boolean
            Code:
              description: The pay codes' code
              title: Code
              type: string
            Description:
              description: The pay codes' description
              title: Description
              type: string
            EffectiveDate:
              description: The pay codes' effective date
              format: date
              title: EffectiveDate
              type: string
            MetaData:
              description: The pay codes' meta data
              properties: {}
              title: MetaData
              type: object
            NextRevisionDate:
              description: The pay codes' next revision date
              format: date
              title: NextRevisionDate
              type: string
            Niable:
              description: The pay codes' niable
              title: Niable
              type: boolean
            NominalCode:
              description: The pay codes' nominal code
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: NominalCode
              type: object
            NonArrestable:
              description: The pay codes' non arrestable
              title: NonArrestable
              type: boolean
            Notional:
              description: The pay codes' notional
              title: Notional
              type: boolean
            Readonly:
              description: The pay codes' readonly
              title: Readonly
              type: boolean
            Region:
              description: The pay codes' region
              enum:
                - NotSet
                - England
                - Scotland
                - Wales
              title: Region
              type: string
            Revision:
              description: The pay codes' revision
              format: int32
              title: Revision
              type: integer
            Taxable:
              description: The pay codes' taxable
              title: Taxable
              type: boolean
            Territory:
              description: The pay codes' territory
              enum:
                - UnitedKingdom
              title: Territory
              type: string
            Type:
              description: The pay codes' type
              enum:
                - NotSet
                - Payment
                - Deduction
              title: Type
              type: string
          title: PayCode
          type: object
      type: object
      xml:
        name: PayCode
    PayInstruction:
      properties:
        PayInstruction:
          properties:
            Description:
              description: The pay instructions' description
              title: Description
              type: string
            EndDate:
              description: The pay instructions' end date
              format: date
              title: EndDate
              type: string
            PayLineTag:
              description: The pay instructions' pay line tag
              title: PayLineTag
              type: string
            StartDate:
              description: The pay instructions' start date
              format: date
              title: StartDate
              type: string
          title: PayInstruction
          type: object
      type: object
      xml:
        name: PayInstruction
    PayLine:
      properties:
        PayLine:
          properties:
            Calculator:
              description: The pay lines' calculator
              title: Calculator
              type: string
            Description:
              description: The pay lines' description
              title: Description
              type: string
            Generated:
              description: The pay lines' generated
              format: date-time
              title: Generated
              type: string
            PayCode:
              description: The pay lines' pay code
              title: PayCode
              type: string
            PayCodeType:
              description: The pay lines' pay code type
              enum:
                - NotSet
                - Payment
                - Deduction
              title: PayCodeType
              type: string
            PayRunSequence:
              description: The pay lines' pay run sequence
              format: int32
              title: PayRunSequence
              type: integer
            PaymentDate:
              description: The pay lines' payment date
              format: date
              title: PaymentDate
              type: string
            TaxPeriod:
              description: The pay lines' tax period
              format: int32
              title: TaxPeriod
              type: integer
            TaxYear:
              description: The pay lines' tax year
              format: int32
              title: TaxYear
              type: integer
            Value:
              description: The pay lines' value
              format: double
              title: Value
              type: number
          title: PayLine
          type: object
      type: object
      xml:
        name: PayLine
    PayRun:
      properties:
        PayRun:
          properties:
            Executed:
              description: The pay runs' executed
              format: date-time
              title: Executed
              type: string
            IsSupplementary:
              description: The pay runs' is supplementary
              title: IsSupplementary
              type: boolean
            PayFrequency:
              description: The pay runs' pay frequency
              enum:
                - Weekly
                - Monthly
                - TwoWeekly
                - FourWeekly
                - Yearly
              title: PayFrequency
              type: string
            PaySchedule:
              description: The pay runs' pay schedule
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: PaySchedule
              type: object
            PaymentDate:
              description: The pay runs' payment date
              format: date
              title: PaymentDate
              type: string
            PeriodEnd:
              description: The pay runs' period end
              format: date
              title: PeriodEnd
              type: string
            PeriodStart:
              description: The pay runs' period start
              format: date
              title: PeriodStart
              type: string
            ProceedingPayRun:
              description: The pay runs' proceeding pay run
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: ProceedingPayRun
              type: object
            Sequence:
              description: The pay runs' sequence
              format: int32
              title: Sequence
              type: integer
            TaxPeriod:
              description: The pay runs' tax period
              format: int32
              title: TaxPeriod
              type: integer
            TaxYear:
              description: The pay runs' tax year
              format: int32
              title: TaxYear
              type: integer
          title: PayRun
          type: object
      type: object
      xml:
        name: PayRun
    PayRunJobInstruction:
      properties:
        PayRunJobInstruction:
          properties:
            Employees:
              description: The pay run job instructions' employees
              properties:
                Employee:
                  items:
                    properties:
                      "@href":
                        description: The links' href
                        title: "@href"
                        type: string
                      "@rel":
                        description: The links' target type
                        title: "@rel"
                        type: string
                      "@title":
                        description: The links' title
                        title: "@title"
                        type: string
                  type: array
              title: Employee
              type: object
            EndDate:
              description: The pay run job instructions' end date
              format: date
              title: EndDate
              type: string
            HoldingDate:
              description: The pay run job instructions' holding date
              format: date-time
              title: HoldingDate
              type: string
            IsSupplementary:
              description: The pay run job instructions' is supplementary
              title: IsSupplementary
              type: boolean
            PaySchedule:
              description: The pay run job instructions' pay schedule
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: PaySchedule
              type: object
            PaymentDate:
              description: The pay run job instructions' payment date
              format: date
              title: PaymentDate
              type: string
            StartDate:
              description: The pay run job instructions' start date
              format: date
              title: StartDate
              type: string
          title: PayRunJobInstruction
          type: object
      type: object
      xml:
        name: PayRunJobInstruction
    PaySchedule:
      properties:
        PaySchedule:
          properties:
            MetaData:
              description: The pay schedules' meta data
              properties: {}
              title: MetaData
              type: object
            Name:
              description: The pay schedules' name
              title: Name
              type: string
            PayFrequency:
              description: The pay schedules' pay frequency
              enum:
                - Weekly
                - Monthly
                - TwoWeekly
                - FourWeekly
                - Yearly
              title: PayFrequency
              type: string
          title: PaySchedule
          type: object
      type: object
      xml:
        name: PaySchedule
    Pension:
      properties:
        Pension:
          properties:
            AECompatible:
              description: The pensions' a e compatible
              title: AECompatible
              type: boolean
            Certification:
              description: The pensions' certification
              enum:
                - NotSet
                - Set1
                - Set2
                - Set3
              title: Certification
              type: string
            Code:
              description: The pensions' code
              title: Code
              type: string
            ContributionDeductionDay:
              description: The pensions' contribution deduction day
              format: int32
              title: ContributionDeductionDay
              type: integer
            EffectiveDate:
              description: The pensions' effective date
              format: date
              title: EffectiveDate
              type: string
            EmployeeContributionCash:
              description: The pensions' employee contribution cash
              format: double
              title: EmployeeContributionCash
              type: number
            EmployeeContributionPercent:
              description: The pensions' employee contribution percent
              format: double
              title: EmployeeContributionPercent
              type: number
            EmployerContributionCash:
              description: The pensions' employer contribution cash
              format: double
              title: EmployerContributionCash
              type: number
            EmployerContributionPercent:
              description: The pensions' employer contribution percent
              format: double
              title: EmployerContributionPercent
              type: number
            EmployerNiSaving:
              description: The pensions' employer ni saving
              title: EmployerNiSaving
              type: boolean
            EmployerNiSavingPercentage:
              description: The pensions' employer ni saving percentage
              format: double
              title: EmployerNiSavingPercentage
              type: number
            Group:
              description: The pensions' group
              title: Group
              type: string
            LowerThreshold:
              description: The pensions' lower threshold
              format: double
              title: LowerThreshold
              type: number
            MetaData:
              description: The pensions' meta data
              properties: {}
              title: MetaData
              type: object
            NextRevisionDate:
              description: The pensions' next revision date
              format: date
              title: NextRevisionDate
              type: string
            PensionablePayCodes:
              description: The pensions' pensionable pay codes
              properties:
                PayCode:
                  items:
                    type: string
                  type: array
              title: PensionablePayCodes
              type: object
            ProRataMethod:
              description: The pensions' pro rata method
              enum:
                - NotSet
                - Annual260Days
                - Annual365Days
                - AnnualQualifyingDays
                - DaysPerCalendarMonth
                - DaysPerTaxPeriod
                - WorkingDaysPerCalendarMonth
                - WeekDaysPerCalendarMonth
              title: ProRataMethod
              type: string
            ProviderEmployerRef:
              description: The pensions' provider employer ref
              title: ProviderEmployerRef
              type: string
            ProviderName:
              description: The pensions' provider name
              title: ProviderName
              type: string
            QualifyingPayCodes:
              description: The pensions' qualifying pay codes
              properties:
                PayCode:
                  items:
                    type: string
                  type: array
              title: QualifyingPayCodes
              type: object
            RasRoundingOverride:
              description: The pensions' ras rounding override
              enum:
                - NotSet
                - PennyUp
                - PennyDown
                - Bankers
                - FiveUp
                - FiveDown
                - Floor
                - Ceiling
              title: RasRoundingOverride
              type: string
            Revision:
              description: The pensions' revision
              format: int32
              title: Revision
              type: integer
            RoundingOption:
              description: The pensions' rounding option
              enum:
                - NotSet
                - PennyUp
                - PennyDown
                - Bankers
                - FiveUp
                - FiveDown
                - Floor
                - Ceiling
              title: RoundingOption
              type: string
            SalarySacrifice:
              description: The pensions' salary sacrifice
              title: SalarySacrifice
              type: boolean
            SchemeName:
              description: The pensions' scheme name
              title: SchemeName
              type: string
            SubGroup:
              description: The pensions' sub group
              title: SubGroup
              type: string
            TaxationMethod:
              description: The pensions' taxation method
              enum:
                - NotSet
                - NetBased
                - ReliefAtSource
                - TaxReliefExcluded
              title: TaxationMethod
              type: string
            UpperThreshold:
              description: The pensions' upper threshold
              format: double
              title: UpperThreshold
              type: number
            UseAEThresholds:
              description: The pensions' use a e thresholds
              title: UseAEThresholds
              type: boolean
          title: Pension
          type: object
      type: object
      xml:
        name: Pension
    Permission:
      properties:
        Permission:
          properties:
            Description:
              description: The permissions' description
              title: Description
              type: string
            Expression:
              description: The permissions' expression
              title: Expression
              type: string
            Name:
              description: The permissions' name
              title: Name
              type: string
            Policy:
              description: The permissions' policy
              enum:
                - Allow
                - Deny
              title: Policy
              type: string
            Verbs:
              description: The permissions' verbs
              enum:
                - Read
                - Write
                - Delete
                - All
              title: Verbs
              type: string
          title: Permission
          type: object
      type: object
      xml:
        name: Permission
    Query:
      properties:
        Query:
          properties:
            Encoding:
              description: The querys' encoding
              title: Encoding
              type: string
            ExcludeNullOrEmptyElements:
              description: The querys' exclude null or empty elements
              title: ExcludeNullOrEmptyElements
              type: boolean
            Groups:
              description: The querys' groups
              properties:
                Group:
                  items:
                    properties:
                      "@GroupName":
                        description: The entity groups' group name
                        title: "@GroupName"
                        type: string
                      "@ItemName":
                        description: The entity groups' item name
                        title: "@ItemName"
                        type: string
                      "@LoopExpression":
                        description: The entity groups' loop expression
                        title: "@LoopExpression"
                        type: string
                      "@Predicate":
                        description: The entity groups' predicate
                        title: "@Predicate"
                        type: string
                      "@Selector":
                        description: The entity groups' selector
                        title: "@Selector"
                        type: string
                      "@UniqueKeyVariable":
                        description: The entity groups' unique key variable
                        title: "@UniqueKeyVariable"
                        type: string
                      Condition:
                        description: The entity groups' conditions
                        items:
                          properties:
                            "@ValueA":
                              description: The compare condition bases' value a
                              title: "@ValueA"
                              type: string
                            "@ValueB":
                              description: The compare condition bases' value b
                              title: "@ValueB"
                              type: string
                          type: object
                        title: Condition
                        type: array
                      Filter:
                        description: The entity groups' filters
                        items:
                          properties:
                            "@IsOr":
                              description: The filter bases' is or
                              title: "@IsOr"
                              type: boolean
                            "@Property":
                              description: The filter bases' property
                              title: "@Property"
                              type: string
                            "@Value":
                              description: The filter bases' value
                              title: "@Value"
                              type: string
                          type: object
                        title: Filter
                        type: array
                      Order:
                        description: The entity groups' ordering
                        items:
                          properties:
                            "@Property":
                              description: The order by bases' property
                              title: "@Property"
                              type: string
                          type: object
                        title: Order
                        type: array
                      Output:
                        description: The entity groups' outputs
                        items:
                          properties:
                            "@MaxLength":
                              description: The output bases' max length
                              title: "@MaxLength"
                              type: string
                            "@Output":
                              description: The output bases' output
                              enum:
                                - Element
                                - Attribute
                                - Variable
                                - VariableSum
                                - VariableAppend
                                - VariablePrepend
                                - ElementDatePart
                                - InnerText
                              title: "@Output"
                              type: string
                          type: object
                        title: Output
                        type: array
                  type: array
              title: Group
              type: object
            RootNodeName:
              description: The querys' root node name
              title: RootNodeName
              type: string
            SuppressMetricAttributes:
              description: The querys' suppress metric attributes
              title: SuppressMetricAttributes
              type: boolean
            Variables:
              description: The querys' variables
              properties:
                Variable:
                  items:
                    properties:
                      "@Name":
                        description: The name value pairs' name
                        title: "@Name"
                        type: string
                      "@Value":
                        description: The name value pairs' value
                        title: "@Value"
                        type: string
                  type: array
              title: Variable
              type: object
          title: Query
          type: object
      type: object
      xml:
        name: Query
    ReportDefinition:
      properties:
        ReportDefinition:
          properties:
            Active:
              description: The report definitions' active
              title: Active
              type: boolean
            Readonly:
              description: The report definitions' readonly
              title: Readonly
              type: boolean
            ReportQuery:
              description: The report definitions' report query
              properties:
                Encoding:
                  description: The querys' encoding
                  title: Encoding
                  type: string
                ExcludeNullOrEmptyElements:
                  description: The querys' exclude null or empty elements
                  title: ExcludeNullOrEmptyElements
                  type: boolean
                Groups:
                  description: The querys' groups
                  properties:
                    Group:
                      items:
                        properties:
                          "@GroupName":
                            description: The entity groups' group name
                            title: "@GroupName"
                            type: string
                          "@ItemName":
                            description: The entity groups' item name
                            title: "@ItemName"
                            type: string
                          "@LoopExpression":
                            description: The entity groups' loop expression
                            title: "@LoopExpression"
                            type: string
                          "@Predicate":
                            description: The entity groups' predicate
                            title: "@Predicate"
                            type: string
                          "@Selector":
                            description: The entity groups' selector
                            title: "@Selector"
                            type: string
                          "@UniqueKeyVariable":
                            description: The entity groups' unique key variable
                            title: "@UniqueKeyVariable"
                            type: string
                          Condition:
                            description: The entity groups' conditions
                            items:
                              properties:
                                "@ValueA":
                                  description: The compare condition bases' value a
                                  title: "@ValueA"
                                  type: string
                                "@ValueB":
                                  description: The compare condition bases' value b
                                  title: "@ValueB"
                                  type: string
                              type: object
                            title: Condition
                            type: array
                          Filter:
                            description: The entity groups' filters
                            items:
                              properties:
                                "@IsOr":
                                  description: The filter bases' is or
                                  title: "@IsOr"
                                  type: boolean
                                "@Property":
                                  description: The filter bases' property
                                  title: "@Property"
                                  type: string
                                "@Value":
                                  description: The filter bases' value
                                  title: "@Value"
                                  type: string
                              type: object
                            title: Filter
                            type: array
                          Order:
                            description: The entity groups' ordering
                            items:
                              properties:
                                "@Property":
                                  description: The order by bases' property
                                  title: "@Property"
                                  type: string
                              type: object
                            title: Order
                            type: array
                          Output:
                            description: The entity groups' outputs
                            items:
                              properties:
                                "@MaxLength":
                                  description: The output bases' max length
                                  title: "@MaxLength"
                                  type: string
                                "@Output":
                                  description: The output bases' output
                                  enum:
                                    - Element
                                    - Attribute
                                    - Variable
                                    - VariableSum
                                    - VariableAppend
                                    - VariablePrepend
                                    - ElementDatePart
                                    - InnerText
                                  title: "@Output"
                                  type: string
                              type: object
                            title: Output
                            type: array
                      type: array
                  title: Group
                  type: object
                RootNodeName:
                  description: The querys' root node name
                  title: RootNodeName
                  type: string
                SuppressMetricAttributes:
                  description: The querys' suppress metric attributes
                  title: SuppressMetricAttributes
                  type: boolean
                Variables:
                  description: The querys' variables
                  properties:
                    Variable:
                      items:
                        properties:
                          "@Name":
                            description: The name value pairs' name
                            title: "@Name"
                            type: string
                          "@Value":
                            description: The name value pairs' value
                            title: "@Value"
                            type: string
                      type: array
                  title: Variable
                  type: object
              title: ReportQuery
              type: object
            SupportedTransforms:
              description: The report definitions' supported transforms
              title: SupportedTransforms
              type: string
            Title:
              description: The report definitions' title
              title: Title
              type: string
            Version:
              description: The report definitions' version
              title: Version
              type: string
          title: ReportDefinition
          type: object
      type: object
      xml:
        name: ReportDefinition
    ReportLine:
      properties:
        ReportLine:
          properties:
            Description:
              description: The report lines' description
              title: Description
              type: string
            Generated:
              description: The report lines' generated
              format: date-time
              title: Generated
              type: string
            TaxMonth:
              description: The report lines' tax month
              format: int32
              title: TaxMonth
              type: integer
            TaxYear:
              description: The report lines' tax year
              format: int32
              title: TaxYear
              type: integer
            Value:
              description: The report lines' value
              format: double
              title: Value
              type: number
          title: ReportLine
          type: object
      type: object
      xml:
        name: ReportLine
    ReportingInstruction:
      properties:
        ReportingInstruction:
          properties:
            EndDate:
              description: The reporting instructions' end date
              format: date
              title: EndDate
              type: string
            StartDate:
              description: The reporting instructions' start date
              format: date
              title: StartDate
              type: string
            TaxMonth:
              description: The reporting instructions' tax month
              format: int32
              title: TaxMonth
              type: integer
            TaxYear:
              description: The reporting instructions' tax year
              format: int32
              title: TaxYear
              type: integer
            Value:
              description: The reporting instructions' value
              format: double
              title: Value
              type: number
          title: ReportingInstruction
          type: object
      type: object
      xml:
        name: ReportingInstruction
    RtiJobInstruction:
      properties:
        RtiJobInstruction:
          properties:
            EarlierTaxYear:
              description: The rti job instructions' earlier tax year
              format: int32
              title: EarlierTaxYear
              type: integer
            Employer:
              description: The rti job instructions' employer
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: Employer
              type: object
            FinalSubmissionForYear:
              description: The rti job instructions' final submission for year
              title: FinalSubmissionForYear
              type: boolean
            Generate:
              description: The rti job instructions' generate
              title: Generate
              type: boolean
            HoldingDate:
              description: The rti job instructions' holding date
              format: date-time
              title: HoldingDate
              type: string
            LateReason:
              description: The rti job instructions' late reason
              enum:
                - A
                - B
                - C
                - D
                - F
                - G
                - H
              title: LateReason
              type: string
            NoPaymentForPeriodFrom:
              description: The rti job instructions' no payment for period from
              format: date
              title: NoPaymentForPeriodFrom
              type: string
            NoPaymentForPeriodTo:
              description: The rti job instructions' no payment for period to
              format: date
              title: NoPaymentForPeriodTo
              type: string
            PaySchedule:
              description: The rti job instructions' pay schedule
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: PaySchedule
              type: object
            PaymentDate:
              description: The rti job instructions' payment date
              format: date
              title: PaymentDate
              type: string
            PeriodOfInactivityFrom:
              description: The rti job instructions' period of inactivity from
              format: date
              title: PeriodOfInactivityFrom
              type: string
            PeriodOfInactivityTo:
              description: The rti job instructions' period of inactivity to
              format: date
              title: PeriodOfInactivityTo
              type: string
            RtiTransaction:
              description: The rti job instructions' rti transaction
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: RtiTransaction
              type: object
            RtiType:
              description: The rti job instructions' rti type
              title: RtiType
              type: string
            SchemeCeased:
              description: The rti job instructions' scheme ceased
              format: date
              title: SchemeCeased
              type: string
            TaxMonth:
              description: The rti job instructions' tax month
              format: int32
              title: TaxMonth
              type: integer
            TaxYear:
              description: The rti job instructions' tax year
              format: int32
              title: TaxYear
              type: integer
            Timestamp:
              description: The rti job instructions' timestamp
              format: date-time
              title: Timestamp
              type: string
            Transmit:
              description: The rti job instructions' transmit
              title: Transmit
              type: boolean
          title: RtiJobInstruction
          type: object
      type: object
      xml:
        name: RtiJobInstruction
    RtiTransactionBase:
      properties:
        RtiTransactionBase:
          properties:
            EmployerCore:
              description: The rti transaction bases' employer core
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: EmployerCore
              type: object
            RequestData:
              description: The rti transaction bases' request data
              title: RequestData
              type: string
            ResponseData:
              description: The rti transaction bases' response data
              title: ResponseData
              type: string
            RtiType:
              description: The rti transaction bases' rti type
              title: RtiType
              type: string
            TaxYear:
              description: The rti transaction bases' tax year
              format: int32
              title: TaxYear
              type: integer
            Timestamp:
              description: The rti transaction bases' timestamp
              format: date-time
              title: Timestamp
              type: string
            TransactionStatus:
              description: The rti transaction bases' transaction status
              enum:
                - New
                - RequestGenerated
                - CompletedWithError
                - CompletedWithSuccess
                - TimeOut
              title: TransactionStatus
              type: string
            TransmissionDate:
              description: The rti transaction bases' transmission date
              format: date-time
              title: TransmissionDate
              type: string
          title: RtiTransactionBase
          type: object
      type: object
      xml:
        name: RtiTransactionBase
    SubContractor:
      properties:
        SubContractor:
          properties:
            Address:
              description: The sub contractors' address
              properties:
                Address1:
                  description: The addresss' line 1
                  title: Address1
                  type: string
                Address2:
                  description: The addresss' line 2
                  title: Address2
                  type: string
                Address3:
                  description: The addresss' line 3
                  title: Address3
                  type: string
                Address4:
                  description: The addresss' line 4
                  title: Address4
                  type: string
                Country:
                  description: The addresss' country
                  title: Country
                  type: string
                Postcode:
                  description: The addresss' postcode
                  title: Postcode
                  type: string
              title: Address
              type: object
            BankAccount:
              description: The sub contractors' bank account
              properties:
                AccountName:
                  description: The bank accounts' account name
                  title: AccountName
                  type: string
                AccountNumber:
                  description: The bank accounts' account number
                  title: AccountNumber
                  type: string
                BranchName:
                  description: The bank accounts' branch name
                  title: BranchName
                  type: string
                Reference:
                  description: The bank accounts' reference
                  title: Reference
                  type: string
                SortCode:
                  description: The bank accounts' sort code
                  title: SortCode
                  type: string
              title: BankAccount
              type: object
            BusinessType:
              description: The sub contractors' business type
              enum:
                - SoleTrader
                - Company
                - Partnership
                - Trust
              title: BusinessType
              type: string
            CompanyName:
              description: The sub contractors' company name
              title: CompanyName
              type: string
            CompanyRegistrationNumber:
              description: The sub contractors' company registration number
              title: CompanyRegistrationNumber
              type: string
            Deactivated:
              description: The sub contractors' deactivated
              title: Deactivated
              type: boolean
            EffectiveDate:
              description: The sub contractors' effective date
              format: date
              title: EffectiveDate
              type: string
            FirstName:
              description: The sub contractors' first name
              title: FirstName
              type: string
            Initials:
              description: The sub contractors' initials
              title: Initials
              type: string
            LastName:
              description: The sub contractors' last name
              title: LastName
              type: string
            MetaData:
              description: The sub contractors' meta data
              properties: {}
              title: MetaData
              type: object
            MiddleName:
              description: The sub contractors' middle name
              title: MiddleName
              type: string
            NextRevisionDate:
              description: The sub contractors' next revision date
              format: date
              title: NextRevisionDate
              type: string
            NiNumber:
              description: The sub contractors' ni number
              title: NiNumber
              type: string
            PartnershipName:
              description: The sub contractors' partnership name
              title: PartnershipName
              type: string
            PartnershipUniqueTaxReference:
              description: The sub contractors' partnership unique tax reference
              title: PartnershipUniqueTaxReference
              type: string
            PayFrequency:
              description: The sub contractors' pay frequency
              enum:
                - Monthly
                - Weekly
              title: PayFrequency
              type: string
            PaymentMethod:
              description: The sub contractors' payment method
              enum:
                - NotSet
                - Cash
                - Cheque
                - BACS
                - FasterPayments
                - Other
              title: PaymentMethod
              type: string
            Region:
              description: The sub contractors' region
              enum:
                - NotSet
                - England
                - Scotland
                - Wales
              title: Region
              type: string
            Revision:
              description: The sub contractors' revision
              format: int32
              title: Revision
              type: integer
            TaxationStatus:
              description: The sub contractors' taxation status
              enum:
                - Unmatched
                - Net
                - Gross
              title: TaxationStatus
              type: string
            Telephone:
              description: The sub contractors' telephone
              title: Telephone
              type: string
            Territory:
              description: The sub contractors' territory
              enum:
                - UnitedKingdom
              title: Territory
              type: string
            Title:
              description: The sub contractors' title
              title: Title
              type: string
            TradingName:
              description: The sub contractors' trading name
              title: TradingName
              type: string
            UniqueTaxReference:
              description: The sub contractors' unique tax reference
              title: UniqueTaxReference
              type: string
            VatRegistered:
              description: The sub contractors' vat registered
              title: VatRegistered
              type: boolean
            VatRegistrationNumber:
              description: The sub contractors' vat registration number
              title: VatRegistrationNumber
              type: string
            VerificationDate:
              description: The sub contractors' verification date
              format: date-time
              title: VerificationDate
              type: string
            VerificationNumber:
              description: The sub contractors' verification number
              title: VerificationNumber
              type: string
            WorksNumber:
              description: The sub contractors' works number
              title: WorksNumber
              type: string
          title: SubContractor
          type: object
      type: object
      xml:
        name: SubContractor
    Tag:
      properties:
        Tag:
          properties:
            Created:
              description: The tags' created
              format: date-time
              title: Created
              type: string
            TaggedItem:
              description: The tags' tagged item
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: TaggedItem
              type: object
            Text:
              description: The tags' text
              title: Text
              type: string
          title: Tag
          type: object
      type: object
      xml:
        name: Tag
    ThirdPartyJobInstruction:
      properties:
        ThirdPartyJobInstruction:
          properties:
            EmployerHref:
              description: The third party job instructions' employer href
              title: EmployerHref
              type: string
            HoldingDate:
              description: The third party job instructions' holding date
              format: date-time
              title: HoldingDate
              type: string
            InstructionType:
              description: The third party job instructions' instruction type
              title: InstructionType
              type: string
            MetaData:
              description: The third party job instructions' meta data
              properties: {}
              title: MetaData
              type: object
            PayLoad:
              description: The third party job instructions' pay load
              title: PayLoad
              type: string
          title: ThirdPartyJobInstruction
          type: object
      type: object
      xml:
        name: ThirdPartyJobInstruction
    ThirdPartyTransaction:
      properties:
        ThirdPartyTransaction:
          properties:
            EmployerCore:
              description: The third party transactions' employer core
              properties:
                "@href":
                  description: The links' href
                  title: "@href"
                  type: string
                "@rel":
                  description: The links' target type
                  title: "@rel"
                  type: string
                "@title":
                  description: The links' title
                  title: "@title"
                  type: string
              title: EmployerCore
              type: object
            JobType:
              description: The third party transactions' job type
              title: JobType
              type: string
            Request:
              description: The third party transactions' request
              title: Request
              type: string
            Response:
              description: The third party transactions' response
              title: Response
              type: string
            TransactionStatus:
              description: The third party transactions' transaction status
              enum:
                - Unknown
                - Success
                - Failure
              title: TransactionStatus
              type: string
            TransmissionDate:
              description: The third party transactions' transmission date
              format: date-time
              title: TransmissionDate
              type: string
          title: ThirdPartyTransaction
          type: object
      type: object
      xml:
        name: ThirdPartyTransaction
    TransformDefinition:
      properties:
        TransformDefinition:
          properties:
            Active:
              description: The transform definitions' active
              title: Active
              type: boolean
            ContentType:
              description: The transform definitions' content type
              title: ContentType
              type: string
            Definition:
              description: The transform definitions' definition
              title: Definition
              type: string
            DefinitionType:
              description: The transform definitions' definition type
              title: DefinitionType
              type: string
            Readonly:
              description: The transform definitions' readonly
              title: Readonly
              type: boolean
            SupportedReports:
              description: The transform definitions' supported reports
              title: SupportedReports
              type: string
            TaxYear:
              description: The transform definitions' tax year
              format: int32
              title: TaxYear
              type: integer
            Title:
              description: The transform definitions' title
              title: Title
              type: string
            Version:
              description: The transform definitions' version
              title: Version
              type: string
          title: TransformDefinition
          type: object
      type: object
      xml:
        name: TransformDefinition
    User:
      properties:
        User:
          properties:
            MetaData:
              description: The users' meta data
              properties: {}
              title: MetaData
              type: object
            Permissions:
              description: The users' permissions
              properties:
                Permission:
                  items:
                    properties:
                      "@href":
                        description: The links' href
                        title: "@href"
                        type: string
                      "@rel":
                        description: The links' target type
                        title: "@rel"
                        type: string
                      "@title":
                        description: The links' title
                        title: "@title"
                        type: string
                  type: array
              title: Permission
              type: object
            Roles:
              description: The users' roles
              properties:
                Role:
                  items:
                    type: string
                  type: array
              title: Roles
              type: object
            UserIdentifier:
              description: The users' user identifier
              title: UserIdentifier
              type: string
          title: User
          type: object
      type: object
      xml:
        name: User
