Help Page Home - Journals
POST Journal
Insert a journal.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
WsAccessKey | The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. | string |
Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred. |
FileId | Specifies the file id of the file to perform the operation upon. | integer |
Required |
Body Parameters
Journal details.
JournalDetailName | Description | Type | Additional information |
---|---|---|---|
Items | The items associated with this journal transaction. | Collection of JournalItem |
Required |
Notes | Textual notes set by the user. | string |
None. |
TransactionId | The Id/key of the journal/transaction. This data is returned only and cannot be added or updated when issuing a POST or PUT. | integer |
None. |
LastUpdatedId | A data field used to check concurreny when performing updates. This data is returned only and used for concurrency checking when performing an update/PUT. | string |
None. |
TransactionDate | Date of this transaction. | date |
Required |
Summary | Journal summary. | string |
None. |
Currency | The currrency code of the amounts. Eg. AUD. | string |
None. |
FxRate | FXRate (Foreign exchange rate) applied to this invoice. | decimal number |
None. |
AutoPopulateFxRate | Determines whether the FxRate is automatically populated using the Fx feed. | boolean |
None. |
Reference | Journal reference | string |
None. |
JournalContactId | The Id/key of the journal transaction's contact. | integer |
None. |
ContactFirstName | Contact first name. This data is returned only and cannot be added or updated when issuing a POST or PUT. | string |
None. |
ContactLastName | Contact last name. This data is returned only and cannot be added or updated when issuing a POST or PUT. | string |
None. |
ContactOrganisationName | Contact organisation name. This data is returned only and cannot be added or updated when issuing a POST or PUT. | string |
None. |
RequiresFollowUp | Journal transaction requires follow up | boolean |
None. |
Tags | List of tags associated with this resource. | Collection of string |
None. |
CreatedDateUtc | The date and time this resource was created in UTC. This data is returned only and cannot be added or updated when issuing a POST or PUT. | date |
None. |
LastModifiedDateUtc | The date and time this resource was last modified in UTC. This data is returned only and cannot be added or updated when issuing a POST or PUT. | date |
None. |
_links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Request Formats
application/json, text/json
Sample:
{ "Items": [ { "Type": "Credit", "AccountId": 321, "TaxCode": "G1", "Amount": 10.0, "_links": [] } ], "Notes": "Test journal note", "TransactionId": 5093684, "LastUpdatedId": "AAAAAAAKgc=", "TransactionDate": "2015-01-24T00:00:00", "Summary": "Test Journal entry 1", "Currency": "AUD", "FxRate": 1.0, "AutoPopulateFxRate": false, "Reference": "123", "JournalContactId": 987, "ContactFirstName": "Joe", "ContactLastName": "Smith", "ContactOrganisationName": "Joes Toys", "RequiresFollowUp": false, "Tags": [ "Note", "Supplier", "Toys" ], "CreatedDateUtc": "2024-10-31T18:00:06.1658055Z", "LastModifiedDateUtc": "2024-11-01T18:00:06.1658055Z", "_links": [] }
application/xml, text/xml
Sample:
<JournalDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <_links /> <TransactionId>5093684</TransactionId> <LastUpdatedId>AAAAAAAKgc=</LastUpdatedId> <TransactionDate>2015-01-24T00:00:00</TransactionDate> <Summary>Test Journal entry 1</Summary> <Currency>AUD</Currency> <FxRate>1</FxRate> <AutoPopulateFxRate>false</AutoPopulateFxRate> <Reference>123</Reference> <JournalContactId>987</JournalContactId> <ContactFirstName>Joe</ContactFirstName> <ContactLastName>Smith</ContactLastName> <ContactOrganisationName>Joes Toys</ContactOrganisationName> <RequiresFollowUp>false</RequiresFollowUp> <Tags> <string>Note</string> <string>Supplier</string> <string>Toys</string> </Tags> <CreatedDateUtc>2024-10-31T18:00:06.1658055Z</CreatedDateUtc> <LastModifiedDateUtc>2024-11-01T18:00:06.1658055Z</LastModifiedDateUtc> <Items> <JournalItem> <_links /> <Type>Credit</Type> <AccountId>321</AccountId> <TaxCode>G1</TaxCode> <Amount>10.00</Amount> </JournalItem> </Items> <Notes>Test journal note</Notes> </JournalDetail>
Response Information
Resource Description
InsertJournalResultName | Description | Type | Additional information |
---|---|---|---|
InsertedEntityId | The Id/key of the newly created/inserted journal. | integer |
None. |
UpdatedJournalId | The id of the updated journal transaction. | integer |
None. |
LastUpdatedId | The unique identifier generated as part of the update. This value is required when submitting subsequent update to prevent concurrency errors. | string |
None. |
UtcLastModified | The date and time this resource was modified in UTC. | date |
None. |
_links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{ "InsertedEntityId": 1, "UpdatedJournalId": 2, "LastUpdatedId": "sample string 3", "UtcLastModified": "2024-11-02T13:17:15.9851443+11:00", "_links": [ { "rel": "sample string 1", "href": "sample string 2", "method": "sample string 3", "title": "sample string 4" }, { "rel": "sample string 1", "href": "sample string 2", "method": "sample string 3", "title": "sample string 4" } ] }
application/xml, text/xml
Sample:
<InsertJournalResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <_links> <Link> <rel>sample string 1</rel> <href>sample string 2</href> <method>sample string 3</method> <title>sample string 4</title> </Link> <Link> <rel>sample string 1</rel> <href>sample string 2</href> <method>sample string 3</method> <title>sample string 4</title> </Link> </_links> <LastUpdatedId>sample string 3</LastUpdatedId> <UtcLastModified>2024-11-02T13:17:15.9851443+11:00</UtcLastModified> <UpdatedJournalId>2</UpdatedJournalId> <InsertedEntityId>1</InsertedEntityId> </InsertJournalResult>