Transactions
Retrieves a transaction from Basecone by it's unique identifier.
GET transactions/:id
The following transactions are currently available through the Basecone API and can be distinguished by their type property
| Transaction |
|---|
| Cash transactions |
| Journal transactions |
| Purchase transactions |
| Sales transactions |
Transaction properties
All transactions share the following properties. Properties specific to one type of transaction are explained in the specific resource pages.
| Property | Type | Description | Optional |
|---|---|---|---|
| TransactionId | Guid | Unique identifier of the transaction. | No |
| Type | String | Indicates the type of transaction, possible value are cash,sales,purchase,journal. |
No |
| DocumentId | Guid | Unique identifier of related document. | No |
| TargetCompany | Company object | This is the company that is targeted to receive the posting line details. This differs from the destination company. | No |
| DestinationCompany | Company object | The destination company is the company to which the header of a transaction in generally booked. | No |
| TransactionNumber | Long (nullable) | Transaction number is the unique number per booking, that is a reference for the transaction from Basecone or any other application (3rd party). | No |
| TransactionDate | DateTime (nullable) | This is the date of the transaction, in most cases the invoice date. The invoice date is generally mentioned on each invoice and differs from the transaction date. | No |
| GeneralLedger | GeneralLedger object | This is the code of the ledger that is selected to book a transaction. This represents the category of booking. | No |
| Period | String | The period of a transaction relates to the transaction date and represents the specific period in the accounts of a company. | No |
| Currency | Currency object | Currency used in transaction. | No |
| AdditionalField1 | String | Additional text field I | No |
| AdditionalField2 | String | Additional text field II | No |
| AdditionalField3 | String | Additional text field III | No |
| IsFinalBooking | Bool | Indicates if this transaction is booked as a final booking. | No |
| TransactionLines | Array | Collection of transactionlines. Type of transactionline depends on the type of transaction. | Yes |
| BookYear | Int | The booking year of a transaction relates to the year in the period property. | No |
Transaction line properties
All transaction lines share the following properties. Properties specific to one type of transaction are explained in the relevant resource page.
| Property | Type | Description | Optional |
|---|---|---|---|
| TransactionLineId | Guid | Unique identifier of the transaction line. | No |
| LineNumber | Int | Line number | No |
| Description | String | Description | No |
| DestinationCompany | Company object | The destination company is the company to which the header of a transaction in generally booked. | No |
| GeneralLedger | GeneralLedger object | This is the code of the ledger that is selected to book a transaction. This represents the category of booking. | No |
| CostCenter | CostCenter object | Cost center | No |
| CostUnit | CostUnit object | Cost unit.
Note: currently, supported only on Unit4 companies. |
No |
| Project | Project object | Project | No |
| Amount | Decimal (nullable) | Amount | No |
| VatCode | VatCode object | Vat code | No |
| VatAmount | Decimal (nullable) | Vat amount | No |
Possible error responses
| Status code | Error code | Details |
|---|---|---|
| 404 | transaction_not_found | Transaction with specified unique id could not be found |