Get list of invoices

get

https://api.frisbii.com/v1/list/invoice

Query Params

from

string

Time range from (inclusive). Local date and time (according to account timezone) on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS. Default from if no interval is given depends on the query. If the query limits on relation e.g. customer and/or subscription, the default from will be epoch 1970-01-01, otherwise one month before to

string

Time range to (exclusive). Local date and time (according to account timezone) on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS. Defaults to now.

interval

string

Limit from to and interval back in time. E.g. one week. Will take precedence over from. Defined in ISO 8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations

size

int32

10 to 100

Defaults to 20

Page size between 10 and 100 (default 20)

next_page_token

string

Next page token from previous response to get next page

range

string

enum

Defaults to created

Time and date attribute to time limit. Either created or settled. Default is created.

Allowed:

handle

string

Invoice exact handle

handle_prefix

string

Invoice handle prefix

handle_contains

string

Invoice handle contains

accounting_number

string

Invoice exact accounting number

accounting_number_prefix

string

Invoice accounting number prefix

accounting_number_contains

string

Invoice accounting number contains

state

array of strings

enum

Invoice state, multiple can be defined

exclude_state

array of strings

enum

Invoice state to exclude, multiple can be defined

customer

string

Invoices for customer by customer handle

amount

string

Amount in minor unit interval. See documentation of intervals.

refunded_amount

string

Refunded amount in minor unit interval. See documentation of intervals.

authorized_amount

string

Authorized amount in minor unit interval. See documentation of intervals.

currency

array of strings

Invoice currency in ISO 4217 three letter alpha code. Multiple can be defined.

currency

partial_settled

boolean

Filter invoices based on partial settled. If true invoices where authorized_amount < settled_amount is returned. If false invoices where settled_amount = authorized_amount is returned.

settled_amount

string

Filter invoices by settled amount.

debtor_id

string

Invoices for customer by debtor id

type

array of strings

enum

Invoice type, multiple can be defined. s - subscription recurring, so - subscription one-time, soi - subscription one-time instant, co - customer one-time, ch - charge

subscription

string

Invoices for subscription by subscription handle

plan

string

Invoices for subscription plan by subscription plan handle

dunning_start

string

Dunning start date and time in local date time interval for account timezone. Date time given in ISO-8601 local date or local date time. See documentation of intervals.

dunning_success

string

Dunning success date and time in local date time interval for account timezone. Date time given in ISO-8601 local date or local date time. See documentation of intervals.

number

int32

≥ 1

Invoice number if subscription invoice

due

string

Due date if due date defined for subscription invoice

customer_name

string

Customer name filter. The name will be split by spaces, and invoices will be filtered where customer's first_name or last_name starts with any of these substrings.

Responses

200Successful operation

400Invalid request, see error codes at https://api.frisbii.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii