Transcription
Revenue Recognition on Salesforce Winter 2019 API ReferenceGuide11/27/2019
Table of ContentsAbout this Guide.4What's New.5Overview .6API Supported Packages.6API Standards and Development Platforms .6Standards . 6Development Platforms . 7Field Types .7Revenue Recognition APIs .8Revenue Web Service Class .8Close Revenue Period. 8Computing Actual Amounts for Fee Schedules . 9Generating Revenue Schedules . 11Generate Revenue Schedules and Terminate Agreement. 11RevRec Action Class . 12Allow Generate Revenue . 13Allow Rollback Revenue. 14Check Milestone Dependents . 15Closing the Revenue Period. 16Create Forecast Revenue Snapshot . 16Generate Agreement Fee Schedules . 17Generate Forecast Revenue Schedule . 18Generate Forecast Revenue Snapshot . 19Generate Revenue Schedule. 20Generate Revenue Schedules and Terminate the Agreement. 21Generate Revenue Snapshot. 21Get RevRec Forecast Period . 22Rollback Forecast Revenue Schedules. 23Rollback Revenue Period. 24
Rollback Revenue Schedules . 24Updating Actual Percent Complete on Agreement Fee . 25Updating Agreement Fee Schedules. 26Updating Budget Amount in Fee Schedules. 27Updating Budget from Forecast. 28Updating Fee Schedules from Agreement . 29Updating Forecast Fee from Schedules. 29Updating Forecast Fee Schedules . 30Updating Forecast Fee Schedules from Actuals. 31Updating Forecast Revenue Schedules With Actuals. 32Update Currency of Milestone Dependents. 33Processing Revenue Run. 34Deprecated APIs. 36Apttus Copyright Disclaimer . 38
Revenue Recognition on Salesforce Winter 2019 API Reference GuideAbout this GuideApttus provides Application Programming Interfaces (API) for you to extend the features offered by ApttusRevenue Recognition. These extensions add more functionality to the features available throughconfiguration on Salesforce.4Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideWhat's NewThe following table lists changes in the documentation to support each release.DocumentTopicDescriptionWinter 2019N/ANo new features were added for this release. Theguide was updated to reflect product namechanges.Summer 2019Processing Revenue RunNew topic. New API introduced in this release.Spring 2019N/ANo new APIs are added for this release. The guideis updated to reflect product name changes.Winter 2018N/ANo new APIs are added for this release. The guideis updated to reflect product name changes.5Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideOverview API Supported PackagesThe package names and version numbers required for the APIs to work seamlessly. API Standards and Development PlatformsApttus APIs are based on Salesforce APIs and use the same standards and platforms. Field TypesApttus APIs use a subset of the supported data and field types on Salesforce.API Supported PackagesThe following packages and dependent packages are required for Revenue Recognition APIs.ProductLatest Certified Version(Name Number)Apttus Revenue Management (New)5.3.135 5.135Apttus Configuration & Pricing10.6.1403.14 10.1403.14Apttus Contract Management9.0.0393.1 9.393.1Apttus Contract-Configuration Integration9.6.0091 9.91Apttus Revenue-Configuration Integration (New)2.1.0011 2.11API Standards and Development PlatformsApttus APIs are based on Salesforce APIs and use the same standards and platforms.StandardsNameReferenceSimple Object Access Protocol (SOAP) 1.1http://www.w3.org/TR/2000/NOTE-SOAP-20000508Web Service Description Language (WSDL) I Basic Profile 004-08-24.html6Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideDevelopment PlatformsApttus SOAP API works with standard SOAP development environments. For a list of compatibledevelopment platforms, see Salesforce Developer Force API details.Field TypesApttus APIs use a subset of the supported data and field types on Salesforce.The following table lists the field types that Apttus supports. For a comprehensive list of all field typessupported by Salesforce, see Salesforce Data Types.TypeDescriptionBooleanThe Boolean field has a true(or 1) or false(or 0) value.Data objectThe Data Object field is an ID type and is represented by CPQ.nnDO in thisdocument.DateThe Date field contains date values only and do not contain relevant timevalues. Time in a date field is always set to midnight in the UTC time zone. Ifyou want a timestamp you must use a dateTime field.DecimalThe Decimal field provides an exact numeric value and you can arbitrarily sizethe precision and scale of the value.IDThe ID field is an alphanumeric field that acts as the primary key for a specificrecord associated with an object. The ID value includes a three-character codethat identifies which object the record is associated with. The ID for a specificrecord does not change.For some objects, this field may also be a reference type value, which containsthe ID value for a related record. They are identified by field names ending in'Id', such as priceListId. The ID field acts like foreign keys and their values canbe changed using an update() call.IntegerThe Integer field contains whole numbers only. There are no digits after thedecimal.ListThe List field includes a fixed set of values from which you must select a singlevalue. Picklists are available as drop-down lists. If a picklist is unrestricted, theAPI does not limit entries to only currently active values.StringThe String field contains text and may have different length restrictions basedon the data you store in the specific field. For instance, City may be limited to50 characters, while AddressLine1 is limited to 255 characters.7Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideRevenue Recognition APIsRevenue Recognition APIs belong to the following classes. Revenue Web Service Class RevRec Action ClassRevenue Web Service ClassApttus Revenue APIs are based on Salesforce APIs and use the same standards and platforms.You can invoke Apttus Revenue Recognition APIs belonging to the RevenueWebService Class from thefollowing command:Apttus Revenue2.RevenueWebService. Name of the Function where the name of the function is API Name and it parameters.Here is a list of APIs along with their parameters: Close Revenue PeriodComputing Actual Amounts for Fee SchedulesGenerating Revenue SchedulesGenerate Revenue Schedules and Terminate AgreementClose Revenue PeriodcloseRevenuePeriod API closed the current revenue period and opens the next period to enable you torecognize revenue for the next month.result closeRevenuePeriod()Response Returns true if the Revenue Period is closed successfully.Returns false if the revenue period is not closed.Code Sample8Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideApttus mputing Actual Amounts for Fee SchedulescomputeActualAmountForFreeSchedules API computes the Actual Amount of the Agreement RevenueSchedules.feeSchedules computeActualAmountForFeeSchedules(feeID, schedules)This API computes the Actual Amount and Forecast Amount for Agreement Fee Schedules based onthe RevRec Rule set on the Agreement Fee. It returns the list of Agreement Fee Schedules. It alsoupdates the Actual Amount and Forecast Amount in the Agreement Fee Schedules.Request DIDYesID of the Agreement FeeschedulesList ID YesThe list of Agreement Fee Schedule IDsResponse ParameterResponseFieldTypeRequired? DescriptionschedulesList ID YesThe list of Agreement Fee Schedule IDsCode SampleID feeId 'a566A000000PRh5QAG';List Id feeScheduleIds new List Id ();feeScheduleIds.add('a566A000000PRh5QAG');Apttus eeSchedules(feeId,feeScheduleIds);9Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuidefeeSchedules computeActualAmountForFeeSchedules2(feeID, schedules)This API computes the Actual Amount and Forecast Amount for Agreement Fee Schedules based onthe RevRec Rule set on the Agreement Fee. It returns the list of Agreement Fee Schedules.Request DIDYesID of the Agreement FeeschedulesList Agreement Fee Schedule Object YesThe list of Agreement Fee ScheduleobjectResponse ParameterResponseFieldTypeRequired? DescriptionschedulesList ID YesThe list of Agreement Fee Schedule IDsCode SampleID feeId 'a566A000000PRh5QAG';List Apttus Revenue2 Agreement Fee Schedule feeSchedules newList Apttus Revenue2 Agreement Fee Schedule ();feeSchedules.add(new Apttus Revenue2 Agreement Fee Schedule (Id '', Name '', OtherData.));Apttus eeSchedules2(feeId,feeSchedules);10Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideGenerating Revenue SchedulesgenerateRevenueSchedules API generates Agreement Revenue Schedules for the current RevRec periodfor the provided agreement ID.result generateRevenueSchedules(ID agreementID)Request D of the agreement to generate revenue schedulesResponse ParameterResponseField TypeDescriptionresultReturns true if the agreement fee schedules are generated successfully.BooleanReturns false if the agreement fee schedules are not generated.Code SampleID feeId 'a566A000000PRh5QAG';Apttus Id);Generate Revenue Schedules and Terminate AgreementgenerateTerminateRevenueSchedule API generates Revenue Schedules for the agreement ID andterminates the agreement by setting RevRec Active flag as false.result terminateRevenueSchedule(agreementID)This API accepts agreement ID of an agreement and generates Revenue Schedules for that agreement.After generating revenue schedules, the agreement is terminated.Request Parameters11Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideRequestFieldType Required DescriptionagreementIDIDYesID of the AgreementResponse ParameterResponseField TypeDescriptionresultReturns true if the revenue schedules are generated successfully.BooleanReturns false if the revenue schedules are not generated.Code SampleID agreementID 'a566A000000PRh5QAG';Apttus e(agreementID);RevRec Action ClassApttus Revenue APIs are based on Salesforce APIs and use the same standards and platforms.You can invoke Apttus Revenue Recognition APIs belonging to the RevenueWebService Class from thefollowing command:Apttus Revenue2.RevRecAction. Name of the Function where the name of the function is API Name and it parameters.Here is a list of APIs along with their parameters: 12Allow Generate RevenueAllow Rollback RevenueCheck Milestone DependentsClosing the Revenue PeriodCreate Forecast Revenue SnapshotGenerate Agreement Fee SchedulesGenerate Forecast Revenue ScheduleGenerate Forecast Revenue SnapshotGenerate Revenue ScheduleCopyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference Guide Generate Revenue Schedules and Terminate the AgreementGenerate Revenue SnapshotGet RevRec Forecast PeriodRollback Forecast Revenue SchedulesRollback Revenue PeriodRollback Revenue SchedulesUpdating Actual Percent Complete on Agreement FeeUpdating Agreement Fee SchedulesUpdating Budget Amount in Fee SchedulesUpdating Budget from ForecastUpdating Fee Schedules from AgreementUpdating Forecast Fee from SchedulesUpdating Forecast Fee SchedulesUpdating Forecast Fee Schedules from ActualsUpdating Forecast Revenue Schedules With ActualsUpdate Currency of Milestone DependentsProcessing Revenue RunDeprecated APIsAllow Generate RevenueallowGenerateRevenue API checks if the Generate Revenue Action is allowed for the given Agreementand Legal Entity.result allowGenerateRevenue2(agreementID, legalEntityID)This API accepts the agreement ID and legal entity ID as input parameters. It checks the RevRec Activeflag and returns 1 if it selected.Request ParametersRequestFieldType Required DescriptionagreementIDIDYesID of the Agreement.legalEntityIDIDYesID of the Legal EntityResponse Parameter13Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference rns 1 if the RevRec Active checkbox is selected.Returns 0 if the RevRec Active checkbox is clear.Code SampleID agreementId 'a566A000000PRh5QAG';ID legalEntityId 'a566A000000PRh87GH';Apttus Revenue2.RevRecAction. allowGenerateRevenue2(agreementId, legalEntityId);Allow Rollback RevenueallowRollbackRevenue API checks if the Rollback Revenue Action is allowed for the given Agreement andLegal Entity.result allowRollbackRevenue(agreementID, legalEntityID)This API accepts the agreement ID and legal entity ID as input parameters. It checks if the RecRec Activeflag is selected and Agreement RevRec Period Date is greater than the Current RevRec Period.Request ParametersRequestFieldType Required DescriptionagreementIDIDYesID of the Agreement.legalEntityIDIDYesID of the Legal EntityResponse Parameter14Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference rns 1 if the Agreement RevRec Period Date is greater than the Current RevRecPeriod.Returns 0 if the Agreement RevRec Period Date is less than the Current RevRec Period.Code SampleID agreementId 'a566A000000PRh5QAG';ID legalEntityId 'a566A000000PRh87GH';Apttus Revenue2.RevRecAction. allowRollbackRevenue(agreementId, legalEntityId);Check Milestone DependentscheckIfMilestoneHasDependents API checks whether any dependent record exists for Agreement Fee,Agreement Prepay or Agreement Trueup for the given Milestone ID.result checkIfMilestoneHasDependents(milestoneID)This API accepts milestone ID as an input parameter and checks if any dependent record exists forAgreement Fee, Agreement Prepay or Agreement Trueup for the given Milestone ID.Request ParametersRequestFieldType Required DescriptionmilestoneIDIDYesID of the Agreement MilstoneResponse ParameterResponseField TypeDescriptionresultReturns true if the agreement record has dependentsIntegerReturns false if the agreement record has no dependents15Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideCode SampleID milestoneId 'a566A000000PRh5QAG';Apttus s(milestoneId);Closing the Revenue PeriodcloseRevenuePeriod API closed the current revenue period and opens the next period to enable you torecognize revenue for the next month.result closeRevenuePeriod()Response Returns true if the Revenue Period is closed successfully.Returns false if the revenue period is not closed.Code SampleApttus Revenue2.RevRecAction.closeRevenuePeriod();Create Forecast Revenue SnapshotcreateForecastRevenueSnapshot API creates a snapshot of the Revenue Forecast for the givenAgreement ID.16Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference Guideresult createForecastRevenueSnapshot(agreementID, snapshotName)This API accepts agreement ID and name of the snapshot as input parameters. It creates a forecastrevenue snapshot for the agreement ID.Request mentIDIDYesID of the Agreement.snapshotNameStringYesName of the snapshot. Revenue Snapshot is created with thisname.Response Returns true if the forecast revenue snapshot is created.Returns false if the forecast revenue snapshot is not created.Code SampleID agreementId 'a566A000000PRh5QAG';String snapshotName 'JanuarySnapshot'Apttus mActuals(agreementId,snapshotName);Generate Agreement Fee SchedulesgenerateFeeSchedule API generates Agreement Fee Schedules for a given agreement fee ID. AgreementFee Schedules are generated for each period based on the Start Date and the End Date defined on theAgreement Fee.17Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference Guideresult generateFeeSchedule(feeID)This API accepts agreement feeID and generates Agreement Fee Schedules for that agreement fee.Request ParametersRequestField Type Required DescriptionfeeIDIDYesID of the Agreement FeeResponse ParameterResponseField TypeDescriptionresultReturns true if the agreement fee schedules are generated successfully.BooleanReturns false if the agreement fee schedules are not generated.Code SampleID feeId 'a566A000000PRh5QAG';Apttus enerate Forecast Revenue SchedulegenerateForecastRevenueSchedule API generates Forecast Revenue Schedules for a given agreement ID.This API also updates the Agreement, Agreement Fee, Agreement Prepay, Agreement Trueup andForecast Revenue Summary records. Forecast Revenue Snapshots are also created.result generateForecastRevenueSchedule(agreementID)This API accepts agreement ID and generates Forecast Revenue Schedules for that agreement.Request Parameters18Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideRequestFieldType Required DescriptionagreementIDIDYesID of the AgreementResponse ParameterResponseField TypeDescriptionresultReturns true if the forecast revenue schedules are generated successfully.BooleanReturns false if the forecast revenue schedules are not generated.Code SampleID agreementID 'a566A000000PRh5QAG';Apttus ule(agreementID);Generate Forecast Revenue SnapshotgenerateForecastRevenueSnapshot API deletes the existing Forecast Revenue Snapshot and createsan updated Forecast Revenue Snapshot for an agreement.result generateForecastRevenueSnapshot(agreementID)This API accepts agreement ID of an agreement and generates Forecast Revenue Snapshot for thatagreement.Request ParametersRequestFieldType Required DescriptionagreementIDIDYesID of the AgreementResponse Parameter19Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideResponseField TypeDescriptionresultReturns true if the Forecast Revenue Snapshot is generated successfully.BooleanReturns false if the Forecast Revenue Snapshot is not generated.Code SampleID agreementID 'a566A000000PRh5QAG';Apttus hot(agreementID);Generate Revenue SchedulegenerateFeeSchedule API generates Revenue Schedules for a given agreement ID. This API also updatesthe Agreement, Agreement Fee, Agreement Prepay, Agreement Trueup and Revenue Summary records.Revenue Snapshots are also created.result generateRevenueSchedule(agreementID)This API accepts agreement ID and generates Revenue Schedules for that agreement.Request ParametersRequestFieldType Required DescriptionagreementIDIDYesID of the AgreementResponse ParameterResponseField TypeDescriptionresultReturns true if the revenue schedules are generated successfully.BooleanReturns false if the revenue schedules are not generated.20Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideCode SampleID agreementID 'a566A000000PRh5QAG';Apttus ementID);Generate Revenue Schedules and Terminate the AgreementgenerateTerminateRevenueSchedule API generates Revenue Schedules for the agreement ID andterminates the agreement by setting RevRec Active flag as false.result generateTerminateRevenueSchedule(agreementID)This API accepts agreement ID of an agreement and generates Revenue Schedules for that agreement.After generating revenue schedules, the agreement is terminated.Request ParametersRequestFieldType Required DescriptionagreementIDIDYesID of the AgreementResponse ParameterResponseField TypeDescriptionresultReturns true if the revenue schedules are generated successfully.BooleanReturns false if the revenue schedules are not generated.Code SampleID agreementID 'a566A000000PRh5QAG';Apttus dule(agreementID);Generate Revenue SnapshotgenerateRevenueSnapshot API generates Revenue Snapshot for an agreement.21Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference Guideresult generateRevenueSnapshot(agreementID)This API accepts agreement ID of an agreement and generates Revenue Snapshot for that agreement.Request ParametersRequestFieldType Required DescriptionagreementIDIDYesID of the AgreementResponse ParameterResponseField TypeDescriptionresultReturns true if the Revenue Snapshot is generated successfully.BooleanReturns false if the Revenue Snapshot is not generated.Code SampleID agreementID 'a566A000000PRh5QAG';Apttus ementID);Get RevRec Forecast PeriodgetRevRecForecastPeriodNumber API returns the revenue forecast period number for the given agreementID.result getRevRecForecastPeriodNumber(agreementID)This API accepts the agreement ID input parameter and returns the revenue forecast period for it.Request Parameters22Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideRequestFieldType Required DescriptionagreementIDIDYesID of the Agreement.Response ntegerThe forecast period numberCode SampleID agreementId 'a566A000000PRh5QAG';Apttus r(agreementId);Rollback Forecast Revenue SchedulesrollbackForecastRevenueSchedule API rollbacks forecast revenue schedules for a given agreement ID. Thevalues of Agreement Trueup, Agreement Fee, and Agreement records are updated. It also deletes ForecastRevenue Schedules, Prepay, Revenue Summary, Forecast Snapshot, and task history records.result rollbackForecastRevenueSchedule(agreementID)This API accepts agreement ID and rollbacks the Forecast Revenue Schedules for that agreement.Request ParametersRequestFieldType Required DescriptionagreementIDIDYesID of the AgreementResponse Parameter23Copyright 2011-2019 Apttus Corporation. All rights reserved.
Revenue Recognition on Salesforce Winter 2019 API Reference GuideResponseField TypeDescriptionresultReturns true if the Forecast revenue schedules are rollbacked successfully.BooleanReturns false if the Forecast revenue schedules are not rollbacked.Code SampleID agreementID 'a566A000000PRh5QAG';Apttus ule(agreementID);Rollback Revenue PeriodrollbackRevenuePeriod API allows you to reopen the previous revenue period. rollbackRevenuePeriod APIchanges the current period date to the last date of the previous period.result rollbackRevenuePeriod()Request nReturns true if the Revenue Period is rolled back successfully.Returns false if the revenue period is not rolled back.Code SampleApt
Revenue Recognition on Salesforce Winter 2019 API Reference Guide . call. Integer The Integer field contains whole numbers only. There are no digits after the . If a picklist is unrestricted, the API does not limit entries to only currently active values. String The String field contains text and may have different length restrictions based .
