Xero Accounting Endpoint: GetExpenseClaimDetail
Jump to navigation
Jump to search
Overview
IMPORTANT: The Expense Claim functionality in Xero was DEPRECATED in 2018. This endpoint is only provided for backwards compatibility reasons for those that still have access to this functionality and require this data.
The Xero GetExpenseClaimDetail endpoint provides all fields for a single expense claim. It should be used along with the ExpenseClaims endpoint.
It is a function that accepts a series of parameters.
Parameters
The GetExpenseClaimDetail is a function that accepts the following parameters.
- ExpenseClaimID
- A guid field that determines the expense claim for which to retrieve data.
- This field is mandatory.
Fields
The following fields are available for the GetExpenseClaimDetail endpoint.
- DataFile
- A record field that identifies the source data file for this record.
- ExpenseClaimID
- A guid field that provides the id of the expense claim.
- ReportingDate
- A date field that provides the date when he expense claim applies for Profit and Loss basis.
- PaymentDueDate
- A date field that provides the date when the payment is due.
- Status
- A text field that indicates the status of the expense claim.
- Possible values are:
- DRAFT: Indicates the expense claim is a draft.
- SUBMITTED: Indicates the expense claim is awaiting approval.
- AUTHORISED: Indicates the expense claim is approved and awaiting payment or partially paid.
- PAID: Indicates the expense claim is completely paid.
- VOIDED: Indicates the expense claim is voided.
- DELETED: Indicates the expense claim is deleted.
- Total
- A decimal field that provides the total amount of the transaction.
- AmountDue
- A decimal field that provides the total amount due.
- AmountPaid
- A decimal field that provides the total amount paid.
- Receipts
- A table field that provides the list of receipts applied to the expense claim.
- See Receipts Fields for more information.
- Payments
- A table field that provides the list of payments applied to the expense claim.
- See Payments Fields for more information.
- UpdatedDateUTC
- A date time field that indicates the date and time this invoice was created and/or updated.
Receipts Fields
The Receipts Fields include the following sub fields.
- ReceiptID
- A guid field that provides the id of the receipt.
- ReceiptNumber
- A text field that provides the receipt number.
- Date
- A date field that provides the date of the receipt.
- Reference
- A text field that provides the reference of the receipt.
- Status
- A text field that indicates the status of the receipt.
- Possible values are:
- DRAFT: Indicates the expense claim is a draft.
- SUBMITTED: Indicates the expense claim is awaiting approval.
- AUTHORISED: Indicates the expense claim is approved and awaiting payment or partially paid.
- PAID: Indicates the expense claim is completely paid.
- VOIDED: Indicates the expense claim is voided.
- DELETED: Indicates the expense claim is deleted.
- Contact
- A record field that provides the Contacts associated with the receipt.
- LineAmountTypes
- A text field that indicates the type of values on the lines.
- Possible values are:
- Exclusive: Indicates that line items are exclusive of tax.
- Inclusive: Indicates that line items are inclusive tax.
- NoTax: Indicates that line items have no tax.
- LineItems
- A table field that provides the receipt lines.
- See LineItems Fields for more information.
- Subtotal
- A decimal field that provides the tax exclusive amount of the transaction.
- TotalTax
- A decimal field that provides the tax amount of the transaction.
- Total
- A decimal field that provides the total amount of the transaction.
- UpdatedDateUTC
- A date time field that indicates the date and time this receipt was created and/or updated.
LineItems Fields
The LineItems Fields include the following sub fields.
- Description
- A text field that provides the description of the line.
- Quantity
- A decimal field that provides the quantity of the line.
- UnitAmount
- A decimal field that provides the unit amount of the line.
- LineAmount
- A decimal field that provides the amount of the line.
- TaxAmount
- A decimal field that provides the tax amount of the line.
- DiscountRate
- A decimal field that provides the discount rate applied to the line.
- AccountCode
- A text field that provides the account code of the line.
- TaxType
- A text field that provides the tax type of the line.
- Tracking
- A table field that provides the tracking category options assigned to the line.
Payments Fields
The Payments Fields include the following sub fields.
- Date
- A date field that provides the date on which the link occurred.
- Reference
- A text field that provides the reference.
- Amount
- A decimal field that provides the amount associated with the payment.
- AccountCode
- A record field that provides the account for the payment.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints