Accounting Apex API Developer Reference

c2g.CODAAPICreditNoteTypes_10_0

global with sharing class CODAAPICreditNoteTypes_10_0

The service class relating to Sales Credit Notes.

Enums

enumCreditNoteReason

Possible reasons for a credit note.

Value Description
DamagedGoods The reason for the credit note is Damaged Goods.
GoodsReturned The reason for the credit note is Goods Returned.
IncorrectShipment The reason for the credit note is Incorrect Shipment.
Overcharge The reason for the credit note is Overcharge.
RetrospectiveDiscount The reason for the credit note is Retrospective Discount.
None The reason for the credit note is None.

enumCreditNoteStatus

Possible sales credit note statuses.

Value Description
InProgress The document has been saved, but has not been posted.
ReadyToPost The document has been batched up for posting by a scheduled job.
Complete The document has been posted.
Discarded The document is no longer required, but evidence needs to be retained. You must provide discard reason.

enumPrintStatus

Possible sales credit note statuses.

Value Description
NotPrinted The document has not been printed.
Printed The document has been printed.

c2g.CODAAPICreditNoteTypes_10_0.CreditNote

global with sharing class CreditNote

Holds information that applies to the whole sales credit note and acts as a container for a number of sales credit note line items. See "Sales Credit Note Fields" and "What is a Sales Credit Note" in the FinancialForce Help for more details.

Properties

Name Type Description
Id id Globally unique string that identifies the record.
OwnerId c2g.CODAAPICommon.Reference ID of the user who owns this record.
IsDeleted boolean Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
Name string Unique number allocated to this sales credit note.
CreatedDate datetime Date and time when this record was created.
CreatedById c2g.CODAAPICommon.Reference ID of the user who created this record.
LastModifiedDate datetime Date and time when this record was last modified by a user.
LastModifiedById c2g.CODAAPICommon.Reference ID of the user who last updated this record.
SystemModstamp datetime Date and time when this record was last modified by a user or by a workflow process (such as a trigger).
Account c2g.CODAAPICommon.Reference Customer account for which you want to create a sales credit note. Mandatory.
CopyAccountValues boolean For internal use only.
CopyDefaultPrintedTextDefinitions boolean For internal use only.
CreditNoteCurrency c2g.CODAAPICommon.Reference Currency in which monetary values are expressed on the sales credit note. Mandatory.
CreditNoteRate decimal The exchange rate for document to home currency.
DualRate decimal The exchange rate for home to dual currency.
CreditNoteDate date Date of the sales credit note. Mandatory.
CreditNoteDescription string Description of the sales credit note.
CreditNoteReason c2g.CODAAPICreditNoteTypes_10_0.enumCreditNoteReason Reasons for the sales credit note.
CreditNoteStatus c2g.CODAAPICreditNoteTypes_10_0.enumCreditNoteStatus Current status of the sales credit note. Mandatory.
CreditNoteTotal decimal Total credit note value, including the tax.
CustomerReference string Customer reference, such as a customer order or returns note number.
DeriveCurrency boolean For internal use only.
DeriveDueDate boolean For internal use only.
DerivePeriod boolean For internal use only.
Dimension1 c2g.CODAAPICommon.Reference Reference to a dimension by which you want to analyze this account.
Dimension2 c2g.CODAAPICommon.Reference Reference to a dimension by which you want to analyze this account.
Dimension3 c2g.CODAAPICommon.Reference Reference to a dimension by which you want to analyze this account.
Dimension4 c2g.CODAAPICommon.Reference Reference to a dimension by which you want to analyze this account.
DiscardReason string Reason why the credit note was discarded.
DueDate date Date the credit note is due for payment. Mandatory.
InvoiceDate date Date of the related sales invoice, if relevant.
Invoice c2g.CODAAPICommon.Reference Reference to the related invoice.
MatchTypeRef string This field is not applicable to credit notes.
Opportunity c2g.CODAAPICommon.Reference Reference to the opportunity to which this credit note is related, if relevant.
OutstandingValue decimal Amount still owed on this document in document currency.
OwnerCompany c2g.CODAAPICommon.Reference Reference to the Company to which this document belongs.
PaymentStatus string Is this document unpaid, part-paid, or paid in full?
Period c2g.CODAAPICommon.Reference Reference to the accounting period in which this document falls. Mandatory.
PrintStatus c2g.CODAAPICreditNoteTypes_10_0.enumPrintStatus Current print status.
PrintedText1AllowEdit boolean Indicates whether the text definition in text position 1 is editable. Mandatory.
PrintedText1Heading string Heading at text position 1.
PrintedText1TextDefinitionName string Name of selected text definition.
PrintedText1Text string Body text at text position 1.
PrintedText2AllowEdit boolean Indicates whether the text definition in text position 2 is editable. Mandatory.
PrintedText2Heading string Heading at text position 2.
PrintedText2TextDefinitionName string Name of selected text definition.
PrintedText2Text string Body text at text position 2.
PrintedText3AllowEdit boolean Indicates whether the text definition in text position 3 is editable. Mandatory.
PrintedText3Heading string Heading at text position 3.
PrintedText3TextDefinitionName string Name of selected text definition.
PrintedText3Text string Body text at text position 3.
PrintedText4AllowEdit boolean Indicates whether the text definition in text position 4 is editable. Mandatory.
PrintedText4Heading string Heading at text position 4.
PrintedText4TextDefinitionName string Name of selected text definition.
PrintedText4Text string Body text at text position 4.
PrintedText5AllowEdit boolean Indicates whether the text definition in text position 5 is editable. Mandatory.
PrintedText5Heading string Heading at text position 5.
PrintedText5TextDefinitionName string Name of selected text definition.
PrintedText5Text string Body text at text position 5.
SalesTaxDocumentCode string A unique code that identifies the document in the external tax calculation system (if applicable).
SalesTaxStatus string The status of the external sales tax calculation (if applicable): Not Calculated, Calculated, Finalized.
TaxCode1 c2g.CODAAPICommon.Reference Tax code 1.
TaxCode2 c2g.CODAAPICommon.Reference Tax code 2.
TaxCode3 c2g.CODAAPICommon.Reference Tax code 3.
TaxTotal decimal Total value of tax on the credit note (Tax1Total + Tax2Total + Tax3Total).
TransactionRef c2g.CODAAPICommon.Reference Number of the transaction created when the credit note was posted.
Year string Name of the year.
NetTotal decimal Total value of items on the credit note, before tax. SUM: CreditNoteLineItem: NetValue
Tax1Total decimal Total value of tax posted to tax code 1. SUM: CreditNoteLineItem: TaxValue
Tax2Total decimal Total value of tax posted to tax code 2. SUM: CreditNoteLineItem: TaxValue
Tax3Total decimal Total value of tax posted to tax code 3. SUM: CreditNoteLineItem: TaxValue
LineItems c2g.CODAAPICreditNoteLineItemTypes_10_0.CreditNoteLineItems Reference to the associated credit note line items. Mandatory.
CustomFields List<c2g.CODAAPICreditNoteTypes_10_0.CustomField> Reference to the list of user-defined fields that have been exposed with a type 1 integration rule.

