Skip to main content
GET
/
coa
/
api
/
vendor
/
summary
List Vendor Summaries
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/vendor/summary \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "dba": "<string>",
      "total_spend": 0,
      "total_bill_spend": 0,
      "total_card_spend": 0,
      "total_paid": 0,
      "total_unpaid": 0,
      "total_credits": 0,
      "credit_used": 0,
      "credit_available": 0,
      "total_spend_book": 0,
      "total_bill_spend_book": 0,
      "total_card_spend_book": 0,
      "total_paid_book": 0,
      "total_unpaid_book": 0,
      "total_credits_book": 0,
      "credit_used_book": 0,
      "credit_available_book": 0
    }
  ],
  "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

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
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"