Account

APIDescription
GET Account/Get?id={id}

Retrieve a single Account record

GET Account/Get/{xeroId}

Retrieves a list of backed up Accounts

GET Account/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Accounts under a specific organisation and backup library

Journal

APIDescription
GET Journal/Get?id={id}

Retrieves a single Journal record

GET Journal/Get/{xeroId}

Retrieves a list of Journals

GET Journal/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Journals under a single organisation and a specific backup library

ExpenseClaim

APIDescription
GET ExpenseClaim/Get?id={id}

Retrieves a single Expense Claim record

GET ExpenseClaim/Get/{xeroId}

Retrives a list of Expense Claims

GET ExpenseClaim/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrievs a list of Expense Claims under a single organisation and a specific backup library

Contact

APIDescription
GET Contact/Get?id={id}

Retrieves a single Contact record

GET Contact/Get/{xeroId}

Retrieves a list of Contacts

GET Contact/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Contacts under a single organisation and a specific backup library

File

APIDescription
GET File/DownloadDataset/{id}

Download a full backed up dataset

GET File/GetAttachments/{id}

Retrieves a list of attachments

GET File/DownloadAttachment?id={id}&fileName={fileName}

Download all backed up attachments

GET File/DownloadXML/{id}

Download a dataset with an XML file format

GET File/DownloadSingleSet/{id}/{backupNumber}

Download a single dataset

Users

APIDescription
POST Users/ValidateUser

Validates the credentials of the logging-in user

POST Users/Create

Create a single user record

GET Users/Get?id={id}

Get a single user record

GET Users/All

Retrieves all the registered users in the company

Invoice

APIDescription
GET Invoice/Get?id={id}

Retrieves a single Invoice record

GET Invoice/Get/{xeroId}

Retrieves a list of Invoices

GET Invoice/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Invoices under a single organisation and a specific backup library

Company

APIDescription
GET Company/Get?id={id}

Retrieves a single company record

GET Company/All

Retrieves a list of Companies

POST Company/Create

Creates a Company record

POST Company/Edit

Edits a Company record

DELETE Company/Delete?id={id}

Deletes a Company record

TrackingCategory

APIDescription
GET TrackingCategory/Get?id={id}

Retrieves a single Tracking Category record

GET TrackingCategory/Get/{xeroId}

Retrieves a list of Tracking Categories

GET TrackingCategory/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Tracking Categories under a single organisation and a specific backup library

Payment

APIDescription
GET Payment/Get?id={id}

Retrieves a single Payment record

GET Payment/Get/{xeroId}

Retrieves a list of Payments

GET Payment/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Payments under a single organisation and a specific backup library

CreditNote

APIDescription
GET CreditNote/Get?id={id}

Retrieves a single Credit Note record

GET CreditNote/Get/{xeroId}

Retrieves a list of Credit Notes

GET CreditNote/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Credit Notes under a single organisation and a specific backup library

Receipt

APIDescription
GET Receipt/Get?id={id}

Retrieves a single Receipt record

GET Receipt/Get/{xeroId}

Retrieves a list of Receipts

GET Receipt/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Receipts under a single organisation and a specific backup library

Employee

APIDescription
GET Employee/Get?id={id}

Retrieves a single Employee record

GET Employee/Get/{xeroId}

Retrieves a list of Employees

GET Employee/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Employees under a single organisation and a specific backup library

ManualJournal

APIDescription
GET ManualJournal/Get?id={id}

Retrieves a single Manual Journal record

GET ManualJournal/Get/{xeroId}

Retrieves a list of Manual Journals

GET ManualJournal/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Manual Journals under a single organisation and a specific backup library

Organisation

APIDescription
GET Organisation/Get?id={id}

Retrieve a single Organisation Record

GET Organisation/GetByCompanyId?id={id}

Retrieves a list of Organisations under a company

DELETE Organisation/Delete?id={id}

Deletes single organisation record

GET Organisation/BackupCount/{orgId}?backuplibraryId={backuplibraryId}

Retrieves a number of backed up items in a single backup library or dataset

GET Organisation/BackupStatus/{orgId}

Retrieves the current backup status of a single organisation along with its backed up record counts

BankTransaction

APIDescription
GET BankTransaction/Get?id={id}

Retrieve a single Bank Transaction record

GET BankTransaction/Get/{xeroId}

Retrieves a list of Bank Transaction records

GET BankTransaction/Get?orgId={orgId}&backuplibraryId={backuplibraryId}

Retrieves a list of Bank Transaction Records under a specific organisation and backup library

GET BankTransaction/Get?orgId={orgId}&backuplibraryId={backuplibraryId}&from={from}&to={to}

Retrieves a list of Bank Transaction Records under a specific organisation and backup library within date range

BackupLibrary

APIDescription
GET BackupLibrary/Get?id={id}

Retrieves a list of backup libraries available for a single organisation

GET BackupLibrary/Get/{orgId}?from={from}&to={to}

Retrieves a list of backup libraries available for a single organisation within date range

ApiBase

APIDescription