List Invoices

Retrieve a paginated list of invoices with comprehensive filtering, sorting, and download capabilities.

This endpoint provides powerful invoice listing with:

• Advanced filtering by date ranges, status, clients, and entities
• Full-text search across multiple fields
• Flexible sorting options including custom calculated fields
• Async CSV export functionality via email
• Optimized queries with prefetched relationships

Filtering Options:

• Date-based filtering (invoice_date, due_date ranges)
• Status-based filtering (payment status, sent status, aging buckets)
• Entity and client-based filtering (supports multiple selections)
• Contract and currency filtering
• Full-text search across invoice numbers, addresses, messages, and client names

Sorting Capabilities:

• Standard field sorting (invoice_date, total_amount, due_date, etc.)
• Custom calculated field sorting (amount_due, client_name, contract_name)
• Ascending/descending order with null handling

Performance Features:

• Efficient database queries with proper indexing
• Prefetched related objects (lines, payments, clients, entities)
• Pagination support for large datasets
• Optimized for high-volume invoice management

Export Functionality:

• Async CSV generation and email delivery
• Filtered export based on current query parameters
• Background processing to handle large datasets

GET /coa/api/v1/invoice

List Invoices

cURL

curl --request GET \
  --url https://api.meetcampfire.com/coa/api/v1/invoice/ \
  --header 'Authorization: <api-key>'

200

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "lines": [
        {
          "id": 123,
          "product_name": "<string>",
          "product_bundle_name": "<string>",
          "stripe_product_id": "<string>",
          "product_is_taxable": true,
          "anrok_item_id": "<string>",
          "sphere_item_id": "<string>",
          "tags": [
            {
              "id": 123,
              "group_name": "<string>",
              "parent_name": "<string>",
              "is_deleted": false,
              "deleted_at": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "last_modified_at": "2023-11-07T05:31:56Z",
              "customer": 123,
              "parent": 123,
              "is_active": true,
              "group": 123
            }
          ],
          "department_name": "<string>",
          "department_code": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "customer": 123,
          "service_date": "2023-12-25",
          "description": "<string>",
          "quantity": 0,
          "rate": 0,
          "currency": "<string>",
          "amount": 0,
          "tax": 0,
          "tax_description": "<string>",
          "entity_use_code": "<string>",
          "discount": 0,
          "discount_percentage": 0,
          "discount_amount": 0,
          "tag_ids": [
            0
          ],
          "tag_group_ids": [
            0
          ],
          "product": 123,
          "product_bundle": 123,
          "department": 123
        }
      ],
      "journal_entry_intercompany": "<string>",
      "client_name": "<string>",
      "client_email": "<string>",
      "client_invoice_message": "<string>",
      "client_use_stripe_auto_bill": true,
      "contract_custom_fields": [
        {}
      ],
      "status": "<string>",
      "past_due_days": 123,
      "entity_name": "<string>",
      "entity_currency": "<string>",
      "entity_invoice_message": "<string>",
      "total_amount": 0,
      "amount_paid": 0,
      "amount_due": 123,
      "contract_name": "<string>",
      "stripe_connection_name": "<string>",
      "stripe_connection_entity": 123,
      "stripe_connection_billing_portal_enabled": true,
      "avalara_connection_name": "<string>",
      "avalara_connection_company": "<string>",
      "tax_rate_name": "<string>",
      "tax_rate_value": 0,
      "payment_term_name": "<string>",
      "voided_journal_entry_order": 123,
      "last_modified_at": "2023-11-07T05:31:56Z",
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z",
      "search_vector": "<string>",
      "search_text": "<string>",
      "auto_sent_at": "2023-11-07T05:31:56Z",
      "invoice_date": "2023-12-25",
      "due_date": "2023-12-25",
      "sent_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "last_sent_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "entity": 123,
      "invoice_number": "<string>",
      "revenue_transactions": [
        123
      ],
      "item_date": "2023-12-25",
      "auto_send_invoice": true,
      "auto_send_invoice_at": "2023-12-25",
      "reminder_sent_dates": "<unknown>",
      "pre_due_reminder_sent_dates": "<unknown>",
      "billing_address": "<string>",
      "billing_addressee": "<string>",
      "shipping_address": "<string>",
      "shipping_addressee": "<string>",
      "ref_number": "<string>",
      "purchase_order_number": "<string>",
      "shipping_date": "2023-12-25",
      "paid_date": "2023-12-25",
      "uncollectible_date": "2023-12-25",
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "location_of_sale": "<string>",
      "message_on_invoice": "<string>",
      "ita_allocation_number": "<string>",
      "anrok_transaction_id": "<string>",
      "warning_message": "<string>",
      "currency": "<string>",
      "exchange_rate": 0,
      "exchange_rate_book": 0,
      "integration_id": "<string>",
      "integration_context": null,
      "vat_number": "<string>",
      "discount": 0,
      "payment_term_applied_discount": 0,
      "use_stripe_auto_bill": true,
      "stripe_payment_link_id": "<string>",
      "stripe_payment_intent_id": "<string>",
      "stripe_invoice_id": "<string>",
      "stripe_pdf_url": "<string>",
      "stripe_payment_link": "<string>",
      "source": "<string>",
      "source_id": "<string>",
      "is_migrated": true,
      "voided_date": "2023-12-25",
      "invoice_labels": null,
      "invoice_language": "<string>",
      "chat_id": -1,
      "client": 123,
      "payment_term": 123,
      "bad_debt_journal_entry": 123,
      "journal_entry": 123,
      "ar_account": 123,
      "voided_journal_entry": 123,
      "entity_transfer_journal_entry": 123,
      "contract": 123,
      "avalara_connection": 123,
      "sphere_connection": 123,
      "anrok_connection": 123,
      "tax_rate": 123,
      "stripe_connection": 123,
      "source_file": 123
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Query Parameters

client · integer

Filter by client ID. Can be specified multiple times

contract · integer

Filter by contract ID

currency · string

Filter by currency code (e.g., USD, EUR)

download · boolean · default: false

If true, triggers async CSV download workflow and sends result via email

end_date · string

Filter invoices with invoice_date on or before this date (YYYY-MM-DD)

entity · integer

Filter by entity ID. Can be specified multiple times

invoice_number · string

Filter by exact invoice number

limit · integer

Number of results to return per page.

line_tag_group_id · integer

Filter invoices with at least one line item assigned a tag from this tag group ID

line_tag_id · integer

Filter invoices with at least one line item assigned this tag ID

offset · integer

The initial index from which to return the results.

paid_date_from · string

Filter invoices with paid_date on or after this date (YYYY-MM-DD)

paid_date_to · string

Filter invoices with paid_date on or before this date (YYYY-MM-DD)

parent_client · integer

Filter by parent client (Vendor) ID. Returns invoices for the specified client and all of its descendants via vendor lineage.

q · string

Search query - searches shipping address, invoice number, message, or client name

ref_number · string

Filter by exact ref number

sentStatus · enum<string>

Filter by sent status

Available options: not_sent, sent

sort · string · default: -invoice_date

Sort order. Use field name for ascending, -field for descending. Special fields: client_name, amount_due. Default: -invoice_date

start_date · string

Filter invoices with invoice_date on or after this date (YYYY-MM-DD)

status · enum<string>

Filter by payment status

Available options: 1_30, 31_60, 61_90, 91_120, current, over_120, paid, partially_paid, past_due, sent, uncollectible, unpaid, voided

Response

200 - application/json

count · integer · required

Example:

123

results · object[] · required

Show child attributes

next · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"