Wyzio API documentation

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
  
  budgetExist boolean
  
  endDate string
  
  fiscalYear integer(int32)
  
  flatRate1AccountsIds array[integer]
  
  flatRate2AccountsIds array[integer]
  
  flatRate_1 string
  
  flatRate_2 string
  
  id integer
  
  isLocked boolean
  
  lockedUntil string
  
  startDate string
  
  status string
  
  Values are OPEN, CLOSED, or INACTIVE.
  
  vatRule object
  
  Hide vatRule attributes Show vatRule attributes
  
  id integer
  
  name object
  
  Hide name attributes Show name attributes
  
  de string
  
  en string
  
  fr string
  
  it string
  
  rule string
  
  Values are NONE, AGREED_SERVICE, RECEIVED_COMPENSATION, NTDR_AGREED_SERVICE, or NTDR_RECEIVED_COMPENSATION.
• 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 \
 -X GET http://wyzio.app/api-v1/accounting-period/date-lock-status/{date} \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

{
  "locked": true,
  "periodDetails": {
    "budgetExist": true,
    "endDate": "string",
    "fiscalYear": 42,
    "flatRate1AccountsIds": [
      42
    ],
    "flatRate2AccountsIds": [
      42
    ],
    "flatRate_1": "string",
    "flatRate_2": "string",
    "id": 42,
    "isLocked": true,
    "lockedUntil": "string",
    "startDate": "string",
    "status": "OPEN",
    "vatRule": {
      "id": 42,
      "name": {
        "de": "string",
        "en": "string",
        "fr": "string",
        "it": "string"
      },
      "rule": "NONE"
    }
  }
}