Difference between revisions of "MYOB Endpoint: Customers"

Revision as of 22:57, 29 August 2021

Overview

The MYOB Customers endpoint allows you to access the list of customer cards. Note, these cards are also available via the (Cards endpoint.

Fields

The following fields are available for the Customers endpoint.

UID: A 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 Cards endpoint.

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

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

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

IsIndividual: A true/false value that indicates if the card is an individual or a company.

DisplayID: A text field used as the Card ID.

IsActive: A true/false value that indicates if the card is active and can be used on new transactions.

Addresses: A table field that stores multiple addresses for this card.

Notes: A text field that stores notes for the card.

Identifiers: A table field that stores multiple identifiers selected for this card.

CustomList1: A record field that stores the first custom list value selected for this card.

CustomList2: A record field that stores the second custom list value selected for this card.

CustomList3: A record field that stores the third custom list value selected for this card.

CustomField1: A record field that stores the first custom field value entered for this card.

CustomField2: A record field that stores the second custom field value entered for this card.

CustomField3: A record field that stores the third custom field value entered for this card.

CurrentBalance: A decimal field that gives access to the current outstanding balance of this card (amount owing or owed).

SellingDetails: A record field that gives access to fields used on sales.; See SellingDetails Fields for more information.

PaymentDetails: A record field that gives access to fields used on payments.; See PaymentDetails Fields for more information.

ForeignCurrency: A record field that gives access to the foreign currency sub-field.

LastModified: A date time field that stores the last date and time this card was modified.

PhotoURI: A text field that stores a URL that can be used to access the photo associated with this card.

RowVersion: A row version field.

SellingDetails Fields

The BuyingDetails field contains the following sub-fields.

SaleLayout

A text field stores the default layout used when recording purchases.

Possible values are:

NoDefault
Item
Service
Professional
Miscellaneous
TimeBilling

PrintedForm: A text field stores the default templated used when printing sales.

InvoiceDelivery: A text field stores the default invoice delivery status.

ItemPriceLevel

A 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 record field that gives access to the account used for recording expenses.

ReceiptMemo: A text field stores the default memo used for payments.

SalesPerson: A record field that gives access to the sales person employee for this customer.

SaleComment: A text field stores the default comment used for sales.

ShippingMethod: A text field stores the default shipping method used for sales.

HourlyBillingRate: A decimal field that gives access to the tax exclusive billing rate of the customer.

ABN: A text field stores the ABN of the customer.; Only applicable to Australia.

ABN: A text field stores the ABN branch number of the customer.; Only applicable to Australia.

TaxCode: A record field that gives access to the tax code used for recording sales.

FreightTaxCode: A record field that gives access to the freight tax code used for recording sales.

UseCustomersTaxCode: A true/false field that indicates if the customer tax code is used.

Terms: A record field that gives access to fields used to the payment terms.

Credit: A record field that gives access to fields used to indicate credit details.; See SellingDetails.Credit Fields for more information.

TaxIdNumber: A text field stores the tax id number of the customer.

Memo: A text field stores the default memo for this customer.

SellingDetails.Credit Fields Fields

The SellingDetails.Credit field contains the following sub-fields.

Limit: A decimal field that gives access to the credit limit given by the customer.

Available: A decimal field that gives access to the credit amount available for this customer.

PastDue: A decimal field that gives access to overdue credit amount for this customer.

OnHold: A true/false field that indicates if credit has been put on hold for this customer.

PaymentDetails Fields

The PaymentDetails field contains the following sub-fields.

Method: A text field used to store the payment method type for the customer.

CardNumber: A text field used to store the credit card number.; Note only the last 4 digits can be retrieved.

NameOnCard: A text field used to store the name on the credit card.

BSBNumber: A text field used to store the BSB number.

BankAccountNumber: A text field used to store the bank account number.

BankAccountName: A text field used to store the bank account name.

Notes: A 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 MYOB API.

Related Fields

Related Endpoints