Akaunting

App · 13 actions

Keep small-business books in Akaunting from workflows: add customers and vendors from forms and CRMs, make invoices, record payments, bills and expenses from other systems, and find unpaid or overdue invoices. Start a workflow when an invoice is added or paid, or income or an expense is recorded.

Actions

ActionWhat it does
Create billRecord a bill from a vendor with its lines, as a draft or received.
Create customer or vendorAdd a customer or vendor.
Create invoiceMake an invoice for a customer with its lines, as a draft or marked sent.
Find customers or vendorsFind customers or vendors by words in their name, email, phone, address or tax number, or by email address.
Find invoicesFind invoices by status, customer, words or date, such as every unpaid or overdue one, newest first.
Find itemsFind products and services by words in their name or description, with their prices and taxes.
Get customer or vendorGet a customer's or vendor's details, by ID, email address or name.
Get invoiceGet an invoice's details, its lines, its status and the payments made on it.
List bank accountsList the company's bank and cash accounts with their balances.
List categoriesList the company's income, expense and item categories.
Record income or expenseRecord money in or out of a bank account that isn't against an invoice, such as a bank feed line or a receipt.
Record invoice paymentRecord money received against an invoice.
Update customer or vendorChange a customer's or vendor's details.

Create bill

Record a bill from a vendor with its lines, as a draft or received.

Inputs

VendorvendortextRequired
Who it's from: picked, or their ID, email address or exact name.
LineslineslistRequired
One row per line: an item, or a name and a price. An item's line takes its purchase price and taxes unless the row gives them.
Mark as receivedmark_as_receivedtrue/false
Mark it received straight away, as Akaunting's Mark as Received does. Otherwise it's a draft.Default: false.
Bill numberbill_numbertext
The vendor's number for it. Leave blank for Akaunting's next one, such as BILL-00012.
Dateissue_datedate
The date on it. Leave blank for today.
Due datedue_datedate
When it's due. Leave blank for Akaunting's payment terms for bills.
Order numberorder_numbertext
An order or purchase order number to show on it.
Notesnotestext
Notes printed on it.
Categorycategorytext
The expense category. Leave blank for the company's default.
Currencycurrencytext
Its currency. Leave blank for the customer's or vendor's own.

Outputs

categorytext
Its category
contact_emailtext
Their email address
contact_idnumber
The customer's or vendor's ID
contact_nametext
The customer's or vendor's name
created_attext
When it was added (ISO 8601)
currencytext
Its currency, such as USD
due_datetext
When it's due (YYYY-MM-DD)
idnumber
Its ID, for other Akaunting steps
issue_datetext
Its date (YYYY-MM-DD)
lineslist
Its lines
linktext
A link to it in Akaunting
notestext
The notes on it
numbertext
Its number, such as INV-00012
order_numbertext
The order number on it
overduetrue/false
Whether money is still owed after its due date
paidnumber
How much has been paid
paymentslist
The payments made on it
remainingnumber
How much is left to pay
statustext
draft, sent, viewed, received, partial, paid or cancelled
subtotalnumber
Its total before tax and discounts
taxnumber
The tax on it
totalnumber
Its total with tax
Example output
{
  "category": "Other",
  "contact_email": "sales@initech.example.com",
  "contact_id": 12,
  "contact_name": "Initech Supplies",
  "created_at": "2026-11-06T09:30:02+00:00",
  "currency": "USD",
  "due_date": "2026-12-06",
  "id": 42,
  "issue_date": "2026-11-06",
  "lines": [
    {
      "description": "November",
      "item_id": 1,
      "name": "Consulting hour",
      "price": 90,
      "tax": 36,
      "taxes": "VAT",
      "total": 180
    }
  ],
  "link": "https://akaunting.example.com/1/purchases/bills/7",
  "notes": "Thank you for your business.",
  "number": "BILL-00007",
  "order_number": "PO-7781",
  "overdue": false,
  "paid": 0,
  "payments": [],
  "remaining": 216,
  "status": "received",
  "subtotal": 180,
  "tax": 36,
  "total": 216
}

Create customer or vendor

Add a customer or vendor. If one of that type already has the email address, it's returned instead, unchanged.

Inputs

