Xero - Delete, Find, Get Records — Streamline Your Business Processes With A Single Click.

Estimated reading time: 13 min

What your automation will do…

A connection to your Xero account is needed so we can sync it with our platform.
Refer to Xero – Connection

You can include between 1 and 255 Methods to build complex Flows.

Xero Methods List and Settings Copy Link

DELETE RECORDS Copy Link

Use this Method to Delete Contact Groups, Tracking Categories, Batch Payments and Folders by providing the ID.

Configuration Table:

Input Options (Field Mapping):

Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
Default Value: Select value from a defined list or specify a fixed attribute.
Manual input: Set a custom value by using the Lightning Bold feature.

Name*	Delete Record
Connection*	Select your connection or create one.
Entity* (Set of data that contain records)	Select the available Entities to delete record from:Contact Groups, Tracking Categories, Batch Payments and Folders.

ID*	Unique Identifier of the records.Tip: Get ID and Code value (for example Contact ID) from Method “Get Records“, “Find Record” or from Trigger “Get all Records of an Entity“.
Tenant	Optionally select a specific Organization (for Xero Account with multiple Organisations). Select Input > Lookup tab > Select Search button to display a list.

(*) required field

Example of Delete Tracking Category

{
  "Name": "new tracking category",
  "Status": "DELETED",
  "TrackingCategoryID": "f9593a2c-9eb2-470c-b6c5-b23d9cf3bbb6",
  "Options": []
}

FIND RECORD Copy Link

Use this Method to Find a specific record by adding criterias to the search.

Configuration Table:

Input Options (Field Mapping):

Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
Default Value: Select value from a defined list or specify a fixed attribute.
Manual input: Set a custom value by using the Lightning Bold feature.

Name*	Find Record
Connection*	Select your connection or create one.
Entity* (Set of data that contain records)	Select the available Entities to find records:Invoice, Payment, Batch Payment, Account, Contact, Bank Transaction, Credit Note, Quote, Manual Journal, Item, Purchase Order, Contact Groups, Asset, Asset Type, Tracking Category, Folder.
MATCHING CRITERIA [+ Add Field] Add a specific field in the search.
Tenant Available in All entities.	Optionally select a specific Organization (for Xero Account with multiple Organisations). Select Input > Lookup tab > Select Search button to display a list.
Entity Invoice	Available fields to filter the search:Type, Invoice ID, Invoice Number, Reference, Date, Due Date, Status, Currency Code. ▪️ When you retrieve multiple invoices, only a summary of the contact is returned and no line details are returned – this is to keep the response more compact. ▪️ The line item details will be returned when you retrieve an individual invoice, either by specifying Invoice ID, Invoice Number, querying by Statuses or by using the optional paging parameter (below). ▪️ When you retrieve invoices by Statuses, pagination is enforced by default.
Entity Payment	Available fields to filter the search: Payment Type, Status.
Entity Batch Payment	Available fields to filter the search: Type, Account ID, Status.
Entity Account	Available fields to filter the search: Account ID, Name, Type.
Entity Contact	Available fields to filter the search: Contact ID, Name, FirstName, LastName, Contact Number, Contact Status, Email Address.
Entity Bank Transaction	▪️ This does not return payments applied to invoices, expense claims or transfers between bank accounts.Available fields to filter the search: Bank Transaction ID, Type.
Entity Credit Note	Available fields to filter the search: Credit Note Number, Type.
Entity Quote	Available fields to filter the search: Status, Quote Number.
Entity Manual Journal	Available fields to filter the search: Status, Narration.
Entity Item	Available fields to filter the search: Code, Name.
Entity Purchase Order	Available fields to filter the search: Status, Type, Purchase Order Number.
Entity Contact Groups	Available fields to filter the search: Contact Group Name, Status.
Entity Asset	Available fields to filter the search: Asset Name, Asset Number, Status.
Entity Asset Type	Available fields to filter the search: Asset Type Name
Entity Tracking Category	Available fields to filter the search: Name, Status.
Entity Folder	Available fields to filter the search: Name

(*) required field

Example of responses:

Find Invoice by providing Invoice ID

{
  "Type": "ACCREC",
  "InvoiceID": "fee88eea-f2aa-4a71-a372-33d6d83d3c45",
  "InvoiceNumber": "INV-0027",
  "Reference": "Ref MK815",
  "Prepayments": [],
  "Overpayments": [],
  "AmountDue": 396,
  "AmountPaid": 0,
  "SentToContact": false,
  "CurrencyRate": 1,
  "IsDiscounted": false,
  "HasAttachments": false,
  "HasErrors": false,
  "Attachments": [],
  "InvoicePaymentServices": [],
  "Contact": {
    "ContactID": "5b96e86b-418e-48e8-8949-308c14aec278",
    "ContactStatus": "ACTIVE",
    "Name": "Marine Systems",
    "EmailAddress": "",
    "BankAccountDetails": "",
    "Addresses": [
      {
        "AddressType": "POBOX",
        "City": "",
        "Region": "",
        "PostalCode": "",
        "Country": ""
      },
      {
        "AddressType": "STREET",
        "City": "",
        "Region": "",
        "PostalCode": "",
        "Country": ""
      }
    ],
    "Phones": [
      {
        "PhoneType": "FAX",
        "PhoneNumber": "",
        "PhoneAreaCode": "",
        "PhoneCountryCode": ""
      },
      {
        "PhoneType": "MOBILE",
        "PhoneNumber": "",
        "PhoneAreaCode": "",
        "PhoneCountryCode": ""
      },
      {
        "PhoneType": "DDI",
        "PhoneNumber": "",
        "PhoneAreaCode": "",
        "PhoneCountryCode": ""
      },
      {
        "PhoneType": "DEFAULT",
        "PhoneNumber": "",
        "PhoneAreaCode": "",
        "PhoneCountryCode": ""
      }
    ],
    "UpdatedDateUTC": "2025-02-19T18:03:41+00:00",
    "ContactGroups": [],
    "IsSupplier": false,
    "IsCustomer": true,
    "DefaultCurrency": "USD",
    "SalesTrackingCategories": [],
    "PurchasesTrackingCategories": [],
    "ContactPersons": [],
    "HasValidationErrors": false
  },
  "DateString": "2025-02-18T00:00:00",
  "Date": "2025-02-18T00:00:00+00:00",
  "DueDateString": "2025-02-24T00:00:00",
  "DueDate": "2025-02-24T00:00:00+00:00",
  "BrandingThemeID": "d613f7f9-8fcb-477f-97f0-31eb85b7e5cf",
  "Status": "AUTHORISED",
  "LineAmountTypes": "Inclusive",
  "LineItems": [
    {
      "Description": "Marketing guides",
      "UnitAmount": 99,
      "TaxType": "OUTPUT",
      "TaxAmount": 30.18,
      "LineAmount": 396,
      "AccountCode": "200",
      "Tracking": [],
      "Quantity": 4,
      "LineItemID": "8dd05881-be4a-4765-b95e-cce0d7395f9f",
      "AccountID": "d1ebb97b-d207-4ccb-9ab6-8a466a8b4d39",
      "ValidationErrors": []
    }
  ],
  "SubTotal": 365.82,
  "TotalTax": 30.18,
  "Total": 396,
  "UpdatedDateUTC": "2008-12-19T01:37:59+00:00",
  "CurrencyCode": "USD"
}

Expand

Find all ACCREC PAYMENT payments with an AUTHORISED status

{
  "Payments": [
    {
      "PaymentID": "b26fd49a-cbae-470a-a8f8-bcbc119e0379",
      "BatchPaymentID": "b54aa50c-794c-461b-89d1-846e1b84d9c0",
      "BatchPayment": {
        "Account": {
          "AccountID": "ac993f75-035b-433c-82e0-7b7a2d40802c"
        },
        "BatchPaymentID": "b54aa50c-794c-461b-89d1-846e1b84d9c0",
        "Date": "\/Date(1455667200000+0000)\/",
        "Type": "RECBATCH",
        "Status": "AUTHORISED",
        "TotalAmount": "600.00",
        "UpdatedDateUTC": "\/Date(1289572582537+0000)\/",
        "IsReconciled": "true"
      },
      "Date": "\/Date(1455667200000+0000)\/",
      "BankAmount": 500.00,
      "Amount": 500.00,
      "Reference": "INV-0001",
      "CurrencyRate": 1.000000,
      "PaymentType": "ACCRECPAYMENT",
      "Status": "AUTHORISED",
      "UpdatedDateUTC": "\/Date(1289572582537+0000)\/",
      "HasAccount": true,
      "IsReconciled": true,
      "Account": {
        "AccountID": "ac993f75-035b-433c-82e0-7b7a2d40802c",
        "Code": "090"
      },
      "Invoice": {
        "Type": "ACCREC",
        "InvoiceID": "b0875d8b-ff26-4ce8-8aea-6955492ead48",
        "InvoiceNumber": "INV-0001",
        "Contact": {
          "ContactID": "fef6755f-549b-4617-b1e9-60bdffb517d8",
          "Name": "Ridgeway University"
        }
      }
    }
  ]
}

Expand

Find an individual batch payment (NZ)

{
  "BatchPayments": [
    {
      "Account": {
        "AccountID": "13918178-849a-4823-9a31-57b7eac713d7"
      },
      "Reference": "ref",
      "BatchPaymentID": "44a1013e-4946-4a73-b207-dfe5424a5ea5",
      "DateString": "2018-10-03T00:00:00",
      "Date": "/Date(1538524800000+0000)/",
      "Payments": [
        {
          "Invoice": {
            "InvoiceID": "5aa9451d-95d1-4f95-a966-bbab2573f71c",
            "Payments": [],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "HasErrors": false,
            "IsDiscounted": false,
            "LineItems": []
          },
          "PaymentID": "a22a64cb-364e-43fa-9a1f-bb2cd1f4adde",
          "Reference": "ref/cheque",
          "Amount": 913.55
        },
        {
          "Invoice": {
            "InvoiceID": "30a87092-31b5-4a2c-831e-327486533dd2",
            "Payments": [],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "HasErrors": false,
            "IsDiscounted": false,
            "LineItems": []
          },
          "PaymentID": "6e20be79-32d8-4ae1-978e-f76d9b245c02",
          "Amount": 495
        },
        {
          "Invoice": {
            "InvoiceID": "86d6e00f-ef56-49f7-9a54-796ccd5ca057",
            "Payments": [],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "HasErrors": false,
            "IsDiscounted": false,
            "LineItems": []
          },
          "PaymentID": "4ba761b8-5940-4a3f-bcdf-7775adb00332",
          "Amount": 3080
        }
      ],
      "Type": "RECBATCH",
      "Status": "AUTHORISED",
      "TotalAmount": 4488.55,
      "UpdatedDateUTC": "/Date(1538525239370+0000)/",
      "IsReconciled": false
    }
  ]
}

Expand

Find Accounts

{
  "Accounts": [{
    "AccountID": "ebd06280-af70-4bed-97c6-7451a454ad85",
    "Code": "091",
    "Name": "Business Savings Account",
    "Type": "BANK",
    "TaxType": "NONE",
    "EnablePaymentsToAccount": false,
    "BankAccountNumber": "0209087654321050",
    "BankAccountType": "BANK",
    "CurrencyCode": "NZD"
  },{
    "AccountID": "7d05a53d-613d-4eb2-a2fc-dcb6adb80b80",
    "Code": "200",
    "Name": "Sales",
    "Type": "REVENUE",
    "TaxType": "OUTPUT2",
    "Description": "Income from any normal business activity",
    "EnablePaymentsToAccount": false
  }]
}

Expand

Find an individual Account

{
  "Accounts": [{
    "AccountID": "297c2dc5-cc47-4afd-8ec8-74990b8761e9",
    "Code": "300",
    "Name": "Purchases",
    "Type": "DIRECTCOSTS",
    "TaxType": "INPUT2",
    "Description": "Goods purchased with the intention of selling these to customers",
    "EnablePaymentsToAccount": false
  }]
}

Find Contacts

{
  "Contacts": [
    {
      "ContactID": "bd2270c3-8706-4c11-9cfb-000b551c3f51",
      "ContactStatus": "ACTIVE",
      "Name": "ABC Limited",
      "FirstName": "Andrea",
      "LastName": "Dutchess",
      "CompanyNumber": "NumberBusiness1234",
      "EmailAddress": "a.dutchess@abclimited.com",
      "BankAccountDetails": "45465844",
      "TaxNumber": "415465456454",
      "AccountsReceivableTaxType": "INPUT2",
      "AccountsPayableTaxType": "OUTPUT2",
      "Addresses": [
        {
          "AddressType": "POBOX",
          "AddressLine1": "P O Box 123",
          "City": "Wellington",
          "PostalCode": "6011",
          "AttentionTo": "Andrea"
        },{
          "AddressType": "STREET"
        }
      ],
      "Phones": [
        {
          "PhoneType": "DEFAULT",
          "PhoneNumber": "1111111",
          "PhoneAreaCode": "04",
          "PhoneCountryCode": "64"
        },{
          "PhoneType": "FAX"
        },{
          "PhoneType": "MOBILE"
        },{
          "PhoneType": "DDI"
        }
      ],
      "UpdatedDateUTC": "\/Date(1488391422280+0000)\/",
      "IsSupplier": false,
      "IsCustomer": true,
      "DefaultCurrency": "NZD"
    },{
      "ContactID": "6d42f03b-181f-43e3-93fb-2025c012de92"
      ...
    }
  ]
}

Expand

Find an individual Contact

{
  "Contacts": [
    {
      "ContactID": "bd2270c3-8706-4c11-9cfb-000b551c3f51",
      "ContactStatus": "ACTIVE",
      "Name": "ABC Limited",
      "FirstName": "Andrea",
      "LastName": "Dutchess",
      "CompanyNumber": "NumberBusiness1234",
      "EmailAddress": "a.dutchess@abclimited.com",
      "BankAccountDetails": "45465844",
      "TaxNumber": "415465456454",
      "AccountsReceivableTaxType": "INPUT2",
      "AccountsPayableTaxType": "OUTPUT2",
      "Addresses": [
        {
          "AddressType": "POBOX",
          "AddressLine1": "P O Box 123",
          "City": "Wellington",
          "PostalCode": "6011",
          "AttentionTo": "Andrea"
        },{
          "AddressType": "STREET"
        }
      ],
      "Phones": [
        {
          "PhoneType": "DEFAULT",
          "PhoneNumber": "1111111",
          "PhoneAreaCode": "04",
          "PhoneCountryCode": "64"
        },{
          "PhoneType": "FAX"
        },{
          "PhoneType": "MOBILE"
        },{
          "PhoneType": "DDI"
        }
      ],
      "UpdatedDateUTC": "\/Date(1488391422280+0000)\/",
      "IsSupplier": false,
      "IsCustomer": true,
      "DefaultCurrency": "NZD"
    }
  ]
}

Expand

Find a single Bank Transaction

{
  "BankTransactions": [{
    "Contact": {
      "ContactID": "6d42f03b-181f-43e3-93fb-2025c012de92",
      "Name": "Wilson Periodicals"
    },
    "DateString": "2014-05-26T00:00:00",
    "Date": "\/Date(1401062400000+0000)\/",
    "Status": "AUTHORISED",
    "LineAmountTypes": "Inclusive",
    "LineItems": [{
      "Description": "Monthly account fee",
      "UnitAmount": "49.90",
      "TaxType": "NONE",
      "TaxAmount": "0.00",
      "LineAmount": "49.90",
      "AccountCode": "404",
      "Quantity": "1.0000",
      "LineItemID": "52208ff9-528a-4985-a9ad-b2b1d4210e38"
    }],
    "SubTotal": "49.90",
    "TotalTax": "0.00",
    "Total": "49.90",
    "UpdatedDateUTC": "\/Date(1439434356790+0000)\/",
    "CurrencyCode": "NZD",
    "BankTransactionID": "d20b6c54-7f5d-4ce6-ab83-55f609719126",
    "BankAccount": {
      "AccountID": "ac993f75-035b-433c-82e0-7b7a2d40802c",
      "Code": "090",
      "Name": "Business Bank Account"
    },
    "BatchPayment": {
      "Account": {
        "AccountID": "ac993f75-035b-433c-82e0-7b7a2d40802c"
      },
      "BatchPaymentID": "b54aa50c-794c-461b-89d1-846e1b84d9c0",
      "Date": "\/Date(1401062400000+0000)\/",
      "Type": "RECBATCH",
      "Status": "AUTHORISED",
      "TotalAmount": "100.00",
      "UpdatedDateUTC": "\/Date(1439434356790+0000)\/",
      "IsReconciled": "true"
    },
    "Type": "SPEND",
    "Reference": "Sub 098801",
    "IsReconciled": "true"
  }]
}

