Check whether date is inside locked or unlocked accounting period

GET /api-v1/accounting-period/date-lock-status/{date}

Headers

  • TARGET-ORGANIZATION-ID integer(int32)

    ID of organization, for which the operation must be performed

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

Path parameters

  • date string Required

    date

Query parameters

  • organizationId integer

    organizationId

Responses

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • locked boolean
    • periodDetails object
      Hide periodDetails attributes Show periodDetails attributes object
      • budgetExist boolean
      • endDate string
      • fiscalYear integer(int32)
      • flatRateAccounts array[object]
        Hide flatRateAccounts attributes Show flatRateAccounts attributes object
        • flatRate string
        • flatRateChartAccountsIds array[integer]
        • id integer
      • id integer
      • isLocked boolean
      • lockedUntil string
      • ntdrRate1AccountsIds array[integer]
      • ntdrRate2AccountsIds array[integer]
      • ntdrRate_1 string
      • ntdrRate_2 string
      • startDate string
      • status string

        Values are OPEN, CLOSED, or INACTIVE.

      • vatRule object
        Hide vatRule attributes Show vatRule attributes object
        • id integer
        • name object
          Hide name attributes Show name attributes object
          • de string
          • en string
          • fr string
          • it string
        • rule string

          Values are NONE, AGREED_SERVICE, RECEIVED_COMPENSATION, NTDR_AGREED_SERVICE, NTDR_RECEIVED_COMPENSATION, FLAT_RATE_RECEIVED_COMPENSATION, or FLAT_RATE_AGREED_SERVICE.
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

GET /api-v1/accounting-period/date-lock-status/{date} 
curl \
 --request GET 'https://wyzio.app/api-v1/accounting-period/date-lock-status/{date}' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string"
Response examples (200) 
{
  "locked": true,
  "periodDetails": {
    "budgetExist": true,
    "endDate": "string",
    "fiscalYear": 42,
    "flatRateAccounts": [
      {
        "flatRate": "string",
        "flatRateChartAccountsIds": [
          42
        ],
        "id": 42
      }
    ],
    "id": 42,
    "isLocked": true,
    "lockedUntil": "string",
    "ntdrRate1AccountsIds": [
      42
    ],
    "ntdrRate2AccountsIds": [
      42
    ],
    "ntdrRate_1": "string",
    "ntdrRate_2": "string",
    "startDate": "string",
    "status": "OPEN",
    "vatRule": {
      "id": 42,
      "name": {
        "de": "string",
        "en": "string",
        "fr": "string",
        "it": "string"
      },
      "rule": "NONE"
    }
  }
}