Xero Accounting Endpoint: JournalsAccrualTable

From OdataLink
Jump to navigation Jump to search

Overview

The Xero JournalsAccrualTable endpoint provides the journal records on an accrual basis that had a material impact on your general ledger.

Note this endpoint is an alternate format of the JournalsAccrual endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.

This endpoint does not internally support filters due to the Xero API Architecture. Only the JournalNumber, JournalDate and CreatedDateUTC fields can be filtered. Furthermore, these fields do not support all types of operators or complex filters.

For journals on a cash basis, see JournalsCash.


Fields

The following fields are available for the JournalsAccrualTable endpoint.

DataFileID
A guid field that provides the id of the xero data file as setup in OdataLink.
DataFileName
A text field provides the name of the xero data file as setup in OdataLink.
DataFileCode
A text field provides the code of the xero data file as setup in OdataLink.
JournalID
A guid field that provides the id of the journal record.
JournalDate
A date field that provides the date to which the journal record applies.
JournalNumber
A text field provides the journal number.
This is a auto-generated sequential number that doesn't correspond or relate to the transaction/invoice number.
Reference
A text field provides a descriptive reference (could be an invoice numnber or reference).
SourceID
A guid field that provides the source unique id of the transaction that generated this journal.
This can be linked to other endpoints.
SourceType
A text field provides a indicates the source of the journal record.
Possible values are:
  • ACCREC: Accounts receivable invoice
  • ACCPAY: Accounts payable invoice
  • ACCRECCREDIT: Accounts receivable credit note
  • ACCPAYCREDIT: Accounts payable credit note
  • ACCRECPAYMENT: Payment on an accounts receivable invoice
  • ACCPAYPAYMENT: Payment on an accounts payable invoice
  • ARCREDITPAYMENT: Accounts receivable credit note payment
  • APCREDITPAYMENT: Accounts payable credit note payment
  • CASHREC: Receive money bank transaction
  • CASHPAID: Spend money bank transaction
  • TRANSFER: Bank transfer
  • ARPREPAYMENT: Accounts receivable prepayment
  • APPREPAYMENT: Accounts payable prepayment
  • AROVERPAYMENT: Accounts receivable overpayment
  • APOVERPAYMENT: Accounts payable overpayment
  • EXPCLAIM: Expense claim
  • EXPPAYMENT: Expense claim payment
  • MANJOURNAL: Manual journal
  • PAYSLIP: Payslip
  • WAGEPAYABLE: Payroll payable
  • INTEGRATEDPAYROLLPE: Payroll expense
  • INTEGRATEDPAYROLLPT: Payroll payment
  • EXTERNALSPENDMONEY: Payroll employee payment
  • INTEGRATEDPAYROLLPTPAYMENT: Payroll tax payment
  • INTEGRATEDPAYROLLCN: Payroll credit note
JournalLineID
A guid field that provides the id of the journal record.
This field cannot really be linked to other endpoints.
AccountID
A GUID field that provides the id of the account.
This field can be used to link to the Accounts endpoints.
AccountCode
A text field that provides the account code.
This field can be used to link to the Accounts endpoints.
AccountType
A text field that provides the account type.
AccountName
A text field that provides account name.
Description
A text field that provides line description.
NetAmount
A decimal field that provides the tax exclusive amount.
This will be a positive value for a debit and negative for a credit
GrossAmount
A decimal field that tax provides the inclusive amount.
This field is calculated as NetAmount + TaxAmount.
TaxAmount
A decimal field that tax amount.
TaxType
A text field that provides the tax type.
TaxName
A text field that provides the name of the tax rate.
CreatedDateUTC
A date time field that indicates the date and time this journal was created.
TrackingCategory1ID
A guid field that provides the id of the first tracking category.
TrackingCategory1Name
A text field provides the name of the first tracking category.
TrackingOption1ID
A guid field that provides the id of the first tracking category option.
TrackingOption1Name
A text field provides the name of the first tracking category option.
TrackingCategory2ID
A guid field that provides the id of the second tracking category.
TrackingCategory2Name
A text field provides the name of the second tracking category.
TrackingOption2ID
A guid field that provides the id of the second tracking category option.
TrackingOption2Name
A text field provides the name of the second tracking category option.


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Endpoints

Accounts
JournalsAccrual
JournalsCash
TaxRates
TrackingCategories


Related Topics

Xero Accounting Models
Xero Accounting Endpoints