MYOB Endpoint: Suppliers
Jump to navigation
Jump to search
Overview
The MYOB Suppliers endpoint allows you to access the list of supplier cards. Note, these cards are also available via the Cards endpoint.
Fields
The following fields are available for the Suppliers 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).
- BuyingDetails
- A record field that gives access to fields used on purchases.
- See BuyingDetails 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.
BuyingDetails Fields
The BuyingDetails field contains the following sub-fields.
- 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.
- ExpenseAccount
- A record field that gives access to the account 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.
- Credit
- A record field that gives access to fields used to indicate credit details.
- See BuyingDetails.Credit Fields for more information.
- 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.
- TaxCode
- A record field that gives access to the tax code used for recording expenses.
- FreightTaxCode
- A record field that gives access to the freight tax code used for recording expenses.
- UseSupplierTaxCode
- A true/false field that indicates if the supplier is tax code is used.
- Terms
- A record field that gives access to fields used to the payment terms.
BuyingDetails.Credit Fields Fields
The BuyingDetails.Credit field contains the following sub-fields.
- Limit
- A decimal field that gives access to the credit limit given by the supplier.
- Available
- A decimal field that gives access to the credit amount available for this supplier.
- PastDue
- A decimal field that gives access to overdue credit amount for this supplier.
PaymentDetails Fields
The PaymentDetails field contains the following sub-fields.
- 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.
- StatementText
- A text field used to store the statement text included on direct credit ABA files.
- StatementCode
- A text field used to store the statement code included on direct credit ABA files.
- StatementReference
- A text field used to store the statement reference included on direct credit ABA files.
- Refund
- A record field that gives access to the refund details.
- See PaymentDetails.Refunds Fields for more information.
PaymentDetails.Refunds Fields
The PaymentDetails.Refunds field contains the following sub-fields.
- PaymentMethod
- A text field used to store the payment method type when recording refunds.
- 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.
- 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