Difference between revisions of "MYOB Endpoint: Suppliers"
Jump to navigation
Jump to search
(Created page with "== Overview == The MYOB '''Suppliers''' endpoint allows you to access the list of employee cards. Note, these cards are also available via the (MYOB Endpoint:...") |
|||
| Line 64: | Line 64: | ||
;BuyingDetails | ;BuyingDetails | ||
:A [[Field Type: Record|record field]] that gives access to fields used on purchases. | :A [[Field Type: Record|record field]] that gives access to fields used on purchases. | ||
:See [[# | :See [[#BuyingDetails Fields|BuyingDetails Fields]] for more information. | ||
;PaymentDetails | ;PaymentDetails | ||
:A [[Field Type: Record|record field]] that gives access to fields used on payments. | :A [[Field Type: Record|record field]] that gives access to fields used on payments. | ||
:See [[#PaymentDetails|PaymentDetails Fields]] for more information. | :See [[#PaymentDetails Fields|PaymentDetails Fields]] for more information. | ||
;ForeignCurrency | ;ForeignCurrency | ||
| Line 91: | Line 91: | ||
The [[#Fields|PaymentDetails]] field contains the following sub-fields. | The [[#Fields|PaymentDetails]] field contains the following sub-fields. | ||
;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. | |||
;StatementText | |||
:A [[Field Type: Text|text field]] used to store the statement text included on direct credit ABA files. | |||
;StatementCode | |||
:A [[Field Type: Text|text field]] used to store the statement code included on direct credit ABA files. | |||
;StatementReference | |||
:A [[Field Type: Text|text field]] used to store the statement reference included on direct credit ABA files. | |||
;Refund | |||
:A [[Field Type: Record|record field]] that gives access to the refund details. | |||
:See [[#PaymentDetails.Refunds Fields|PaymentDetails .Refunds Fields]] for more information. | |||
Revision as of 21:04, 29 August 2021
Overview
The MYOB Suppliers endpoint allows you to access the list of employee 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.
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.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Fields