Search invoices

get

https://{tenant}.onechurchsoftware.com/api/billing/invoices

Retrieve the account's subscription invoices. All invoices for the account's subscription are returned, newest first, with any filters, sorting and paging applied to the complete set. Requires permission to manage the account.

Required permission: Full Account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

number

int32

≥ 1

Filter by invoice number.

date.start

date-time

The earliest invoice date to include.

date.end

date-time

The latest invoice date to include.

total.start

double

The minimum invoice total to include.

total.end

double

The maximum invoice total to include.

credits.start

double

The minimum credit amount to include.

credits.end

double

The maximum credit amount to include.

paid.start

double

The minimum paid amount to include.

paid.end

double

The maximum paid amount to include.

items

string

Filter by text found in the invoice's line item descriptions. Each word must appear in at least one line item.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK