Exporting Overpayments from Xero

This task will download overpayments from Xero in XML format.

Note

Overpayments can be created using the Import Bank Transactions task, by specifying a type of 'SpendOverpayment' or 'ReceiveOverpayment'.

Settings

Connection

Required
The Xero connection use when running this task.

Output File

Required
The file to save results from this task. The results are returned as an array of the object as detailed in the example below.

Export All

Required Set to true to export all records, or false to only export records since the time shown in the Export From setting.

Export From

Required The rolling date to export modified records from. This will update automatically when the task runs. This setting only takes affect when Export All is set to false.

Filter

Optional
Specify criteria to filter the records on e.g. Status == "Authorised"

Zynk Settings

See Common Task Settings

Examples

Sample output file showing an overpayment:

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfXeroOverpayment>
  <XeroOverpayment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Errors />
    <Warnings />
    <ValidationStatus>Ok</ValidationStatus>
    <UpdatedDateUtc>2020-10-15T14:39:07.92</UpdatedDateUtc>
    <Id>a8b3a8a6-8bdd-49f5-9b07-826116fb8c55</Id>
    <Contact>
      <ValidationStatus>Ok</ValidationStatus>
      <UpdatedDateUtc xsi:nil="true" />
      <Id>f926539f-5a8b-4c54-83e9-739ff2b3dee3</Id>
      <ContactStatus>Active</ContactStatus>
      <Name>ABS Garages Ltd</Name>
      <IsSupplier xsi:nil="true" />
      <IsCustomer xsi:nil="true" />
      <Discount xsi:nil="true" />
      <HasAttachments xsi:nil="true" />
      <ContactPersons />
      <Addresses />
      <Phones />
      <ContactGroups />
    </Contact>
    <Date>2020-10-15T00:00:00</Date>
    <Status>Authorised</Status>
    <LineAmountTypes>NoTax</LineAmountTypes>
    <LineItems>
      <LineItem>
        <ValidationStatus>Ok</ValidationStatus>
        <Description>Product</Description>
        <Quantity>1.0000</Quantity>
        <UnitAmount>10.00</UnitAmount>
        <AccountCode>2100C</AccountCode>
        <TaxType>NONE</TaxType>
        <TaxAmount>0.00</TaxAmount>
        <LineAmount>10.00</LineAmount>
        <DiscountRate xsi:nil="true" />
        <Tracking />
        <LineItemId>31bc53d5-ff16-4827-9dfa-6d3b7fe14f1e</LineItemId>
      </LineItem>
    </LineItems>
    <SubTotal>10.00</SubTotal>
    <TotalTax>0.00</TotalTax>
    <Total>10.00</Total>
    <CurrencyCode>GBP</CurrencyCode>
    <CurrencyRate xsi:nil="true" />
    <Type>SpendOverpayment</Type>
    <RemainingCredit>10.00</RemainingCredit>
    <HasAttachments>false</HasAttachments>
    <Allocations />
    <Payments />
    <ExternalId>3985791</ExternalId>
  </XeroOverpayment>
</ArrayOfXeroOverpayment>