| FINANCIAL_ITEM_LOCKED | FINANCIAL Endpoint | |
| /rpc/financial/?method=FINANCIAL_ITEM_LOCKED | ||
| Depending on the lock, varying fields on the parent item, or line item will be locked. | ||
|
By default, the financial system has mechanisms to prevent editing of data that should be locked, for example preventing a receipt being moved between bank accounts after it has been reconciled. There are standard procedures to be able to overcome all these locks, for example roll back the locked periods, roll back reconciliations etc. However, on occasion an administrator needs a mechanism to edit older data, and that is where you need to use overrides. Also, Invoices are automatically locked if you have the profile setting of 232 set to Y. The date that invoices, expenses, general journals are locked to are set by the profile settings of 233, 264, 265. However, you shouldn't set these manually, instead they are controlled by FINANCIAL_DEBTORSCREDITORS_PROCESSING_MANAGE Other profile settings are 301 - lock transactions in reconciliation (default Y), 302 - Lock if in BAS (default Y) |
||
| You should not build an override mechanism into your normal user interfaces - they should be only available for administrators. When an override is applied, it is logged. They can be viewed for up to 6 months via ADMIN_OVERRIDE_SEARCH. It shows the item the override was applied to, what standard rule(s) were overriden, and by whom | ||
| To use an override, you can either pass 'override=Y', in which case all overrides against all locks will be applied. However, the recommended use is via 'override_XXX=Y', for example 'override_LockedReconciliation=Y' to override a specific type of lock. This way you can write an admin form to change the amount of an Item that is in a reconciliation, but block it from changing it if it has also been submitted in a BAS. |
| PARAMETERS | TYPE | NOTES; | |
| Item | Numeric | You need to either pass Item, or Object and ObjectContext. If you pass all, Item takes precedence | |
| Object | Numeric | ||
| ObjectContext | Numeric |
| RETURN | ||
| LockedBAS | Y/N. The item is in a BAS. You cannot update the contact that the item is linked to, the bank account, of the date. Applies to Receipts and Payments. | |
| LockedCredit | Y/N. For Items only. See below | |
| LockedDate | Y/N. The item is in a locked period. You cannot update any fields. | |
| LockedLinked | Y/N. For Items only. See below | |
| LockedReconciliation | Y/N. The item is in a reconciliation. You cannot update the contact that the item is linked to, the bank account, of the date. Applies to Receipts and Payments. | |
| LockedSent | Y/N. The invoice has been marked as sent. You cannot update any fields. | |
| LockedTransfer | Y/N. For Items only. See below | |
| ADDITIONAL NOTES | |
For Line Items (FINANCIAL_ITEM_MANAGE), if the parent item (ie Invoice, Receipt, Payment, Expense) is:
|