Skip to main content
GET
/
coa
/
api
/
v1
/
invoice
/
{id}
Retrieve Invoice
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/v1/invoice/{id}/ \
  --header 'Authorization: <api-key>'
{
  "id": 47864,
  "lines": [
    {
      "id": 206228,
      "product_name": "Enterprise Subscription",
      "stripe_product_id": "prod_RncZVXRunpKxAk",
      "product_is_taxable": true,
      "anrok_item_id": null,
      "service_date": "2028-04-01",
      "description": "Enterprise Subscription (2028-04-01 - 2028-06-30)",
      "quantity": 1,
      "rate": 6249.99,
      "currency": "USD",
      "amount": 6249.99,
      "tax": 0,
      "tax_description": null,
      "created_at": "2025-05-02T16:24:50+0000",
      "last_modified_at": "2025-05-02T16:24:50+0000",
      "product": 1717
    }
  ],
  "payments": [
    {
      "id": 22220,
      "credit_memo": null,
      "currency": "USD",
      "amount": 6249.99,
      "payment_date": "2025-04-30",
      "created_at": "2025-04-24T23:13:35+0000",
      "voided_date": null,
      "source": "MANUAL",
      "last_modified_at": "2025-04-24T23:13:35+0000",
      "payment_journal_entry": null,
      "payment_transaction": null,
      "voided_journal_entry": null
    }
  ],
  "payment_journal_entries": [
    null
  ],
  "client_name": "Apple",
  "client_email": null,
  "client_invoice_message": null,
  "client_use_stripe_auto_bill": false,
  "status": "paid",
  "past_due_days": null,
  "entity_name": "Top Level",
  "entity_currency": "USD",
  "entity_invoice_message": "Please make a payment to the following bank:\n\nBank Name: JP Morgan Chase\nBank Address: 456 Another Rd, San Francisco, CA, USA\nSWIFT/BIC Code: XYZBUS22\nAccount Number: 123456789\nAccount Type: Checking\nAccount Name: Campfire Software",
  "total_amount": 6249.99,
  "amount_paid": 6249.99,
  "amount_due": 0,
  "attachments": [],
  "invoice_number": "INV-0000493",
  "revenue_transactions": [],
  "item_date": null,
  "voided_journal_entry_order": null,
  "search_vector": null,
  "search_text": "INV_0000493 Apple",
  "auto_send_invoice": false,
  "auto_send_invoice_at": null,
  "auto_sent_at": null,
  "reminder_sent_dates": {},
  "billing_address": "",
  "shipping_address": "",
  "terms": "net_30",
  "ref_number": null,
  "purchase_order_number": null,
  "invoice_date": "2028-04-01",
  "due_date": "2028-05-01",
  "shipping_date": null,
  "paid_date": "2025-04-30",
  "uncollectible_date": null,
  "sent_date": null,
  "period_start": "2028-04-01",
  "period_end": "2028-06-30",
  "location_of_sale": null,
  "message_on_invoice": "Pay invoice here: https://billing.stripe.com/p/login/test_8wM8At9rYeT3ayY4gm",
  "payment_status": "paid",
  "warning_message": null,
  "created_at": "2025-03-21T19:39:47+0000",
  "last_modified_at": "2025-05-02T16:24:50+0000",
  "currency": "USD",
  "exchange_rate": 1,
  "exchange_rate_book": 1,
  "last_sent_at": null,
  "integration_id": null,
  "integration_context": null,
  "use_stripe_auto_bill": false,
  "stripe_payment_link_id": null,
  "stripe_payment_intent_id": null,
  "stripe_invoice_id": null,
  "stripe_pdf_url": null,
  "stripe_payment_link": null,
  "source": null,
  "source_id": null,
  "voided_date": null,
  "entity": 54,
  "client": 24020,
  "bad_debt_journal_entry": null,
  "journal_entry": 2681173,
  "contract": null,
  "avalara_connection": null,
  "sphere_connection": null,
  "anrok_connection": null,
  "tax_rate": null,
  "stripe_connection": null,
  "source_file": null,
  "voided_journal_entry": null
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
integer
required

Response

200 - application/json
​
id
integer
required
​
lines
object[]
required
​
payments
object[]
required
​
payment_journal_entries
integer[]
required
​
journal_entry_intercompany
string
required
​
client_name
string
required
​
client_email
string
required
​
client_invoice_message
string
required
​
client_use_stripe_auto_bill
boolean
required
​
status
string
required
​
past_due_days
integer | null
required
​
entity_name
string
required
​
entity_currency
string
required
​
entity_invoice_message
string
required
​
total_amount
number<double>
required
Required range: -1000000000000000000 < x < 1000000000000000000
​
amount_paid
number<double>
required
Required range: -1000000000000000000 < x < 1000000000000000000
​
amount_due
number<double>
required
​
contract_name
string
required
​
attachments
object[]
required
​
stripe_connection_name
string
required
​
stripe_connection_entity
integer
required
​
stripe_connection_billing_portal_enabled
boolean
required
​
avalara_connection_name
string
required
​
avalara_connection_company
string
required
​
tax_rate_name
string
required
​
tax_rate_value
number<double>
required
Required range: -1000000 < x < 1000000
​
payment_term_name
string
required
​
voided_journal_entry_order
integer | null
required
​
last_modified_at
string<date-time>
required
​
is_deleted
boolean
default:false
required
​
deleted_at
string<date-time> | null
required
​
search_vector
string | null
required
​
search_text
string | null
required
​
invoice_date
string<date>
required
​
due_date
string<date>
required
​
created_at
string<date-time>
required
​
customer
integer
required
​
entity
integer
required
​
invoice_number
string
​
revenue_transactions
integer[]
​
item_date
string<date> | null
​
auto_send_invoice
boolean | null
​
auto_send_invoice_at
string<date> | null
​
auto_sent_at
string<date> | null
​
reminder_sent_dates
any

Dictionary tracking when reminders were sent for each day overdue (e.g., {'5': '2024-01-15', '10': '2024-01-20'})

​
billing_address
string | null
​
shipping_address
string | null
​
terms
  • custom - Custom
  • net_5 - Net 5
  • net_7 - Net 7
  • net_10 - Net 10
  • net_15 - Net 15
  • net_20 - Net 20
  • net_30 - Net 30
  • net_40 - Net 40
  • net_45 - Net 45
  • net_60 - Net 60
  • net_90 - Net 90
  • net_105 - Net 105
  • net_120 - Net 120
  • due_on_receipt - Due on Receipt
Available options:
custom,
net_5,
net_7,
net_10,
net_15,
net_20,
net_30,
net_40,
net_45,
net_60,
net_90,
net_105,
net_120,
due_on_receipt
​
ref_number
string | null
Maximum string length: 120
​
purchase_order_number
string | null
Maximum string length: 120
​
shipping_date
string<date> | null
​
paid_date
string<date> | null
​
uncollectible_date
string<date> | null
​
sent_date
string<date> | null
​
period_start
string<date> | null
​
period_end
string<date> | null
​
location_of_sale
string | null
​
message_on_invoice
string | null
​
payment_status
  • open - Open
  • sent - Sent
  • partial - Partially Paid
  • paid - Paid
  • uncollectible - Uncollectible
  • voided - Voided
Available options:
open,
sent,
partial,
paid,
uncollectible,
voided
​
anrok_transaction_id
string | null

ID of the transaction in Anrok (set when transaction is created)

Maximum string length: 255
​
warning_message
string | null
​
currency
string
Maximum string length: 3
​
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
​
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
​
last_sent_at
string<date-time> | null
​
integration_id
string | null
Maximum string length: 250
​
integration_context
unknown
​
vat_number
string | null
Maximum string length: 250
​
discount
number<double> | null

Discount amount for the invoice

Required range: -1000000000000000000 < x < 1000000000000000000
​
payment_term_applied_discount
number<double> | null

Discount amount applied based on payment term early payment discount

Required range: -1000000000000000000 < x < 1000000000000000000
​
use_stripe_auto_bill
boolean | null
​
stripe_payment_link_id
string | null
Maximum string length: 500
​
stripe_payment_intent_id
string | null
Maximum string length: 500
​
stripe_invoice_id
string | null
Maximum string length: 500
​
stripe_pdf_url
string | null
Maximum string length: 500
​
stripe_payment_link
string | null
Maximum string length: 500
​
source
string | null
Maximum string length: 250
​
source_id
string | null
​
voided_date
string<date> | null
​
client
integer | null
​
payment_term
integer | null
​
bad_debt_journal_entry
integer | null
​
journal_entry
integer | null
​
voided_journal_entry
integer | null
​
entity_transfer_journal_entry
integer | null
​
contract
integer | null
​
avalara_connection
integer | null
​
sphere_connection
integer | null
​
anrok_connection
integer | null
​
tax_rate
integer | null
​
stripe_connection
integer | null
​
source_file
integer | null