Campfire

App · 26 actions

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.

Actions

ActionWhat it does
Create billRecord a bill from a vendor.
Create invoiceCreate an invoice to a customer for one of your products.
Create journal entryPost a journal entry: debit one account and credit another, or give several balanced lines.
Create vendor or customerAdd a vendor (who sends you bills) or a customer (who gets your invoices).
Delete billDelete a bill and its journal entry for good.
Delete invoiceDelete an invoice with its payments and journal entries for good.
Delete journal entryDelete a journal entry.
Delete vendor or customerDelete a vendor or customer.
Find vendors and customersFind vendors and customers by name, email or company, or those changed since a time.
Get balance sheetGet the balance sheet: each account's balance at the end of each month, quarter or year in a range.
Get billGet one bill with its lines, payments and amount due.
Get invoiceGet one invoice with its lines, payments, amount due and payment link.
Get profit and lossGet the profit and loss (income statement): revenue and expenses per account for each month, quarter or year in a range.
List accountsList the chart of accounts with balances, optionally only one type (such as expenses) or those matching a name or number.
List bank accountsList bank and card accounts with their current and available balances.
List bank transactionsList the transactions from your bank and card feeds, with amounts, descriptions and the entries they were booked to.
List billsList bills, newest first, filtered by status, vendor, entity, bill date, search words or when they last changed.
List invoicesList invoices, newest first, filtered by status, customer, entity, invoice date, number or search words.
List journal entriesList journal entries with their lines, in a date range (the last six months unless given) and optionally for one account.
List productsList the products and services you sell, with prices.
Record bill paymentRecord that a bill was paid, in full or in part, from an account such as your bank account.
Record invoice paymentRecord a payment received on an invoice, in full or in part, into an account such as your bank account.
Reopen voided billUndo a bill's void, so it is open to pay again.
Update vendor or customerChange a vendor's or customer's details.
Void billVoid a bill with a reversing entry.
Void invoiceVoid an invoice with a reversing entry.

Create bill

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

Inputs

Vendorvendor_idtextRequired
Who the bill is from. Pick one, or give its id.
Bill numberbill_numbertextRequired
The number on the vendor's bill or invoice.
Expense accountaccount_idtext
The account the cost goes to. Required unless Lines is used.
Amountamountnumber
The bill's amount. Required unless Lines is used.At least 0.01.
Descriptiondescriptiontext
What the bill is for.
Departmentdepartment_idtext
The department the cost belongs to.
Bill datebill_datedate
The date on the bill. Defaults to today.
Payment termstermstext
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 datedue_datedate
Defaults to the date the payment terms give.
Entityentity_idtext
The company or subsidiary it belongs to. Defaults to your main one.
Currencycurrencytext
Defaults to the entity's currency.
Messagememotext
A message shown on the document.
Lines (advanced)lineslist
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

billobject
The bill
Example output
{
  "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

Customercustomer_idtextRequired
Who the invoice is to. Pick one, or give its id.
Productproduct_idtext
What you are charging for. Required unless Lines is used.
Priceunit_pricenumber
The price of one unit. Required unless Lines is used.
Quantityquantitynumber
How many. Defaults to 1.At least 0.0001. Default: 1.
Descriptiondescriptiontext
The line's description, shown on the invoice.
Invoice numberinvoice_numbertext
The invoice's number, such as INV-1042.
Invoice dateinvoice_datedate
The date on the invoice. Defaults to today.
Payment termstermstext
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 datedue_datedate
Defaults to the date the payment terms give.
Entityentity_idtext
The company or subsidiary it belongs to. Defaults to your main one.
Currencycurrencytext
Defaults to the entity's currency.
Messagememotext
A message shown on the document.
PO numberpurchase_order_numbertext
The customer's purchase order number.
Lines (advanced)lineslist
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

invoiceobject
The invoice
Example output
{
  "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 accountdebit_account_idtext
The account to debit. Required unless Lines is used.
Credit accountcredit_account_idtext
The account to credit. Required unless Lines is used.
Amountamountnumber
The amount debited and credited. Required unless Lines is used.At least 0.01.
Line descriptiondescriptiontext
A description on both lines.
Dateentry_datedate
The day the entry posts on. Defaults to today.
Memomemotext
What the entry is for.
Entityentity_idtext
The company or subsidiary it belongs to. Defaults to your main one.
Currencycurrencytext
Defaults to the entity's currency.
Reverse onreversal_datedate
Post a reversing entry on this day, such as the first of next month for an accrual.
Lines (advanced)lineslist
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_entryobject
The journal entry
Example output
{
  "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

NamenametextRequired
The vendor's or customer's name.
Typecontact_typetext
A vendor sends you bills; a customer gets your invoices.One of: vendor (Vendor (default)), customer. Default: vendor.
Company namecompany_nametext
The legal company name, if it differs.
Emailemailtext
Where bills or invoices are sent.
Phonephone_numbertext
Phone number.
Websitewebsitetext
Website address.
Street addressaddress_street_1text
Street and number.
Address line 2address_street_2text
Suite, floor or building.
Citycitytext
City.
State or regionstatetext
State, province or region.
ZIP or postal codezip_codetext
ZIP or postal code.
Countrycountrytext
Country.
Payment termstermstext
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 IDexternal_idtext
Your own id for them, such as their id in your CRM.
Notesnotestext
Notes kept on the record.

Outputs

contactobject
The vendor or customer
Example output
{
  "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 IDbill_idtextRequired
The bill's id, from 'List bills', 'Create bill' or a trigger.

Outputs

bill_idtext
The bill deleted
deletedtrue/false
Always true once deleted
Example output
{
  "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 IDinvoice_idtextRequired
The invoice's id, from 'List invoices', 'Create invoice' or a trigger.

Outputs

deletedtrue/false
Always true once deleted
invoice_idtext
The invoice deleted
Example output
{
  "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 IDjournal_entry_idtextRequired
The journal entry's id, from 'List journal entries' or 'Create journal entry'.

Outputs

deletedtrue/false
Always true once deleted
journal_entry_idtext
The journal entry deleted
Example output
{
  "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 customercontact_idtextRequired
Pick one, or give its id from an earlier step.

Outputs

contact_idtext
The id deleted
deletedtrue/false
Always true once deleted
Example output
{
  "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

Typecontact_typetext
Only vendors, or only customers. Leave empty for both.One of: vendor (Vendors), customer (Customers).
Searchsearchtext
A name, email or company name to look for.
Changed sincemodified_sincedate and time
Only those created or changed at or after this time.
Include inactiveinclude_inactivetrue/false
Also return vendors and customers marked inactive.Default: false.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

contactslist
The vendors and customers
countnumber
How many are on this page
has_moretrue/false
Whether there are more after this page
next_offsetnumber
What to put in Skip for the next page; 0 on the last
totalnumber
How many match in all
Example output
{
  "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

Fromstart_datedate
The first day covered. Defaults to six months ago.
Toend_datedate
The last day covered. Defaults to the end of this month.
Columnscadencetext
One column per month, quarter, year, week or day.One of: monthly (Monthly (default)), quarterly, yearly, weekly, daily. Default: monthly.
Entityentity_idtext
Only this company or subsidiary. Leave empty for all.

Outputs

cadencetext
How the columns are split: monthly, quarterly and so on
countnumber
How many rows
end_datetext
Last day covered (YYYY-MM-DD)
rowslist
One row per account
start_datetext
First day covered (YYYY-MM-DD)
Example output
{
  "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 IDbill_idtextRequired
The bill's id, from 'List bills', 'Create bill' or a trigger.

Outputs

billobject
The bill
Example output
{
  "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 IDinvoice_idtextRequired
The invoice's id, from 'List invoices', 'Create invoice' or a trigger.

Outputs

invoiceobject
The invoice
Example output
{
  "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

Fromstart_datedate
The first day covered. Defaults to six months ago.
Toend_datedate
The last day covered. Defaults to the end of this month.
Columnscadencetext
One column per month, quarter, year, week or day.One of: monthly (Monthly (default)), quarterly, yearly, weekly, daily. Default: monthly.
Entityentity_idtext
Only this company or subsidiary. Leave empty for all.

Outputs

cadencetext
How the columns are split: monthly, quarterly and so on
countnumber
How many rows
end_datetext
Last day covered (YYYY-MM-DD)
rowslist
One row per account
start_datetext
First day covered (YYYY-MM-DD)
Example output
{
  "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

Typeaccount_typetext
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).
Searchsearchtext
Part of an account's name or number.
Most to returnlimitnumber
How many accounts to return at most. Defaults to 100.From 1 to 1000.

Outputs

accountslist
The matching accounts
countnumber
How many are returned
totalnumber
How many match in all
Example output
{
  "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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

bank_accountslist
The bank and card accounts
countnumber
How many are on this page
has_moretrue/false
Whether there are more after this page
next_offsetnumber
What to put in Skip for the next page; 0 on the last
totalnumber
How many match in all
Example output
{
  "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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there are more after this page
next_offsetnumber
What to put in Skip for the next page; 0 on the last
totalnumber
How many match in all
transactionslist
The bank transactions
Example output
{
  "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

Statusstatustext
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.
Vendorvendor_idtext
Only bills from this vendor.
Entityentity_idtext
Only this company or subsidiary.
Fromstart_datedate
Only those dated on or after this day.
Toend_datedate
Only those dated on or before this day.
Searchsearchtext
Words to look for, such as a name or a number.
Changed sincemodified_sincedate and time
Only those created or changed at or after this time.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

billslist
The bills
countnumber
How many are on this page
has_moretrue/false
Whether there are more after this page
next_offsetnumber
What to put in Skip for the next page; 0 on the last
totalnumber
How many match in all
Example output
{
  "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

Statusstatustext
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.
Customercustomer_idtext
Only invoices to this customer.
Entityentity_idtext
Only this company or subsidiary.
Fromstart_datedate
Only those dated on or after this day.
Toend_datedate
Only those dated on or before this day.
Invoice numberinvoice_numbertext
Only the invoice with exactly this number.
Searchsearchtext
Words to look for, such as a name or a number.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there are more after this page
invoiceslist
The invoices
next_offsetnumber
What to put in Skip for the next page; 0 on the last
totalnumber
How many match in all
Example output
{
  "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

Fromstart_datedate
Only those dated on or after this day.
Toend_datedate
Only those dated on or before this day.
Accountaccount_idtext
Only entries with a line on this account.
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there are more after this page
journal_entrieslist
The journal entries
next_offsetnumber
What to put in Skip for the next page; 0 on the last
totalnumber
How many match in all
Example output
{
  "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 sizelimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get a later page. Use 'next_offset' from the page before.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there are more after this page
next_offsetnumber
What to put in Skip for the next page; 0 on the last
productslist
The products
totalnumber
How many match in all
Example output
{
  "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 IDbill_idtextRequired
The bill's id, from 'List bills', 'Create bill' or a trigger.
Paid throughaccount_idtextRequired
The account the money moved through, usually a bank or card account.
Amountamountnumber
How much was paid. Defaults to the full amount due.At least 0.01.
Payment datepayment_datedate
The day it was paid. Defaults to today.
Notememotext
A note kept with the payment.

Outputs

amount_recordednumber
The amount of the payment recorded
billobject
The bill, after the payment
Example output
{
  "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 IDinvoice_idtextRequired
The invoice's id, from 'List invoices', 'Create invoice' or a trigger.
Paid throughaccount_idtextRequired
The account the money moved through, usually a bank or card account.
Amountamountnumber
How much was paid. Defaults to the full amount due.At least 0.01.
Payment datepayment_datedate
The day it was paid. Defaults to today.
Notememotext
A note kept with the payment.

Outputs

amount_recordednumber
The amount of the payment recorded
invoiceobject
The invoice, after the payment
journal_entry_idslist
Ids of the journal entries the payment posted
Example output
{
  "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 IDbill_idtextRequired
The bill's id, from 'List bills', 'Create bill' or a trigger.

Outputs

billobject
The bill
Example output
{
  "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 customercontact_idtextRequired
Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Company namecompany_nametext
The legal company name, if it differs.
Emailemailtext
Where bills or invoices are sent.
Phonephone_numbertext
Phone number.
Websitewebsitetext
Website address.
Street addressaddress_street_1text
Street and number.
Address line 2address_street_2text
Suite, floor or building.
Citycitytext
City.
State or regionstatetext
State, province or region.
ZIP or postal codezip_codetext
ZIP or postal code.
Countrycountrytext
Country.
Payment termstermstext
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 IDexternal_idtext
Your own id for them, such as their id in your CRM.
Notesnotestext
Notes kept on the record.

Outputs

contactobject
The vendor or customer
Example output
{
  "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 IDbill_idtextRequired
The bill's id, from 'List bills', 'Create bill' or a trigger.
Void datevoid_datedate
The day the void posts on. Defaults to today.

Outputs

billobject
The bill
Example output
{
  "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 IDinvoice_idtextRequired
The invoice's id, from 'List invoices', 'Create invoice' or a trigger.
Void datevoid_datedate
The day the void posts on. Defaults to today.

Outputs

invoiceobject
The invoice
Example output
{
  "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"
  }
}

On this page