# Campfire

> Run your Campfire books from workflows: create, pay and void bills and invoices, manage vendors and customers, post journal entries, read bank balances and transactions, and pull the profit and loss and balance sheet.

App · 26 actions. Web page: https://docs.lodol.com/docs/integrations/campfire

## Actions

### Create bill

Record a bill from a vendor. It posts to accounts payable at once.

**Inputs**

- Vendor (`vendor_id`, text, required): Who the bill is from. Pick one, or give its id.
- Bill number (`bill_number`, text, required): The number on the vendor's bill or invoice.
- Expense account (`account_id`, text): The account the cost goes to. Required unless Lines is used.
- Amount (`amount`, number): The bill's amount. Required unless Lines is used. At least 0.01.
- Description (`description`, text): What the bill is for.
- Department (`department_id`, text): The department the cost belongs to.
- Bill date (`bill_date`, date): The date on the bill. Defaults to today.
- Payment terms (`terms`, text): When payment is due. Defaults to Net 30. One of: `due_on_receipt` (Due on receipt), `net_5` (Net 5), `net_7` (Net 7), `net_10` (Net 10), `net_15` (Net 15), `net_20` (Net 20), `net_30` (Net 30 (default)), `net_40` (Net 40), `net_45` (Net 45), `net_60` (Net 60), and 3 more.
- Due date (`due_date`, date): Defaults to the date the payment terms give.
- Entity (`entity_id`, text): The company or subsidiary it belongs to. Defaults to your main one.
- Currency (`currency`, text): Defaults to the entity's currency.
- Message (`memo`, text): A message shown on the document.
- Lines (advanced) (`lines`, list): For a bill with several lines: a list such as [{"account": 2622, "amount": 120, "description": "Paper"}]. Each line takes account, amount, description and department. When filled in it replaces the single-line fields.

**Outputs**

- `bill` (object): The bill

**Example output**

```json
{
  "bill": {
    "amount_due": 10000.0,
    "amount_paid": 0.0,
    "bill_date": "2025-08-01",
    "bill_number": "1234567",
    "created_at": "2025-07-25T04:24:32+00:00",
    "currency": "USD",
    "due_date": "2025-08-24",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "31894",
    "journal_entry_id": "7491951",
    "last_modified_at": "2025-07-25T04:24:32+00:00",
    "lines": [
      {
        "account_id": "2622",
        "account_name": "6700 - Office Expenses",
        "amount": 10000.0,
        "department_id": "35",
        "department_name": "Engineering",
        "description": "1x Large Expense Line",
        "id": "298626"
      }
    ],
    "memo": "A really big expense",
    "paid_date": "",
    "payment_status": "open",
    "payments": [],
    "status": "open",
    "terms": "",
    "total_amount": 10000.0,
    "vendor_id": "34182",
    "vendor_name": "ABC Bead Supply",
    "voided_date": ""
  }
}
```

### Create invoice

Create an invoice to a customer for one of your products. It posts to accounts receivable at once.

**Inputs**

- Customer (`customer_id`, text, required): Who the invoice is to. Pick one, or give its id.
- Product (`product_id`, text): What you are charging for. Required unless Lines is used.
- Price (`unit_price`, number): The price of one unit. Required unless Lines is used.
- Quantity (`quantity`, number): How many. Defaults to 1. At least 0.0001. Default: `1`.
- Description (`description`, text): The line's description, shown on the invoice.
- Invoice number (`invoice_number`, text): The invoice's number, such as INV-1042.
- Invoice date (`invoice_date`, date): The date on the invoice. Defaults to today.
- Payment terms (`terms`, text): When payment is due. Defaults to Net 30. One of: `due_on_receipt` (Due on receipt), `net_5` (Net 5), `net_7` (Net 7), `net_10` (Net 10), `net_15` (Net 15), `net_20` (Net 20), `net_30` (Net 30 (default)), `net_40` (Net 40), `net_45` (Net 45), `net_60` (Net 60), and 3 more.
- Due date (`due_date`, date): Defaults to the date the payment terms give.
- Entity (`entity_id`, text): The company or subsidiary it belongs to. Defaults to your main one.
- Currency (`currency`, text): Defaults to the entity's currency.
- Message (`memo`, text): A message shown on the document.
- PO number (`purchase_order_number`, text): The customer's purchase order number.
- Lines (advanced) (`lines`, list): For an invoice with several lines: a list such as [{"product": 2545, "quantity": 2, "unit_price": 50}]. Each line takes product, quantity, unit_price (or amount), description, service_date and tax. When filled in it replaces the single-line fields.

**Outputs**

- `invoice` (object): The invoice

**Example output**

```json
{
  "invoice": {
    "amount_due": 55.0,
    "amount_paid": 0.0,
    "contract_id": "12954",
    "created_at": "2025-07-25T18:54:43+00:00",
    "currency": "USD",
    "customer_email": "",
    "customer_id": "33973",
    "customer_name": "Client A",
    "due_date": "2025-07-31",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "145055",
    "invoice_date": "2025-07-01",
    "invoice_number": "987654321",
    "journal_entry_id": "7491952",
    "last_modified_at": "2025-07-25T18:54:43+00:00",
    "lines": [
      {
        "amount": 50.0,
        "description": "Invoice Line Item",
        "id": "337587",
        "product_id": "2545",
        "product_name": "Product A",
        "quantity": 1.0,
        "rate": 50.0,
        "service_date": "2025-07-01",
        "tax": 5.0
      }
    ],
    "memo": "Please pay by bank transfer.",
    "paid_date": "",
    "payment_link": "",
    "payment_status": "open",
    "payments": [],
    "purchase_order_number": "123456789",
    "status": "open",
    "terms": "net_30",
    "total_amount": 55.0,
    "voided_date": ""
  }
}
```

### Create journal entry

Post a journal entry: debit one account and credit another, or give several balanced lines.

**Inputs**

- Debit account (`debit_account_id`, text): The account to debit. Required unless Lines is used.
- Credit account (`credit_account_id`, text): The account to credit. Required unless Lines is used.
- Amount (`amount`, number): The amount debited and credited. Required unless Lines is used. At least 0.01.
- Line description (`description`, text): A description on both lines.
- Date (`entry_date`, date): The day the entry posts on. Defaults to today.
- Memo (`memo`, text): What the entry is for.
- Entity (`entity_id`, text): The company or subsidiary it belongs to. Defaults to your main one.
- Currency (`currency`, text): Defaults to the entity's currency.
- Reverse on (`reversal_date`, date): Post a reversing entry on this day, such as the first of next month for an accrual.
- Lines (advanced) (`lines`, list): For more than one debit or credit: a list such as [{"account": 6700, "debit": 100}, {"account": 1000, "credit": 100}]. Each line takes account, debit or credit, description, vendor and department; debits must equal credits. When filled in it replaces the single-line fields.

**Outputs**

- `journal_entry` (object): The journal entry

**Example output**

```json
{
  "journal_entry": {
    "created_at": "2025-07-25T00:01:28+00:00",
    "currency": "USD",
    "date": "2025-07-31",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "7491945",
    "lines": [
      {
        "account_id": "180564",
        "account_name": "1000 - Cash and Cash Equivalents",
        "credit": 0.0,
        "debit": 12345.67,
        "department_id": "",
        "department_name": "",
        "description": "Test Line Description",
        "id": "24429462",
        "vendor_id": "",
        "vendor_name": ""
      },
      {
        "account_id": "2563",
        "account_name": "1600 - Fixed Assets",
        "credit": 12345.67,
        "debit": 0.0,
        "department_id": "35",
        "department_name": "Engineering",
        "description": "Test Line Description",
        "id": "24429463",
        "vendor_id": "34182",
        "vendor_name": "ABC Bead Supply"
      }
    ],
    "memo": "Test Journal Memo",
    "number": "0004358",
    "total": 12345.67,
    "type": "journal_entry"
  }
}
```

### Create vendor or customer

Add a vendor (who sends you bills) or a customer (who gets your invoices).

**Inputs**

- Name (`name`, text, required): The vendor's or customer's name.
- Type (`contact_type`, text): A vendor sends you bills; a customer gets your invoices. One of: `vendor` (Vendor (default)), `customer`. Default: `vendor`.
- Company name (`company_name`, text): The legal company name, if it differs.
- Email (`email`, text): Where bills or invoices are sent.
- Phone (`phone_number`, text): Phone number.
- Website (`website`, text): Website address.
- Street address (`address_street_1`, text): Street and number.
- Address line 2 (`address_street_2`, text): Suite, floor or building.
- City (`city`, text): City.
- State or region (`state`, text): State, province or region.
- ZIP or postal code (`zip_code`, text): ZIP or postal code.
- Country (`country`, text): Country.
- Payment terms (`terms`, text): Their usual payment terms. One of: `due_on_receipt` (Due on receipt), `net_5` (Net 5), `net_7` (Net 7), `net_10` (Net 10), `net_15` (Net 15), `net_20` (Net 20), `net_30` (Net 30 (default)), `net_40` (Net 40), `net_45` (Net 45), `net_60` (Net 60), and 3 more.
- External ID (`external_id`, text): Your own id for them, such as their id in your CRM.
- Notes (`notes`, text): Notes kept on the record.

**Outputs**

- `contact` (object): The vendor or customer

**Example output**

```json
{
  "contact": {
    "address_street_1": "1234 Campground Road",
    "address_street_2": "",
    "campfire_id": "VEN-0000042",
    "city": "San Francisco",
    "company_name": "ABC Bead Supply LLC",
    "country": "US",
    "created_at": "2025-07-17T16:21:02+00:00",
    "display_name": "ABC Bead Supply",
    "email": "billing@abcbeads.example.com",
    "external_id": "",
    "id": "34182",
    "last_modified_at": "2025-07-17T16:21:02+00:00",
    "name": "ABC Bead Supply",
    "notes": "",
    "phone_number": "+1 415 555 0100",
    "state": "CA",
    "status": "ACTIVE",
    "terms": "net_30",
    "type": "vendor",
    "website": "https://abcbeads.example.com",
    "zip_code": "98765"
  }
}
```

### Delete bill

Delete a bill and its journal entry for good. Bills in a closed period can't be deleted; void them instead.

**Inputs**

- Bill ID (`bill_id`, text, required): The bill's id, from 'List bills', 'Create bill' or a trigger.

**Outputs**

- `bill_id` (text): The bill deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "bill_id": "31894",
  "deleted": true
}
```

### Delete invoice

Delete an invoice with its payments and journal entries for good. Invoices in a closed period can't be deleted; void them instead.

**Inputs**

- Invoice ID (`invoice_id`, text, required): The invoice's id, from 'List invoices', 'Create invoice' or a trigger.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `invoice_id` (text): The invoice deleted

**Example output**

```json
{
  "deleted": true,
  "invoice_id": "145055"
}
```

### Delete journal entry

Delete a journal entry. Campfire refuses one in a closed period or one that a bill or invoice depends on.

**Inputs**

- Journal entry ID (`journal_entry_id`, text, required): The journal entry's id, from 'List journal entries' or 'Create journal entry'.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `journal_entry_id` (text): The journal entry deleted

**Example output**

```json
{
  "deleted": true,
  "journal_entry_id": "7491945"
}
```

### Delete vendor or customer

Delete a vendor or customer. Campfire finishes deleting it in the background.

**Inputs**

- Vendor or customer (`contact_id`, text, required): Pick one, or give its id from an earlier step.

**Outputs**

- `contact_id` (text): The id deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "contact_id": "34182",
  "deleted": true
}
```

### Find vendors and customers

Find vendors and customers by name, email or company, or those changed since a time.

**Inputs**

- Type (`contact_type`, text): Only vendors, or only customers. Leave empty for both. One of: `vendor` (Vendors), `customer` (Customers).
- Search (`search`, text): A name, email or company name to look for.
- Changed since (`modified_since`, date and time): Only those created or changed at or after this time.
- Include inactive (`include_inactive`, true/false): Also return vendors and customers marked inactive. Default: `false`.
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Skip (`offset`, number): How many to skip, to get a later page. Use 'next_offset' from the page before. At least 0.

**Outputs**

- `contacts` (list): The vendors and customers
- `count` (number): How many are on this page
- `has_more` (true/false): Whether there are more after this page
- `next_offset` (number): What to put in Skip for the next page; 0 on the last
- `total` (number): How many match in all

**Example output**

```json
{
  "contacts": [
    {
      "address_street_1": "1234 Campground Road",
      "address_street_2": "",
      "campfire_id": "VEN-0000042",
      "city": "San Francisco",
      "company_name": "ABC Bead Supply LLC",
      "country": "US",
      "created_at": "2025-07-17T16:21:02+00:00",
      "display_name": "ABC Bead Supply",
      "email": "billing@abcbeads.example.com",
      "external_id": "",
      "id": "34182",
      "last_modified_at": "2025-07-17T16:21:02+00:00",
      "name": "ABC Bead Supply",
      "notes": "",
      "phone_number": "+1 415 555 0100",
      "state": "CA",
      "status": "ACTIVE",
      "terms": "net_30",
      "type": "vendor",
      "website": "https://abcbeads.example.com",
      "zip_code": "98765"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total": 1
}
```

### Get balance sheet

Get the balance sheet: each account's balance at the end of each month, quarter or year in a range.

**Inputs**

- From (`start_date`, date): The first day covered. Defaults to six months ago.
- To (`end_date`, date): The last day covered. Defaults to the end of this month.
- Columns (`cadence`, text): One column per month, quarter, year, week or day. One of: `monthly` (Monthly (default)), `quarterly`, `yearly`, `weekly`, `daily`. Default: `monthly`.
- Entity (`entity_id`, text): Only this company or subsidiary. Leave empty for all.

**Outputs**

- `cadence` (text): How the columns are split: monthly, quarterly and so on
- `count` (number): How many rows
- `end_date` (text): Last day covered (YYYY-MM-DD)
- `rows` (list): One row per account
- `start_date` (text): First day covered (YYYY-MM-DD)

**Example output**

```json
{
  "cadence": "monthly",
  "count": 1,
  "end_date": "2022-11-30",
  "rows": [
    {
      "account_id": "12172",
      "account_name": "Bill.com Money Out Clearing",
      "account_number": "111000",
      "amounts": {
        "2022-11-01_Jupiter Consulting, LLC": 5.73,
        "2022-11-01_Total": 5.36
      },
      "section": "ASSET"
    }
  ],
  "start_date": "2022-11-01"
}
```

### Get bill

Get one bill with its lines, payments and amount due.

**Inputs**

- Bill ID (`bill_id`, text, required): The bill's id, from 'List bills', 'Create bill' or a trigger.

**Outputs**

- `bill` (object): The bill

**Example output**

```json
{
  "bill": {
    "amount_due": 10000.0,
    "amount_paid": 0.0,
    "bill_date": "2025-08-01",
    "bill_number": "1234567",
    "created_at": "2025-07-25T04:24:32+00:00",
    "currency": "USD",
    "due_date": "2025-08-24",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "31894",
    "journal_entry_id": "7491951",
    "last_modified_at": "2025-07-25T04:24:32+00:00",
    "lines": [
      {
        "account_id": "2622",
        "account_name": "6700 - Office Expenses",
        "amount": 10000.0,
        "department_id": "35",
        "department_name": "Engineering",
        "description": "1x Large Expense Line",
        "id": "298626"
      }
    ],
    "memo": "A really big expense",
    "paid_date": "",
    "payment_status": "open",
    "payments": [],
    "status": "open",
    "terms": "",
    "total_amount": 10000.0,
    "vendor_id": "34182",
    "vendor_name": "ABC Bead Supply",
    "voided_date": ""
  }
}
```

### Get invoice

Get one invoice with its lines, payments, amount due and payment link.

**Inputs**

- Invoice ID (`invoice_id`, text, required): The invoice's id, from 'List invoices', 'Create invoice' or a trigger.

**Outputs**

- `invoice` (object): The invoice

**Example output**

```json
{
  "invoice": {
    "amount_due": 55.0,
    "amount_paid": 0.0,
    "contract_id": "12954",
    "created_at": "2025-07-25T18:54:43+00:00",
    "currency": "USD",
    "customer_email": "",
    "customer_id": "33973",
    "customer_name": "Client A",
    "due_date": "2025-07-31",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "145055",
    "invoice_date": "2025-07-01",
    "invoice_number": "987654321",
    "journal_entry_id": "7491952",
    "last_modified_at": "2025-07-25T18:54:43+00:00",
    "lines": [
      {
        "amount": 50.0,
        "description": "Invoice Line Item",
        "id": "337587",
        "product_id": "2545",
        "product_name": "Product A",
        "quantity": 1.0,
        "rate": 50.0,
        "service_date": "2025-07-01",
        "tax": 5.0
      }
    ],
    "memo": "Please pay by bank transfer.",
    "paid_date": "",
    "payment_link": "",
    "payment_status": "open",
    "payments": [],
    "purchase_order_number": "123456789",
    "status": "open",
    "terms": "net_30",
    "total_amount": 55.0,
    "voided_date": ""
  }
}
```

### Get profit and loss

Get the profit and loss (income statement): revenue and expenses per account for each month, quarter or year in a range.

**Inputs**

- From (`start_date`, date): The first day covered. Defaults to six months ago.
- To (`end_date`, date): The last day covered. Defaults to the end of this month.
- Columns (`cadence`, text): One column per month, quarter, year, week or day. One of: `monthly` (Monthly (default)), `quarterly`, `yearly`, `weekly`, `daily`. Default: `monthly`.
- Entity (`entity_id`, text): Only this company or subsidiary. Leave empty for all.

**Outputs**

- `cadence` (text): How the columns are split: monthly, quarterly and so on
- `count` (number): How many rows
- `end_date` (text): Last day covered (YYYY-MM-DD)
- `rows` (list): One row per account
- `start_date` (text): First day covered (YYYY-MM-DD)

**Example output**

```json
{
  "cadence": "monthly",
  "count": 2,
  "end_date": "2024-01-31",
  "rows": [
    {
      "account_id": "2555",
      "account_name": "Sales, General, and Administrative Expenses",
      "account_number": "600000",
      "amounts": {
        "2024-01-01_Total": 14883.910000000002
      },
      "section": "OPERATING_EXPENSES"
    },
    {
      "account_id": "2556",
      "account_name": "Sales",
      "account_number": "400000",
      "amounts": {
        "2024-01-01_Total": 766651.0
      },
      "section": "REVENUE"
    }
  ],
  "start_date": "2024-01-01"
}
```

### List accounts

List the chart of accounts with balances, optionally only one type (such as expenses) or those matching a name or number.

**Inputs**

- Type (`account_type`, text): Only accounts of this type. One of: `ASSET` (Assets), `LIABILITY` (Liabilities), `EQUITY`, `REVENUE`, `COGS` (Cost of goods sold), `OPERATING_EXPENSES` (Operating expenses), `OTHER_INCOME` (Other income), `OTHER_EXPENSE` (Other expenses).
- Search (`search`, text): Part of an account's name or number.
- Most to return (`limit`, number): How many accounts to return at most. Defaults to 100. From 1 to 1000.