Expand

Find a collection of Bank Transactions

{
  "BankTransactions": [{
    "Contact": {
      "ContactID": "c09661a2-a954-4e34-98df-f8b6d1dc9b19",
      "Name": "BNZ"
    },
    "DateString": "2014-05-26T00:00:00",
    "Date": "\/Date(1401062400000+0000)\/",
    "LineAmountTypes": "Inclusive",
    "SubTotal": "15.00",
    "TotalTax": "0.00",
    "Total": "15.00",
    "UpdatedDateUTC": "\/Date(1519250319570+0000)\/",
    "FullyPaidOnDate": "\/Date(1439434356790+0000)\/",
    "BankTransactionID": "d20b6c54-7f5d-4ce6-ab83-55f609719126",
    "BankAccount": {
      "AccountID": "297c2dc5-cc47-4afd-8ec8-74990b8761e9",
      "Code": "BANK"
    },
    "Type": "SPEND",
    "IsReconciled": "true"
  },{
    ...
  }]
}

Expand

Find Credit Note (Without Paging)

{
  "CreditNotes": [
    {
      "Contact": {
        "ContactID": "c6c7b870-bb4d-489a-921e-2f0ee4192ff9",
        "Name": "Test Apply Credit Note"
      },
      "DateString": "2016-12-16T00:00:00",
      "Date": "\/Date(1481846400000+0000)\/",
      "Status": "PAID",
      "LineAmountTypes": "Inclusive",
      "SubTotal": 86.96,
      "TotalTax": 13.04,
      "Total": 100.00,
      "UpdatedDateUTC": "\/Date(1290168061547+0000)\/",
      "CurrencyCode": "NZD",
      "FullyPaidOnDate": "\/Date(1481846400000+0000)\/",
      "Type": "ACCRECCREDIT",
      "CreditNoteID": "aea95d78-ea48-456b-9b08-6bc012600072",
      "CreditNoteNumber": "CN-0002",
      "CurrencyRate": 1.000000,
      "RemainingCredit": 0.00,
      "Allocations": [
        {
          "AllocationID": "b12335f4-a1e5-4431-aeb4-488e5547558e",
          "Amount": 100.00,
          "Date": "\/Date(1481846400000+0000)\/",
          "Invoice": {
            "InvoiceID": "87cfa39f-136c-4df9-a70d-bb80d8ddb975",
            "InvoiceNumber": "INV-0001"
          }
        }
      ]
    }
  ]
}

Expand

Find Single Credit Note

{
  "CreditNotes": [
    {
      "Contact": {
        "ContactID": "d0cd2c4f-18a0-4f7c-a32a-2db00f29d298",
        "ContactStatus": "ACTIVE",
        "Name": "PC Complete"
        ...
      },
      "DateString": "2017-02-07T00:00:00",
      "Date": "\/Date(1486425600000+0000)\/",
      "DueDate": "\/Date(1486425600000+0000)\/",
      "Status": "PAID",
      "LineAmountTypes": "Exclusive",
      "LineItems": [
        {
          "Description": "Internal DVD drive couldn't be supplied, backorder (Oliver laptop)",
          "UnitAmount": 199.00,
          "TaxType": "INPUT",
          "TaxAmount": 19.90,
          "LineAmount": 199.00,
          "AccountCode": "453",
          "AccountId": "fc8f0c5e-a3dc-4de3-ab8d-37ae0e5d152f",
          "Tracking": [
            {
              "Name": "Region",
              "Option": "North",
              "TrackingCategoryID": "093af706-c2aa-4d97-a4ce-2d205a017eac",
              "TrackingOptionID": "3f05cdf9-246b-46a2-bf6f-441da1b09b89"
            }
          ],
          "Quantity": 1.0000
        }
      ],
      "SubTotal": 199.00,
      "TotalTax": 19.90,
      "Total": 218.90,
      "UpdatedDateUTC": "\/Date(1290777947340+0000)\/",
      "CurrencyCode": "AUD",
      "FullyPaidOnDate": "\/Date(1486425600000+0000)\/",
      "Type": "ACCPAYCREDIT",
      "RemainingCredit": 0.00,
      "Allocations": [
        {
          "AllocationID": "b12335f4-a1e5-4431-aeb4-488e5547558e",
          "Amount": 218.90,
          "Date": "\/Date(1486425600000+0000)\/",
          "Invoice": {
            "InvoiceID": "673dd7cc-beb7-4697-83d4-0c47cb400cc2"
          }
        }
      ],
      "HasAttachments": false,
      "CreditNoteID": "7df8949c-b71f-40c0-bbcf-39f2f450f286",
      "CreditNoteNumber": "03391"
    }
  ]
}

Expand

Find a collection of Quotes

{
  "Id": "a5325919-874c-4e7c-bcb0-5b149de392c8",
  "Status": "OK",
  "ProviderName": "Adam Public",
  "DateTimeUTC": "/Date(1574029615275)/",
  "Quotes": [
    {
      "QuoteID": "68e9965d-8d22-4e22-a01c-ee0a78fb3ea1",
      "QuoteNumber": "QU-0010",
      "Reference": "REF-123",
      "Terms": "Quote valid until the end of the month",
      "Contact": {
        "ContactID": "42771b60-19a7-4692-af81-dd9f9b9362d4",
        "Name": "ABC Furniture",
        "EmailAddress": "info@abfl.com",
        "FirstName": "Trish",
        "LastName": "Rawlings"
      },
      "LineItems": [
        {
          "LineItemID": "060f0936-5818-4b31-acbd-6c733dafbc1a",
          "AccountCode": "200",
          "Description": "Development work - developer onsite per day",
          "UnitAmount": 650.0000,
          "DiscountRate": 10.00,
          "LineAmount": 585.00,
          "ItemCode": "DevD",
          "Quantity": 1.0000,
          "TaxAmount": 58.50,
          "TaxType": "OUTPUT",
          "Tracking": [
            {
              "TrackingCategoryID": "093af706-c2aa-4d97-a4ce-2d205a017eac",
              "TrackingOptionID": "ae777a87-5ef3-4fa0-a4f0-d10e1f13073a",
              "Name": "Region",
              "Option": "Eastside"
            }
          ]
        }
      ],
      "Date": "/Date(1574035200000)/",
      "DateString": "2019-11-18T00:00:00",
      "ExpiryDate": "/Date(1575072000000)/",
      "ExpiryDateString": "2019-11-30T00:00:00",
      "Status": "DRAFT",
      "CurrencyRate": 0.901366,
      "CurrencyCode": "CAD",
      "SubTotal": 585.00,
      "TotalTax": 58.50,
      "Total": 643.50,
      "TotalDiscount": 65.00,
      "Title": "Quote for dev work",
      "Summary": "As discussed",
      "BrandingThemeID": "2ced98b8-3be9-42c4-ae79-fe3c8bca3490",
      "UpdatedDateUTC": "/Date(1574029509507)/",
      "LineAmountTypes": "EXCLUSIVE"
    }
    ...
  ]
}

Expand

Find a collection of Manual Journals (Without Paging)

{
  "ManualJournals": [
    {
      "Date": "\/Date(1486166400000+0000)\/",
      "Status": "DRAFT",
      "LineAmountTypes": "NoTax",
      "UpdatedDateUTC": "\/Date(1291226902527+0000)\/",
      "ManualJournalID": "99ff1108-2d9a-4955-ac7e-e705aa1b9547",
      "Narration": "Prepaid our insurance a year in advance",
      "ShowOnCashBasisReports": true
    },{
      "Date": "\/Date(1488240000000+0000)\/",
      "Status": "POSTED",
      "LineAmountTypes": "NoTax",
      "UpdatedDateUTC": "\/Date(1291227505357+0000)\/",
      "ManualJournalID": "e5f09a63-62db-4739-af7c-1deda351ed5a",
      "Narration": "Prepaid our phone a year in advance",
      "ShowOnCashBasisReports": true
    }
  ]
}

Expand

Find a single Manual Journals

{
  "ManualJournals": [
    {
      "Date": "\/Date(1486166400000+0000)\/",
      "Status": "POSTED",
      "LineAmountTypes": "NoTax",
      "UpdatedDateUTC": "\/Date(1291226902527+0000)\/",
      "ManualJournalID": "c53ebb10-c046-471b-9919-29ac6b9fb977",
      "Narration": "Coded incorrectly Office Equipment should be Computer Equipment",
      "JournalLines": [
        {
          "Description": "Coded incorrectly Office Equipment should be Computer Equipment",
          "TaxType": "NONE",
          "TaxAmount": 0.00,
          "LineAmount": -2569.00,
          "AccountCode": "720",
          "Tracking": [],
          "IsBlank": false
        },
        {
          "Description": "Coded incorrectly Computer Equipment should be Office Equipment",
          "TaxType": "NONE",
          "TaxAmount": 0.00,
          "LineAmount": 2569.00,
          "AccountCode": "710",
          "Tracking": [],
          "IsBlank": false
        }
      ],
      "ShowOnCashBasisReports": true,
      "HasAttachments": false
    }
  ]
}

Expand

Find an individual Items

{
  "Items": [
    {
      "ItemID": "9a59ea90-942e-484d-9b71-d00ab607e03b",
      "Code": "Merino-2011-LG",
      "Description": "2011 Merino Sweater - LARGE",
      "UpdatedDateUTC": "\/Date(1488338552390+0000)\/",
      "PurchaseDetails": {
        "UnitPrice": 149.0000,
        "AccountCode": "300"
      },
      "SalesDetails": {
        "UnitPrice": 299.0000,
        "AccountCode": "200"
      }
    }
  ]
}

Find a collection of Items

{
  "Items": [
    {
      "ItemID": "19b79d12-0ae1-496e-9649-cbd04b15c7c5",
      "Code": "UnTrackedThing",
      "Description": "I sell this untracked thing",
      "PurchaseDescription": "I buy this untracked thing",
      "UpdatedDateUTC": "\/Date(1488338552390+0000)\/",
      "PurchaseDetails": {
        "UnitPrice": 20.0000,
        "AccountCode": "400",
        "TaxType": "NONE"
      },
      "SalesDetails": {
        "UnitPrice": 40.0000,
        "AccountCode": "200",
        "TaxType": "OUTPUT2"
      },
      "Name": "An Untracked Item",
      "IsTrackedAsInventory": false,
      "IsSold": true,
      "IsPurchased": true
    },
    {
      "ItemID": "90a72d44-43e4-410d-a68b-1139ef0c0c07",
      "Code": "TrackedThing",
      "Description": "I sell this tracked thing",
      "PurchaseDescription": "I purchase this tracked thing",
      "UpdatedDateUTC": "\/Date(1488338552390+0000)\/",
      "PurchaseDetails": {
        "UnitPrice": 20.0000,
        "COGSAccountCode": "430",
        "TaxType": "NONE"
      },
      "SalesDetails": {
        "UnitPrice": 40.0000,
        "AccountCode": "200",
        "TaxType": "OUTPUT2"
      },
      "Name": "Tracked Thing",
      "IsTrackedAsInventory": true,
      "InventoryAssetAccountCode": "630",
      "TotalCostPool": 200.00,
      "QuantityOnHand": 10.0000,
      "IsSold": true,
      "IsPurchased": true
    }
  ]
}

Expand

Find Contact Groups

{
  "ContactGroups": [
    {
      "ContactGroupID": "97bbd0e6-ab4d-4117-9304-d90dd4779199",
      "Name": "VIP Customers",
      "Status": "ACTIVE"
    },{
      "ContactGroupID": "d0c68f1a-e5dd-4a45-aa02-27d8fdbfd562",
      "Name": "Preferred Suppliers",
      "Status": "ACTIVE"
    }
  ]
}

Expand

Find Single Contact Group

{
  "ContactGroups": [
    {
      "ContactGroupID": "97bbd0e6-ab4d-4117-9304-d90dd4779199",
      "Name": "Adam's Contacts",
      "Status": "ACTIVE",
      "Contacts": [
        {
          "ContactID": "9ce626d2-14ea-463c-9fff-6785ab5f9bfb",
          "Name": "Boom FM"
        },{
          "ContactID": "b9d4332a-26a3-4577-8db2-6e830d4b07cd",
          "Name": "Berry Brew"
        },{
          "ContactID": "2dc0ef7c-582f-4542-963b-dbdc069e4819",
          "Name": "Bayside Wholesale"
        }
      ]
    }
  ]
}

Expand

Find a list of draft Assets

{
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "pageCount": 1,
    "itemCount": 2,
  },
  "items": [
    {
      "assetId": "3b5b3a38-5649-495f-87a1-14a4e5918634",
      "assetName": "Awesome Truck 3",
      "assetNumber": "FA-0013",
      "purchaseDate": "2015-07-01T00:00:00",
      "purchasePrice": 1000,
      "disposalPrice": 0,
      "assetStatus": "Draft",
      "canRollback": true,
      "accountingBookValue": 0
    },
    {
      "assetId": "1fd647b8-c449-42cb-9cc4-cd41fe8df262",
      "assetName": "Awesome Car",
      "assetNumber": "FA-0001",
      "purchaseDate": "2015-07-01T00:00:00",
      "purchasePrice": 100000,
      "disposalPrice": 0,
      "assetStatus": "Draft",
      "bookDepreciationSetting": {
        "depreciationMethod": "StraightLine",
        "averagingMethod": "ActualDays",
        "depreciationRate": 0.01,
        "depreciationCalculationMethod": "None",
        "effectiveFromDate": "2015-07-01T00:00:00",
        "costLimit": 100000,
        "residualValue": 10000,
      },
      "bookDepreciationDetail": {
        "currentCapitalGain": 0,
        "currentGainLoss": 0,
        "priorAccumDepreciationAmount": 0,
        "currentAccumDepreciationAmount": 0
      },
      "canRollback": true,
      "accountingBookValue": 100000
    }
  ]
}

Expand

Find a single Asset

{
  "assetId": "92d04e4407404c1facd6edbbceac7faa",
  "assetName": "Computer",
  "assetNumber": "FA-0021",
  "purchaseDate": "2016-04-11T00:00:00",
  "purchasePrice": 3000,
  "serialNumber": "123456789",
  "warrantyExpiryDate": "2018-04-11T00:00:00",
  "assetTypeId": "5da209c55e194a43b92571b776c49ced",
  "description": "A computer for computing",
  "disposalPrice": 0,
  "assetStatus": "Registered",
  "bookDepreciationSetting": {
    "depreciationMethod": "StraightLine",
    "averagingMethod": "ActualDays",
    "depreciationRate": 33,
    "depreciationCalculationMethod": "None"
    "currentGainLoss": 0,
  },
  "bookDepreciationDetail": {
    "currentCapitalGain": 0,
    "depreciationStartDate": "2016-04-11T00:00:00",
    "priorAccumDepreciationAmount": 0,
    "currentAccumDepreciationAmount": 0
  },
  "canRollback": true,
  "accountingBookValue": 3000
}

Expand

Find a list of Asset Types

[
  {
    "assetTypeId": "5da209c5-5e19-4a43-b925-71b776c49ced",
    "assetTypeName": "Computer Equipment",
    "fixedAssetAccountId": "24e260f1-bfc4-4766-ad7f-8a8ce01de879",
    "depreciationExpenseAccountId": "b23fc79b-d66b-44b0-a240-e138e086fcbc",
    "accumulatedDepreciationAccountId": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694",
    "bookDepreciationSetting": {
      "depreciationMethod": "StraightLine",
      "averagingMethod": "ActualDays",
      "depreciationRate": 33,
      "depreciationCalculationMethod": "None"
    },
    "locks": 0
  },
  {
    "assetTypeId": "a865d898-4ee9-4366-bf37-bfc1b35cf788",
    "assetTypeName": "Office Equipment",
    "fixedAssetAccountId": "24e260f1-bfc4-4766-ad7f-8a8ce01de879",
    "depreciationExpenseAccountId": "b23fc79b-d66b-44b0-a240-e138e086fcbc",
    "accumulatedDepreciationAccountId": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694",
    "bookDepreciationSetting": {
      "depreciationMethod": "StraightLine",
      "averagingMethod": "ActualDays",
      "depreciationRate": 33,
      "depreciationCalculationMethod": "None"
    },
    "locks": 0
  },
  {
    "assetTypeId": "26c17b4a-0093-402c-b9bb-281dedf5c604",
    "assetTypeName": "Vehicles",
    "fixedAssetAccountId": "24e260f1-bfc4-4766-ad7f-8a8ce01de879",
    "depreciationExpenseAccountId": "b23fc79b-d66b-44b0-a240-e138e086fcbc",
    "accumulatedDepreciationAccountId": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694",
    "bookDepreciationSetting": {
      "depreciationMethod": "StraightLine",
      "averagingMethod": "ActualDays",
      "depreciationRate": 33,
      "depreciationCalculationMethod": "None"
    },
    "locks": 0
  }
]

Expand

Find Tracking Categories

{
  "TrackingCategories": [
    {
      "Name": "Region",
      "Status": "ACTIVE",
      "TrackingCategoryID": "351953c4-8127-4009-88c3-f9cd8c9cbe9f",
      "Options": [
        {
          "TrackingOptionID": "ce205173-7387-4651-9726-2cf4c5405ba2",
          "Name": "Eastside",
          "Status": "ACTIVE"
        },
        {
          "TrackingOptionID": "6eb12fdf-63de-4033-98df-be679d84e3c2",
          "Name": "North",
          "Status": "ACTIVE"
        },
        {
          "TrackingOptionID": "6159bdd4-b634-4338-a664-e929aa73f70f",
          "Name": "South",
          "Status": "ACTIVE"
        },
        {
          "TrackingOptionID": "161ad543-97ab-4436-8213-e0d794b1ea90",
          "Name": "West Coast",
          "Status": "ACTIVE"
        }
      ]
    }
  ]
}

Expand

Find Folders

{
 "Name":"Inbox",
 "FileCount":0,
 "Email":"xero.inbox.dxlsh.yth06v9y5u6ak3bz@xerofiles.com",
 "IsInbox":true,
 "Id":"7215cb90-15e1-4949-9fec-690126f1f88f"
},
{
 "Name":"Contracts",
 "FileCount":1,
 "IsInbox":false,
 "Id":"0f8ccf21-7267-4268-9167-a1e2c40c84c8"
}

GET RECORDS Copy Link

Use this Method to retrieves all records from an Entity.

Configuration Table:

Input Options (Field Mapping):

Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
Default Value: Select value from a defined list or specify a fixed attribute.
Manual input: Set a custom value by using the Lightning Bold feature.

Name*	Get Records
Connection*	Select your connection or create one.
Entity* (Set of data that contain records)	Select the available Entities to retrieve records from:Invoice, Payment, Batch Payment, Account, Contact, Linked Transaction, Item, Purchase Order, Contact Groups, Employee, Report, Tax Rate, Asset, Asset Type, Tracking Category, Folder, Tenant, Settings.
MATCHING CRITERIA [+ Add Field] Add a specific field in the search.
Tenant Available in All entities.	Optionally select a specific Organization (for Xero Account with multiple Organisations). Select Input > Lookup tab > Select Search button to display a list.
Entity Invoice	▪️ When you retrieve multiple invoices, only a summary of the contact is returned and no line details are returned – this is to keep the response more compact. ▪️ The line item details will be returned when you retrieve an individual invoice, either by specifying Invoice ID, Invoice Number, querying by Statuses or by using the optional paging parameter (below). ▪️ When you retrieve invoices by Statuses, pagination is enforced by default.See Find Record Method.
Entity Payment	Requests that have more than 100k payments being returned in the response will be denied and receive a 400 response code.
Entity Batch Payment	Retrieve batch payments.
Entity Account	Allows you to retrieve the full chart of accounts.
Entity Contact	Requests that have more than 100k contacts being returned in the response will be denied.
Entity Linked Transaction	Available fields to filter the search:Linked Transaction ID: The Xero identifier for an Linked Transaction. Source Transaction ID: Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice. Contact ID: Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer. Status: Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status Target Transaction ID. Page: Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1.
Entity Item	Retrieve a collection of items.
Entity Purchase Order	When you retrieve multiple purchase orders, paging is enforced by default. 100 purchase orders are returned per page.
Entity Contact Groups	Allows you to retrieve the ContactID and Name of all the contacts in a contact group. Only contact groups with a status of ACTIVE are returned.
Entity Employee	Retrieves Employees within an organisation.
Entity Report	Returns the 1099 report, for all years from 2012, as configured by the rules in the Xero app. The 1099 report includes both the 1099-NEC and 1099-MISC forms for all reports in years 2020 onward. For reports 2019 and prior, only the 1099-MISC form applies. This report is available to US organizations only. To access this report, the user must have the advisor user role in the organization.
Entity Tax Rate	Returns tax rates for an organisation.
Entity Asset	Available fields to filter the search: Status: Required when retrieving a collection of assets.
Entity Asset Type	Retrieve a list of Asset Types.
Entity Tracking Category	Retrieve tracking categories and options.
Entity Folder	Retrieving the list of folders.
Entity Tenant	Retrieve Tenants information.
Entity Settings	Allows you to retrieve the organisation settings for fixed assets.

(*) required field

Example of responses:

Get a collection of Invoices

{
  "Invoices": [
    {
      "Type": "ACCREC",
      "Contact": {
        "ContactID": "025867f1-d741-4d6b-b1af-9ac774b59ba7",
        "Name": "City Agency"
      },
      "Date": "\/Date(1518685950940+0000)\/",
      "DateString": "2009-05-27T00:00:00",
      "DueDate": "\/Date(1518685950940+0000)\/",
      "DueDateString": "2009-06-06T00:00:00",
      "Status": "AUTHORISED",
      "LineAmountTypes": "Exclusive",
      "SubTotal": 1800.00,
      "TotalTax": "225.00",
      "Total": "2025.00",
      "UpdatedDateUTC": "\/Date(1518685950940+0000)\/",
      "CurrencyCode": "NZD",
      "InvoiceID": "243216c5-369e-4056-ac67-05388f86dc81",
      "InvoiceNumber": "OIT00546",
      "AmountDue": "2025.00",
      "AmountPaid": "0.00",
      "AmountCredited": "0.00"
    },
    {
      "Reference": "RPT-DD",
      "Type": "ACCREC",
      "Contact": {
        "ContactID": "06638157-fdfa-47f4-91d0-875b5f5c18c6",
        "Name": "Marine Systems"
      },
      "Date": "\/Date(1518685950940+0000)\/",
      "DateString": "2009-05-27T00:00:00",
      "DueDate": "\/Date(1518685950940+0000)\/",
      "DueDateString": "2009-06-06T00:00:00",
      "Status": "AUTHORISED",
      "LineAmountTypes": "Exclusive",
      "SubTotal": "28.50",
      "TotalTax": "3.56",
      "Total": "32.06",
      "UpdatedDateUTC": "\/Date(1518685950940+0000)\/",
      "CurrencyCode": "NZD",
      "InvoiceID": "03778e72-d541-404a-ab9b-2757aeda76a3",
      "InvoiceNumber": "OIT00542",
      "AmountDue": "32.06",
      "AmountPaid": "0.00",
      "AmountCredited": "0.00"
    }
  ]
}

Expand

Get Payments

{
  "Payments": [
    {
      "PaymentID": "b26fd49a-cbae-470a-a8f8-bcbc119e0379",
      "BatchPaymentID": "b54aa50c-794c-461b-89d1-846e1b84d9c0",
      "BatchPayment": {
        "Account": {
          "AccountID": "ac993f75-035b-433c-82e0-7b7a2d40802c"
        },
        "BatchPaymentID": "b54aa50c-794c-461b-89d1-846e1b84d9c0",
        "Date": "\/Date(1455667200000+0000)\/",
        "Type": "RECBATCH",
        "Status": "AUTHORISED",
        "TotalAmount": "600.00",
        "UpdatedDateUTC": "\/Date(1289572582537+0000)\/",
        "IsReconciled": "true"
      },
      "Date": "\/Date(1455667200000+0000)\/",
      "BankAmount": 500.00,
      "Amount": 500.00,
      "Reference": "INV-0001",
      "CurrencyRate": 1.000000,
      "PaymentType": "ACCRECPAYMENT",
      "Status": "AUTHORISED",
      "UpdatedDateUTC": "\/Date(1289572582537+0000)\/",
      "HasAccount": true,
      "IsReconciled": true,
      "Account": {
        "AccountID": "ac993f75-035b-433c-82e0-7b7a2d40802c",
        "Code": "090"
      },
      "Invoice": {
        "Type": "ACCREC",
        "InvoiceID": "b0875d8b-ff26-4ce8-8aea-6955492ead48",
        "InvoiceNumber": "INV-0001",
        "Contact": {
          "ContactID": "fef6755f-549b-4617-b1e9-60bdffb517d8",
          "Name": "Ridgeway University"
        }
      }
    }
  ]
}

Expand

Get an individual batch payment (NZ)

