JDBC Driver for MYOB

Build 22.0.8462

SpendingTransactions

Return, update, create and delete spend money transactions for an AccountRight company file.

Table Specific Information

Select

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, AmountPaid, ChequePrinted, Date, DeliveryStatus, IsTaxInclusive, Memo, PayFrom, PayeeAddress, PaymentNumber, StatementParticulars, TotalTax, AccountID, AccountDisplayID, AccountName, CategoryID, CategoryDisplayID, CategoryName, ContactID, ContactDisplayID, ContactName, ContactType. All the other columns and operators are processed client side. 

SELECT * FROM SpendingTransactions WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM SpendingTransactions WHERE AmountPaid = 120.45
SELECT * FROM SpendingTransactions WHERE AccountID = "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f"

Update

To update an existing transaction, along with its Lines, we can either pass a JSON string to the Lines value or use a temporary table like below. Note: this will replace all the current Lines with the ones below. 

INSERT INTO SpendingTransactionItems#TEMP(Amount, AccountID, TaxCodeID, RowID, RowVersion) VALUES (22.3, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b", 656, "8733325201913151488")
UPDATE ReceivingTransactions SET PaymentMethod = "Cash", Lines = "SpendingTransactionItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Insert

The following attributes are required when performing an insert: Date, PayFrom, AccountID, ContactID. 

INSERT INTO SpendingTransactions(Date, PayFrom, AccountId, ContactId) VALUES ("01/01/2019", "Account", "c195ee7d-2954-42a6-8a19-6f362442bf89", "4635fd9e-82a7-4612-ae15-32c464ef7c48")

Columns

Name Type ReadOnly Description
ID [KEY] Uuid True

Unique identifier in the form of a guid.

AmountPaid Double True

Total of all amounts paid.

ChequePrinted Boolean False

True indicates you don't need to print a cheque for this spend money. False indicates you can print a cheque for spend money .

Date Datetime False

The date of the entry.

DeliveryStatus String False

Delivery status assigned to payment: ToBePrinted, ToBeEmailed, ToBePrintedAndEmailed, AlreadyPrintedOrSent.

IsTaxInclusive Boolean False

True indicates the transaction is set to tax inclusive with the Amount inclusive of tax. False indicates the transaction is not tax inclusive with the Amount value tax exclusive.

Memo String False

Memo text for the object.

PayFrom String False

If allocating a banking account for the payment specify Account. If using electronic payments specify ElectronicPayments.

PayeeAddress String False

Name and address of Payee, if a contact is supplied on POST and PayeeAddress is left blank, Address 1 of the contact will default. If neither Contact or PayAddress are assigned on POST then will default to null.

PaymentNumber String False

ID No of payment transaction, if left blank on POST will auto increment based upon last recorded #.

StatementParticulars String False

ONLY applicable for Electronic Payments. Particulars attached to electronic payment.

TotalTax Double True

Total of all tax amounts applicable to the spend money.

URI String True

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

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.

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.

CategoryID Uuid False

Unique category identifier in the form of a guid.

CategoryDisplayID String True

Display id for the category.

CategoryName String True

Name of the category.

CategoryURI String True

Uniform resource identifier associated with the category object.

ContactID Uuid False

Unique identifier in the form of a guid.

ContactDisplayID String True

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

ContactName String True

Name of the contact record.

ContactType String True

Card type of the contact record, can be either Customer, Supplier, Employee or Personal.

ContactURI String True

Uniform resource identifier associated with the contact object.

Lines String False

An array of spend money line 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