Journal API

Overview

The Zumzum Financials Journal API service provides the following capabilities

• Create a Journal with Journal Line Items
• Edit a Journal with Journal Line Items
• Post a Journal with a Journal Line Items
• Unpost a Journal with Journal Line Items

Journal With Journal Line Item Description

Journal records offer an ideal opportunity to create transactions to the Zumzum Financials general ledger.  You should be aware of the following:

• Journals are created with a default status of “Draft”
• Only Submit a list of draft Journals to the Journal Service in order to post them to the general ledger.
• Only one Journal Record may be submitted to post at any one time.
• All Journal Line Item values will need to be provided as a positive number as negative amounts are not supported.
• Only Journals that balance to zero for all line items will post successfully with the Post Journal Service.
• You may create multiple Journals with multiple line items in a single API call
• Once created, you are unable to add or remove Journal Line Items so you will need to delete the Journal and enter a new journal.
• Once added, you are unable to remove a Dimension from a Journal Line Item.  You may insert an alternative Dimension with an update call.

The CreateJournals function will accept the list of ‘JournalWrapper’ as an input parameter.  Below are the required fields when creating a draft Journal with Journal Line Items.

JournalWrapper API Fields

The CreateJournals function will accept the list of ‘JournalLineWrapper’ as an input parameter.  Below are the required fields when creating a Journal Line Item.

JournalLineWrapper API Fields

The JournalService will accept the list of ‘APICustomFieldWrapper’ as an input parameter.  Once you have created your custom fields on this object, you would be able to pass those as variables to the API for creating and updating records.  Below are the required fields when creating adding custom fields to your API call.

APICustomFieldWrapper API Fields

Create a Draft Journal – CreateJournals Method

Below is information related on how to create a draft Journal with the Journal API service using Apex code.  Zumzum Financials includes a global class called JournalService which you may call from your own Apex code. The CreateJournals method is used to insert Journals with Journal Line Items and returns a list of draft Journals created.

Sample Code: Create Journal

This example is provided to help you begin creating your own custom code.  The code will create a Journal record with 2 Journal Line Items and return a list of the draft Journal created. The following steps will be performed:

1. Prepare the list collection “List<JournalWrapper>” to supply as an input for the CreateJournals function.
2. Prepare the list collection “List<JournalLineWrapper>” to insert Journal Line Items with their required fields.
3. Create the Journal and Journal Line Item Records
4. Return a list of the draft Journal created with the list “listOfJournalRequest”

Sample Code :

/**************Start Sample Code Create A Draft Journal *****************************/

// Create a new variable Journal Wrapper to store the Journal data
zumzum.JournalWrapper objJournal = new zumzum.JournalWrapper();

// Create a new list variable to store the Journal Line Wrappers

List<zumzum.JournalLineWrapper> listOfLines = new List<zumzum.JournalLineWrapper>();

// Create a new variable JournalLineWrapper to store the journal line data

zumzum.JournalLineWrapper objJornalLine = new zumzum.JournalLineWrapper();

// Add the Nominal Account ID data to the Journal Line item variables

objJornalLine.NominalAccount ='a0i3H00000000NdQAI';

// Add the Tax Rate ID data to the Journal Line item variables 

objJornalLine.TaxRate ='a173H0000008OcZQAU';

// Add the Debit amount data to the Journal Line item variables 

objJornalLine.Debit = 10.00;

//Add the Journal Line Item to the Journal Line Items Wrapper

listOfLines.add(objJornalLine);

// Create a new variable JournalLineWrapper to store the journal line data 

objJornalLine = new zumzum.JournalLineWrapper();

// Add the Nominal Account ID data to the Journal Line item variables 

objJornalLine.NominalAccount ='a0i3H00000000NdQAI';

// Add the Tax Rate ID data to the Journal Line item variables 

objJornalLine.TaxRate ='a173H0000008OcZQAU';

// Add the Credit amount data to the Journal Line item variables 

objJornalLine.Credit = 10;

//Add the Journal Line Item to the Journal Line Items Wrapper 

listOfLines.add(objJornalLine);

objJournal.JournalLines = listOfLines;

// Create the variable to store the list of Journal Wrappers

List<zumzum.JournalWrapper> listOfJournalRequest = new List<zumzum.JournalWrapper>();

// Add the journal to the list of Journal Wrappers

listOfJournalRequest.add(objJournal);

// Initiate a new instance of the Zumzum Journal Service

zumzum.JournalService objJournalService = new zumzum.JournalService();

// Call the CreateJournals method in the Journal Service

zumzum.JournalService.JournalResponse response = objJournalService.CreateJournals(listOfJournalRequest);

// Receive the response message from the Journal Service

system.debug('Response>>' + response); 

/**************Start Sample Code Create A Draft Journal *****************************/

Edit A Draft Journal – UpdateJournals Method

Below is information related on how to edit a draft Journal with the Journal API service using Apex code.   The UpdateJournals method is used to edit Journals and Journal Line Items and returns a list of draft Journals edited.

Sample Code: Update Journal

This example code us used to edit an existing Journal record, to help you begin creating your own custom code.  The code will edit the Journal Line Item of an existing Journal. The following steps will be performed:

1. Prepare the list collection “List<JournalWrapper>” to include the “JournalID” to supply as an input for the UpdateJournals function.
2. Prepare the list collection “List<JournalLineWrapper>” to edit Journal Line Items with their changed fields.
3. Edit the Journal Line Item Records
4. Return a list of the draft Journal edited with the list “listOfJournalRequest”

Sample Code :

/* Update Journal */

zumzum.JournalWrapper objJournal = new zumzum.JournalWrapper();

objJournal.JournalID = 'a3S3H00000003OtUAI';

List<zumzum.JournalLineWrapper> listOfLines = new List<zumzum.JournalLineWrapper>();

zumzum.JournalLineWrapper objJournalLine = new zumzum.JournalLineWrapper();

objJournalLine.JournalLineID = 'a3R3H0000004GNMUA2';

objJournalLine.NominalAccount ='a0i3H00000000NdQAI';

objJournalLine.TaxRate ='a173H0000008OcZQAU';

objJournalLine.Debit = 20;

objJournalLine.Credit = 20;

listOfLines.add(objJournalLine);

objJournal.JournalLines = listOfLines;

List<zumzum.JournalWrapper> listOfJournalRequest = new List<zumzum.JournalWrapper>();

listOfJournalRequest.add(objJournalLine);

zumzum.JournalService objJournalService = new zumzum.JournalService();

zumzum.JournalService.JournalResponse response = objJournalService.UpdateJournals(listOfJournalRequest);

system.debug('Response>>' + response);

Sample Code: Post A Journal

Please follow the below steps to post a single Journal record.

1. Prepare the input variable “JournalID to submit to the PostJournal method.
2. You may develop your own batch routine to submit multiple Journals to the PostJournal method.

This example is provided to help you begin creating your own custom code.  The code will post a Journal to the general ledger.

Sample Code:

/* Post Journal */

zumzum.JournalService objService = new zumzum.JournalService();

zumzum.JournalService.JournalResponse response = objService.PostJournal('a0Z7E0000097UA7UAM');

system.debug('response>>' + response);

/* Unpost Journal */

zumzum.JournalService objService = new zumzum.JournalService();

zumzum.JournalService.JournalResponse response = objService.UnPostJournal('a3S3H00000003OtUAI');

system.debug('response>>' + response);

Below are a list of error codes that are returned by the Journal Service.