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
| Action | What it does |
|---|---|
| Create customer | Add a customer card for a company or an individual. |
| Create item | Add an item you sell, buy, or both (not tracked in inventory). |
| Create service invoice | Create a service sale invoice for a customer, with one or more lines. |
| Create supplier | Add a supplier card for a company or an individual. |
| Delete customer | Delete a customer card. |
| Delete customer payment | Delete a recorded customer payment, which reopens the invoice it paid. |
| Delete item | Delete an item. |
| Delete service invoice | Delete a service sale invoice. |
| Delete supplier | Delete a supplier card. |
| Get company info | Get the connected company file's name, address, tax numbers and whether it is read only. |
| Get customer | Get one customer card with its addresses, selling details and balance. |
| Get invoice | Get one sale invoice with its lines. |
| Get item | Get one item with its prices, accounts and quantities. |
| List accounts | List the chart of accounts with codes, kinds and balances. |
| List bills | List purchase bills of every layout, newest first, filtered by status, supplier or date. |
| List customers | List customer cards, most recently changed first, filtered by name, card ID, email or change date. |
| List invoices | List sale invoices of every layout, newest first, filtered by status, customer or date. |
| List items | List items in the items list, by item number. |
| List suppliers | List supplier cards, most recently changed first, filtered by name, card ID, email or change date. |
| List tax codes | List every tax code in the company file with its rate. |
| Record customer payment | Record money received from a customer and apply it to one of their invoices. |
| Update customer | Change a customer card. |
Create customer
Add a customer card for a company or an individual.
Inputs
- Type
contact_typetextRequired - Whether the customer is a company or an individual.One of:
company,individual. - Company name
company_nametext - Needed for a company.
- First name
first_nametext - For an individual.
- Last name
last_nametext - For an individual.
- Card ID
card_idtext - Your own ID for the card, up to 15 characters, such as CUS000001. MYOB gives one if empty.
- Email
emailtext - The email address on the first address.
- Phone
phonetext - Phone number on the first address.
- Street
streettext - Street on the first address.
- City
citytext - City on the first address.
- State
statetext - State on the first address.
- Postcode
postcodetext - Postcode on the first address.
- Country
countrytext - Country on the first address.
- Website
websitetext - Website on the first address.
- Notes
notestext - Notes on the card.
- Tax code
tax_codetextRequired - The tax code used on its sales or purchases by default.
- Freight tax code
freight_tax_codetext - The tax code for freight. Defaults to the tax code.
- Invoice delivery
invoice_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 number
numbertextRequired - Your unique number for the item, up to 30 characters.
- Name
nametext - The item's name, up to 30 characters.
- Description
descriptiontext - A description of the item.
- Income account
income_accounttext - For an item you sell: the account its sales are recorded in.
- Selling price
selling_pricenumber - For an item you sell: its base price.
- Sale tax code
sale_tax_codetext - For an item you sell: its tax code. Needed with an income account.
- Expense account
expense_accounttext - For an item you buy: the account its purchases are recorded in.
- Standard cost
standard_costnumber - For an item you buy: its usual cost.
- Purchase tax code
purchase_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
- Customer
customer_idtextRequired - The customer. Pick one, or use an ID from an earlier step.
- Date
datedateRequired - The invoice date.
- Description
descriptiontextRequired - What the first line is for.
- Amount
amountnumberRequired - The first line's amount.
- Income account
income_accounttextRequired - The account the first line's sale is recorded in.
- Tax code
tax_codetextRequired - The first line's tax code.
- More lines
more_lineslist - Further lines, each with a description, amount, account and tax_code (MYOB IDs).
- Amounts include tax
is_tax_inclusivetrue/false - Turn on when the amounts already include tax.
- Invoice number
numbertext - Your own invoice number. MYOB gives the next one if empty.
- Customer PO number
customer_po_numbertext - The customer's purchase order number.
- Comment
commenttext - A comment printed on the invoice.
- Journal memo
journal_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
- Type
contact_typetextRequired - Whether the supplier is a company or an individual.One of:
company,individual. - Company name
company_nametext - Needed for a company.
- First name
first_nametext - For an individual.
- Last name
last_nametext - For an individual.
- Card ID
card_idtext - Your own ID for the card, up to 15 characters, such as CUS000001. MYOB gives one if empty.
- Email
emailtext - The email address on the first address.
- Phone
phonetext - Phone number on the first address.
- Street
streettext - Street on the first address.
- City
citytext - City on the first address.
- State
statetext - State on the first address.
- Postcode
postcodetext - Postcode on the first address.
- Country
countrytext - Country on the first address.
- Website
websitetext - Website on the first address.
- Notes
notestext - Notes on the card.
- Tax code
tax_codetextRequired - The tax code used on its sales or purchases by default.
- Freight tax code
freight_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
- Customer
customer_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 ID
payment_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
- Item
item_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 ID
invoice_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
- Supplier
supplier_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
- Customer
customer_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 ID
invoice_idtextRequired - The invoice's MYOB ID, from 'List invoices' or an earlier step.
- Layout
layouttext - 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
- Item
item_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
- Classification
classificationtext - Only accounts of this kind.One of:
Asset,Liability,Equity,Income,CostOfSales(Cost of sales),Expense,OtherIncome(Other income),OtherExpense(Other expense). - Active only
active_onlytrue/false - Leave out inactive accounts.
- Detail accounts only
detail_onlytrue/false - Leave out header accounts, which only group others.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - 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
- Status
statustext - Only bills with this status.One of:
Open,Closed(Closed (paid)),Debit. - Supplier
supplier_idtext - Only this supplier's bills.
- From date
from_datedate - Only those dated on or after this day.
- To date
to_datedate - Only those dated on or before this day.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - 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 name
company_nametext - Only the card with exactly this company name.
- Card ID
card_idtext - Only the card with exactly this card ID, such as CUS000001.
- Email
emailtext - Only cards with exactly this email address.
- Active only
active_onlytrue/false - Leave out inactive cards.
- Changed since
modified_sincedate - Only cards changed on or after this day.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - 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
- Status
statustext - Only invoices with this status.One of:
Open,Closed(Closed (paid)),Credit. - Customer
customer_idtext - Only this customer's invoices.
- From date
from_datedate - Only those dated on or after this day.
- To date
to_datedate - Only those dated on or before this day.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - 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 number
numbertext - Only the item with exactly this number.
- Active only
active_onlytrue/false - Leave out inactive items.
- Sold only
sold_onlytrue/false - Only items you sell.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - 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 name
company_nametext - Only the card with exactly this company name.
- Card ID
card_idtext - Only the card with exactly this card ID, such as CUS000001.
- Email
emailtext - Only cards with exactly this email address.
- Active only
active_onlytrue/false - Leave out inactive cards.
- Changed since
modified_sincedate - Only cards changed on or after this day.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - 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
- Customer
customer_idtextRequired - The customer. Pick one, or use an ID from an earlier step.
- Invoice ID
invoice_idtextRequired - The invoice's MYOB ID, from 'List invoices' or an earlier step.
- Amount
amountnumberRequired - The amount received and applied to the invoice.
- Deposit to
deposit_totext - Where the money goes. Defaults to a bank account.One of:
Account(A bank account),UndepositedFunds(Undeposited funds). Default:Account. - Bank account
bank_accounttext - The bank account it is deposited in. Needed when depositing to a bank account.
- Date
datedate - The payment date. Defaults to today in MYOB.
- Payment method
payment_methodtext - A payment method set up in the company file, such as Cash or EFTPOS.
- Memo
memotext - A memo for the payment.
- Receipt number
receipt_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
- Customer
customer_idtextRequired - The customer. Pick one, or use an ID from an earlier step.
- Type
contact_typetext - Whether the customer is a company or an individual. Leave empty to keep it.One of:
company,individual. - Company name
company_nametext - Needed for a company. Leave empty to keep it.
- First name
first_nametext - For an individual. Leave empty to keep it.
- Last name
last_nametext - For an individual. Leave empty to keep it.
- Card ID
card_idtext - Your own ID for the card, up to 15 characters, such as CUS000001. MYOB gives one if empty. Leave empty to keep it.
- Email
emailtext - The email address on the first address. Leave empty to keep it.
- Phone
phonetext - Phone number on the first address. Leave empty to keep it.
- Street
streettext - Street on the first address. Leave empty to keep it.
- City
citytext - City on the first address. Leave empty to keep it.
- State
statetext - State on the first address. Leave empty to keep it.
- Postcode
postcodetext - Postcode on the first address. Leave empty to keep it.
- Country
countrytext - Country on the first address. Leave empty to keep it.
- Website
websitetext - Website on the first address. Leave empty to keep it.
- Notes
notestext - Notes on the card. Leave empty to keep it.
- Active
is_activetrue/false - Turn off to make the card inactive. Leave empty to keep it.
- Tax code
tax_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/..."
}
}