# Akaunting

> 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.

App · 13 actions. Web page: https://docs.lodol.com/docs/integrations/akaunting

## Actions

### Create bill

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

**Inputs**

- Vendor (`vendor`, text, required): Who it's from: picked, or their ID, email address or exact name.
- Lines (`lines`, list, required): 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 received (`mark_as_received`, true/false): Mark it received straight away, as Akaunting's Mark as Received does. Otherwise it's a draft. Default: `false`.
- Bill number (`bill_number`, text): The vendor's number for it. Leave blank for Akaunting's next one, such as BILL-00012.
- Date (`issue_date`, date): The date on it. Leave blank for today.
- Due date (`due_date`, date): When it's due. Leave blank for Akaunting's payment terms for bills.
- Order number (`order_number`, text): An order or purchase order number to show on it.
- Notes (`notes`, text): Notes printed on it.
- Category (`category`, text): The expense category. Leave blank for the company's default.
- Currency (`currency`, text): Its currency. Leave blank for the customer's or vendor's own.

**Outputs**

- `category` (text): Its category
- `contact_email` (text): Their email address
- `contact_id` (number): The customer's or vendor's ID
- `contact_name` (text): The customer's or vendor's name
- `created_at` (text): When it was added (ISO 8601)
- `currency` (text): Its currency, such as USD
- `due_date` (text): When it's due (YYYY-MM-DD)
- `id` (number): Its ID, for other Akaunting steps
- `issue_date` (text): Its date (YYYY-MM-DD)
- `lines` (list): Its lines
- `link` (text): A link to it in Akaunting
- `notes` (text): The notes on it
- `number` (text): Its number, such as INV-00012
- `order_number` (text): The order number on it
- `overdue` (true/false): Whether money is still owed after its due date
- `paid` (number): How much has been paid
- `payments` (list): The payments made on it
- `remaining` (number): How much is left to pay
- `status` (text): draft, sent, viewed, received, partial, paid or cancelled
- `subtotal` (number): Its total before tax and discounts
- `tax` (number): The tax on it
- `total` (number): Its total with tax

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The company's or person's name.
- Type (`type`, text): Whether you sell to them or buy from them. One of: `customer`, `vendor`. Default: `customer`.
- Email (`email`, text): Their email address.
- Phone (`phone`, text): Their phone number.
- Address (`address`, text): The street address.
- City (`city`, text): The town or city.
- Postcode (`zip_code`, text): The postcode or ZIP code.
- State (`state`, text): The state, county or province.
- Country (`country`, text): The country's two-letter code, such as US or GB.
- Tax number (`tax_number`, text): Their VAT or tax number.
- Website (`website`, text): Their website.
- Reference (`reference`, text): Your own reference for them, such as their ID in a CRM.
- Currency (`currency`, text): The currency they're invoiced or billed in. Leave blank for the company's own.

**Outputs**

- `address` (text): Their address
- `created` (true/false): False when one with that email address was already there
- `created_at` (text): When they were added (ISO 8601)
- `currency` (text): The currency they're invoiced or billed in, such as USD
- `email` (text): Their email address
- `enabled` (true/false): Whether they're enabled
- `id` (number): The customer's or vendor's ID, for other Akaunting steps
- `link` (text): A link to them in Akaunting
- `name` (text): Their name
- `phone` (text): Their phone number
- `reference` (text): Your reference for them, such as an ID in another system
- `tax_number` (text): Their tax number
- `type` (text): customer or vendor
- `website` (text): Their website

**Example output**

```json
{
  "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**

- Customer (`customer`, text, required): Who it's for: picked, or their ID, email address or exact name.
- Lines (`lines`, list, required): 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 sent (`mark_as_sent`, true/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`.
- Date (`issue_date`, date): The date on it. Leave blank for today.
- Due date (`due_date`, date): When it's due. Leave blank for Akaunting's payment terms for invoices.
- Invoice number (`invoice_number`, text): Its number. Leave blank for Akaunting's next one, such as INV-00012.
- Order number (`order_number`, text): An order or purchase order number to show on it.
- Notes (`notes`, text): Notes printed on it.
- Category (`category`, text): The income category. Leave blank for the company's default.
- Currency (`currency`, text): Its currency. Leave blank for the customer's or vendor's own.

**Outputs**

