Skip to main content
GET
/
coa
/
api
/
v1
/
invoice-payments
List Invoice Payments
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/v1/invoice-payments \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "invoice_id": 123,
      "invoice_number": "<string>",
      "amount": 0,
      "currency": "<string>",
      "payment_date": "2023-12-25",
      "external_id": "<string>",
      "voided_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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

​
cursor
string

Opts into cursor pagination. Pass an empty value (cursor=) on the first request, then follow the 'next' URL from each response until it is null. The cursor value is opaque - do not parse or construct it. Cursor pagination is recommended for full syncs as it avoids the performance penalty of deep offsets on large result sets.

​
last_modified_at__gte
string

Filter for payments modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Use this for incremental syncs: store the highest last_modified_at you have processed and pass it on the next sync run.

​
last_modified_at__lte
string

Filter for payments modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Date-only values are inclusive of the entire day.

​
limit
integer
default:100

Maximum number of records to return per page. Default 100, maximum 10000. Use with offset to paginate

​
offset
integer
default:0

Number of records to skip before collecting the result page. Use with limit to paginate

​
skip_count
boolean
default:false

When 'true', skips the total COUNT query and returns a lower-bound 'count' instead. Recommended for large syncs where the exact total is not needed.

​
voided
boolean

Filter by void status. When 'true', returns only voided payments (voided_date is set). When 'false', returns only active payments. When omitted, returns both so integrators can detect and propagate voids.

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"