5.0.0 • Published 3 years ago

@datafire/xero v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
3 years ago

@datafire/xero

Client library for Accounting

Installation and Usage

npm install --save @datafire/xero
let xero = require('@datafire/xero').create({
  consumer_key: "",
  consumer_secret: "",
  token: "",
  token_secret: ""
});

.then(data => {
  console.log(data);
});

Description

Introduction

The Xero Accounting API is a RESTful web service and uses the OAuth (v1.0a) protocol to authenticate 3rd party applications. The Accounting API exposes accounting and related functions of the main Xero application and can be used for a variety of purposes such as creating transactions like invoices and credit notes, right through to extracting accounting data via our reports endpoint.

Actions

Accounts.get

Retrieve the chart of accounts

xero.Accounts.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned

Output

  • output object
    • Accounts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Accounts.post

Create or update accounts

xero.Accounts.post({
  "Accounts": {
    "Code": "",
    "Name": "",
    "Type": ""
  }
}, context)

Input

  • input object

Output

  • output object
    • Accounts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Accounts.put

Create new accounts

xero.Accounts.put({
  "Accounts": {
    "Code": "",
    "Name": "",
    "Type": ""
  }
}, context)

Input

  • input object

Output

  • output object
    • Accounts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Accounts.AccountID.delete

Delete an account

xero.Accounts.AccountID.delete({
  "AccountID": ""
}, context)

Input

  • input object
    • AccountID required string

Output

Output schema unknown

Accounts.AccountID.get

Retrieve a single account

xero.Accounts.AccountID.get({
  "AccountID": ""
}, context)

Input

  • input object
    • AccountID required string

Output

  • output object
    • Accounts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Accounts.AccountID.post

Update an account

xero.Accounts.AccountID.post({
  "Accounts": {
    "Code": "",
    "Name": "",
    "Type": ""
  },
  "AccountID": ""
}, context)

Input

  • input object
    • Accounts required Account
    • AccountID required string

Output

  • output object
    • Accounts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Accounts.AccountID.Attachments.get

Retrieve Attachments

xero.Accounts.AccountID.Attachments.get({
  "AccountID": ""
}, context)

Input

  • input object
    • AccountID required string: The Xero generated unique identifier for an account
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Accounts.AccountID.Attachments.FileName.get

Download an Attachment

