Purchase Invoice API

Overview

The Zumzum Financials Purchase Invoice API service provides the following capabilities

• Create a Purchase Invoice with a Purchase Invoice Line Item
• Edit a Purchase Invoice with a Purchase Invoice Line Item
• Post a Purchase Invoice
• Batch Post Purchase Invoices

Purchase Invoice With Purchase Invoice Line Description

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

• Purchase Invoices are created with a default status of “Draft” and need to be submitted to the PostPurchaseInvoice method.
• Only submit a list of draft Purchase Invoices to the Purchase Invoice Service in order to post them to the general ledger.
• Only one Purchase Invoice record may be submitted to post at any one time.
• Purchase Invoices and Purchase Credits are created in the Purchase Invoice Object by setting the “Type” field on the record to be created.
• All Purchase Invoice Line Item values will need to be provided as a positive number as negative amounts are not supported.
• The Purchase Invoice will be automatically updated to Paid Y or N if the total Paid Amount is equal to the Total Gross  of the Purchase Invoice.  The Total Paid Amount is calculated from all the supplier payments or purchase credit allocations to the Purchase Invoice Line Items.
• Remove any field values by sending the text value “null” to any global variable, excluding required fields or date fields.
• Create Purchase Invoices and Purchase Invoice line items including your own custom fields using the global list APICustomFieldWrapper

The PurchaseInvoicePost Service function will accept the list of ‘PurchaseInvoiceWrapper’ as an input parameter.  Below are the required fields when creating a draft Purchase Invoice with Purchase  Invoice Line Items.

PurchaseInvoiceWrapper API Fields

The CreatePurchaseInvoice function will accept the list of ‘PurchaseInvoiceLineWrapper’ as an input parameter.  Below are the required fields when creating a Purchase Invoice Line Item.

PurchaseInvoiceLineWrapper API Fields

The PurchaseInvoicePost Service 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 Purchase Invoice – CreatePurchaseInvoices Method

Below is information related on how to create a draft Purchase Invoice with the Purchase Invoice API service using Apex code.  Zumzum Financials includes a global class called PurchaseInvoiceService which you may call from your own Apex code. The CreatePurchaseInvoices method is used to insert Purchase Invoices with Purchase Invoice Line Items and returns a list of draft purchase invoices created.

Sample Code: Create Purchase Invoice

This example is provided to help you begin creating your own custom code.  The code will create a Purchase Invoice with a single Purchase Invoice Line Item and return a list of the Purchase Invoice created. The following steps will be performed:

1. Prepare the list collection “List<PurchaseInvoiceWrapper>” to supply as an input for the CreatePurchaseInvoice function.
2. Prepare the list collection “List<PurchaseInvoiceLineWrapper>” to insert Purchase Invoice Line Items with their required fields.
3. Create the Purchase Invoice and Purchase Invoice Line Item Records
4. Return a list of the draft Purchase Invoices created with Purchase_Invoice__c

Sample Code :

zumzum.PurchaseInvoiceService objInvoiceHandler = new zumzum.PurchaseInvoiceService();

List<zumzum.PurchaseInvoiceService.PurchaseInvoiceWrapper > lstInvoiceData = new List<zumzum.PurchaseInvoiceService.PurchaseInvoiceWrapper >();

zumzum.PurchaseInvoiceService.PurchaseInvoiceWrapper purchaseInvoice = new zumzum.PurchaseInvoiceService.PurchaseInvoiceWrapper( );

purchaseInvoice.SupplierAccount = '0013H000003sPCoQAM'; //provide the account id here.

purchaseInvoice.InvoiceDate = date.today();

//purchaseInvoice.TransactionCurrency = 'a1T3H0000004Cc8UAE'; //provide the transaction currency id here

zumzum.PurchaseInvoiceService.PurchaseInvoiceLineWrapper purchaseInvoiceLine = new zumzum.PurchaseInvoiceService.PurchaseInvoiceLineWrapper();

purchaseInvoiceLine.NominalAccount = 'a0i3H00000000NZQAY';

purchaseInvoiceLine.Narrative = 'line--1';

purchaseInvoiceLine.Quantity = 2;

purchaseInvoiceLine.TaxRate = 'a173H0000008OciQAE'; //provide tax rate id

purchaseInvoiceLine.ForeignNetAmount = 30;

purchaseInvoice.LineItems = new List<zumzum.PurchaseInvoiceService.PurchaseInvoiceLineWrapper>();

purchaseInvoice.LineItems.add(purchaseInvoiceLine);

purchaseInvoiceLine = new zumzum.PurchaseInvoiceService.PurchaseInvoiceLineWrapper();

purchaseInvoiceLine.NominalAccount = 'a0i3H00000000NZQAY';

purchaseInvoiceLine.Narrative = 'line--2';

purchaseInvoiceLine.Quantity = 3;

purchaseInvoiceLine.TaxRate = 'a173H0000008OciQAE'; //provide tax rate id

purchaseInvoiceLine.ForeignNetAmount = 50;

purchaseInvoice.LineItems.add(purchaseInvoiceLine);

lstInvoiceData.add(purchaseInvoice);

zumzum.PurchaseInvoiceService.Response objResponse = objInvoiceHandler.CreatePurchaseInvoices(lstInvoiceData);

system.debug('Message>>' + objResponse.ResponseMessage);

