TDV Adapter for MYOB

Build 22.0.8462


Return, create and delete customer payments for an AccountRight company file.

Table Specific Information


MYOB allows a subset of columns to be used in the WHERE clause of a SELECT query. These columns may be used with the following operators: =, !=, >, <, >=, <=. In addition, queries with multiple criterias can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Date, DepositTo, AmountReceived, Memo, PaymentMethod, ReceiptNumber, AccountID, AccountDisplayID, AccountName, CustomerID, CustomerDisplayID, CustomerName. All the other columns and operators are processed client side.

SELECT * FROM CustomerPayments WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM CustomerPayments WHERE CustomerID = "0229a075-f93a-4b6c-85d7-0ffd5ba43982"
SELECT * FROM CustomerPayments WHERE AmountReceived = 1399.99


The following attributes are required when performing an insert: DepositTo, AccountID, CustomerID, Invoices.

To insert the Invoices values into CustomerPayments, we can either pass the JSON data as a string or use a temporary table like below.

INSERT INTO CustomerPaymentInvoices#TEMP(AmountApplied, ID, Type) VALUES (444.21, " 0229a075-f93a-4b6c-85d7-0ffd5ba43982", "Order")
INSERT INTO CustomerPayments(DepositTo, AccountID, CustomerID, Invoices) VALUES("Account", "ee9824a1-26d7-4501-8c19-83bc1fd84167", "ee9824a1-26d7-4501-8c19-83bc1fd84167", "CustomerPaymentInvoices#TEMP")


Name Type ReadOnly Description
ID [KEY] Uuid True

Unique identifier in the form of a guid.

Date Datetime False

The date of the entry.

DepositTo String False

If allocating a banking account for the payment specify Account. If using undeposited funds specify UndepositedFunds.

AmountReceived Double False

The amount received.

Memo String False

Memo text for the object.

PaymentMethod String False

One of: American Express, Bank Card, Barter Card, Cash, Cheque, Diners Club, EFTPOS, MasterCard, Money Order, Other, Visa.

ReceiptNumber String False

ID No of payment transaction.

RowVersion String True

Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.

URI String True

Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.

AccountID Uuid False

Unique identifier for the account in the form of a guid.

AccountDisplayID String True

Account code. Format includes separator ie 4-1100

AccountName String True

Name of the account.

AccountURI String True

Uniform resource identifier associated with the account object.

CustomerID Uuid False

Unique guid identifier belonging to the assigned customer contact.

CustomerDisplayID String True

Customer contact Card ID, can also be used as a unique customer contact identifier.

CustomerName String True

Name of the customer contact.

CustomerURI String True

Uniform resource identifier associated with the customer contact object.

Invoices String False

An array of line invoice information.

CompanyFileId String True

The ID of the company file. Takes precedence over the CompanyFileId connection property.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462