MYOB Endpoint: SuppliersTable
Overview
The MYOB SuppliersTable endpoint allows you to access the list of supplier cards. Note, these cards are also available via the Cards endpoint.
Note this endpoint is an alternate format of the Suppliers endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.
Fields
The following fields are available for the SuppliersTable endpoint.
- DataFileID
- A guid field that provides the id of the data file as setup in OdataLink.
- DataFileName
- A text field that provides the name of the data file as setup in OdataLink.
- DataFileCode
- A text field that provides the code of the data file as setup in OdataLink.
- 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.
- Address1Street
- A text field stores the street address.
- Address1City
- A text field stores the city.
- Address1State
- A text field stores the state or province.
- Address1PostCode
- A text field stores the post code or zip code.
- Address1Country
- A text field stores the country.
- Address1Phone1
- A text field stores the first phone number.
- Address1Phone2
- A text field stores the second phone number.
- Address1Phone3
- A text field stores the third phone number.
- Address1Fax
- A text field stores the fax number.
- Address1Email
- A text field stores the email.
- Address1Website
- A text field stores the website.
- Address1ContactName
- A text field stores the contact name.
- Address1Saluation
- A text field stores the saluation (e.g. Mr, Mrs, etc.)
- Address2Street
- A text field stores the street address.
- Address2City
- A text field stores the city.
- Address2State
- A text field stores the state or province.
- Address2PostCode
- A text field stores the post code or zip code.
- Address2Country
- A text field stores the country.
- Address2Phone1
- A text field stores the first phone number.
- Address2Phone2
- A text field stores the second phone number.
- Address2Phone3
- A text field stores the third phone number.
- Address2Fax
- A text field stores the fax number.
- Address2Email
- A text field stores the email.
- Address2Website
- A text field stores the website.
- Address2ContactName
- A text field stores the contact name.
- Address2Saluation
- A text field stores the saluation (e.g. Mr, Mrs, etc.)
- Address3Street
- A text field stores the street address.
- Address3City
- A text field stores the city.
- Address3State
- A text field stores the state or province.
- Address3PostCode
- A text field stores the post code or zip code.
- Address3Country
- A text field stores the country.
- Address3Phone1
- A text field stores the first phone number.
- Address3Phone2
- A text field stores the second phone number.
- Address3Phone3
- A text field stores the third phone number.
- Address3Fax
- A text field stores the fax number.
- Address3Email
- A text field stores the email.
- Address3Website
- A text field stores the website.
- Address3ContactName
- A text field stores the contact name.
- Address3Saluation
- A text field stores the saluation (e.g. Mr, Mrs, etc.)
- Address4Street
- A text field stores the street address.
- Address4City
- A text field stores the city.
- Address4State
- A text field stores the state or province.
- Address4PostCode
- A text field stores the post code or zip code.
- Address4Country
- A text field stores the country.
- Address4Phone1
- A text field stores the first phone number.
- Address4Phone2
- A text field stores the second phone number.
- Address4Phone3
- A text field stores the third phone number.
- Address4Fax
- A text field stores the fax number.
- Address4Email
- A text field stores the email.
- Address4Website
- A text field stores the website.
- Address4ContactName
- A text field stores the contact name.
- Address4Saluation
- A text field stores the saluation (e.g. Mr, Mrs, etc.)
- Address5Street
- A text field stores the street address.
- Address5City
- A text field stores the city.
- Address5State
- A text field stores the state or province.
- Address5PostCode
- A text field stores the post code or zip code.
- Address5Country
- A text field stores the country.
- Address5Phone1
- A text field stores the first phone number.
- Address5Phone2
- A text field stores the second phone number.
- Address5Phone3
- A text field stores the third phone number.
- Address5Fax
- A text field stores the fax number.
- Address5Email
- A text field stores the email.
- Address5Website
- A text field stores the website.
- Address5ContactName
- A text field stores the contact name.
- Address5Saluation
- A text field stores the saluation (e.g. Mr, Mrs, etc.)
- Notes
- A text field that stores notes for the card.
- CustomList1
- A text field that stores the first custom list value selected for this card.
- CustomList2
- A text field that stores the second custom list value selected for this card.
- CustomList3
- A text field that stores the third custom list value selected for this card.
- CustomField1
- A text field that stores the first custom field value entered for this card.
- CustomField2
- A text field that stores the second custom field value entered for this card.
- CustomField3
- A text 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).
- PurchaseLayout
- A text field stores the default layout (Item, Service, Miscellaneous or Professional) used when recording purchases.
- PrintedForm
- A text field stores the default templated used when printing the purchase.
- PuchaseOrderDelivery
- A text field stores the default purchase order delivery status.
- ExpenseAccountUID
- A GUID field that provides the internal id of the account used for recording expenses.. This field can be used to link to other endpoints.
- ExpenseAccountNumber
- A text field that provides the account number used for recording expenses.
- ExpenseAccountName
- A text field that provides the account name used for recording expenses.
- PaymentMemo
- A text field stores the default memo used for payments.
- PurchaseComment
- A text field stores the default comment used for purchases.
- SupplierBillingRate
- A decimal field that gives access to the tax exclusive billing rate of the supplier.
- ShippingMethod
- A text field stores the default shipping method used for purchases.
- IsReportable
- A true/false field that indicates if the supplier is setup for reportable taxable payments.
- Only applicable to Australia.
- CostPerHour
- A decimal field that gives access to the cost per hour of the supplier.
- CreditLimit
- A decimal field that gives access to the credit limit given by the supplier.
- CreditAvailable
- A decimal field that gives access to the credit amount available for this supplier.
- CreditPastDue
- A decimal field that gives access to overdue credit amount for this supplier.
- ABN
- A text field stores the ABN of the supplier.
- Only applicable to Australia.
- ABN
- A text field stores the ABN branch number of the supplier.
- Only applicable to Australia.
- TaxIdNumber
- A text field stores the tax id number of the supplier.
- TaxCodeUID
- A guid field that provides the id of the tax code for recording expenses.
- TaxCode
- A text field that provides the tax code for recording expenses (e.g. GST or FRE).
- FreightTaxCodeUID
- A guid field that provides the id of the tax code for recording freight.
- FreightTaxCode
- A text field that provides the tax code for recording freight(e.g. GST or FRE).
- UseSupplierTaxCode
- A true/false field that indicates if the supplier is tax code is used.
- TermsPaymentIsDue
- A text field that represents the due date.
- Possible values are:
- CashOnDelivery
- PrePaid
- InAGivenNumberOfDays
- OnADayOfTheMonth
- NumberOfDaysAfterEOM
- DayOfMonthAfterEOM
- TermsDiscountDate
- A integer field used to represent either a specific day or a specific number of days in order to receive a discount.
- TermsBalanceDueDate
- A integer field used to represent either a specific day or a specific number of days in order to pay on time.
- TermsDiscountForEarlyPayment
- A decimal field used to represent the percentage discount for early payment.
- TermsVolumeDiscount
- A decimal field used to represent the percentage discount for large purchases.
- PaymentDetailsBSBNumber
- A text field used to store the BSB number.
- PaymentDetailsBankAccountNumber
- A text field used to store the bank account number.
- PaymentDetailsBankAccountName
- A text field used to store the bank account name.
- PaymentDetailsStatementText
- A text field used to store the statement text included on direct credit ABA files.
- PaymentDetailsStatementCode
- A text field used to store the statement code included on direct credit ABA files.
- PaymentDetailsStatementReference
- A text field used to store the statement reference included on direct credit ABA files.
- RefundDetailsPaymentMethod
- A text field used to store the payment method type when recording refunds.
- RefundDetailsCardNumber
- A text field used to store the credit card number.
- Note only the last 4 digits can be retrieved.
- RefundDetailsNameOnCard
- A text field used to store the name on the credit card.
- RefundDetailsNotes
- A text field used to store the notes for the payment method.
- ForeignCurrencyUID
- A GUID field that provides the internal id of the currency linked to this transaction. This field can be used to link to other endpoints.
- ForeignCurrencyCode
- A text field that provides the currency ISO code.
- ForeignCurrencyName
- A text field that provides the currency name.
- 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.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Endpoints