NamenametextRequired
The company's or person's name.
Typetypetext
Whether you sell to them or buy from them.One of: customer, vendor. Default: customer.
Emailemailtext
Their email address.
Phonephonetext
Their phone number.
Addressaddresstext
The street address.
Citycitytext
The town or city.
Postcodezip_codetext
The postcode or ZIP code.
Statestatetext
The state, county or province.
Countrycountrytext
The country's two-letter code, such as US or GB.
Tax numbertax_numbertext
Their VAT or tax number.
Websitewebsitetext
Their website.
Referencereferencetext
Your own reference for them, such as their ID in a CRM.
Currencycurrencytext
The currency they're invoiced or billed in. Leave blank for the company's own.

Outputs

addresstext
Their address
createdtrue/false
False when one with that email address was already there
created_attext
When they were added (ISO 8601)
currencytext
The currency they're invoiced or billed in, such as USD
emailtext
Their email address
enabledtrue/false
Whether they're enabled
idnumber
The customer's or vendor's ID, for other Akaunting steps
linktext
A link to them in Akaunting
nametext
Their name
phonetext
Their phone number
referencetext
Your reference for them, such as an ID in another system
tax_numbertext
Their tax number
typetext
customer or vendor
websitetext
Their website
Example output
{
  "address": "1 Main St",
  "created": true,
  "created_at": "2026-11-06T09:12:44+00:00",
  "currency": "USD",
  "email": "billing@acme.example.com",
  "enabled": true,
  "id": 12,
  "link": "https://akaunting.example.com/1/sales/customers/12",
  "name": "Acme Ltd",
  "phone": "+1 555 0100",
  "reference": "CRM-1042",
  "tax_number": "US123456",
  "type": "customer",
  "website": "https://acme.example.com"
}

Create invoice

Make an invoice for a customer with its lines, as a draft or marked sent. It takes the next invoice number unless you give one.

Inputs

CustomercustomertextRequired
Who it's for: picked, or their ID, email address or exact name.
LineslineslistRequired
One row per line: an item, or a name and a price. An item's line takes its sale price and taxes unless the row gives them.
Mark as sentmark_as_senttrue/false
Mark it sent straight away, as Akaunting's Mark as Sent does, for an invoice you send yourself. Otherwise it's a draft.Default: false.
Dateissue_datedate
The date on it. Leave blank for today.
Due datedue_datedate
When it's due. Leave blank for Akaunting's payment terms for invoices.
Invoice numberinvoice_numbertext
Its number. Leave blank for Akaunting's next one, such as INV-00012.
Order numberorder_numbertext
An order or purchase order number to show on it.
Notesnotestext
Notes printed on it.
Categorycategorytext
The income category. Leave blank for the company's default.
Currencycurrencytext
Its currency. Leave blank for the customer's or vendor's own.

Outputs

categorytext
Its category
contact_emailtext
Their email address
contact_idnumber
The customer's or vendor's ID
contact_nametext
The customer's or vendor's name
created_attext
When it was added (ISO 8601)
currencytext
Its currency, such as USD
due_datetext
When it's due (YYYY-MM-DD)
idnumber
Its ID, for other Akaunting steps
issue_datetext
Its date (YYYY-MM-DD)
lineslist
Its lines
linktext
A link to it in Akaunting
notestext
The notes on it
numbertext
Its number, such as INV-00012
order_numbertext
The order number on it
overduetrue/false
Whether money is still owed after its due date
paidnumber
How much has been paid
paymentslist
The payments made on it
remainingnumber
How much is left to pay
statustext
draft, sent, viewed, received, partial, paid or cancelled
subtotalnumber
Its total before tax and discounts
taxnumber
The tax on it
totalnumber
Its total with tax
Example output
{
  "category": "Sales",
  "contact_email": "billing@acme.example.com",
  "contact_id": 12,
  "contact_name": "Acme Ltd",
  "created_at": "2026-11-06T09:30:02+00:00",
  "currency": "USD",
  "due_date": "2026-12-06",
  "id": 42,
  "issue_date": "2026-11-06",
  "lines": [
    {
      "description": "November",
      "item_id": 1,
      "name": "Consulting hour",
      "price": 90,
      "tax": 36,
      "taxes": "VAT",
      "total": 180
    }
  ],
  "link": "https://akaunting.example.com/1/sales/invoices/42",
  "notes": "Thank you for your business.",
  "number": "INV-00042",
  "order_number": "PO-7781",
  "overdue": false,
  "paid": 100,
  "payments": [
    {
      "account": "Cash",
      "amount": 100,
      "currency": "USD",
      "date": "2026-11-06",
      "id": 31,
      "number": "TRA-00031",
      "payment_method": "Bank Transfer",
      "reference": "BANK-123"
    }
  ],
  "remaining": 116,
  "status": "sent",
  "subtotal": 180,
  "tax": 36,
  "total": 216
}

