Skip to content
Revenue API
/
/
Check the soft-freeze sta...

Check the soft-freeze status

Request

Purpose

Returns, for each book and organization available to the caller, whether a soft freeze is in effect. During a soft freeze (typically during period close) journal entry changes are restricted.

When to use

  • Before creating or changing entries during period close, to know whether changes are currently restricted for a book and organization.
Security
OneIdOAuth
cURL
curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/journal-entries/soft-freeze-check \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Soft-freeze state

Headers
traceIdstring

Identifier of the request. Quote it when you contact Zuora Support.

Bodyapplication/json
Array [
bookIdinteger or null, (int32)

Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.

Example:1
secAtrValstring or null

Organization (security attribute value).

Example:"101"
softFreezeAppliedboolean or null

true when a soft freeze is in effect.

Example:false
]
Response
[
  {
    "bookId": 1,
    "secAtrVal": "101",
    "softFreezeApplied": false
  },
  {
    "bookId": 1,
    "secAtrVal": "102",
    "softFreezeApplied": true
  }
]