**Outputs**

- `accounts` (list): The matching accounts
- `count` (number): How many are returned
- `total` (number): How many match in all

**Example output**

```json
{
  "accounts": [
    {
      "account_subtype": "EXPENSE",
      "account_type": "OPERATING_EXPENSES",
      "currency": "USD",
      "current_balance": 18250.4,
      "description": "Supplies and small equipment",
      "id": "2622",
      "name": "Office Expenses",
      "name_and_number": "6700 - Office Expenses",
      "number": "6700",
      "parent_id": "",
      "status": "ACTIVE"
    }
  ],
  "count": 1,
  "total": 1
}
```

### List bank accounts

List bank and card accounts with their current and available balances.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Skip (`offset`, number): How many to skip, to get a later page. Use 'next_offset' from the page before. At least 0.

**Outputs**

- `bank_accounts` (list): The bank and card accounts
- `count` (number): How many are on this page
- `has_more` (true/false): Whether there are more after this page
- `next_offset` (number): What to put in Skip for the next page; 0 on the last
- `total` (number): How many match in all

**Example output**

```json
{
  "bank_accounts": [
    {
      "available_balance": 248500.0,
      "currency": "USD",
      "current_balance": 250000.0,
      "entity_id": "54",
      "entity_name": "Top Level",
      "id": "811",
      "last_modified_at": "2025-07-25T04:24:32+00:00",
      "ledger_account_id": "180564",
      "ledger_account_name": "1000 - Cash and Cash Equivalents",
      "name": "Operating Checking",
      "nickname": "Ops",
      "status": "active",
      "type": "Checking"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total": 1
}
```

### List bank transactions