Find customers or vendors

Find customers or vendors by words in their name, email, phone, address or tax number, or by email address.

Inputs

Typetypetext
Customers or vendors.One of: customer, vendor. Default: customer.
Searchsearchtext
Words in the name, email, phone, address, website or tax number.
Emailemailtext
Only the one with this email address.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

contactslist
The customers or vendors found
countnumber
How many are listed
totalnumber
How many match in all
Example output
{
  "contacts": [
    {
      "address": "1 Main St",
      "created_at": "2026-11-06T09:12:44+00:00",
      "currency": "USD",
      "email": "billing@acme.example.com",
      "enabled": true,
      "id": 12,
      "link": "https://akaunting.example.com/1/sales/customers/12",
      "name": "Acme Ltd",
      "phone": "+1 555 0100",
      "reference": "CRM-1042",
      "tax_number": "US123456",
      "type": "customer",
      "website": "https://acme.example.com"
    }
  ],
  "count": 1,
  "total": 1
}

Find invoices

Find invoices by status, customer, words or date, such as every unpaid or overdue one, newest first.

Inputs

Statusstatustext
Which invoices. Unpaid is sent, viewed or part paid; overdue is unpaid past its due date.One of: any, draft, sent, viewed, partial (Partially paid), unpaid, overdue, paid, cancelled. Default: any.
Customercustomertext
Only this customer's invoices.
Searchsearchtext
Words in the invoice's number, order number or customer's details.
Dated fromdate_fromdate
Only invoices dated on or after this day.
Dated todate_todate
Only invoices dated on or before this day.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

amount_duenumber
What's left to pay on those listed
countnumber
How many are listed
invoiceslist
The invoices found, newest first
totalnumber
How many match in all
Example output
{
  "amount_due": 116,
  "count": 1,
  "invoices": [
    {
      "category": "Sales",
      "contact_email": "billing@acme.example.com",
      "contact_id": 12,
      "contact_name": "Acme Ltd",
      "created_at": "2026-11-06T09:30:02+00:00",
      "currency": "USD",
      "due_date": "2026-12-06",
      "id": 42,
      "issue_date": "2026-11-06",
      "link": "https://akaunting.example.com/1/sales/invoices/42",
      "notes": "Thank you for your business.",
      "number": "INV-00042",
      "order_number": "PO-7781",
      "overdue": false,
      "paid": 100,
      "remaining": 116,
      "status": "sent",
      "subtotal": 180,
      "tax": 36,
      "total": 216
    }
  ],
  "total": 1
}

Find items

Find products and services by words in their name or description, with their prices and taxes.

Inputs

Searchsearchtext
Words in the name or description.
Typetypetext
Products, services or both.One of: any (Products and services), product (Products), service (Services). Default: any.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
itemslist
The items found, by name
totalnumber
How many match in all
Example output
{
  "count": 1,
  "items": [
    {
      "category": "General",
      "description": "One hour of consulting",
      "enabled": true,
      "id": 1,
      "name": "Consulting hour",
      "purchase_price": 0,
      "sale_price": 90,
      "taxes": "VAT",
      "type": "service"
    }
  ],
  "total": 1
}

Get customer or vendor

Get a customer's or vendor's details, by ID, email address or name.

Inputs

Customer or vendorcontacttextRequired
Who: picked, or their ID, email address or exact name.

Outputs

addresstext
Their address
created_attext
When they were added (ISO 8601)
currencytext
The currency they're invoiced or billed in, such as USD
emailtext
Their email address
enabledtrue/false
Whether they're enabled
idnumber
The customer's or vendor's ID, for other Akaunting steps
linktext
A link to them in Akaunting
nametext
Their name
phonetext
Their phone number
referencetext
Your reference for them, such as an ID in another system
tax_numbertext
Their tax number
typetext
customer or vendor
websitetext
Their website
Example output
{
  "address": "1 Main St",
  "created_at": "2026-11-06T09:12:44+00:00",
  "currency": "USD",
  "email": "billing@acme.example.com",
  "enabled": true,
  "id": 12,
  "link": "https://akaunting.example.com/1/sales/customers/12",
  "name": "Acme Ltd",
  "phone": "+1 555 0100",
  "reference": "CRM-1042",
  "tax_number": "US123456",
  "type": "customer",
  "website": "https://acme.example.com"
}

Get invoice

Get an invoice's details, its lines, its status and the payments made on it.

Inputs

InvoiceinvoicetextRequired
The invoice's ID or its number, such as INV-00012.

