List bills

get

https://www.pelcro.com/api/v1/core/bills

Retrieve a paginated list of bills.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

limit

int32

Defaults to 10

The maximum number of objects you want returned per result set. For instance, if you set limit=10, the API will return a maximum of 10 objects in the response. (max: 100)

page

int32

Defaults to 1

The specific page of the result set you want to retrieve, typically used in conjunction with limit. For example, if you set page=2 and limit=10, the API will return the second page of results, containing a maximum of 10 objects starting from the 11th object.

sort

string

enum

Sort field. Prefix with - for descending.

vendor_id

integer

Filter by vendor ID.

status

string

enum

Filter by bill status.

Allowed:

filter[id]

string

Filter by bill ID. Example: eq:42

filter[user_id]

string

Filter by vendor user ID. Example: eq:1001

filter[status]

string

enum

Filter by bill status.

Allowed:

filter[number]

string

Filter by bill number. Example: like:BILL-001

filter[total][from]

number

Minimum total amount.

filter[total][to]

number

Maximum total amount.

filter[created_at][from]

date

Created on or after this date (YYYY-MM-DD).

filter[created_at][to]

date

Created on or before this date (YYYY-MM-DD).

filter[updated_at][from]

date

Updated on or after this date (YYYY-MM-DD).

filter[updated_at][to]

date

Updated on or before this date (YYYY-MM-DD).

filter[period_start][from]

date

Period start on or after this date (YYYY-MM-DD).

filter[period_start][to]

date

Period start on or before this date (YYYY-MM-DD).

filter[period_end][from]

date

Period end on or after this date (YYYY-MM-DD).

filter[period_end][to]

date

Period end on or before this date (YYYY-MM-DD).

filter[finalized_at][from]

date

Finalized on or after this date (YYYY-MM-DD).

filter[finalized_at][to]

date

Finalized on or before this date (YYYY-MM-DD).

filter[paid_at][from]

date

Paid on or after this date (YYYY-MM-DD).

filter[paid_at][to]

date

Paid on or before this date (YYYY-MM-DD).

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Invalid request.

401Unauthenticated.