Accounting Apex API Developer Reference

c2g.AmendPxService

global with sharing class AmendPxService

This service class provides document reversal functionality. Only journals are currently supported.

Methods

amendSync

global static void amendSync(List<c2g.AmendPxService.Document> changes)

This service allows you to amend documents synchronously.

Input Parameters

Name Type Description
changes List<c2g.AmendPxService.Document> A list of changes to be applied to posted documents.

amendAsync

global static ID amendAsync(List<c2g.AmendPxService.Document> changes)

This service allows you to amend documents asynchronously using an Apex Job. The amendAsync method can handle larger documents than the amendSync method.

Input Parameters

Name Type Description
changes List<c2g.AmendPxService.Document> A list of changes to be applied to posted documents.

Return Value

The ID of the async job. This can be monitored from the "Apex Jobs" page.

c2g.AmendPxService.Document

global abstract class Document

A container for the changes to apply to a document.

Properties

Name Type Description
documentId ID The ID of the document to amend.
description String The required description of the document.
amendDescription Boolean Set to 'true' if the description is to be amended.
subAnalysis Map<String, Object> A map of custom document field values to be amended (keyed by the field name).

c2g.AmendPxService.Journal

global class Journal extends Document

A specialised document for the changes to apply to a journal.

This class extends c2g.AmendPxService.Document

Properties

Name Type Description
reference String The required reference of the journal.
amendReference Boolean Set to 'true' if the reference is to be amended.
lineItems List<c2g.AmendPxService.JournalLine> A list of the journal lines to amend.

c2g.AmendPxService.Line

global abstract class Line

A container for the changes to apply to a document line.

Properties

Name Type Description
lineId ID The ID of the document line to amend.
lineDescription String The required description of the line.
amendLineDescription Boolean Set to 'true' if the description is to be amended.
subAnalysis Map<String, Object> A map of custom line field values to be amended (keyed by the field name).

c2g.AmendPxService.JournalLine

global class JournalLine extends Line

This class extends c2g.AmendPxService.Line

Properties

Name Type Description
dimension1 ID The required Dimension 1 ID of the line.
amendDimension1 Boolean Set to 'true' if Dimension 1 is to be amended.
dimension2 ID The required Dimension 2 ID of the line.
amendDimension2 Boolean Set to 'true' if Dimension 2 is to be amended.
dimension3 ID The required Dimension 3 ID of the line.
amendDimension3 Boolean Set to 'true' if Dimension 3 is to be amended.
dimension4 ID The required Dimension 4 ID of the line.
amendDimension4 Boolean Set to 'true' if Dimension 4 is to be amended.
© Copyright 2009–2021 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.