Full Open API Accounting Integration

The Full API Integration Approach is designed for clients who want maximum control over how payroll data is translated into accounting journal entries. Instead of relying on Jisr to generate ready-made journals, this approach exposes raw payroll and accrual data through Jisr's Open APIs, and your ERP system is responsible for applying your own accounting rules, account mappings, and grouping logic to build the journal entries itself.

This approach is best suited for organizations with a custom-built ERP, or teams whose accounting logic is complex enough that it needs to live inside the ERP rather than in Jisr.

Prerequisites:
 

Before you can call any Jisr Open API, you need an API Key and an Access Token. For more explanation on how to perform these steps, refer to this article.
 

Notes:

1- When creating the API key, make sure to select the following API permissions under the Financial section: 

• List Paygroups
• List GL Transaction Types
• List Payroll Transactions
• List Accrual Transactions

Additional permissions may be required depending on how journals will be constructed within your ERP system. Common examples include:

• Employees

• Departments

• Locations

• Business Units

These entities can be used to build journal entries at different levels of granularity, such as:

• Employee-level journals

• Department-level journals

• Location-level journals

• Business Unit, Legal Entity, Company, or Subsidiary-level journals

Note: When generating the API Key, ensure all required entities are included in the selected permissions based on your integration requirements.

2- Use the Authentication API to generate an Access Token, following the API documentation detailed in this technical documentation. This API response returns an Access Token to use in every subsequent request

Integration steps:

The Full API Integration Approach provides complete flexibility for building accounting journals within your ERP system.

Unlike the Partial API Integration Approach, where Jisr generates journal entries based on File-Based Accounting Integration configurations, this approach exposes the raw accounting data through APIs.

Using these APIs, your ERP system can retrieve:

• Payroll Transactions

• Accrual Transactions

• GL Transaction Types

You can then construct journal entries according to your organization's accounting rules and ERP requirements.

Note:

Before building journals, it is recommended to retrieve the supporting master data that may be required for journal construction and account mapping (e.g, GL transaction types, employees, departments, locations, business units).

1- Retrieve Paygroups:

Paygroup information is required to start the integration process.

Use the endpoint: GET /openapi/v1/paygroup, following the details in the technical documentation.

2- Retrieve GL Transaction Types:
GL Transaction Types are the core mapping mechanism between Jisr payroll elements (Basic Salary, Housing Allowance, Overtime, etc.) and accounts in your ERP's chart of accounts.

Use the endpoint: GET /openapi/v1/gl_transaction_types, following the details in the technical documentation.

During implementation, it's recommended to map each GL Transaction Type ID to a corresponding ERP account, for example:

GL Transaction Type	ERP Account
Basic Salary	Salary Expense
Housing Allowance	Housing Expense
Salary Payable	Salary Liability

This mapping table becomes the foundation for your journal construction logic inside the ERP.

3- Retrieve Payroll Transactions:

Use the endpoint: GET /openapi/v1/payroll_transactions, following the details in the technical documentation.

4- Retrieve Accrual Transactions:

Use the endpoint: GET /openapi/v1/accrual_transactions, following the details in the technical documentation.

5- Journal Construction Process:

After retrieving the required data, the ERP system is responsible for:

1. Retrieving GL Transaction Types.

2. Retrieving Payroll Transactions and/or Accrual Transactions.

3. Applying account mappings.

4. Applying accounting rules.

5. Grouping transactions by the required dimensions.

6. Building journal entries.

This is what gives the Full API Integration Approach its flexibility; the journal logic lives entirely in your system, so it can be as simple or as granular as your accounting requirements demand.

6- Automate with Webhooks (Optional):

Webhooks let Jisr notify your ERP automatically when relevant payroll events occur, instead of you polling on a schedule.
For more details on how to use webhooks, refer to this article.