GET Journals

Returns a list of journal transaction summary records.

Request Information

URI Parameters

Name	Description	Type	Additional information
Page	Specifies the page number of the result set to return.	integer	None.
PageSize	Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified.	integer	None.
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
LastModifiedFromDate	Filter records with LastModifiedDate greater than or equal to a date in UTC (must also specifiy LastModifiedToDate).	date	None.
LastModifiedToDate	Filter records with LastModifiedDate less than or equal to a date in UTC (must also specifiy LastModifiedFromDate).	date	None.
Tags	One or more tags that are used to filter the result set by. More tags can be separated with a comma, for example 'tags=tag1,tag2'.	string	None.
TagSelection	Specifies how to filter when using the supplied tags.Valid values are: requireAny - filter records with ANY ONE of the supplied tags, requireAll - filter records with ALL of the supplied tags, excludeAny - filter records excluding any records with ANY ONE of the specified tags, excludeAll - filter records excluding any records with ALL of the specified tags.	string	None.
FromDate	Filter records with Date greater than or equal to a date (must also specifiy ToDate).	string	None.
ToDate	Filter records with Date less than or equal to a date (must also specifiy FromDate).	string	None.
JournalContactId	Filter records with a Contact Id equal to the specified value.	string	None.

Body Parameters

None.

Response Information

Resource Description

JournalTransactionSummaryResponse

Name	Description	Type	Additional information
Journals	List of journals.	Collection of JournalSummary	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:

{
  "Journals": [
    {
      "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-11-19T18:00:07.2543256Z",
      "LastModifiedDateUtc": "2024-11-20T18:00:07.2543256Z",
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Journal/5093684?FileId=123",
          "method": "GET",
          "title": null
        },
        {
          "rel": "related",
          "href": "https://api.saasu.com/Contact/987?FileId=123",
          "method": "GET",
          "title": "Contact"
        }
      ]
    },
    {
      "TransactionId": 5093685,
      "LastUpdatedId": "AAAAAAAKgd=",
      "TransactionDate": "2015-01-24T00:00:00",
      "Summary": "Test Journal entry 2",
      "Currency": "AUD",
      "FxRate": 1.0,
      "AutoPopulateFxRate": false,
      "Reference": "321",
      "JournalContactId": 789,
      "ContactFirstName": "Bill",
      "ContactLastName": "Jones",
      "ContactOrganisationName": "Bills Paper Goods",
      "RequiresFollowUp": false,
      "Tags": [
        "Note, Supplier"
      ],
      "CreatedDateUtc": "2024-11-19T18:00:07.2543256Z",
      "LastModifiedDateUtc": "2024-11-20T18:00:07.2543256Z",
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Journal/5093685?FileId=123",
          "method": "GET",
          "title": null
        },
        {
          "rel": "related",
          "href": "https://api.saasu.com/Contact/789?FileId=123",
          "method": "GET",
          "title": "Contact"
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/Journals?FileId=123",
      "method": "GET",
      "title": null
    },
    {
      "rel": "next",
      "href": "https://api.saasu.com/Journals?FileId=123&Page=2&PageSize=25",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:

<JournalTransactionSummaryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/Journals?FileId=123</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>next</rel>
      <href>https://api.saasu.com/Journals?FileId=123&amp;Page=2&amp;PageSize=25</href>
      <method>GET</method>
    </Link>
  </_links>
  <Journals>
    <JournalSummary>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Journal/5093684?FileId=123</href>
          <method>GET</method>
        </Link>
        <Link>
          <rel>related</rel>
          <href>https://api.saasu.com/Contact/987?FileId=123</href>
          <method>GET</method>
          <title>Contact</title>
        </Link>
      </_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-11-19T18:00:07.2543256Z</CreatedDateUtc>
      <LastModifiedDateUtc>2024-11-20T18:00:07.2543256Z</LastModifiedDateUtc>
    </JournalSummary>
    <JournalSummary>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Journal/5093685?FileId=123</href>
          <method>GET</method>
        </Link>
        <Link>
          <rel>related</rel>
          <href>https://api.saasu.com/Contact/789?FileId=123</href>
          <method>GET</method>
          <title>Contact</title>
        </Link>
      </_links>
      <TransactionId>5093685</TransactionId>
      <LastUpdatedId>AAAAAAAKgd=</LastUpdatedId>
      <TransactionDate>2015-01-24T00:00:00</TransactionDate>
      <Summary>Test Journal entry 2</Summary>
      <Currency>AUD</Currency>
      <FxRate>1</FxRate>
      <AutoPopulateFxRate>false</AutoPopulateFxRate>
      <Reference>321</Reference>
      <JournalContactId>789</JournalContactId>
      <ContactFirstName>Bill</ContactFirstName>
      <ContactLastName>Jones</ContactLastName>
      <ContactOrganisationName>Bills Paper Goods</ContactOrganisationName>
      <RequiresFollowUp>false</RequiresFollowUp>
      <Tags>
        <string>Note, Supplier</string>
      </Tags>
      <CreatedDateUtc>2024-11-19T18:00:07.2543256Z</CreatedDateUtc>
      <LastModifiedDateUtc>2024-11-20T18:00:07.2543256Z</LastModifiedDateUtc>
    </JournalSummary>
  </Journals>
</JournalTransactionSummaryResponse>