Accounting Apex API Developer Reference

c2g.DocumentAmendService

global with sharing class DocumentAmendService

The service class relating to amending posted documents.

Methods

amendInvoices

global static void amendInvoices(List<c2g.DocumentAmendService.Invoice> invoices)

This service allows you to amend posted sales invoices that have custom fields set up for sub-analysis mapping. Use the SalesInvoiceAmend (Amend Sales Invoice) custom permission to grant permissions on this method.

Input Parameters

Name Type Description
invoices List<c2g.DocumentAmendService.Invoice> Holds details of the sales invoices that you want to amend.

amendCreditNotes

global static void amendCreditNotes(List<c2g.DocumentAmendService.CreditNote> creditNotes)

This service allows you to amend posted sales credit notes that have custom fields set up for sub-analysis mapping. Use the SalesCreditNoteAmend (Amend Sales Credit Notes) custom permission to grant permissions on this method.

Input Parameters

Name Type Description
creditNotes List<c2g.DocumentAmendService.CreditNote> Holds details of the sales credit notes that you want to amend.

amendPurchaseInvoices

global static void amendPurchaseInvoices(List<c2g.DocumentAmendService.PurchaseInvoice> purchaseInvoices)

This service allows you to amend posted purchase invoices that have custom fields set up for sub-analysis mapping. Use the PayableInvoiceAmend (Amend Payable Invoices) custom permission to grant permissions on this method.

Input Parameters

Name Type Description
purchaseInvoices List<c2g.DocumentAmendService.PurchaseInvoice> Holds details of the purchase invoices that you want to amend.

amendPurchaseCreditNotes

global static void amendPurchaseCreditNotes(List<c2g.DocumentAmendService.PurchaseCreditNote> purchaseCreditNotes)

This service allows you to amend posted purchase credit notes that have custom fields set up for sub-analysis mapping. Use the PurchaseCreditNoteAmend (Amend Payable Credit Notes) custom permission to grant permissions on this method.

Input Parameters

Name Type Description
purchaseCreditNotes List<c2g.DocumentAmendService.PurchaseCreditNote> Holds details of the purchase credit notes that you want to amend.

amendJournals

global static void amendJournals(List<c2g.DocumentAmendService.Journal> journals)

This service allows you to amend posted journals that have custom fields set up for sub-analysis mapping. Use the JournalAmend (Amend Journals) custom permission to grant permissions on this service.

Input Parameters

Name Type Description
journals List<c2g.DocumentAmendService.Journal> Holds details of the journals that you want to amend.

amendCashEntries

global static void amendCashEntries(List<c2g.DocumentAmendService.CashEntry> cashEntries)

This service allows you to amend posted Cash entries that have custom fields set up for sub-analysis mapping.

Input Parameters

Name Type Description
cashEntries List<c2g.DocumentAmendService.CashEntry> Holds details of the cash entries that you want to amend.

c2g.DocumentAmendService.Document

global abstract with sharing class Document

Holds document details that can be amended after the document has been posted. Where the value for a field is null the c2g.DocumentAmendService will set that field's value to null on the document, so if you want a value to be unchanged you must populate that field with its current value.

Properties

Name Type Description
DocumentId Id Unique string that identifies the document.
DueDate Date The document's due date.
Description String The document description.
Dimension1 Id The document's Dimension 1 value.
Dimension2 Id The document's Dimension 2 value.
Dimension3 Id The document's Dimension 3 value.
Dimension4 Id The document's Dimension 4 value.
SubAnalysis Map<String, Object> Holds a list of custom fields and values that have been set up for sub-analysis mapping.
LineItems List<c2g.DocumentAmendService.Line> Holds values that you want to amend at line level. You only need to supply the values that you want to amend.

Methods

Document

global Document()

Creates an API version of an empty document object for use with the DocumentAmendService.

c2g.DocumentAmendService.Invoice

global with sharing class Invoice extends Document

