Interfaces
Overview
The FreeBalance Technical Platform supports batch import using XML for any entity, and ensure consistent behavior for all import interfaces, e.g. launch import operations from a central place, log the status of every operation and report errors in similar ways.
The FreeBalance Accountability Suite operates using XML for batch import, which is recognized as the best open standard for sharing structured data among different software systems.
Import Batch
Overview
Import Batch entity keeps statistical information for each import operation. The batch number is referenced by imported transactions and can be used as a search condition.Import Result keeps the result of each entry imported (accepted, rejected, or temp-saved) and error messages if any.
Navigation
Admin ► Interfaces ► Import Batch
Import Batch screen Fields
Field | Description |
Batch Number | This is a System generated id |
Start Time | This is the date and time that the import was started. |
Duration(ms) | This is the duration of the import measured in milliseconds. |
Input Quantity | This are the number of entries imported. |
Accepted Quantity | Monetary amount of the accepted entries |
Input Amount | Monetary amount of the input entries. |
Accepted Amount | Monetary amount of the accepted entries. |
User | The user who executed that particular import. |
Domain | The domain where the batch is created. |
Create Import
Navigation: 
To Import an XML to support a specific screen, e.g. Vendor, follow the steps below:
1. Click on the Entity Tab that you wish to Import, e.g. Vendor
2. Click on the Browse icon 
or enter the import file path.
3. Click on the Import icon 
4. The system will confirm the Batch number for the new Import.
Financial Operation
Overview
Any transaction that requires to affect the Financial Accountability Module must be linked to a financial operation, this operation can be by a reference to an existing operation that has been already applied in FA or automatically generated by any of the system modules in order to generate a transaction in FA
Navigation
Admin ► Interfaces ► Financial Operation
Financial Operation screen Fields and tab
Field | Description |
Id | This is a system generated unique identifier. |
| Workflow Status | This attribute can take one of the following values: ‘Approval Requested’, ‘Approved’, ‘Cancelled’, ‘Posted To FA’, and ‘Registered’. |
Financial Operation Type | This attribute can take one of the following values: 'Journal Voucher','Expense Voucher','Cash Sales'. |
Financial Operation Mode | This is a read only attribute with one of the following values: 'Reference Only','Generated by the System','Manually Entered'. |
Reference Number | This is a reference number to the financial operation in FA, this attribute must be manually entered when attribute Financial Operation Mode has been set to 'Reference Only', otherwise this value must be assigned by the system once a Financial Operation has been posted to FA. |
Fiscal Year | This is the fiscal year for this Financial Operation. |
Fiscal Period | The fiscal period where this Financial Operation will be applied. |
Gain Loss Result | This attribute must be calculated by the application for auto-generated financial operations. |
Registered Date | Assigned by the system, this is the Date and Time when this financial operation was registered. |
Approved Date | Assigned by the system, this is the Date and Time when this Financial Operation was approved. |
Posted Date | Assigned by the system, this is the Date and Time when this Financial Operation was posted. |
Transaction Related Id | This is the transaction identifier that originated this financial operation. |
Registered By | The User ID who registered this Financial Operation. |
Financial Operation Source | This attribute references the source or origin of this financial operation. |
Payment Mode | If this value is not populated and the Financial Operation is related with 'Expense Voucher' then system should get this value from Entity Vendor. |
Payment Terms | If this value is not populated and the Financial Operation is related with 'Expense Voucher' then system should get this value from Entity Vendor. |
PO Reference Number | This number will be automatically generated by the system in some processes related with Contract Management and it will be used as a link between Financial Operations and Expense Vouchers PO (FA). |
Paid Status | This can be 'No', 'Partially' or 'Yes'. |
Cheque Number | This cheque number is populated by the system when we generate expense vouchers and comes from the entity payment details. |
Amount | This ChequeAmount is populated by the system when we generate expense vouchers and comes from the entity payment details |
Cheque Date | Payment batch creation date |
Description | Information relevant to this particular Financial Operation, can be user entered for the 'Manual' or 'Reference' Operations or generated from another transaction. |
Financial Operation Detail Tab | This can be a collection of zero or more financial operation Details. |
Financial Operation Detail Tab
Financial Operation Detail Tab Screen Fields
| Fields | Description |
| Correlative | Correlative number, system auto generated, this attribute specifies the order to show the details to the UI this correlative will be used also for mapping against the XREF_ITEM_NUM in FA (See Attribute Mapping). |
| Debit Amount | This is the amount to be debited. If this value is being manually entered it is mandatory to be different from zero |
| Credit Amount | This is the amount to be credited. If this value is being manually entered it is mandatory to be different from zero |
| UACS | Specifies the coding block related to the account that will be affected by credit and/or debit. |
| Goods Receive Note Reference Number | Good Receive Note Reference Number on FA. It is read-only and visible to the user. This number will be automatically generated by the system in some processes related with Contract Management and it will be used as a link between Financial Operation Detail (Platform) and Expense Vouchers PO Item (FA). |
| Description | Description of the financial operation detail. |
Swift
Synchronization Error Log
Overview
The synchronization process generates a message Log screen that allows the user to see any messages generated by the Synchronization process. A failure screen allows the user to see any records which failed to synchronize. From here, one can attempt to resynchronize specific records manually. The record details indicate the primary key values of the item which failed to synchronize, and the Error Message field displays the exact error message returned by the synchronization process. The Synchronization between FreeBalance Classic and the Platform is achieved using a tool called Synchronization Application that allows tables to be kept in sync between the two systems by means of sending and receiving XML and creating corresponding records in the databases.
Field | Description |
Date Time | The Date Time field show when the synchronization was last run. |
User | User who views the error log |
Entity | Entity can be Business Ownership Type,Catalogue Item, Catalogue Item Catagory, Country,Financial Operation , Hazard Type,Performance Rating,Procurement Purchase Order,Purchasing Vehicle,Unit of Measure,Vendor Catalogue Item and Vendor Set Aside. |
Id | The unique id related to the Synchronization Error Log |
Application Id | This is the Application Id |
Event Type | Event type consist of Delete,Update and Insert |
Request | The request message for generating the error log. |
Error Message | The Error Message field displays the exact error message returned by the synchronization process. |
Uniface Code Converter
Overview
Uniface Code Converter is used for synchronization with classic FreeBalance software versions and maintains a mapping of code conversions between prior and the new platforms related to unconvertible codes (language, country, customer status).
Navigation
Admin ► Interfaces ► Uniface Code Converter
Uniface Code Converter screen Fields
Field | Description |
Code Type | Code Type consist of Currency,Customer Status,Language,Payment Method and Payment Mode.This is a system generated id. |
Uniface Code | Used for synchronization with classic FreeBalance software versions and maintains a mapping of code conversions between prior and the new platforms related to unconvertible codes (language, country, customer status) |
Local Code | The Local Code depends upon the Code Type selected. For example If we select Currency in Code type we will have Australian dollar, Euro etc whereas if we select Language we will have English Lao etc. |