List the transactions from your bank and card feeds, with amounts, descriptions and the entries they were booked to.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Skip (`offset`, number): How many to skip, to get a later page. Use 'next_offset' from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there are more after this page
- `next_offset` (number): What to put in Skip for the next page; 0 on the last
- `total` (number): How many match in all
- `transactions` (list): The bank transactions

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total": 1,
  "transactions": [
    {
      "amount": -8999.99,
      "bank_account_id": "811",
      "bank_account_name": "Operating Checking",
      "created_at": "2025-07-08T12:00:00+00:00",
      "currency": "USD",
      "date": "2025-07-08",
      "description": "ScholarShare ACHCONTRIB 070825",
      "entity_name": "Top Level",
      "excluded": false,
      "id": "21069178",
      "journal_entry_id": "7491960",
      "kind": "ach",
      "merchant_name": "ScholarShare",
      "note": "",
      "status": "posted"
    }
  ]
}
```

### List bills

List bills, newest first, filtered by status, vendor, entity, bill date, search words or when they last changed.

**Inputs**

- Status (`status`, text): Only bills in this state. One of: `unpaid`, `open`, `partially_paid` (Partially paid), `paid`, `past_due` (Past due), `current` (Not yet due), `needs_approval` (Needs approval), `payment_pending` (Payment pending), `voided`.
- Vendor (`vendor_id`, text): Only bills from this vendor.
- Entity (`entity_id`, text): Only this company or subsidiary.
- From (`start_date`, date): Only those dated on or after this day.
- To (`end_date`, date): Only those dated on or before this day.
- Search (`search`, text): Words to look for, such as a name or a number.
- Changed since (`modified_since`, date and time): Only those created or changed at or after this time.
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Skip (`offset`, number): How many to skip, to get a later page. Use 'next_offset' from the page before. At least 0.

**Outputs**

- `bills` (list): The bills
- `count` (number): How many are on this page
- `has_more` (true/false): Whether there are more after this page
- `next_offset` (number): What to put in Skip for the next page; 0 on the last
- `total` (number): How many match in all

**Example output**

```json
{
  "bills": [
    {
      "amount_due": 10000.0,
      "amount_paid": 0.0,
      "bill_date": "2025-08-01",
      "bill_number": "1234567",
      "created_at": "2025-07-25T04:24:32+00:00",
      "currency": "USD",
      "due_date": "2025-08-24",
      "entity_id": "54",
      "entity_name": "Top Level",
      "id": "31894",
      "journal_entry_id": "7491951",
      "last_modified_at": "2025-07-25T04:24:32+00:00",
      "lines": [
        {
          "account_id": "2622",
          "account_name": "6700 - Office Expenses",
          "amount": 10000.0,
          "department_id": "35",
          "department_name": "Engineering",
          "description": "1x Large Expense Line",
          "id": "298626"
        }
      ],
      "memo": "A really big expense",
      "paid_date": "",
      "payment_status": "open",
      "payments": [],
      "status": "open",
      "terms": "",
      "total_amount": 10000.0,
      "vendor_id": "34182",
      "vendor_name": "ABC Bead Supply",
      "voided_date": ""
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "total": 1
}
```

### List invoices

List invoices, newest first, filtered by status, customer, entity, invoice date, number or search words.

**Inputs**

- Status (`status`, text): Only invoices in this state. One of: `unpaid`, `open`, `sent`, `partially_paid` (Partially paid), `paid`, `past_due` (Past due), `current` (Not yet due), `scheduled`, `uncollectible`, `voided`.
- Customer (`customer_id`, text): Only invoices to this customer.
- Entity (`entity_id`, text): Only this company or subsidiary.
- From (`start_date`, date): Only those dated on or after this day.
- To (`end_date`, date): Only those dated on or before this day.
- Invoice number (`invoice_number`, text): Only the invoice with exactly this number.
- Search (`search`, text): Words to look for, such as a name or a number.
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Skip (`offset`, number): How many to skip, to get a later page. Use 'next_offset' from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there are more after this page
- `invoices` (list): The invoices
- `next_offset` (number): What to put in Skip for the next page; 0 on the last
- `total` (number): How many match in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "invoices": [
    {
      "amount_due": 55.0,
      "amount_paid": 0.0,
      "contract_id": "12954",
      "created_at": "2025-07-25T18:54:43+00:00",
      "currency": "USD",
      "customer_email": "",
      "customer_id": "33973",
      "customer_name": "Client A",
      "due_date": "2025-07-31",
      "entity_id": "54",
      "entity_name": "Top Level",
      "id": "145055",
      "invoice_date": "2025-07-01",
      "invoice_number": "987654321",
      "journal_entry_id": "7491952",
      "last_modified_at": "2025-07-25T18:54:43+00:00",
      "lines": [
        {
          "amount": 50.0,
          "description": "Invoice Line Item",
          "id": "337587",
          "product_id": "2545",
          "product_name": "Product A",
          "quantity": 1.0,
          "rate": 50.0,
          "service_date": "2025-07-01",
          "tax": 5.0
        }
      ],
      "memo": "Please pay by bank transfer.",
      "paid_date": "",
      "payment_link": "",
      "payment_status": "open",
      "payments": [],
      "purchase_order_number": "123456789",
      "status": "open",
      "terms": "net_30",
      "total_amount": 55.0,
      "voided_date": ""
    }
  ],
  "next_offset": 0,
  "total": 1
}
```

### List journal entries

List journal entries with their lines, in a date range (the last six months unless given) and optionally for one account.

**Inputs**

- From (`start_date`, date): Only those dated on or after this day.
- To (`end_date`, date): Only those dated on or before this day.
- Account (`account_id`, text): Only entries with a line on this account.
- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Skip (`offset`, number): How many to skip, to get a later page. Use 'next_offset' from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there are more after this page
- `journal_entries` (list): The journal entries
- `next_offset` (number): What to put in Skip for the next page; 0 on the last
- `total` (number): How many match in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "journal_entries": [
    {
      "created_at": "2025-07-25T00:01:28+00:00",
      "currency": "USD",
      "date": "2025-07-31",
      "entity_id": "54",
      "entity_name": "Top Level",
      "id": "7491945",
      "lines": [
        {
          "account_id": "180564",
          "account_name": "1000 - Cash and Cash Equivalents",
          "credit": 0.0,
          "debit": 12345.67,
          "department_id": "",
          "department_name": "",
          "description": "Test Line Description",
          "id": "24429462",
          "vendor_id": "",
          "vendor_name": ""
        },
        {
          "account_id": "2563",
          "account_name": "1600 - Fixed Assets",
          "credit": 12345.67,
          "debit": 0.0,
          "department_id": "35",
          "department_name": "Engineering",
          "description": "Test Line Description",
          "id": "24429463",
          "vendor_id": "34182",
          "vendor_name": "ABC Bead Supply"
        }
      ],
      "memo": "Test Journal Memo",
      "number": "0004358",
      "total": 12345.67,
      "type": "journal_entry"
    }
  ],
  "next_offset": 0,
  "total": 1
}
```

### List products

List the products and services you sell, with prices.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000.
- Skip (`offset`, number): How many to skip, to get a later page. Use 'next_offset' from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there are more after this page
- `next_offset` (number): What to put in Skip for the next page; 0 on the last
- `products` (list): The products
- `total` (number): How many match in all

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "products": [
    {
      "currency": "USD",
      "description": "Annual platform subscription",
      "id": "2545",
      "is_taxable": false,
      "name": "Product A",
      "price": 50.0,
      "revenue_account_name": "4000 - Sales"
    }
  ],
  "total": 1
}
```

### Record bill payment

Record that a bill was paid, in full or in part, from an account such as your bank account.

**Inputs**

- Bill ID (`bill_id`, text, required): The bill's id, from 'List bills', 'Create bill' or a trigger.
- Paid through (`account_id`, text, required): The account the money moved through, usually a bank or card account.
- Amount (`amount`, number): How much was paid. Defaults to the full amount due. At least 0.01.
- Payment date (`payment_date`, date): The day it was paid. Defaults to today.
- Note (`memo`, text): A note kept with the payment.

**Outputs**

- `amount_recorded` (number): The amount of the payment recorded
- `bill` (object): The bill, after the payment

**Example output**

```json
{
  "amount_recorded": 10000.0,
  "bill": {
    "amount_due": 0.0,
    "amount_paid": 10000.0,
    "bill_date": "2025-08-01",
    "bill_number": "1234567",
    "created_at": "2025-07-25T04:24:32+00:00",
    "currency": "USD",
    "due_date": "2025-08-24",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "31894",
    "journal_entry_id": "7491951",
    "last_modified_at": "2025-07-25T04:24:32+00:00",
    "lines": [
      {
        "account_id": "2622",
        "account_name": "6700 - Office Expenses",
        "amount": 10000.0,
        "department_id": "35",
        "department_name": "Engineering",
        "description": "1x Large Expense Line",
        "id": "298626"
      }
    ],
    "memo": "A really big expense",
    "paid_date": "",
    "payment_status": "paid",
    "payments": [],
    "status": "paid",
    "terms": "",
    "total_amount": 10000.0,
    "vendor_id": "34182",
    "vendor_name": "ABC Bead Supply",
    "voided_date": ""
  }
}
```

### Record invoice payment

Record a payment received on an invoice, in full or in part, into an account such as your bank account.

**Inputs**

- Invoice ID (`invoice_id`, text, required): The invoice's id, from 'List invoices', 'Create invoice' or a trigger.
- Paid through (`account_id`, text, required): The account the money moved through, usually a bank or card account.
- Amount (`amount`, number): How much was paid. Defaults to the full amount due. At least 0.01.
- Payment date (`payment_date`, date): The day it was paid. Defaults to today.
- Note (`memo`, text): A note kept with the payment.

**Outputs**

- `amount_recorded` (number): The amount of the payment recorded
- `invoice` (object): The invoice, after the payment
- `journal_entry_ids` (list): Ids of the journal entries the payment posted

**Example output**

```json
{
  "amount_recorded": 55.0,
  "invoice": {
    "amount_due": 0.0,
    "amount_paid": 55.0,
    "contract_id": "12954",
    "created_at": "2025-07-25T18:54:43+00:00",
    "currency": "USD",
    "customer_email": "",
    "customer_id": "33973",
    "customer_name": "Client A",
    "due_date": "2025-07-31",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "145055",
    "invoice_date": "2025-07-01",
    "invoice_number": "987654321",
    "journal_entry_id": "7491952",
    "last_modified_at": "2025-07-25T18:54:43+00:00",
    "lines": [
      {
        "amount": 50.0,
        "description": "Invoice Line Item",
        "id": "337587",
        "product_id": "2545",
        "product_name": "Product A",
        "quantity": 1.0,
        "rate": 50.0,
        "service_date": "2025-07-01",
        "tax": 5.0
      }
    ],
    "memo": "Please pay by bank transfer.",
    "paid_date": "",
    "payment_link": "",
    "payment_status": "paid",
    "payments": [],
    "purchase_order_number": "123456789",
    "status": "paid",
    "terms": "net_30",
    "total_amount": 55.0,
    "voided_date": ""
  },
  "journal_entry_ids": [
    "7491960"
  ]
}
```

### Reopen voided bill

Undo a bill's void, so it is open to pay again.

**Inputs**

- Bill ID (`bill_id`, text, required): The bill's id, from 'List bills', 'Create bill' or a trigger.

**Outputs**

- `bill` (object): The bill

**Example output**

```json
{
  "bill": {
    "amount_due": 10000.0,
    "amount_paid": 0.0,
    "bill_date": "2025-08-01",
    "bill_number": "1234567",
    "created_at": "2025-07-25T04:24:32+00:00",
    "currency": "USD",
    "due_date": "2025-08-24",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "31894",
    "journal_entry_id": "7491951",
    "last_modified_at": "2025-07-25T04:24:32+00:00",
    "lines": [
      {
        "account_id": "2622",
        "account_name": "6700 - Office Expenses",
        "amount": 10000.0,
        "department_id": "35",
        "department_name": "Engineering",
        "description": "1x Large Expense Line",
        "id": "298626"
      }
    ],
    "memo": "A really big expense",
    "paid_date": "",
    "payment_status": "open",
    "payments": [],
    "status": "open",
    "terms": "",
    "total_amount": 10000.0,
    "vendor_id": "34182",
    "vendor_name": "ABC Bead Supply",
    "voided_date": ""
  }
}
```

### Update vendor or customer

Change a vendor's or customer's details. Only the fields filled in change.

**Inputs**

- Vendor or customer (`contact_id`, text, required): Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Company name (`company_name`, text): The legal company name, if it differs.
- Email (`email`, text): Where bills or invoices are sent.
- Phone (`phone_number`, text): Phone number.
- Website (`website`, text): Website address.
- Street address (`address_street_1`, text): Street and number.
- Address line 2 (`address_street_2`, text): Suite, floor or building.
- City (`city`, text): City.
- State or region (`state`, text): State, province or region.
- ZIP or postal code (`zip_code`, text): ZIP or postal code.
- Country (`country`, text): Country.
- Payment terms (`terms`, text): Their usual payment terms. One of: `due_on_receipt` (Due on receipt), `net_5` (Net 5), `net_7` (Net 7), `net_10` (Net 10), `net_15` (Net 15), `net_20` (Net 20), `net_30` (Net 30 (default)), `net_40` (Net 40), `net_45` (Net 45), `net_60` (Net 60), and 3 more.
- External ID (`external_id`, text): Your own id for them, such as their id in your CRM.
- Notes (`notes`, text): Notes kept on the record.

**Outputs**

- `contact` (object): The vendor or customer

**Example output**

```json
{
  "contact": {
    "address_street_1": "1234 Campground Road",
    "address_street_2": "",
    "campfire_id": "VEN-0000042",
    "city": "San Francisco",
    "company_name": "ABC Bead Supply LLC",
    "country": "US",
    "created_at": "2025-07-17T16:21:02+00:00",
    "display_name": "ABC Bead Supply",
    "email": "billing@abcbeads.example.com",
    "external_id": "",
    "id": "34182",
    "last_modified_at": "2025-07-17T16:21:02+00:00",
    "name": "ABC Bead Supply",
    "notes": "",
    "phone_number": "+1 415 555 0100",
    "state": "CA",
    "status": "ACTIVE",
    "terms": "net_30",
    "type": "vendor",
    "website": "https://abcbeads.example.com",
    "zip_code": "98765"
  }
}
```

### Void bill

Void a bill with a reversing entry. 'Reopen voided bill' undoes it.

**Inputs**

- Bill ID (`bill_id`, text, required): The bill's id, from 'List bills', 'Create bill' or a trigger.
- Void date (`void_date`, date): The day the void posts on. Defaults to today.

**Outputs**

- `bill` (object): The bill

**Example output**

```json
{
  "bill": {
    "amount_due": 10000.0,
    "amount_paid": 0.0,
    "bill_date": "2025-08-01",
    "bill_number": "1234567",
    "created_at": "2025-07-25T04:24:32+00:00",
    "currency": "USD",
    "due_date": "2025-08-24",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "31894",
    "journal_entry_id": "7491951",
    "last_modified_at": "2025-07-25T04:24:32+00:00",
    "lines": [
      {
        "account_id": "2622",
        "account_name": "6700 - Office Expenses",
        "amount": 10000.0,
        "department_id": "35",
        "department_name": "Engineering",
        "description": "1x Large Expense Line",
        "id": "298626"
      }
    ],
    "memo": "A really big expense",
    "paid_date": "",
    "payment_status": "voided",
    "payments": [],
    "status": "voided",
    "terms": "",
    "total_amount": 10000.0,
    "vendor_id": "34182",
    "vendor_name": "ABC Bead Supply",
    "voided_date": "2025-08-02"
  }
}
```

### Void invoice

Void an invoice with a reversing entry.

**Inputs**

- Invoice ID (`invoice_id`, text, required): The invoice's id, from 'List invoices', 'Create invoice' or a trigger.
- Void date (`void_date`, date): The day the void posts on. Defaults to today.

**Outputs**

- `invoice` (object): The invoice

**Example output**

```json
{
  "invoice": {
    "amount_due": 55.0,
    "amount_paid": 0.0,
    "contract_id": "12954",
    "created_at": "2025-07-25T18:54:43+00:00",
    "currency": "USD",
    "customer_email": "",
    "customer_id": "33973",
    "customer_name": "Client A",
    "due_date": "2025-07-31",
    "entity_id": "54",
    "entity_name": "Top Level",
    "id": "145055",
    "invoice_date": "2025-07-01",
    "invoice_number": "987654321",
    "journal_entry_id": "7491952",
    "last_modified_at": "2025-07-25T18:54:43+00:00",
    "lines": [
      {
        "amount": 50.0,
        "description": "Invoice Line Item",
        "id": "337587",
        "product_id": "2545",
        "product_name": "Product A",
        "quantity": 1.0,
        "rate": 50.0,
        "service_date": "2025-07-01",
        "tax": 5.0
      }
    ],
    "memo": "Please pay by bank transfer.",
    "paid_date": "",
    "payment_link": "",
    "payment_status": "voided",
    "payments": [],
    "purchase_order_number": "123456789",
    "status": "voided",
    "terms": "net_30",
    "total_amount": 55.0,
    "voided_date": "2025-07-02"
  }
}
```
