MYOB Endpoint: CustomerPayments
Jump to navigation
Jump to search
Overview
The MYOB CustomerPayments endpoint allows you to get access to customer payments transaction recorded within MYOB.
Fields
The following fields are available for the CustomerPayments endpoint.
- UID
- A GUID field representing the internal id of this record. This field can be used to link to other endpoints.
- DepositTo
- A text field used to indicate the destination of the payment.
- Possible values are:
- Account: Indicates the money was paid from the nominated account.
- UndepositedFunds: Indicates the money was paid from the undeposited funds clearing account.
- Account
- A record field that provides the account to which payment was made.
- Customer
- A record field that provides the customer associated with this transaction.
- ReceiptNumber
- A text field that provides the transaction number.
- Date
- A date field that indicates the date of the transaction.
- AmountReceived
- A decimal field that provides the total amount received.
- AmountReceivedForeign
- A decimal field that provides the total amount received for foreign currency transactions (if applicable).
- PaymentMethod
- A text field that provides the payment method used to receive the money.
- Memo
- A text field that provides the memo for the transaction.
- Invoices
- A table field that provides the linked invoices of this transaction.
- See Invoices Fields for more information.
- TransactionUID
- A GUID field. It is currently unclear what this represents.
- ForeignCurrency
- A record field that provides the currency associated with this transaction.
- CurrencyExchangeRate
- A decimal field that provides the foreign currency exchange rate (if applicable).
- RowVersion
- A row version field.
Invoices Fields
The Lines field contains the following sub-fields.
- RowID
- A integer field representing the internal id of this line.
- Number
- A text field that provides the linked invoice number associated for this line.
- UID
- A GUID field that provides the linked invoice UID associated for this line.
- AmountApplied
- A decimal field that provides the total payment amount applied to this invoice and line.
- AmountReceivedForeign
- A decimal field that provides the total payment amount applied to this invoice and line for foreign currency transactions (if applicable).
- Type
- A text field that indicates if the line applies to an invoice or order.
- Possible values are:
- Invoice for sales invoices.
- Order for sales orders.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Fields
Related Endpoints
- JournalTransactions
- SalesAllInvoices
- SalesAllOrders
- SalesItemInvoices
- SalesItemOrders
- SalesMiscellaneousInvoices
- SalesMiscellaneousOrders
- SalesProfessionalInvoices
- SalesProfessionalOrders
- SalesServiceInvoices
- SalesServiceOrders
- SalesTimeBillingInvoices
- SalesTimeBillingOrders