Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• calendarYear integer(int32) Required

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • jobKey string
  • dispatched boolean
  • jobFinished boolean
  • resultStatus string

    Values are ACCEPTED, PARTIAL, or REJECTED.

  • lastPolledDate string(date-time)
  • pollPhase string

    Values are VALIDITY_CHECKING, PROCESSING, FINISHED, or FAULT.

  • pollCount integer(int32)
  • lastPollError string
  • status string

    Values are SUCCESS or FAILED.

  • validationError string
  • createdDate string(date-time)
  • domains array[object]
    Hide domains attributes Show domains attributes object

    • id integer(int64)
    • domain string

      Values are AHV_AVS, BVG_LPP, UVG_LAA, UVGZ_LAAC, KTG_AMC, FAK_CAF, TAX, TAX_AT_SOURCE, TAX_CROSSBORDER, STATISTIC, or UNEMPLOYMENT_CERTIFICATES.

    • institutionIdRef string
    • state string

      Values are IGNORED, PROCESSING, ERROR, or SUCCESS.

    • endUserInformation string
    • detailInformation string
    • canton string
    • responseCode string
    • institutionName string
    • responseId string
    • requestId string
    • completion object
      Hide completion attributes Show completion attributes object

      • url string
      • expiryDate string(date-time)
      • key string
      • password string
    • notifications array[object]
      Hide notifications attributes Show notifications attributes object

      • level string

        Values are WARNING or INFO.

      • qualityLevel string
      • descriptionCode string
      • description string
      • stage string

        Values are STATUS, RESULT, or DIALOG.

    • warningCount integer(int32)
    • infoCount integer(int32)
    • processFlow string

      Values are COMPLETION_AND_RESULT, DIALOG_AND_RESULT, or RESULT.

    • resultAvailable boolean
    • dialogAvailable boolean
    • result object
      Hide result attributes Show result attributes object

      • state string

        Values are NOT_SUPPORTED, COMPLETION_RELEASE_IS_MISSING, PROCESSING, ERROR, FAULT, or SUCCESS.

      • fetchedDate string(date-time)
      • expectedAvailability string(date-time)
      • endUserInformation string
      • detailInformation string
      • responseId string
      • requestId string
      • institutionName string
      • notifications array[object]
        Hide notifications attributes Show notifications attributes object

        • level string

          Values are WARNING or INFO.

        • qualityLevel string
        • descriptionCode string
        • description string
        • stage string

          Values are STATUS, RESULT, or DIALOG.

      • warningCount integer(int32)
      • infoCount integer(int32)
      • requestArchived boolean
      • responseArchived boolean
  • calendarYear integer(int32)
  • declarationKind string
  • monthType string
  • notifications array[object]
    Hide notifications attributes Show notifications attributes object

    • level string

      Values are WARNING or INFO.

    • qualityLevel string
    • descriptionCode string
    • description string
    • stage string

      Values are STATUS, RESULT, or DIALOG.

  • testCase boolean
  • declarationId string
  • requestId string
  • responseId string
  • predecessorJobKey string
  • predecessorDeclarationId string
  • substitutedByJobKey string
  • substitutedByDeclarationId string
  • signedRequestArchived boolean
  • signedResponseArchived boolean
  • substituted boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error