system.debug('purchaseInvoices>>' + objResponse.purchaseInvoices);

Edit a Draft Purchase Invoice – UpdatePurchaseInvoices Method

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

Sample Code: Update Purchase Invoice

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

1. Prepare the list collection “List<Purchase InvoiceWrapper>” to include the “Purchase InvoiceID” to supply as an input for the UpdatePurchaseInvoices function.
2. Prepare the list collection “List<PurchaseInvoiceLineWrapper>” to edit Purchase Invoice Line Items with their changed fields.
3. Edit the Purchase Invoice Line Item records
4. Return a list of the draft Purchase Invoices edited with the list “Purchase_Invoice__c”

Sample Code :

zumzum.PurchaseInvoiceService objInvoiceHandler = new zumzum.PurchaseInvoiceService();

List<zumzum.PurchaseInvoiceService.PurchaseInvoiceWrapper > lstInvoiceData = new List<zumzum.PurchaseInvoiceService.PurchaseInvoiceWrapper >();

zumzum.PurchaseInvoiceService.PurchaseInvoiceWrapper purchaseInvoice = new zumzum.PurchaseInvoiceService.PurchaseInvoiceWrapper( );

PurchaseInvoice.PurchaseInvoiceId = 'a0n3H0000004pXwQAI';

purchaseInvoice.SupplierAccount = '0013H000003sPCoQAM'; //provide the account id here.

purchaseInvoice.InvoiceDate = date.today().addDays(-20);

PurchaseInvoice.InvoiceDueDate = date.today().addDays(1);

PurchaseInvoice.ExternalReference = 'Edit PI - External reference change';

//purchaseInvoice.TransactionCurrency = 'a1T3H0000004Cc8UAE'; //provide the transaction currency id here

zumzum.PurchaseInvoiceService.PurchaseInvoiceLineWrapper purchaseInvoiceLine = new zumzum.PurchaseInvoiceService.PurchaseInvoiceLineWrapper();

PurchaseInvoiceLine.PurchaseInvoiceLineId = 'a0m3H000000sHeMQAU';

purchaseInvoiceLine.NominalAccount = 'a0i3H00000000NZQAY';

purchaseInvoiceLine.Narrative = 'lineedit--1';

purchaseInvoiceLine.Quantity = 2;

purchaseInvoiceLine.TaxRate = 'a173H0000008OciQAE'; //provide tax rate id

purchaseInvoiceLine.ForeignNetAmount = 35;

purchaseInvoice.LineItems = new List<zumzum.PurchaseInvoiceService.PurchaseInvoiceLineWrapper>();

purchaseInvoice.LineItems.add(purchaseInvoiceLine);

purchaseInvoiceLine = new zumzum.PurchaseInvoiceService.PurchaseInvoiceLineWrapper();

purchaseInvoiceLine.NominalAccount = 'a0i3H00000000NZQAY';

purchaseInvoiceLine.Narrative = 'lineedit--2';

purchaseInvoiceLine.Quantity = 1;

purchaseInvoiceLine.TaxRate = 'a173H0000008OciQAE'; //provide tax rate id

purchaseInvoiceLine.ForeignNetAmount = 45;

purchaseInvoice.LineItems.add(purchaseInvoiceLine);

lstInvoiceData.add(purchaseInvoice);

zumzum.PurchaseInvoiceService.Response objResponse = objInvoiceHandler.UpdatePurchaseInvoices(lstInvoiceData);

system.debug('Message>>' + objResponse.ResponseMessage);

system.debug('purchaseInvoices>>' + objResponse.purchaseInvoices);

Post A Purchase Invoice – PostPurchaseInvoice Method

Sample Code: Post A Purchase Invoice

/* Gather the list of draft Purchase Invoices with a query */

List<Zumzum__Purchase_Invoice__c> lstDraftPurchaseInvoices = [Select id from Zumzum__Purchase_Invoice__c where Zumzum__Status__c = 'Draft' order by createddate desc limit 20];

Set<Id> setOfPurchaseInvoiceIds = new Set<Id>();

for(Zumzum__Purchase_Invoice__c PI : lstDraftPurchaseInvoices){

setOfPurchaseInvoiceIds.add(PI.id);

}

zumzum.PurchaseInvoiceService objInvoiceHandler = new zumzum.PurchaseInvoiceService();

/* Pass the list of Purchase Invoices to be posted to the PostPurchaseInvoice method */

objInvoiceHandler.PostPurchaseInvoice(setOfPurchaseInvoiceIds,true);

//***************************Start Sample Post Purchase Invoice Code ************************//

zumzum.PurchaseInvoiceService objPurchaseInvoice = new zumzum.PurchaseInvoiceService();

// Populate the Set of Purchase Invoice IDs 

Set<Id> setOfPurchaseInvoiceIds = new Set<Id>{'a0q8E000006jNM7','a0q8E000006jNMC'};

//Pass the parameter “executeInBatchProcessing” as true if you wish to execute post invoice processing in batches

zumzum.PurchaseInvoiceService.Response objResponse = objPurchaseInvoice.PostPurchaseInvoice(setOfPurchaseInvoiceIds,false); 

system.debug('Message>>' + objResponse.ResponseMessage);

system.debug('purchaseInvoices>>' + objResponse.purchaseInvoices);

//*********************End Sample Post Purchase Invoice Code***************************************************//