Outputs

categorytext
Its category
contact_emailtext
Their email address
contact_idnumber
The customer's or vendor's ID
contact_nametext
The customer's or vendor's name
created_attext
When it was added (ISO 8601)
currencytext
Its currency, such as USD
due_datetext
When it's due (YYYY-MM-DD)
idnumber
Its ID, for other Akaunting steps
issue_datetext
Its date (YYYY-MM-DD)
lineslist
Its lines
linktext
A link to it in Akaunting
notestext
The notes on it
numbertext
Its number, such as INV-00012
order_numbertext
The order number on it
overduetrue/false
Whether money is still owed after its due date
paidnumber
How much has been paid
paymentslist
The payments made on it
remainingnumber
How much is left to pay
statustext
draft, sent, viewed, received, partial, paid or cancelled
subtotalnumber
Its total before tax and discounts
taxnumber
The tax on it
totalnumber
Its total with tax
Example output
{
  "category": "Sales",
  "contact_email": "billing@acme.example.com",
  "contact_id": 12,
  "contact_name": "Acme Ltd",
  "created_at": "2026-11-06T09:30:02+00:00",
  "currency": "USD",
  "due_date": "2026-12-06",
  "id": 42,
  "issue_date": "2026-11-06",
  "lines": [
    {
      "description": "November",
      "item_id": 1,
      "name": "Consulting hour",
      "price": 90,
      "tax": 36,
      "taxes": "VAT",
      "total": 180
    }
  ],
  "link": "https://akaunting.example.com/1/sales/invoices/42",
  "notes": "Thank you for your business.",
  "number": "INV-00042",
  "order_number": "PO-7781",
  "overdue": false,
  "paid": 100,
  "payments": [
    {
      "account": "Cash",
      "amount": 100,
      "currency": "USD",
      "date": "2026-11-06",
      "id": 31,
      "number": "TRA-00031",
      "payment_method": "Bank Transfer",
      "reference": "BANK-123"
    }
  ],
  "remaining": 116,
  "status": "sent",
  "subtotal": 180,
  "tax": 36,
  "total": 216
}

List bank accounts

List the company's bank and cash accounts with their balances.

Inputs

Include disabledinclude_disabledtrue/false
Also list those switched off.Default: false.

Outputs

accountslist
The accounts
countnumber
How many are listed
Example output
{
  "accounts": [
    {
      "balance": 1250.4,
      "bank_name": "Cash",
      "currency": "USD",
      "enabled": true,
      "id": 1,
      "name": "Cash",
      "number": "1",
      "opening_balance": 0,
      "type": "bank"
    }
  ],
  "count": 1
}

List categories

List the company's income, expense and item categories.

Inputs

Typetypetext
Which categories.One of: any (All), income, expense, item, other. Default: any.
Include disabledinclude_disabledtrue/false
Also list those switched off.Default: false.

Outputs

categorieslist
The categories
countnumber
How many are listed
Example output
{
  "categories": [
    {
      "enabled": true,
      "id": 3,
      "name": "Sales",
      "parent_id": 0,
      "type": "income"
    }
  ],
  "count": 1
}

Record income or expense

Record money in or out of a bank account that isn't against an invoice, such as a bank feed line or a receipt.

Inputs

TypetypetextRequired
Money in or money out.One of: income, expense.
AmountamountnumberRequired
How much.At least 0.01.
Datedatedate
When it was paid. Leave blank for today.
Accountaccounttext
The bank or cash account. Leave blank for the company's default account.
Categorycategorytext
An income or expense category, by name or ID, matching the type. Leave blank for the company's default.
Descriptiondescriptiontext
What it was for.
Customer or vendorcontacttext
Who paid or was paid: their ID, email address or exact name.
Payment methodpayment_methodtext
How it was paid, such as Bank Transfer. Leave blank for the company's default.
Referencereferencetext
A reference, such as a bank transaction ID.
Currencycurrencytext
Its currency. Leave blank for the account's own.

Outputs