c2g.CODAAPICreditNoteTypes_10_0.CustomField

global with sharing class CustomField implements CODAAPICommon.IAPICustomField

Holds the information about the user-defined fields that have been exposed with a type 1 integration rule See "Integration Rules - Type 1" in the FinancialForce Help for more details.
The same read and write permissions granted for the FinancialForce application extend to the FinancialForce API.

Properties

Name Type Description
FieldName string Name of the user-defined field.
Value string Value of the user-defined field.

c2g.CODAAPICreditNoteTypes_10_0.CreditNoteForAmend

global with sharing class CreditNoteForAmend

Represents information that allows you to amend the header on a posted credit note.

Properties

Name Type Description
CreditNote c2g.CODAAPICommon.Reference Reference to the sales credit note to be amended. Mandatory.
CustomerReference String Customer reference such as a customer order number. This will appear on the printed credit note.
DueDate Date Date the credit note is due for payment.
CreditNoteDescription String Description of the credit note.
CreditNoteReason c2g.CODAAPICreditNoteTypes_10_0.enumCreditNoteReason Reasons for the credit note.
AccountDimension1 c2g.CODAAPICommon.Reference Reference to the Dimension1 record by which you want to analyze this account. Mandatory if AccountDimension1Specified is true.
AccountDimension1Specified Boolean If AccountDimension1Specified is true, the value in AccountDimension1 is applied to Dimension1 on the header. If AccountDimension1 is null, the value in Dimension 1 on the header is deleted. If AccountDimension1Specified is false, the Dimension1 value on the header is not updated.
AccountDimension2 c2g.CODAAPICommon.Reference Reference to the Dimension2 record by which you want to analyze this account. Mandatory if AccountDimension2Specified is true.
AccountDimension2Specified Boolean If AccountDimension2Specified is true, the value in AccountDimension2 is applied to Dimension2 on the header. If AccountDimension2 is null, the value in Dimension 2 on the header is deleted. If AccountDimension2Specified is false, the Dimension2 value on the header is not updated.
AccountDimension3 c2g.CODAAPICommon.Reference Reference to the Dimension3 record by which you want to analyze this account. Mandatory if AccountDimension3Specified is true.
AccountDimension3Specified Boolean If AccountDimension3Specified is true, the value in AccountDimension3 is applied to Dimension3 on the header. If AccountDimension3 is null, the value in the Dimension3 on the header is deleted. If AccountDimension3Specified is false, the Dimension3 value on the header is not updated.
AccountDimension4 c2g.CODAAPICommon.Reference Reference to the Dimension4 record by which you want to analyze this account. Mandatory if AccountDimension4Specified is true.
AccountDimension4Specified Boolean If AccountDimension4Specified is true, the value in AccountDimension4 is applied to Dimension4 on the header. If AccountDimension4 is null, the value in the Dimension4 on the header is deleted. If AccountDimension4Specified is false, the Dimension4 value on the header is not updated.
© Copyright 2009–2020 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.