Skip to content
Longport WhaleLongport Whale
Reporting Jurisdiction

Update Reporting Jurisdiction

Update the reporting configuration of a tax jurisdiction.

Request parameters

  • Required: id (record ID), report_requirement (reporting requirement), audit_frontend_resource (caller-provided audit context, including the jurisdiction name).
  • initial_reporting_year (first reporting year) is required when report_requirement is 1; the admin console omits it when report_requirement is 0.
  • Take id from a row of POST /v1/datasets/report_crs_tax_jurisdictions.
  • See each field's documentation for format, value ranges, and business meaning.

Business notes

Updates the reporting requirement and first reporting year for the specified tax jurisdiction, identified by record ID.

Risk warning

This operation changes tax-reporting configuration and may affect the scope of subsequent CRS data generation. Confirm the parameters before calling.

Result

On success, the configuration update completes; refer to the 200 response definition for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/crs/update_tax_jurisdiction

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

report.crs_tasks

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

idstringrequired

Record ID of the tax jurisdiction. Take id from a row of POST /v1/datasets/report_crs_tax_jurisdictions.

report_requirementstringrequired

Reporting requirement: 1 = report, 0 = do not report.

Values
1
0
initial_reporting_yearstring

First reporting year, such as 2026. Required when report_requirement is 1.

audit_frontend_resourceobjectrequired

Audit context provided by the caller. Contains tj_country_name (the jurisdiction name).

Child attributes
tj_country_namestring

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs