Xero Accounting Endpoint: ContactsExpanded: Difference between revisions
No edit summary |
No edit summary |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The Xero '''Contacts''' [[Endpoints|endpoint]] allows you to access the complete list of contacts (both customers and suppliers) present within Xero. | The Xero '''Contacts''' [[Xero Accounting Endpoints|endpoint]] allows you to access the complete list of contacts (both customers and suppliers) present within Xero. | ||
This endpoints provides access to all fields and details. It is also optimised for larger data files. | This endpoints provides access to all fields and details. It is also optimised for larger data files. | ||
In most situations, it is recommended to use this endpoint instead of the [[Xero Accounting Endpoint: Contacts|Contacts]] endpoint. | In most situations, it is recommended to use this endpoint instead of the [[Xero Accounting Endpoint: Contacts|Contacts]] endpoint. | ||
Note an alternate endpoint named [[Xero Accounting Endpoint: ContactsExpandedTable|ContactsExpandedTable]] is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory. | |||
| Line 11: | Line 13: | ||
The following fields are available for the Accounts endpoint. | The following fields are available for the Accounts endpoint. | ||
;DataFile | |||
:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record. | |||
;ContactID | ;ContactID | ||
| Line 44: | Line 49: | ||
;SkypeUserName | ;SkypeUserName | ||
:A [[Field Type: Text|text field]] that provides the skype user name of the contact. | :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 | ;BankAccountDetails | ||
:A [[Field Type: Text|text field]] that provides the bank account number of the contact. | :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 | ;TaxNumber | ||
:A [[Field Type: Text|text field]] that provides the tax number of the contact. | :A [[Field Type: Text|text field]] that provides the tax number of the contact. | ||
:This could | :This could either be: | ||
:* '''ABN''' (for Australia) | :* '''ABN''' (for Australia) | ||
:* '''GST Number''' (for New Zealand) | :* '''GST Number''' (for New Zealand) | ||
:* '''VAT Number''' (for UK) | :* '''VAT Number''' (for UK) | ||
:* '''Tax ID | :* '''Tax ID Number''' (for all other regions) | ||
;AccountsReceivableTaxType | ;AccountsReceivableTaxType | ||
| Line 76: | Line 92: | ||
;IsCustomer | ;IsCustomer | ||
:A [[Field Type: Boolean|true/false value]] that indicates if this contact can be used on sales. | :A [[Field Type: Boolean|true/false value]] that indicates if this contact can be used on sales. | ||
;DefaultCurrency | ;DefaultCurrency | ||
| Line 85: | Line 98: | ||
;Discount | ;Discount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the default discount rate provided to this contact. | ||
;BrandingTheme | ;BrandingTheme | ||
| Line 203: | Line 216: | ||
;Outstanding | ;Outstanding | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the total outstanding balance this customer owes. | ||
;Overdue | ;Overdue | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the portion of ouststanding balance this customer owes that is overdue. | ||
| Line 214: | Line 227: | ||
;Outstanding | ;Outstanding | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the total outstanding balance owed to this supplier. | ||
;Overdue | ;Overdue | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the portion of ouststanding balance owed to this supplier that is overdue | ||
| Line 254: | Line 267: | ||
== Related Endpoints == | == Related Endpoints == | ||
:[[Xero Accounting Endpoint: Contacts|Contacts]] | |||
:[[Xero Accounting Endpoint: Accounts|Accounts]] | :[[Xero Accounting Endpoint: Accounts|Accounts]] | ||
:[[Xero Accounting Endpoint: BankTransactions|BankTransactions]] | :[[Xero Accounting Endpoint: BankTransactions|BankTransactions]] | ||
| Line 266: | Line 280: | ||
:[[Xero Accounting Endpoint: Prepayments|Prepayments]] | :[[Xero Accounting Endpoint: Prepayments|Prepayments]] | ||
:[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]] | :[[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]] | :[[Xero Accounting Endpoint: TaxRates|TaxRates]] | ||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||