GET 17.0/database/transactions/{id}

Description

Retrieve Transactions

URI Parameters

Name Description Type Additional information
id

integer

Required

None.

None.

Name Description Type Additional information
ID

integer

None.

Type

byte

None.

Status

byte

None.

AddedDate

date

None.

DueDate

date

None.

StatusDate

date

None.

BankingDate

date

None.

UserID

integer

None.

ContactID

integer

None.

PropertyID

integer

None.

TenancyID

integer

None.

ProductID

integer

None.

TaxRateID

integer

None.

TaxRate

decimal number

None.

Debit

decimal number

None.

Credit

decimal number

None.

PaymentMethodID

integer

None.

Notes

string

String length: inclusive between 0 and 512

StatementID

integer

None.

InvoiceID

integer

None.

ReceiptID

integer

None.

BillID

integer

None.

CompanyAccount

byte

None.

BankAccountID

integer

None.

CommissionFee

decimal number

None.

CommissionPercentage

decimal number

None.

TransferFees

byte

None.

StatementNotes

string

String length: inclusive between 0 and 255

SiteID

integer

None.

LinkedTo

integer

None.

LinkedCascadeDelete

byte

None.

LinkGroup

integer

None.

PaymentCleared

byte

None.

PaymentClearedDate

date

None.

BankReconciliationID

integer

None.

IncludeOnBankRec

byte

None.

PaymentCollectionID

integer

None.

RentDemandSent

byte

None.

IncludeAsDebit

byte

None.

TransactionGroupID

integer

None.

ResetBalance

byte

None.

Version

byte

None.

PreviousStatus

byte

None.

PeriodStartDate

date

None.

PeriodEndDate

date

None.

CompanyID

integer

None.

TransferDeposit

byte

None.

SplitID

integer

None.

TransferOverseasTax

byte

None.

CreationMethod

byte

None.

PaymentForID

integer

None.

BankAccountBalanceExclude

byte

None.

SuspenseAccount

byte

None.

PaymentRunID

integer

None.

LinkedPropertyID

integer

None.

Exported

byte

None.

BankMatched

byte

None.

ReceivedFromContactID

integer

None.

ResetFundsHeld

byte

None.

ResetFundsHeldAmount

decimal number

None.

application/json, text/json

Sample:
{
  "id": 1,
  "type": 64,
  "status": 64,
  "addedDate": "2025-01-09T20:41",
  "dueDate": "2025-01-09T20:41",
  "statusDate": "2025-01-09T20:41",
  "bankingDate": "2025-01-09T20:41",
  "userID": 8,
  "contactID": 9,
  "propertyID": 10,
  "tenancyID": 11,
  "productID": 12,
  "taxRateID": 13,
  "taxRate": 14.0,
  "debit": 15.0,
  "credit": 16.0,
  "paymentMethodID": 17,
  "notes": "sample string 18",
  "statementID": 19,
  "invoiceID": 20,
  "receiptID": 21,
  "billID": 22,
  "companyAccount": 64,
  "bankAccountID": 24,
  "commissionFee": 25.0,
  "commissionPercentage": 26.0,
  "transferFees": 64,
  "statementNotes": "sample string 28",
  "siteID": 29,
  "linkedTo": 30,
  "linkedCascadeDelete": 64,
  "linkGroup": 32,
  "paymentCleared": 64,
  "paymentClearedDate": "2025-01-09T20:41",
  "bankReconciliationID": 35,
  "includeOnBankRec": 64,
  "paymentCollectionID": 37,
  "rentDemandSent": 64,
  "includeAsDebit": 64,
  "transactionGroupID": 40,
  "resetBalance": 64,
  "version": 64,
  "previousStatus": 64,
  "periodStartDate": "2025-01-09T20:41",
  "periodEndDate": "2025-01-09T20:41",
  "companyID": 46,
  "transferDeposit": 64,
  "splitID": 48,
  "transferOverseasTax": 64,
  "creationMethod": 64,
  "paymentForID": 51,
  "bankAccountBalanceExclude": 64,
  "suspenseAccount": 64,
  "paymentRunID": 54,
  "linkedPropertyID": 55,
  "exported": 64,
  "bankMatched": 64,
  "receivedFromContactID": 58,
  "resetFundsHeld": 64,
  "resetFundsHeldAmount": 60.0
}

application/xml, text/xml

Sample:
<Transactions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <Type>64</Type>
  <Status>64</Status>
  <AddedDate>2025-01-09T20:41:11.4321569+00:00</AddedDate>
  <DueDate>2025-01-09T20:41:11.4321569+00:00</DueDate>
  <StatusDate>2025-01-09T20:41:11.4321569+00:00</StatusDate>
  <BankingDate>2025-01-09T20:41:11.4321569+00:00</BankingDate>
  <UserID>8</UserID>
  <ContactID>9</ContactID>
  <PropertyID>10</PropertyID>
  <TenancyID>11</TenancyID>
  <ProductID>12</ProductID>
  <TaxRateID>13</TaxRateID>
  <TaxRate>14</TaxRate>
  <Debit>15</Debit>
  <Credit>16</Credit>
  <PaymentMethodID>17</PaymentMethodID>
  <Notes>sample string 18</Notes>
  <StatementID>19</StatementID>
  <InvoiceID>20</InvoiceID>
  <ReceiptID>21</ReceiptID>
  <BillID>22</BillID>
  <CompanyAccount>64</CompanyAccount>
  <BankAccountID>24</BankAccountID>
  <CommissionFee>25</CommissionFee>
  <CommissionPercentage>26</CommissionPercentage>
  <TransferFees>64</TransferFees>
  <StatementNotes>sample string 28</StatementNotes>
  <SiteID>29</SiteID>
  <LinkedTo>30</LinkedTo>
  <LinkedCascadeDelete>64</LinkedCascadeDelete>
  <LinkGroup>32</LinkGroup>
  <PaymentCleared>64</PaymentCleared>
  <PaymentClearedDate>2025-01-09T20:41:11.4321569+00:00</PaymentClearedDate>
  <BankReconciliationID>35</BankReconciliationID>
  <IncludeOnBankRec>64</IncludeOnBankRec>
  <PaymentCollectionID>37</PaymentCollectionID>
  <RentDemandSent>64</RentDemandSent>
  <IncludeAsDebit>64</IncludeAsDebit>
  <TransactionGroupID>40</TransactionGroupID>
  <ResetBalance>64</ResetBalance>
  <Version>64</Version>
  <PreviousStatus>64</PreviousStatus>
  <PeriodStartDate>2025-01-09T20:41:11.4321569+00:00</PeriodStartDate>
  <PeriodEndDate>2025-01-09T20:41:11.4321569+00:00</PeriodEndDate>
  <CompanyID>46</CompanyID>
  <TransferDeposit>64</TransferDeposit>
  <SplitID>48</SplitID>
  <TransferOverseasTax>64</TransferOverseasTax>
  <CreationMethod>64</CreationMethod>
  <PaymentForID>51</PaymentForID>
  <BankAccountBalanceExclude>64</BankAccountBalanceExclude>
  <SuspenseAccount>64</SuspenseAccount>
  <PaymentRunID>54</PaymentRunID>
  <LinkedPropertyID>55</LinkedPropertyID>
  <Exported>64</Exported>
  <BankMatched>64</BankMatched>
  <ReceivedFromContactID>58</ReceivedFromContactID>
  <ResetFundsHeld>64</ResetFundsHeld>
  <ResetFundsHeldAmount>60</ResetFundsHeldAmount>
</Transactions>