- `category` (text): Its category
- `contact_email` (text): Their email address
- `contact_id` (number): The customer's or vendor's ID
- `contact_name` (text): The customer's or vendor's name
- `created_at` (text): When it was added (ISO 8601)
- `currency` (text): Its currency, such as USD
- `due_date` (text): When it's due (YYYY-MM-DD)
- `id` (number): Its ID, for other Akaunting steps
- `issue_date` (text): Its date (YYYY-MM-DD)
- `lines` (list): Its lines
- `link` (text): A link to it in Akaunting
- `notes` (text): The notes on it
- `number` (text): Its number, such as INV-00012
- `order_number` (text): The order number on it
- `overdue` (true/false): Whether money is still owed after its due date
- `paid` (number): How much has been paid
- `payments` (list): The payments made on it
- `remaining` (number): How much is left to pay
- `status` (text): draft, sent, viewed, received, partial, paid or cancelled
- `subtotal` (number): Its total before tax and discounts
- `tax` (number): The tax on it
- `total` (number): Its total with tax

**Example output**

```json
{
  "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**

- Type (`type`, text): Customers or vendors. One of: `customer`, `vendor`. Default: `customer`.
- Search (`search`, text): Words in the name, email, phone, address, website or tax number.
- Email (`email`, text): Only the one with this email address.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `contacts` (list): The customers or vendors found
- `count` (number): How many are listed
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Status (`status`, text): 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`.
- Customer (`customer`, text): Only this customer's invoices.
- Search (`search`, text): Words in the invoice's number, order number or customer's details.
- Dated from (`date_from`, date): Only invoices dated on or after this day.
- Dated to (`date_to`, date): Only invoices dated on or before this day.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `amount_due` (number): What's left to pay on those listed
- `count` (number): How many are listed
- `invoices` (list): The invoices found, newest first
- `total` (number): How many match in all

**Example output**