accounttext
The account's name
account_idnumber
The account's ID
amountnumber
How much
categorytext
The category's name
category_idnumber
The category's ID
contacttext
The customer's or vendor's name
contact_idnumber
The customer's or vendor's ID; 0 if none
created_attext
When it was recorded (ISO 8601)
currencytext
Its currency
datetext
When it was paid (YYYY-MM-DD)
descriptiontext
Its description
document_idnumber
The invoice's or bill's ID it pays; 0 if none
idnumber
The transaction's ID
linktext
A link to it in Akaunting
numbertext
Its number, such as TRA-00032
payment_methodtext
How it was paid
referencetext
Its reference
typetext
income or expense
Example output
{
  "account": "Cash",
  "account_id": 1,
  "amount": 42.5,
  "category": "Other",
  "category_id": 4,
  "contact": "",
  "contact_id": 0,
  "created_at": "2026-11-06T10:01:12+00:00",
  "currency": "USD",
  "date": "2026-11-06",
  "description": "Office supplies",
  "document_id": 0,
  "id": 32,
  "link": "https://akaunting.example.com/1/banking/transactions/32",
  "number": "TRA-00032",
  "payment_method": "Cash",
  "reference": "RECEIPT-889",
  "type": "expense"
}

Record invoice payment

Record money received against an invoice. Once it's paid in full, Akaunting marks it paid.

Inputs

InvoiceinvoicetextRequired
The invoice's ID or its number, such as INV-00012.
Amountamountnumber
How much was paid. Leave blank for everything left to pay.At least 0.01.
Payment datedatedate
When it was paid. Leave blank for today.
Accountaccounttext
The bank or cash account. Leave blank for the company's default account.
Payment methodpayment_methodtext
How it was paid, such as Bank Transfer. Leave blank for the company's default.
Referencereferencetext
A reference, such as a bank transaction ID.
Descriptiondescriptiontext
A note on the payment.

Outputs

accounttext
The account it went into
amountnumber
How much was recorded
datetext
When it was paid (YYYY-MM-DD)
invoice_idnumber
The invoice's ID
invoice_numbertext
The invoice's number
invoice_statustext
The invoice's status now: partial or paid
invoice_totalnumber
The invoice's total
linktext
A link to the invoice in Akaunting
paidnumber
How much has been paid on the invoice in all
payment_idnumber
The payment's ID
payment_methodtext
How it was paid
payment_numbertext
The payment's number, such as TRA-00031
referencetext
The payment's reference
remainingnumber
How much is left to pay
Example output
{
  "account": "Cash",
  "amount": 100,
  "date": "2026-11-06",
  "invoice_id": 42,
  "invoice_number": "INV-00042",
  "invoice_status": "partial",
  "invoice_total": 216,
  "link": "https://akaunting.example.com/1/sales/invoices/42",
  "paid": 100,
  "payment_id": 31,
  "payment_method": "Bank Transfer",
  "payment_number": "TRA-00031",
  "reference": "BANK-123",
  "remaining": 116
}

Update customer or vendor

Change a customer's or vendor's details. Blank fields stay as they are.

Inputs

Customer or vendorcontacttextRequired
Who: picked, or their ID, email address or exact name.
Namenametext
A new name. Leave blank to keep it.
Emailemailtext
Their email address. Leave blank to keep it.
Phonephonetext
Their phone number. Leave blank to keep it.
Addressaddresstext
The street address. Leave blank to keep it.
Citycitytext
The town or city. Leave blank to keep it.
Postcodezip_codetext
The postcode or ZIP code. Leave blank to keep it.
Statestatetext
The state, county or province. Leave blank to keep it.
Countrycountrytext
The country's two-letter code, such as US or GB. Leave blank to keep it.
Tax numbertax_numbertext
Their VAT or tax number. Leave blank to keep it.
Websitewebsitetext
Their website. Leave blank to keep it.
Referencereferencetext
Your own reference for them, such as their ID in a CRM. Leave blank to keep it.
Currencycurrencytext
The currency they're invoiced or billed in. Leave blank to keep it.

Outputs

addresstext
Their address
created_attext
When they were added (ISO 8601)
currencytext
The currency they're invoiced or billed in, such as USD
emailtext
Their email address
enabledtrue/false
Whether they're enabled
idnumber
The customer's or vendor's ID, for other Akaunting steps
linktext
A link to them in Akaunting
nametext
Their name
phonetext
Their phone number
referencetext
Your reference for them, such as an ID in another system
tax_numbertext
Their tax number
typetext
customer or vendor
websitetext
Their website
Example output
{
  "address": "1 Main St",
  "created_at": "2026-11-06T09:12:44+00:00",
  "currency": "USD",
  "email": "billing@acme.example.com",
  "enabled": true,
  "id": 12,
  "link": "https://akaunting.example.com/1/sales/customers/12",
  "name": "Acme Ltd",
  "phone": "+1 555 0100",
  "reference": "CRM-1042",
  "tax_number": "US123456",
  "type": "customer",
  "website": "https://acme.example.com"
}

On this page