Get invoices

get

https://api.helcim.com/v2/invoices/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Page number for paginated results. Defaults to the first page if omitted.

dateStart

date-time

Filter invoices created on or after this date or date-time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. If time is omitted, 00:00:00 is assumed. If dateEnd is provided, it must not be earlier than dateStart.

dateEnd

date-time

Filter invoices created on or before this date or date-time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. If time is omitted, 23:59:59 is assumed. If dateStart is provided, dateEnd must not be earlier than dateStart.

invoiceNumber

string

Filter invoices by the exact invoice number. Matches exactly (case-insensitive). If no match exists, no invoices are returned.

customerId

string

Filter invoices by customer ID.

status

string

enum

Filter invoices by status.

type

string

enum

Filter invoices by type.

currency

string

enum

Filter invoices by currency code.

Allowed:

withConvenienceFee

integer

enum

Include the convenience fee for each invoice. If 1, the convenience fee is included in the response. If 0 or omitted, the convenience fee is set to 0.

Allowed:

withOrderFields

integer

enum

Include custom field values for each invoice. If 1, the orderFields array for each invoice is populated. If 0 or omitted, orderFields is always an empty array.

Allowed:

convenienceFeeEnabled

integer

enum

Filter invoices by whether the convenience fee is enabled. If 1, return all invoices with the convenience fee enabled. If 0, return all invoices with the convenience fee disabled. If omitted, no filter is applied.

Allowed:

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200Successful

defaultFailed