Xero Accounting Endpoint: Contacts: Difference between revisions

(10 intermediate revisions by 2 users not shown)

Line 1:

== Overview ==

The Xero '''Contacts''' [[Endpoints|endpoint]] allows you to access a simple list of contacts (both customers and suppliers) present within Xero.

The Xero '''Contacts''' [[Xero Accounting Endpoints|endpoint]] allows you to access a simple list of contacts (both customers and suppliers) present within Xero.

This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many contacts.

Line 44:

;SkypeUserName

:A [[Field Type: Text|text field]] that provides the skype user name of the contact.

;Website

:A [[Field Type: Text|text field]] that provides the website url of the contact.

;BankAccountDetails

:A [[Field Type: Text|text field]] that provides the bank account number of the contact.

;CompanyNumber

:A [[Field Type: Text|text field]] that provides the business registration number of the contact.

:This could either be:

:* '''ACN''' (for Australia)

:* '''NZBN''' (for New Zealand)

:* '''Business Registration Number''' (for UK)

:* '''Business Registration Number''' (for all other regions)

;TaxNumber

:A [[Field Type: Text|text field]] that provides the tax number of the contact.

:This could ~~eithe~~ be:

:This could either be:

:* '''ABN''' (for Australia)

:* '''GST Number''' (for New Zealand)

:* '''VAT Number''' (for UK)

:* '''Tax ID ~~Nuber~~''' (for all other regions)

:* '''Tax ID Number''' (for all other regions)

;AccountsReceivableTaxType

Line 77:

Line 88:

:A [[Field Type: Text|text field]] that provides the 3 digit ISO currency code.

:This field can be linked to the [[Xero Accounting Endpoint: Currencies|Currencies]] endpoint.

;BatchPayments

:A [[Field Type: Record|record field]] that provides additional fields for when recording batch payements.

:See [[#BatchPayments Fields|BatchPayments Fields]] for more information.

;Balances

Line 87:

Line 102:

;UpdatedDateUTC

:A [[Field Type: DateTimeOffset|date time field]] that indicates the last time this record was updated.

== BatchPayments Fields ==

The [[#Fields|BatchPayments Fields]] include the following sub fields.

;BankAccountNumber

:A [[Field Type: Text|text field]] that provides the bank account number of the contact.

;BankAccountName

:A [[Field Type: Text|text field]] that provides the bank account name of the contact.

;Details

:A [[Field Type: Text|text field]] that provides the details sent to a financial institution.

Line 107:

Line 136:

;Outstanding

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the total outstanding balance this customer owes.

:A [[Field Type: Decimal|decimal field]] that provides the total outstanding balance this customer owes.

;Overdue

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the portion of ouststanding balance this customer owes that is overdue.

:A [[Field Type: Decimal|decimal field]] that provides the portion of ouststanding balance this customer owes that is overdue.

Line 118:

Line 147:

;Outstanding

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the total outstanding balance owed to this supplier.

:A [[Field Type: Decimal|decimal field]] that provides the total outstanding balance owed to this supplier.

;Overdue

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the portion of ouststanding balance owed to this supplier that is overdue

:A [[Field Type: Decimal|decimal field]] that provides the portion of ouststanding balance owed to this supplier that is overdue

Line 139:

Line 168:

== Related Endpoints ==

:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]

:[[Xero Accounting Endpoint: BankTransactions|BankTransactions]]

:[[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]]

Line 144:

Line 174:

:[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]

:[[Xero Accounting Endpoint: Currencies|Currencies]]

:[[Xero Accounting Endpoint: Invoices|Invoices]]

:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]

:[[Xero Accounting Endpoint: Overpayments|Overpayments]]

:[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]

:[[Xero Accounting Endpoint: Prepayments|Prepayments]]

:[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]

:[[Xero Projects Endpoint: Projects|Projects]]

:[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]]

:[[Xero Accounting Endpoint: Quotes|Quotes]]

:[[Xero Accounting Endpoint: RepeatingInvoices|RepeatingInvoices]]

:[[Xero Accounting Endpoint: TaxRates|TaxRates]]

== Related Topics ==

:[[Xero Accounting Models]]

:[[Xero Accounting Endpoints]]

@@ Line 1: / Line 1: @@
 == Overview ==
-The Xero '''Contacts''' [[Endpoints|endpoint]] allows you to access a simple list of contacts (both customers and suppliers) present within Xero.
+The Xero '''Contacts''' [[Xero Accounting Endpoints|endpoint]] allows you to access a simple list of contacts (both customers and suppliers) present within Xero.
 This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many contacts.
@@ Line 44: / Line 44: @@
 ;SkypeUserName
 :A [[Field Type: Text|text field]] that provides the skype user name of the contact.
+;Website
+:A [[Field Type: Text|text field]] that provides the website url of the contact.
 ;BankAccountDetails
 :A [[Field Type: Text|text field]] that provides the bank account number of the contact.
+;CompanyNumber
+:A [[Field Type: Text|text field]] that provides the business registration number of the contact.
+:This could either be:
+:* '''ACN''' (for Australia)
+:* '''NZBN''' (for New Zealand)
+:* '''Business Registration Number''' (for UK)
+:* '''Business Registration Number''' (for all other regions)
 ;TaxNumber
 :A [[Field Type: Text|text field]] that provides the tax number of the contact.
-:This could eithe be:
+:This could either be:
 :* '''ABN''' (for Australia)
 :* '''GST Number''' (for New Zealand)
 :* '''VAT Number''' (for UK)
-:* '''Tax ID Nuber''' (for all other regions)
+:* '''Tax ID Number''' (for all other regions)
 ;AccountsReceivableTaxType
@@ Line 77: / Line 88: @@
 :A [[Field Type: Text|text field]] that provides the 3 digit ISO currency code.
 :This field can be linked to the [[Xero Accounting Endpoint: Currencies|Currencies]] endpoint.
+;BatchPayments
+:A [[Field Type: Record|record field]] that provides additional fields for when recording batch payements.
+:See [[#BatchPayments Fields|BatchPayments Fields]] for more information.
 ;Balances
@@ Line 87: / Line 102: @@
 ;UpdatedDateUTC
 :A [[Field Type: DateTimeOffset|date time field]] that indicates the last time this record was updated.
+== BatchPayments Fields ==
+The [[#Fields|BatchPayments Fields]] include the following sub fields.
+;BankAccountNumber
+:A [[Field Type: Text|text field]] that provides the bank account number of the contact.
+;BankAccountName
+:A [[Field Type: Text|text field]] that provides the bank account name of the contact.
+;Details
+:A [[Field Type: Text|text field]] that provides the details sent to a financial institution.
@@ Line 107: / Line 136: @@
 ;Outstanding
-:A [[Field Type: Decimal|decimal value]] that provides the total outstanding balance this customer owes.
+:A [[Field Type: Decimal|decimal field]] that provides the total outstanding balance this customer owes.
 ;Overdue
-:A [[Field Type: Decimal|decimal value]] that provides the portion of ouststanding balance this customer owes that is overdue.
+:A [[Field Type: Decimal|decimal field]] that provides the portion of ouststanding balance this customer owes that is overdue.
@@ Line 118: / Line 147: @@
 ;Outstanding
-:A [[Field Type: Decimal|decimal value]] that provides the total outstanding balance owed to this supplier.
+:A [[Field Type: Decimal|decimal field]] that provides the total outstanding balance owed to this supplier.
 ;Overdue
-:A [[Field Type: Decimal|decimal value]] that provides the portion of ouststanding balance owed to this supplier that is overdue
+:A [[Field Type: Decimal|decimal field]] that provides the portion of ouststanding balance owed to this supplier that is overdue
@@ Line 139: / Line 168: @@
 == Related Endpoints ==
+:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
 :[[Xero Accounting Endpoint: BankTransactions|BankTransactions]]
 :[[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]]
@@ Line 144: / Line 174: @@
 :[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]
 :[[Xero Accounting Endpoint: Currencies|Currencies]]
+:[[Xero Accounting Endpoint: Invoices|Invoices]]
+:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
 :[[Xero Accounting Endpoint: Overpayments|Overpayments]]
 :[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]
 :[[Xero Accounting Endpoint: Prepayments|Prepayments]]
 :[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]
+:[[Xero Projects Endpoint: Projects|Projects]]
+:[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]]
+:[[Xero Accounting Endpoint: Quotes|Quotes]]
+:[[Xero Accounting Endpoint: RepeatingInvoices|RepeatingInvoices]]
 :[[Xero Accounting Endpoint: TaxRates|TaxRates]]
+== Related Topics ==
+:[[Xero Accounting Models]]
+:[[Xero Accounting Endpoints]]