xero.Accounts.AccountID.Attachments.FileName.get({
  "FileName": "",
  "AccountID": ""
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment to be downloaded
    • AccountID required string: The Xero generated unique identifier for an account
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

Output schema unknown

Accounts.AccountID.Attachments.FileName.post

Upload an Attachment

xero.Accounts.AccountID.Attachments.FileName.post({
  "FileName": "",
  "AccountID": "",
  "Content": {
    "Content": ""
  }
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment being uploaded
    • AccountID required string: The Xero generated unique identifier for an account
    • Content required Content

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransactions.get

Retrieve any spend or receive money transactions (inc. prepayments and overpayments)

xero.BankTransactions.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • BankTransactions array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransactions.post

Create a new spend or receive money (inc. prepayments and overpayments)

xero.BankTransactions.post({
  "BankTransactions": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": [],
    "BankAccount": {}
  }
}, context)

Input

  • input object
    • BankTransactions required BankTransaction
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • BankTransactions array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransactions.put

Create a new spend or receive money (inc. prepayments and overpayments)

xero.BankTransactions.put({
  "BankTransactions": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": [],
    "BankAccount": {}
  }
}, context)

Input

  • input object
    • BankTransactions required BankTransaction
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • BankTransactions array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransactions.BankTransactionID.get

Retrieve a spend or receive money (inc. prepayments and overpayments)

xero.BankTransactions.BankTransactionID.get({
  "BankTransactionID": ""
}, context)

Input

  • input object
    • BankTransactionID required string
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • BankTransactions array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransactions.BankTransactionID.post

Update a spend or receive money

xero.BankTransactions.BankTransactionID.post({
  "BankTransactions": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": [],
    "BankAccount": {}
  },
  "BankTransactionID": ""
}, context)

Input

  • input object
    • BankTransactions required BankTransaction
    • BankTransactionID required string
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • BankTransactions array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransactions.BankTransactionID.Attachments.get

Retrieve Attachments

xero.BankTransactions.BankTransactionID.Attachments.get({
  "BankTransactionID": ""
}, context)

Input

  • input object
    • BankTransactionID required string: The Xero generated unique identifier for an bank transaction
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransactions.BankTransactionID.Attachments.FileName.get

Download an Attachment

xero.BankTransactions.BankTransactionID.Attachments.FileName.get({
  "FileName": "",
  "BankTransactionID": ""
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment to be downloaded
    • BankTransactionID required string: The Xero generated unique identifier for an bank transaction
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

Output schema unknown

BankTransactions.BankTransactionID.Attachments.FileName.post

Upload an Attachment

xero.BankTransactions.BankTransactionID.Attachments.FileName.post({
  "FileName": "",
  "BankTransactionID": "",
  "Content": {
    "Content": ""
  }
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment being uploaded
    • BankTransactionID required string: The Xero generated unique identifier for an bank transaction
    • Content required Content

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransfers.get

Retrieve a colection of bank transfers

xero.BankTransfers.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned

Output

  • output object
    • BankTransfers array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransfers.put

Create a bank transfer

xero.BankTransfers.put({
  "BankTransfers": {
    "FromBankAccount": {},
    "ToBankAccount": {},
    "Amount": 0
  }
}, context)

Input

  • input object
    • BankTransfers required BankTransfer
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • BankTransfers array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransfers.BankTransferID.get

Retrieve an individual bank transfer

xero.BankTransfers.BankTransferID.get({
  "BankTransferID": ""
}, context)

Input

  • input object
    • BankTransferID required string

Output

  • output object
    • BankTransfers array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BankTransfers.BankTransferID.Attachments.FileName.get

Download an Attachment

xero.BankTransfers.BankTransferID.Attachments.FileName.get({
  "FileName": "",
  "BankTransferID": ""
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment to be downloaded
    • BankTransferID required string: The Xero generated unique identifier for an BankTransfer
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

Output schema unknown

BankTransfers.BankTransferID.Attachments.FileName.post

Upload an Attachment

xero.BankTransfers.BankTransferID.Attachments.FileName.post({
  "FileName": "",
  "BankTransferID": "",
  "Content": {
    "Content": ""
  }
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment being uploaded
    • BankTransferID required string: The Xero generated unique identifier for a BankTransfer
    • Content required Content

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BrandingThemes.get

Retrieve a collection of BrandingThemes

xero.BrandingThemes.get(null, context)

Input

This action has no parameters

Output

  • output object
    • BrandingThemes array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

BrandingThemes.BrandingThemeID.get

Retrieve an individual BrandingTheme

xero.BrandingThemes.BrandingThemeID.get({
  "BrandingThemeID": ""
}, context)

Input

  • input object
    • BrandingThemeID required string

Output

  • output object
    • BrandingThemes array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ContactGroups.get

Retrieve a collection of contact groups

xero.ContactGroups.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned

Output

  • output object
    • ContactGroups array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ContactGroups.post

Create or update a contact group

xero.ContactGroups.post({
  "ContactGroups": {
    "Name": ""
  }
}, context)

Input

  • input object
    • ContactGroups required ContactGroup
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • ContactGroups array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ContactGroups.put

Create a new contact group

xero.ContactGroups.put({
  "ContactGroups": {
    "Name": ""
  }
}, context)

Input

  • input object
    • ContactGroups required ContactGroup
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • ContactGroups array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ContactGroups.ContactGroupID.delete

Delete a contact group

xero.ContactGroups.ContactGroupID.delete({
  "ContactGroupID": ""
}, context)

Input

  • input object
    • ContactGroupID required string

Output

Output schema unknown

ContactGroups.ContactGroupID.get

Retrieve the ContactID and Name of all the contacts in a contact group

xero.ContactGroups.ContactGroupID.get({
  "ContactGroupID": ""
}, context)

Input

  • input object
    • ContactGroupID required string

Output

  • output object
    • ContactGroups array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ContactGroups.ContactGroupID.post

Update a contact group

xero.ContactGroups.ContactGroupID.post({
  "ContactGroups": {
    "Name": ""
  },
  "ContactGroupID": ""
}, context)

Input

  • input object
    • ContactGroups required ContactGroup
    • ContactGroupID required string

Output

  • output object
    • ContactGroups array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ContactGroups.ContactGroupID.Contacts.delete

Remove all contacts from a contact group

xero.ContactGroups.ContactGroupID.Contacts.delete({
  "ContactGroupID": ""
}, context)

Input

  • input object
    • ContactGroupID required string

Output

Output schema unknown

ContactGroups.ContactGroupID.Contacts.put

Add contacts to a contact group

xero.ContactGroups.ContactGroupID.Contacts.put({
  "Contacts": {
    "Name": ""
  },
  "ContactGroupID": ""
}, context)

Input

  • input object
    • Contacts required Contact
    • ContactGroupID required string

Output

  • output object
    • ContactGroups array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ContactGroups.ContactGroupID.Contacts.ContactID.delete

Remove a contact from a contact group

xero.ContactGroups.ContactGroupID.Contacts.ContactID.delete({
  "ContactGroupID": "",
  "ContactID": ""
}, context)

Input

  • input object
    • ContactGroupID required string
    • ContactID required string

Output

Output schema unknown

Contacts.get

Retrieve a collection of contacts

xero.Contacts.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned
    • includeArchived boolean: Include archived records in the response
    • IDs string: Filter by a comma-separated list of ContactIDs

Output

  • output object
    • Contacts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Contacts.post

Create or update a contact

xero.Contacts.post({
  "Contacts": {
    "Name": ""
  }
}, context)

Input

  • input object
    • Contacts required Contact
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • Contacts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Contacts.put

Create a contact

xero.Contacts.put({
  "Contacts": {
    "Name": ""
  }
}, context)

Input

  • input object

Output

  • output object
    • Contacts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Contacts.ContactID.get

Retrieve an individual contact

xero.Contacts.ContactID.get({
  "ContactID": ""
}, context)

Input

  • input object
    • ContactID required string

Output

  • output object
    • Contacts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Contacts.ContactID.post

Update a contact

xero.Contacts.ContactID.post({
  "Contacts": {
    "Name": ""
  },
  "ContactID": ""
}, context)

Input

  • input object
    • Contacts required Contact
    • ContactID required string

Output

  • output object
    • Contacts array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Contacts.ContactID.Attachments.get

Retrieve Attachments

xero.Contacts.ContactID.Attachments.get({
  "ContactID": ""
}, context)

Input

  • input object
    • ContactID required string: The Xero generated unique identifier for a Contact
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Contacts.ContactID.Attachments.FileName.get

Download an Attachment

xero.Contacts.ContactID.Attachments.FileName.get({
  "FileName": "",
  "ContactID": ""
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment to be downloaded
    • ContactID required string: The Xero generated unique identifier for a Contact
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

Output schema unknown

Contacts.ContactID.Attachments.FileName.post

Upload an Attachment

xero.Contacts.ContactID.Attachments.FileName.post({
  "FileName": "",
  "ContactID": "",
  "Content": {
    "Content": ""
  }
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment being uploaded
    • ContactID required string: The Xero generated unique identifier for a Contact
    • Content required Content

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

CreditNotes.get

Retrieve a collection of credit notes

xero.CreditNotes.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • page integer: Page number e.g. page=1. Page size is 100. When using the page parameter full resource details will be returned (including line items).

Output

  • output object
    • CreditNotes array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

CreditNotes.post

Create or update a credit note

xero.CreditNotes.post({
  "CreditNotes": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": []
  }
}, context)

Input

  • input object
    • CreditNotes required CreditNote
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • CreditNotes array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

CreditNotes.put

Create a credit note

xero.CreditNotes.put({
  "CreditNotes": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": []
  }
}, context)

Input

  • input object
    • CreditNotes required CreditNote
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • CreditNotes array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

CreditNotes.CreditNoteID.get

Retrieve an individual credit note

xero.CreditNotes.CreditNoteID.get({
  "CreditNoteID": ""
}, context)

Input

  • input object
    • CreditNoteID required string
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • CreditNotes array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

CreditNotes.CreditNoteID.post

Update a credit note

xero.CreditNotes.CreditNoteID.post({
  "CreditNotes": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": []
  },
  "CreditNoteID": ""
}, context)

Input

  • input object
    • CreditNotes required CreditNote
    • CreditNoteID required string
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • CreditNotes array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

CreditNotes.CreditNoteID.Allocations.put

Allocate a credit note

xero.CreditNotes.CreditNoteID.Allocations.put({
  "Allocations": {
    "Invoice": {},
    "AppliedAmount": 0,
    "Date": ""
  },
  "CreditNoteID": ""
}, context)

Input

  • input object
    • Allocations required Allocation
    • CreditNoteID required string

Output

  • output object
    • CreditNotes array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

CreditNotes.CreditNoteID.Attachments.get

Retrieve Attachments

xero.CreditNotes.CreditNoteID.Attachments.get({
  "CreditNoteID": ""
}, context)

Input

  • input object
    • CreditNoteID required string: The Xero generated unique identifier for a CreditNote
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

CreditNotes.CreditNoteID.Attachments.FileName.get

Download an Attachment

xero.CreditNotes.CreditNoteID.Attachments.FileName.get({
  "FileName": "",
  "CreditNoteID": ""
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment to be downloaded
    • CreditNoteID required string: The Xero generated unique identifier for a CreditNote
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

Output schema unknown

CreditNotes.CreditNoteID.Attachments.FileName.post

Upload an Attachment

xero.CreditNotes.CreditNoteID.Attachments.FileName.post({
  "FileName": "",
  "CreditNoteID": "",
  "Content": {
    "Content": ""
  }
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment being uploaded
    • CreditNoteID required string: The Xero generated unique identifier for a CreditNote
    • Content required Content

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Currencies.get

Retrieve the currencies the organisation is subscribed to

xero.Currencies.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned

Output

  • output object
    • Currencies array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Currencies.put

Add currencies to the organisation

xero.Currencies.put({
  "Currencies": {}
}, context)

Input

  • input object
    • Currencies required Currency
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • Currencies array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Employees.get

Retrieve a collection of employees

xero.Employees.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • Employees array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Employees.post

Create or update employees

xero.Employees.post({
  "Employees": {
    "FirstName": "",
    "LastName": ""
  }
}, context)

Input

  • input object
    • Employees required Employee
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • Employees array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Employees.put

Create employees

xero.Employees.put({
  "Employees": {
    "FirstName": "",
    "LastName": ""
  }
}, context)

Input

  • input object
    • Employees required Employee
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • Employees array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Employees.EmployeeID.get

Retrieve an individual employee

xero.Employees.EmployeeID.get({
  "EmployeeID": ""
}, context)

Input

  • input object
    • EmployeeID required string

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • Employees array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Employees.EmployeeID.post

Update an employee

xero.Employees.EmployeeID.post({
  "Employees": {
    "FirstName": "",
    "LastName": ""
  },
  "EmployeeID": ""
}, context)

Input

  • input object
    • Employees required Employee
    • EmployeeID required string

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • Employees array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ExpenseClaims.get

Retrieve a collection of expense claims

xero.ExpenseClaims.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ExpenseClaims array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ExpenseClaims.post

Create or update an expense claim

xero.ExpenseClaims.post({
  "ExpenseClaims": {
    "User": {},
    "Receipts": []
  }
}, context)

Input

  • input object
    • ExpenseClaims required ExpenseClaim
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ExpenseClaims array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ExpenseClaims.put

Create an expense claim

xero.ExpenseClaims.put({
  "ExpenseClaims": {
    "User": {},
    "Receipts": []
  }
}, context)

Input

  • input object
    • ExpenseClaims required ExpenseClaim
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ExpenseClaims array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ExpenseClaims.ExpenseClaimID.get

Retrieve an individual expense claim

xero.ExpenseClaims.ExpenseClaimID.get({
  "ExpenseClaimID": ""
}, context)

Input

  • input object
    • ExpenseClaimID required string

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ExpenseClaims array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ExpenseClaims.ExpenseClaimID.post

Update an expense claim

xero.ExpenseClaims.ExpenseClaimID.post({
  "ExpenseClaims": {
    "User": {},
    "Receipts": []
  },
  "ExpenseClaimID": ""
}, context)

Input

  • input object
    • ExpenseClaims required ExpenseClaim
    • ExpenseClaimID required string

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ExpenseClaims array
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Invoices.get

Retrieve a collection of invoices (sales invoices and bills)

xero.Invoices.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • IDs string: Filter by a comma-separated list of InvoiceIDs
    • ContactIDs string: Filter by a comma-separated list of ContactIDs
    • Statuses string: Filter by a comma-separated list of Statuses
    • InvoiceNumbers string: Filter by a comma-separated list of InvoiceNumbers

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Invoices array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Invoices.post

Create or update an Invoice (sales invoices or bills)

xero.Invoices.post({
  "Invoices": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": []
  }
}, context)

Input

  • input object
    • Invoices required Invoice
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Invoices array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Invoices.put

Create an Invoice (sales invoices or bills)

xero.Invoices.put({
  "Invoices": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": []
  }
}, context)

Input

  • input object
    • Invoices required Invoice
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Invoices array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Invoices.InvoiceID.get

Retrieve an Invoice (sales invoice or bill)

xero.Invoices.InvoiceID.get({
  "InvoiceID": ""
}, context)

Input

  • input object
    • InvoiceID required string
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Invoices array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Invoices.InvoiceID.post

Update an Invoice (sales invoice or bill)

xero.Invoices.InvoiceID.post({
  "Invoices": {
    "Type": "",
    "Contact": {
      "Name": ""
    },
    "LineItems": []
  },
  "InvoiceID": ""
}, context)

Input

  • input object
    • Invoices required Invoice
    • InvoiceID required string
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Invoices array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Invoices.InvoiceID.Attachments.get

Retrieve Attachments

xero.Invoices.InvoiceID.Attachments.get({
  "InvoiceID": ""
}, context)

Input

  • input object
    • InvoiceID required string: The Xero generated unique identifier for an Invoice
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Invoices.InvoiceID.Attachments.FileName.get

Download an Attachment

xero.Invoices.InvoiceID.Attachments.FileName.get({
  "FileName": "",
  "InvoiceID": ""
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment to be downloaded
    • InvoiceID required string: The Xero generated unique identifier for an Invoice
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00

Output

Output schema unknown

Invoices.InvoiceID.Attachments.FileName.post

Upload an Attachment

xero.Invoices.InvoiceID.Attachments.FileName.post({
  "FileName": "",
  "InvoiceID": "",
  "Content": {
    "Content": ""
  }
}, context)

Input

  • input object
    • FileName required string: The filename of the attachment being uploaded
    • InvoiceID required string: The Xero generated unique identifier for an Invoice
    • Content required Content

Output

  • output object
    • Attachments array
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Invoices.InvoiceID.OnlineInvoice.get

Retrieve the URL to view the online invoice

xero.Invoices.InvoiceID.OnlineInvoice.get({
  "InvoiceID": ""
}, context)

Input

  • input object
    • InvoiceID required string

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • OnlineInvoices array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Items.get

Retrieve a collection of items

xero.Items.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Items array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Items.post

Create or update an item

xero.Items.post({
  "Items": {
    "Code": ""
  }
}, context)

Input

  • input object
    • Items required Item
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Items array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Items.put

Create an item

xero.Items.put({
  "Items": {
    "Code": ""
  }
}, context)

Input

  • input object
    • Items required Item
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Items array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Items.ItemID.delete

Delete an item

xero.Items.ItemID.delete({
  "ItemID": ""
}, context)

Input

  • input object
    • ItemID required string

Output

Output schema unknown

Items.ItemID.get

Retrieve an item

xero.Items.ItemID.get({
  "ItemID": ""
}, context)

Input

  • input object
    • ItemID required string
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Items array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Items.ItemID.post

Update an item

xero.Items.ItemID.post({
  "Items": {
    "Code": ""
  },
  "ItemID": ""
}, context)

Input

  • input object
    • Items required Item
    • ItemID required string
    • unitdp integer: Determines the decimal places accepted/returned on the UnitAmount. UnitAmount is 2 decimal places by default but can be increased to 4 decimal places by supplying the unitdp=4 parameter.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Items array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Journals.get

Retrieve a collection of journals.

xero.Journals.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • paymentsOnly boolean: Return results on a the cash basis
    • offset integer: Offset by a specified journal number. e.g. journals with a JournalNumber greater than the offset will be returned.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Journals array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

Journals.JournalID.get

Retrieve an individual journal.

xero.Journals.JournalID.get({
  "JournalID": ""
}, context)

Input

  • input object
    • JournalID required string

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • Journals array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

LinkedTransactions.get

Retrieve a collection of linked transactions (billable expenses)

xero.LinkedTransactions.get({}, context)

Input

  • input object
    • page integer: Page number e.g. page=1. Page size is 100. When using the page parameter full resource details will be returned (including line items).
    • SourceTransactionID string: Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice
    • ContactID string: Filter by the ContactID. Get all the linked transactions that have been assigned to a particular customer.
    • Status string: 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 e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED.
    • TargetTransactionID string: Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • LinkedTransactions array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

LinkedTransactions.post

Create or update a linked transaction (billable expense)

xero.LinkedTransactions.post({
  "LinkedTransactions": {}
}, context)

Input

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • LinkedTransactions array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

LinkedTransactions.put

Create a linked transaction (billable expense)

xero.LinkedTransactions.put({
  "LinkedTransactions": {}
}, context)

Input

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • LinkedTransactions array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

LinkedTransactions.LinkedTransactionID.delete

Delete a linked transaction (billable expense)

xero.LinkedTransactions.LinkedTransactionID.delete({
  "LinkedTransactionID": ""
}, context)

Input

  • input object
    • LinkedTransactionID required string

Output

Output schema unknown

LinkedTransactions.LinkedTransactionID.get

Retrieve a linked transaction (billable expense)

xero.LinkedTransactions.LinkedTransactionID.get({
  "LinkedTransactionID": ""
}, context)

Input

  • input object
    • LinkedTransactionID required string

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • LinkedTransactions array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

LinkedTransactions.LinkedTransactionID.post

Update a linked transaction (billable expense)

xero.LinkedTransactions.LinkedTransactionID.post({
  "LinkedTransactions": {},
  "LinkedTransactionID": ""
}, context)

Input

  • input object

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • LinkedTransactions array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ManualJournals.get

Retrieve a collection of manual journals

xero.ManualJournals.get({}, context)

Input

  • input object
    • If-Modified-Since string: A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
    • where string: Filter by an any element
    • order string: Order by any element returned
    • page integer: Page number e.g. page=1. Page size is 100. When using the page parameter full resource details will be returned (including line items).

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ManualJournals array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ManualJournals.post

Create or update a manual journal

xero.ManualJournals.post({
  "ManualJournals": {
    "Narration": "",
    "JournalLines": []
  }
}, context)

Input

  • input object
    • ManualJournals required ManualJournal
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ManualJournals array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ManualJournals.put

Create a manual journal

xero.ManualJournals.put({
  "ManualJournals": {
    "Narration": "",
    "JournalLines": []
  }
}, context)

Input

  • input object
    • ManualJournals required ManualJournal
    • summarizeErrors boolean: If you plan to submit more than one entity per API call, we recommend that you append the summarizeErrors=false querystring to your API call. This ensures that every entity is returned back to you, each having their own status attribute.

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ManualJournals array
    • ProviderName string: Name of the application that made the request
    • Status string: OK for a successful response

ManualJournals.ManualJournalID.get

Retrieve an individual manual journal

xero.ManualJournals.ManualJournalID.get({
  "ManualJournalID": ""
}, context)

Input

  • input object
    • ManualJournalID required string

Output

  • output object
    • DateTimeUTC string: DateTime of the request
    • ID string: Unique identifier for each response
    • ManualJournals array
    • ProviderName string: Name of the application that made the request
    • Status `str
datafire
@everything-registry/sub-chunk-223@infinitebrahmanuniverse/nolb-_datafire_x@zalastax/nolb-_datafire_x
5.0.0

3 years ago

4.1.1

6 years ago

4.1.0

6 years ago

4.0.0

6 years ago

3.0.0

6 years ago