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
| Action | What it does |
|---|---|
| Create bill | Record a bill from a vendor. |
| Create invoice | Create an invoice to a customer for one of your products. |
| Create journal entry | Post a journal entry: debit one account and credit another, or give several balanced lines. |
| Create vendor or customer | Add a vendor (who sends you bills) or a customer (who gets your invoices). |
| Delete bill | Delete a bill and its journal entry for good. |
| Delete invoice | Delete an invoice with its payments and journal entries for good. |
| Delete journal entry | Delete a journal entry. |
| Delete vendor or customer | Delete a vendor or customer. |
| Find vendors and customers | Find vendors and customers by name, email or company, or those changed since a time. |
| Get balance sheet | Get the balance sheet: each account's balance at the end of each month, quarter or year in a range. |
| Get bill | Get one bill with its lines, payments and amount due. |
| Get invoice | Get one invoice with its lines, payments, amount due and payment link. |
| 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. |
| List accounts | List the chart of accounts with balances, optionally only one type (such as expenses) or those matching a name or number. |
| List bank accounts | List bank and card accounts with their current and available balances. |
| List bank transactions | List the transactions from your bank and card feeds, with amounts, descriptions and the entries they were booked to. |
| List bills | List bills, newest first, filtered by status, vendor, entity, bill date, search words or when they last changed. |
| List invoices | List invoices, newest first, filtered by status, customer, entity, invoice date, number or search words. |
| List journal entries | List journal entries with their lines, in a date range (the last six months unless given) and optionally for one account. |
| List products | List the products and services you sell, with prices. |
| Record bill payment | Record that a bill was paid, in full or in part, from an account such as your bank account. |
| Record invoice payment | Record a payment received on an invoice, in full or in part, into an account such as your bank account. |
| Reopen voided bill | Undo a bill's void, so it is open to pay again. |
| Update vendor or customer | Change a vendor's or customer's details. |
| Void bill | Void a bill with a reversing entry. |
| Void invoice | Void an invoice with a reversing entry. |
Create bill
Record a bill from a vendor. It posts to accounts payable at once.
Inputs
- Vendor
vendor_idtextRequired - Who the bill is from. Pick one, or give its id.
- Bill number
bill_numbertextRequired - The number on the vendor's bill or invoice.
- Expense account
account_idtext - The account the cost goes to. Required unless Lines is used.
- Amount
amountnumber - The bill's amount. Required unless Lines is used.At least 0.01.
- Description
descriptiontext - What the bill is for.
- Department
department_idtext - The department the cost belongs to.
- Bill date
bill_datedate - The date on the bill. Defaults to today.
- Payment terms
termstext - 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_datedate - Defaults to the date the payment terms give.
- Entity
entity_idtext - The company or subsidiary it belongs to. Defaults to your main one.
- Currency
currencytext - Defaults to the entity's currency.
- Message
memotext - 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
- Customer
customer_idtextRequired - Who the invoice is to. Pick one, or give its id.
- Product
product_idtext - What you are charging for. Required unless Lines is used.
- Price
unit_pricenumber - The price of one unit. Required unless Lines is used.
- Quantity
quantitynumber - How many. Defaults to 1.At least 0.0001. Default:
1. - Description
descriptiontext - The line's description, shown on the invoice.
- Invoice number
invoice_numbertext - The invoice's number, such as INV-1042.
- Invoice date
invoice_datedate - The date on the invoice. Defaults to today.
- Payment terms
termstext - 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_datedate - Defaults to the date the payment terms give.
- Entity
entity_idtext - The company or subsidiary it belongs to. Defaults to your main one.
- Currency
currencytext - Defaults to the entity's currency.
- Message
memotext - A message shown on the document.
- PO number
purchase_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 account
debit_account_idtext - The account to debit. Required unless Lines is used.
- Credit account
credit_account_idtext - The account to credit. Required unless Lines is used.
- Amount
amountnumber - The amount debited and credited. Required unless Lines is used.At least 0.01.
- Line description
descriptiontext - A description on both lines.
- Date
entry_datedate - The day the entry posts on. Defaults to today.
- Memo
memotext - What the entry is for.
- Entity
entity_idtext - The company or subsidiary it belongs to. Defaults to your main one.
- Currency
currencytext - Defaults to the entity's currency.
- Reverse on
reversal_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
- Name
nametextRequired - The vendor's or customer's name.
- Type
contact_typetext - A vendor sends you bills; a customer gets your invoices.One of:
vendor(Vendor (default)),customer. Default:vendor. - Company name
company_nametext - The legal company name, if it differs.
- Email
emailtext - Where bills or invoices are sent.
- Phone
phone_numbertext - Phone number.
- Website
websitetext - Website address.
- Street address
address_street_1text - Street and number.
- Address line 2
address_street_2text - Suite, floor or building.
- City
citytext - City.
- State or region
statetext - State, province or region.
- ZIP or postal code
zip_codetext - ZIP or postal code.
- Country
countrytext - Country.
- Payment terms
termstext - 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_idtext - Your own id for them, such as their id in your CRM.
- Notes
notestext - 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 ID
bill_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 ID
invoice_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 ID
journal_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 customer
contact_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
- Type
contact_typetext - Only vendors, or only customers. Leave empty for both.One of:
vendor(Vendors),customer(Customers). - Search
searchtext - A name, email or company name to look for.
- Changed since
modified_sincedate and time - Only those created or changed at or after this time.
- Include inactive
include_inactivetrue/false - Also return vendors and customers marked inactive.Default:
false. - Page size
limitnumber - How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
- Skip
offsetnumber - 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
- From
start_datedate - The first day covered. Defaults to six months ago.
- To
end_datedate - The last day covered. Defaults to the end of this month.
- Columns
cadencetext - One column per month, quarter, year, week or day.One of:
monthly(Monthly (default)),quarterly,yearly,weekly,daily. Default:monthly. - Entity
entity_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 ID
bill_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 ID
invoice_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
- From
start_datedate - The first day covered. Defaults to six months ago.
- To
end_datedate - The last day covered. Defaults to the end of this month.
- Columns
cadencetext - One column per month, quarter, year, week or day.One of:
monthly(Monthly (default)),quarterly,yearly,weekly,daily. Default:monthly. - Entity
entity_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
- Type
account_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). - Search
searchtext - Part of an account's name or number.
- Most to return
limitnumber - 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 size
limitnumber - How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
- Skip
offsetnumber - 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 size
limitnumber - How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
- Skip
offsetnumber - 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
- Status
statustext - 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_idtext - Only bills from this vendor.
- Entity
entity_idtext - Only this company or subsidiary.
- From
start_datedate - Only those dated on or after this day.
- To
end_datedate - Only those dated on or before this day.
- Search
searchtext - Words to look for, such as a name or a number.
- Changed since
modified_sincedate and time - Only those created or changed at or after this time.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
- Skip
offsetnumber - 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
- Status
statustext - 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_idtext - Only invoices to this customer.
- Entity
entity_idtext - Only this company or subsidiary.
- From
start_datedate - Only those dated on or after this day.
- To
end_datedate - Only those dated on or before this day.
- Invoice number
invoice_numbertext - Only the invoice with exactly this number.
- Search
searchtext - Words to look for, such as a name or a number.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
- Skip
offsetnumber - 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
- From
start_datedate - Only those dated on or after this day.
- To
end_datedate - Only those dated on or before this day.
- Account
account_idtext - Only entries with a line on this account.
- Page size
limitnumber - How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
- Skip
offsetnumber - 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 size
limitnumber - How many to return, 1 to 1000. Defaults to 50.From 1 to 1000.
- Skip
offsetnumber - 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 ID
bill_idtextRequired - The bill's id, from 'List bills', 'Create bill' or a trigger.
- Paid through
account_idtextRequired - The account the money moved through, usually a bank or card account.
- Amount
amountnumber - How much was paid. Defaults to the full amount due.At least 0.01.
- Payment date
payment_datedate - The day it was paid. Defaults to today.
- Note
memotext - 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 ID
invoice_idtextRequired - The invoice's id, from 'List invoices', 'Create invoice' or a trigger.
- Paid through
account_idtextRequired - The account the money moved through, usually a bank or card account.
- Amount
amountnumber - How much was paid. Defaults to the full amount due.At least 0.01.
- Payment date
payment_datedate - The day it was paid. Defaults to today.
- Note
memotext - 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 ID
bill_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 customer
contact_idtextRequired - Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Company name
company_nametext - The legal company name, if it differs.
- Email
emailtext - Where bills or invoices are sent.
- Phone
phone_numbertext - Phone number.
- Website
websitetext - Website address.
- Street address
address_street_1text - Street and number.
- Address line 2
address_street_2text - Suite, floor or building.
- City
citytext - City.
- State or region
statetext - State, province or region.
- ZIP or postal code
zip_codetext - ZIP or postal code.
- Country
countrytext - Country.
- Payment terms
termstext - 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_idtext - Your own id for them, such as their id in your CRM.
- Notes
notestext - 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 ID
bill_idtextRequired - The bill's id, from 'List bills', 'Create bill' or a trigger.
- Void date
void_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 ID
invoice_idtextRequired - The invoice's id, from 'List invoices', 'Create invoice' or a trigger.
- Void date
void_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"
}
}