{
  "BatchPayments": [
    {
      "Account": {
        "AccountID": "13918178-849a-4823-9a31-57b7eac713d7"
      },
      "Reference": "ref",
      "BatchPaymentID": "44a1013e-4946-4a73-b207-dfe5424a5ea5",
      "DateString": "2018-10-03T00:00:00",
      "Date": "/Date(1538524800000+0000)/",
      "Payments": [
        {
          "Invoice": {
            "InvoiceID": "5aa9451d-95d1-4f95-a966-bbab2573f71c",
            "Payments": [],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "HasErrors": false,
            "IsDiscounted": false,
            "LineItems": []
          },
          "PaymentID": "a22a64cb-364e-43fa-9a1f-bb2cd1f4adde",
          "Reference": "ref/cheque",
          "Amount": 913.55
        },
        {
          "Invoice": {
            "InvoiceID": "30a87092-31b5-4a2c-831e-327486533dd2",
            "Payments": [],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "HasErrors": false,
            "IsDiscounted": false,
            "LineItems": []
          },
          "PaymentID": "6e20be79-32d8-4ae1-978e-f76d9b245c02",
          "Amount": 495
        },
        {
          "Invoice": {
            "InvoiceID": "86d6e00f-ef56-49f7-9a54-796ccd5ca057",
            "Payments": [],
            "CreditNotes": [],
            "Prepayments": [],
            "Overpayments": [],
            "HasErrors": false,
            "IsDiscounted": false,
            "LineItems": []
          },
          "PaymentID": "4ba761b8-5940-4a3f-bcdf-7775adb00332",
          "Amount": 3080
        }
      ],
      "Type": "RECBATCH",
      "Status": "AUTHORISED",
      "TotalAmount": 4488.55,
      "UpdatedDateUTC": "/Date(1538525239370+0000)/",
      "IsReconciled": false
    }
  ]
}

Expand

Get Accounts

{
  "Accounts": [{
    "AccountID": "ebd06280-af70-4bed-97c6-7451a454ad85",
    "Code": "091",
    "Name": "Business Savings Account",
    "Type": "BANK",
    "TaxType": "NONE",
    "EnablePaymentsToAccount": false,
    "BankAccountNumber": "0209087654321050",
    "BankAccountType": "BANK",
    "CurrencyCode": "NZD"
  },{
    "AccountID": "7d05a53d-613d-4eb2-a2fc-dcb6adb80b80",
    "Code": "200",
    "Name": "Sales",
    "Type": "REVENUE",
    "TaxType": "OUTPUT2",
    "Description": "Income from any normal business activity",
    "EnablePaymentsToAccount": false
  }]
}

Expand

Get Contacts

{
  "Contacts": [
    {
      "ContactID": "bd2270c3-8706-4c11-9cfb-000b551c3f51",
      "ContactStatus": "ACTIVE",
      "Name": "ABC Limited",
      "FirstName": "Andrea",
      "LastName": "Dutchess",
      "CompanyNumber": "NumberBusiness1234",
      "EmailAddress": "a.dutchess@abclimited.com",
      "BankAccountDetails": "45465844",
      "TaxNumber": "415465456454",
      "AccountsReceivableTaxType": "INPUT2",
      "AccountsPayableTaxType": "OUTPUT2",
      "Addresses": [
        {
          "AddressType": "POBOX",
          "AddressLine1": "P O Box 123",
          "City": "Wellington",
          "PostalCode": "6011",
          "AttentionTo": "Andrea"
        },{
          "AddressType": "STREET"
        }
      ],
      "Phones": [
        {
          "PhoneType": "DEFAULT",
          "PhoneNumber": "1111111",
          "PhoneAreaCode": "04",
          "PhoneCountryCode": "64"
        },{
          "PhoneType": "FAX"
        },{
          "PhoneType": "MOBILE"
        },{
          "PhoneType": "DDI"
        }
      ],
      "UpdatedDateUTC": "\/Date(1488391422280+0000)\/",
      "IsSupplier": false,
      "IsCustomer": true,
      "DefaultCurrency": "NZD"
    },{
      "ContactID": "6d42f03b-181f-43e3-93fb-2025c012de92"
      ...
    }
  ]
}

Expand

Get Linked Transactions

{
  "LinkedTransactions": [
    {
      "LinkedTransactionID": "2b921ac0-1ed9-4a61-bd67-706180f1bd94",
      "SourceTransactionID": "057df639-6632-4995-b0ac-00152e1c5092",
      "SourceLineItemID": "aa605236-49cc-4cf7-8c43-161def9bbf68",
      "ContactID": "a94c0f29-8924-4b05-b0e6-585ea1982faa",
      "TargetTransactionID": "147f3680-1b41-48ee-8c7f-61a656bbf49a",
      "TargetLineItemID": "14f06cf1-e2af-4825-8476-bb79f5ba503e",
      "Status": "BILLED",
      "Type": "BILLABLEEXPENSE",
      "UpdatedDateUTC": "2015-09-09T22:13:28",
      "SourceTransactionTypeCode": "SPEND"
    },
    {
      "LinkedTransactionID": "dc3c18e6-ab39-4d0e-8283-0609efa36145",
      "SourceTransactionID": "0465c7b5-69b8-4e55-8c32-af73eab9afba",
      "SourceLineItemID": "c92bf129-5da1-401c-8cf5-1508e92ee829",
      "Status": "DRAFT",
      "Type": "BILLABLEEXPENSE",
      "UpdatedDateUTC": "2015-09-09T23:43:54",
      "SourceTransactionTypeCode": "ACCPAY"
    }
  ]
}

Expand

Get a collection of Items

{
  "Items": [
    {
      "ItemID": "19b79d12-0ae1-496e-9649-cbd04b15c7c5",
      "Code": "UnTrackedThing",
      "Description": "I sell this untracked thing",
      "PurchaseDescription": "I buy this untracked thing",
      "UpdatedDateUTC": "\/Date(1488338552390+0000)\/",
      "PurchaseDetails": {
        "UnitPrice": 20.0000,
        "AccountCode": "400",
        "TaxType": "NONE"
      },
      "SalesDetails": {
        "UnitPrice": 40.0000,
        "AccountCode": "200",
        "TaxType": "OUTPUT2"
      },
      "Name": "An Untracked Item",
      "IsTrackedAsInventory": false,
      "IsSold": true,
      "IsPurchased": true
    },
    {
      "ItemID": "90a72d44-43e4-410d-a68b-1139ef0c0c07",
      "Code": "TrackedThing",
      "Description": "I sell this tracked thing",
      "PurchaseDescription": "I purchase this tracked thing",
      "UpdatedDateUTC": "\/Date(1488338552390+0000)\/",
      "PurchaseDetails": {
        "UnitPrice": 20.0000,
        "COGSAccountCode": "430",
        "TaxType": "NONE"
      },
      "SalesDetails": {
        "UnitPrice": 40.0000,
        "AccountCode": "200",
        "TaxType": "OUTPUT2"
      },
      "Name": "Tracked Thing",
      "IsTrackedAsInventory": true,
      "InventoryAssetAccountCode": "630",
      "TotalCostPool": 200.00,
      "QuantityOnHand": 10.0000,
      "IsSold": true,
      "IsPurchased": true
    }
  ]
}

Expand

Get Purchase Orders

{
  "Items": [
    {
      "ItemID": "19b79d12-0ae1-496e-9649-cbd04b15c7c5",
      "Code": "UnTrackedThing",
      "Description": "I sell this untracked thing",
      "PurchaseDescription": "I buy this untracked thing",
      "UpdatedDateUTC": "\/Date(1488338552390+0000)\/",
      "PurchaseDetails": {
        "UnitPrice": 20.0000,
        "AccountCode": "400",
        "TaxType": "NONE"
      },
      "SalesDetails": {
        "UnitPrice": 40.0000,
        "AccountCode": "200",
        "TaxType": "OUTPUT2"
      },
      "Name": "An Untracked Item",
      "IsTrackedAsInventory": false,
      "IsSold": true,
      "IsPurchased": true
    },
    {
      "ItemID": "90a72d44-43e4-410d-a68b-1139ef0c0c07",
      "Code": "TrackedThing",
      "Description": "I sell this tracked thing",
      "PurchaseDescription": "I purchase this tracked thing",
      "UpdatedDateUTC": "\/Date(1488338552390+0000)\/",
      "PurchaseDetails": {
        "UnitPrice": 20.0000,
        "COGSAccountCode": "430",
        "TaxType": "NONE"
      },
      "SalesDetails": {
        "UnitPrice": 40.0000,
        "AccountCode": "200",
        "TaxType": "OUTPUT2"
      },
      "Name": "Tracked Thing",
      "IsTrackedAsInventory": true,
      "InventoryAssetAccountCode": "630",
      "TotalCostPool": 200.00,
      "QuantityOnHand": 10.0000,
      "IsSold": true,
      "IsPurchased": true
    }
  ]
}

Expand

Get Contact Groups

{
  "ContactGroups": [
    {
      "ContactGroupID": "97bbd0e6-ab4d-4117-9304-d90dd4779199",
      "Name": "VIP Customers",
      "Status": "ACTIVE"
    },{
      "ContactGroupID": "d0c68f1a-e5dd-4a45-aa02-27d8fdbfd562",
      "Name": "Preferred Suppliers",
      "Status": "ACTIVE"
    }
  ]
}

Get 1099 Reports 2022

{
  "Id": "8b474ddb-9ef4-457c-8640-1c0e3670ea0e",
  "Status": "OK",
  "ProviderName": "Hornblower Enterprises",
  "DateTimeUTC": "/Date(1662597051457)/",
  "Reports": [
    {
      "ReportName": "1099-NEC report",
      "ReportDate": "1 Jan 2022 to 31 Dec 2022",
      "Fields": [],
      "Contacts": [
        {
          "Box1": 0.0,
          "Box2": 0.0,
          "Box4": 1000.0,
          "Name": "Bank West",
          "FederalTaxIDType": "SSN",
          "City": "Pinehaven",
          "Zip": "12345",
          "State": "CA",
          "Email": "test_one@example.com",
          "StreetAddress": "Procurement Services\r\nGPO 1234\r\n\r\n\r\n",
          "TaxID": "234-22-2223",
          "ContactId": "81d5706a-8057-4338-8511-747cd85f4c68",
          "LegalName": "Test One",
          "BusinessName": "Bank West",
          "FederalTaxClassification": "SOLE_PROPRIETOR"
        },
        {
          "Box1": 0.0,
          "Box2": 0.0,
          "Box4": 1000.0,
          "Name": "Hoyt Productions",
          "FederalTaxIDType": "SSN",
          "City": "Oaktown",
          "Zip": "45123",
          "State": "NY",
          "Email": "test_two@example.com",
          "StreetAddress": "100 Rusty Ridge Road\r\nSuite 100\r\n\r\n\r\n",
          "TaxID": "123-45-6780",
          "ContactId": "19732b6a-9a5c-4651-b33c-3f8f682e2a2b",
          "LegalName": "Test Two",
          "BusinessName": "Hoyt Productions",
          "FederalTaxClassification": "SOLE_PROPRIETOR"
        },
        {
          "Box1": 0.0,
          "Box2": 0.0,
          "Box4": 1000.0,
          "Name": "Truxton Property Management",
          "FederalTaxIDType": "EIN",
          "City": "Coppertown",
          "Zip": "21321",
          "State": "FL",
          "Email": "test_three@example.com",
          "StreetAddress": "1000 Copper Avenue\r\nSuite 1000\r\n\r\n\r\n",
          "TaxID": "33-3332233",
          "ContactId": "018355fc-c67e-4352-b443-ef3873031983",
          "LegalName": "Test Three",
          "BusinessName": "Truxton Property Management",
          "FederalTaxClassification": "SOLE_PROPRIETOR"
        }
      ]
    },
    {
      "ReportName": "1099-MISC report",
      "ReportDate": "1 Jan 2022 to 31 Dec 2022",
      "Fields": [],
      "Contacts": [
        {
          "Box1": 5543.75,
          "Box2": 0.0,
          "Box3": 0.0,
          "Box4": 0.0,
          "Box5": 0.0,
          "Box6": 0.0,
          "Box7": 0.0,
          "Box8": 0.0,
          "Box9": 0.0,
          "Box10": 0.0,
          "Box11": 0.0,
          "Box14": 0.0,
          "Name": "Bank West",
          "FederalTaxIDType": "SSN",
          "City": "Pinehaven",
          "Zip": "12345",
          "State": "CA",
          "Email": "test_one@example.com",
          "StreetAddress": "Procurement Services\r\nGPO 1234\r\n\r\n\r\n",
          "TaxID": "234-22-2223",
          "ContactId": "81d5706a-8057-4338-8511-747cd85f4c68",
          "LegalName": "Test One",
          "BusinessName": "Bank West",
          "FederalTaxClassification": "SOLE_PROPRIETOR"
        },
        {
          "Box1": 5543.75,
          "Box2": 0.0,
          "Box3": 0.0,
          "Box4": 0.0,
          "Box5": 0.0,
          "Box6": 0.0,
          "Box7": 0.0,
          "Box8": 0.0,
          "Box9": 0.0,
          "Box10": 0.0,
          "Box11": 0.0,
          "Box14": 0.0,
          "Name": "Hoyt Productions",
          "FederalTaxIDType": "SSN",
          "City": "Oaktown",
          "Zip": "45123",
          "State": "NY",
          "Email": "test_two@example.com",
          "StreetAddress": "100 Rusty Ridge Road\r\nSuite 100\r\n\r\n\r\n",
          "TaxID": "123-45-6780",
          "ContactId": "19732b6a-9a5c-4651-b33c-3f8f682e2a2b",
          "LegalName": "Test Two",
          "BusinessName": "Hoyt Productions",
          "FederalTaxClassification": "SOLE_PROPRIETOR"
        },
        {
          "Box1": 5543.75,
          "Box2": 0.0,
          "Box3": 0.0,
          "Box4": 0.0,
          "Box5": 0.0,
          "Box6": 0.0,
          "Box7": 0.0,
          "Box8": 0.0,
          "Box9": 0.0,
          "Box10": 0.0,
          "Box11": 0.0,
          "Box14": 0.0,
          "Name": "Truxton Property Management",
          "FederalTaxIDType": "EIN",
          "City": "Coppertown",
          "Zip": "21321",
          "State": "FL",
          "Email": "test_three@example.com",
          "StreetAddress": "1000 Copper Avenue\r\nSuite 1000\r\n\r\n\r\n",
          "TaxID": "33-3332233",
          "ContactId": "018355fc-c67e-4352-b443-ef3873031983",
          "LegalName": "Test Three",
          "BusinessName": "Truxton Property Management",
          "FederalTaxClassification": "SOLE_PROPRIETOR"
        }
      ]
    }
  ]
}

Expand

Get Tax Rates

{
  "TaxRates": [
    {
      "Name": "15% GST on Expenses",
      "TaxType": "INPUT2",
      "CanApplyToAssets": "true",
      "CanApplyToEquity": "true",
      "CanApplyToExpenses": "true",
      "CanApplyToLiabilities": "true",
      "CanApplyToRevenue": "false",
      "DisplayTaxRate": "15.0000",
      "EffectiveRate": "15.0000",
      "Status": "ACTIVE",
      "TaxComponents": [
        {
          "Name": "GST",
          "Rate": "15.0000",
          "IsCompound": "false",
          "IsNonRecoverable": "false"
        }
      ]
    },
    {
      "Name": "15% GST on Income",
      "TaxType": "OUTPUT2",
      "CanApplyToAssets": "true",
      "CanApplyToEquity": "true",
      "CanApplyToExpenses": "false",
      "CanApplyToLiabilities": "true",
      "CanApplyToRevenue": "true",
      "DisplayTaxRate": "15.0000",
      "EffectiveRate": "15.0000",
      "Status": "ACTIVE",
      "TaxComponents": [
        {
          "Name": "GST",
          "Rate": "15.0000",
          "IsCompound": "false",
          "IsNonRecoverable": "false"
        }
      ]
    },
    {
      "Name": "GST on Imports",
      "TaxType": "GSTONIMPORTS",
      "CanApplyToAssets": "false",
      "CanApplyToEquity": "false",
      "CanApplyToExpenses": "false",
      "CanApplyToLiabilities": "true",
      "CanApplyToRevenue": "false",
      "DisplayTaxRate": "0.0000",
      "EffectiveRate": "0.0000",
      "Status": "ACTIVE",
      "TaxComponents": [
        {
          "Name": "GST",
          "Rate": "0.0000",
          "IsCompound": "false",
          "IsNonRecoverable": "false"
        }
      ]
    }
  ]
}

Expand

Get a list of draft Assets

