performContractBudgetCreateFinalEntriesPreCheck

performContractBudgetCreateFinalEntriesPreCheck

Overview

This method checks whether final budget entries can be created for a contract, without creating them.

Use it before calling createContractBudgetFinalEntries.

Rules

The create final budget entries functionality is available for a contract type when:

  1. A configuration entry for 'lease_finalise' exists for the contract type in the [gl_posting_map_reporting] table.

A contract can be finalised when:

  1. A suspend date is entered.

  2. There are no transactions in 'pending' or 'on-hold' status in the Payments and Maintenance areas.

  3. At least one period has been billed.

This method requires the ContractBudgets:CreateFinalEntries permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractBudgets:CreateFinalEntries'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/contract/budgets/final-entries/pre-check/5678 https://api.{{environment}}.catch-e.com/fm/contract/budgets/final-entries/pre-check/5678 https://api.test.catch-e.com/fm/contract/budgets/final-entries/pre-check/5678

Path Parameters

Key

Format

Notes

Mandatory

contract_id

string

Contract Id. A positive whole number, up to 10 digits, with no leading zeros.

Yes

Response Details

Success

200 - OK

Field

Format

Notes

contract_type_finalisable_flag

string

Whether the create final budget entries functionality is available for the contract's type. Values: yes, no.

contract_finalisable_flag

string

Whether the contract can be finalised. Values: yes, no.

{ "contract_type_finalisable_flag": "yes", "contract_finalisable_flag": "yes" }

Error Response Details

Validation Message

Comments

401 - Unauthorized

1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message

Comments

403 - Forbidden

- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message

Comments

404 - Not Found

The contract does not exist.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message

Comments

406 - Not Acceptable

The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message

Comments

500 - Internal Error

An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message

Comments

default - Unexpected Error

Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }