Journal Transaction History
Returns a list of Journals and their history for all transaction types
Date Released: Feb 2023 Date Updated: Feb 2023
URL | Supports |
/{cf_uri}/Report/JournalTransactionHistory
|
GET |
PUT |
POST |
DELETE
|
Filtering using $filter on this endpoint is limited to the following properties:
- UID
- JournalType
- DateOccurred
- DatePosted
- SourceTransaction/UID*
- OperationType
- GroupUID
Sorting is only availble by using $orderby and one of these properties:
|
The elements list below details information for Journal Transaction History. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.
Items shown with are required when posting or puting data
Items shown with are read-only elements
Attribute Details
- UIDGuid (36)
- Unique identifier in the form of a guid.
- DisplayIDString (13)
- Journal transaction id.
- JournalTypeString
- Full list of journal types:
General
Sale
Purchase
CashPayment
CashReceipt
Inventory
- SourceTransactionString
- Source transaction that created the journal transaction.This object will only have a value on the latest version of the journal transaction (unless the transaction has been deleted)
- UIDGuid (36)
- Foreign Key: Unique identifier for the source transaction in the form of a guid.
- TransactionTypeString (30)
- Transaction types consist of the following:
Bill
Invoice
SupplierPayment
CustomerPayment
SpendMoneyTxn
ReceiveMoneyTxn
TransferMoneyTxn
GeneralJournal
InventoryAdjustment
CreditRefund
CreditSettlement
DebitRefund
DebitSettlement
- URIString
- Uniform resource identifier associated with the transaction object.
- DateOccurredDateTime
- Transaction date entry, format YYYY-MM-DD HH:MM:SS { 'DateOccurred': '2014-04-09 00:00:00' }
- DatePostedDateTime
- Date timestamp for day the transaction was entered, format YYYY-MM-DD HH:MM:SS { 'DatePosted': '2014-08-11 13:33:02' }
- DescriptionString (255)
- Journal memo assigned to the transaction.
- OperationTypeString
- Operation types:
Added
System
Edited
Deleted
Reversed. - GroupUIDGUID (36)
- UID of the first version of the transaction.
- Lines []
- An array of journal line information
- Account
- The following set of information pulls through details for an Account
- UIDGuid (36)
- Foreign Key: Unique identifier for the account in the form of a guid.
- NameString (60)
- Account name belonging to the account record.
- DisplayIDString (6)
- Account code format includes separator ie 1-1100{ 'DisplayID': '1-1200' }
- URIString
- Uniform resource identifier associated with the account object.
- AmountDecimal (13.6)
- Dollar amount posted to the Account object for each line of the transaction.
- IsCreditBoolean
- True indicates the amount posted a credit to the Account object.
False indicates the amount posted did not record as a credit to the Account object. - Job
- The following set of information pulls through the details for a job
- UID GUID (36)
- Foreign Key: Unique guid identifier belonging to the job for the line of the service sale.
- Number String (30)
- Number assigned to the job
- Name String (30)
- Name assigned to the job
- URI String
- Uniform resource identifier associated with the job object
- LineDescriptionString (255)
- Line description for each line of the transaction if one has been entered.
- ReconciledDateDateTime
- Date timestamp for day the transaction was reconciled, format YYYY-MM-DD HH:MM:SS { 'ReconciledDate': '2014-08-11 13:33:02' }
- UnitCountDecimal (19.6)
- Quantity value of the journal transaction entry.
- URIString
- Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
- RowVersionString
- Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
Example json GET response
- {
- "UID":"dee518bc-c4c0-4ddc-bcab-783c83fd1ded",
- "DisplayID":"00000012",
- "JournalType":"Purchase",
- "SourceTransaction":{
- "UID":: "936abe86-06a6-4853-998b-06b7ba5c8d81",
- "TransactionType":"Bill",
- "URI":"{cf_uri}/Purchase/Bill/936abe86-06a6-4853-998b-06b7ba5c8d81"
- },
- "DateOccurred":"2023-01-16T00:00:00",
- "DatePosted":"2023-01-16T02:56:38.513",
- "Description":"Purchase; Curbys Super Stands",
- "OperationType":"Added",
- "GroupUID":"dee518bc-c4c0-4ddc-bcab-783c83fd1ded",
- "Lines":< [
- {
- "Account" : {
- "UID":"f1aa791a-2c5e-4fcf-aa07-ab5c46d1ad9b",
- "Name":"Trade Creditors",
- "DisplayID":"2-2000",
- "URI": "{cf_uri}/GeneralLedger/Account/f1aa791a-2c5e-4fcf-aa07-ab5c46d1ad9b"
- },
- "Amount": 966.500000,
- "IsCredit": true,
- "Job": null,
- "LineDescription": null,
- "ReconciledDate": null,
- "UnitCount": null
- },
- {
- "Account" : {
- "UID":"7fe0ea59-d595-4e58-9701-994f9f8ef8f6",
- "Name":"Inventory",
- "DisplayID":"1-1400",
- "URI": "{cf_uri}/GeneralLedger/Account/7fe0ea59-d595-4e58-9701-994f9f8ef8f6"
- },
- "Amount": 878.640000,
- "IsCredit": false,
- "Job": null,
- "LineDescription": "Steel Stand; Pine Stand",
- "ReconciledDate": null,
- "UnitCount": null
- },
- {
- "Account" : {
- "UID":"24561179-383f-41e1-86a0-3d420d2d6223",
- "Name":"GST Paid",
- "DisplayID":"2-3030",
- "URI": "{cf_uri}/GeneralLedger/Account/24561179-383f-41e1-86a0-3d420d2d6223"
- },
- "Amount": 87.860000,
- "IsCredit": false,
- "Job": null,
- "LineDescription": null,
- "ReconciledDate": null,
- "UnitCount": null
- },
- ],
- "URI": "{cf_uri}/Report/JournalTransactionHistory/dee518bc-c4c0-4ddc-bcab-783c83fd1ded",
- "RowVersion": "3837641927100989440"
- }