Campfire Accounts Receivable API
Operations related to invoicing and the AR subledger
Campfire Accounts Receivable API is one of 12 APIs that Campfire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Accounts Receivable. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 41 operations across 27 paths, and defines 58 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.meetcampfire.com.
41 operations
27 paths
58 schemas
5 DELETE12 GET3 PATCH17 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Campfire Accounts Receivable API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (knoxApiToken).
knoxApiToken— Token-based authentication with required prefix "Token"
Paths & Operations 41
Across 27 paths, the API surfaces 41 operations — 5 DELETE, 12 GET, 3 PATCH, 17 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Accounts Receivable 41
Operations related to invoicing and the AR subledger
GET
/coa/api/v1/credit-memo
List Credit Memos
POST
/coa/api/v1/credit-memo
Create Credit Memo
POST
/coa/api/v1/credit-memo/{credit_memo_id}/mark-used
Mark Credit Memo as Used
POST
/coa/api/v1/credit-memo/{credit_memo_id}/payment/{payment_id}/void
Void Credit Memo Used Payment
DELETE
/coa/api/v1/credit-memo/{credit_memo_id}/payment/{payment_id}/void
Delete Credit Memo Used Payment
POST
/coa/api/v1/credit-memo/{credit_memo_id}/reopen/
Reopen Voided Credit Memo
POST
/coa/api/v1/credit-memo/{credit_memo_id}/void/
Void Credit Memo
GET
/coa/api/v1/credit-memo/{id}
Retrieve Credit Memo
PUT
/coa/api/v1/credit-memo/{id}
Update Credit Memo
PATCH
/coa/api/v1/credit-memo/{id}
Partial Update Credit Memo
DELETE
/coa/api/v1/credit-memo/{id}
Delete Credit Memo
GET
/coa/api/v1/credit-memo/{id}/pdf/
Get Credit Memo PDF
PUT
/coa/api/v1/credit-memo/{id}/send/
Send Credit Memo
POST
/coa/api/v1/credit-memo/bulk-search
Bulk Search Credit Memos by Number
GET
/coa/api/v1/credit-memo/next-credit-memo-number
Get Next Credit Memo Number
GET
/coa/api/v1/invoice/
List Invoices
POST
/coa/api/v1/invoice/
Create Invoice
GET
/coa/api/v1/invoice-payments
List Invoice Payments
POST
/coa/api/v1/invoice/{invoice_id}/calculate-payment
Calculate Invoice Payment
POST
/coa/api/v1/invoice/{invoice_id}/default-payment
Get Default Payment Amount
POST
/coa/api/v1/invoice/{invoice_id}/pay/
Mark Invoice as Paid
POST
/coa/api/v1/invoice/{invoice_id}/payment/{payment_id}/void/
Void Invoice Payment
DELETE
/coa/api/v1/invoice/{invoice_id}/payment/{payment_id}/void/
Delete Invoice Payment
POST
/coa/api/v1/invoice/{invoice_id}/reopen/
Reopen Voided Invoice
POST
/coa/api/v1/invoice/{invoice_id}/void/
Void Invoice
GET
/coa/api/v1/invoice/{id}/
Retrieve Invoice
PUT
/coa/api/v1/invoice/{id}/
Update Invoice
PATCH
/coa/api/v1/invoice/{id}/
Partial Update Invoice
DELETE
/coa/api/v1/invoice/{id}/
Delete Invoice
POST
/coa/api/v1/invoice/bulk-apply-payment
Bulk Apply Transaction Payment to Selected Invoices
POST
/coa/api/v1/invoice/bulk-create
Bulk Create Invoices
POST
/coa/api/v1/invoice/bulk-search
Bulk Search Invoices by Number
GET
/coa/api/v1/invoice/report/{id}/data
Execute invoice report
GET
/coa/api/v1/invoice/report/preview
Preview invoice report
GET
/coa/api/v1/invoice/statement/client/{client_id}/pdf/
Get Client Invoice Statement PDF
GET
/rr/api/v1/product
List Contract Products
POST
/rr/api/v1/product
Create Contract Product
GET
/rr/api/v1/product/{id}
Retrieve Product
PUT
/rr/api/v1/product/{id}
Update Product
PATCH
/rr/api/v1/product/{id}
Partial Update Product
DELETE
/rr/api/v1/product/{id}
Delete Product
Schemas 58
The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are PatchedAccountingInvoice (112 properties), AccountingInvoice (112 properties), AccountingInvoiceList (100 properties), AccountingCreditMemo (50 properties). Each schema is shown below with its type and property counts.
AccountingCreditMemo
object
50 properties
23 required
PaginatedInvoicePaymentSyncList
object
4 properties
2 required
AccountingInvoiceJournalEntry
object
7 properties
7 required
CreditMemoPaymentInput
object
3 properties
3 required
AccountingInvoiceLine
object
34 properties
15 required
MarkCreditMemoUsed
object
Serializer for marking a credit memo as used with a transaction.
5 properties
4 required
PaginatedAccountingInvoiceListList
object
4 properties
2 required
AccountingCreditMemoPayment
object
15 properties
9 required
ProductUsageTierSummary
object
7 properties
7 required
PricingModelEnum
string
unitbased - Unit based pricing fixedfee - Fixed fee pricing percentagebased - Percentage based pricing graduatedtiered - Graduated tiered pricing volumebased -…
MarkPaidCreditMemo
object
3 properties
3 required
PaginatedAccountingCreditMemoList
object
4 properties
2 required
MarkInvoicePaidAutoCreatedCreditMemo
object
2 properties
2 required
EngineUsedEnum
string
postgres - postgres
PatchedProduct
object
44 properties
BlankEnum
TransactionPaymentInput
object
4 properties
3 required
BulkInvoice
object
1 property
1 required
EmptyTransactionInput
object
3 properties
2 required
ApplicationStatusEnum
string
open - Open partiallyused - Partially Used used - Used voided - Voided
CreditMemoTypeEnum
string
creditmemo - Credit Memo overpayment - Overpayment
BulkApplyInvoicePayment
object
3 properties
1 required
MarkPaid
object
5 properties
PaymentStatusCdcEnum
string
draft - Draft open - Open sent - Sent partial - Partially Paid paid - Paid uncollectible - Uncollectible voided - Voided
InvoiceReportResponse
object
Output schema for invoice report responses.
8 properties
5 required
MarkInvoicePaidResponse
object
200 payload for the mark-invoice-paid endpoint. The endpoint returns ids of the records it created rather than the invoice itself. autocreatedcreditmemos is on…
3 properties
2 required
BulkInvoiceSearch
object
1 property
1 required
MarkPaidEmptyTransaction
object
13 properties
4 required
AccountingInvoiceJournalEntryTypeEnum
string
reclassification - Reclassification adjustment - Adjustment dispute - Dispute refund - Refund refundfailure - Refund Failure fxloss - FX Loss recoverables - Re…
VoidPayment
object
1 property
VoidCreditMemoRequest
object
1 property
1 required
ProductUsageGroupSummary
object
6 properties
3 required
TermsEnum
string
custom - Custom net5 - Net 5 net7 - Net 7 net10 - Net 10 net15 - Net 15 net20 - Net 20 net30 - Net 30 net40 - Net 40 net45 - Net 45 net60 - Net 60 net90 - Net…
File
object
17 properties
14 required
PatchedAccountingInvoice
object
112 properties
CalculatePaymentOutput
object
6 properties
6 required
BulkCreditMemo
object
1 property
1 required
CalculatePaymentInput
object
3 properties
MarkPaidTransaction
object
10 properties
1 required
BulkApplyInvoicePaymentFilters
object
5 properties
AccountingInvoicePayment
object
24 properties
13 required
Source24dEnum
string
STRIPE - Stripe MANUAL - Manual
PaginatedProductList
object
4 properties
2 required
NullEnum
BulkCreateInvoices
object
Serializer for bulk invoice creation. Accepts a list of invoice data.
1 property
1 required
InvoicePaymentSync
object
12 properties
12 required
PatchedAccountingCreditMemo
object
50 properties
GetDefaultPaymentInput
object
2 properties
1 required
BulkCreditMemoSearch
object
1 property
1 required
Product
object
44 properties
18 required
InvoiceReportResultRow
object
Schema for a single result row (dimensions + aggregates + drilldown).
3 properties
3 required
AccountingInvoiceList
object
Lightweight serializer for the invoice list endpoint. Excludes heavy nested fields (emails, payments, attachments, paymentjournalentries) that are only needed…
100 properties
40 required
AccountingInvoice
object
112 properties
52 required
PaymentTypeEnum
string
CREDITMEMO - Credit Memo BANKTRANSACTION - Bank Transaction MANUALTRANSACTION - Manual Transaction
AccountingCreditMemoLine
object
23 properties
13 required
VoidInvoiceRequest
object
1 property
MarkPaidDebitMemo
object
3 properties
3 required
GetDefaultPaymentOutput
object
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Campfire 11
Other APIs Campfire publishes across the network.
Campfire Accounts Payable API
Campfire Bank Reconciliation API
Campfire Cash Management API
Campfire coa API
Campfire Company Objects API
Campfire Core Accounting API
Campfire Custom Fields API
Campfire Financial Statements API
Campfire Integrations API
Campfire Revenue Recognition API
Campfire Settings API
#Accounts Receivable