Sales Transaction Proposal
Retrieve sales transaction proposal from Basecone by its unique identifier.
This API resource is only available to Premium APPs.
GET transactionproposals/:id
Example response
{
"type": "sales",
"description": "",
"dueDate": "2014-09-07T00:00:00",
"invoiceNumber": "hyrht54654",
"customer": {
"code": "1002"
},
"paymentCondition":{
"paymentConditionId": "d6bbcf34-9fec-40ca-800d-8df0ded40f61",
"code": "30"
},
"isInPaymentBatch": true,
"isCreditNote": false,
"totalAmount": 500,
"transactionProposalId": "d6bbcf34-9fec-40ca-800d-8df0ded40f61",
"documentId": "afdae3ec-9784-4b31-9529-4d05008a22e4",
"targetCompany": {
"code": "9901"
},
"transactionDate": "2014-08-08T00:00:00",
"generalLedger": {
"code": "1300"
},
"period": "2014/8",
"currency": {
"code": "EUR"
},
"additionalField1": "Some text",
"additionalField2": "Some more text",
"additionalField3": "AAAHlw==AFDAE3EC97844B3195294D05008A22E4",
"transactionLines": [
{
"intraCommunity": {
"countryCode": "nl",
"VatNumber": "NL3298742987",
"Date": "2014-08-05T00:00:00",
"IcpDeliveryType": "goods",
},
"transactionLineId": "0a20f63a-9a7e-48e3-9c05-0344bf990077",
"lineNumber": 2,
"description": "Some description",
"additionalField1": "Some text",
"destinationCompany": {
"code": "9901"
},
"generalLedger": {
"code": "0090"
},
"costCenter": {
"code": "00013"
},
"costUnit": {
"code": "D0001"
},
"project": {
"code": "P0008"
},
"amount": 500,
"vatCode": {
"code": "IV21"
},
"vatAmount": 120
}
]
}
Sales transaction proposal properties
Properties specific to sales transaction proposals are printed bold, other properties are shared between all types of transactions.
| Property | Type | Description |
|---|---|---|
| Description | String | Description |
| DueDate | DateTime (nullable) | Due date |
| InvoiceNumber | String | Invoice number |
| Customer | Customer object | Customer |
| PaymentCondition | Payment condition object | Payment condition, not supported for all accounting systems |
| IsInPaymentBatch | Bool | This indicates and provides a trigger if the transaction needs to be taken into account for any payment run in the 3rd party application. |
| IsCreditNote | Bool | Indicates whether this transaction is a credit note. |
| TotalAmount | Decimal (nullable) | Total amount |
| TransactionProposalId | Guid | Unique identifier of the transaction. |
| Type | String | Indicates the type of transaction, possible value are cash,sales,purchase,journal. |
| Document | Document object | This is a reference to the related document resource. |
| DestinationCompany | Company object | This is the company that is targeted to receive the posting line details. This differs from the destination company. |
| 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. |
| GeneralLedger | GeneralLedger object | This is the code of the ledger that is selected to book a transaction. This represents the category of booking. |
| Period | String | The period of a transaction relates to the transaction date and represents the specific period in the accounts of a company. |
| Currency | Currency object | Currency used in transaction. |
| AdditionalField1 | String | Additional text field I |
| AdditionalField2 | String | Additional text field II |
| AdditionalField3 | String | Additional text field III |
| IsFinalBooking | Bool | Indicates if this transaction will be booked as a final booking. |
| TransactionLines | Array | Collection of transactionlines. Type of transactionline depends on the type of transaction. |
Sales transaction line properties
| Property | Type | Description | |
|---|---|---|---|
| IntraCommunity | IntraCommunity object | This indicates if the VAT code is related to an Intra Community Transaction/delivery. | |
| 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 |
IntraCommunity
| Property | Type | Description |
|---|---|---|
| CountryCode | String | Two letter country ISO code. |
| VatNumber | String | The applicable vat number. |
| Date | DateTime (nullable) | The date of the icp delivery. |
| IcpDeliveryType | String | The type of icp delivery, possible value are goods,services |
