-
Notifications
You must be signed in to change notification settings - Fork 2
CreditNote
PatrickLane edited this page Nov 13, 2014
·
2 revisions
Presentation of the CreditNote data structure. CreditNotes can be created for customers and suppliers.
CreditNote members
Name | Type | Description | Constraints |
---|---|---|---|
AccountAddress1 | String | Get/Set the customer/supplier account address 's first line. | |
AccountAddress2 | String | Get/Set the customer/supplier account address 's second line. | |
AccountBranchID | Int32 | Get/Set the branch account ID for a head office `CreditNote`. | |
AccountID | Int32 | Get/Set the unique identifier of the customer/supplier. |
|
AccountName | String | Get/Set the customer/supplier account name. It is duplicated here from the customer/supplier account record, as it may have changed since the CreditNote was created. |
|
AccountTaxCode | String | Get/Set the account tax code if the customer/supplier uses a default tax code. This field is used only if the UseAccountTaxCode flag is set. |
|
AreaID | String | Get/Set the area unique identifier related to the CreditNote. |
|
AuthorUserID | String | Get the unique identifier of the user who created the CreditNote. |
|
City | String | Get/Set customer/supplier city. |
|
Contact | String | Get/Set the customer/supplier contact name. |
|
Country | String | Get/Set the customer/supplier country's name. |
|
County_State | String | Get/Set the customer/supplier county or state. |
|
CreationDate | DateTime | Get the CreditNote creation date. | |
CurrencyCode | String | Get/Set the currency code of the CreditNote. |
|
DeliveryAddress1 | String | Get/Set customer/supplier delivery address's fist line. |
|
DeliveryAddress2 | String | Get/Set customer/supplier delivery address's second line. |
|
DeliveryAccountName | String | Get/Set customer/supplier delivery account name. The delivery account name can be different from the account name. |
|
DeliveryCity | String | Get/Set the customer/supplier delivery city. |
|
DeliveryCounty_State | String | Get/Set customer/supplier delivery county or state. |
|
DeliveryCountry | String | Get/Set the customer/supplier delivery country. |
|
DeliveryDate | DateTime | Get/Set the CreditNote delivery date. | |
DeliveryPostCode | String | Get/Set the customer/supplier delivery post code. |
|
DepartmentID | String | Get/Set the default department ID |
|
DiscountRate | Decimal | Get/Set the default discount rate for the CreditNote. |
|
ExchangeRate | Decimal | Get/Set the currency exchange rate between the customer/supplier currency and the system base currency for the current CreditNote. |
|
ExcludeFromPrinting | Boolean | Get/Set a flag indicating whether the CreditNote should be included in the reports. | |
ExternalReference | String | Get/Set the CreditNote external reference. |
|
ForCollection | Boolean | Get/Set a flag indicating whether the CreditNote is for collection or not. | |
Hold | Int16 | Get/Set the hold status of the CreditNote. Unknown List Class | |
CreditNoteDate | DateTime | Get/Set the CreditNote date. | |
CreditNoteID | Int32 | Get the CreditNote unique identifier. |
|
CreditNoteNumber | String | Get/Set the CreditNote number. Used only if the customer/supplier does not use auto-numbering for CreditNotes. |
|
IsPrinted | Boolean | Get a flag indicating whether the CreditNote has been printed or not. | |
Ledger | LedgerType | Get the CreditNote ledger type: Sales or Purchases. | |
Lines | InvoiceLine[] | Get the array of lines of the CreditNote. There is no limit to the amount of lines an CreditNote can have. | |
Notes | String | Get/Set some notes on the CreditNote. |
|
OrderDate | DateTime | Get/Set the order date. | |
OrderID | Nullable < Int32 > |
Get the Order unique identifier if the CreditNote has been created by promoting a Order. | |
OrderNumber | String | Get the Order unique identifier if the CreditNote has been created by promoting a Order. |
|
PaymentMethodID | String | Get/Set the customer/supplier payment method. |
|
Phone | String | Get/Set the customer/supplier phone number. |
|
PostCode | String | Get/Set customer/supplier post code. |
|
ShipmentViaID | String | Get/Set the ship via unique identifier. |
|
Status | String | Get the CreditNote status: Processed or Posted. A posted CreditNote is not editable. | |
UseAccountTaxCode | Boolean | Get/Set a flag indicating whether the customer/supplier chooses to use the tax code from itself rather than the ones coming from the stock items. This is only useful for interactive use, on the web service this does not do anything. |
|