WSTransactionModification - accountsIQ/API-Wiki GitHub Wiki
This structure represents a transaction.
WSTransactionModification members
| Name | Type | Description |
|---|---|---|
| AccountID | Int32 | The unique account ID (customer or supplier) if any, otherwise 0 |
| Ledger | LedgerType | Sales|Purchases|Null. Sales indicates a customer, Purchases a supplier. |
| TransactionType | String | Type of the transaction. Please see TransactionTypes for the list of short names. |
| CurrencyCode | String | Currency code for the control line. Only valid for debtors and creditors transactions. |
| TransactionID | Int32 | Unique transaction identifier |
| InternalNumber | String | Internal number of the transaction. This can be the invoice number or the credit journal number etc. Unique per transaction type. |
| ExternalReference | String | Transaction external reference |
| TransactionDate | DateTime | Contains the transaction date. |
| FinancialYear | Int32 | Contains the financial year in which the transaction falls. It may be different from the calendar year. |
| PeriodNumber | Int32 | Contains the period number (starting from 1) in which the transaction falls. It may be different from the month number, depending on the financial year start/end. |
| PeriodName | Int32 | Contains the period name in which the transaction falls. It may be different from the month name, depending on the financial year start/end. |
| CreationDate | DateTime | Physical date in which the system received the transaction. |
| LineDetails | WSTransactionModificationDetail[] | Contains the list of lines making up the different movements inside the transaction. |
The following fields are part of the same structure but only make sense for creditors or debtors transaction (with a non-0 account ID):
| Name | Type | Description |
|---|---|---|
| AccountCode | String | The customer or supplier code, if any. |
| IsBatchInvoiceOrNote | Boolean | True if the transaction is a sales/purchases batch invoice/credit note. |
| InvoiceID | Int32 | Set to the product invoice/note unique ID if the transaction is the result of a product invoice/credit note posting. Otherwise 0. |
| ControlAmount | Decimal | If set, it contains the amount of the control line. Only valid for debtors and creditors transactions. |
| OutstandingAmount | Decimal | If set, it contains the amount outstanding on the transaction. Only valid for debtors and creditors transactions. |
| ControlBCAmount | Decimal | If set, it contains the amount of the control line in base currency. Only valid for debtors and creditors transactions. |