View source for MYOB Endpoint: Customers

== Overview ==

The MYOB '''Customers''' [[MYOB Endpoints|endpoint]] allows you to access the list of customer cards. Note, these cards are also available via the [[MYOB Endpoint: Cards|Cards]] endpoint.

== Fields ==

The following fields are available for the Customers endpoint.

;UID
:A [[Field Type: GUID|GUID field]] representing the internal id of a card. This field can be used to link to other endpoints.
:Note that the UID will be the same as that on the [[MYOB Endpoint: Cards|Cards]] endpoint.

;CompanyName
:A [[Field Type: Text|text field]] used as the company name of the card.
:Note this only applies to cards set as companies and not individuals.

;LastName
:A [[Field Type: Text|text field]] used as the last name of the card.
:Note this only applies to cards set as individuals and not companies.

;FirstName
:A [[Field Type: Text|text field]] used as the first name of the card.
:Note this only applies to cards set as individuals and not companies.

;IsIndividual
:A [[Field Type: Boolean|true/false value]] that indicates if the card is an individual or a company.

;DisplayID
:A [[Field Type: Text|text field]] used as the Card ID.

;IsActive
:A [[Field Type: Boolean|true/false value]] that indicates if the card is active and can be used on new transactions.

;Addresses
:A [[Field Type: Table|table field]] that stores multiple [[MYOB Field: Addresses|addresses]] for this card.

;Notes
:A [[Field Type: Text|text field]] that stores notes for the card.

;Identifiers
:A [[Field Type: Table|table field]] that stores multiple [[MYOB Field: Identifiers|identifiers]] selected for this card.

;CustomList1
:A [[Field Type: Record|record field]] that stores the first [[MYOB Field: CustomList|custom list value]] selected for this card.

;CustomList2
:A [[Field Type: Record|record field]] that stores the second [[MYOB Field: CustomList|custom list value]] selected for this card.

;CustomList3
:A [[Field Type: Record|record field]] that stores the third [[MYOB Field: CustomList|custom list value]] selected for this card.

;CustomField1
:A [[Field Type: Record|record field]] that stores the first [[MYOB Field: CustomField|custom field value]] entered for this card.

;CustomField2
:A [[Field Type: Record|record field]] that stores the second [[MYOB Field: CustomField|custom field value]] entered for this card.

;CustomField3
:A [[Field Type: Record|record field]] that stores the third [[MYOB Field: CustomField|custom field value]] entered for this card.

;CurrentBalance
:A [[Field Type: Decimal|decimal field]] that gives access to the current outstanding balance of this card (amount owing or owed).

;SellingDetails
:A [[Field Type: Record|record field]] that gives access to fields used on sales.
:See [[#SellingDetails Fields|SellingDetails Fields]] for more information.

;PaymentDetails
:A [[Field Type: Record|record field]] that gives access to fields used on payments.
:See [[#PaymentDetails Fields|PaymentDetails Fields]] for more information.

;ForeignCurrency
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: Currencies|foreign currency sub-field]].

;LastModified
:A [[Field Type: DateTimeOffset|date time field]] that stores the last date and time this card was modified.

;PhotoURI
:A [[Field Type: Text|text field]] that stores a URL that can be used to access the photo associated with this card.

;RowVersion
:A [[Field Type: Row Version|row version field]].


== SellingDetails Fields ==

The [[#Fields|BuyingDetails]] field contains the following sub-fields.

;SaleLayout
:A [[Field Type: Text|text field]] stores the default layout used when recording purchases.
:Possible values are:
:*NoDefault
:*Item
:*Service
:*Professional
:*Miscellaneous
:*TimeBilling

;PrintedForm
:A [[Field Type: Text|text field]] stores the default templated used when printing sales.

;InvoiceDelivery
:A [[Field Type: Text|text field]] stores the default invoice delivery status.

;ItemPriceLevel
:A [[Field Type: Text|text field]] stores the default price level for this customer.
:Possible values are:
:*Base Selling Price
:*Level A
:*Level B
:*Level C
:*Level D
:*Level E
:*Level F

;IncomeAccount
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: Accounts|account]] used for recording expenses.

;ReceiptMemo
:A [[Field Type: Text|text field]] stores the default memo used for payments.

;SalesPerson
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: Cards|sales person employee]] for this customer.

;SaleComment
:A [[Field Type: Text|text field]] stores the default comment used for sales.

;ShippingMethod
:A [[Field Type: Text|text field]] stores the default shipping method used for sales.

;HourlyBillingRate
:A [[Field Type: Decimal|decimal field]] that gives access to the tax exclusive billing rate of the customer.

;ABN
:A [[Field Type: Text|text field]] stores the ABN of the customer.
:Only applicable to '''Australia'''.

;ABN
:A [[Field Type: Text|text field]] stores the ABN branch number of the customer.
:Only applicable to '''Australia'''.

;TaxCode
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: TaxCodes|tax code]] used for recording sales.

;FreightTaxCode
:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: TaxCodes|freight tax code]] used for recording sales.

;UseCustomersTaxCode
:A [[Field Type: Boolean|true/false field]] that indicates if the customer tax code is used.

;Terms
:A [[Field Type: Record|record field]] that gives access to fields used to the [[MYOB Field: Terms|payment terms]].

;Credit
:A [[Field Type: Record|record field]] that gives access to fields used to indicate credit details.
:See [[#SellingDetails.Credit Fields|SellingDetails.Credit Fields]] for more information.

;TaxIdNumber
:A [[Field Type: Text|text field]] stores the tax id number of the customer.

;Memo
:A [[Field Type: Text|text field]] stores the default memo for this customer.


== SellingDetails.Credit Fields ==

The [[#SellingDetails Fields|SellingDetails.Credit]] field contains the following sub-fields.

;Limit
:A [[Field Type: Decimal|decimal field]] that gives access to the credit limit given by the customer.

;Available
:A [[Field Type: Decimal|decimal field]] that gives access to the credit amount available for this customer.

;PastDue
:A [[Field Type: Decimal|decimal field]] that gives access to overdue credit amount for this customer.

;OnHold
:A [[Field Type: Boolean|true/false field]] that indicates if credit has been put on hold for this customer.

== PaymentDetails Fields ==

The [[#Fields|PaymentDetails]] field contains the following sub-fields.

;Method
:A [[Field Type: Text|text field]] used to store the payment method type for the customer.

;CardNumber
:A [[Field Type: Text|text field]] used to store the credit card number.
:Note only the last 4 digits can be retrieved.

;NameOnCard
:A [[Field Type: Text|text field]] used to store the name on the credit card.

;BSBNumber
:A [[Field Type: Text|text field]] used to store the BSB number.

;BankAccountNumber
:A [[Field Type: Text|text field]] used to store the bank account number.

;BankAccountName
:A [[Field Type: Text|text field]] used to store the bank account name.

;Notes
:A [[Field Type: Text|text field]] used to store the notes for the payment method.


== MYOB API ==

For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/contact/customer/ MYOB API].


== Related Fields ==

:[[MYOB Field: Accounts|Accounts]] 
:[[MYOB Field: Addresses|Addresses]] 
:[[MYOB Field: Cards|Cards]] 
:[[MYOB Field: Currencies|Currencies]] 
:[[MYOB Field: CustomList|CustomList]] 
:[[MYOB Field: CustomField|CustomField]] 
:[[MYOB Field: Identifiers|Identifiers]] 
:[[MYOB Field: TaxCodes|TaxCodes]] 


== Related Endpoints==

:[[MYOB Endpoint: Cards|Cards]]


== Related Topics ==

:[[MYOB Models]]
:[[MYOB Endpoints]]