Transaction Locking AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Lock financial transactions in Zoho Books to prevent modifications to transactions dated on or before a specific date. Transaction locking helps maintain the integrity of your financial records by restricting edits to closed periods.

Download Transaction Locking OpenAPI Document

End Points

PUT

/accountingperiods/transactionlock

GET

/transactionlocks

PUT

/transactionlock/partialunlock

Attribute

transaction_lock_id

string

ID of the transaction lock.

accounting_period_id

string

ID of the accounting period.

transaction_lock_status

string

Status of the transaction lock. Allowed Values: disabled, enabled, enabled_with_logging.

transaction_lock_date

string

Date up to which transactions are locked. [yyyy-MM-dd]

lock_status

string

Lock status of the transaction lock.

lock_scope

integer

Scope of the lock. Allowed Values: 0, 1, 2, 3, 4, 5.

lock_scope_formatted

string

Formatted display value of the lock scope.

lock_status_formatted

string

Formatted display value of the lock status.

partial_lock_number

integer

Partial lock number for the transaction lock.

accounting_period_name

string

Name of the accounting period.

fiscal_year_name

string

Name of the fiscal year.

start_date

string

Start date of the accounting period. [yyyy-MM-dd]

end_date

string

End date of the accounting period. [yyyy-MM-dd]

status

string

Status of the transaction lock entry.

is_adjustment_period

boolean

Whether the period is an adjustment period.

locked_by

string

Name of the user who locked the period.

user_exceptions

array

List of users exempted from the transaction lock.

user_exceptions_count

integer

Number of users exempted from the transaction lock.

account_exceptions

array

List of accounts exempted from the transaction lock.

account_exceptions_count

integer

Number of accounts exempted from the transaction lock.

reason

string

Reason for the transaction lock action. Max-length [500]

active_lock_summary

object

Summary of the active transaction lock.

{
    "transaction_lock_id": "982000000567045",
    "accounting_period_id": "982000000567001",
    "transaction_lock_status": "enabled",
    "transaction_lock_date": "2024-03-31",
    "lock_status": "locked",
    "lock_scope": 0,
    "lock_scope_formatted": "All",
    "lock_status_formatted": "Locked",
    "partial_lock_number": 0,
    "accounting_period_name": "Q1 2024",
    "fiscal_year_name": "FY 2024-2025",
    "start_date": "2024-04-01",
    "end_date": "2024-06-30",
    "status": "active",
    "is_adjustment_period": false,
    "locked_by": "John Smith",
    "user_exceptions": [],
    "user_exceptions_count": 0,
    "account_exceptions": [],
    "account_exceptions_count": 0,
    "reason": "Year-end closing",
    "active_lock_summary": {}
}

Update transaction lock AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update transaction lock settings.
OAuth Scope : ZohoBooks.accountants.UPDATE

Arguments

transaction_lock_status

string

Status of the transaction lock. Allowed Values: disabled, enabled, enabled_with_logging.

transaction_lock_module

string

Module to which the transaction lock applies. Allowed Values: sales, purchase, accountant, banking, inventory_adjustments.

transaction_lock_date

string

Date up to which transactions are locked. [yyyy-MM-dd]

accounting_period_id

string

ID of the accounting period.

reason

string

Reason for the transaction lock action. Max-length [500]

user_ids

array

List of user IDs to exempt from the lock.

account_ids

array

List of account IDs to exempt from the lock.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/transactionlock?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/transactionlock?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "transaction_lock_status": "enabled",
    "transaction_lock_module": "sales",
    "transaction_lock_date": "2024-03-31",
    "accounting_period_id": "982000000567001",
    "reason": "Year-end closing",
    "user_ids": [
        "982000000567089"
    ],
    "account_ids": [
        "982000000567101"
    ]
}

