MYOB Endpoint: SupplierPayments
Overview
The MYOB SupplierPayments endpoint allows you to get access to payments made on purchases within MYOB.
Fields
The following fields are available for the SupplierPayments endpoint.
- UID
- A GUID field representing the internal id of this record. This field can be used to link to other endpoints.
- PayFrom
- A text field used to indicate the source of the payment.
- Possible values are:
- Account: Indicates the money was paid from the nominated account.
- ElectronicPayments: Indicates the money was paid from the electronic payments clearing account.
- Account
- A record field that provides the account from which payment was made.
- Supplier
- A record field that provides the supplier associated with this transaction.
- PayeeAddress
- A text field that provides the complete address of the payee.
- StatementParticulars
- A text field that provides the statement particular if it is an electronic payments transaction.
- StatementCode
- A text field that provides the statement code if it is an electronic payments transaction.
- StatementReference
- A text field that provides the statement reference if it is an electronic payments transaction.
- PaymentNumber
- A text field that provides the transaction number.
- Date
- A date field that indicates the date of the transaction.
- AmountPaid
- A decimal field that provides the total amount paid.
- AmountPaidForeign
- A decimal field that provides the total amount paid in foreign currency (if applicable).
- Memo
- A text field that provides the memo for the transaction.
- Lines
- A table field that provides the lines of this transaction.
- See Lines Fields for more information.
- DeliveryStatus
- A text field that provides the delivery status of this transaction.
- Possible values are:
- PrintAndEmail
- Nothing
- ForeignCurrency
- A record field that provides the currency associated with this transaction.
- CurrencyExchangeRate
- A decimal field that provides the exchange rate for foreign currency transactions (if applicable).
- RowVersion
- A row version field.
Lines Fields
The Lines field contains the following sub-fields.
- RowID
- A integer field representing the internal id of this row.
- Type
- A text field that indicates the source transaction type for this line.
- Possible values are:
- Bill: for purchase invoices.
- Order: for purchase orders.
- Purchase
- A record field that provides the purchase invoice or purchase order linked to this line.
- AmountApplied
- A decimal field that provides the amount applied to the invoice or order for this line.
- AmountAppliedForeign
- A decimal field that provides the amount applied to the invoice or order for this line for foreign currency invoices (if applicable).
- RowVersion
- A row version field.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Fields
Related Endpoints
- JournalTransactions
- PurchasesAllInvoices
- PurchasesAllOrders
- PurchasesItemInvoices
- PurchasesItemOrders
- PurchasesMiscellaneousInvoices
- PurchasesMiscellaneousOrders
- PurchasesProfessionalInvoices
- PurchasesProfessionalOrders
- PurchasesServiceInvoices
- PurchasesServiceOrders