接続の確立

MYOB への接続を追加

MYOB への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
MYOB アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからMYOB コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

MYOB への接続

MYOB 会社ファイルに接続するには、CompanyFileId をデータを取得したい会社ファイルのID に設定します。指定しない場合は、最初に返された会社ファイルのID（アルファベット順にソート）が使用されます。

この接続プロパティは、CompanyFiles ビューを除くすべてのテーブルおよびビューにアクセスするために必要です。このビューは、アカウントに紐づく会社ファイル（およびその関連ID）を表示するために使用できます。会社ファイルのID がわからない場合は、このビューを使用してください。

次のプロパティを追加設定します。



オンプレミスインスタンス	Instance：OnPremise に設定。
	AuthScheme：Basic に設定。
	User：会社のファイルに紐づいているユーザー名。会社ファイルを作成すると、Administrator というユーザーアカウントが自動的に作成されます。デフォルトでは、Administrator ユーザーアカウントにはパスワードが割り当てられません。
	InitiateOAuth：OFF。
	Url：MYOB インスタンスのURL。
クラウドインスタンス	Instance：Cloud に設定。
	AuthScheme：OAuth に設定。
	InitiateOAuth：GETANDREFRESH。
	User：会社のファイルに紐づいているユーザー名。
	Password：（パスワードが設定されている場合）会社ファイルの認可されたユーザーのパスワードに設定。

OAuth の詳細は以下を参照してください。

MYOB への認証

MYOB はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのMYOB への認証について詳しく説明します。

デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth アプリケーションの作成についての情報と、埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成を参照してください。

MYOB で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

アクセストークンの期限が切れたときは、Sync App は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ：

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

はじめてデータに接続する際、次の接続プロパティを設定します。
- InitiateOAuth：REFRESH。
- OAuthClientId：アプリケーション設定のクライアントId。
- OAuthClientSecret：アプリケーション設定のクライアントシークレット。
- OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation：Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
その後のデータ接続では、以下を設定します。
- InitiateOAuth
- OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
次の接続プロパティを設定します。
- OAuthClientId：アプリケーション設定のクライアントId。
- OAuthClientSecret：アプリケーション設定のクライアントシークレット。
RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

高度な機能

このセクションでは、MYOB Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、MYOB にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、MYOB API へのSQL の実行について詳しく説明します。

CompanyFileId 接続プロパティは、CompanyFiles ビューを除くすべてのテーブルおよびビューにアクセスするために必要です。 CompanyFiles ビューは、アカウントに紐づく会社ファイル（およびその関連ID）を表示するために使用できます。会社ファイルのID がわからない場合は、このビューを使用してください。

主要機能

Sync App は、Accounts、PurchaseOrders、およびSalesOrders などのMYOB エンティティをリレーショナルテーブルやビューとしてモデル化し、SQL を記述してMYOB データをクエリできるようにします。
ストアドプロシージャを使用すると、アクセストークンの取得やOAuth 2.0でのリフレッシュの維持など、MYOB の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとMYOB アカウントへのあらゆる変更が即座に反映されます。

テーブル

テーブルでは、利用可能なテーブルを説明します。テーブルは、Customers、PurchaseOrders、SalesOrders などを静的にモデル化するように定義されています。

ビュー

AccountRegister、Currencies などMYOB データへの読み取り専用アクセスには、ビューを使用できます。

ストアドプロシージャ

ストアドプロシージャは、MYOB のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやアップロードなど、MYOB の操作を実行できます。

テーブル

Sync App はMYOB のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

MYOB Connector for CData Sync テーブル


Name	Description
AccountBudgets	Return and update general ledger account budgets.
Accounts	Return, update, create and delete accounts for an AccountRight company file.
Activities	Return, update, create and delete a list of time billing activities for an AccountRight company file.
ActivitySlips	Return, update, create and delete a list of time billing activity slips for an AccountRight company file.
Build	Return's Build transaction journals
ContactCustomers	Return, update, create and delete a customer contact for an AccountRight company file.
ContactEmployees	Return, update, create and delete an employee contact for an AccountRight company file.
ContactPersonals	Return, update, create and delete a personal contact for an AccountRight company file.
Contacts	Return all contact types for an AccountRight company file. This table has been deprecated, and new tables - ContactSupplier, ContactCustomer, ContactPersonal, and ContactEmployee have been introduced as replacements for it.
ContactSuppliers	Return, update, create and delete a supplier contact for an AccountRight company file.
CreditRefunds	Return, create and delete credit notes refunded to customers for an AccountRight company file.
CreditSettlements	Return, create and delete settled customer credits for an AccountRight company file.
CustomerPayments	Return, create and delete customer payments for an AccountRight company file.
DebitRefunds	Return all purchase bill types for an AccountRight company file.
DebitSettlements	Return, create and delete debit settlements for an AccountRight company file.
EmployeePaymentDetails	Return and update employee payment details on employee contact cards for an AccountRight company file.
EmployeePayrollDetails	Return and update employee payroll details on employee contact cards for an AccountRight company file.
EmployeeStandardPay	Return and update employee standard pay details on employee contact cards for an AccountRight company file.
InventoryAdjustments	Return, update, create and delete inventory adjustments for an AccountRight company file.
ItemPriceMatrices	Return and update the item price matrix for multiple customer selling prices.
Items	Return, update, create and delete inventory items for an AccountRight company file.
JobBudgets	Return and update job budgets.
Jobs	Return, update, create and delete a job for an AccountRight company file.
Journals	Return, update, create and delete general journal transactions for an AccountRight company file.
PayrollWages	Return, update, create and delete payroll categories of type wage for an AccountRight company file.
PurchaseBills	Return all purchase bill types for an AccountRight company file.
PurchaseOrders	Return all purchase order types for an AccountRight company file.
ReceivingTransactions	Return, update, create and delete receive money transactions for an AccountRight company file.
SaleInvoices	Return all sale invoice types for an AccountRight company file.
SaleOrders	Returns all sale order types for an AccountRight company file.
SaleQuotes	Return all sale quote types for an AccountRight company file.
SpendingTransactions	Return, update, create and delete spend money transactions for an AccountRight company file.
SupplierPayments	Return, create and delete supplier payments for an AccountRight company file.
TaxCodes	Tax codes for an AccountRight company file.
TimesheetLineEntries	Return timesheet entries for an AccountRight company file
TimesheetLineItems	Return timesheet entries for an AccountRight company file
Timesheets	Return timesheet entries for an AccountRight company file
TransferringTransactions	Return, update, create and delete transfer money transactions for an AccountRight company file.

AccountBudgets

Return and update general ledger account budgets.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: FinancialYear, LastMonthInFinancialYear. All the other columns and operators are processed client side.

SELECT * FROM AccountBudgets WHERE FinancialYear = 13
SELECT * FROM AccountBudgets WHERE LastMonthInFinancialYear = 41

Columns


Name	Type	ReadOnly	References	Description
FinancialYear	Integer	False		Financial year can consist of current FY or next FY only.
LastMonthInFinancialYear	Integer	True		Number representing the last month of the financial year. For example, 3 indicates March.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
Budgets	String	False		An array of account budget information.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Accounts

Return, update, create and delete accounts 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Classification, CurrentBalance, Description, DisplayID, IsActive, IsHeader, Level, Name, Number, OpeningBalance, Type, LastReconciledDate, BankingBSBNumber, BankingAccountName, BankingAccountNumber, BankingCode, BankingCompanyTradingName, BankingCreateBankFiles, BankingDirectEntryUserId, BankingIncludeSelfBalancingTransaction, BankingStatementParticulars, ForeignCurrencyID, ForeignCurrencyCode, ForeignCurrencyCurrencyName, ParentAccountID, ParentAccountDisplayID, ParentAccountName, TaxCodeID, TaxCodeCode. All the other columns and operators are processed client side.

SELECT * FROM Accounts WHERE ID = REPLACE
SELECT * FROM Accounts WHERE Classification = "criteria"
SELECT * FROM Accounts WHERE CurrentBalance = 40.72729281968018

Insert

The following attributes are required when performing an insert: Number, Type, TaxCodeID.

INSERT INTO Accounts (Number, Type, TaxCodeID) VALUES (101, "bank", "2619bed9-3750-45b5-b353-18f5651beb01")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	False		Unique identifier in the form of a guid.
Classification	String	False		The account classification can be one of the following: (1) Asset, (2) Liability, (3) Equity, (4) Income, (5) CostOfSales, (6) Expense, (8) OtherIncome, (9) OtherExpense.
CurrentBalance	Decimal	True		Current balance of the account. Note that this balance will include all future-dated activity.
Description	String	False		A description of the account.
DisplayID	String	False		Account code format includes separator ie 1-1100
IsActive	Boolean	False		True indicates the account is active. False indicates the account is inactive. A user marks an account as inactive when they no longer need to record transactions to it
IsHeader	Boolean	False		True indicates the account is a header account.Header accounts are used to organise, group and subtotal accounts in the Accounts List and reports. False indicates the account is a detail account. Only detail accounts can be assigned to transactions.
Level	Integer	False		The hierarchial level of the account in the Accounts List. Possible values are 1, 2, 3, 4. The highest level accounts are level 1, the lowest 4. You can only assign levels 2 to 4 to a new account.
Name	String	False		Name of the account.
Number	Integer	False		Account number for example 1150. Must be a unique four-digit number that does not include the account type classification number and account separator.
OpeningBalance	Decimal	False		Balance of the account as at the conversion date set for the company file.
Type	String	False		Depending on the classification of the account (e.g. asset), you can define the account's type, see here for more information on account types.
LastReconciledDate	Datetime	True		Shows the date that the Account was last reconciled. This will return as null if the Account has never been reconciled.
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.
BankingBSBNumber	String	False		BSB as provided by the financial institution.
BankingAccountName	String	False		Bank account name setup.
BankingAccountNumber	String	False		Account number as provided by the financial institution.
BankingCode	String	False		Bank code as provided by the financial institution.
BankingCompanyTradingName	String	False		Company trading name if applicable for bank account.
BankingCreateBankFiles	Boolean	False		True indicates the bank account will be used to create bank files (ABA). False indicates the bank account will not be used to create bank files.
BankingDirectEntryUserId	String	False		Direct entry user id as provided by the financial institution.
BankingIncludeSelfBalancingTransaction	Boolean	False		True indicates the bank account requires a self balancing transaction. False indicates the bank account does not require a self balancing transaction.
BankingStatementParticulars	String	False		Statement particulars assigned to the bank account.
ForeignCurrencyID	Uuid	True	Currencies.ID	Unique identifier in the form of a guid.
ForeignCurrencyCode	String	True		The currency code.
ForeignCurrencyCurrencyName	String	True		The full name of the currency.
ForeignCurrencyURI	String	True		Uniform resource identifier associated with the purchase.
ParentAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
ParentAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
ParentAccountName	String	True		Name of the account.
ParentAccountURI	String	True		Uniform resource identifier associated with the account object.
TaxCodeID	Uuid	False	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String	True		3 digit tax code.
TaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Activities

Return, update, create and delete a list of time billing activities 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Description, DisplayID, IsActive, Name, Status, Type, UnitOfMeasurement, IncomeAccountID, IncomeAccountDisplayID, IncomeAccountName, ChargeableRate, UseDescriptionOnSales, TaxCodeID, TaxCodeCode. All the other columns and operators are processed client side.

SELECT * FROM Activities WHERE ID = REPLACE
SELECT * FROM Activities WHERE Description = "criteria"
SELECT * FROM Activities WHERE DisplayID = "criteria"

Insert

The following attributes are required when performing an insert: DisplayID, IncomeAccountID, TaxCodeID, Type, Status.

INSERT INTO Activities (DisplayID, IncomeAccountID, TaxCodeID, Type, Status) VALUES ("test", "0b9b6098-1a9e-499d-bf41-b863a6daad9c", "2619bed9-3750-45b5-b353-18f5651beb01", "Hourly", "Chargeable"

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Description	String	False		Description of the object.
DisplayID	String	False		Display ID for the object.
IsActive	Boolean	False		True or false.
Name	String	False		Name of the object.
Status	String	False		Can consist of the following: Chargeable used to include on time billing invoices. NonChargeable used when not charging customers but still wanting to include on activity slip.
Type	String	False		Hourly or NonHourly.
UnitOfMeasurement	String	False		Hourly - If Type = Hourly then UnitOfMeasurement = Hour. NonHourly - specify the type of measurement
IncomeAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
IncomeAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
IncomeAccountName	String	True		Name of the account.
IncomeAccountURI	String	True		Uniform resource identifier associated with the account object.
ChargeableRate	String	True		Rate which can consit of the following: EmployeeBillingRate - sourced from the employee contact card. CustomerBillingRate - sourced from the customer contact card. ActivityRate - entered on activity and is exclusive of tax.
UseDescriptionOnSales	Boolean	True		True or false.
TaxCodeID	Uuid	False	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String	True		3 digit tax code.
TaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
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.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ActivitySlips

Return, update, create and delete a list of time billing activity slips 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, ProviderID, ProviderType, ProviderName, CustomerID, CustomerName, ActivityID, ActivityName, JobID, JobNumber, JobName, HourlySalaryPayrollCategoryType, HourlySalaryPayrollCategoryName. All the other columns and operators are processed client side.

SELECT * FROM ActivitySlips WHERE ID = REPLACE
SELECT * FROM ActivitySlips WHERE Rate = 15
SELECT * FROM ActivitySlips WHERE AlreadyBilledAmount = 45.86163291317715

Update

To update an existing activity slip, see below.

UPDATE ActivitySlips SET Rate = 40 WHERE ID = "f979f0e7-1cd8-4fb9-b2c2-9d4546440cf7"

Insert

The following attributes are required when performing an insert: ProviderID, CustomerID, ActivityID.

INSERT INTO ActivitySlips (Rate, AlreadyBilledAmount, Date, ProviderID, CustomerID, ActivityID) VALUES (50, 100.50, "01/01/2023", "43d9bef9-4f5e-4ef2-88a8-4d93a0b8866d", "e3b36dea-3720-449c-8cb3-197d3a2e5f4a", "5ec16ddc-3344-4bef-a40d-ddbfd6098914")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
DisplayID	String	False		Display ID for the object.
Date	Datetime	False		The date of the activity slip.
ProviderID	Uuid	True		Unique provider identifier in the form of a guid.
ProviderDisplayID	String	False		Display id for the provider.
ProviderType	String	True		Type of the provider.
ProviderName	String	True		Name of the provider.
ProviderURI	String	True		Uniform resource identifier associated with the provider object.
CustomerID	Uuid	True		Unique customer identifier in the form of a guid.
CustomerDisplayID	String	False		Display id for the customer.
CustomerName	String	True		Name of the customer.
CustomerURI	String	True		Uniform resource identifier associated with the customer object.
ActivityID	Uuid	True		Unique activity identifier in the form of a guid.
ActivityName	String	True		Name of the activity.
ActivityURI	String	True		Uniform resource identifier associated with the activity object.
JobID	Uuid	True		Unique job identifier in the form of a guid.
JobNumber	String	True		Display id for the job.
JobName	String	True		Name of the job.
JobURI	String	True		Uniform resource identifier associated with the job object.
UnitCount	Decimal	False		Number of (time) units that the Activity will be billed for (in hours).
Rate	Decimal	False		The rate that the Activity will be billed at on this Activity Slip.
AdjustmentAmount	Decimal	False		The Adjustment of how much to bill the customer for in Currency.
AlreadyBilledAmount	Decimal	False		The Adjustment of how much to bill the customer for in Billing Units.
AdjustmentCount	Decimal	False		The Adjustment of how much to bill the customer for in Billing Units.
AlreadyBilledCount	Decimal	False		The amount of Billing Units already billed.
Notes	String	False		Any notes associated with this Activity Slip.
StartStopDescription	String	False		The description of the number of hours the Employee spent on this date for each Payroll Category or Activity.
StartTime	Datetime	False		The exact time this Activity was started.
EndTime	Datetime	False		The exact time this Activity was ended.
ElapsedTime	Integer	False		The Elapsed Time for the Activity in Seconds.
HourlySalaryPayrollCategoryID	Uuid	False		Unique HourlySalaryPayrollCategory identifier in the form of a guid.
HourlySalaryPayrollCategoryType	String	True		Type of the HourlySalaryPayrollCategory.
HourlySalaryPayrollCategoryName	String	True		Name of the HourlySalaryPayrollCategory.
HourlySalaryPayrollCategoryURI	String	True		Uniform resource identifier associated with the HourlySalaryPayrollCategory object.
PaidToEmployeeAmountDecimal	Decimal	False		The Amount already paid to the Employee for this Activity Slip.
LastModified	Datetime	False		DateTime of the last time this resource was modified through a direct action to the object. eg a field was updated.
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.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Build

Return's Build transaction journals

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	False		Unique guid identifier created for the Build adjustment journal.
CategoryUID	Uuid	False	Categories.Id	Unique guid identifier belonging to the category assigned to the inventory journal.
CategoryDisplayID	String	False		Display id for the category
CategoryName	String	False		Name of the category
CategoryURI	String	False		Uniform resource identifier associated with the category object
Date	Datetime	False		Transaction date entry, format YYYY-MM-DD HH:MM:SS
InventoryJournalNumber	String	False		Inventory journal number, if left null when posting a number will automatically be assigned and incremented based upon last recorded
Lines	String	False		An array of journal line information
Memo	String	False		Memo text describing the transaction line
RowVersion	String	False		ONLY required on PUT for updating an existing inventory adjustment line.NOT required when creating a new inventory adjustment journal.
URI	String	False		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web
CompanyFileId	String	False	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ContactCustomers

Return, update, create and delete a customer contact 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering:

ID
CurrentBalance
FirstName
LastName
CompanyName
IsActive
IsIndividual
LastModified
Notes
DisplayID
SellingABN
SellingABNBranch
SellingCreditAvailable
SellingCreditLimit
SellingCreditOnHold
SellingCreditPastDue
SellingFreightTaxCodeCode
SellingFreightTaxCodeID
SellingHourlyBillingRate
SellingInvoiceDelivery
SellingItemPriceLevel
SellingMemo
SellingPrintedForm
SellingReceiptMemo
SellingSaleComment
SellingSaleLayout
SellingShippingMethod
SellingTaxCodeCode
SellingTaxCodeID
SellingTermsBalanceDueDate
SellingTermsDiscountDate
SellingTermsDiscountForEarlyPayment
SellingTermsMonthlyChargeForLatePayment
SellingTermsPaymentIsDue
SellingTermsVolumeDiscount
SellingUseCustomerTaxCode
SellingIncomeAccountId
SellingSalesPersonId
PaymentBSBNumber
PaymentBankAccountName
PaymentBankAccountNumber

All the other columns and operators are processed client side. These columns only support equality comparisons.

SELECT * FROM ContactCustomers WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM ContactCustomers WHERE FirstName = "James" OR FirstName = "John"

Insert

The following attributes are required when performing an insert: CompanyName (if IsIndividual = false), FirstName, LastName, IsIndividual, SellingTaxCodeID and SellingFreightTaxCodeID.

INSERT INTO ContactCustomers (FirstName, LastName, IsIndividual, SellingTaxCodeID, SellingFreightTaxCodeID) VALUES ("James", "Bond", true, "446d2226-254b-4821-acc2-7031842e0166", "446d2226-254b-4821-acc2-7031842e0166")

Update

To update an existing ContactCustomer, along with its associated addresses, either pass a JSON string to the aggregate input value or use a temporary table:

INSERT INTO ContactAddressItems#TEMP (City, Country) VALUES ("Paris", "France")
UPDATE ContactCustomers SET FirstName = "James", Addresses = "ContactAddressItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Delete

You must specify the Id of the ContactCustomer to delete it.

DELETE FROM ContactCustomers WHERE Id = '5a3e152b-4910-4cbe-ad27-32a57392ae23'

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
CurrentBalance	Decimal	True		Contact balance.
FirstName	String	False		Contact first name.
LastName	String	False		Contact last name.
CompanyName	String	False		Contact company name.
IsActive	Boolean	False		True indicates the employee contact is active. False indicates the employee contact is inactive.
IsIndividual	Boolean	False		True indicates the employee contact represents an individual. False indicates the employee contact represents a company.
LastModified	Datetime	True		Extracts the last modification date for the contact resource.
Notes	String	False		Notes for the contact.
PhotoURI	String	False		Uniform resource identifier associated with a photo image.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
DisplayID	String	False		Display ID for the contact card.
SellingABN	Sring	False		ABN Number (Must be 11 digits and formatted as XX XXX XXX XXX).
SellingABNBranch	String	False		ABN branch number.
SellingCreditAvailable	Integer	True		Credit available.
SellingCreditLimit	Integer	False		Credit limit.
SellingCreditOnHold	Boolean	False		Credit on hold.
SellingCreditPastDue	Integer	True		Past due balance.
SellingFreightTaxCodeCode	String	True		3 digit tax code.
SellingFreightTaxCodeID	Uuid	False		Unique guid identifier belonging to the assigned tax code.
SellingFreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
SellingHourlyBillingRate	Double	False		The customers hourly billing rate.
SellingInvoiceDelivery	String	False		Default invoice delivery status assigned.
SellingItemPriceLevel	String	True		Item price level, can consist of the following: Base Selling Price, Level A, Level B, Level C, Level D, Level E, Level F.
SellingMemo	String	False		Default memo text.
SellingPrintedForm	String	False		Named form selected as default printed form.
SellingReceiptMemo	String	False		Default receipt memo.
SellingSaleComment	String	False		Default selected sale comment.
SellingSaleLayout	String	False		Sale Type of the record containing the full default Sale Layout definition: NoDefault, Service, Item, Professional, TimeBilling, Miscellaneous.
SellingShippingMethod	String	False		Shipping method text.
SellingTaxCodeCode	String	True		3 digit tax code.
SellingTaxCodeID	Uuid	True		Unique guid identifier belonging to the assigned tax code.
SellingTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
SellingTermsBalanceDueDate	Integer	True		The date of the entry.
SellingTermsDiscountDate	Integer	True		The date of the entry.
SellingTermsDiscountForEarlyPayment	Double	True		% discount for early payment.
SellingTermsMonthlyChargeForLatePayment	Double	True		% monthly charge for late payment.
SellingTermsPaymentIsDue	String	True		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
SellingTermsVolumeDiscount	Integer	True		Volume supplier discount.
SellingUseCustomerTaxCode	Boolean	True		True indicates to use the customer tax code. False indicates do not use the customer tax code.
SellingTaxIdNumber	String	False		Tax id number.
SellingIncomeAccountId	Uuid	True		Unique identifier for the income account in the form of a guid.
SellingIncomeAccountName	String	True		Name of the income account.
SellingIncomeAccountDisplayId	String	True		Income account code format includes separator ie 4-1100.
SellingIncomeAccountURI	String	True		Uniform resource identifier associated with the income account object.
SellingSalesPersonId	Uuid	True		Unique employee contact identifier in the form of a guid.
SellingSalesPersonName	String	True		Selected employee contact name.
SellingSalesPersonDisplayId	String	True		Employee contact Card ID, can also be used as a unique employee contact identifier.
SellingSalesPersonURI	String	True		Uniform resource identifier associated with the employee contact object.
PaymentMethod	String	False		Payment methods must exist in company file, default methods consist of the following: American Express, Bank Card, Barter Card, Cash, Cheque, Diners Club, EFTPOS, MasterCard, Money Order, Other, Visa.
PaymentCardNumber	String	False		Last 4 digits only.
PaymentNameOnCard	String	False		Default name on card.
PaymentNotes	String	False		Default payment notes.
PaymentBSBNumber	String	False		Default bank account bsb number.
PaymentBankAccountName	String	False		Default bank account name.
PaymentBankAccountNumber	String	False		formatted (XX-XXXX-XXXXXXX-XX).
ForeignCurrencyId	Uuid	True		This is an AccountRight only field. Foreign Key: Unique identifier for the currency in the form of a guid.
ForeignCurrencyCode	String	True		This is an AccountRight only field.The currency code.
ForeignCurrencyName	String	True		This is an AccountRight only field. The full name of the currency.
ForeignCurrencyURI	String	True		This is an AccountRight only field. Uniform resource identifier associated with the currency object.
Identifiers	String	True		Contact Identifiers Details.
CustomField1Label	String	True		Custom Field 1 label.
CustomField1Value	String	True		Custom Field 1 value.
CustomField2Label	String	True		Custom Field 2 label.
CustomField2Value	String	True		Custom Field 2 value.
CustomField3Label	String	True		Custom Field 3 label.
CustomField3Value	String	True		Custom Field 3 value.
CustomList1Label	String	True		Custom List 1 label.
CustomList1Value	String	True		Custom List 1 value.
CustomList2Label	String	True		Custom List 2 label.
CustomList2Value	String	True		Custom List 2 value.
CustomList3Label	String	True		Custom List 3 label.
CustomList3Value	String	True		Custom List 3 value.
Addresses	String	False		The following set of information pulls through details for a contact address.
RowVersion	String	False		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ContactEmployees

Return, update, create and delete an employee contact 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering:

ID
CurrentBalance
FirstName
LastName
CompanyName
IsActive
IsIndividual
LastModified
Notes
DisplayID
EmployeePaymentDetailsID
EmployeePayrollDetailsID
EmployeeStandardPayID
TimeBillingDetailsCostPerHour
TimeBillingDetailsEmployeeBillingRateExcludingTax

All the other columns and operators are processed client side. These columns only support equality comparisons.

SELECT * FROM ContactEmployees WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM ContactEmployees WHERE FirstName = "James" OR FirstName = "John"

Insert

The following attributes are required when performing an insert: CompanyName (if IsIndividual = false), FirstName, LastName, and IsIndividual.

INSERT INTO ContactEmployees (FirstName, LastName, IsIndividual) VALUES ("James", "Bond", true)

Update

To update an existing ContactEmployee, along with its associated addresses, either pass a JSON string to the aggregate input value or use a temporary table:

INSERT INTO ContactAddressItems#TEMP (City, Country) VALUES ("Paris", "France")
UPDATE ContactEmployees SET FirstName = "James", Addresses = "ContactAddressItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Delete

You must specify the Id of the ContactEmployee to delete it.

DELETE FROM ContactEmployees WHERE Id = '5a3e152b-4910-4cbe-ad27-32a57392ae23'

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
CurrentBalance	Decimal	True		Contact balance.
FirstName	String	False		Contact first name.
LastName	String	False		Contact last name.
CompanyName	String	False		Contact company name.
IsActive	Boolean	False		True indicates the employee contact is active. False indicates the employee contact is inactive.
IsIndividual	Boolean	False		True indicates the employee contact represents an individual. False indicates the employee contact represents a company.
LastModified	Datetime	True		Extracts the last modification date for the contact resource.
Notes	String	False		Notes for the contact.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
PhotoURI	String	False		Uniform resource identifier associated with a photo image.
DisplayID	String	False		Display ID for the contact card.
EmployeePaymentDetailsID	Uuid	True		Unique identifier in the form of a guid.
EmployeePaymentDetailsURI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
EmployeePayrollDetailsID	Uuid	True		Unique identifier in the form of a guid.
EmployeePayrollDetailsURI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
EmployeeStandardPayID	Uuid	True		Unique identifier in the form of a guid.
EmployeeStandardPayURI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
TimeBillingDetailsCostPerHour	Double	True		Hourly cost of employee to business.
TimeBillingDetailsEmployeeBillingRateExcludingTax	Double	True		Hourly billing rate for services provided by employee
Identifiers	String	True		Contact Identifiers Details.
CustomField1Label	String	True		Custom Field 1 label.
CustomField1Value	String	True		Custom Field 1 value.
CustomField2Label	String	True		Custom Field 2 label.
CustomField2Value	String	True		Custom Field 2 value.
CustomField3Label	String	True		Custom Field 3 label.
CustomField3Value	String	True		Custom Field 3 value.
CustomList1Label	String	True		Custom List 1 label.
CustomList1Value	String	True		Custom List 1 value.
CustomList2Label	String	True		Custom List 2 label.
CustomList2Value	String	True		Custom List 2 value.
CustomList3Label	String	True		Custom List 3 label.
CustomList3Value	String	True		Custom List 3 value.
Addresses	String	False		The following set of information pulls through details for a contact address.
RowVersion	String	False		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ContactPersonals

Return, update, create and delete a personal contact 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering:

ID
CurrentBalance
FirstName
LastName
CompanyName
IsActive
IsIndividual
LastModified
Notes
DisplayID

All the other columns and operators are processed client side. These columns only support equality comparisons.

SELECT * FROM ContactPersonals WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM ContactPersonals WHERE FirstName = "James" OR FirstName = "John"

Insert

The following attributes are required when performing an insert: CompanyName (if IsIndividual = false), FirstName, LastName, and IsIndividual.

INSERT INTO ContactPersonals (FirstName, LastName, IsIndividual) VALUES ("James", "Smith", true)

Update

To update an existing ContactPersonal, along with its associated addresses, either pass a JSON string to the aggregate input value or use a temporary table:

INSERT INTO ContactAddressItems#TEMP (City, Country) VALUES ("Paris", "France")
UPDATE ContactPersonals SET FirstName = "James", Addresses = "ContactAddressItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Delete

You must specify the Id of the ContactPersonal to delete it.

DELETE FROM ContactPersonals WHERE Id = '5a3e152b-4910-4cbe-ad27-32a57392ae23'

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
CurrentBalance	Decimal	True		Contact balance.
FirstName	String	False		Contact first name.
LastName	String	False		Contact last name.
CompanyName	String	False		Contact company name.
IsActive	Boolean	False		True indicates the employee contact is active. False indicates the employee contact is inactive.
IsIndividual	Boolean	False		True indicates the employee contact represents an individual. False indicates the employee contact represents a company.
LastModified	Datetime	True		Extracts the last modification date for the contact resource.
Notes	String	False		Notes for the contact.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
PhotoURI	String	False		Uniform resource identifier associated with a photo image.
DisplayID	String	False		Display ID for the contact card.
Identifiers	String	True		Contact Identifiers Details.
CustomField1Label	String	True		Custom Field 1 label.
CustomField1Value	String	True		Custom Field 1 value.
CustomField2Label	String	True		Custom Field 2 label.
CustomField2Value	String	True		Custom Field 2 value.
CustomField3Label	String	True		Custom Field 3 label.
CustomField3Value	String	True		Custom Field 3 value.
CustomList1Label	String	True		Custom List 1 label.
CustomList1Value	String	True		Custom List 1 value.
CustomList2Label	String	True		Custom List 2 label.
CustomList2Value	String	True		Custom List 2 value.
CustomList3Label	String	True		Custom List 3 label.
CustomList3Value	String	True		Custom List 3 value.
Addresses	String	False		The following set of information pulls through details for a contact address.
RowVersion	String	False		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Contacts

Return all contact types for an AccountRight company file. This table has been deprecated, and new tables - ContactSupplier, ContactCustomer, ContactPersonal, and ContactEmployee have been introduced as replacements for it.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering:


ABN	ABNBranch	BuyingABN	BuyingABNBranch	BuyingCostPerHour
BuyingPrintedForm	BuyingPurchaseComment	BuyingPurchaseLayout	BuyingPurchaseOrderDelivery	BuyingShippingMethod
BuyingSupplierBillingRate	CompanyName	CreditAvailable	CreditLimit	CreditOnHold
BuyingIsReportable	BuyingPaymentMemo	CreditPastDue	CurrentBalance	DisplayID
EmployeePaymentDetailsID	EmployeePayrollDetailsID	EmployeeStandardPayID	ExpenseAccountDisplayID	ExpenseAccountID
ExpenseAccountName	FirstName	FreightTaxCodeCode	FreightTaxCodeID	HourlyBillingRate
ID	InvoiceDelivery	IsActive	IsIndividual	LastName
LastModified	Memo	Notes	PaymentBankAccountName	PaymentBankAccountNumber
PaymentBSBNumber	PaymentLastModified	PaymentRefundCardNumber	PaymentRefundNameOnCard	PaymentRefundNotes
PaymentRefundPaymentMethod	PaymentStatementText	PrintedForm	ReceiptMemo	SaleComment
SaleLayout	ShippingMethod	TaxCodeCode	TaxCodeID	TermsBalanceDueDate
TermsDiscountDate	TermsDiscountForEarlyPayment	TermsMonthlyChargeForLatePayment	TermsPaymentIsDue	TermsVolumeDiscount
TimeBillingDetailsCostPerHour	TimeBillingDetailsEmployeeBillingRateExcludingTax	UseCustomerTaxCode

All the other columns and operators are processed client side. Type supports only equality comparison.

SELECT * FROM Contacts WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM Contacts WHERE Type = "Customer"
SELECT * FROM Contacts WHERE FirstName = "James" OR FirstName = "John"

Update

To update an existing contact, along with the addresses, either pass a JSON string to the aggregate input value or use a temporary table like below.

INSERT INTO ContactAddressItems#TEMP (City, Country) VALUES ("Paris", "France")
UPDATE Contacts SET FirstName = "James", Addresses = "ContactAddressItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Insert

The following attributes are required when performing an insert: Type, CompanyName (if IsIndividual = false), FirstName, LastName, IsIndividual. In addition, for "Customer" and "Supplier" types, "SellingTaxCodeID, SellingFreightTaxCodeID" and "BuyingTaxCodeID, BuyingFreightTaxCodeID" are required respectively.

INSERT INTO Contacts (Type, FirstName, LastName, IsIndividual, SellingTaxCodeID, SellingFreightTaxCodeID) VALUES ("Customer", "James", "Bond", true, "446d2226-254b-4821-acc2-7031842e0166", "446d2226-254b-4821-acc2-7031842e0166")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
CurrentBalance	Decimal	False		Contact balance.
FirstName	String	False		Contact first name.
LastName	String	False		Contact last name.
CompanyName	String	False		Contact company name.
IsActive	Boolean	False		True indicates the employee contact is active. False indicates the employee contact is inactive.
IsIndividual	Boolean	False		True indicates the employee contact represents an individual. False indicates the employee contact represents a company.
LastModified	Datetime	False		Extracts the last modification date for the contact resource.
Notes	String	False		Notes for the contact.
PhotoURI	String	False		Uniform resource identifier associated with a photo image.
Type	String	False		Contact type. One of: Customer,Supplier,Personal,Employee.
DisplayID	String	False		Display ID for the contact card.
SellingABN	String	True		ABN Number (Must be 11 digits and formatted as XX XXX XXX XXX).
SellingABNBranch	String	True		ABN branch number.
SellingCreditAvailable	Integer	True		Credit available.
SellingCreditLimit	Integer	True		Credit limit.
SellingCreditOnHold	Boolean	True		Credit on hold.
SellingCreditPastDue	Integer	True		Past due balance.
SellingFreightTaxCodeCode	String	True		3 digit tax code.
SellingFreightTaxCodeID	Uuid	True		Unique guid identifier belonging to the assigned tax code.
SellingFreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
SellingHourlyBillingRate	Double	True		The customers hourly billing rate.
SellingInvoiceDelivery	String	True		Default invoice delivery status assigned.
SellingItemPriceLevel	String	True		Item price level, can consist of the following: Base Selling Price, Level A, Level B, Level C, Level D, Level E, Level F.
SellingMemo	String	True		Default memo text.
SellingPrintedForm	String	True		Named form selected as default printed form.
SellingReceiptMemo	String	True		Default receipt memo.
SellingSaleComment	String	True		Default selected sale comment.
SellingSaleLayout	String	True		Sale Type of the record containing the full default Sale Layout definition: NoDefault, Service, Item, Professional, TimeBilling, Miscellaneous.
SellingShippingMethod	String	True		Shipping method text.
SellingTaxCodeCode	String	True		3 digit tax code.
SellingTaxCodeID	Uuid	True		Unique guid identifier belonging to the assigned tax code.
SellingTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
SellingTermsBalanceDueDate	Integer	True		The date of the entry.
SellingTermsDiscountDate	Integer	True		The date of the entry.
SellingTermsDiscountForEarlyPayment	Double	True		% discount for early payment.
SellingTermsMonthlyChargeForLatePayment	Double	True		% monthly charge for late payment.
SellingTermsPaymentIsDue	String	True		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
SellingTermsVolumeDiscount	Integer	True		Volume supplier discount.
SellingUseCustomerTaxCode	Boolean	True		True indicates to use the customer tax code. False indicates do not use the customer tax code.
BuyingABN	String	True		ABN Number (Must be 11 digits and formatted as XX XXX XXX XXX).
BuyingABNBranch	String	True		ABN branch number.
BuyingCostPerHour	Double	True		Cost per hour of providing the suppliers services when generating an activity slip.
BuyingCreditAvailable	Double	True		Credit availiable.
BuyingCreditLimit	Double	True		Credit limit.
BuyingCreditPastDue	Double	True		Past due balance.
BuyingExpenseAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
BuyingExpenseAccountID	Uuid	True		Unique identifier for the account in the form of a guid.
BuyingExpenseAccountName	String	True		Name of the account.
BuyingExpenseAccountURI	String	True		Uniform resource identifier associated with the account object.
BuyingFreightTaxCodeCode	String	True		3 digit tax code.
BuyingFreightTaxCodeID	Uuid	True		Unique guid identifier belonging to the assigned tax code.
BuyingFreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
BuyingIsReportable	Boolean	True		True indicates the supplier contact is setup for reportable taxable payments. False indicates the supplier contact is not setup for reportable taxable payments.
BuyingPaymentMemo	String	True		Default payment memo.
BuyingPrintedForm	String	True		Named form selected as default printed form.
BuyingPurchaseComment	String	True		Default selected purchase comment.
BuyingPurchaseLayout	String	True		Purchase type of the record containing the full default purchase layout definition: NoDefault, Service, Item, Professional, Miscellaneous.
BuyingPurchaseOrderDelivery	String	True		Default supplier delivery status.
BuyingShippingMethod	String	True		Shipping method text.
BuyingSupplierBillingRate	Double	True		The suppliers hourly billing rate exclusive of tax.
BuyingTaxCodeCode	String	True		3 digit tax code.
BuyingTaxCodeID	Uuid	True		Unique guid identifier belonging to the assigned tax code.
BuyingTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
BuyingTermsBalanceDueDate	Integer	True		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which payments must be made. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which payments must be made.
BuyingTermsDiscountDate	Integer	True		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which payments must be made to receive discounts. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
BuyingTermsDiscountForEarlyPayment	Double	True		% discount for early payment.
BuyingTermsPaymentIsDue	String	True		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
BuyingTermsVolumeDiscount	Double	True		Volume discount.
BuyingUseSupplierTaxCode	Boolean	True		True or false.
PaymentBSBNumber	String	True		Default bank account bsb number.
PaymentBankAccountName	String	True		Default bank account name.
PaymentBankAccountNumber	String	True		formatted (XX-XXXX-XXXXXXX-XX).
PaymentLastModified	String	True		Extracts the last modification date for the contact resource.
PaymentPhotoURI	String	True		Uniform resource identifier associated with a photo image.
PaymentRefundCardNumber	String	True		Last 4 digits only.
PaymentRefundNameOnCard	String	True		Default name on card.
PaymentRefundNotes	String	True		Default refund payment notes.
PaymentRefundPaymentMethod	String	True		Payment method on refund, must exist in company file, default methods consist of the following: American Express, Bank Card, Barter Card, Cash, Cheque, Diners Club, EFTPOS, MasterCard, Money Order, Other, Visa.
PaymentRowVersion	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.
PaymentStatementText	String	True		Default statement text.
PaymentURI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
EmployeePaymentDetailsID	Uuid	True		Unique identifier in the form of a guid.
EmployeePaymentDetailsURI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
EmployeePayrollDetailsID	Uuid	True		Unique identifier in the form of a guid.
EmployeePayrollDetailsURI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
EmployeeStandardPayID	Uuid	True		Unique identifier in the form of a guid.
EmployeeStandardPayURI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
TimeBillingDetailsCostPerHour	Double	True		Hourly cost of employee to business.
TimeBillingDetailsEmployeeBillingRateExcludingTax	Double	True		Hourly billing rate for services provided by employee
Identifiers	String	True		Contact Identifiers Details.
CustomField1Label	String	True		Custom Field 1 label.
CustomField1Value	String	True		Custom Field 1 value.
CustomField2Label	String	True		Custom Field 2 label.
CustomField2Value	String	True		Custom Field 2 value.
CustomField3Label	String	True		Custom Field 3 label.
CustomField3Value	String	True		Custom Field 3 value.
CustomList1Label	String	True		Custom List 1 label.
CustomList1Value	String	True		Custom List 1 value.
CustomList2Label	String	True		Custom List 2 label.
CustomList2Value	String	True		Custom List 2 value.
CustomList3Label	String	True		Custom List 3 label.
CustomList3Value	String	True		Custom List 3 value.
Addresses	String	False		The following set of information pulls through details for a contact address.
RowVersion	String	False		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ContactSuppliers

Return, update, create and delete a supplier contact 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering:

ID
CurrentBalance
FirstName
LastName
CompanyName
IsActive
IsIndividual
LastModified
Notes
DisplayID
BuyingABN
BuyingABNBranch
BuyingCostPerHour
BuyingCreditAvailable
BuyingCreditLimit
BuyingCreditPastDue
BuyingExpenseAccountDisplayID
BuyingExpenseAccountID
BuyingExpenseAccountName
BuyingFreightTaxCodeCode
BuyingFreightTaxCodeID
BuyingIsReportable
BuyingPaymentMemo
BuyingPrintedForm
BuyingPurchaseComment
BuyingPurchaseLayout
BuyingPurchaseOrderDelivery
BuyingShippingMethod
BuyingSupplierBillingRate
BuyingTaxCodeCode
BuyingTaxCodeID
BuyingTermsBalanceDueDate
BuyingTermsDiscountDate
BuyingTermsDiscountForEarlyPayment
BuyingTermsPaymentIsDue
BuyingTermsVolumeDiscount
BuyingUseSupplierTaxCode
PaymentBSBNumber
PaymentBankAccountName
PaymentBankAccountNumber
PaymentRefundCardNumber
PaymentRefundNameOnCard
PaymentRefundNotes
PaymentRefundPaymentMethod
PaymentStatementText

All the other columns and operators are processed client side. These columns only support equality comparisons.

SELECT * FROM ContactSuppliers WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM ContactSuppliers WHERE FirstName = "James" OR FirstName = "John"

Insert

The following attributes are required when performing an insert: CompanyName (if IsIndividual = false), FirstName, LastName, IsIndividual, BuyingTaxCodeID and BuyingFreightTaxCodeID.

INSERT INTO ContactSuppliers (FirstName, LastName, IsIndividual, BuyingTaxCodeID, BuyingFreightTaxCodeID) VALUES ("James", "Bond", true, "446d2226-254b-4821-acc2-7031842e0166", "446d2226-254b-4821-acc2-7031842e0166")

Update

To update an existing ContactSupplier, along with its associated addresses, either pass a JSON string to the aggregate input value or use a temporary table:.

INSERT INTO ContactAddressItems#TEMP (City, Country) VALUES ("Paris", "France")
UPDATE ContactSuppliers SET FirstName = "James", Addresses = "ContactAddressItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Delete

You must specify the Id of the ContactSupplier to delete it.

DELETE FROM ContactSuppliers WHERE Id = '35fe2eaa-d941-4312-a427-bd4281670c75'

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
CurrentBalance	Decimal	True		Contact balance.
FirstName	String	False		Contact first name.
LastName	String	False		Contact last name.
CompanyName	String	False		Contact company name.
IsActive	Boolean	False		True indicates the employee contact is active. False indicates the employee contact is inactive.
IsIndividual	Boolean	False		True indicates the employee contact represents an individual. False indicates the employee contact represents a company.
LastModified	Datetime	True		Extracts the last modification date for the contact resource.
Notes	String	False		Notes for the contact.
PhotoURI	String	False		Uniform resource identifier associated with a photo image.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
DisplayID	String	False		Display ID for the contact card.
BuyingABN	String	False		ABN Number (Must be 11 digits and formatted as XX XXX XXX XXX).
BuyingABNBranch	String	False		ABN branch number.
BuyingCostPerHour	Double	False		Cost per hour of providing the suppliers services when generating an activity slip.
BuyingCreditAvailable	Double	True		Credit availiable.
BuyingCreditLimit	Double	False		Credit limit.
BuyingCreditPastDue	Double	True		Past due balance.
BuyingExpenseAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
BuyingExpenseAccountID	Uuid	False		Unique identifier for the account in the form of a guid.
BuyingExpenseAccountName	String	True		Name of the account.
BuyingExpenseAccountURI	String	True		Uniform resource identifier associated with the account object.
BuyingFreightTaxCodeCode	String	True		3 digit tax code.
BuyingFreightTaxCodeID	Uuid	False		Unique guid identifier belonging to the assigned tax code.
BuyingFreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
BuyingIsReportable	Boolean	False		True indicates the supplier contact is setup for reportable taxable payments. False indicates the supplier contact is not setup for reportable taxable payments.
BuyingPaymentMemo	String	False		Default payment memo.
BuyingPrintedForm	String	False		Named form selected as default printed form.
BuyingPurchaseComment	String	False		Default selected purchase comment.
BuyingPurchaseLayout	String	False		Purchase type of the record containing the full default purchase layout definition: NoDefault, Service, Item, Professional, Miscellaneous.
BuyingPurchaseOrderDelivery	String	False		Default supplier delivery status.
BuyingShippingMethod	String	False		Shipping method text.
BuyingSupplierBillingRate	Double	False		The suppliers hourly billing rate exclusive of tax.
BuyingTaxIdNumber	String	False		Tax id Number.
BuyingTaxCodeCode	String	True		3 digit tax code.
BuyingTaxCodeID	Uuid	False		Unique guid identifier belonging to the assigned tax code.
BuyingTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
BuyingTermsBalanceDueDate	Integer	False		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which payments must be made. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which payments must be made.
BuyingTermsDiscountDate	Integer	False		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which payments must be made to receive discounts. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
BuyingTermsDiscountForEarlyPayment	Double	False		% discount for early payment.
BuyingTermsPaymentIsDue	String	False		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
BuyingTermsVolumeDiscount	Double	False		Volume discount.
BuyingUseSupplierTaxCode	Boolean	False		True or false.
PaymentBSBNumber	String	False		Default bank account bsb number.
PaymentBankAccountName	String	False		Default bank account name.
PaymentBankAccountNumber	String	False		formatted (XX-XXXX-XXXXXXX-XX).
PaymentRefundCardNumber	String	False		Last 4 digits only.
PaymentRefundNameOnCard	String	False		Default name on card.
PaymentRefundNotes	String	False		Default refund payment notes.
PaymentRefundPaymentMethod	String	False		Payment method on refund, must exist in company file, default methods consist of the following: American Express, Bank Card, Barter Card, Cash, Cheque, Diners Club, EFTPOS, MasterCard, Money Order, Other, Visa.
PaymentStatementText	String	False		Default statement text.
PaymentStatementCode	String	False		Default code attached to an electronic payment. ONLY APPLICABLE FOR NZ REGION.
PaymentStatementReference	String	False		Default reference attached to an electronic payment. ONLY APPLICABLE FOR NZ REGION.
ForeignCurrencyId	Uuid	True		This is an AccountRight only field. Foreign Key: Unique identifier for the currency in the form of a guid.
ForeignCurrencyCode	String	True		This is an AccountRight only field.The currency code.
ForeignCurrencyName	String	True		This is an AccountRight only field. The full name of the currency.
ForeignCurrencyURI	String	True		This is an AccountRight only field. Uniform resource identifier associated with the currency object.
Identifiers	String	True		Contact Identifiers Details.
CustomField1Label	String	True		Custom Field 1 label.
CustomField1Value	String	True		Custom Field 1 value.
CustomField2Label	String	True		Custom Field 2 label.
CustomField2Value	String	True		Custom Field 2 value.
CustomField3Label	String	True		Custom Field 3 label.
CustomField3Value	String	True		Custom Field 3 value.
CustomList1Label	String	True		Custom List 1 label.
CustomList1Value	String	True		Custom List 1 value.
CustomList2Label	String	True		Custom List 2 label.
CustomList2Value	String	True		Custom List 2 value.
CustomList3Label	String	True		Custom List 3 label.
CustomList3Value	String	True		Custom List 3 value.
Addresses	String	False		The following set of information pulls through details for a contact address.
RowVersion	String	False		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

CreditRefunds

Return, create and delete credit notes refunded to customers 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 criteria 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, DeliveryStatus, Memo, Number, Payee, Amount, ChequePrinted, AccountID, AccountDisplayID, AccountName, CustomerID, CustomerDisplayID, CustomerName, InvoiceID, InvoiceNumber. All the other columns and operators are processed client side.

SELECT * FROM CreditRefunds WHERE ID = "6d35e53a-5070-432d-b9ec-f4791e353352
SELECT * FROM CreditRefunds WHERE AccountName = "AccountName"
SELECT * FROM CreditRefunds WHERE Amount = 340.44

Insert

The following attributes are required when performing an insert: Date, Amount, AccountID, CustomerID, InvoiceID.

INSERT INTO CreditRefunds (Date, Amount, AccountID, CustomerID, InvoiceID) VALUES ("01/02/2019", 54, "3a35e83a-5070-432d-b6ec-f4791f353352", "2619bed9-3750-45b5-b353-18f5651beb01", "f6703af2-7494-4ecc-b0f6-b2bb9c813782")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Date	Datetime	False		Transaction date.
DeliveryStatus	String	False		Remittance advise delivery status assigned to credit note: Print = ToBePrinted, Email = ToBeEmailed, PrintAndEmail = ToBePrintedAndEmailed, Nothing = AlreadyPrintedOrSent.
Memo	String	False		Memo text describing the credit refund.
Number	String	False		Sales invoice number
Payee	String	False		Payee address on the credit note belonging to the customer contact.
Amount	Decimal	False		Total credit amount to be refunded, can be equal to or less than the invoice amount.
ChequePrinted	Boolean	False		True or false.
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	True	Accounts.ID	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	True	Contacts.ID	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.
InvoiceID	Uuid	False	SaleInvoices.ID	Unique identifier in the form of a guid.
InvoiceNumber	String	True		Invoice number.
InvoiceURI	String	True		Uniform resource identifier associated with the invoice.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

CreditSettlements

Return, create and delete settled customer credits 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 criteria 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, Memo, Number, CreditAmount, CreditFromInvoiceID, CreditFromInvoiceNumber, CustomerID, CustomerDisplayID, CustomerName. All the other columns and operators are processed client side.

SELECT * FROM CreditSettlements WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM CreditSettlements WHERE CustomerID = "07763f97-43cc-4149-8c00-d92feb4e1404"
SELECT * FROM CreditSettlements WHERE Memo = "memo"

Insert

The following attributes are required when performing an insert: Date, CreditFromInvoiceID, CustomerID.

To insert the Lines values into CreditSettlements, either pass the JSON data as a string or use a temporary table like below.

INSERT INTO CreditSettlementItems#TEMP (AmountApplied, Type, SaleId) VALUES (444.21, "Invoice", "0229a075-f93a-4b6c-85d7-0ffd5ba43982")
INSERT INTO CreditSettlements (Date, CreditFromInvoiceID, CustomerID, Lines) VALUES ("01/01/2019", "07763f97-43cc-4149-8c00-d92feb4e1404", "6aaccbbf-2a21-44eb-8462-dfff3117dd5a", "CreditSettlementItems#TEMP")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Date	Datetime	False		Transaction date.
Memo	String	False		Memo text describing the settled credit.
Number	String	False		Cheque credit number, optional on POST as will auto increment based upon last recorded if left blank.
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.
CreditAmount	Decimal	True		Total credit amount to be applied, can only be less than or equal to CreditFromInvoice amount.
CreditFromInvoiceID	Uuid	False		Unique identifier in the form of a guid.
CreditFromInvoiceNumber	String	True		Invoice number.
CreditFromInvoiceURI	String	True		Uniform resource identifier associated with the invoice.
CustomerID	Uuid	False	Contacts.ID	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.
Lines	String	False		The following set of information pulls through line details for the credit settlement.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

CustomerPayments

Return, create and delete customer payments 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 criteria 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

Insert

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

To insert the Invoices values into CustomerPayments, 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")

Columns


Name	Type	ReadOnly	References	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	Accounts.ID	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	Contacts.ID	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	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

DebitRefunds

Return all purchase bill types 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Amount, Date, DepositTo, Memo, Number, PaymentMethod, BillID, BillNumber, AccountID, AccountDisplayID, AccountName, SupplierID, SupplierDisplayID, SupplierName. All the other columns and operators are processed client side.

SELECT * FROM DebitRefunds WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM DebitRefunds WHERE Amount = 1600.00
SELECT * FROM DebitRefunds WHERE AccountName = "Processing account"

Insert

The following attributes are required when performing an insert: Amount, Date, DepositTo, BillID, AccountID.

INSERT INTO DebitRefunds (Date, Amount, AccountID, DepositTo, BillID) VALUES ("01/02/2019", 54, "3a35e83a-5070-432d-b6ec-f4791f353352", "Account", "f6703af2-7494-4ecc-b0f6-b2bb9c813782")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Amount	Double	False		Total amount of the debit to be refunded, can be equal to or less than the bill amount.
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.
Memo	String	False		Memo text for the object.
Number	String	False		Purchase bill number.
PaymentMethod	String	False		Payment method text.
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.
BillID	Uuid	False	PurchaseBills.ID	Unique identifier in the form of a guid.
BillNumber	String	True		Bill number.
BillURI	String	True		Uniform resource identifier associated with the bill.
AccountID	Uuid	False	Accounts.ID	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.
SupplierID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned supplier contact.
SupplierDisplayID	String	True		Customer contact Card ID, can also be used as a unique supplier contact identifier.
SupplierName	String	True		Name of the supplier contact.
SupplierURI	String	True		Uniform resource identifier associated with the supplier contact object.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

DebitSettlements

Return, create and delete debit settlements 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 criteria 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, Memo, Number, DebitAmount, DebitFromBillID, DebitFromBillNumber, SupplierID, SupplierDisplayID, SupplierName. All the other columns and operators are processed client side.

SELECT * FROM DebitSettlements WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM DebitSettlements WHERE DebitAmount = 2600
SELECT * FROM DebitSettlements WHERE Memo = "memo"

Insert

The following attributes are required when performing an insert: Date, DebitFromBillID, Lines.

To insert the Lines values into DebitSettlements, either pass the JSON data as a string or use a temporary table like below.

INSERT INTO DebitSettlementItems#TEMP (AmountApplied, Type, Purchaseid) VALUES (444.21, "Order", "0229a075-f93a-4b6c-85d7-0ffd5ba43982")
INSERT INTO DebitSettlements (Date, DebitFromBillID, Lines) VALUES ("01/01/2019", "07763f97-43cc-4149-8c00-d92feb4e1404", "6aaccbbf-2a21-44eb-8462-dfff3117dd5a", "DebitSettlementItems#TEMP")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Date	Datetime	False		The date of the entry.
Memo	String	False		Memo text for the object.
Number	String	False		ID transaction number, if left blank on POST will auto increment based upon last recorded.
DebitAmount	Double	False		Total debit amount to be applied, can only be less than or equal to DebitFromBill amount.
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.
DebitFromBillID	Uuid	False	PurchaseBills.ID	Unique identifier in the form of a guid.
DebitFromBillNumber	String	True		Bill number.
DebitFromBillURI	String	True		Uniform resource identifier associated with the bill.
SupplierID	Uuid	False	Accounts.ID	Unique guid identifier belonging to the assigned supplier contact.
SupplierDisplayID	String	True		Customer contact Card ID, can also be used as a unique supplier contact identifier.
SupplierName	String	True		Name of the supplier contact.
SupplierURI	String	True		Uniform resource identifier associated with the supplier contact object.
Lines	String	False		The following set of information pulls through line details for the debit settlement.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeePaymentDetails

Return and update employee payment details on employee contact cards 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, BankStatementText, PaymentMethod, EmployeeID, EmployeeDisplayID, EmployeeName. All the other columns and operators are processed client side.

SELECT * FROM EmployeePaymentDetails WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM EmployeePaymentDetails WHERE EmployeeID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Update

To update an existing employee payment detail, along with its BankAccounts, either pass a JSON string to the BankAccounts value or use a temporary table like below. Note: this will replace all the current BankAccounts with the ones below.

INSERT INTO EmployeeBankAccountItems#TEMP (BSBNumber, BankAccountName, BankAccountNumber, Unit, Value) VALUES ("341-241", "123412341", "Mr A Long", 100, "Percent")
UPDATE EmployeePaymentDetails SET BankAccounts = "EmployeeBankAccountItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
BankStatementText	String	False		Text to appear on employee's bank statement where PaymentMethod = Electronic.
PaymentMethod	String	False		Payment method can consist of the following Enum values: Cash, Cheque, Electronic.
EmployeeID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned employee contact.
EmployeeDisplayID	String	True		Customer contact Card ID, can also be used as a unique employee contact identifier.
EmployeeName	String	True		Name of the employee contact.
EmployeeURI	String	True		Uniform resource identifier associated with the employee contact object.
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.
BankAccounts	String	False		An array of employee bank account information where PaymentMethod = Electronic.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeePayrollDetails

Return and update employee payroll details on employee contact cards 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, DateOfBirth, Gender, PaySlipDelivery, PaySlipEmail, StartDate, TimeBillingCostPerHour, TimeBillingEmployeeBillingRateExcludingTax, EmploymentBasis, EmploymentCategory, EmploymentStatus, EmployeeID, EmployeeDisplayID, EmployeeName, EmploymentClassificationID, EmploymentClassificationName, TaxCategoryID, TaxCategoryName, TaxCategoryType, TaxTableID, TaxTableName, TaxFileNumber, TaxTotalRebatesPerYear, TaxWithholdingVariationRate, TaxExtraTaxPerPay, WageAnnualSalary, WageHourlyRate, WageHoursInWeeklyPayPeriod, WagePayBasis, WagePayFrequency, WagesExpenseAccountID, WagesExpenseAccountDisplayID, WagesExpenseAccountName. All the other columns and operators are processed client side.

SELECT * FROM EmployeePayrollDetails WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM EmployeePayrollDetails WHERE TaxTableID = "a3ed306d-2da1-49b3-9023-353c3dffb2e9"
SELECT * FROM EmployeePayrollDetails WHERE StartDate = "01/02/2019"

Update

To update an existing payroll detail aggregate list, either pass a JSON string to the aggregate input value or use a temporary table like below.

INSERT INTO EmployeePayrollDeductionItems#TEMP (ID) VALUES ("a7ld306u-2da1-49b2-90f3-111c3dffb2e2)
UPDATE EmployeePayrollDetails SET Deductions = "EmployeePayrollDeductionItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
DateOfBirth	Datetime	False		The employee's date of birth.
Gender	String	False		Gender of the employee contact.
PaySlipDelivery	String	False		The methods by which the payslip can be sent: ToBePrinted (Defaults to be printed on PUT if not specified) , ToBeEmailed, ToBePrintedAndEmailed, AlreadyPrintedOrSent.
PaySlipEmail	String	False		Email address to which payslips should be emailed.
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.
StartDate	Datetime	False		Ending date of the period.
TimeBillingCostPerHour	Double	True		Hourly cost.
TimeBillingEmployeeBillingRateExcludingTax	Double	True		Hourly billing rate for services provided by employee.
EmploymentBasis	String	False		Employment basis can consist of the following: Individual (Defaults to individual on PUT if not specified) , Labor Hire, Other.
EmploymentCategory	String	False		Employment category can consist of the following: Permanent (Defaults to permanent on PUT if not specified), Temporary.
EmploymentStatus	String	False		Employment status can consist of the following: FullTime (Defaults to full time on PUT if not specified) , PartTime, Other, Casual.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
EmployeeID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned employee contact.
EmployeeDisplayID	String	True		Customer contact Card ID, can also be used as a unique employee contact identifier.
EmployeeName	String	True		Name of the employee contact.
EmployeeURI	String	True		Uniform resource identifier associated with the employee contact object.
EmploymentClassificationID	Uuid	False		Unique identifier for the account in the form of a guid.
EmploymentClassificationName	String	True		Name of the employment classification.
EmploymentClassificationURI	String	True		Uniform resource identifier associated with the employment classification object.
TaxCategoryID	Uuid	False		Unique category identifier in the form of a guid.
TaxCategoryName	String	True		Name of the category.
TaxCategoryType	String	True		Indicates the type of payroll category ie: Wage, Deduction, Superannuation.
TaxCategoryURI	String	True		Uniform resource identifier associated with the category object.
TaxTableID	Uuid	False		Unique identifier for the account in the form of a guid.
TaxTableName	String	True		Name of the tax table.
TaxTableURI	String	True		Uniform resource identifier associated with the tax table object.
TaxFileNumber	String	False		Employee tax file number (Must be 9 digits and formatted as XXX XXX XXX).
TaxTotalRebatesPerYear	Double	False		The employee's total rebates offset amount.
TaxWithholdingVariationRate	Double	False		% rate that applies if selected tax table = Withholding Variation.
TaxExtraTaxPerPay	Double	True		The employees extra tax withheld from there pay.
WageAnnualSalary	Decimal	True		Annual salary amount for the employee.
WageHourlyRate	Decimal	True		Employee hourly rate.
WageHoursInWeeklyPayPeriod	Decimal	True		Hours worked in a pay period. Defaults to 40 on PUT if not specified.
WagePayBasis	String	True		PayBasis can consist of the following: Salary (Defaults to salary on PUT if not specified), Hourly.
WagePayFrequency	String	True		Pay frequency can consist of the following: Weekly (Defaults to weekly on PUT if not specified) , Fortnightly, TwiceAMonth, Monthly.
WagesExpenseAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
WagesExpenseAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
WagesExpenseAccountName	String	True		Name of the account.
WagesExpenseAccountURI	String	True		Uniform resource identifier associated with the account object.
WageCategories	String	False		An array of wage categories the employee is linked to.
Entitlements	String	False		The following set of information pulls through details for each linked entitlement category.
Deductions	String	False		The following set of information pulls through details for each linked deductions category.
EmployerExpenses	String	False		The following set of information pulls through details for each linked employer expenses category.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeeStandardPay

Return and update employee standard pay details on employee contact cards 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Memo, HoursPerPayFrequency, PayFrequency, CategoryID, CategoryDisplayID, CategoryName, EmployeeID, EmployeeDisplayID, EmployeeName, PayrollDetailsID. All the other columns and operators are processed client side.

SELECT * FROM EmployeeStandardPay WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM EmployeeStandardPay WHERE EmployeeID = "2aed306d-2da3-49b1-9023-153c3dc5b2ef"
SELECT * FROM EmployeeStandardPay WHERE HoursPerPayFrequency = 11

Update

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

INSERT INTO EmployeePayrollCategoryItems#TEMP (payrollcategoryid) VALUES ("2ced306d-1da3-49b1-2223-153c3dc5b2ef")
UPDATE EmployeeStandardPay SET PayrollCategories = "EmployeePayrollCategoryItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Memo	String	False		Memo text for the object.
HoursPerPayFrequency	Decimal	True		Hours worked in a pay period.
PayFrequency	String	True		Pay frequency can consist of the following: Weekly, Fortnightly, TwiceAMonth, Monthly.
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.
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.
EmployeeID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned employee contact.
EmployeeDisplayID	String	True		Customer contact Card ID, can also be used as a unique employee contact identifier.
EmployeeName	String	True		Name of the employee contact.
EmployeeURI	String	True		Uniform resource identifier associated with the employee contact object.
PayrollDetailsID	Uuid	True	EmployeePayrollDetails.ID	Unique identifier in the form of a guid.
PayrollDetailsURI	String	True		Uniform resource identifier associated with the object.
PayrollCategories	String	False		All payroll categories linked to the employee contact, includes all payroll categories of type Wage.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

InventoryAdjustments

Return, update, create and delete inventory adjustments 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, InventoryJournalNumber, Date, IsYearEndAdjustment, Memmo, CategoryID, CategoryDisplayID, CategoryName. All the other columns and operators are processed client side.

SELECT * FROM InventoryAdjustments WHERE ID = "10f623a6-1638-4970-afd5-0394191bf015"
SELECT * FROM InventoryAdjustments WHERE InventoryJournalNumber = "IJ000001"
SELECT * FROM InventoryAdjustments WHERE IsYearEndAdjustment = True

Update

To update an existing inventory adjustment, along with its Lines, 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 InventoryAdjustmentItems#TEMP (Quantity, AccountID, ItemID, LocationID, RowID, RowVersion) VALUES (500, "2e653a1a-dafe-4e81-a553-f9a56ed3d105", "d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda", "04ad68a3-91f5-4739-8b83-13f86ecd2e33", 656, "8733325201913151488")
UPDATE InventoryAdjustments SET InventoryJournalNumber = "IJ000002", Lines = "InventoryAdjustmentItems#TEMP" WHERE ID = "10f623a6-1638-4970-afd5-0394191bf015"

Insert

The following attributes are required when performing an insert: Date.

INSERT INTO InventoryAdjustments (Date, InventoryJournalNumber, IsYearEndAdjustment) VALUES ("01/01/2023", "IJ000003", False)

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
InventoryJournalNumber	String	False		Inventory journal number, if left null when posting a number will automatically be assigned and incremented based upon last recorded.
Date	Datetime	False		The date of the entry.
IsYearEndAdjustment	Boolean	False		True indicates the transaction is a YearEndAdjustment. False indicates the transaction is not a YearEndAdjustment.
Memo	String	False		Memo text for the 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.
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.
Lines	String	False		An array of spend money line information.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ItemPriceMatrices

Return and update the item price matrix for multiple customer selling prices.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, ItemID, ItemName, ItemNumber. All the other columns and operators are processed client side.

SELECT * FROM ItemPriceMatrices WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM ItemPriceMatrices WHERE ItemName = "item name"

Update

To update an existing item price matrix, along with its SellingPrices, either pass a JSON string to the SellingPrices value or use a temporary table like below. Note: this will replace all the current SellingPrices with the ones below.

INSERT INTO ItemSellingPrices#TEMP (quantityover, levelA, LevelB) VALUES (10, 11.5, 12.7)
UPDATE ItemPriceMatrices SET SellingPrices = "ItemSellingPrices#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
ItemID	Uuid	True	Items.ID	Unique identifier in the form of a guid.
ItemName	String	True		Name of the item.
ItemNumber	String	True		The number assigned to the item.
ItemURI	String	True		Uniform resource identifier associated with the item.
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.
SellingPrices	String	False		An array of selling price information.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Items

Return, update, create and delete inventory items 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, AverageCost, BaseSellingPrice, IsActive, IsBought, IsInventoried, IsSold, Name, Number, CurrentValue, Description, UseDescription, AssetAccountID, AssetAccountDisplayID, AssetAccountName, BuyingUnitOfMeasure, BuyingItemsPerBuyingUnit, BuyingLastPurchasePrice, BuyingStandardCost, RestockingSupplierID, RestockingSupplierDisplayID, RestockingSupplierItemNumber, RestockingSupplierName, RestockingDefaultOrderQuantity, RestockingMinimumLevelForRestockingAlert, BuyingTaxCodeID, BuyingTaxCodeCode, CostOfSalesAccountID, CostOfSalesAccountDisplayID, CostOfSalesAccountName, IncomeAccountID, IncomeAccountDisplayID, IncomeAccountName, ExpenseAccountID, ExpenseAccountDisplayID, ExpenseAccountName, QuantityAvailable, QuantityCommitted, QuantityOnHand, QuantityOnOrder, SellingBaseSellingPrice, SellingCalculateSalesTaxOn, SellingIsTaxInclusive, SellingItemsPerSellingUnit, SellingUnitOfMeasure, SellingTaxCodeID, SellingTaxCodeCode. All the other columns and operators are processed client side.

SELECT * FROM Items WHERE ID = "d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda" OR ID = "59aa54c8-6793-4a63-bda9-55451fa3976e"
SELECT * FROM Items WHERE AverageCost = 21.38 OR BaseSellingPrice = 11.95
SELECT * FROM Items WHERE IsActive = true

Insert

The following attribute is required when performing an insert: Number.

INSERT INTO Items (Number) VALUES ("429")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
AverageCost	Decimal	True		Item's average cost when the quantity on hand is equal to or greater than zero.
BaseSellingPrice	Decimal	True		Item's base selling price inclusive of tax.
IsActive	Boolean	False		Please note: Defaults to true if left blank on POST. True indicates the item is active. False indicates the item is inactive.
IsBought	Boolean	False		True indicates the item is bought. False indicates the item is not bought.
IsInventoried	Boolean	False		True indicates the item is inventoried. False indicates the item is not inventoried.
IsSold	Boolean	False		True indicates the item is sold. False indicates the item is not sold.
Name	String	False		Name of the object.
Number	String	False		Item number.
PhotoURI	String	False		Uniform resource identifier associated with a photo image.
PriceMatrixURI	String	False		Please note: Only available if Item IsSold = true.
CurrentValue	Decimal	True		Dollar value of units held in inventory.
Description	String	False		Description of the object.
UseDescription	Boolean	False		True indicates to use the description text instead of item name on sale invoices and purchase orders. False indicates not to use the item description on sales and purchases.
AssetAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
AssetAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
AssetAccountName	String	True		Name of the account.
AssetAccountURI	String	True		Uniform resource identifier associated with the account object.
BuyingUnitOfMeasure	String	False		Description of the unit type the item is purchased with, ie: kg, hour.
BuyingItemsPerBuyingUnit	Decimal	False		Number of items per buying unit. Note: if is IsInventoried = false null is returned.
BuyingLastPurchasePrice	Decimal	True		The item's tax inclusive price per unit when last purchased.
BuyingStandardCost	Decimal	False		Standard purchase price for one buying unit of this item.
RestockingSupplierID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned supplier contact.
RestockingSupplierDisplayID	String	True		Customer contact Card ID, can also be used as a unique supplier contact identifier.
RestockingSupplierItemNumber	String	False		Number or code supplier has assigned to the item.
RestockingSupplierName	String	True		Name of the supplier contact.
RestockingSupplierURI	String	True		Uniform resource identifier associated with the supplier contact object.
RestockingDefaultOrderQuantity	Integer	True		Default number of units to buy on auto reorder.
RestockingMinimumLevelForRestockingAlert	Integer	True		The minimum number of items on hand before needing to reorder.
BuyingTaxCodeID	Uuid	False	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
BuyingTaxCodeCode	String	True		3 digit tax code.
BuyingTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
CostOfSalesAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
CostOfSalesAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
CostOfSalesAccountName	String	True		Name of the account.
CostOfSalesAccountURI	String	True		Uniform resource identifier associated with the account object.
IncomeAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
IncomeAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
IncomeAccountName	String	True		Name of the account.
IncomeAccountURI	String	True		Uniform resource identifier associated with the account object.
ExpenseAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
ExpenseAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
ExpenseAccountName	String	True		Name of the account.
ExpenseAccountURI	String	True		Uniform resource identifier associated with the account object.
QuantityAvailable	Decimal	True		Calculated quantity of the item available for sale.
QuantityCommitted	Decimal	True		Quantity of the item held in pending sale invoices.
QuantityOnHand	Decimal	True		Quantity of units held in inventory.
QuantityOnOrder	Decimal	True		Quantity of the item held in pending purchase orders.
SellingBaseSellingPrice	Decimal	True		Standard selling price for one selling unit of this item.
SellingCalculateSalesTaxOn	String	True		ONLY APPLICABLE FOR AU REGION. Sales tax can be calculated on any of the following Enum values: ActualSellingPrice, BaseSellingPrice, LevelA, LevelB, LevelC, LevelD, LevelE, LevelF.
SellingIsTaxInclusive	Boolean	True		True indicates the selling prices are inclusive of tax. False indicates the selling prices are exclusive of tax.
SellingItemsPerSellingUnit	Integer	True		Number of items per selling unit. Note: if is IsInventoried = false null is returned.
SellingUnitOfMeasure	String	True		Description of the unit type the item is sold as, ie: kg, hour.
SellingTaxCodeID	Uuid	False	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
SellingTaxCodeCode	String	True		3 digit tax code.
SellingTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
CustomField1Label	String	True		Custom Field 1 label.
CustomField1Value	String	True		Custom Field 1 value.
CustomField2Label	String	True		Custom Field 2 label.
CustomField2Value	String	True		Custom Field 2 value.
CustomField3Label	String	True		Custom Field 3 label.
CustomField3Value	String	True		Custom Field 3 value.
CustomList1Label	String	True		Custom List 1 label.
CustomList1Value	String	True		Custom List 1 value.
CustomList2Label	String	True		Custom List 2 label.
CustomList2Value	String	True		Custom List 2 value.
CustomList3Label	String	True		Custom List 3 label.
CustomList3Value	String	True		Custom List 3 value.
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.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

JobBudgets

Return and update job budgets.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, JobID, JobName, JobNumber. All the other columns and operators are processed client side.

SELECT * FROM JobBudgets WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM JobBudgets WHERE JobName = "job name"

Update

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

INSERT INTO JobBudgetItems#TEMP (Amount, AccountID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f")
UPDATE JobBudgets SET Budgets = "JobBudgetItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	False		Unique identifier in the form of a guid.
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.
JobID	Uuid	False	Jobs.ID	Unique job identifier in the form of a guid.
JobName	String	True		Name assigned to the job.
JobNumber	String	True		Number assigned to the job.
JobURI	String	True		Uniform resource identifier associated with the job object.
Budgets	String	False		An array of job budget information.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Jobs

Return, update, create and delete a job 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Contact, Description, StartDate, FinishDate, IsActive, IsHeader, Manager, Name, Number, PercentComplete, StartDate, TrackReimbursables, LinkedCustomerID, LinkedCustomerDisplayID, LinkedCustomerName, LinkedCustomerUri, ParentJobID, ParentJobName, ParentJobNumber, ParentJobUri. All the other columns and operators are processed client side.

SELECT * FROM Jobs WHERE ID = "797755431-e8d1-411f-9859-5ff2a54f97d9"
SELECT * FROM Jobs WHERE Number = "125" OR Name = "Supply of Coolers FH"
SELECT * FROM Jobs WHERE ParentJobNumber = "120"

Insert

The following attribute is required when performing an insert: Number.

INSERT INTO Jobs (Number) VALUES ("429")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Contact	String	False		Contact for the job.
Description	String	False		Description of the object.
StartDate	Datetime	False		Date the job was started.
FinishDate	Datetime	False		Date the job was completed.
IsActive	Boolean	False		Defaults to true if left blank on POST.
IsHeader	Boolean	False		Defaults to true if left blank on POST.
Manager	String	False		Manager of the job.
Name	String	False		Name of the object.
Number	String	False		Number assigned to the job.
PercentComplete	Double	False		% of the job completed.
LastModified	Datetime	True		Date the job was Modified.
TrackReimbursables	Boolean	False		True indicates a job is used to track reimbursable expenses. False indicates a job is not used to track reimbursable expenses.
LinkedCustomerID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned customer contact.
LinkedCustomerDisplayID	String	True		Customer contact Card ID, can also be used as a unique customer contact identifier.
LinkedCustomerName	String	True		Name of the customer contact.
LinkedCustomerUri	String	True		Uniform resource identifier associated with the customer contact object.
ParentJobID	Uuid	False	Jobs.ID	Unique job identifier in the form of a guid.
ParentJobName	String	True		Name assigned to the job.
ParentJobNumber	String	True		Number assigned to the job.
ParentJobUri	String	True		Uniform resource identifier associated with the job object.
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.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Journals

Return, update, create and delete general journal 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, DateOccurred, DisplayID, GSTReportingMethod, IsTaxInclusive, IsYearEndAdjustment, Memo, CategoryID, CategoryDisplayID, CategoryName, Uri. All the other columns and operators are processed client side.

SELECT * FROM Journals WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM Journals WHERE CategoryID = "6cbbea25-6256-4df4-bb37-17eb2d21f803
SELECT * FROM Journals WHERE GSTReportingMethod = "Purchase"

Insert

The following attribute is required when performing an insert: DateOccurred, Lines.

To insert an existing journal, along with its Lines, either pass a JSON string to the Lines value or use a temporary table like below.

INSERT INTO JournalItems#TEMP (AccountID, TaxcodeID, Amount, IsCredit) VALUES ("d3f55ef1-ce77-4ef2-a415-61d04db2c5fc", "e1e27d8e-f89d-451d-97c8-e0c3c1716a91", 11.23, true)
INSERT INTO JournalItems#TEMP (AccountID, TaxcodeID, Amount, IsCredit) VALUES ("d3f55ef1-ce77-4ef2-a415-61d04db2c5fc", "e1e27d8e-f89d-451d-97c8-e0c3c1716a91", 11.23, false)
INSERT INTO Journals (DateOccurred, Lines) VALUES ("2018-03-04", "JournalItems#TEMP")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
DateOccurred	Datetime	False		Transaction date entry.
DisplayID	String	False		Display ID for the object.
GSTReportingMethod	String	False		Reporting Method used on the general journal transaction which accepts the following: Sale (Supply), Purchase (Acquisition).
IsTaxInclusive	Boolean	False		True indicates the transaction default status is set to tax inclusiv.e False indicates the transaction status is not tax inclusive.
IsYearEndAdjustment	Boolean	False		True indicates the transaction is a YearEndAdjustmen.t False indicates the transaction is not a YearEndAdjustment.
Memo	String	False		Header memo of the general journal entry.
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.
ForeignCurrencyID	Uuid	False		Uniform identifier for the currency in the form of the guid.
ForeignCurrencyCode	String	True		The currency code.
ForeignCurrencyName	String	True		The full name of the currency.
ForeignCurrencyURI	String	True		Uniform resource identifier associated with the currency object.
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.
Lines	String	False		An array of line item information.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PayrollWages

Return, update, create and delete payroll categories of type wage 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Name, StpCategory, Type, WageType, PayRate, FixedHourlyRate, AutomaticallyAdjustBaseAmounts, RegularRateMultiplier, OverriddenWagesExpenseAccountID, OverriddenWagesExpenseAccountName, OverriddenWagesExpenseAccountNumber. All the other columns and operators are processed client side.

SELECT * FROM PayrollWages WHERE ID = "e57725b2-c4f0-47ce-8103-299c7a675112"
SELECT * FROM PayrollWages WHERE Name = "Base Hourly"
SELECT * FROM PayrollWages WHERE StpCategory = "NotReportable" OR Type = "Wage"

Insert

The following attribute is required when performing an insert: WageType, Name.

INSERT INTO PayrollWages (WageType, Name) VALUES ("Salary", "Example salary")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Name	String	False		Name of the wage category.
StpCategory	String	False		STP Category for this payroll category. See MYOB help for more info. Valid values are: NotReportable (default), GrossPayments, PAYGWithholding, ExemptForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type	String	True		Indicates the type of payroll category ie: Wage, Expense, Deduction.
WageType	String	True		Indicates whether the wage category is a salary type or an hourly type. Use either Hourly or Salary
PayRate	String	True		How to calculate the rate, can be either RegularRate or FixedHourly.
FixedHourlyRate	Decimal	False		Fixed hourly rate for all employees linked to this wage category if PayRate = FixedHourly, otherwise null.
AutomaticallyAdjustBaseAmounts	Boolean	False		When entering leave amounts on a pay, base hourly or base salary amount will automatically be adjusted if set to True.
RegularRateMultiplier	Decimal	False		Calculate as a multiple of the hourly rate setup on each employee's card if PayRate = RegularRate, otherwise null.
OverriddenWagesExpenseAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
OverriddenWagesExpenseAccountName	String	True		Name of the account.
OverriddenWagesExpenseAccountNumber	String	True		Account code format includes separator ie 6-1200.
OverriddenWagesExpenseAccountURI	String	True		Uniform resource identifier associated with the account object.
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.
Exemptions	String	False		An array of tax and deductions this wage category is exempt from.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PurchaseBills

Return all purchase bill types 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, AppliedToDate, BalanceDueAmount, BillDeliveryStatus, Comment, Date, Freight, IsReportable, IsTaxInclusive, JournalMemo, Number, ShipToAddress, ShippingMethod, Status, Subtotal, TotalAmount, TotalTax, SupplierInvoiceNumber, CategoryID, CategoryDisplayID, CategoryName, FreightTaxCodeID, FreightTaxCodeCode, OrderID, OrderNumber, SupplierID, SupplierDisplayID, SupplierName, TermsBalanceDueDate, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsPaymentIsDue, TermsMonthlyChargeForLatePayment. All the other columns and operators are processed client side. BillType supports only equality comparison.

SELECT * FROM PurchaseBills WHERE ID = REPLACE
SELECT * FROM PurchaseBills WHERE AppliedToDate = 20
SELECT * FROM PurchaseBills WHERE BalanceDueAmount = 45.86163291317715

Update

To update an existing bill, along with its Lines, 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 PurchaseBillItems#TEMP (Total, AccountID, TaxCodeID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE PurchaseBills SET BillType = "Service", Lines = "PurchaseBillItems#TEMP" WHERE ID = "f979f0e7-1cd8-4fb9-b2c2-9d4546440cf7"

Insert

The following attributes are required when performing an insert: BillType, Date, FreightTaxCodeID, SupplierID.

INSERT INTO PurchaseBills (BillType, Date, FreightTaxCodeID, SupplierID) VALUES ("Item", "01/01/2019", "446d2226-254b-4821-acc2-7031842e0166", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
AppliedToDate	Decimal	True		Amount currently applied to the purchase bill.
BalanceDueAmount	Decimal	True		Amount still payable on the purchase bill.
BillDeliveryStatus	String	False		Bill delivery status assigned: Print = ToBePrinted, Email = ToBeEmailed, PrintAndEmail = ToBePrintedAndEmailed, Nothing = AlreadyPrintedOrSent.
BillType	String	False		Type of the bill. One of: Item,Service,Professional,Miscellaneous.
Comment	String	False		Purchase bill comment.
Date	Datetime	False		The date of the entry.
Freight	Decimal	False		Tax inclusive freight amount applicable to the purchase bill.
IsReportable	Boolean	False		ONLY applicable for AU region. True indicates the transaction is reportable taxable payment. Falseindicates the transaction is not reportable taxable payment.
IsTaxInclusive	Boolean	False		True indicates the transaction is set to tax inclusive. False indicates the transaction is not tax inclusive.
JournalMemo	String	False		Memo text for the object.
Number	String	False		Purchase bill number.
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.
ShipToAddress	String	False		ShipTo address of the purchase bill.
ShippingMethod	String	False		Shipping method text.
Status	String	True		Bill status: Open, Closed, Debit.
Subtotal	Decimal	True		If IsTaxInclusive = false then sum of all tax exclusive line amounts. If IsTaxInclusive = true then sum of all tax inclusive line amounts.
TotalAmount	Decimal	True		Total amount of the purchase bill.
TotalTax	Decimal	True		Total of all tax amounts applicable to the purchase bill.
SupplierInvoiceNumber	String	False		Supplier invoice number.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
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.
FreightTaxCodeID	Uuid	False	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
FreightTaxCodeCode	String	True		3 digit tax code.
FreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
OrderID	Uuid	False	PurchaseOrders.ID	Unique identifier in the form of a guid.
OrderNumber	String	True		The order number.
OrderURI	String	True		Uniform resource identifier associated with the order.
SupplierID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned supplier contact.
SupplierDisplayID	String	True		Customer contact Card ID, can also be used as a unique supplier contact identifier.
SupplierName	String	True		Name of the supplier contact.
SupplierURI	String	True		Uniform resource identifier associated with the supplier contact object.
TermsBalanceDueDate	Integer	False		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer has to pay invoices. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to pay invoices.
TermsDiscount	Decimal	True		Discount amount that will apply if payment is made in full by the discount date.
TermsDiscountDate	Integer	True		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer must pay to receive discounts. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
TermsDiscountExpiryDate	Datetime	True		Date in which payment must be paid in full in quote to receive discount.
TermsDiscountForEarlyPayment	Double	True		% discount for early payment.
TermsDueDate	Datetime	True		Date in which payment is due.
TermsPaymentIsDue	String	False		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
TermsMonthlyChargeForLatePayment	Double	False		% monthly charge for late payment.
Lines	String	False		An array of line bill information.
PromisedDate	Datetime	False		Transaction Promised Date.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PurchaseOrders

Return all purchase order types 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, AppliedToDate, Date, Freight, BalanceDueAmount, IsReportable, IsTaxInclusive, JournalMemo, Number, ShipToAddress, Status, SupplierInvoiceNumber, Subtotal, TotalAmount, TotalTax, CategoryID, CategoryDisplayID, CategoryName, FreightTaxCodeID, FreightTaxCodeCode, SupplierID, SupplierDisplayID, SupplierName, TermsBalanceDueDate, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsPaymentIsDue. All the other columns and operators are processed client side. OrderType supports only equality comparison.

SELECT * FROM PurchaseOrders WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
SELECT * FROM PurchaseOrders WHERE AppliedToDate = 40
SELECT * FROM PurchaseOrders WHERE OrderType = "Service"

Update

To update an existing order, along with its Lines, 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 PurchaseOrderItems#TEMP (Total, AccountID, TaxCodeID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE PurchaseOrders SET OrderType = "Service", Lines = "PurchaseOrderItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"

Insert

The following attributes are required when performing an insert: OrderType, Date, FreightTaxCodeID, SupplierID.

INSERT INTO PurchaseOrders (OrderType, Date, FreightTaxCodeID, SupplierID) VALUES ("Service", "01/01/2019", "446d2226-254b-4821-acc2-7031842e0166", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
AppliedToDate	Double	True		Amount currently applied to the purchase order.
Date	Datetime	False		The date of the entry.
Freight	Decimal	False		Tax inclusive freight amount applicable to the purchase order.
BalanceDueAmount	Decimal	True		Amount still payable on the purchase order.
IsReportable	Boolean	False		ONLY applicable for AU region. True indicates the transaction is reportable taxable payment. Falseindicates the transaction is not reportable taxable payment.
IsTaxInclusive	Boolean	False		True indicates the transaction is set to tax inclusive. False indicates the transaction is not tax inclusive.
JournalMemo	String	False		Memo text for the object.
Number	String	False		Purchase order number.
OrderType	String	False		Type of the order. One of: Item,Service,Professional,Miscellaneous
ShipToAddress	String	False		ShipTo address of the purchase order.
Status	String	True		Purchase Order status: Open, ConvertedToBill.
SupplierInvoiceNumber	String	False		Supplier invoice number.
Subtotal	Decimal	True		If IsTaxInclusive = false then sum of all tax exclusive line amounts. If IsTaxInclusive = true then sum of all tax inclusive line amounts.
TotalAmount	Decimal	True		Total amount of the purchase order.
TotalTax	Decimal	True		Total of all tax amounts applicable to the purchase order.
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.
CategoryID	Uuid	True		Unique category identifier in the form of a guid.
CategoryDisplayID	String	False		Display id for the category.
CategoryName	String	True		Name of the category.
CategoryURI	String	True		Uniform resource identifier associated with the category object.
FreightTaxCodeID	Uuid	True	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
FreightTaxCodeCode	String	False		3 digit tax code.
FreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
Comment	String	False		Purchase Order Comment
ShippingMethod	String	False		Shipping Method
PromisedDate	Datetime	False		Transaction Promised Date.
SupplierID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned supplier contact.
SupplierDisplayID	String	True		Customer contact Card ID, can also be used as a unique supplier contact identifier.
SupplierName	String	True		Name of the supplier contact.
SupplierURI	String	True		Uniform resource identifier associated with the supplier contact object.
TermsBalanceDueDate	Integer	False		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer has to pay invoices. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to pay invoices.
TermsDiscount	Decimal	True		Discount amount that will apply if payment is made in full by the discount date.
TermsDiscountDate	Integer	True		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer must pay to receive discounts. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
TermsDiscountExpiryDate	Datetime	True		Date in which payment must be paid in full in quote to receive discount.
TermsDiscountForEarlyPayment	Double	True		% discount for early payment.
TermsDueDate	Datetime	True		Date in which payment is due.
TermsPaymentIsDue	String	False		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
Lines	String	False		An array of line order information.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ReceivingTransactions

Return, update, create and delete receive 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, AmountReceived, ContactDisplayID, Date, DepositTo, IsTaxInclusive, Memo, PaymentMethod, ReceiptNumber, TotalTax, AccountID, AccountDisplayID, AccountName, CategoryID, CategoryDisplayID, CategoryName, ContactID, ContactName, ContactType. All the other columns and operators are processed client side.

SELECT * FROM ReceivingTransactions WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM ReceivingTransactions WHERE AmountReceived = 12.45
SELECT * FROM ReceivingTransactions WHERE Memo = "memo"

Update

To update an existing transaction, along with its Lines, 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 ReceivingTransactionItems#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 = "ReceivingTransactionItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"

Insert

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

INSERT INTO ReceivingTransactions (Date, DepositTo, Memo, AccountID, ContactID) VALUES ("01/01/2019", "Account", "memo", "91e0769a-bdd1-4402-8e4f-95b7743bd733", "4635fd9e-82a7-4612-ae15-32c464ef7c48")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
AmountReceived	Double	True		The amount received.
ContactDisplayID	String	True		Contact Card ID, can also be used as a unique contact identifier.
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.
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.
PaymentMethod	String	False		Payment methods must exist in company file, default methods consist of the following: American Express, Bank Card, Barter Card, Cash, Cheque, Diners Club, EFTPOS, MasterCard, Money Order, Other, Visa.
ReceiptNumber	String	False		ID No of payment transaction, if left blank on POST will auto increment based upon last recorded #.
TotalTax	Double	True		Total of all tax amounts applicable to the receive 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	Accounts.ID	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	Contacts.ID	Unique identifier in the form of a guid.
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 receive money line information.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SaleInvoices

Return all sale invoice types 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, BalanceDueAmount, Comment, Date, InvoiceDeliveryStatus, IsTaxInclusive, JournalMemo, LastPaymentDate, Number, PromisedDate, ReferralSource, ShipToAddress, ShippingMethod, Status, Subtotal, Freight, TotalTax, TotalAmount, CustomerPurchaseOrderNumber, CategoryID, CategoryDisplayID, CategoryName, SalespersonID, SalespersonDisplayID, SalespersonName, CustomerID, CustomerDisplayID, CustomerName, FreightTaxCodeID, FreightTaxCodeCode, OrderID, OrderNumber, TermsBalanceDueDate, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsFinanceCharge, TermsMonthlyChargeForLatePayment, TermsPaymentIsDue. All the other columns and operators are processed client side. InvoiceType supports only equality comparison.

SELECT * FROM SaleInvoices WHERE ID = "fa024423-e61a-44cd-8a8b-4d52a2f9fc04"
SELECT * FROM SaleInvoices WHERE BalanceDueAmount = 24.3766206457717
SELECT * FROM SaleInvoices WHERE Comment = "commect"
SELECT * FROM SaleInvoices WHERE InvoiceType = "Service"

Update

To update an existing invoice, along with its Lines, 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 PurchaseOrderItems#TEMP (Total, AccountID, TaxCodeID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE PurchaseOrders SET InvoiceType = "Service", Lines = "PurchaseOrderItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"

Insert

The following attributes are required when performing an insert: InvoiceType, Date, CustomerID.

INSERT INTO SaleInvoices (InvoiceType, Date, CustomerID) VALUES ("item", "01/01/2019", "4635fd9e-82a7-4612-ae15-32c464ef7c48")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
BalanceDueAmount	Decimal	True		Amount still payable on the sale invoice.
Comment	String	False		Sale invoice comment.
Date	Datetime	False		The date of the entry.
InvoiceDeliveryStatus	String	False		Invoice delivery status assigned: Print = ToBePrinted, Email = ToBeEmailed, PrintAndEmail = ToBePrintedAndEmailed, Nothing = AlreadyPrintedOrSent.
InvoiceType	String	False		Type of the invoice. One of: Item,Service,Professional,TimeBilling,Miscellaneous.
IsTaxInclusive	Boolean	False		True indicates the transaction is tax inclusive with Total values to be keyed in tax-inclusive. False indicates the transaction is not tax inclusive with Total values to be keyed in tax-exclusive.
JournalMemo	String	False		Memo text for the object.
LastPaymentDate	Datetime	True		The date of the entry.
LastModified	Datetime	True		LastModified date of the entry.
Number	String	False		Sale invoice number.
PromisedDate	Datetime	False		The date of the entry.
ReferralSource	String	False		Referral Source selected on the sale invoice.
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.
ShipToAddress	String	False		ShipTo address of the sale invoice.
ShippingMethod	String	False		Shipping method text.
Status	String	True		Invoice status: Open, Closed, Credit.
Subtotal	Decimal	True		If IsTaxInclusive = false then sum of all tax exclusive line amounts. If IsTaxInclusive = true then sum of all tax inclusive line amounts.
Freight	Decimal	True		Freight applicable to the sale invoice.
TotalTax	Decimal	True		Total of all tax amounts applicable to the sale invoice.
TotalAmount	Decimal	True		Total amount of the sale invoice.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
CustomerPurchaseOrderNumber	String	False		Customer PO number.
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.
SalespersonID	Uuid	False	Contacts.ID	Unique identifier in the form of a guid.
SalespersonDisplayID	String	True		Employee contact Card ID.
SalespersonName	String	True		Selected employee contact name.
SalespersonURI	String	True		Uniform resource identifier associated with the employee.
CustomerID	Uuid	False	Contacts.ID	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.
FreightTaxCodeID	Uuid	False	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
FreightTaxCodeCode	String	True		3 digit tax code.
FreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code object.
OrderID	Uuid	False	PurchaseOrders.ID	Unique identifier in the form of a guid.
OrderNumber	String	True		The order number.
OrderURI	String	True		Uniform resource identifier associated with the order.
TermsBalanceDueDate	Integer	False		The date of the entry.
TermsDiscount	Decimal	True		Discount amount that will apply if payment is made in full by the discount date.
TermsDiscountDate	Integer	True		The date of the entry.
TermsDiscountExpiryDate	Datetime	True		The date of the entry.
TermsDiscountForEarlyPayment	Double	False		% discount for early payment.
TermsDueDate	Datetime	True		The date of the entry.
TermsFinanceCharge	Decimal	False		Late payment fee to be charged if payment is not made in full by the due date.
TermsMonthlyChargeForLatePayment	Double	False		% monthly charge for late payment.
TermsPaymentIsDue	String	False		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
Lines	String	False		An array of line invoice information.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SaleOrders

Returns all sale order types 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, AppliedToDate, BalanceDueAmount, Date, IsTaxInclusive, JournalMemo, Number, ReferralSource, Status, Subtotal, TotalAmount, TotalTax, LastPaymentDate, CustomerID, CustomerDisplayID, CustomerName, Freight, FreightTaxCodeCode, FreightTaxCodeID, CategoryID, CategoryDisplayID, CategoryName, SalespersonID, SalespersonDisplayID, SalespersonName, TermsBalanceDueDate, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsFinanceCharge, TermsMonthlyChargeForLatePayment, TermsPaymentIsDue. All the other columns and operators are processed client side. OrderType supports only equality comparison.

SELECT * FROM SaleOrders WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
SELECT * FROM SaleOrders WHERE BalanceDueAmount = 13
SELECT * FROM SaleOrders WHERE IsTaxInclusive = true

Update

To update an existing order, along with its Lines, 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 SaleOrderItems#TEMP (Total, AccountID, TaxCodeID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE SaleOrders SET OrderType = "Service", Lines = "SaleOrderItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"

Insert

The following attribute is required when performing an insert: OrderType, CustomerID.

INSERT INTO SaleOrders (OrderType, CustomerID) VALUES ("item", "4635fd9e-82a7-4612-ae15-32c464ef7c48")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
AppliedToDate	Decimal	True		The date of the entry.
BalanceDueAmount	Decimal	True		Amount still payable on the sales order.
Date	Datetime	True		The date of the entry.
IsTaxInclusive	Boolean	False		True indicates the transaction is set to tax inclusive. False indicates the transaction is not tax inclusive.
JournalMemo	String	False		Memo text for the object.
Number	String	False		Sales Order number.
OrderType	String	False		Type of the order. One of: Item,Service,Professional,TimeBilling,Miscellaneous.
ReferralSource	String	False		Referral Source selected on the sale order.
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.
Status	String	True		Order status can consist of the following: Open, ConvertedToInvoice.
Subtotal	Decimal	True		If IsTaxInclusive = false then sum of all tax exclusive line amounts. If IsTaxInclusive = true then sum of all tax inclusive line amounts.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
TotalAmount	Decimal	True		Total amount of the sale order.
TotalTax	Decimal	True		Total of all tax amounts applicable to the sale order.
LastPaymentDate	String	True		The date of the entry.
CustomerID	Uuid	False	Contacts.ID	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.
Freight	Decimal	False		Tax inclusive freight amount applicable to the sale order.
FreightTaxCodeCode	String	True		3 digit tax code.
FreightTaxCodeID	Uuid	True	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
FreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code 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.
SalespersonID	Uuid	False	Contacts.ID	Unique identifier in the form of a guid.
SalespersonDisplayID	String	True		Employee contact Card ID.
SalespersonName	String	True		Selected employee contact name.
SalespersonURI	String	True		Uniform resource identifier associated with the employee.
TermsBalanceDueDate	Integer	False		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer has to pay invoices. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to pay invoices.
TermsDiscount	Decimal	True		Discount amount that will apply if payment is made in full by the discount date.
TermsDiscountDate	Integer	True		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer must pay to receive discounts. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
TermsDiscountExpiryDate	Datetime	True		Date in which payment must be paid in full in quote to receive discount.
TermsDiscountForEarlyPayment	Double	False		% discount for early payment.
TermsDueDate	Datetime	True		Date in which payment is due.
TermsFinanceCharge	Decimal	False		Late payment fee to be charged if payment is not made in full by the due date.
TermsMonthlyChargeForLatePayment	Double	False		% monthly charge for late payment.
TermsPaymentIsDue	String	False		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
Lines	String	False		An array of sale line order information.
CustomerPurchaseOrderNumber	String	False		Customer PO number.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SaleQuotes

Return all sale quote types 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, BalanceDueAmount, Date, IsTaxInclusive, JournalMemo, Number, ReferralSource, Subtotal, TotalAmount, TotalTax, CustomerPurchaseOrderNumber, CustomerID, CustomerDisplayID, CustomerName, Freight, FreightTaxCodeID, FreightTaxCodeCode, CategoryID, CategoryDisplayID, CategoryName, SalespersonID, SalespersonDisplayID, SalespersonName, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsFinanceCharge, TermsMonthlyChargeForLatePayment, TermsPaymentIsDue, TermsBalanceDueDate. All the other columns and operators are processed client side. QuoteType supports only equality comparison.

SELECT * FROM SaleQuotes WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM SaleQuotes WHERE BalanceDueAmount = 13
SELECT * FROM SaleQuotes WHERE QuoteType = "Service"

Update

To update an existing bill, along with its Lines, 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 SaleQuoteItems#TEMP (Total, AccountID, TaxCodeID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE PurchaseBills SET QuoteType = "Service", Lines = "SaleQuoteItems#TEMP" WHERE ID = "f979f0e7-1cd8-4fb9-b2c2-9d4546440cf7"

Insert

The following attribute is required when performing an insert: QuoteType, CustomerID.

INSERT INTO SaleQuotes (QuoteType, CustomerID) VALUES ("item", "4635fd9e-82a7-4612-ae15-32c464ef7c48")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
BalanceDueAmount	Decimal	True		Amount still payable on the sales quote.
Date	Datetime	True		The date of the entry.
IsTaxInclusive	Boolean	False		True indicates the transaction is set to tax inclusive. False indicates the transaction is not tax inclusive.
JournalMemo	String	False		Journal memo text describing the sale.
Number	String	False		Sales Quote number.
QuoteType	String	False		Type of the quote. One of: Item,Service,Professional,TimeBilling,Miscellaneous.
ReferralSource	String	False		Referral Source selected on the sale quote.
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.
Subtotal	Decimal	True		If IsTaxInclusive = false then sum of all tax exclusive line amounts. If IsTaxInclusive = true then sum of all tax inclusive line amounts.
TotalAmount	Decimal	True		Total amount of the sale quote.
TotalTax	Decimal	True		Total of all tax amounts applicable to the sale quote.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
CustomerPurchaseOrderNumber	String	False		Customer PO number.
CustomerID	Uuid	False	Contacts.ID	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.
Freight	Decimal	False		Tax inclusive freight amount applicable to the sale quote.
FreightTaxCodeID	Uuid	True	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
FreightTaxCodeCode	String	True		3 digit tax code.
FreightTaxCodeURI	String	True		Uniform resource identifier associated with the tax code 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.
SalespersonID	Uuid	False	Contacts.ID	Unique identifier in the form of a guid.
SalespersonDisplayID	String	True		Employee contact Card ID.
SalespersonName	String	True		Selected employee contact name.
SalespersonURI	String	True		Uniform resource identifier associated with the employee.
TermsDiscount	Decimal	True		Discount amount that will apply if payment is made in full by the discount date.
TermsDiscountDate	Integer	False		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer must pay to receive discounts. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to receive discounts.
TermsDiscountExpiryDate	Datetime	True		Date in which payment must be paid in full in quote to receive discount.
TermsDiscountForEarlyPayment	Double	False		% discount for early payment.
TermsDueDate	Datetime	True		Date in which payment is due.
TermsFinanceCharge	Decimal	True		Late payment fee to be charged if payment is not made in full by the due date.
TermsMonthlyChargeForLatePayment	Double	False		% monthly charge for late payment.
TermsPaymentIsDue	String	False		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
TermsBalanceDueDate	Integer	True		If PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber or NumberOfDaysAfterEOM then set the number of days within which the customer has to pay invoices. If PaymentIsDue = OnADayOfTheMonth or DayOfMonthAfterEOM then set the day of the month within which the payment must be made to pay invoices.
Lines	String	False		An array of sale line quote information.
Comment	String	False		Sales Quotes Comment
ShippingMethod	String	False		Shipping Method
PromisedDate	Datetime	False		Transaction Promised Date.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

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 criteria 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, 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	References	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	Accounts.ID	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	Contacts.ID	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	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SupplierPayments

Return, create and delete supplier payments 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 criteria 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, Date, DeliveryStatus, Memo, PayFrom, PayeeAddress, PaymentNumber, StatementParticulars, AccountID, AccountDisplayID, AccountName, SupplierID, SupplierDisplayID, SupplierName, ForeignCurrencyID, ForeignCurrencyCode, ForeignCurrencyName. All the other columns and operators are processed client side.

SELECT * FROM SupplierPayments WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM SupplierPayments WHERE Memo = "memo"
SELECT * FROM SupplierPayments WHERE AmountPaid = 46.502
SELECT * FROM SupplierPayments WHERE PayeeAddress = "WLJ Real Estate 555 High Street Chatswood NSW 2067 Australia"

Update

To update an existing payment, along with its Lines, 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 SupplierPaymentItems#TEMP (AmountApplied, PurchaseID) VALUES (444.21, " 0229a075-f93a-4b6c-85d7-0ffd5ba43982")
UPDATE SupplierPayments SET Lines = "supplierpaymentitems#TEMP" WHERE ID = "c3d2350b-733a-4140-8dda-ffa0f34d4297"

Insert

The following attributes are required when performing an insert: PayFrom, AccountID, SupplierID, Lines.

INSERT INTO SupplierPaymentItems#TEMP (amountapplied, purchaseid) VALUES (444.21, "415ffd17-9fb7-45b4-aeb1-3af0db11ff84")
INSERT INTO SupplierPayments (PayFrom, AccountId, SupplierId, Lines) VALUES ("Account", "c195ee7d-2954-42a6-8a19-6f362442bf89", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd", "SupplierPaymentItems#TEMP")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
AmountPaid	Double	False		Total of all amounts paid to the purchase bill/bills.
Date	Datetime	False		The date of the entry.
DeliveryStatus	String	False		Delivery status assigned to payment: Print = ToBePrinted, Email = ToBeEmailed, PrintAndEmail = ToBePrintedAndEmailed, Nothing = AlreadyPrintedOrSent.
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		Payee name and address of the supplier contact.
PaymentNumber	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.
StatementParticulars	String	False		ONLY applicable for Electronic Payments. Particulars attached to electronic payment.
URI	String	True		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
AccountID	Uuid	False	Accounts.ID	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.
SupplierID	Uuid	False	Contacts.ID	Unique guid identifier belonging to the assigned supplier contact.
SupplierDisplayID	String	True		Customer contact Card ID, can also be used as a unique supplier contact identifier.
SupplierName	String	True		Name of the supplier contact.
SupplierURI	String	True		Uniform resource identifier associated with the supplier contact object.
ForeignCurrencyID	Uuid	True	Currencies.ID	Unique identifier in the form of a guid.
ForeignCurrencyCode	String	True		The currency code.
ForeignCurrencyName	String	True		The full name of the currency.
ForeignCurrencyURI	String	True		Uniform resource identifier associated with the purchase.
Lines	String	False		An array of purchase bill/order line information
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

TaxCodes

Tax codes 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Code, Description, IsRateNegative, LuxuryCarTaxThreshold, Rate, Type, TaxCollectedAccountID, TaxCollectedAccountDisplayID, TaxCollectedAccountName, TaxPaidAccountID, TaxPaidAccountDisplayID, TaxPaidAccountName, WithholdingCreditAccountID, WithholdingCreditAccountDisplayID, WithholdingCreditAccountName, WithholdingPayableAccountID, WithholdingPayableAccountDisplayID, WithholdingPayableAccountName, ImportDutyPayableAccountID, ImportDutyPayableAccountDisplayID, ImportDutyPayableAccountName, LinkedSupplierID, LinkedSupplierDisplayID, LinkedSupplierName. All the other columns and operators are processed client side.

SELECT * FROM TaxCodes WHERE WithholdingPayableAccountID = "e1b278bb-9ba3-4d2a-8dda-a49d09dcc471"
SELECT * FROM TaxCodes WHERE Rate = 46.5
SELECT * FROM TaxCodes WHERE Description = "No ABN Withholding" AND Code = "ABN"

Insert

The following attributes are required when performing an insert: Code, Description, Type, TaxCollectedAccountID, TaxPaidAccountID.

INSERT INTO TaxCodes (Code, Description, Type, TaxCollectedAccountID, TaxPaidAccountID) VALUES ("CDE", "Example tax code", "NoABN_TFN", "446d2226-254b-4821-acc2-7031842e0166", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Code	String	False		3 digit code assigned to the tax code.
Description	String	False		Description given to the tax code.
IsRateNegative	Boolean	False		True indicates the tax rate is a negative value. False indicates the tax rate is a positive value.
LuxuryCarTaxThreshold	Decimal	False		Dollar value which must be exceeded before tax is calculated using this tax code.
Rate	Decimal	False		Rate of tax assigned.
Type	String	False		Tax Types consist of the following: ImportDuty, SalesTax GST_VAT (Goods and Services Tax), InputTaxed, Consolidated, LuxuryCarTax, WithholdingsTax, NoABN_TFN.
TaxCollectedAccountID	Uuid	False	Accounts.Id	Unique identifier for the account in the form of a guid.
TaxCollectedAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
TaxCollectedAccountName	String	True		Name of the account.
TaxCollectedAccountURI	String	True		Uniform resource identifier associated with the account object.
TaxPaidAccountID	Uuid	False	Accounts.Id	Unique identifier for the account in the form of a guid.
TaxPaidAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
TaxPaidAccountName	String	True		Name of the account.
TaxPaidAccountURI	String	True		Uniform resource identifier associated with the account object.
WithholdingCreditAccountID	Uuid	False	Accounts.Id	Unique identifier for the account in the form of a guid.
WithholdingCreditAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
WithholdingCreditAccountName	String	True		Name of the account.
WithholdingCreditAccountURI	String	True		Uniform resource identifier associated with the account object.
WithholdingPayableAccountID	Uuid	False	Accounts.Id	Unique identifier for the account in the form of a guid.
WithholdingPayableAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
WithholdingPayableAccountName	String	True		Name of the account.
WithholdingPayableAccountURI	String	True		Uniform resource identifier associated with the account object.
ImportDutyPayableAccountID	Uuid	False	Accounts.Id	Unique identifier for the account in the form of a guid.
ImportDutyPayableAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
ImportDutyPayableAccountName	String	True		Name of the account.
ImportDutyPayableAccountURI	String	True		Uniform resource identifier associated with the account object.
LinkedSupplierID	Uuid	False	Contacts.Id	Unique guid identifier belonging to the assigned supplier contact.
LinkedSupplierDisplayID	String	True		Customer contact Card ID, can also be used as a unique supplier contact identifier.
LinkedSupplierName	String	True		Name of the supplier contact.
LinkedSupplierURI	String	True		Uniform resource identifier associated with the supplier contact object.
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.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

TimesheetLineEntries

Return timesheet entries for an AccountRight company file

Columns


Name	Type	ReadOnly	References	Description
TimeSheetId [KEY]	Uuid	True	Timesheets.Id	Unique category identifier in the form of a guid.
EntryId [KEY]	Uuid	True		Unique guid identifier belonging to the line entry.
EntryDate	Datetime	False		Date of the entry, format YYYY-MM-DD HH:MM:SS
EntryHours	Double	False		Number of hours assigned for entry day.
EntryProcessed	Boolean	True		indicates the timesheet entry has been processed or not as part of payroll
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

TimesheetLineItems

Return timesheet entries for an AccountRight company file

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Integer	False		LineId which represents the index of the line.
TimeSheetId [KEY]	Uuid	True	Timesheets.Id	Unique category identifier in the form of a guid.
PayrollCategoryId	Uuid	False		Unique payroll wage category identifier in the form of a guid.
PayrollCategoryName	String	True		Name of the payroll wage category.
PayrollCategoryType	String	True		Indicates the type of payroll category ie: Wage, Deduction, Tax.
PayrollCategoryURI	String	True		Uniform resource identifier associated with the payroll wage category object.
JobId	Uuid	True		Unique guid identifier belonging to the job for this line of the timesheet entry.
JobNumber	String	True		Number assigned to the job.
JobName	String	True		Name assigned to the job.
JobURI	String	True		Uniform resource identifier associated with the job object.
ActivityId	Uuid	True		Unique guid identifier belonging to the activity assigned for this line of the timesheet entry.
ActivityName	String	True		Name of the activity.
ActivityURI	String	True		Uniform resource identifier associated with the activity object.
CustomerId	Uuid	True		Unique guid identifier belonging to the customer assigned for this line of the timesheet entry.
CustomerName	String	True		Name of the customer.
CustomerDisplayID	String	False		Customer contact Card ID, can also be used as a unique customer contact identifier.
CustomerURI	String	True		Uniform resource identifier associated with the customer object.
Notes	String	True		Notes attached to the timesheet entry.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Timesheets

Return timesheet entries 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 = operator. In addition, queries with multiple criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison type for server side filtering: ID, EmployeeName, EmployeeDisplayId, StartDate, EndDate. All the other columns and operators are processed client side.

SELECT * FROM Categories WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM Timesheets WHERE EmployeeName = "Mary Jones"
SELECT * FROM Timesheets WHERE EmployeeDisplayId = "EMP00001"
SELECT * FROM Timesheets WHERE StartDate = "2019-10-28"
SELECT * FROM Timesheets WHERE EndDate = "2019-11-03"

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Uuid	True		Unique category identifier in the form of a guid.
EmployeeName	String	True		Name of the employee.
EmployeeDisplayId	String	True		Employee contact Card ID, can also be used as a unique employee contact identifier.
EmployeeURI	String	True		Uniform resource identifier associated with the employee object.
StartDate	Datetime	False		Date when the timesheet period starts, format YYYY-MM-DD HH:MM:SS
EndDate	Datetime	False		Date when the timesheet period finishes, format YYYY-MM-DD HH:MM:SS
URI	String	True		Uniform resource identifier associated with the employee object.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

TransferringTransactions

Return, update, create and delete transfer 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Amount, TransferNumber, Memo, Date, ToAccountID, ToAccountDisplayID, ToAccountName, FromAccountID, FromAccountDisplayID, FromAccountName, CategoryID, CategoryDisplayID, CategoryName. All the other columns and operators are processed client side.

SELECT * FROM TransferringTransactions WHERE ID = "bfaade84-1adf-4e2d-acfd-629e95d09de7"
SELECT * FROM TransferringTransactions WHERE Amount = 3300
SELECT * FROM TransferringTransactions WHERE TransferNumber = "TR000007" OR TransferNumber = "TR000008"

Insert

The following attributes are required when performing an insert: Date, Amount, ToAccountID, FromAccountID.

INSERT INTO TransferringTransactions (Date, Amount, ToAccountID, FromAccountID) VALUES ("01/01/2019", 6700.0, "446d2226-254b-4821-acc2-7031842e0166", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd")

Columns


Name	Type	ReadOnly	References	Description
ID [KEY]	Uuid	True		Unique identifier in the form of a guid.
Amount	Double	False		Amount to be allocated to the account, must be non zero.
TransferNumber	String	False		ID No of payment transaction, if left blank on POST will auto increment based upon last recorded #.
Memo	String	False		Memo text describing the transfer money transaction.
Date	Datetime	False		Transaction date entry.
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.
ToAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
ToAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
ToAccountName	String	True		Name of the account.
ToAccountURI	String	True		Uniform resource identifier associated with the account object.
FromAccountID	Uuid	False	Accounts.ID	Unique identifier for the account in the form of a guid.
FromAccountDisplayID	String	True		Account code. Format includes separator ie 4-1100
FromAccountName	String	True		Name of the account.
FromAccountURI	String	True		Uniform resource identifier associated with the account object.
CategoryID	Uuid	True		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.
CompanyFileId	String	True	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

MYOB Connector for CData Sync ビュー


Name	Description
AccountBudgetItems	Return general ledger account budget items
AccountRegister	Returns general ledger account activity.
BalanceSheetSummaryReport	Returns a Balance Sheet Summary.
BankAccounts	Return the bank accounts for an AccountRight company file.
BankingTransactions	Return a list of bank statement transactions for an AccountRight company file.
BuildLineItems	Build Lines
Categories	Return categories for cost center tracking
CategoryRegisters	Return transactions grouped with categories
CompanyFiles	Returns a list of company files.
CompanyPreferences	Returns company data file preferences for an AccountRight company file.
ContactAddressItems	Contact address items.
CreditSettlementItems	Credit settlement items.
Currencies	View currencies within an Accountright Live company file.
CustomerPaymentInvoices	Customer payment items for an AccountRight company file.
DebitSettlementItems	Debit settlement items.
EmployeeBankAccountItems	Employee bank account items.
EmployeePayrollAdviceReport	Return a pay advice report showing employee paycheque details for an AccountRight company file.
EmployeePayrollCategoryItems	Employee payroll category items.
EmployeePayrollDeductionItems	Employee payroll deduction items.
EmployeePayrollEntitlementItems	Employee payroll entitlement items.
EmployeePayrollExpenseItems	Employee payroll expense items.
EmployeePayrollWageCategoryItems	Employee wage category items.
InventoryAdjustmentItems	Inventory adjustment items for an AccountRight company file.
ItemLocations	Return an inventoried item location information
ItemSellingPrices	Return the item price matrix for multiple customer selling prices.
JobBudgetItems	Job budget items.
JournalItems	Journal line items.
JournalTransactionHistory	Returns a list of Journals and their history for all transaction types
JournalTransactionHistoryLineItems	Journal Transaction History Items
JournalTransactionItems	Usage information for the operation JournalTransactionItems.rsd.
JournalTransactions	Usage information for the operation JournalTransactions.rsd.
Locations	Return an inventoried item location information.
NZGSTReport	Returns a GST report for New Zealand AccountRight files.
PayrollCategories	Returns generic information on all payroll category types for an AccountRight company file.
PayrollCategorySummaryReport	Returns a Payroll Category Summary report for an AccountRight file.
PayrollDeductions	Return payroll categories of type deduction for an AccountRight company file
PayrollEntitlements	Return payroll categories of type entitlement for an AccountRight company file.
PayrollExpenses	Return payroll categories of type expense for an AccountRight company file.
PayrollSuperannuations	Return payroll categories of type superannuation for an AccountRight company file.
PayrollTaxes	Return payroll categories of type tax for an AccountRight company file.
PayrollTaxTables	Return payroll tax tables loaded into an AccountRight company file.
PriceLevelDetail	Tax codes for an AccountRight company file.
ProfitAndLossSummaryReport	Returns a Profit and Loss Summary for an AccountRight file.
ProfitLossDistributions	Returns the Profit and Loss Distribution of an AccountRight company file.
PurchaseBillItems	Return all purchase bill types for an AccountRight company file.
PurchaseOrderItems	Return all purchase order types for an AccountRight company file.
ReceivingTransactionItems	Receive money transactions for an AccountRight company file.
SaleInvoiceItems	Return all sale invoice types for an AccountRight company file.
SaleOrderItems	Returns all sale order types for an AccountRight company file.
SaleQuoteItems	Return all sale quote types for an AccountRight company file.
SpendingTransactionItems	Spend money transaction items for an AccountRight company file.
SuperannuationFunds	Superannuation fund details for an AccountRight company file.
SupplierPaymentItems	Supplier payment items for an AccountRight company file.
TaxCodeSummaryReport	Returns a Tax Code Summary Report for AccountRight files.
TransactionCodingSummaryReport	Returns a report of the total number of coded and uncoded transactions in an AccountRight file.

AccountBudgetItems

Return general ledger account budget items

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
FinancialYear	Integer		Financial year can consist of current FY or next FY only.
LastMonthInFinancialYear	Integer		Number representing the last month of the financial year. For example, 3 indicates March.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountName	String		Name of the account.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountURI	String		Uniform resource identifier associated with the account object.
MonthlyBudgets	String		An array of monthly account budget information.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

AccountRegister

Returns general ledger account activity.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Activity, Adjustment, Month, Year, YearEndActivity, YearEndAdjustment, AccountID, AccountDisplayID, AccountName. All the other columns and operators are processed client side.

SELECT * FROM AccountRegister WHERE AccountID = "d3f55ef1-ce77-4ef2-a415-61d04db2c5fc"
SELECT * FROM AccountRegister WHERE AccountName = "AccountName"
SELECT * FROM AccountRegister WHERE Month = 6

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Activity	Decimal		Net activity within profit and loss account or net movement within balance sheet accounts.
Adjustment	Decimal		Adjustments.
Month	Integer		Month in which the activity was generated ie December = 12.
Year	Integer		Year in which the activity was generated ie 2014.
YearEndActivity	Decimal		Net activity within profit and loss account or net movement within balance sheet accounts for YearEndAdjustments.
YearEndAdjustment	Decimal		General Journal entries recorded outside of the 12 month financial year.
RowVersion	String		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		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
UnitCount	Decimal		Quantity balance of the account.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

BalanceSheetSummaryReport

Returns a Balance Sheet Summary.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: AsOfDate, YearEndAdjust. All the other columns and operators are processed client side. The default behavior is AsOfDate as today's date and YearEndAdjust as false; if the AsOfDate and YearEndAdjust filters are left unset.

SELECT * FROM BalanceSheetSummaryReport

To override this behavior, the values can be set directly in the query. For example:

SELECT * FROM BalanceSheetSummaryReport WHERE AsOfDate = '2021-05-31 00:00:00' AND YearEndAdjust = false

Columns


Name	Type	References	Description
AccountTotal	Decimal		Total Amount for the Account for the given date range.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
AsOfDate	Date		Date of the period, format YYYY-MM-DD HH:MM:SS
YearEndAdjust	Boolean		If you are including Year end Adjustments. This is a true or False value.
CompanyFileId	String		The ID of the company file.

BankAccounts

Return the bank accounts 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, FinancialInstitution, BankAccountName, BSB, BankAccountNumber, CardName, CardNumber, AccountID, AccountDisplayID, AccountName, LastReconciledDate. All the other columns and operators are processed client side.

SELECT * FROM BankAccounts WHERE ID = REPLACE
SELECT * FROM BankAccounts WHERE FinancialInstitution = "ANZ"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
FinancialInstitution	String		The code for the Financial Institution.
BankAccountName	String		Bank account name setup.
BSB	String		BSB as provided by the financial institution.
BankAccountNumber	String		Account number as provided by the financial institution.
CardName	String		The name on the credit card.
CardNumber	String		The credit card number.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
BankLinkStatus	String		The status of the Bankfeed connection.
LastReconciledDate	Datetime		Shows the date that the Account was last reconciled. This will return as null if the Account has never been reconciled.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

BankingTransactions

Return a list of bank statement 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 criteria 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, Description, IsCredit, StatementDate, Status, Amount, AccountID, AccountDisplayID, AccountName. All the other columns and operators are processed client side.

SELECT * FROM BankingTransactions WHERE ID = "6d35e53a-5070-432d-b9ec-f4791e353352"
SELECT * FROM BankingTransactions WHERE IsCredit = true
SELECT * FROM BankingTransactions WHERE Amount = 1400 OR Amount = 1800

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Date	Datetime		Transaction date.
Description	String		Description text for the transaction.
IsCredit	Boolean		True or false.
StatementDate	Datetime		Date when the BankStatement was pulled into AccountRight.
Status	String		One of: Uncoded, Coded, Hidden.
Amount	Decimal		Dollar amount of the withdrawal or deposit.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
RowVersion	String		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	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

BuildLineItems

Build Lines

Columns


Name	Type	References	Description
RowID [KEY]	String		Sequence of the entry within the inventory journal set.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
AccountDisplayID	String		Account code format includes separator ie 1-1100
AccountName	String		Account name belonging to the account record
AccountUID	String		Unique guid identifier belonging to the account for the item adjustment
AccountURI	String		Uniform resource identifier associated with the account object
Amount	String		Dollar amount assigned to the item (Quantity * UnitCost = Amount).
ItemName	String		Name assigned to the item.
ItemNumber	String		Number assigned to the item.
ItemUID	String		Unique identifier for item in the form of a guid
ItemURI	String		Uniform resource identifier associated with the item object.
LocationName	String		Name assigned to the location.
LocationUID	String		Unique identifier for location in the form of a guid.
LocationURI	String		Uniform resource identifier associated with the location object
Memo	String		Memo text describing the transaction line
UnitCost	Double		Unit cost assigned to the item/items, if left blank on POST will default to AverageCost.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

CategoryRegisters

Return transactions grouped with categories

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 = operator. In addition, queries with multiple criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison type for server side filtering: CategoryID, AccountID, Year, Month, Activity, YearEndActivity. All the other columns and operators are processed client side.

SELECT * FROM CategoryRegisters WHERE CategoryID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM CategoryRegisters WHERE AccountID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM CategoryRegisters WHERE Year = "2019"
SELECT * FROM CategoryRegisters WHERE Month = "09"

Columns


Name	Type	References	Description
CategoryID	Uuid	Categories.ID	Unique category identifier in the form of a guid for the category.
AccountID	Uuid	Accounts.ID	Unique category identifier in the form of a guid for the account.
Year	Integer		Financial year in which the activity was generated ie 2014.
Month	Integer		Month in which the activity was generated ie December = 12.
Activity	Decimal		Net activity within profit & loss account or net movement within balance sheet accounts.
YearEndActivity	Decimal		Net activity within profit & loss account or net movement within balance sheet accounts for YearEndAdjustments.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

CompanyFiles

Returns a list of company files.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID. All the other columns and operators are processed client side.

SELECT * FROM CompanyFiles WHERE ID = "68556195-8f87-4e1a-85e9-069f5fc52497"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
CheckedOutBy	String		my.MYOB user that has checked out the file offline.
CheckedOutDate	Datetime		Date the online file was checked out offline.
Country	String		The 2 character country code. EG: AU or NZ
LibraryPath	String		Path name to the company file.s
Name	String		Name of the object.
ProductVersion	String		MYOB AccountRight Live version this company file was created with. EG: 2013.3.
ProductLevelCode	Integer		AccountRight Live product code.
ProductLevelName	String		AccountRight Live product name, ie Basics, Standard, Plus.
SerialNumber	String		The 12 digit serial number of the AccountRight file.
UiAccessFlags	Integer		The file accessible product type identifier. 0-LocalAccountRight, 1-OnlineAccountRight, 2-New Essentials, 3-AccountRight and NewEssentials
Uri	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.

CompanyPreferences

Returns company data file preferences for an AccountRight company file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
PreferToReceiveMoneyIntoUndepositedFunds	Boolean		True indicates the preference When I receive money, I prefer to Group with Other Undeposited funds is turned on. False indicates the preference When I receive money, I prefer to Group with Other Undeposited funds is turned off.
PurchasesTermsBalanceDueDate	Integer		The balance due date which includes EOM (End of Month).
PurchasesTermsCreditLimit	Decimal		Default customer contact credit limit.
PurchasesTermsDiscountDate	Integer		The discount date which includes EOM (End of Month).
PurchasesTermsDiscountForEarlyPayment	Double		% discount for early payment.
PurchasesTermsMonthlyChargeForLatePayment	Double		% monthly charge for late payment.
PurchasesTermsPaymentIsDue	String		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
PurchasesTermsPriceLevel	String		Default price level.
PurchasesTermsUseCustomerTaxCode	Boolean		True or false.
PurchasesTermsUseSupplierTaxCode	Boolean		True or false.
PurchasesTermsFreightTaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
PurchasesTermsFreightTaxCodeCode	String		3 digit tax code.
PurchasesTermsFreightTaxCodeURI	String		Uniform resource identifier associated with the tax code object.
PurchasesTermsTaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
PurchasesTermsTaxCodeCode	String		3 digit tax code.
PurchasesTermsTaxCodeURI	String		Uniform resource identifier associated with the tax code object.
ReportsAndFormsReportTaxablePayments	Boolean		True indicates that report taxable payments made to contractors is turned on. False indicates that report taxable payments made to contractors is turned off.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
SalesTermsBalanceDueDate	Integer		The balance due date which includes EOM (End of Month).
SalesTermsCreditLimit	Decimal		Default customer contact credit limit.
SalesTermsDiscountDate	Integer		The discount date which includes EOM (End of Month).
SalesTermsDiscountForEarlyPayment	Double		% discount for early payment.
SalesTermsMonthlyChargeForLatePayment	Double		% monthly charge for late payment.
SalesTermsPaymentIsDue	String		Default Terms of Payment definitions: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
SalesTermsPriceLevel	String		Default price level.
SalesTermsUseCustomerTaxCode	Boolean		True or false.
SalesTermsUseSupplierTaxCode	Boolean		True or false.
SalesTermsFreightTaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
SalesTermsFreightTaxCodeCode	String		3 digit tax code.
SalesTermsFreightTaxCodeURI	String		Uniform resource identifier associated with the tax code object.
SalesTermsTaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
SalesTermsTaxCodeCode	String		3 digit tax code.
SalesTermsTaxCodeURI	String		Uniform resource identifier associated with the tax code object.
SystemCategoryTracking	String		Can consist of the following values: Off ,OnAndNotRequired, OnAndRequired.
SystemLockPeriodPriorTo	String		Lock period disabling entries prior to a given date.
SystemTransactionsCannotBeChangedMustBeReversed	Boolean		True indicates that transctions cannot be changed or deleted, they must be reversed. False indicates transctions can be either changed or deleted.
TimesheetsUseTimesheetsFor	String		Can consist of either TimeBillingAndPayroll or Payroll.
TimesheetsWeekStartsOn	String		Day the week starts on ie: Monday, Tuesday, Wednesday.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ContactAddressItems

Contact address items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
ID [KEY]	Integer		LineId which represents the index of the line.
ContactID [KEY]	Uuid		Unique identifier in the form of a guid.
City	String		City of address record.
ContactName	String		Contact Name on address record.
Country	String		Country of location for address record.
Email	String		Email contact of address record.
Fax	String		Fax number of address record.
Location	Integer		One contact can have up to five address records.
Phone1	String		Phone number 1 of address record.
Phone2	String		Phone number 2 of address record.
Phone3	String		Phone number 3 of address record.
PostCode	String		Postcode of address record.
Salutation	String		Salutation text for address record.
State	String		State of address record. Updated in 2018.1, this field is required for addresses with a country that is blank or Australia. Where required, valid values are: AAT , ACT , NSW , NT , QLD , SA , TAS , VIC, WA.
Street	String		Full content of Address field.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

CreditSettlementItems

Credit settlement items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
ID [KEY]	Integer		LineId which represents the index of the line.
CreditSettlementID [KEY]	Uuid		Unique identifier in the form of a guid.
AmountApplied	Decimal		Credit amount applied to sales transactions, amount must be greater than 0.
Type	String		Sale type which can consist of the following: Invoice, Order.
SaleID	Uuid		Unique identifier in the form of a guid.
SaleNumber	String		Sale number.
SaleURI	String		Uniform resource identifier associated with the invoice.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Currencies

View currencies within an Accountright Live 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Code, CurrencyName, CurrencyRate. All the other columns and operators are processed client side.

SELECT * FROM Currencies WHERE Code = "AED"
SELECT * FROM Currencies WHERE CurrencyName = "Emirati Dirham"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Code	String		Three letter ISO 4217 code for this currency.
CurrencyName	String		Full currency name.
CurrencyRate	Decimal		Conversion rate from local currency.
RowVersion	String		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		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

CustomerPaymentInvoices

Customer payment items for an AccountRight company file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
CustomerPaymentID [KEY]	Uuid		Unique identifier in the form of a guid.
ID [KEY]	Uuid		Unique guid identifier belonging to the invoice.
AmountApplied	Double		Amount applied to invoice.
Number	String		Invoice number.
RowID	Integer		Sequence of the entry within the customer payment set.
Type	String		Invoice type: Invoice, Order.
URI	String		Uniform resource identifier associated with the invoice object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

DebitSettlementItems

Debit settlement items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
ID [KEY]	Integer		LineId which represents the index of the line.
DebitSettlementID [KEY]	Uuid		Unique identifier in the form of a guid.
Type	String		Purchase type which can consist of the following: Bill, Order.
AmountApplied	Double		Debit amount applied to purchases transactions, amount must be greater than 0.
PurchaseID	Uuid	PurchaseOrders.ID	Unique identifier in the form of a guid.
PurchaseNumber	String		Purchase number.
PurchaseURI	String		Uniform resource identifier associated with the purchase.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeeBankAccountItems

Employee bank account items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
ID [KEY]	Integer		LineId which represents the index of the line.
EmployeeID [KEY]	Uuid		Unique identifier in the form of a guid.
BSBNumber	String		Required Only: for updating an existing employee's payment details where PaymentMethod = Electronic. Format looks like
BankAccountName	String		Required Only: for updating an existing employee's payment details where PaymentMethod = Electronic.
BankAccountNumber	String		Required Only: for updating an existing employee's payment details where PaymentMethod = Electronic.
Unit	String		Units can consist of the following Enum values: Percent, Dollars, RemainingAmount (read-only for the last account in the collection).
Value	Integer		Net pay amount to be transferred to employee's account using either Dollars (13.6) or Percent (0.00 - 100.00)
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeePayrollAdviceReport

Return a pay advice report showing employee paycheque details for an AccountRight company file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
AnnualSalary	Decimal		Annual salary amount for the employee (at the time of the API call).
ChequeNumber	String		Cheque number or reference type.
DateOfBirth	Datetime		Employees date of birth.
EmployerABNOrTFN	String		ABN or TFN as entered within the Company Information window or Company endpoint.
EmployerCompanyName	String		Company name as entered within the Company Information window or Company endpoint.
EmployerURI	String		Uniform resource identifier associated with the company file.
GrossPay	Decimal		Gross Wages for pay period (total amount of money before deductions) for the employee.
HourlyRate	Decimal		Employee's hourly rate.
NetPay	Decimal		Net Wages for pay period (total amount of money after deductions) for the employee.
PayFrequency	String		Pay frequency can consist of the following: Weekly, Fortnightly, TwiceAMonth, Monthly.
PayPeriodEndDate	Datetime		Finishing date of the pay period.
PayPeriodStartDate	Datetime		Starting date of the pay period.
PaymentDate	Datetime		Date when the paycheque was processed and paid,.
SuperannuationFundID	Uuid		Unique guid identifier belonging to the superannuation fund.
SuperannuationFundName	String		Name of the superannuation fund.
SuperannuationFundURI	String		Uniform resource identifier associated with the superannuation fund.
EmployeeID	Uuid	Contacts.ID	Unique guid identifier belonging to the assigned employee contact.
EmployeeDisplayID	String		Customer contact Card ID, can also be used as a unique employee contact identifier.
EmployeeName	String		Name of the employee contact.
EmployeeURI	String		Uniform resource identifier associated with the employee contact object.
Amount	Decimal		Amount processed for payroll category i.e. $ amounts for Wages, Superannuation, Deductions and Hours for entitlements.
PayrollCategoryID	Uuid	PayrollCategories.ID	Unique category identifier in the form of a guid.
PayrollCategoryName	String		Name of the category.
PayrollCategoryType	String		Indicates the type of payroll category i.e. Wage, Deduction, Expense, Tax.
PayrollCategoryURI	String		Uniform resource identifier associated with the category object.
Hours	Integer		Number of hours paid on hourly payroll category or accrued for entitlements. Note: If payroll category is of type salary then null is returned.
CalculationRate	Decimal		The rate an hourly wage category is calculated,Note: If wage is of type salary then null is returned.
YearToDate	Decimal		YTD amounts accrued this payroll year based upon pays recorded.
CompanyFileId	String		The ID of the company file.

EmployeePayrollCategoryItems

Employee payroll category items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
EmployeeID [KEY]	Uuid		Unique identifier in the form of a guid.
Amount	Double		The total amount.
IsCalculated	Boolean		True or false.
PayrollCategoryID [KEY]	Uuid		Unique category identifier in the form of a guid.
PayrollCategoryName	String		Name of the category.
PayrollCategoryType	String		Type of the payroll category.
PayrollCategoryURI	String		Uniform resource identifier associated with the category object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeePayrollDeductionItems

Employee payroll deduction items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
PayrollDetailsID [KEY]	Uuid		Unique identifier in the form of a guid.
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Name	String		Name of the deduction.
Type	String		Type of the deduction.
URI	String		Uniform resource identifier associated with the expense deduction.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeePayrollEntitlementItems

Employee payroll entitlement items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
PayrollDetailsID [KEY]	Uuid		Unique identifier in the form of a guid.
CarryOver	Decimal		The number of hours carried over from the previous payroll year.
EntitlementCategoryID [KEY]	Uuid		Unique category identifier in the form of a guid.
EntitlementCategoryName	String		Name of the category.
EntitlementCategoryType	String		Indicates the type of payroll category ie: Wage, Deduction, Superannuation.
EntitlementCategoryURI	String		Uniform resource identifier associated with the category object.
IsAssigned	Boolean		True or false.
Total	Decimal		The number of hours available on the entitlement (Total = CarryOver + YearToDate).
YearToDate	Decimal		Net number of hours accrued this payroll year.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeePayrollExpenseItems

Employee payroll expense items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
PayrollDetailsID [KEY]	Uuid		Unique identifier in the form of a guid.
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Name	String		Name of the expense.
Type	String		Type of the expense.
URI	String		Uniform resource identifier associated with the expense object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

EmployeePayrollWageCategoryItems

Employee wage category items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
PayrollDetailsID [KEY]	Uuid		Unique identifier in the form of a guid.
ID [KEY]	Uuid		Unique category identifier in the form of a guid.
Name	String		Name of the category.
Type	String		Type of the category.
URI	String		Uniform resource identifier associated with the category object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

InventoryAdjustmentItems

Inventory adjustment items for an AccountRight company file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
AdjustmentID	Uuid	InventoryAdjustments.ID	Unique identifier in the form of a guid.
Amount	Double		Dollar amount assigned to the item.
Quantity	Double		The quantity of items to be adjusted.
UnitCost	Double		Unit cost assigned to the item/items.
RowID	Integer		Sequence of the entry within the inventory journal set.
Memo	String		Memo text describing the transaction line.
RowVersion	String		RowVersion. Required during update to identify the line item.
ItemID	Uuid	Items.ID	Unique item identifier in the form of a guid.
ItemName	String		Name assigned to the item.
ItemNumber	String		Number assigned to the item.
ItemURI	String		Uniform resource identifier associated with the item object.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
JobID	Uuid	Jobs.ID	Unique job identifier in the form of a guid.
JobName	String		Name assigned to the job.
JobNumber	String		Number assigned to the job.
JobURI	String		Uniform resource identifier associated with the job object.
LocationID	Uuid	Locations.ID	Unique identifier for the location in the form of a guid.
LocationIdentifier	String		Identifier assigned to the location.
LocationName	String		Name of the location.
LocationURI	String		Uniform resource identifier associated with the location object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ItemLocations

Return an inventoried item location information

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier for location in the form of a guid.
ItemID [KEY]	Uuid	Items.ID	Unique identifier in the form of a guid.
Identifier	String		Identifier assigned to the location.
QuantityOnHand	Decimal		Quantity of units held in inventory
Name	String		Name assigned to the location.
URI	String		Uniform resource identifier associated with the location object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ItemSellingPrices

Return the item price matrix for multiple customer selling prices.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ItemPriceMatrixID. All the other columns and operators are processed client side.

SELECT * FROM ItemSellingPrices WHERE ItemPriceMatrixID = "3a35e83a-5070-432d-b6ec-f4791f353352"

Columns


Name	Type	References	Description
ID [KEY]	Integer		LineId which represents the index of the line.
ItemPriceMatrixID [KEY]	Uuid		Unique identifier in the form of a guid.
QuantityOver	Integer		The first QuantityOver must always be 0, for each additional quantity break specify the item quantity.
LevelA	Double		Item price Level a, defaults to items Base Selling Price.
LevelB	Double		Item price Level b, defaults to items Base Selling Price.
LevelC	Double		Item price Level c, defaults to items Base Selling Price.
LevelD	Double		Item price Level d, defaults to items Base Selling Price.
LevelE	Double		Item price Level e, defaults to items Base Selling Price.
LevelF	Double		Item price Level f, defaults to items Base Selling Price.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

JobBudgetItems

Job budget items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
JobBudgetID	Uuid	JobBudgets.Id	Unique identifier in the form of a guid.
Amount	Decimal		Budget amount for job.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

JournalItems

Journal line items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
JournalID [KEY]	Uuid		Unique identifier in the form of a guid.
Amount	Double		Dollar amount posted to the line of the transaction.
IsCredit	Boolean		True indicates the amount posted to the account as a credit. False indicates the amount posted to the account as a debit.
IsOverriddenTaxAmount	Boolean		True indicates the tax amount has been altered. False indicates the tax amount has not been altered.
Memo	String		Memo text applied to the line of the transaction.
RowID [KEY]	Integer		Sequence of the entry within the general journal set.
TaxAmount	Double		Tax amount for the line of the journal if using an applicable TaxCode.
RowVersion	String		Row version for the item. Required to udpate an existing line.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
JobID	Uuid	Jobs.ID	Unique job identifier in the form of a guid.
JobNumber	String		Number assigned to the job.
JobName	String		Name assigned to the job.
JobURI	String		Uniform resource identifier associated with the job object.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String		3 digit tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

JournalTransactionHistory

Returns a list of Journals and their history for all transaction types

Columns


Name	Type	References	Description
UID [KEY]	Uuid		Unique identifier in the form of a guid.
DateOccurred	Datetime		Transaction date entry, format YYYY-MM-DD HH:MM:SS
DatePosted	Datetime		Date timestamp for day the transaction was entered, format YYYY-MM-DD HH:MM:SS
Description	String		Journal memo assigned to the transaction.
DisplayID	String		Journal transaction id.
GroupUID	Uuid		UID of the first version of the transaction.
JournalType	String		Full list of journal types:General Sale Purchase CashPayment CashReceipt Inventory
Lines	String		An array of journal line information
OperationType	String		Operation types:Added System Edited Deleted Reversed.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
SourceTransactionTransactionType	String		Transaction types consist of the following: Bill Invoice SupplierPayment CustomerPayment SpendMoneyTxn ReceiveMoneyTxn TransferMoneyTxn GeneralJournal InventoryAdjustment CreditRefund CreditSettlement DebitRefund DebitSettlement
SourceTransactionUID	Uuid		Unique identifier for the source transaction in the form of a guid.
SourceTransactionURI	String		Uniform resource identifier associated with the transaction object.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
CompanyFileId	String		ID of the company file. Takes precedence over the CompanyFileId property.

JournalTransactionHistoryLineItems

Journal Transaction History Items

Columns


Name	Type	References	Description
ID [KEY]	Integer		LineId which represents the index of the line.
JournalTransactionID [KEY]	Uuid		Unique identifier in the form of a guid.
AccountID	Uuid		Unique identifier for the account in the form of a guid
AccountDisplayID	String		Account code format includes separator ie 1-1100
AccountName	String		Account name belonging to the account record.
AccountURI	String		Uniform resource identifier associated with the account object.
Amount	Decimal		Dollar amount posted to the Account object for each line of the transaction.
IsCredit	Boolean		Indicates whether the amount posted a credit to the Account object.
JobID	Uuid		Unique guid identifier belonging to the job for the line of the service sale.
JobName	String		Name assigned to the job
JobNumber	String		Number assigned to the job
JobUri	String		Uniform resource identifier associated with the job object
LineDescription	String		Line description for each line of the transaction if one has been entered.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

JournalTransactionItems

Usage information for the operation JournalTransactionItems.rsd.

Table Specific Information

Select

Only the JournalTransactionID column, when using the equality comparison, is supported for server side filtering.

Columns


Name	Type	References	Description
ID [KEY]	Integer		LineId which represents the index of the line.
JournalTransactionID [KEY]	Uuid		Unique identifier in the form of a guid.
AccountID	Uuid
AccountDisplayID	String
AccountName	String
AccountURI	String
Amount	Decimal
IsCredit	Boolean
JobID	Uuid
JobName	String
JobNumber	String
JobUri	String
LineDescription	String
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

JournalTransactions

Usage information for the operation JournalTransactions.rsd.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, DisplayID, Description, DateOccurred, DatePosted, JournalType, SourceTransactionID, SourceTransactionTransactionType. All the other columns and operators are processed client side.

SELECT * FROM JournalTransactions WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM JournalTransactions WHERE Description = "description" AND SourceTransactionTransactionType = "type"

Columns


Name	Type	References	Description
ID [KEY]	Uuid
DisplayID	String
Description	String
DateOccurred	Datetime
DatePosted	Datetime
JournalType	String
RowVersion	String
SourceTransactionID	Uuid
SourceTransactionTransactionType	String
SourceTransactionURI	String
URI	String
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

Locations

Return an inventoried item location information.

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique location identifier in the form of a guid.
AddressCity	String		City of address Record.
AddressContactName	String		ContactName on Address record.
AddressCountry	String		Country of the Location for adress Record.
AddressEmail	String		Email contact of address record.
AddressFax	String		Fax number of address record.
AddressLocation	Integer		One location can have one address.
AddressPhone1	String		Phone number 1 of address record.
AddressPhone2	String		Phone number 2 of address record.
AddressPhone3	String		Phone number 3 of address record.
AddressPostCode	String		Post Code of address record.
AddressSalutation	String		Salutation text for address record.
AddressState	String		State of Address record.
AddressStreet	String		Full content of address field.
AddressWebsite	String		World wide Webaddress for contact.
CanSell	Boolean		True indicates items inventoried in the location can be sold,False indicates items inventoried in the location can not be sold
Identifier	String		Identifier of the location.
IsActive	Boolean		True indicates location is active,False indicates location is inactive.
Name	String		Name for an induvidual location.
Notes	String		Notes for the location.
RowVersion	String		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		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

NZGSTReport

Returns a GST report for New Zealand AccountRight files.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: EndDate, ReportingPeriod, ReportingBasis, YearEndAdjust. All the other columns and operators are processed client side. The default behavior is EndDate as today's date, ReportingPeriod as 6m, ReportingBasis as Cash, and YearEndAdjust as false; if the EndDate, ReportingPeriod, ReportingBasis, and YearEndAdjust filters are left unset.

SELECT * FROM NZGSTReport

To override this behavior, the values can be set directly in the query. For example:

SELECT * FROM NZGSTReport WHERE EndDate = "01/04/2019" AND ReportingBasis = "Cash"  AND ReportingPeriod = "6m" AND YearEndAdjust = false

Columns


Name	Type	References	Description
Address	String		The Address of the Company.
CompanyName	String		The name of the Business.
CreditAdjustments	Decimal		The Credit Adjustments amount for the given date range.
DebitAdjustments	Decimal		The Debit Adjustments amount for the given date range.
IrdNumber	String		The IRD number of the Company, format xxx-xxx-xxx.
NetGSTSales	Decimal		The Net GST Sales amount for the given date range.
PaymentAmount	Decimal		Total Payment Amount for the given date range.
PhoneNumber	String		The Phone number for the Company.
TotalGSTCollected	Decimal		Total GST Collected for the given date range.
TotalGSTCollectedOnPurchases	Decimal		Total GST Collected on Purchases for the given date range.
TotalGSTCollectedOnSales	Decimal		Total GST Collected on Sales for the given date range.
TotalGSTCredit	Decimal		Total GST Credit for the given date range.
TotalPurchases	Decimal		Total Amount of Purchases for the given date range.
TotalSales	Decimal		Total Amount of Sales for the given date range.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
ZeroRatedSupplies	Decimal		Total Zero Rated Supplies for the given date range.
EndDate	Date		Starting date of the period.
ReportingPeriod	String		Reporting Period for the report. This will either be 1m, 2m or 6m.
ReportingBasis	String		Reporting basis for the period, will either be Cash or Accural.
YearEndAdjust	Boolean		If you are including Year end Adjustments. This is a true or False value.
CompanyFileId	String		The ID of the company file.

PayrollCategories

Returns generic information on all payroll category types 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Name, Type. All the other columns and operators are processed client side.

SELECT * FROM PayrollCategories WHERE ID = "3a35e83a-5070-432d-b6ec-f4791f353352"
SELECT * FROM PayrollCategories WHERE Name = "criteria"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Name	String		Name of the payroll category.
Type	String		Indicates the type of payroll category ie: Wage, Expense, Deduction, Tax, Superannuation, Entitlement.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PayrollCategorySummaryReport

Returns a Payroll Category Summary report for an AccountRight 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: EndDate, StartDate, ReportingBasis, YearEndAdjust. All the other columns and operators are processed client side. The default behavior is EndDate as today's date, StartDate as the first day of the year, ReportingBasis as Cash, and YearEndAdjust as false; if the EndDate, StartDate, ReportingBasis, and YearEndAdjust filters are left unset.

SELECT * FROM PayrollCategorySummaryReport

To override this behavior, the values can be set directly in the query. For example:

SELECT * FROM PayrollCategorySummaryReport WHERE StartDate = "12/01/2018" AND EndDate = "01/04/2019" AND ReportingBasis = "Cash" AND YearEndAdjust = false

Columns


Name	Type	References	Description
Amount	Decimal		Total amount for the Payroll Category for that date range.
Hours	Decimal		Total Hours for the Payroll Category for that date range.
PayrollCategoryID	Uuid		Unique category identifier in the form of a guid.
PayrollCategoryName	String		Name of the category.
PayrollCategoryType	String		Payroll Category Type.
PayrollCategoryURI	String		Uniform resource identifier associated with the category object.
EndDate	Date		Starting date of the period.
StartDate	Date		Ending date of the period.
ReportingBasis	String		Reporting basis for the period, will either be Cash or Accural.
YearEndAdjust	Boolean		If you are including Year end Adjustments. This is a true or False value.
CompanyFileId	String		The ID of the company file.

PayrollDeductions

Return payroll categories of type deduction 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, CalculationBasisPercentageOf, CalculationBasisType, CalculationFixedDollarsOf, LimitAccrualPeriod, LimitFixedDollarsOf, LimitType, Name, StpCategory, Type, PayableAccountID, PayableAccountDisplayID, PayableAccountName. All the other columns and operators are processed client side.

SELECT * FROM PayrollDeductions WHERE ID = "PayrollEntitlements"
SELECT * FROM PayrollDeductions WHERE CalculationBasisPercentageOf = 28
SELECT * FROM PayrollDeductions WHERE PayableAccountName = "PayableAccountName"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
CalculationBasisPercentageOf	Decimal		Percentage of super to calculate if CalculationBasis.Type = PercentageOfPayrollCategory.
CalculationBasisType	String		The type of calculation to use can be any of the following 3: UserEntered - use amount on employees standard pay when processing. PercentageOfPayrollCategory - Equals x percentage, calculate as a % of gross wages or another payroll category. FixedDollars - Equals x dollar to contribute for all linked employees.
CalculationFixedDollarsOf	Decimal		Nominated deduction amount CalculationBasis.Type = FixedDollars.
LimitAccrualPeriod	String		How the maximum expense is calculated if Limit.Type = FixedDollars. Can consist of any of the following: PayPeriod, Month, Year, Hour.
LimitFixedDollarsOf	Decimal		Maximum expense amount if Limit.Type = FixedDollars.
LimitType	String		The type of calculation to use can be any of the following 3: NoLimit - no limits in place on expense calculations. PercentageOfPayrollCategory - Equals x percentage, limit is calculated as a % of gross wages or another payroll category. FixedDollars - Equals x dollar limit set.
Name	String		Name of the object.
StpCategory	String		STP Category for this payroll category. See MYOB help for more info. Valid values are: NotReportable (default), GrossPayments, PAYGWithholding, ExemptForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type	String		Indicates the type of payroll category ie: Wage, Expense, Deduction.
PayableAccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
PayableAccountDisplayID	String		Account code. Format includes separator ie 4-1100
PayableAccountName	String		Name of the account.
PayableAccountURI	String		Uniform resource identifier associated with the account object.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PayrollEntitlements

Return payroll categories of type entitlement 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Name, PrintOnPayAdvice, StpCategory, Type, CalculationAccrualPeriod, CalculationFixedHoursOf, CalculationBasisType, CarryEntitlementOverToNextYear. All the other columns and operators are processed client side.

SELECT * FROM PayrollEntitlements WHERE ID = "3a35e83a-5070-432d-b6ec-f4791f353352"
SELECT * FROM PayrollEntitlements WHERE Name = "criteria"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Name	String		Name of the object.
PrintOnPayAdvice	Boolean		True indicates accrued leave hours will show on pay advices. False indicates accrued leave hours will not be shown on pay advices.
StpCategory	String		STP Category for this payroll category. See MYOB help for more info. Valid values are: NotReportable (default), GrossPayments, PAYGWithholding, ExemptForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type	String		Indicates the type of payroll category ie: Wage, Expense, Deduction.
CalculationAccrualPeriod	String		How the specified hours are accrued if CalculationBasis.Type = FixedHours. Can consist of any of the following: PayPeriod, Month, Year, Hour.
CalculationFixedHoursOf	Decimal		Number of hours to accrue if CalculationBasis.Type = FixedHours.
CalculationBasisType	String		The type of calculation to use can be any of the following 3: UserEntered - use amount on employees standard pay when processing. PercentageOfPayrollCategory - Equals x percentage, calculate as a % of gross wages or another payroll category. FixedDollars - Equals x dollar to contribute for all linked employees.
CarryEntitlementOverToNextYear	Boolean		True indicates to carry over any unused leave hours when starting a new payroll year. False indicates not to carry over unused leave hours when starting a new payroll year.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
PayrollWages	String		An array of linked wage category information, when recording hours for selected linked wage on an employee's pay, the entitlement balance will reduce accordingly.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PayrollExpenses

Return payroll categories of type expense 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, LimitAccrualPeriod, LimitFixedDollarsOf, LimitType, PrintOnPayAdvice, Threshold, Name, StpCategory, Type, PayrollCategoryID, PayrollCategoryName, PayrollCategoryType, CalculationBasisPercentageOf, CalculationBasisType, ExpenseAccountID, ExpenseAccountDisplayID, ExpenseAccountName, PayableAccountID, PayableAccountDisplayID, PayableAccountName. All the other columns and operators are processed client side.

SELECT * FROM PayrollExpenses WHERE PrintOnPayAdvice = true
SELECT * FROM PayrollExpenses WHERE LimitFixedDollarsOf = 350
SELECT * FROM PayrollExpenses WHERE StpCategory = "NotReportable"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
LimitAccrualPeriod	String		How the maximum expense is calculated if Limit.Type = FixedDollars. Can consist of any of the following: PayPeriod, Month, Year, Hour.
LimitFixedDollarsOf	Decimal		Maximum expense amount if Limit.Type = FixedDollars.
LimitType	String		The type of calculation to use can be any of the following 3: NoLimit - no limits in place on expense calculations. PercentageOfPayrollCategory - Equals x percentage, limit is calculated as a % of gross wages or another payroll category. FixedDollars - Equals x dollar limit set.
PrintOnPayAdvice	Boolean		True indicates accrued expenses will show on pay advices. False indicates accrued expenses will not be shown on pay advices.
Threshold	Decimal		Amount if expense is only payable when wages exceed a certain $$ per month.
Name	String		Name of the wage category.
StpCategory	String		STP Category for this payroll category. See MYOB help for more info. Valid values are: NotReportable (default), GrossPayments, PAYGWithholding, ExemptForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type	String		Indicates the type of payroll category ie: Wage, Expense, Deduction.
PayrollCategoryID	Uuid	PayrollCategories.ID	Unique category identifier in the form of a guid.
PayrollCategoryName	String		Name of the category.
PayrollCategoryType	String		Indicates the type of payroll category ie: Wage, Expense, Deduction.
PayrollCategoryURI	String		Uniform resource identifier associated with the category object.
CalculationBasisPercentageOf	Decimal		Percentage of super to calculate if CalculationBasis.Type = PercentageOfPayrollCategory.
CalculationBasisType	String		The type of calculation to use can be any of the following 3: UserEntered - use amount on employees standard pay when processing. PercentageOfPayrollCategory - Equals x percentage, calculate as a % of gross wages or another payroll category. FixedDollars - Equals x dollar to contribute for all linked employees.
ExpenseAccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
ExpenseAccountDisplayID	String		Account code. Format includes separator ie 4-1100
ExpenseAccountName	String		Name of the account.
ExpenseAccountURI	String		Uniform resource identifier associated with the account object.
PayableAccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
PayableAccountDisplayID	String		Account code. Format includes separator ie 4-1100
PayableAccountName	String		Name of the account.
PayableAccountURI	String		Uniform resource identifier associated with the account object.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PayrollSuperannuations

Return payroll categories of type superannuation 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, ContributionType, Exclusion, PrintOnPayAdvice, Threshold, Type, LimitType, Name, PayrollCategoryID, PayrollCategoryName, PayrollCategoryType, CalculationBasisPercentageOf, CalculationBasisType, ExpenseAccountID, ExpenseAccountDisplayID, ExpenseAccountName, PayableAccountID, PayableAccountDisplayID, PayableAccountName. All the other columns and operators are processed client side.

SELECT * FROM PayrollSuperannuations WHERE Threshold = 450
SELECT * FROM PayrollSuperannuations WHERE LimitType = "NoLimit"
SELECT * FROM PayrollSuperannuations WHERE Exclusion = 23

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
ContributionType	String		The type of contribution basis, consist of the following: SuperannuationGuarantee, EmployeeAdditional, EmployerAdditional, Productivity, Redundancy, SalaySacrifice, Spouse.
Exclusion	Decimal		Amount to reduce an employees wage by before calculating superannuation.
PrintOnPayAdvice	Boolean		True indicates accrued superannuation will show on pay advices. False indicates accrued superannuation will not be shown on pay advices.
Threshold	Decimal		Amount if superannuation is only payable when wages exceed a certain $$ per month.
Type	String		Indicates the type of payroll category ie: Wage, Expense, Deduction.
LimitType	String		The type of calculation to use can be any of the following 3: NoLimit - no limits in place on contribution calculations. PercentageOfPayrollCategory - Equals x percentage, limit is calculated as a % of gross wages or another payroll category. FixedDollars - Equals x dollar limit set.
Name	String		Name of the object.
PayrollCategoryID	Uuid	PayrollCategories.ID	Unique category identifier in the form of a guid.
PayrollCategoryName	String		Name of the category.
PayrollCategoryType	String		Indicates the type of payroll category ie: Wage, Expense, Deduction.
PayrollCategoryURI	String		Uniform resource identifier associated with the category object.
CalculationBasisPercentageOf	Decimal		Percentage of super to calculate if CalculationBasis.Type = PercentageOfPayrollCategory.
CalculationBasisType	String		The type of calculation to use can be any of the following 3: UserEntered - use amount on employees standard pay when processing. PercentageOfPayrollCategory - Equals x percentage, calculate as a % of gross wages or another payroll category. FixedDollars - Equals x dollar to contribute for all linked employees.
ExpenseAccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
ExpenseAccountDisplayID	String		Account code. Format includes separator ie 4-1100
ExpenseAccountName	String		Name of the account.
ExpenseAccountURI	String		Uniform resource identifier associated with the account object.
PayableAccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
PayableAccountDisplayID	String		Account code. Format includes separator ie 4-1100
PayableAccountName	String		Name of the account.
PayableAccountURI	String		Uniform resource identifier associated with the account object.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
Exemptions	String		An array of wage categories the superannuation category is exempt from.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PayrollTaxes

Return payroll categories of type tax 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Name, StpCategory, Type, TaxTableRevisionDate, PayableAccountID, PayableAccountDisplayID, PayableAccountName. All the other columns and operators are processed client side.

SELECT * FROM PayrollTaxes WHERE PayableAccountID = "02c3f70b-2570-4f2b-bd51-560c65ecb1df"
SELECT * FROM PayrollTaxes WHERE Name = "PAYG Withholding"
SELECT * FROM PayrollTaxes WHERE StpCategory = "PAYGWitholding"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Name	String		Name of the wage category.
StpCategory	String		STP Category for this payroll category. See MYOB help for more info. Valid values are: NotReportable (default), GrossPayments, PAYGWithholding, ExemptForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type	String		Indicates the type of payroll category ie: Wage, Expense, Deduction.
TaxTableRevisionDate	Datetime		The date payroll tax tables loaded in AccountRight were last updated.
PayableAccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
PayableAccountDisplayID	String		Account code. Format includes separator ie 4-1100
PayableAccountName	String		Name of the account.
PayableAccountURI	String		Uniform resource identifier associated with the account object.
URI	String		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PayrollTaxTables

Return payroll tax tables loaded into 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, Name. All the other columns and operators are processed client side.

SELECT * FROM PayrollTaxTables WHERE ID = "3a35e83a-5070-432d-b6ec-f4791f353352"
SELECT * FROM PayrollTaxTables WHERE Name = "criteria"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
Name	String		Name of the payroll tax table.
RowVersion	String		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		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PriceLevelDetail

Tax codes for an AccountRight company file.

Columns


Name	Type	References	Description
Name	String		Name of price level.
Value	String		Associated label of price level.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ProfitAndLossSummaryReport

Returns a Profit and Loss Summary for an AccountRight 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: EndDate, StartDate, ReportingBasis, YearEndAdjust. All the other columns and operators are processed client side. The default behavior is EndDate as today's date, StartDate as the first day of the year, ReportingBasis as Cash, and YearEndAdjust as false; if the EndDate, StartDate, ReportingBasis, and YearEndAdjust filters are left unset.

SELECT * FROM ProfitAndLossSummaryReport

To override this behavior, the values can be set directly in the query. For example:

SELECT * FROM ProfitAndLossSummaryReport WHERE StartDate = "12/01/2018" AND EndDate = "01/04/2019" AND ReportingBasis = "Cash" AND YearEndAdjust = false

Columns


Name	Type	References	Description
AccountTotal	Decimal		Total Amount for the Account for the given date range.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
EndDate	Date		Starting date of the period.
StartDate	Date		Ending date of the period.
ReportingBasis	String		Reporting basis for the period, will either be Cash or Accural.
YearEndAdjust	Boolean		If you are including Year end Adjustments. This is a true or False value.
CompanyFileId	String		The ID of the company file.

ProfitLossDistributions

Returns the Profit and Loss Distribution of an AccountRight company file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
Entity	String		Entity of the Profit and Loss Distribution.
HeaderAccountID	Uuid	Accounts.ID	Unique identifier for the header account in the form of a guid.
HeaderAccountDisplayID	String		Header Account code. Format includes separator ie 4-1100
HeaderAccountName	String		Name of the header account.
HeaderAccountURI	String		Uniform resource identifier associated with the header account object.
RetainedEarningsAccountID	Uuid	Accounts.ID	Unique identifier for the retained earnings account in the form of a guid.
RetainedEarningsAccountDisplayID	String		Retained Earnings Account code. Format includes separator ie 4-1100
RetainedEarningsAccountName	String		Name of the retained earnings account.
RetainedEarningsAccountURI	String		Uniform resource identifier associated with the retained earnings account object.
CurrentEarningsAccountID	Uuid	Accounts.ID	Unique identifier for the current earnings account in the form of a guid.
CurrentEarningsAccountDisplayID	String		Current Earnings Account code. Format includes separator ie 4-1100
CurrentEarningsAccountName	String		Name of the current earnings account.
CurrentEarningsAccountURI	String		Uniform resource identifier associated with the current earnings account object.
Value	Double		Value to be allocated to the account.
Unit	String		Unit that the Value is measured in.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
CompanyFileId	String		The ID of the company file.

PurchaseBillItems

Return all purchase bill types for an AccountRight company file.

Table Specific Information

Select

Only the PurchaseBillId and BillType columns, when using the equality comparison, are supported for server side filtering. If left unspecified, the BillType column will default to 'Item'.

Columns


Name	Type	References	Description
PurchaseBillId	Uuid		Unique identifier in the form of a guid.
Date	Datetime		Transaction date entry.
Description	String		Description text for the line.
Total	Decimal		Total amount for the line item only.
Type	String		Bill line type, can consist of the following: Transaction - All fields detailed in Lines array are consumable. Header - Only allows you to POST to Description element. Subtotal - Calculated value that is read-only.
BillQuantity	Decimal		The quantity of goods shipped.
ReceivedQuantity	Decimal		The quantity of goods received.
BackorderQuantity	Decimal		Please note: To be implemented when Purchase Order functionality is available.
UnitPrice	Decimal		Price per unit.
DiscountPercent	Double		Discount rate applicable to the line item.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
JobID	Uuid	Jobs.ID	Unique job identifier in the form of a guid.
JobName	String		Name assigned to the job.
JobNumber	String		Number assigned to the job.
JobURI	String		Uniform resource identifier associated with the job object.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String		3 digit tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
ItemID	Uuid	Items.ID	Unique identifier in the form of a guid.
ItemName	String		Name of the item.
ItemNumber	String		The number assigned to the item.
ItemURI	String		Uniform resource identifier associated with the item.
RowID	Integer		Sequence of the entry within the item.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
BillType	String		Type of the bill. One of: Item,Service,Professional,Miscellaneous.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

PurchaseOrderItems

Return all purchase order types for an AccountRight company file.

Table Specific Information

Select

Only the PurchaseOrderId and OrderType columns, when using the equality comparison, are supported for server side filtering. If left unspecified, the OrderType column will default to 'Item'.

Columns


Name	Type	References	Description
PurchaseOrderId	Uuid		Unique identifier in the form of a guid.
BillQuantity	Decimal		The quantity of goods shipped.
Description	String		Description text for the line.
DiscountPercent	Double		Discount rate applicable to the line item.
ReceivedQuantity	Decimal		Received quantity.
Total	Decimal		Total amount for the line item only.
Type	String		Line type, can consist of the following: Transaction - All fields detailed in Lines array are consumable. Header - Only allows you to POST to Description element. Subtotal - Calculated value that is read-only.
UnitPrice	Decimal		Price per unit.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
JobID	Uuid	Jobs.ID	Unique job identifier in the form of a guid.
JobName	String		Name assigned to the job.
JobNumber	String		Number assigned to the job.
JobURI	String		Uniform resource identifier associated with the job object.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String		3 digit tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
ItemID	Uuid	Items.ID	Unique identifier in the form of a guid.
ItemName	String		Name of the item.
ItemNumber	String		The number assigned to the item.
ItemURI	String		Uniform resource identifier associated with the item.
RowID	Integer		Sequence of the entry within the item.
RowVersion	String		Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.
OrderType	String		Type of the order. One of: Item,Service,Professional,Miscellaneous.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

ReceivingTransactionItems

Receive money transactions for an AccountRight company file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
TransactionID	Uuid	ReceivingTransactions.ID	Unique identifier in the form of a guid.
Amount	Double		Amount to be allocated to the account.
Memo	String		Memo text describing the transaction line.
RowID	Integer		Sequence of the entry within the spend money set.
RowVersion	String		RowVersion. Required during update to identify the line item.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
JobID	Uuid	Jobs.ID	Unique job identifier in the form of a guid.
JobName	String		Name assigned to the job.
JobNumber	String		Number assigned to the job.
JobURI	String		Uniform resource identifier associated with the job object.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String		3 digit tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SaleInvoiceItems

Return all sale invoice types for an AccountRight company file.

Table Specific Information

Select

Only the SaleInvoiceId and InvoiceType columns, when using the equality comparison, are supported for server side filtering. If left unspecified, the InvoiceType column will default to 'Item'.

Columns


Name	Type	References	Description
SaleInvoiceId	Uuid		Unique identifier in the form of a guid.
DiscountPercent	Double		Discount rate applicable to the line of the sale invoice.
Description	String		Description text for the sale line.
CostOfGoodsSold	Decimal		Cost Of the Goods Sold
RowID	Integer		Sequence of the entry within the item sale invoice set.
RowVersion	String		The RowVersion or the line item.
ShipQuantity	Decimal		The quantity of goods shipped.
Total	Decimal		Invoice line type, can consist of the following: Transaction - All fields detailed in Lines array are consumable. Header - Only allows you to POST to Description element. Subtotal - Calculated value that is read-only.
Type	String		The type of the invoice.
UnitPrice	Decimal		Price per unit.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
ItemID	Uuid	Items.ID	Unique identifier in the form of a guid.
ItemName	String		Name of the item.
ItemNumber	String		The number assigned to the item.
ItemURI	String		Uniform resource identifier associated with the item.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String		3 digit tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
JobID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the job for the line of the item sale.
JobNumber	String		Number assigned to the job.
JobName	String		Name assigned to the job.
JobURI	String		Uniform resource identifier associated with the job object.
LocationID	Uuid	TaxCodes.ID	Unique identifier for location in the form of a guid.
LocationIdentifier	String		Identifier assigned to the location.
LocationName	String		Name assigned to the location.
LocationURI	String		Uniform resource identifier associated with the location object.
InvoiceType	String		The type of the invoice. One of: Item,Service,Professional,TimeBilling,Miscellaneous.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SaleOrderItems

Returns all sale order types for an AccountRight company file.

Table Specific Information

Select

Only the SaleOrderId and OrderType columns, when using the equality comparison, are supported for server side filtering. If left unspecified, the OrderType column will default to 'Item'.

Columns


Name	Type	References	Description
SaleOrderId	Uuid		Unique identifier in the form of a guid.
DiscountPercent	Double		Discount rate applicable to the line of the sale order.
Description	String		Description text for the sale line.
RowID	Integer		Sequence of the entry within the item sale order set.
RowVersion	String		The RowVersion or the line item.
ShipQuantity	Decimal		The quantity of goods shipped.
Total	Decimal		Order line type, can consist of the following: Transaction - All fields detailed in Lines array are consumable. Header - Only allows you to POST to Description element. Subtotal - Calculated value that is read-only.
Type	String		Line type, can consist of the following: Transaction - All fields detailed in Lines array are consumable. Header - Only allows you to POST to Description element. Subtotal - Calculated value that is read-only.
UnitPrice	Decimal		Price per unit.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
ItemID	Uuid	Items.ID	Unique identifier in the form of a guid.
ItemName	String		Name of the item.
ItemNumber	String		The number assigned to the item.
ItemURI	String		Uniform resource identifier associated with the item.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String		3 digit tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
OrderType	String		Type of the order. One of: Item,Service,Professional,TimeBilling,Miscellaneous.
Comment	String		Sales Order Comment
ShippingMethod	String		Shipping Method
PromisedDate	Datetime		Transaction Promised Date.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SaleQuoteItems

Return all sale quote types for an AccountRight company file.

Table Specific Information

Select

Only the SaleQuoteId and QuoteType columns, when using the equality comparison, are supported for server side filtering. If left unspecified, the QuoteType column will default to 'Item'.

Columns


Name	Type	References	Description
SaleQuoteId	Uuid		Unique identifier in the form of a guid.
DiscountPercent	Double		Discount rate applicable to the line of the sale quote.
Description	String		Description text for the sale line.
RowID	Integer		Sequence of the entry within the item sale quote set.
RowVersion	String		The RowVersion or the line item.
ShipQuantity	Decimal		The quantity of goods shipped.
Total	Decimal		Total amount for the line item only.
Type	String		Quote line type, can consist of the following: Transaction - All fields detailed in Lines array are consumable. Header - Only allows you to POST to Description element. Subtotal - Calculated value that is read-only.
UnitPrice	Decimal		Price per unit.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
ItemID	Uuid	Items.ID	Unique identifier in the form of a guid.
ItemName	String		Name of the item.
ItemNumber	String		The number assigned to the item.
ItemURI	String		Uniform resource identifier associated with the item.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String		3 digit tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
QuoteType	String		The type of the quote. One of: Item,Service,Professional,TimeBilling,Miscellaneous.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SpendingTransactionItems

Spend money transaction items for an AccountRight company file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
TransactionID	Uuid	SpendingTransactions.ID	Unique identifier in the form of a guid.
Amount	Double		Amount to be allocated to the account.
Memo	String		Memo text describing the transaction line.
RowID	Integer		Sequence of the entry within the spend money set.
RowVersion	String		RowVersion. Required during update to identify the line item.
AccountID	Uuid	Accounts.ID	Unique identifier for the account in the form of a guid.
AccountDisplayID	String		Account code. Format includes separator ie 4-1100
AccountName	String		Name of the account.
AccountURI	String		Uniform resource identifier associated with the account object.
JobID	Uuid	Jobs.ID	Unique job identifier in the form of a guid.
JobName	String		Name assigned to the job.
JobNumber	String		Number assigned to the job.
JobURI	String		Uniform resource identifier associated with the job object.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeCode	String		3 digit tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SuperannuationFunds

Superannuation fund details 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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: ID, EmployerMembershipNumber, Name, PhoneNumber, Website. All the other columns and operators are processed client side.

SELECT * FROM SuperannuationFunds WHERE ID = "a05b34e5-5d10-465a-98ae-aa2a7eb65a35"
SELECT * FROM SuperannuationFunds WHERE Name = "AMP Life"

Columns


Name	Type	References	Description
ID [KEY]	Uuid		Unique identifier in the form of a guid.
EmployerMembershipNumber	String		Employer Membership number.
Name	String		Name of the superannuation fund.
PhoneNumber	String		Superannuation fund contact phone number.
Website	String		World wide web address for superannuation fund.
RowVersion	String		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		Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

SupplierPaymentItems

Supplier payment items for an AccountRight company file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
SupplierPaymentID [KEY]	Uuid		Unique identifier in the form of a guid.
AmountApplied	Double		Amount applied to the purchase bill or order.
Type	String		Purchase type, can consist of the following: Bill, Order.
PurchaseID	Uuid		Unique guid identifier belonging to the supplier purchase bill or order.
PurchaseNumber	String		Purchase bill/order number.
PurchaseURI	String		Uniform resource identifier associated with the purchase bill/order object.
RowID	Integer		Sequence of the entry within the supplier payment set.
RowVersion	String		Incrementing number that can be used for change control but does does not preserve a date or a time.
CompanyFileId	String	CompanyFiles.ID	ID of the company file. Takes precedence over the CompanyFileId property.

TaxCodeSummaryReport

Returns a Tax Code Summary Report for AccountRight files.

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 criteria can be executed by combining the criteria with AND and OR operators. These columns support the above comparison types for server side filtering: EndDate, StartDate, ReportingBasis, YearEndAdjust. All the other columns and operators are processed client side. The default behavior is EndDate as today's date, StartDate as the first day of the year, ReportingBasis as Cash, and YearEndAdjust as false; if the EndDate, StartDate, ReportingBasis, and YearEndAdjust filters are left unset.

SELECT * FROM TaxCodeSummaryReport

To override this behavior, the values can be set directly in the query. For example:

SELECT * FROM TaxCodeSummaryReport WHERE StartDate = "12/01/2018" AND EndDate = "01/04/2019" AND ReportingBasis = "Cash" AND YearEndAdjust = false

Columns


Name	Type	References	Description
PurchasesTotal	Decimal		Total Purchases amount for a Tax Code.
SalesTotal	Decimal		Total Tax Collected amount for a Tax Code.
TaxCodeCode	String		3 digit tax code.
TaxCodeID	Uuid	TaxCodes.ID	Unique guid identifier belonging to the assigned tax code.
TaxCodeURI	String		Uniform resource identifier associated with the tax code object.
TaxCollected	Decimal		Total Tax Collected amount for a Tax Code.
TaxPaid	Decimal		Total Tax Paid amount for a Tax Code.
TaxRate	Decimal		Tax Rate for the Tax Code.
StartDate	Date		Ending date of the period.
EndDate	Date		Starting date of the period.
ReportingBasis	String		Reporting basis for the period, will either be Cash or Accural.
YearEndAdjust	Boolean		If you are including Year end Adjustments. This is a true or False value.
CompanyFileId	String		The ID of the company file.

TransactionCodingSummaryReport

Returns a report of the total number of coded and uncoded transactions in an AccountRight file.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns


Name	Type	References	Description
Year	Integer		The calender year.
Month	Integer		Number representing the month of the year. For example: 5 indicates May.
TotalReceived	Integer		Total number of bankfeed transactions received.
AutoCoded	Integer		Total number of transaction that have been coded using BankFeed Rules.
Uncoded	Integer		Total number of bankfeed transactions that have not been coded
CompanyFileId	String		The ID of the company file.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
AuthScheme	The scheme used for authentication. Accepted entries are Basic and OAuth.
User	認証するMYOB ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。

Connection

プロパティ	説明
Instance	Whether to use On-Premise instance or Cloud instance when connecting to MyOB
CompanyFileId	The ID of the company file. If not specified, the ID of the first returned company file will be used.
URL	MYOB インスタンスのURL。

OAuth

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
IncludeCFToken	Depending on the MYOB instance configuration, a CFToken header being included may cause requests to fail. In these cases, this property should be set to false to omit the header.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	MYOB から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
AuthScheme	The scheme used for authentication. Accepted entries are Basic and OAuth.
User	認証するMYOB ユーザーアカウントのユーザーID を指定します。
Password	認証するユーザーアカウントのパスワードを指定します。

AuthScheme

The scheme used for authentication. Accepted entries are Basic and OAuth.

解説

The available authentication options are:

Basic: Set this to use HTTP Basic authentication.
OAuth: Set this to use OAuth authentication. Only available for MYOB cloud instance.

User

認証するMYOB ユーザーアカウントのユーザーID を指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

Password

認証するユーザーアカウントのパスワードを指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

Connection

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。

プロパティ	説明
Instance	Whether to use On-Premise instance or Cloud instance when connecting to MyOB
CompanyFileId	The ID of the company file. If not specified, the ID of the first returned company file will be used.
URL	MYOB インスタンスのURL。

Instance

Whether to use On-Premise instance or Cloud instance when connecting to MyOB

解説

Whether to use On-Premise instance or Cloud instance when connecting to MyOB

CompanyFileId

The ID of the company file. If not specified, the ID of the first returned company file will be used.

解説

This connection property is required to access all tables and views, except for the CompanyFiles view, which you can use to view the company files associated with your account (and their associated IDs).

SELECT Id FROM CompanyFiles

URL

MYOB インスタンスのURL。

解説

MYOB インスタンスのURL。

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。


プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がMYOB への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がMYOB への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がMYOB にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

BASIC：Sync App はHTTP BASIC 認証を行います。
DIGEST：Sync App はHTTP DIGEST 認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。


AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログの「高度なログの記録」セクションを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\MYOB Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：


プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
IncludeCFToken	Depending on the MYOB instance configuration, a CFToken header being included may cause requests to fail. In these cases, this property should be set to false to omit the header.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	MYOB から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

IncludeCFToken

Depending on the MYOB instance configuration, a CFToken header being included may cause requests to fail. In these cases, this property should be set to false to omit the header.

解説

When true, this property will cause the x-myobapi-cftoken header to be added to requests to the MYOB API. When false, this header will be ommitted.

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

MYOB から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Accounts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビューを参照してください。

MYOB Connector for CData Sync

MYOB Connector for CData Sync

概要

MYOB バージョンサポート

接続の確立

MYOB への接続を追加

MYOB への接続

MYOB への認証

高度な機能

ユーザー定義ビュー

SSL の設定

ファイアウォールとプロキシ

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

概要

主要機能

テーブル

ビュー

ストアドプロシージャ

テーブル

MYOB Connector for CData Sync テーブル

AccountBudgets

Table Specific Information

Select

Columns

Accounts

Table Specific Information

Select

Insert

Columns

Activities

Table Specific Information

Select

Insert

Columns

ActivitySlips

Table Specific Information

Select

Update

Insert

Columns

Build

Columns

ContactCustomers

Table Specific Information

Select

Insert

Update

Delete

Columns

ContactEmployees

Table Specific Information

Select

Insert

Update

Delete

Columns

ContactPersonals

Table Specific Information

Select

Insert

Update

Delete

Columns

Contacts

Table Specific Information

Select

Update

Insert

Columns

ContactSuppliers

Table Specific Information

Select