ExpenseClaims
Query, insert and update expense claims for a Xero organisation.
Table Specific Information
The ExpenseClaims table allows you to SELECT, INSERT, and UPDATE expense claims for a Xero organization.
SELECT
The Xero API allows extensive filtering and ordering. You can define WHERE and ORDER BY clauses in a query to filter and order the results using any non-line-item column.
Note: The Xero API does not support filtering on line items or journal lines.
INSERT
To create a new expense claim record, the UserId field must be defined; in addition, at least one ReceiptId must be specified. One can be provided either via the ReceiptId column:
INSERT INTO ExpenseClaims (UserId, ReceiptId) VALUES (
'XXXXX-XXXXX-XXXXX-XXXXX', 'YYYYY-YYYYY-YYYYY-YYYYY'
)
Multiple may also be specified by including them in the ReceiptAggregate:
INSERT INTO ExpenseClaims (UserId, ReceiptAggregate) VALUES (
'XXXXX-XXXXX-XXXXX-XXXXX',
'<Receipt>
<ReceiptID>YYYYY-YYYYY-YYYYY-YYYYY</ReceiptID>
</Receipt>
<Receipt>
<ReceiptID>ZZZZZ-ZZZZZ-ZZZZZ-ZZZZZ</ReceiptID>
</Receipt>'
)
UPDATE
You can update any field that is not read-only.
Note: UPDATE operations will count as two operations against the Xero API. One is required to retrieve the existing record, and another to update the record with new data.
Columns
Name | Type | ReadOnly | Description |
ExpenseClaimId [KEY] | String | True |
The unique identifier of the expense claim. |
UserId | String | False |
The Id of the associated user. |
ReceiptAggregate | String | False |
Used to define Receipt rows using XML values. Should be provided on INSERT only. |
ReceiptId | String | False |
The Id of the receipt. |
Status | String | True |
The status code for the expense claim. The valid values are SUBMITTED, AUTHORISED, and PAID. |
UpdatedDateUTC | Datetime | True |
The date when the expense claim was last updated. |
Total | Decimal | True |
The total amount of an expense claim being paid. |
AmountDue | Decimal | True |
The amount due to be paid for an expense claim. |
AmountPaid | Decimal | True |
The amount still to pay for an expense claim. |
PaymentDueDate | Date | True |
The date when the expense claim is due to be paid. |
ReportingDate | Date | True |
The date the expense claim will be reported in Xero. |
TenantId | String | False |
The ID of the tenant to query instead of the connection tenant |