{
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "pageCount": 1,
    "itemCount": 2,
  },
  "items": [
    {
      "assetId": "3b5b3a38-5649-495f-87a1-14a4e5918634",
      "assetName": "Awesome Truck 3",
      "assetNumber": "FA-0013",
      "purchaseDate": "2015-07-01T00:00:00",
      "purchasePrice": 1000,
      "disposalPrice": 0,
      "assetStatus": "Draft",
      "canRollback": true,
      "accountingBookValue": 0
    },
    {
      "assetId": "1fd647b8-c449-42cb-9cc4-cd41fe8df262",
      "assetName": "Awesome Car",
      "assetNumber": "FA-0001",
      "purchaseDate": "2015-07-01T00:00:00",
      "purchasePrice": 100000,
      "disposalPrice": 0,
      "assetStatus": "Draft",
      "bookDepreciationSetting": {
        "depreciationMethod": "StraightLine",
        "averagingMethod": "ActualDays",
        "depreciationRate": 0.01,
        "depreciationCalculationMethod": "None",
        "effectiveFromDate": "2015-07-01T00:00:00",
        "costLimit": 100000,
        "residualValue": 10000,
      },
      "bookDepreciationDetail": {
        "currentCapitalGain": 0,
        "currentGainLoss": 0,
        "priorAccumDepreciationAmount": 0,
        "currentAccumDepreciationAmount": 0
      },
      "canRollback": true,
      "accountingBookValue": 100000
    }
  ]
}

Expand

Get a single Asset

{
  "assetId": "92d04e4407404c1facd6edbbceac7faa",
  "assetName": "Computer",
  "assetNumber": "FA-0021",
  "purchaseDate": "2016-04-11T00:00:00",
  "purchasePrice": 3000,
  "serialNumber": "123456789",
  "warrantyExpiryDate": "2018-04-11T00:00:00",
  "assetTypeId": "5da209c55e194a43b92571b776c49ced",
  "description": "A computer for computing",
  "disposalPrice": 0,
  "assetStatus": "Registered",
  "bookDepreciationSetting": {
    "depreciationMethod": "StraightLine",
    "averagingMethod": "ActualDays",
    "depreciationRate": 33,
    "depreciationCalculationMethod": "None"
    "currentGainLoss": 0,
  },
  "bookDepreciationDetail": {
    "currentCapitalGain": 0,
    "depreciationStartDate": "2016-04-11T00:00:00",
    "priorAccumDepreciationAmount": 0,
    "currentAccumDepreciationAmount": 0
  },
  "canRollback": true,
  "accountingBookValue": 3000
}

Expand

Get a list of Asset Types

[
  {
    "assetTypeId": "5da209c5-5e19-4a43-b925-71b776c49ced",
    "assetTypeName": "Computer Equipment",
    "fixedAssetAccountId": "24e260f1-bfc4-4766-ad7f-8a8ce01de879",
    "depreciationExpenseAccountId": "b23fc79b-d66b-44b0-a240-e138e086fcbc",
    "accumulatedDepreciationAccountId": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694",
    "bookDepreciationSetting": {
      "depreciationMethod": "StraightLine",
      "averagingMethod": "ActualDays",
      "depreciationRate": 33,
      "depreciationCalculationMethod": "None"
    },
    "locks": 0
  },
  {
    "assetTypeId": "a865d898-4ee9-4366-bf37-bfc1b35cf788",
    "assetTypeName": "Office Equipment",
    "fixedAssetAccountId": "24e260f1-bfc4-4766-ad7f-8a8ce01de879",
    "depreciationExpenseAccountId": "b23fc79b-d66b-44b0-a240-e138e086fcbc",
    "accumulatedDepreciationAccountId": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694",
    "bookDepreciationSetting": {
      "depreciationMethod": "StraightLine",
      "averagingMethod": "ActualDays",
      "depreciationRate": 33,
      "depreciationCalculationMethod": "None"
    },
    "locks": 0
  },
  {
    "assetTypeId": "26c17b4a-0093-402c-b9bb-281dedf5c604",
    "assetTypeName": "Vehicles",
    "fixedAssetAccountId": "24e260f1-bfc4-4766-ad7f-8a8ce01de879",
    "depreciationExpenseAccountId": "b23fc79b-d66b-44b0-a240-e138e086fcbc",
    "accumulatedDepreciationAccountId": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694",
    "bookDepreciationSetting": {
      "depreciationMethod": "StraightLine",
      "averagingMethod": "ActualDays",
      "depreciationRate": 33,
      "depreciationCalculationMethod": "None"
    },
    "locks": 0
  }
]

Expand

Get Tracking Categories

{
  "TrackingCategories": [
    {
      "Name": "Region",
      "Status": "ACTIVE",
      "TrackingCategoryID": "351953c4-8127-4009-88c3-f9cd8c9cbe9f",
      "Options": [
        {
          "TrackingOptionID": "ce205173-7387-4651-9726-2cf4c5405ba2",
          "Name": "Eastside",
          "Status": "ACTIVE"
        },
        {
          "TrackingOptionID": "6eb12fdf-63de-4033-98df-be679d84e3c2",
          "Name": "North",
          "Status": "ACTIVE"
        },
        {
          "TrackingOptionID": "6159bdd4-b634-4338-a664-e929aa73f70f",
          "Name": "South",
          "Status": "ACTIVE"
        },
        {
          "TrackingOptionID": "161ad543-97ab-4436-8213-e0d794b1ea90",
          "Name": "West Coast",
          "Status": "ACTIVE"
        }
      ]
    }
  ]
}

Get Folders

{
 "Name":"Inbox",
 "FileCount":0,
 "Email":"xero.inbox.dxlsh.yth06v9y5u6ak3bz@xerofiles.com",
 "IsInbox":true,
 "Id":"7215cb90-15e1-4949-9fec-690126f1f88f"
},
{
 "Name":"Contracts",
 "FileCount":1,
 "IsInbox":false,
 "Id":"0f8ccf21-7267-4268-9167-a1e2c40c84c8"
}

Get Tenant (Specific to Wiresk)

[
  {
    "id": "87b4fe4d-dfb1-4754-af21-9c815401bd74",
    "authEventId": "ce8b0930-09cb-48fd-9b15-aea64fc10856",
    "tenantId": "1633f71f-d77e-48b6-a2c4-df3e1962eedd",
    "tenantType": "ORGANISATION",
    "tenantName": "Demo Company (Global)",
    "createdDateUtc": "2025-02-20T04:35:50.2922220",
    "updatedDateUtc": "2025-02-20T04:35:50.2942050"
  },
  {
    "id": "fa064823-2d9c-4d97-b783-a513a4f3b3c6",
    "authEventId": "d012bdda-2b8a-40af-96e7-631e6dfafa03",
    "tenantId": "89f8b832-3b28-4b1a-bd49-aaecec055952",
    "tenantType": "ORGANISATION",
    "tenantName": "Wiresk Demo",
    "createdDateUtc": "2025-02-19T08:25:18.7274290",
    "updatedDateUtc": "2025-02-19T08:25:18.7287320"
  }
]

Get Settings

{
      "assetNumberPrefix": "FA-",
      "assetNumberSequence": "0022",
      "assetStartDate": "2015-07-01T00:00:00",
      "lastDepreciationDate": "2015-07-31T00:00:00",
      "defaultGainOnDisposalAccountId": "346ddb97-739a-4274-b43b-66aa3218d17c",
      "defaultLossOnDisposalAccountId": "1b798541-24e2-4855-9309-c023a0b576f3",
      "defaultCapitalGainOnDisposalAccountId": "6d6a0bdb-e118-45d8-a023-2ad617ec1cb7",
      "optInForTax": false
}

Test run or automate your Flow Copy Link

After setting up your Flow, you can choose to:

“Run once”, your Flow will run only a single time. You can use this function to test your Flow.
“Run Scheduler” will automate your Flows with the recurrence rule you previously defined.

For more details, refer to How to run a Flow tutorial in our Help Center.

If you are using a Webhook Trigger, the Flow will initiate automatically when a webhook is received from your connected apps. This means that the Flow is automated without a scheduler and will run until you deactivate the Flow manually. Refer to Webhook documentation in our Help Center.

Learn more about Wiresk, explore our user guide.

If you need an integration that you cannot find in Wiresk, you can make a request to our team, and we will try our best to satisfy your needs.

Xero – Delete, Find, Get Records

Xero Methods List and Settings Copy Link

DELETE RECORDS Copy Link

FIND RECORD Copy Link

GET RECORDS Copy Link

Test run or automate your Flow Copy Link