{
    "code": 0,
    "message": "Transaction lock has been updated.",
    "transaction_lock": {
        "transaction_lock_id": "982000000567045",
        "accounting_period_id": "982000000567001",
        "transaction_lock_status": "enabled",
        "transaction_lock_date": "2024-03-31",
        "lock_status": "locked",
        "lock_scope": 0,
        "lock_scope_formatted": "All",
        "lock_status_formatted": "Locked",
        "partial_lock_number": 0,
        "accounting_period_name": "Q1 2024",
        "fiscal_year_name": "FY 2024-2025",
        "start_date": "2024-04-01",
        "end_date": "2024-06-30",
        "status": "active",
        "is_adjustment_period": false,
        "locked_by": "John Smith",
        "user_exceptions": [],
        "user_exceptions_count": 0,
        "account_exceptions": [],
        "account_exceptions_count": 0,
        "reason": "Year-end closing",
        "active_lock_summary": {...}
    }
}

Get transaction lock details AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get the details of financial transaction locking.
OAuth Scope : ZohoBooks.accountants.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

accounting_period_id

string

ID of the accounting period.

transaction_lock_id

string

ID of the transaction lock.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/transactionlock?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/transactionlock?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "transaction_lock": {
        "transaction_lock_id": "982000000567045",
        "accounting_period_id": "982000000567001",
        "transaction_lock_status": "enabled",
        "transaction_lock_date": "2024-03-31",
        "lock_status": "locked",
        "lock_scope": 0,
        "lock_scope_formatted": "All",
        "lock_status_formatted": "Locked",
        "partial_lock_number": 0,
        "accounting_period_name": "Q1 2024",
        "fiscal_year_name": "FY 2024-2025",
        "start_date": "2024-04-01",
        "end_date": "2024-06-30",
        "status": "active",
        "is_adjustment_period": false,
        "locked_by": "John Smith",
        "user_exceptions": [],
        "user_exceptions_count": 0,
        "account_exceptions": [],
        "account_exceptions_count": 0,
        "reason": "Year-end closing",
        "active_lock_summary": {...}
    }
}

Delete a transaction lock AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete a transaction lock entry.
OAuth Scope : ZohoBooks.accountants.DELETE

Arguments

reason

string

Reason for the transaction lock action. Max-length [500]

Query Parameters

organization_id

string

(Required)

ID of the organization

transaction_lock_id

string

(Required)

ID of the transaction lock to delete.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695&transaction_lock_id=982000000567045"
type: DELETE
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695&transaction_lock_id=982000000567045")
  .delete(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695&transaction_lock_id=982000000567045', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("DELETE", "/books/v3/transactionlock?organization_id=10234695&transaction_lock_id=982000000567045", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/transactionlock?organization_id=10234695&transaction_lock_id=982000000567045",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/books/v3/transactionlock?organization_id=10234695&transaction_lock_id=982000000567045' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "reason": "Year-end closing"
}

{
    "code": 0,
    "message": "The transaction lock has been deleted."
}

Get transaction lock for an accounting period AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Get transaction locking details for an accounting period.
OAuth Scope : ZohoBooks.accountants.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

accounting_period_id

string

ID of the accounting period.

transaction_lock_id

string

ID of the transaction lock.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/accountingperiods/transactionlock?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/accountingperiods/transactionlock?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/accountingperiods/transactionlock?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/accountingperiods/transactionlock?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/accountingperiods/transactionlock?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/accountingperiods/transactionlock?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "transaction_lock": {
        "transaction_lock_id": "982000000567045",
        "accounting_period_id": "982000000567001",
        "transaction_lock_status": "enabled",
        "transaction_lock_date": "2024-03-31",
        "lock_status": "locked",
        "lock_scope": 0,
        "lock_scope_formatted": "All",
        "lock_status_formatted": "Locked",
        "partial_lock_number": 0,
        "accounting_period_name": "Q1 2024",
        "fiscal_year_name": "FY 2024-2025",
        "start_date": "2024-04-01",
        "end_date": "2024-06-30",
        "status": "active",
        "is_adjustment_period": false,
        "locked_by": "John Smith",
        "user_exceptions": [],
        "user_exceptions_count": 0,
        "account_exceptions": [],
        "account_exceptions_count": 0,
        "reason": "Year-end closing",
        "active_lock_summary": {...}
    }
}