Holds details that can be amended after the invoice has been posted. Where the value for a field is null the c2g.DocumentAmendService will set that field's value to null on the invoice, so if you want a value to be unchanged you must populate that field with its current value.

This class extends c2g.DocumentAmendService.Document

Properties

Name Type Description
CustomerReference String Customer reference such as a customer order number.
PaymentScheduleDueDates List<Date> The list of payment due dates if a payment schedule is attached to the sales invoice.

Methods

Invoice

global Invoice()

Creates an API version of an empty sales invoice object for use with the DocumentAmendService.

c2g.DocumentAmendService.CreditNote

global with sharing class CreditNote extends Document

Holds details that can be amended after the credit note has been posted. Where the value for a field is null the c2g.DocumentAmendService will set that field's value to null on the credit note, so if you want a value to be unchanged you must populate that field with its current value.

This class extends c2g.DocumentAmendService.Document

Properties

Name Type Description
CustomerReference String Customer reference such as a customer order or returns note number.
CreditNoteReason String The reason for the credit note.

Methods

CreditNote

global CreditNote()

Creates an API version of an empty sales credit note object for use with the DocumentAmendService.

c2g.DocumentAmendService.PurchaseInvoice

global with sharing class PurchaseInvoice extends Document

Holds details that can be amended after the invoice has been posted. Where the value for a field is null the c2g.DocumentAmendService will set that field's value to null on the invoice, so if you want a value to be unchanged you must populate that field with its current value.

This class extends c2g.DocumentAmendService.Document

Properties

Name Type Description
DocumentReference1 String The invoice's Reference 1.
DocumentReference2 String The invoice's Reference 2.
ExpenseLines List<c2g.DocumentAmendService.Line> Holds values that you want to amend at line level. Where the value for a field is null the DocumentAmendService will set all line level field's value to null, so if you want field level values to remain unchanged you must populate those fields with their current values.

Methods

PurchaseInvoice

global PurchaseInvoice()

Creates an API version of an empty purchase invoice object for use with the DocumentAmendService.

c2g.DocumentAmendService.PurchaseCreditNote

global with sharing class PurchaseCreditNote extends Document

Holds details that can be amended after the credit note has been posted. Where the value for a field is null the c2g.DocumentAmendService will set that field's value to null on the credit note, so if you want a value to be unchanged you must populate that field with its current value.

This class extends c2g.DocumentAmendService.Document

Properties

Name Type Description
DocumentReference1 String The credit note's Reference 1.
DocumentReference2 String The credit note's Reference 2.
VendorInvoiceNumber String Invoice number on the credit note delivered by the vendor.
CreditNoteReason String The reason for the credit note.
ExpenseLines List<c2g.DocumentAmendService.Line> Holds values that you want to amend at line level. You only need to supply the values that you want to amend.

Methods

PurchaseCreditNote

global PurchaseCreditNote()

Creates an API version of an empty purchase credit note object for use with the DocumentAmendService.

c2g.DocumentAmendService.Journal

global with sharing class Journal

Holds details that can be amended after the journal has been posted. Where the value for a field is null the c2g.DocumentAmendService will set that field's value to null on the journal, so if you want a value to be unchanged you must populate that field with its current value.

Properties

Name Type Description
DocumentId Id Unique string that identifies the journal.
Description String The journal's description.
Reference String Any significant reference that might be useful to store on the journal.
SubAnalysis Map<String, Object> Holds a list of custom fields and values that have been set up for sub-analysis mapping.
LineItems List<c2g.DocumentAmendService.Line> Holds values that you want to amend at line level. You only need to supply the values that you want to amend.

Methods

Journal

global Journal()

Creates an API version of an empty journal object for use with the DocumentAmendService.

c2g.DocumentAmendService.CashEntry

global with sharing class CashEntry

Holds details that can be amended after the Cash Entry has been posted. Where the value for a field is null the c2g.DocumentAmendService will set that field's value to null on the cash entry, so if you want a value to be unchanged you must populate that field with its current value.

