Overview
Configuration is provided for establishing connections with the Xero service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this section we will show you how to set up a REST Connection Manager to access the Xero service using the legacy certificate-based authentication.
- Download and install OpenSSL.
- Run the OpenSSL application in administrator mode. Find the folder where it is installed and go to the bin folder. Right-mouse-click on openssl.exe and select “Run as Administrator.”
- Execute this command in the OpenSSL window:
genrsa -des3 -out privatekey.pem 1024 - Enter a pass phrase and verify it by typing it a second time, when prompted. This will be used in the password parameter when you set up the REST connection manager with the Xero config file.
- Execute this command in the OpenSSL window:
req -new -x509 -key privatekey.pem -out publickey.cer -days 1825 - Enter the pass phrase you created when you executed the first command above and provide answers to each of the questions asked.
- Execute this command in the OpenSSL window: pkcs12 -export -out public_privatekey.pfx -inkey privatekey.pem -in publickey.cer
- Enter the pass phrase you created when you executed the first command above and then create an export password when prompted. This can be the same or different from the first pass phrase. Verify this pass phrase when prompted.
- Locate the keys/certificates you just created. By default, they will be placed in the bin folder under the OpenSSL folder.
- Go to this page on the Xero website: https://api.xero.com and login using your Xero credentials.
- Click on My Apps.
- Click on New App.
- Click on Private App.
- Fill in the App name. You may name it whatever name you want to use.
- Select your organization.
- Place your Public Key in the box. You may drag it there or click on the box and select it. This key is the one with the .cer extension.
- Click one or both of the checkboxes at the bottom.
- Click Create App in the bottom right corner.
- When the App Details are displayed, click Save.
- Under OAuth 1.0a Credentials, click on Copy next to the Consumer Key.
- In Visual Studio, with an SSIS package open, right-click on the Connection Manager canvas.
- Select New Connection.
- When the list of connection managers appears, scroll down the list to find the REST connection manager and select it.
- Once the connection manager dialog opens, select the Xero configuration.
- Paste the Consumer Key into the Consumer Key field. This is the value you copied from the Private App you created on the Xero website.
- For the Certificate field, click on the ellipsis to browse to the private certificate you created using OpenSSL (e.g. in the bin folder) and select it. The correct certificate will be the one that has the .pfx extension.
- Enter your Password. This is the pass phrase you created with the first command in OpenSSL.
- Click on Test Connection.
- When you see Test Connection succeeded, click OK.
- Click OK to close the connection manager dialog.
Congratulations! You have successfully configured a REST connection manager for Xero.
Configuration
Base URL address: https://api.xero.com/api.xro/2.0.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope: https://developer.xero.com/documentation/oauth2/scopes
- TenantId: Required. Specify tenant (organization) identifier.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
Xero-tenant-id:
{{=token.TenantId}}
Documentation: https://developer.xero.com/documentation/oauth2/auth-flow.
- Legacy
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- ConsumerKey: Required. Specify consumer key.
- Certificate: Required. Select certificate file.
- Password: Required. Specify certificate password.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
OAuth {{=Xero.getAuthentication(request)}}
Documentation: https://developer.xero.com/documentation/auth-and-limits/private-applications.
- [Read] action
-
Endpoint URL address:
/{{=parameters.endpoint}}/{{=parameters.guid}}/Attachments/.
The result is extracted from:{{=response.Attachments}}.The action has the following user-defined parameters:
- endpoint: Required. Specifies the name of the parent endpoint (e.g. Receipts, Invoices).
- guid: Required. Specifies the guid of the document that the attachment belongs to (e.g. ReceiptID or InvoiceID).
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: https://developer.xero.com/documentation/api/attachments/#GET.
- [Create] action
-
Endpoint URL address:
/{{=parameters.endpoint}}/{{=parameters.guid}}/Attachments/{{=item.Filename}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
content:
{{=item.Content}}
Documentation: https://developer.xero.com/documentation/api/attachments/#PUT.
-
content:
- [Update] action
-
Endpoint URL address:
/{{=parameters.endpoint}}/{{=parameters.guid}}/Attachments/{{=item.Filename}}.
The action uses POST method.The following request parameters will be automatically processed:
-
content:
{{=item.Content}}
Documentation: https://developer.xero.com/documentation/api/attachments/#POST.
-
content:
- AttachmentID
A key field. Template: ShortText.
- Filename
Template: ShortText.
- Content
Data type: DT_IMAGE The value is gathered from
/{{=parameters.endpoint}}/{{=parameters.guid}}/Attachments/{{=item.Filename}}address.- MimeType
Template: ShortText.
- Url
Template: ShortText. A read-only field.
- ContentLength
Data type: DT_I4 A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Accounts.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/accounts/#GET.
- [Create] action
-
Endpoint URL address:
/Accounts.Documentation: https://developer.xero.com/documentation/api/accounts/#PUT.
- [Update] action
-
Endpoint URL address:
/Accounts.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ Accounts: { Account: Xero.wrapString(resource, item) } })}}
Documentation: https://developer.xero.com/documentation/api/accounts/#POST.
-
application/xml:
- [Delete] action
-
Endpoint URL address:
/Accounts/{{=item.AccountID}}.
The action uses DELETE method.Documentation: https://developer.xero.com/documentation/api/accounts/#DELETE.
- AccountID
A key field. Template: ShortText.
- Code
Template: ShortText.
- Name
Template: ShortText.
- Type
Template: ShortText.
- BankAccountNumber
Template: ShortText.
- Status
Template: ShortText.
- Description
Template: LongText.
- TaxType
Template: ShortText.
- EnablePaymentsToAccount
Data type: DT_BOOL
- ShowInExpenseClaims
Data type: DT_BOOL
- Class
Template: ShortText. A read-only field.
- SystemAccount
Template: ShortText. A read-only field.
- BankAccountType
Template: ShortText. A read-only field.
- CurrencyCode
Template: ShortText. A read-only field.
- ReportingCode
Template: ShortText. A read-only field.
- ReportingCodeName
Template: ShortText. A read-only field.
- HasAttachments
Data type: DT_BOOL A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
Based on resource template BatchBase.
- [Read] action
-
Endpoint URL address:
/BankTransactions.Documentation: https://developer.xero.com/documentation/api/banktransactions/#GET.
- [Create] action
-
Endpoint URL address:
/BankTransactions.Documentation: https://developer.xero.com/documentation/api/banktransactions/#PUT.
- [Update] action
-
Endpoint URL address:
/BankTransactions.Documentation: https://developer.xero.com/documentation/api/banktransactions/#POST.
- [Delete] action
-
Endpoint URL address:
/BankTransactions.
- BankTransactionID
A key field. Template: ShortText.
- Type
Template: ShortText.
- Contact
Template: Contact.
- LineItems
Field components:
- An array.
-
Uses template:
LineItem.
- BankAccount
Template: BankAccount.
- IsReconciled
Data type: DT_BOOL
- Date
Template: DateTime.
- Reference
Template: ShortText.
- CurrencyCode
Template: ShortText.
- CurrencyRate
Template: Decimal.
- Url
Template: ShortText.
- Status
Template: ShortText.
- LineAmountTypes
Template: ShortText.
- SubTotal
Template: Decimal.
- TotalTax
Template: Decimal.
- Total
Template: Decimal.
- PrepaymentID
Template: ShortText. A read-only field.
- OverpaymentID
Template: ShortText. A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
- HasAttachments
Data type: DT_BOOL A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/BankTransfers.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/bank-transfers/#GET.
- [Create] action
-
Endpoint URL address:
/BankTransfers.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ BankTransfers: { BankTransfer: Xero.wrapString(resource, item) } })}}
Documentation: https://developer.xero.com/documentation/api/bank-transfers/#PUT.
-
application/xml:
- BankTransferID
A key field. Template: ShortText.
- FromBankAccount
Template: BankAccount.
- ToBankAccount
Template: BankAccount.
- Amount
Template: Decimal.
- Date
Template: DateTime.
- CurrencyRate
Template: Decimal. A read-only field.
- FromBankTransactionID
Template: ShortText. A read-only field.
- ToBankTransactionID
Template: ShortText. A read-only field.
- HasAttachments
Data type: DT_BOOL A read-only field.
- CreatedDateUTC
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/BrandingThemes.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/branding-themes/#GET.
- BrandingThemeID
A key field. Template: ShortText.
- Name
Template: ShortText.
- SortOrder
Data type: DT_I4
- CreatedDateUTC
Template: DateTime.
Based on resource template BatchBase.
- [Read] action
-
Endpoint URL address:
/Contacts.Documentation: https://developer.xero.com/documentation/api/contacts/#GET.
- [Create] action
-
Endpoint URL address:
/Contacts.Documentation: https://developer.xero.com/documentation/api/contacts/#PUT.
- [Update] action
-
Endpoint URL address:
/Contacts.Documentation: https://developer.xero.com/documentation/api/contacts/#POST.
- ContactID
A key field. Template: ShortText.
- ContactNumber
Template: ShortText.
- AccountNumber
Template: ShortText.
- ContactStatus
Template: ShortText.
- Name
Template: ShortText.
- FirstName
Template: ShortText.
- LastName
Template: ShortText.
- EmailAddress
Template: ShortText.
- SkypeUserName
Template: ShortText.
- ContactPersons
Field components:
- An array.
-
Uses template:
ContactPerson.
- BankAccountDetails
Template: ShortText.
- TaxNumber
Template: ShortText.
- AccountsReceivableTaxType
Template: ShortText.
- AccountsPayableTaxType
Template: ShortText.
- Addresses
Field components:
- An array.
-
Uses template:
Address.
- Phones
Field components:
- An array.
-
Uses template:
Phone.
- IsSupplier
Data type: DT_BOOL
- IsCustomer
Data type: DT_BOOL
- DefaultCurrency
Template: ShortText.
- XeroNetworkKey
Template: ShortText.
- SalesDefaultAccountCode
Template: ShortText.
- PurchasesDefaultAccountCode
Template: ShortText.
- SalesTrackingCategories
Field components:
- An array.
-
Uses template:
TrackingCategory.
- PurchasesTrackingCategories
Field components:
- An array.
-
Uses template:
TrackingCategory.
- PaymentTerms
Template: ShortText.
- UpdatedDateUTC
Template: DateTime. A read-only field.
- ContactGroups
A read-only field. Field components:
- An array.
- Contains the following components: ContactGroupID, Name.
- Website
Template: ShortText. A read-only field.
- BrandingTheme
Template: BrandingTheme. A read-only field.
- BatchPayments
Template: ShortText. A read-only field.
- Discount
Template: ShortText. A read-only field.
- Balances
A read-only field. Field components:
- Contains the following components: AccountsReceivable, AccountsPayable.
- HasAttachments
Data type: DT_BOOL A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ContactGroups.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/contactgroups/#GET.
- [Create] action
-
Endpoint URL address:
/ContactGroups.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ ContactGroups: { ContactGroup: Xero.wrapString(resource, item) } })}}
Documentation: https://developer.xero.com/documentation/api/contactgroups/#PUT.
-
application/xml:
- [Update] action
-
Endpoint URL address:
/ContactGroups.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ ContactGroups: { ContactGroup: Xero.wrapString(resource, item) } })}}
Documentation: https://developer.xero.com/documentation/api/contactgroups/#POST.
-
application/xml:
- [Delete] action
-
Endpoint URL address:
/ContactGroups.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ ContactGroups: { ContactGroup: Xero.wrapString(resource, _.extend(item, { Status: 'DELETED' })) } })}}
-
application/xml:
- ContactGroupID
A key field. Template: ShortText.
- Name
Template: ShortText.
- Status
Template: ShortText.
- Contacts
The value is sent to
/ContactGroups/{{=item.ContactGroupID}}/Contactsaddress. Field components:- An array.
-
Uses template:
Contact.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/CreditNotes.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/credit-notes/#GET.
- [Create] action
-
Endpoint URL address:
/CreditNotes.Documentation: https://developer.xero.com/documentation/api/credit-notes/#PUT.
- [Update] action
-
Endpoint URL address:
/CreditNotes.Documentation: https://developer.xero.com/documentation/api/credit-notes/#POST.
- CreditNoteID
A key field. Template: ShortText.
- Type
Template: ShortText.
- Contact
Template: Contact.
- Date
Template: DateTime.
- Status
Template: ShortText.
- LineAmountTypes
Template: ShortText.
- LineItems
Field components:
- An array.
-
Uses template:
LineItem.
- SubTotal
Template: Decimal.
- TotalTax
Template: Decimal.
- Total
Template: Decimal.
- UpdatedDateUTC
Template: DateTime.
- CurrencyCode
Template: ShortText.
- FullyPaidOnDate
Template: DateTime.
- CreditNoteNumber
Template: ShortText.
- Reference
Template: ShortText.
- SentToContact
Data type: DT_BOOL
- CurrencyRate
Template: Decimal.
- RemainingCredit
Template: Decimal.
- Allocations
Field components:
- An array.
-
Uses template:
Allocation.
- BrandingThemeID
Template: ShortText.
- HasAttachments
Data type: DT_BOOL
Based on resource template BatchBase.
- [Read] action
-
Endpoint URL address:
/Employees.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/employees/#GET.
- [Create] action
-
Endpoint URL address:
/Employees.Documentation: https://developer.xero.com/documentation/api/employees/#PUT.
- [Update] action
-
Endpoint URL address:
/Employees.Documentation: https://developer.xero.com/documentation/api/employees/#POST.
- EmployeeID
A key field. Template: ShortText.
- Status
Template: ShortText.
- FirstName
Template: ShortText.
- LastName
Template: ShortText.
- ExternalLink
Field components:
-
Uses template:
ShortText. - Contains the following components: Url.
-
Uses template:
- UpdatedDateUTC
Template: DateTime. A read-only field.
Based on resource template BatchBase.
- [Read] action
-
Endpoint URL address:
/ExpenseClaims.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/expense-claims/#GET.
- [Create] action
-
Endpoint URL address:
/ExpenseClaims.Documentation: https://developer.xero.com/documentation/api/expense-claims/#PUT.
- [Update] action
-
Endpoint URL address:
/ExpenseClaims.Documentation: https://developer.xero.com/documentation/api/expense-claims/#POST.
- ExpenseClaimID
A key field. Template: ShortText.
- User
Template: User.
- Receipts
Field components:
- An array.
- Contains the following components: ReceiptID, ReceiptNumber.
- Payments
A read-only field. Field components:
- An array.
-
Uses template:
Payment.
- Status
Template: ShortText. A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
- Total
Template: Decimal. A read-only field.
- AmountDue
Template: Decimal. A read-only field.
- AmountPaid
Template: Decimal. A read-only field.
- PaymentDueDate
Template: DateTime. A read-only field.
- ReportingDate
Template: DateTime. A read-only field.
Based on resource template BatchBase.
- [Read] action
-
Endpoint URL address:
/Invoices.Documentation: https://developer.xero.com/documentation/api/invoices/#get.
- [Create] action
-
Endpoint URL address:
/Invoices.Documentation: https://developer.xero.com/documentation/api/invoices/#put.
- [Update] action
-
Endpoint URL address:
/Invoices.Documentation: https://developer.xero.com/documentation/api/invoices/#post.
- [Delete] action
-
Endpoint URL address:
/Invoices.
- InvoiceID
A key field. Template: ShortText.
- Type
Template: ShortText.
- Contact
Template: Contact.
- LineItems
Field components:
- An array.
-
Uses template:
LineItem.
- Date
Template: DateTime.
- DueDate
Template: DateTime.
- LineAmountTypes
Template: ShortText.
- InvoiceNumber
Template: ShortText.
- Reference
Template: ShortText.
- BrandingThemeID
Template: ShortText.
- Url
Template: ShortText.
- CurrencyCode
Template: ShortText.
- CurrencyRate
Template: Decimal.
- Status
Template: ShortText.
- SentToContact
Data type: DT_BOOL
- ExpectedPaymentDate
Template: DateTime.
- PlannedPaymentDate
Template: DateTime.
- SubTotal
Template: Decimal. A read-only field.
- TotalTax
Template: Decimal. A read-only field.
- Total
Template: Decimal. A read-only field.
- TotalDiscount
Template: Decimal. A read-only field.
- HasAttachments
Data type: DT_BOOL A read-only field.
- Payments
A read-only field. Field components:
- An array.
-
Uses template:
Payment.
- Prepayments
A read-only field. Field components:
- An array.
- Contains the following components: PrepaymentID, Date, Total.
- Overpayments
A read-only field. Field components:
- An array.
- Contains the following components: OverpaymentID, Date, Total.
- AmountDue
Template: Decimal. A read-only field.
- AmountPaid
Template: Decimal. A read-only field.
- FullyPaidOnDate
Template: DateTime. A read-only field.
- AmountCredited
Template: Decimal. A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
- CreditNotes
A read-only field. Field components:
- An array.
- Contains the following components: CreditNoteID, CreditNoteNumber.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Items.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/items/#GET.
- [Create] action
-
Endpoint URL address:
/Items.Documentation: https://developer.xero.com/documentation/api/items/#PUT.
- [Update] action
-
Endpoint URL address:
/Items.Documentation: https://developer.xero.com/documentation/api/items/#POST.
- [Delete] action
-
Endpoint URL address:
/Items/{{=item.ItemID}}.
The action uses DELETE method.Documentation: https://developer.xero.com/documentation/api/items/#DELETE.
- ItemID
A key field. Template: ShortText.
- Code
Template: ShortText.
- InventoryAssetAccountCode
Template: ShortText.
- Name
Template: ShortText.
- IsSold
Data type: DT_BOOL
- IsPurchased
Data type: DT_BOOL
- Description
Template: LongText.
- PurchaseDescription
Template: LongText.
- PurchaseDetails
Template: PurchaseSalesDetails.
- SalesDetails
Template: PurchaseSalesDetails.
- IsTrackedAsInventory
Data type: DT_BOOL
- TotalCostPool
Template: Decimal.
- QuantityOnHand
Data type: DT_I4
- UpdatedDateUTC
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Journals.
The result is paginated.The following request parameters will be automatically processed:
-
page:
-
offset:
{{=parameters.iterator}}
Documentation: https://developer.xero.com/documentation/api/journals/#GET.
-
page:
- JournalID
A key field. Template: ShortText.
- JournalDate
Template: DateTime.
- JournalNumber
Template: ShortText.
- CreatedDateUTC
Template: DateTime.
- Reference
Template: ShortText.
- SourceID
Template: ShortText.
- SourceType
Template: ShortText.
- JournalLines
Field components:
- An array.
- Contains the following components: JournalLineID, AccountID, AccountCode, AccountType, AccountName, Description, NetAmount, GrossAmount, TaxAmount, TaxType, TaxName, TrackingCategories.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/LinkedTransactions.Documentation: https://developer.xero.com/documentation/api/linked-transactions/#GET.
- [Create] action
-
Endpoint URL address:
/LinkedTransactions.Documentation: https://developer.xero.com/documentation/api/linked-transactions/#PUT.
- [Update] action
-
Endpoint URL address:
/LinkedTransactions.Documentation: https://developer.xero.com/documentation/api/linked-transactions/#POST.
- [Delete] action
-
Endpoint URL address:
/LinkedTransactions/{{=item.LinkedTransactionID}}.
The action uses DELETE method.Documentation: https://developer.xero.com/documentation/api/linked-transactions/#DELETE.
- LinkedTransactionID
A key field. Template: ShortText.
- SourceTransactionID
Template: ShortText.
- SourceLineItemID
Template: ShortText.
- ContactID
Template: ShortText.
- TargetTransactionID
Template: ShortText.
- TargetLineItemID
Template: ShortText.
- Status
Template: ShortText. A read-only field.
- Type
Template: ShortText. A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
- SourceTransactionTypeCode
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ManualJournals.Documentation: https://developer.xero.com/documentation/api/manual-journals/#GET.
- [Create] action
-
Endpoint URL address:
/ManualJournals.Documentation: https://developer.xero.com/documentation/api/manual-journals/#PUT.
- [Update] action
-
Endpoint URL address:
/ManualJournals.Documentation: https://developer.xero.com/documentation/api/manual-journals/#POST.
- ManualJournalID
A key field. Template: ShortText.
- Narration
Template: LongText.
- JournalLines
Field components:
- An array.
- Contains the following components: LineAmount, AccountCode, Description, TaxType, Tracking, TaxAmount.
- Date
Template: DateTime.
- LineAmountTypes
Template: ShortText.
- Status
Template: ShortText.
- Url
Template: ShortText.
- ShowOnCashBasisReports
Data type: DT_BOOL
- HasAttachments
Data type: DT_BOOL A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Organisation.
The result is paginated.
- APIKey
Template: ShortText.
- Name
Template: ShortText.
- LegalName
Template: ShortText.
- PaysTax
Data type: DT_BOOL
- Version
Template: ShortText.
- BaseCurrency
Template: ShortText.
- CountryCode
Template: ShortText.
- IsDemoCompany
Data type: DT_BOOL
- OrganisationStatus
Template: ShortText.
- RegistrationNumber
Template: ShortText.
- TaxNumber
Template: ShortText.
- FinancialYearEndDay
Data type: DT_I4
- FinancialYearEndMonth
Data type: DT_I4
- SalesTaxBasis
Template: ShortText.
- SalesTaxPeriod
Template: ShortText.
- DefaultSalesTax
Template: Decimal.
- DefaultPurchasesTax
Template: Decimal.
- PeriodLockDate
Template: ShortText.
- EndOfYearLockDate
Template: ShortText.
- CreatedDateUTC
Template: DateTime.
- OrganisationEntityType
Template: ShortText.
- Timezone
Template: ShortText.
- ShortCode
Template: ShortText.
- LineOfBusiness
Template: ShortText.
- Addresses
Field components:
- An array.
-
Uses template:
Address.
- Phones
Field components:
- An array.
-
Uses template:
Phone.
- ExternalLinks
Field components:
- An array.
- Contains the following components: LinkType, Url.
- PaymentTerms
Field components:
- Contains the following components: Bills, Sales.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Overpayments.Documentation: https://developer.xero.com/documentation/api/overpayments/#GET.
- [Update] action
-
Endpoint URL address:
/Overpayments/{{=item.OverpaymentID}/Allocations.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ Allocations: Xero.wrapString(resource, item.Allocations) })}}
Documentation: https://developer.xero.com/documentation/api/overpayments/#PUT.
-
application/xml:
- OverpaymentID
A key field. Template: ShortText.
- Type
Template: ShortText. A read-only field.
- Contact
Template: Contact. A read-only field.
- Date
Template: DateTime. A read-only field.
- Status
Template: ShortText. A read-only field.
- LineAmountTypes
Template: ShortText. A read-only field.
- LineItems
A read-only field. Field components:
- An array.
- Contains the following components: Description, Quantity, UnitAmount, AccountCode, TaxType, TaxAmount, LineAmount, Tracking.
- SubTotal
Template: Decimal. A read-only field.
- TotalTax
Template: Decimal. A read-only field.
- Total
Template: Decimal. A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
- CurrencyCode
Template: ShortText. A read-only field.
- CurrencyRate
Template: Decimal. A read-only field.
- RemainingCredit
Template: Decimal. A read-only field.
- Allocations
Field components:
- An array.
-
Uses template:
Allocation.
- Payments
A read-only field. Field components:
- An array.
-
Uses template:
Payment.
- HasAttachments
Data type: DT_BOOL A read-only field.
Based on resource template BatchBase.
- [Read] action
-
Endpoint URL address:
/Payments.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/payments/#GET.
- [Create] action
-
Endpoint URL address:
/Payments.Documentation: https://developer.xero.com/documentation/api/payments/#PUT.
- [Delete] action
-
Endpoint URL address:
/Payments/{{=item.PaymentID}}.
The result is extracted from:.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ Payments: { Payment: Xero.wrapString(resource, _.extend(item, { Status: 'DELETED' })) } })}}
Documentation: https://developer.xero.com/documentation/api/payments/#POST.
-
application/xml:
- PaymentID
A key field. Template: ShortText.
- Invoice
Field components:
-
Uses template:
ShortText. - Contains the following components: InvoiceID, InvoiceNumber.
-
Uses template:
- CreditNote
Field components:
-
Uses template:
ShortText. - Contains the following components: CreditNoteID, CreditNoteNumber.
-
Uses template:
- Prepayment
Field components:
-
Uses template:
ShortText. - Contains the following components: PrepaymentID.
-
Uses template:
- Overpayment
Field components:
-
Uses template:
ShortText. - Contains the following components: OverpaymentID.
-
Uses template:
- Account
Field components:
-
Uses template:
ShortText. - Contains the following components: AccountID, Code.
-
Uses template:
- Date
Template: DateTime.
- CurrencyRate
Template: Decimal.
- Amount
Template: Decimal.
- Reference
Template: ShortText.
- IsReconciled
Data type: DT_BOOL
- Status
Template: ShortText.
- PaymentType
Template: ShortText. A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Prepayments.Documentation: https://developer.xero.com/documentation/api/prepayments/#GET.
- [Update] action
-
Endpoint URL address:
/Prepayments/{{=item.PrepaymentID}/Allocations.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ Allocations: Xero.wrapString(resource, item.Allocations) })}}
Documentation: https://developer.xero.com/documentation/api/prepayments/#PUT.
-
application/xml:
- PrepaymentID
A key field. Template: ShortText.
- Type
Template: ShortText. A read-only field.
- Contact
Template: Contact. A read-only field.
- Date
Template: DateTime. A read-only field.
- Status
Template: ShortText. A read-only field.
- LineAmountTypes
Template: ShortText. A read-only field.
- LineItems
A read-only field. Field components:
- An array.
- Contains the following components: Description, Quantity, UnitAmount, AccountCode, TaxType, TaxAmount, LineAmount, Tracking.
- SubTotal
Template: Decimal. A read-only field.
- TotalTax
Template: Decimal. A read-only field.
- Total
Template: Decimal. A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
- CurrencyCode
Template: ShortText. A read-only field.
- CurrencyRate
Template: Decimal. A read-only field.
- RemainingCredit
Template: Decimal. A read-only field.
- Allocations
Field components:
- An array.
-
Uses template:
Allocation.
- HasAttachments
Data type: DT_BOOL A read-only field.
Based on resource template BatchBase.
- [Read] action
-
Endpoint URL address:
/PurchaseOrders.Documentation: https://developer.xero.com/documentation/api/purchase-orders/#get.
- [Create] action
-
Endpoint URL address:
/PurchaseOrders.Documentation: https://developer.xero.com/documentation/api/purchase-orders/#put.
- [Update] action
-
Endpoint URL address:
/PurchaseOrders.Documentation: https://developer.xero.com/documentation/api/purchase-orders/#post.
- PurchaseOrderID
A key field. Template: ShortText.
- Contact
Template: Contact.
- LineItems
Field components:
- An array.
-
Uses template:
LineItem.
- Date
Template: DateTime.
- DeliveryDate
Template: DateTime.
- LineAmountTypes
Template: ShortText.
- PurchaseOrderNumber
Template: ShortText.
- Reference
Template: ShortText.
- BrandingThemeID
Template: ShortText.
- CurrencyCode
Template: ShortText.
- Status
Template: ShortText.
- SentToContact
Data type: DT_BOOL
- DeliveryAddress
Template: ShortText.
- AttentionTo
Template: ShortText.
- Telephone
Template: ShortText.
- DeliveryInstructions
Template: LongText.
- ExpectedArrivalDate
Template: DateTime.
- CurrencyRate
Template: Decimal. A read-only field.
- SubTotal
Template: Decimal. A read-only field.
- TotalTax
Template: Decimal. A read-only field.
- Total
Template: Decimal. A read-only field.
- TotalDiscount
Template: Decimal. A read-only field.
- HasAttachments
Data type: DT_BOOL A read-only field.
- UpdatedDateUTC
Template: DateTime.
Based on resource template BatchBase.
- [Read] action
-
Endpoint URL address:
/Receipts.Documentation: https://developer.xero.com/documentation/api/receipts/#GET.
- [Create] action
-
Endpoint URL address:
/Receipts.Documentation: https://developer.xero.com/documentation/api/receipts/#PUT.
- [Update] action
-
Endpoint URL address:
/Receipts.Documentation: https://developer.xero.com/documentation/api/receipts/#POST.
- [Delete] action
-
Endpoint URL address:
/Receipts.
The result is extracted from:.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ Receipt: Xero.wrapString(resource, _.extend(item, { Status: 'DELETED' })) })}}
-
application/xml:
- ReceiptID
A key field. Template: ShortText.
- Date
Template: DateTime.
- Contact
Template: Contact.
- Lineitems
Field components:
- An array.
-
Uses template:
LineItem.
- User
Template: User.
- Reference
Template: ShortText.
- LineAmountTypes
Template: ShortText.
- SubTotal
Template: Decimal.
- TotalTax
Template: Decimal.
- Total
Template: Decimal.
- Status
Template: ShortText. A read-only field.
- ReceiptNumber
Template: ShortText. A read-only field.
- UpdatedDateUTC
Template: DateTime. A read-only field.
- HasAttachments
Data type: DT_BOOL A read-only field.
- Url
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/RepeatingInvoices.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/repeating-invoices/#get.
- RepeatingInvoiceID
A key field. Template: ShortText.
- Type
Template: ShortText.
- Contact
Template: Contact.
- Schedule
Field components:
-
Uses template:
ShortText. - Contains the following components: Period, Unit, DueDate, DueDateType, StartDate, NextScheduledDate, EndDate.
-
Uses template:
- LineItems
Field components:
- An array.
-
Uses template:
LineItem.
- LineAmountTypes
Template: ShortText.
- Reference
Template: ShortText.
- BrandingThemeID
Template: ShortText.
- CurrencyCode
Template: ShortText.
- Status
Template: ShortText.
- SubTotal
Template: Decimal.
- TotalTax
Template: Decimal.
- Total
Template: Decimal.
- HasAttachments
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/TaxRates.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/tax-rates/#GET.
- [Create] action
-
Endpoint URL address:
/TaxRates.Documentation: https://developer.xero.com/documentation/api/tax-rates/#PUT.
- [Update] action
-
Endpoint URL address:
/TaxRates.Documentation: https://developer.xero.com/documentation/api/tax-rates/#POST.
- [Delete] action
-
Endpoint URL address:
/TaxRates.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ TaxRate: Xero.wrapString(resource, _.extend(item, { Status: 'DELETED' })) })}}
-
application/xml:
- Name
A key field. Template: ShortText.
- TaxType
Template: ShortText.
- TaxComponents
Field components:
- An array.
- Contains the following components: Name, Rate, IsCompound.
- Status
Template: ShortText.
- ReportTaxType
Template: ShortText.
- CanApplyToAssets
Data type: DT_BOOL A read-only field.
- CanApplyToEquity
Data type: DT_BOOL A read-only field.
- CanApplyToExpenses
Data type: DT_BOOL A read-only field.
- CanApplyToLiabilities
Data type: DT_BOOL A read-only field.
- CanApplyToRevenue
Data type: DT_BOOL A read-only field.
- DisplayTaxRate
Template: Decimal. A read-only field.
- EffectiveRate
Template: Decimal. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/TrackingCategories.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/tracking-categories/#GET.
- [Create] action
-
Endpoint URL address:
/TrackingCategories.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ TrackingCategories: { TrackingCategory: Xero.wrapString(resource, item) } })}}
Documentation: https://developer.xero.com/documentation/api/tracking-categories/#PUT.
-
application/xml:
- [Update] action
-
Endpoint URL address:
/TrackingCategories/{{=item.TrackingCategoryID}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml({ TrackingCategories: { TrackingCategory: Xero.wrapString(resource, item) } })}}
Documentation: https://developer.xero.com/documentation/api/tracking-categories/#POST.
-
application/xml:
- [Delete] action
-
Endpoint URL address:
/TrackingCategories/{{=item.TrackingCategoryID}}.
The action uses DELETE method.Documentation: https://developer.xero.com/documentation/api/tracking-categories/#DELETE.
- TrackingCategoryID
A key field. Template: ShortText.
- Name
Template: ShortText.
- Status
Template: ShortText.
- Options
The value is sent to
/TrackingCategories/{{=item.TrackingCategoryID}}/Optionssaddress. Field components:- An array.
-
Uses template:
TrackingCategoryOption.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Users.
The result is paginated.Documentation: https://developer.xero.com/documentation/api/users/#GET.
- UserID
A key field. Template: ShortText.
- EmailAddress
Template: ShortText.
- FirstName
Template: ShortText.
- LastName
Template: ShortText.
- UpdatedDateUTC
Template: DateTime.
- IsSubscriber
Data type: DT_BOOL
- OrganisationRole
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=response[resource.objects]}}.
The result is paginated.The action has the following user-defined parameters:
- ModifiedAfter: Required. Specifies a timestamp. Only items created or modified since this timestamp will be returned.
The following request parameters will be automatically processed:
-
If-Modified-Since:
{{=parameters.ModifiedAfter}} -
page:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
- [Create] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml( function(item) { var result = {}; result[resource.object] = Xero.wrapString(resource, item); return result; }(item) )}}
-
application/xml:
- [Update] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml( function(item) { var result = {}; result[resource.object] = Xero.wrapString(resource, item); return result; }(item) )}}
-
application/xml:
Based on resource template Base.
- [Create] action
-
The result is extracted from:{{=response[resource.objects]}}.The following request parameters will be automatically processed:
-
summarizeErrors:
false -
application/xml:
{{=json2xml( function(batch) { var result = {}; result[resource.objects] = _.map(batch, function(item) { var itemResult = {}; itemResult[resource.object] = Xero.wrapString(resource, item); return itemResult; }); return result; }(batch) )}}
-
summarizeErrors:
- [Update] action
-
The result is extracted from:{{=response[resource.objects]}}.The following request parameters will be automatically processed:
-
summarizeErrors:
false -
application/xml:
{{=json2xml( function(batch) { var result = {}; result[resource.objects] = _.map(batch, function(item) { var itemResult = {}; itemResult[resource.object] = Xero.wrapString(resource, item); return itemResult; }); return result; }(batch) )}}
-
summarizeErrors:
- [Delete] action
-
The result is extracted from:{{=response[resource.objects]}}.
The action uses POST method.The following request parameters will be automatically processed:
-
summarizeErrors:
false -
application/xml:
{{=json2xml( function(batch) { var result = {}; result[resource.objects] = _.map(batch, function(item) { var itemResult = {}; itemResult[resource.object] = Xero.wrapString(resource, _.extend(item, { Status: 'DELETED' })); return itemResult; }); return result; }(batch) )}}
-
summarizeErrors:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=(value && new Date(parseInt(/\/Date\(([-\d+]+)\)\//.exec(value)[1])).toUTCString()) || undefined}}expression.- Decimal
Data type: DT_DECIMAL
- ContactPerson
Field components:
-
Uses template:
ShortText. - Contains the following components: FirstName, LastName, EmailAddress, IncludeInEmails.
-
Uses template:
- Address
Field components:
-
Uses template:
ShortText. - Contains the following components: AddressType, AddressLine, City, Region, PostalCode, Country, AttentionTo.
-
Uses template:
- Phone
Field components:
-
Uses template:
ShortText. - Contains the following components: PhoneType, PhoneNumber, PhoneAreaCode, PhoneCountryCode.
-
Uses template:
- TrackingCategoryOption
Field components:
-
Uses template:
ShortText. - Contains the following components: TrackingOptionID, Name, Status.
-
Uses template:
- TrackingCategory
Field components:
-
Uses template:
ShortText. - Contains the following components: TrackingCategoryID, Name, Status, Options.
-
Uses template:
- Contact
Field components:
-
Uses template:
ShortText. - Contains the following components: ContactID, ContactNumber, Name.
-
Uses template:
- BrandingTheme
Field components:
-
Uses template:
ShortText. - Contains the following components: BrandingThemeID, Name, SortOrder, CreatedDateUTC.
-
Uses template:
- LineItem
Field components:
-
Uses template:
ShortText. - Contains the following components: LineItemID, Description, Quantity, UnitAmount, ItemCode, AccountCode, TaxType, DiscountRate, Tracking, TaxAmount, LineAmount.
-
Uses template:
- BankAccount
Field components:
-
Uses template:
ShortText. - Contains the following components: AccountID, Code.
-
Uses template:
- Allocation
Field components:
-
Uses template:
Decimal. - Contains the following components: AppliedAmount, Date, Invoice.
-
Uses template:
- Payment
Field components:
-
Uses template:
ShortText. - Contains the following components: PaymentID, Date, Amount, CurrencyRate.
-
Uses template:
- PurchaseSalesDetails
Field components:
-
Uses template:
Decimal. - Contains the following components: UnitPrice, AccountCode, COGSAccountCode, TaxType.
-
Uses template:
- User
Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, FirstName, LastName.
-
Uses template:
Knowledge Base
- Where can I find the documentation for the Xero Connection?
- How to export key pair and certificate to .pfx file.
What's New
- New: Support for Report API.
- New: Support for OAuth2 authentication.
- Fixed: Authentication signature was invalid because of changes in the REST backend.
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.