billing

GET /billing/invoices/

Changed on

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Query parameters

accountstring

account

billing_method'braintree' | 'invoice' | 'stripe'

billing_method

confirmed_at__datestring date
confirmed_at__date_or_isnullstring date
confirmed_at__gtstring datetime
confirmed_at__gt_or_isnullstring datetime
confirmed_at__gtestring datetime
confirmed_at__gte_or_isnullstring datetime
confirmed_at__ltstring datetime
confirmed_at__lt_or_isnullstring datetime
confirmed_at__ltestring datetime
confirmed_at__lte_or_isnullstring datetime
created_atstring

created_at

created_at__datestring date
created_at__date_or_isnullstring date
created_at__gtstring datetime
created_at__gt_or_isnullstring datetime
created_at__gtestring datetime
created_at__gte_or_isnullstring datetime
created_at__ltstring datetime
created_at__lt_or_isnullstring datetime
created_at__ltestring datetime
created_at__lte_or_isnullstring datetime
cursorinteger

The pagination cursor value.

format'json' | 'xlsx'
orderingstring

Which field to use when ordering the results.

page_sizeinteger

Number of results to return per page.

state'draft' | 'confirmed' | 'overdue' | 'paid' | 'cancelled'

state

Response

idstring uuid required
urlstring uri required
billing_method'braintree' | 'invoice' | 'stripe' required
state'draft' | 'confirmed' | 'overdue' | 'paid' | 'cancelled' required
periodstring[] required

Indicates what period the price was calculated for

total_no_vatstring decimal required
total_vatstring decimal required
total_with_vatstring decimal required
currencystring required
vatboolean required
due_datestring date nullable
paid_atstring date-time required
pricingstring uuid required
confirmed_bystring uri required
confirmed_atstring date-time required
created_atstring date-time required
updated_atstring date-time required

Changes

    • info

      media type application/json; version=2.4.12 was changed to application/json; version=2.4.13 for the response status

    • info

      media type application/xlsx; version=2.4.12 was changed to application/xlsx; version=2.4.13 for the response status

    • info

      media type application/json; version=2.4.11 was changed to application/json; version=2.4.12 for the response status

    • info

      media type application/xlsx; version=2.4.11 was changed to application/xlsx; version=2.4.12 for the response status