```json
{
  "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**

- Search (`search`, text): Words in the name or description.
- Type (`type`, text): Products, services or both. One of: `any` (Products and services), `product` (Products), `service` (Services). Default: `any`.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `items` (list): The items found, by name
- `total` (number): How many match in all

**Example output**

```json
{
  "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 vendor (`contact`, text, required): Who: picked, or their ID, email address or exact name.

**Outputs**

- `address` (text): Their address
- `created_at` (text): When they were added (ISO 8601)
- `currency` (text): The currency they're invoiced or billed in, such as USD
- `email` (text): Their email address
- `enabled` (true/false): Whether they're enabled
- `id` (number): The customer's or vendor's ID, for other Akaunting steps
- `link` (text): A link to them in Akaunting
- `name` (text): Their name
- `phone` (text): Their phone number
- `reference` (text): Your reference for them, such as an ID in another system
- `tax_number` (text): Their tax number
- `type` (text): customer or vendor
- `website` (text): Their website

**Example output**

```json
{
  "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**

- Invoice (`invoice`, text, required): The invoice's ID or its number, such as INV-00012.

**Outputs**

- `category` (text): Its category
- `contact_email` (text): Their email address
- `contact_id` (number): The customer's or vendor's ID
- `contact_name` (text): The customer's or vendor's name
- `created_at` (text): When it was added (ISO 8601)
- `currency` (text): Its currency, such as USD
- `due_date` (text): When it's due (YYYY-MM-DD)
- `id` (number): Its ID, for other Akaunting steps
- `issue_date` (text): Its date (YYYY-MM-DD)
- `lines` (list): Its lines
- `link` (text): A link to it in Akaunting
- `notes` (text): The notes on it
- `number` (text): Its number, such as INV-00012
- `order_number` (text): The order number on it
- `overdue` (true/false): Whether money is still owed after its due date
- `paid` (number): How much has been paid
- `payments` (list): The payments made on it
- `remaining` (number): How much is left to pay
- `status` (text): draft, sent, viewed, received, partial, paid or cancelled
- `subtotal` (number): Its total before tax and discounts
- `tax` (number): The tax on it
- `total` (number): Its total with tax

**Example output**

```json
{
  "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 disabled (`include_disabled`, true/false): Also list those switched off. Default: `false`.

**Outputs**

- `accounts` (list): The accounts
- `count` (number): How many are listed

**Example output**

```json
{
  "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**

- Type (`type`, text): Which categories. One of: `any` (All), `income`, `expense`, `item`, `other`. Default: `any`.
- Include disabled (`include_disabled`, true/false): Also list those switched off. Default: `false`.

**Outputs**

- `categories` (list): The categories
- `count` (number): How many are listed

**Example output**

```json
{
  "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**

- Type (`type`, text, required): Money in or money out. One of: `income`, `expense`.
- Amount (`amount`, number, required): How much. At least 0.01.
- Date (`date`, date): When it was paid. Leave blank for today.
- Account (`account`, text): The bank or cash account. Leave blank for the company's default account.
- Category (`category`, text): An income or expense category, by name or ID, matching the type. Leave blank for the company's default.
- Description (`description`, text): What it was for.
- Customer or vendor (`contact`, text): Who paid or was paid: their ID, email address or exact name.
- Payment method (`payment_method`, text): How it was paid, such as Bank Transfer. Leave blank for the company's default.
- Reference (`reference`, text): A reference, such as a bank transaction ID.
- Currency (`currency`, text): Its currency. Leave blank for the account's own.

**Outputs**

- `account` (text): The account's name
- `account_id` (number): The account's ID
- `amount` (number): How much
- `category` (text): The category's name
- `category_id` (number): The category's ID
- `contact` (text): The customer's or vendor's name
- `contact_id` (number): The customer's or vendor's ID; 0 if none
- `created_at` (text): When it was recorded (ISO 8601)
- `currency` (text): Its currency
- `date` (text): When it was paid (YYYY-MM-DD)
- `description` (text): Its description
- `document_id` (number): The invoice's or bill's ID it pays; 0 if none
- `id` (number): The transaction's ID
- `link` (text): A link to it in Akaunting
- `number` (text): Its number, such as TRA-00032
- `payment_method` (text): How it was paid
- `reference` (text): Its reference
- `type` (text): income or expense

**Example output**

```json
{
  "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**

- Invoice (`invoice`, text, required): The invoice's ID or its number, such as INV-00012.
- Amount (`amount`, number): How much was paid. Leave blank for everything left to pay. At least 0.01.
- Payment date (`date`, date): When it was paid. Leave blank for today.
- Account (`account`, text): The bank or cash account. Leave blank for the company's default account.
- Payment method (`payment_method`, text): How it was paid, such as Bank Transfer. Leave blank for the company's default.
- Reference (`reference`, text): A reference, such as a bank transaction ID.
- Description (`description`, text): A note on the payment.

**Outputs**

- `account` (text): The account it went into
- `amount` (number): How much was recorded
- `date` (text): When it was paid (YYYY-MM-DD)
- `invoice_id` (number): The invoice's ID
- `invoice_number` (text): The invoice's number
- `invoice_status` (text): The invoice's status now: partial or paid
- `invoice_total` (number): The invoice's total
- `link` (text): A link to the invoice in Akaunting
- `paid` (number): How much has been paid on the invoice in all
- `payment_id` (number): The payment's ID
- `payment_method` (text): How it was paid
- `payment_number` (text): The payment's number, such as TRA-00031
- `reference` (text): The payment's reference
- `remaining` (number): How much is left to pay

**Example output**

```json
{
  "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 vendor (`contact`, text, required): Who: picked, or their ID, email address or exact name.
- Name (`name`, text): A new name. Leave blank to keep it.
- Email (`email`, text): Their email address. Leave blank to keep it.
- Phone (`phone`, text): Their phone number. Leave blank to keep it.
- Address (`address`, text): The street address. Leave blank to keep it.
- City (`city`, text): The town or city. Leave blank to keep it.
- Postcode (`zip_code`, text): The postcode or ZIP code. Leave blank to keep it.
- State (`state`, text): The state, county or province. Leave blank to keep it.
- Country (`country`, text): The country's two-letter code, such as US or GB. Leave blank to keep it.
- Tax number (`tax_number`, text): Their VAT or tax number. Leave blank to keep it.
- Website (`website`, text): Their website. Leave blank to keep it.
- Reference (`reference`, text): Your own reference for them, such as their ID in a CRM. Leave blank to keep it.
- Currency (`currency`, text): The currency they're invoiced or billed in. Leave blank to keep it.

**Outputs**

- `address` (text): Their address
- `created_at` (text): When they were added (ISO 8601)
- `currency` (text): The currency they're invoiced or billed in, such as USD
- `email` (text): Their email address
- `enabled` (true/false): Whether they're enabled
- `id` (number): The customer's or vendor's ID, for other Akaunting steps
- `link` (text): A link to them in Akaunting
- `name` (text): Their name
- `phone` (text): Their phone number
- `reference` (text): Your reference for them, such as an ID in another system
- `tax_number` (text): Their tax number
- `type` (text): customer or vendor
- `website` (text): Their website

**Example output**

```json
{
  "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"
}
```
