Accounting Apex API Developer Reference

c2g.CODAAPIPurchaseCreditNote_7_0

global with sharing class CODAAPIPurchaseCreditNote_7_0

the service class relating to purchase credit notes.

This class contains deprecated items.

Properties

Name Type Description
VERSION_STRING string the api version.
SERVICE_NAME string the name of the service.

Methods

GetAPIVersion

webService static string GetAPIVersion()

Used to get the latest API version.

Return Value

Text

GetServiceName

webService static String GetServiceName()

Used to get the name of the service.

Return Value

Text

PostPurchaseCreditNote

webService static void PostPurchaseCreditNote(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to post a purchase credit note. Use the PayableCreditNotePost (Post Payable Credit Notes) custom permission to grant permissions on this service.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes. Does not need to be the current company.
value c2g.CODAAPICommon.Reference Identifies the purchase credit note you want to post.

Return Value

This web service does not return a value.

BulkPostPurchaseCreditNote

webService static void BulkPostPurchaseCreditNote(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICommon.Reference[] values)

This service allows you to post purchase credit notes in bulk. Use the PayableCreditNotePost (Post Payable Credit Note) custom permission to grant permissions on this service.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes. Does not need to be the current company.
values c2g.CODAAPICommon.Reference[] Identifies the purchase credit notes you want to post.

Return Value

This web service does not return a value.

Deprecated

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

Methods

CreatePurchaseCreditNote

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPICommon.Reference CreatePurchaseCreditNote(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote value)

This service allows you to create a purchase credit note (also known as payable credit note). See "Payable Credit Note Fields" and "What is a Payable Credit Note" in the FinancialForce Help for more details. Use PayableCreditNoteSave (Save Payable Credit Notes) custom permission to grant permissions on this method.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote Holds details of the purchase credit note you want to create.

Return Value

This web service returns a CODAAPICommon.Reference object.

UpdatePurchaseCreditNote

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPICommon.Reference UpdatePurchaseCreditNote(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote value)

This service allows you to update a purchase credit note. Use PayableCreditNoteEdit (Edit Payable Credit Notes) custom permission to grant permissions on this method.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote Holds details of the purchase credit note you want to update.

Return Value

This web service returns a CODAAPICommon.Reference object.

GetPurchaseCreditNote

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote GetPurchaseCreditNote(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to retrieve a purchase credit note.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPICommon.Reference Identifies the purchase credit note you want to retrieve.

Return Value

This web service returns a c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote object.

BulkCreatePurchaseCreditNote

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPICommon.Reference[] BulkCreatePurchaseCreditNote(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote[] values)

This service allows you to create purchase credit notes in bulk. Use PayableCreditNoteSave (Save Payable Credit Notes) custom permission to grant permissions on this method.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
values c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote[] Holds details of the purchase credit notes you want to create.

Return Value

This web service returns an array of CODAAPICommon.Reference objects.

BulkUpdatePurchaseCreditNote

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPICommon.Reference[] BulkUpdatePurchaseCreditNote(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote[] values)

This service allows you to update purchase credit notes in bulk. It also handles amending posted purchase credit notes and their related transactions. Use PayableCreditNoteEdit (Edit Payable Credit Notes) custom permission to grant permissions on this method.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
values c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote[] Holds details of the purchase credit notes you want to update.

Return Value

This web service returns an array of CODAAPICommon.Reference objects.

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.

//In addition to making updates, BulkUpdate can be used to amend, as this example shows
//using a reference to an existing credit note.
c2g.CODAAPICommon.Reference postedCreditRef = c2g.CODAAPICommon.getRef('a4m1I00000002l1QAA', null);
c2g.CODAAPICommon_7_0.Context context = new c2g.CODAAPICommon_7_0.Context();
c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote credit = c2g.CODAAPIPurchaseCreditNote_7_0.GetPurchaseCreditNote(context, postedCreditRef);

//detail the amendment
credit.CreditNoteDescription = 'AmendedDescription';
List<c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote> credits = new List<c2g.CODAAPIPurchaseCreditNoteTypes_7_0.PurchaseCreditNote>();
credits.add(credit);

//call the API
c2g.CODAAPIPurchaseCreditNote_7_0.BulkUpdatePurchaseCreditNote(context, credits);
© Copyright 2009–2022 FinancialForce.com, inc. All rights reserved. Various trademarks held by their respective owners.