c2g.CODAAPICreditNoteTypes_10_0

global with sharing class CODAAPICreditNoteTypes_10_0

CreditNote
CustomField
CreditNoteForAmend

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.
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.
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.
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.
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.
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.
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.