Allows you to retrieve any journals.

GET {{baseUrl}}/Journals?offset=<integer>&paymentsOnly=<boolean>

Request Params

KeyDatatypeRequiredDescription
offsetstringOffset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned
paymentsOnlystringFilter to retrieve journals on a cash basis. Journals are returned on an accrual basis by default.

HEADERS

KeyDatatypeRequiredDescription
If-Modified-SincestringOnly records created or modified since this timestamp will be returned
xero-tenant-idstring(Required) Xero identifier for Tenant

RESPONSES

status: OK

{&quot;Id&quot;:&quot;49a09a97-df50-4679-8043-02c86e0dcf5f&quot;,&quot;Status&quot;:&quot;OK&quot;,&quot;ProviderName&quot;:&quot;Provider Name Example&quot;,&quot;DateTimeUTC&quot;:&quot;/Date(1552335214210)/&quot;,&quot;Journals&quot;:[{&quot;JournalID&quot;:&quot;1b31feeb-aa23-404c-8c19-24c827c53661&quot;,&quot;JournalDate&quot;:&quot;/Date(1539993600000+0000)/&quot;,&quot;JournalNumber&quot;:1,&quot;CreatedDateUTC&quot;:&quot;/Date(1541176243467+0000)/&quot;,&quot;Reference&quot;:&quot;Red Fish, Blue Fish&quot;,&quot;SourceID&quot;:&quot;d4956132-ed94-4dd7-9eaa-aa22dfdf06f2&quot;,&quot;SourceType&quot;:&quot;ACCREC&quot;,&quot;JournalLines&quot;:[{&quot;JournalLineID&quot;:&quot;81e6b1bf-d812-4f87-8dc4-698558ae043e&quot;,&quot;AccountID&quot;:&quot;b94495d0-44ab-4199-a1d0-427a4877e100&quot;,&quot;AccountCode&quot;:&quot;610&quot;,&quot;AccountType&quot;:&quot;CURRENT&quot;,&quot;AccountName&quot;:&quot;Accounts Receivable&quot;,&quot;Description&quot;:&quot;&quot;,&quot;NetAmount&quot;:40.0,&quot;GrossAmount&quot;:40.0,&quot;TaxAmount&quot;:0.0,&quot;TrackingCategories&quot;:[]},{&quot;JournalLineID&quot;:&quot;ad221a8c-ebee-4c1b-88ed-d574e27e8803&quot;,&quot;AccountID&quot;:&quot;e0a5d892-9f9f-44f0-a153-5cb7db125170&quot;,&quot;AccountCode&quot;:&quot;200&quot;,&quot;AccountType&quot;:&quot;REVENUE&quot;,&quot;AccountName&quot;:&quot;Sales&quot;,&quot;Description&quot;:&quot;Acme Tires&quot;,&quot;NetAmount&quot;:-40.0,&quot;GrossAmount&quot;:-40.0,&quot;TaxAmount&quot;:0.0,&quot;TaxType&quot;:&quot;NONE&quot;,&quot;TaxName&quot;:&quot;No GST&quot;,&quot;TrackingCategories&quot;:[]}]},{&quot;JournalID&quot;:&quot;2be66e45-805b-46de-921d-c67e1d3dad2a&quot;,&quot;JournalDate&quot;:&quot;/Date(1539993600000+0000)/&quot;,&quot;JournalNumber&quot;:9,&quot;CreatedDateUTC&quot;:&quot;/Date(1541176504083+0000)/&quot;,&quot;Reference&quot;:&quot;Red Fish, Blue Fish&quot;,&quot;SourceID&quot;:&quot;046d8a6d-1ae1-4b4d-9340-5601bdf41b87&quot;,&quot;SourceType&quot;:&quot;ACCREC&quot;,&quot;JournalLines&quot;:[{&quot;JournalLineID&quot;:&quot;ba8a5680-a753-4a35-b3dd-0bc72e5c26a1&quot;,&quot;AccountID&quot;:&quot;b94495d0-44ab-4199-a1d0-427a4877e100&quot;,&quot;AccountCode&quot;:&quot;610&quot;,&quot;AccountType&quot;:&quot;CURRENT&quot;,&quot;AccountName&quot;:&quot;Accounts Receivable&quot;,&quot;Description&quot;:&quot;&quot;,&quot;NetAmount&quot;:40.0,&quot;GrossAmount&quot;:40.0,&quot;TaxAmount&quot;:0.0,&quot;TrackingCategories&quot;:[]},{&quot;JournalLineID&quot;:&quot;09a0b9b9-0222-4e24-8c31-efef472e22f1&quot;,&quot;AccountID&quot;:&quot;e0a5d892-9f9f-44f0-a153-5cb7db125170&quot;,&quot;AccountCode&quot;:&quot;200&quot;,&quot;AccountType&quot;:&quot;REVENUE&quot;,&quot;AccountName&quot;:&quot;Sales&quot;,&quot;Description&quot;:&quot;Acme Tires&quot;,&quot;NetAmount&quot;:-40.0,&quot;GrossAmount&quot;:-40.0,&quot;TaxAmount&quot;:0.0,&quot;TaxType&quot;:&quot;NONE&quot;,&quot;TaxName&quot;:&quot;No GST&quot;,&quot;TrackingCategories&quot;:[]}]},{&quot;JournalID&quot;:&quot;d0ed2957-ebba-4d3a-8367-ae9ccd574885&quot;,&quot;JournalDate&quot;:&quot;/Date(1543449600000+0000)/&quot;,&quot;JournalNumber&quot;:14,&quot;CreatedDateUTC&quot;:&quot;/Date(1541176592673+0000)/&quot;,&quot;SourceID&quot;:&quot;99ea7f6b-c513-4066-bc27-b7c65dcd76c2&quot;,&quot;SourceType&quot;:&quot;ACCRECPAYMENT&quot;,&quot;JournalLines&quot;:[{&quot;JournalLineID&quot;:&quot;1bdae2b7-3035-40ec-b344-b12b1c23adc4&quot;,&quot;AccountID&quot;:&quot;b94495d0-44ab-4199-a1d0-427a4877e100&quot;,&quot;AccountCode&quot;:&quot;610&quot;,&quot;AccountType&quot;:&quot;CURRENT&quot;,&quot;AccountName&quot;:&quot;Accounts Receivable&quot;,&quot;Description&quot;:&quot;&quot;,&quot;NetAmount&quot;:-46.0,&quot;GrossAmount&quot;:-46.0,&quot;TaxAmount&quot;:0.0,&quot;TrackingCategories&quot;:[]},{&quot;JournalLineID&quot;:&quot;353be85e-ae79-4bb3-9483-5ea7682fc0a3&quot;,&quot;AccountID&quot;:&quot;5690f1e8-1d02-4893-90c2-ee1a69eff942&quot;,&quot;AccountCode&quot;:&quot;970&quot;,&quot;AccountType&quot;:&quot;EQUITY&quot;,&quot;AccountName&quot;:&quot;Owner A Funds Introduced&quot;,&quot;Description&quot;:&quot;&quot;,&quot;NetAmount&quot;:46.0,&quot;GrossAmount&quot;:46.0,&quot;TaxAmount&quot;:0.0,&quot;TrackingCategories&quot;:[]}]},{&quot;JournalID&quot;:&quot;772e8133-7f12-4edc-ab98-aa6dceb16c9d&quot;,&quot;JournalDate&quot;:&quot;/Date(1552262400000+0000)/&quot;,&quot;JournalNumber&quot;:30,&quot;CreatedDateUTC&quot;:&quot;/Date(1552333389227+0000)/&quot;,&quot;Reference&quot;:&quot;&quot;,&quot;SourceID&quot;:&quot;5376633d-0456-43a3-8234-e457a3f50a12&quot;,&quot;SourceType&quot;:&quot;ACCPAY&quot;,&quot;JournalLines&quot;:[{&quot;JournalLineID&quot;:&quot;33469836-642f-4973-a708-0e99339dff4a&quot;,&quot;AccountID&quot;:&quot;a2a4795b-a01f-40eb-afa6-a34b4514875d&quot;,&quot;AccountCode&quot;:&quot;800&quot;,&quot;AccountType&quot;:&quot;CURRLIAB&quot;,&quot;AccountName&quot;:&quot;Accounts Payable&quot;,&quot;Description&quot;:&quot;&quot;,&quot;NetAmount&quot;:-28750.0,&quot;GrossAmount&quot;:-28750.0,&quot;TaxAmount&quot;:0.0,&quot;TrackingCategories&quot;:[]},{&quot;JournalLineID&quot;:&quot;4f3b6462-5cf6-4b55-a2ae-de4039878215&quot;,&quot;AccountID&quot;:&quot;53a12a15-7e9b-4a31-85f4-a7cee6d04215&quot;,&quot;AccountCode&quot;:&quot;630&quot;,&quot;AccountType&quot;:&quot;CURRENT&quot;,&quot;AccountName&quot;:&quot;Inventory&quot;,&quot;Description&quot;:&quot;Brand new Fender Strats&quot;,&quot;NetAmount&quot;:25000.0,&quot;GrossAmount&quot;:28750.0,&quot;TaxAmount&quot;:3750.0,&quot;TaxType&quot;:&quot;INPUT2&quot;,&quot;TaxName&quot;:&quot;15% GST on Expenses&quot;,&quot;TrackingCategories&quot;:[]},{&quot;JournalLineID&quot;:&quot;534e822e-d441-48a7-8e57-5ad54729e83e&quot;,&quot;AccountID&quot;:&quot;17d9a4a0-3181-4803-a96b-f0dbe589091b&quot;,&quot;AccountCode&quot;:&quot;820&quot;,&quot;AccountType&quot;:&quot;CURRLIAB&quot;,&quot;AccountName&quot;:&quot;GST&quot;,&quot;Description&quot;:&quot;&quot;,&quot;NetAmount&quot;:3750.0,&quot;GrossAmount&quot;:3750.0,&quot;TaxAmount&quot;:0.0,&quot;TrackingCategories&quot;:[]}]}]}