Xero · Example Payload

Xero Getjournal Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getjournal Example is an example object payload from Xero, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "getJournal",
  "method": "GET",
  "path": "/Journals/{JournalID}",
  "summary": "Xero Retrieves a specific journal using a unique journal Id.",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "39ab8367-eb14-420d-83a9-e01ddddd21f8",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1552335613002)/",
        "Journals": [
          {
            "JournalID": "1b31feeb-aa23-404c-8c19-24c827c53661",
            "JournalDate": "/Date(1539993600000+0000)/",
            "JournalNumber": 1,
            "CreatedDateUTC": "/Date(1541176243467+0000)/",
            "Reference": "Red Fish, Blue Fish",
            "JournalLines": [
              {
                "JournalLineID": "81e6b1bf-d812-4f87-8dc4-698558ae043e",
                "AccountID": "b94495d0-44ab-4199-a1d0-427a4877e100",
                "AccountCode": "610",
                "AccountType": "CURRENT",
                "AccountName": "Accounts Receivable",
                "Description": "",
                "NetAmount": 40.0,
                "GrossAmount": 40.0,
                "TaxAmount": 0.0,
                "TaxType": "",
                "TaxName": "",
                "TrackingCategories": []
              },
              {
                "JournalLineID": "ad221a8c-ebee-4c1b-88ed-d574e27e8803",
                "AccountID": "e0a5d892-9f9f-44f0-a153-5cb7db125170",
                "AccountCode": "200",
                "AccountType": "REVENUE",
                "AccountName": "Sales",
                "Description": "Acme Tires",
                "NetAmount": -40.0,
                "GrossAmount": -40.0,
                "TaxAmount": 0.0,
                "TaxType": "NONE",
                "TaxName": "No GST",
                "TrackingCategories": []
              }
            ]
          }
        ]
      }
    }
  ]
}