List transaction locks AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List all transaction locks with pagination.
OAuth Scope : ZohoBooks.accountants.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

page

integer

Page number to be fetched. Default value is 1.

per_page

integer

Number of records to be fetched per page.

accounting_period_id

string

ID of the accounting period to filter by.

lock_scope

integer

Filter by lock scope. Allowed Values: 0, 1, 2, 3, 4, 5.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/transactionlocks?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/transactionlocks?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/transactionlocks?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/transactionlocks?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/transactionlocks?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/books/v3/transactionlocks?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "transaction_locks": [
        {
            "transaction_lock_id": "982000000567045",
            "accounting_period_id": "982000000567001",
            "transaction_lock_status": "enabled",
            "transaction_lock_date": "2024-03-31",
            "lock_status": "locked",
            "lock_scope": 0,
            "lock_scope_formatted": "All",
            "lock_status_formatted": "Locked",
            "partial_lock_number": 0,
            "accounting_period_name": "Q1 2024",
            "fiscal_year_name": "FY 2024-2025",
            "start_date": "2024-04-01",
            "end_date": "2024-06-30",
            "status": "active",
            "is_adjustment_period": false,
            "locked_by": "John Smith",
            "user_exceptions": [],
            "user_exceptions_count": 0,
            "account_exceptions": [],
            "account_exceptions_count": 0,
            "reason": "Year-end closing",
            "active_lock_summary": {...}
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 10,
        "has_more_page": false,
        "applied_filter": "Status.All",
        "sort_column": "start_date",
        "sort_order": "D"
    }
}

Update partial unlock settings AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update partial unlock settings for transaction locking.
OAuth Scope : ZohoBooks.accountants.UPDATE

Arguments

is_enabled

boolean

Whether partial unlock is enabled.

lock_module

string

Module for partial unlock. Allowed Values: all, sales, purchase, accountant, banking.

start_date

string

Start date of the accounting period. [yyyy-MM-dd]

end_date

string

End date of the accounting period. [yyyy-MM-dd]

reason

string

Reason for the transaction lock action. Max-length [500]

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/transactionlock/partialunlock?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/books/v3/transactionlock/partialunlock?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/transactionlock/partialunlock?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/transactionlock/partialunlock?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/books/v3/transactionlock/partialunlock?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/books/v3/transactionlock/partialunlock?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "is_enabled": true,
    "lock_module": "all",
    "start_date": "2024-04-01",
    "end_date": "2024-06-30",
    "reason": "Year-end closing"
}

{
    "code": 0,
    "message": "Partial unlock settings have been updated.",
    "transaction_lock": {
        "transaction_lock_id": "982000000567045",
        "accounting_period_id": "982000000567001",
        "transaction_lock_status": "enabled",
        "transaction_lock_date": "2024-03-31",
        "lock_status": "locked",
        "lock_scope": 0,
        "lock_scope_formatted": "All",
        "lock_status_formatted": "Locked",
        "partial_lock_number": 0,
        "accounting_period_name": "Q1 2024",
        "fiscal_year_name": "FY 2024-2025",
        "start_date": "2024-04-01",
        "end_date": "2024-06-30",
        "status": "active",
        "is_adjustment_period": false,
        "locked_by": "John Smith",
        "user_exceptions": [],
        "user_exceptions_count": 0,
        "account_exceptions": [],
        "account_exceptions_count": 0,
        "reason": "Year-end closing",
        "active_lock_summary": {...}
    }
}

Transaction Locking AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Attribute

Update transaction lock AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Query Parameters

Get transaction lock details AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Delete a transaction lock AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Query Parameters

Query Parameters

List transaction locks AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Update partial unlock settings AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Query Parameters

Transaction Locking AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update transaction lock AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Delete a transaction lock AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List transaction locks AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab