MYOB

App · 22 actions

Work with your MYOB Business or AccountRight books: customers, suppliers, items, sale invoices, customer payments, bills, accounts and tax codes.

Actions

ActionWhat it does
Create customerAdd a customer card for a company or an individual.
Create itemAdd an item you sell, buy, or both (not tracked in inventory).
Create service invoiceCreate a service sale invoice for a customer, with one or more lines.
Create supplierAdd a supplier card for a company or an individual.
Delete customerDelete a customer card.
Delete customer paymentDelete a recorded customer payment, which reopens the invoice it paid.
Delete itemDelete an item.
Delete service invoiceDelete a service sale invoice.
Delete supplierDelete a supplier card.
Get company infoGet the connected company file's name, address, tax numbers and whether it is read only.
Get customerGet one customer card with its addresses, selling details and balance.
Get invoiceGet one sale invoice with its lines.
Get itemGet one item with its prices, accounts and quantities.
List accountsList the chart of accounts with codes, kinds and balances.
List billsList purchase bills of every layout, newest first, filtered by status, supplier or date.
List customersList customer cards, most recently changed first, filtered by name, card ID, email or change date.
List invoicesList sale invoices of every layout, newest first, filtered by status, customer or date.
List itemsList items in the items list, by item number.
List suppliersList supplier cards, most recently changed first, filtered by name, card ID, email or change date.
List tax codesList every tax code in the company file with its rate.
Record customer paymentRecord money received from a customer and apply it to one of their invoices.
Update customerChange a customer card.

Create customer

Add a customer card for a company or an individual.

Inputs

Typecontact_typetextRequired
Whether the customer is a company or an individual.One of: company, individual.
Company namecompany_nametext
Needed for a company.
First namefirst_nametext
For an individual.
Last namelast_nametext
For an individual.
Card IDcard_idtext
Your own ID for the card, up to 15 characters, such as CUS000001. MYOB gives one if empty.
Emailemailtext
The email address on the first address.
Phonephonetext
Phone number on the first address.
Streetstreettext
Street on the first address.
Citycitytext
City on the first address.
Statestatetext
State on the first address.
Postcodepostcodetext
Postcode on the first address.
Countrycountrytext
Country on the first address.
Websitewebsitetext
Website on the first address.
Notesnotestext
Notes on the card.
Tax codetax_codetextRequired
The tax code used on its sales or purchases by default.
Freight tax codefreight_tax_codetext
The tax code for freight. Defaults to the tax code.
Invoice deliveryinvoice_deliverytext
How their invoices are sent by default. Defaults to 'To be printed'.One of: Print (To be printed), Email (To be emailed), PrintAndEmail (To be printed and emailed), Nothing (Already printed or sent). Default: Print.

Outputs

customerobject
The customer card
Example output
{
  "customer": {
    "CompanyName": "Clearwater Pty Ltd",
    "CurrentBalance": 1000.0,
    "DisplayID": "CUS000001",
    "FirstName": "Chris",
    "IsActive": true,
    "IsIndividual": false,
    "LastModified": "2026-11-18T05:04:32.993",
    "LastName": "Davis",
    "RowVersion": "-2085166627472539648",
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

Create item

Add an item you sell, buy, or both (not tracked in inventory).

Inputs

Item numbernumbertextRequired
Your unique number for the item, up to 30 characters.
Namenametext
The item's name, up to 30 characters.
Descriptiondescriptiontext
A description of the item.
Income accountincome_accounttext
For an item you sell: the account its sales are recorded in.
Selling priceselling_pricenumber
For an item you sell: its base price.
Sale tax codesale_tax_codetext
For an item you sell: its tax code. Needed with an income account.
Expense accountexpense_accounttext
For an item you buy: the account its purchases are recorded in.
Standard coststandard_costnumber
For an item you buy: its usual cost.
Purchase tax codepurchase_tax_codetext
For an item you buy: its tax code. Needed with an expense account.

Outputs

itemobject
The item
Example output
{
  "item": {
    "BaseSellingPrice": 150.0,
    "Description": "One hour of consulting",
    "IsActive": true,
    "IsBought": false,
    "IsSold": true,
    "Name": "Consulting hour",
    "Number": "ITEM-001",
    "QuantityOnHand": 0.0,
    "RowVersion": "-2085166627472539648",
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

Create service invoice

Create a service sale invoice for a customer, with one or more lines.

Inputs

Customercustomer_idtextRequired
The customer. Pick one, or use an ID from an earlier step.
DatedatedateRequired
The invoice date.
DescriptiondescriptiontextRequired
What the first line is for.
AmountamountnumberRequired
The first line's amount.
Income accountincome_accounttextRequired
The account the first line's sale is recorded in.
Tax codetax_codetextRequired
The first line's tax code.
More linesmore_lineslist
Further lines, each with a description, amount, account and tax_code (MYOB IDs).
Amounts include taxis_tax_inclusivetrue/false
Turn on when the amounts already include tax.
Invoice numbernumbertext
Your own invoice number. MYOB gives the next one if empty.
Customer PO numbercustomer_po_numbertext
The customer's purchase order number.
Commentcommenttext
A comment printed on the invoice.
Journal memojournal_memotext
The memo recorded in the journal.

Outputs

invoiceobject
The sale invoice
Example output
{
  "invoice": {
    "BalanceDueAmount": 110.0,
    "Customer": {
      "Name": "Clearwater Pty Ltd",
      "UID": "2b74006d-a599-42dd-b228-52596f49333c"
    },
    "Date": "2026-11-18T00:00:00",
    "Number": "00000123",
    "RowVersion": "-2085166627472539648",
    "Status": "Open",
    "TotalAmount": 110.0,
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

Create supplier

Add a supplier card for a company or an individual.

Inputs

Typecontact_typetextRequired
Whether the supplier is a company or an individual.One of: company, individual.
Company namecompany_nametext
Needed for a company.
First namefirst_nametext
For an individual.
Last namelast_nametext
For an individual.
Card IDcard_idtext
Your own ID for the card, up to 15 characters, such as CUS000001. MYOB gives one if empty.
Emailemailtext
The email address on the first address.
Phonephonetext
Phone number on the first address.
Streetstreettext
Street on the first address.
Citycitytext
City on the first address.
Statestatetext
State on the first address.
Postcodepostcodetext
Postcode on the first address.
Countrycountrytext
Country on the first address.
Websitewebsitetext
Website on the first address.
Notesnotestext
Notes on the card.
Tax codetax_codetextRequired
The tax code used on its sales or purchases by default.
Freight tax codefreight_tax_codetext
The tax code for freight. Defaults to the tax code.

Outputs

supplierobject
The supplier card
Example output
{
  "supplier": {
    "CompanyName": "Clearwater Pty Ltd",
    "CurrentBalance": 1000.0,
    "DisplayID": "CUS000001",
    "FirstName": "Chris",
    "IsActive": true,
    "IsIndividual": false,
    "LastModified": "2026-11-18T05:04:32.993",
    "LastName": "Davis",
    "RowVersion": "-2085166627472539648",
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

Delete customer

Delete a customer card. MYOB refuses if the customer has transactions.

Inputs

Customercustomer_idtextRequired
The customer. Pick one, or use an ID from an earlier step.

Outputs

deletedtrue/false
True once MYOB has deleted it
idtext
The MYOB ID of what was deleted
Example output
{
  "deleted": true,
  "id": "2b74006d-a599-42dd-b228-52596f49333c"
}

Delete customer payment

Delete a recorded customer payment, which reopens the invoice it paid.

Inputs

Payment IDpayment_idtextRequired
The payment's MYOB ID, from 'Record customer payment' or an earlier step.

Outputs

deletedtrue/false
True once MYOB has deleted it
idtext
The MYOB ID of what was deleted
Example output
{
  "deleted": true,
  "id": "2b74006d-a599-42dd-b228-52596f49333c"
}

Delete item

Delete an item. MYOB refuses if the item has been used.

Inputs

Itemitem_idtextRequired
The item. Pick one, or use an ID from an earlier step.

Outputs

deletedtrue/false
True once MYOB has deleted it
idtext
The MYOB ID of what was deleted
Example output
{
  "deleted": true,
  "id": "2b74006d-a599-42dd-b228-52596f49333c"
}

Delete service invoice

Delete a service sale invoice. MYOB refuses if payments are applied to it.

Inputs

Invoice IDinvoice_idtextRequired
The invoice's MYOB ID, from 'List invoices' or an earlier step.

Outputs

deletedtrue/false
True once MYOB has deleted it
idtext
The MYOB ID of what was deleted
Example output
{
  "deleted": true,
  "id": "2b74006d-a599-42dd-b228-52596f49333c"
}

Delete supplier

Delete a supplier card. MYOB refuses if the supplier has transactions.

Inputs

Suppliersupplier_idtextRequired
The supplier. Pick one, or use an ID from an earlier step.

Outputs

deletedtrue/false
True once MYOB has deleted it
idtext
The MYOB ID of what was deleted
Example output
{
  "deleted": true,
  "id": "2b74006d-a599-42dd-b228-52596f49333c"
}

Get company info

Get the connected company file's name, address, tax numbers and whether it is read only.

Inputs

None.

Outputs

companyobject
The company file's details
company_file_idtext
The company file's MYOB ID
Example output
{
  "company": {
    "ABNOrTFN": "80 000 000 001",
    "Address": "25 Spring Street Blackburn VIC 3130",
    "CompanyName": "Clearwater Pty Ltd",
    "EmailAddress": "info@clearwater.com.au",
    "PhoneNumber": "03 9555 4567",
    "ReadOnly": false,
    "SerialNumber": "610456761234"
  },
  "company_file_id": "5d4b1ce0-bb9f-4f4c-9578-2b168b7295db"
}

Get customer

Get one customer card with its addresses, selling details and balance.

Inputs

Customercustomer_idtextRequired
The customer. Pick one, or use an ID from an earlier step.

Outputs

customerobject
The customer card
Example output
{
  "customer": {
    "CompanyName": "Clearwater Pty Ltd",
    "CurrentBalance": 1000.0,
    "DisplayID": "CUS000001",
    "FirstName": "Chris",
    "IsActive": true,
    "IsIndividual": false,
    "LastModified": "2026-11-18T05:04:32.993",
    "LastName": "Davis",
    "RowVersion": "-2085166627472539648",
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

Get invoice

Get one sale invoice with its lines.

Inputs

Invoice IDinvoice_idtextRequired
The invoice's MYOB ID, from 'List invoices' or an earlier step.
Layoutlayouttext
The invoice's layout, as 'List invoices' shows it in InvoiceType. Defaults to Service.One of: Service, Item, Professional, TimeBilling (Time billing), Miscellaneous. Default: Service.

Outputs

invoiceobject
The sale invoice
Example output
{
  "invoice": {
    "BalanceDueAmount": 110.0,
    "Customer": {
      "Name": "Clearwater Pty Ltd",
      "UID": "2b74006d-a599-42dd-b228-52596f49333c"
    },
    "Date": "2026-11-18T00:00:00",
    "Number": "00000123",
    "RowVersion": "-2085166627472539648",
    "Status": "Open",
    "TotalAmount": 110.0,
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

Get item

Get one item with its prices, accounts and quantities.

Inputs

Itemitem_idtextRequired
The item. Pick one, or use an ID from an earlier step.

Outputs

itemobject
The item
Example output
{
  "item": {
    "BaseSellingPrice": 150.0,
    "Description": "One hour of consulting",
    "IsActive": true,
    "IsBought": false,
    "IsSold": true,
    "Name": "Consulting hour",
    "Number": "ITEM-001",
    "QuantityOnHand": 0.0,
    "RowVersion": "-2085166627472539648",
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

List accounts

List the chart of accounts with codes, kinds and balances.

Inputs

Classificationclassificationtext
Only accounts of this kind.One of: Asset, Liability, Equity, Income, CostOfSales (Cost of sales), Expense, OtherIncome (Other income), OtherExpense (Other expense).
Active onlyactive_onlytrue/false
Leave out inactive accounts.
Detail accounts onlydetail_onlytrue/false
Leave out header accounts, which only group others.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the page before.At least 0.

Outputs

accountslist
The accounts
countnumber
How many records match, across all pages
next_skipnumber
The Skip value for the next page, or empty when this is the last page
Example output
{
  "accounts": [
    {
      "Classification": "Income",
      "CurrentBalance": 2500.0,
      "DisplayID": "4-1100",
      "IsActive": true,
      "IsHeader": false,
      "Name": "Sales",
      "Type": "Income",
      "UID": "2b74006d-a599-42dd-b228-52596f49333c"
    }
  ],
  "count": 1,
  "next_skip": null
}

List bills

List purchase bills of every layout, newest first, filtered by status, supplier or date.

Inputs

Statusstatustext
Only bills with this status.One of: Open, Closed (Closed (paid)), Debit.
Suppliersupplier_idtext
Only this supplier's bills.
From datefrom_datedate
Only those dated on or after this day.
To dateto_datedate
Only those dated on or before this day.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the page before.At least 0.

Outputs

billslist
The bills
countnumber
How many records match, across all pages
next_skipnumber
The Skip value for the next page, or empty when this is the last page
Example output
{
  "bills": [
    {
      "BalanceDueAmount": 220.0,
      "Date": "2026-11-18T00:00:00",
      "Number": "00000045",
      "Status": "Open",
      "Supplier": {
        "Name": "Office Supplies Co",
        "UID": "2b74006d-a599-42dd-b228-52596f49333c"
      },
      "TotalAmount": 220.0,
      "UID": "2b74006d-a599-42dd-b228-52596f49333c",
      "URI": "https://api.myob.com/accountright/..."
    }
  ],
  "count": 1,
  "next_skip": null
}

List customers

List customer cards, most recently changed first, filtered by name, card ID, email or change date.

Inputs

Company namecompany_nametext
Only the card with exactly this company name.
Card IDcard_idtext
Only the card with exactly this card ID, such as CUS000001.
Emailemailtext
Only cards with exactly this email address.
Active onlyactive_onlytrue/false
Leave out inactive cards.
Changed sincemodified_sincedate
Only cards changed on or after this day.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the page before.At least 0.

Outputs

countnumber
How many records match, across all pages
customerslist
The customers
next_skipnumber
The Skip value for the next page, or empty when this is the last page
Example output
{
  "count": 1,
  "customers": [
    {
      "CompanyName": "Clearwater Pty Ltd",
      "CurrentBalance": 1000.0,
      "DisplayID": "CUS000001",
      "FirstName": "Chris",
      "IsActive": true,
      "IsIndividual": false,
      "LastModified": "2026-11-18T05:04:32.993",
      "LastName": "Davis",
      "RowVersion": "-2085166627472539648",
      "UID": "2b74006d-a599-42dd-b228-52596f49333c",
      "URI": "https://api.myob.com/accountright/..."
    }
  ],
  "next_skip": null
}

List invoices

List sale invoices of every layout, newest first, filtered by status, customer or date.

Inputs

Statusstatustext
Only invoices with this status.One of: Open, Closed (Closed (paid)), Credit.
Customercustomer_idtext
Only this customer's invoices.
From datefrom_datedate
Only those dated on or after this day.
To dateto_datedate
Only those dated on or before this day.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the page before.At least 0.

Outputs

countnumber
How many records match, across all pages
invoiceslist
The invoices
next_skipnumber
The Skip value for the next page, or empty when this is the last page
Example output
{
  "count": 1,
  "invoices": [
    {
      "BalanceDueAmount": 110.0,
      "Customer": {
        "Name": "Clearwater Pty Ltd",
        "UID": "2b74006d-a599-42dd-b228-52596f49333c"
      },
      "Date": "2026-11-18T00:00:00",
      "Number": "00000123",
      "RowVersion": "-2085166627472539648",
      "Status": "Open",
      "TotalAmount": 110.0,
      "UID": "2b74006d-a599-42dd-b228-52596f49333c",
      "URI": "https://api.myob.com/accountright/..."
    }
  ],
  "next_skip": null
}

List items

List items in the items list, by item number.

Inputs

Item numbernumbertext
Only the item with exactly this number.
Active onlyactive_onlytrue/false
Leave out inactive items.
Sold onlysold_onlytrue/false
Only items you sell.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the page before.At least 0.

Outputs

countnumber
How many records match, across all pages
itemslist
The items
next_skipnumber
The Skip value for the next page, or empty when this is the last page
Example output
{
  "count": 1,
  "items": [
    {
      "BaseSellingPrice": 150.0,
      "Description": "One hour of consulting",
      "IsActive": true,
      "IsBought": false,
      "IsSold": true,
      "Name": "Consulting hour",
      "Number": "ITEM-001",
      "QuantityOnHand": 0.0,
      "RowVersion": "-2085166627472539648",
      "UID": "2b74006d-a599-42dd-b228-52596f49333c",
      "URI": "https://api.myob.com/accountright/..."
    }
  ],
  "next_skip": null
}

List suppliers

List supplier cards, most recently changed first, filtered by name, card ID, email or change date.

Inputs

Company namecompany_nametext
Only the card with exactly this company name.
Card IDcard_idtext
Only the card with exactly this card ID, such as CUS000001.
Emailemailtext
Only cards with exactly this email address.
Active onlyactive_onlytrue/false
Leave out inactive cards.
Changed sincemodified_sincedate
Only cards changed on or after this day.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
Skipskipnumber
How many to skip, to get a later page. Use 'next_skip' from the page before.At least 0.

Outputs

countnumber
How many records match, across all pages
next_skipnumber
The Skip value for the next page, or empty when this is the last page
supplierslist
The suppliers
Example output
{
  "count": 1,
  "next_skip": null,
  "suppliers": [
    {
      "CompanyName": "Clearwater Pty Ltd",
      "CurrentBalance": 1000.0,
      "DisplayID": "CUS000001",
      "FirstName": "Chris",
      "IsActive": true,
      "IsIndividual": false,
      "LastModified": "2026-11-18T05:04:32.993",
      "LastName": "Davis",
      "RowVersion": "-2085166627472539648",
      "UID": "2b74006d-a599-42dd-b228-52596f49333c",
      "URI": "https://api.myob.com/accountright/..."
    }
  ]
}

List tax codes

List every tax code in the company file with its rate.

Inputs

None.

Outputs

countnumber
How many tax codes
tax_codeslist
The tax codes
Example output
{
  "count": 1,
  "tax_codes": [
    {
      "Code": "GST",
      "Description": "Goods & Services Tax",
      "Rate": 10.0,
      "Type": "GST_VAT",
      "UID": "2b74006d-a599-42dd-b228-52596f49333c"
    }
  ]
}

Record customer payment

Record money received from a customer and apply it to one of their invoices.

Inputs

Customercustomer_idtextRequired
The customer. Pick one, or use an ID from an earlier step.
Invoice IDinvoice_idtextRequired
The invoice's MYOB ID, from 'List invoices' or an earlier step.
AmountamountnumberRequired
The amount received and applied to the invoice.
Deposit todeposit_totext
Where the money goes. Defaults to a bank account.One of: Account (A bank account), UndepositedFunds (Undeposited funds). Default: Account.
Bank accountbank_accounttext
The bank account it is deposited in. Needed when depositing to a bank account.
Datedatedate
The payment date. Defaults to today in MYOB.
Payment methodpayment_methodtext
A payment method set up in the company file, such as Cash or EFTPOS.
Memomemotext
A memo for the payment.
Receipt numberreceipt_numbertext
Your own receipt number. MYOB gives one if empty.

Outputs

paymentobject
The customer payment
Example output
{
  "payment": {
    "AmountReceived": 110.0,
    "Customer": {
      "Name": "Clearwater Pty Ltd",
      "UID": "2b74006d-a599-42dd-b228-52596f49333c"
    },
    "Date": "2026-11-18T00:00:00",
    "DepositTo": "Account",
    "ReceiptNumber": "CR000012",
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

Update customer

Change a customer card. Only the fields you fill in change; the rest stay as they are.

Inputs

Customercustomer_idtextRequired
The customer. Pick one, or use an ID from an earlier step.
Typecontact_typetext
Whether the customer is a company or an individual. Leave empty to keep it.One of: company, individual.
Company namecompany_nametext
Needed for a company. Leave empty to keep it.
First namefirst_nametext
For an individual. Leave empty to keep it.
Last namelast_nametext
For an individual. Leave empty to keep it.
Card IDcard_idtext
Your own ID for the card, up to 15 characters, such as CUS000001. MYOB gives one if empty. Leave empty to keep it.
Emailemailtext
The email address on the first address. Leave empty to keep it.
Phonephonetext
Phone number on the first address. Leave empty to keep it.
Streetstreettext
Street on the first address. Leave empty to keep it.
Citycitytext
City on the first address. Leave empty to keep it.
Statestatetext
State on the first address. Leave empty to keep it.
Postcodepostcodetext
Postcode on the first address. Leave empty to keep it.
Countrycountrytext
Country on the first address. Leave empty to keep it.
Websitewebsitetext
Website on the first address. Leave empty to keep it.
Notesnotestext
Notes on the card. Leave empty to keep it.
Activeis_activetrue/false
Turn off to make the card inactive. Leave empty to keep it.
Tax codetax_codetext
A new default tax code. Leave empty to keep it.

Outputs

customerobject
The customer card
Example output
{
  "customer": {
    "CompanyName": "Clearwater Pty Ltd",
    "CurrentBalance": 1000.0,
    "DisplayID": "CUS000001",
    "FirstName": "Chris",
    "IsActive": true,
    "IsIndividual": false,
    "LastModified": "2026-11-18T05:04:32.993",
    "LastName": "Davis",
    "RowVersion": "-2085166627472539648",
    "UID": "2b74006d-a599-42dd-b228-52596f49333c",
    "URI": "https://api.myob.com/accountright/..."
  }
}

On this page