Accounting Apex API Developer Reference

c2g.ArchiveSetsService

global with sharing class ArchiveSetsService

The service class relating to Archive Set.

Enums

DocumentType

The value of the Document Type to be included in the Archive set.

Value Description
ARDocuments Enables you to include Account Receivable documents in the Archive set.

Methods

createArchiveSet

global static Id createArchiveSet(c2g.ArchiveSetsService.ArchiveSet archiveSet)

Method to create Archive Set.

Input Parameters

Name Type Description
archiveSet c2g.ArchiveSetsService.ArchiveSet Holds an object of c2g.ArchiveSetsService.ArchiveSet.

Return Value

Id of ArchiveSet record.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//Create object of c2g.ArchiveSetsService.ArchiveSet
c2g.ArchiveSetsService.ArchiveSet archiveSet = new c2g.ArchiveSetsService.ArchiveSet();
archiveSet.CompanyId = 'a1c0O000000eUCy';
archiveSet.DocumentType = c2g.ArchiveSetsService.DocumentType.ARDocuments;
archiveSet.selectedYearId = 'a2u0O000000ebiJ';
archiveSet.fromPeriodId = 'a2U0O000000cpls';
archiveSet.toPeriodId = 'a2U0O000000cplt';

Id archiveSetId = c2g.ArchiveSetsService.createArchiveSet(archiveSet);

runArchiving

global static void runArchiving(Id archiveSetId)

Method to run batch for Archiving.

Input Parameters

Name Type Description
archiveSetId Id Holds an id of ArchiveSet record.

discard

global static void discard(Id archiveSetId)

Method to discard Archive Set.

Input Parameters

Name Type Description
archiveSetId Id Holds an id of ArchiveSet record.

c2g.ArchiveSetsService.ArchiveSet

global with sharing class ArchiveSet

Holds information of the Archive Set

Properties

Name Type Description
DocumentType c2g.ArchiveSetsService.DocumentType Document Type.
CompanyId Id Holds Id of Company.
SelectedYearId Id Holds Id of selected Year.
FromPeriodId Id Holds Id of from period.
ToPeriodId Id Holds Id of to period.
CreateSummarizationJournal Boolean Holds Value of Create Summarization Journal.

Methods

ArchiveSet

global ArchiveSet()

Return Value

This constructor does not return a value.

© Copyright 2009–2019 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.