Skip to main content
GET
/
coa
/
api
/
v1
/
invoice
/
report
/
{id}
/
data
Execute invoice report
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/v1/invoice/report/{id}/data \
  --header 'Authorization: <api-key>'
{
  "count": 5,
  "results": [
    {
      "client_id": 42,
      "client_name": "Acme Corp",
      "amount": 50000,
      "amount_paid": 30000,
      "Widget A::::amount": 25000,
      "Widget B::::amount": 25000,
      "filter_params": {
        "invoice__client_id": 42
      },
      "group_id": 123456,
      "id": 123456
    }
  ],
  "engine_used": "postgres",
  "pivot_result_fields": [
    "Widget A::::amount",
    "Widget B::::amount"
  ],
  "pivot_value_mappings": {
    "product_id": {
      "Widget A": 1,
      "Widget B": 2
    }
  }
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Query Parameters

aggregation_fields
string

Aggregates: sum:amount, sum:amount_paid, sum:amount_due, etc.

client_id
string

Filter by client ID(s)

contract_id
string

Filter by contract ID(s)

currency
string

Filter by currency code

department_id
string

Filter by department ID(s)

end_date
string

End date (YYYY-MM-DD)

entity_id
string

Entity ID(s), comma-separated

group_fields
string

Row dimensions: client_id, invoice_id, invoice_date_month, product_id, etc.

group_keys
string

Drilldown parent keys

limit
integer

Page size (max 10000)

mode
string

paginated | full | csv

offset
integer

Pagination offset

payment_status
string

Filter by status: draft,open,sent,partial,paid,uncollectible

pivot_fields
string

Column dimensions: product_id, client_id, etc.

product_id
string

Filter by product ID(s)

shouldPivot
boolean

Enable pivot columns

start_date
string

Start date (YYYY-MM-DD)

Response

200 - application/json

Output schema for invoice report responses.

count
integer
required

Total rows before pagination

next
string | null
required

Next page URL (null for datatable pagination)

previous
string | null
required

Previous page URL

results
object[]
required

Paginated result rows

engine_used
enum<string>
required

Execution engine: 'postgres'

  • postgres - postgres
Available options:
postgres
pivot_result_fields
string[]

Sorted list of pivot column names

pivot_value_mappings
object

Mapping of pivot field -> {display_name: id} for drilldown