This class contains deprecated items.

Properties

Name Type Description
DocumentId Id Unique string that identifies the cash entry.
Description String The Cash entry's description.
Reference String The Cash entry's reference.
BankAccountDimension1Id Id The Bank Account Dimension 1 Id for this Cash Entry.
BankAccountDimension2Id Id The Bank Account Dimension 2 Id for this Cash Entry.
BankAccountDimension3Id Id The Bank Account Dimension 3 Id for this Cash Entry.
BankAccountDimension4Id Id The Bank Account Dimension 4 Id for this Cash Entry.
ChargesGLADimension1Id Id The Charges GLA Dimension 1 Id for this Cash Entry.
ChargesGLADimension2Id Id The Charges GLA Dimension 2 Id for this Cash Entry.
ChargesGLADimension3Id Id The Charges GLA Dimension 3 Id for this Cash Entry.
ChargesGLADimension4Id Id The Charges GLA Dimension 4 Id for this Cash Entry.
SubAnalysis Map<String, Object> Holds a list of custom fields and values that have been set up for sub-analysis mapping.
LineItems List<c2g.DocumentAmendService.CashEntryLine> Holds values that you want to amend at line level. You only need to supply the values that you want to amend.

Methods

CashEntry

global CashEntry()

Creates an API version of an empty cash entry object for use with the DocumentAmendService.

Deprecated

The following items are deprecated and not supported for use. We recommend that you stop using these items to avoid exceptions.

Properties

Name Type Description Deprecation Details
BankAccountDimension1 CODADimension1 The Bank Account Dimension 1 for this Cash Entry.
BankAccountDimension2 CODADimension2 The Bank Account Dimension 2 for this Cash Entry.
BankAccountDimension3 CODADimension3 The Bank Account Dimension 3 for this Cash Entry.
BankAccountDimension4 CODADimension4 The Bank Account Dimension 4 for this Cash Entry.
ChargesGLADimension1 CODADimension1 The Charges GLA Dimension 1 for this Cash Entry.
ChargesGLADimension2 CODADimension2 The Charges GLA Dimension 2 for this Cash Entry.
ChargesGLADimension3 CODADimension3 The Charges GLA Dimension 3 for this Cash Entry.
ChargesGLADimension4 CODADimension4 The Charges GLA Dimension 4 for this Cash Entry.

c2g.DocumentAmendService.CashEntryLine

global with sharing class CashEntryLine

Holds line details that can be amended after the document has been posted. You only need to supply the values that you want to amend.

Properties

Name Type Description
LineId Id Unique string that identifies the line.
AccountReference String The line's account reference.
LineDescription String The line's description.
AccountDimension1 Id The line's Account Dimension 1 value.
AccountDimension2 Id The line's Account Dimension 2 value.
AccountDimension3 Id The line's Account Dimension 3 value.
AccountDimension4 Id The line's Account Dimension 4 value.
SubAnalysis Map<String, Object> Holds a list of custom fields and values that have been set up for sub-analysis mapping at line level.

Methods

CashEntryLine

global CashEntryLine()

Creates an API version of an empty line object for use with the DocumentAmendService.

c2g.DocumentAmendService.Line

global with sharing class Line

Holds line details that can be amended after the document has been posted. You only need to supply the values that you want to amend.

Properties

Name Type Description
LineId Id Unique string that identifies the line.
LineDescription String The line's description.
Dimension1 Id The line's Dimension 1 value.
Dimension2 Id The line's Dimension 2 value.
Dimension3 Id The line's Dimension 3 value.
Dimension4 Id The line's Dimension 4 value.
SubAnalysis Map<String, Object> Holds a list of custom fields and values that have been set up for sub-analysis mapping at line level.

Methods

Line

global Line()

Creates an API version of an empty line object for use with the DocumentAmendService.

© Copyright 2009–2023 Certinia Inc. All rights reserved. Various trademarks held by their respective owners.