Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
erp-invoices

Mixin for viewsets that provides a queryset based on a model class.

get/billing/org/v1/erp-invoices

Query parameters

billing_period_from__fromstring date

Billing period from (inclusive)

billing_period_to__tostring date

Billing period to (inclusive)

client_idnumber

Filter by client ID

currencystring

Filter by currency code

invoice_date__fromstring date

Invoice date from (inclusive)

invoice_date__tostring date

Invoice date to (inclusive)

limitinteger

Number of results to return per page. Maximum is 100.

move_type'out_invoice' | 'out_refund'

Filter by move type: out_invoice or out_refund

  • out_invoice - out_invoice
  • out_refund - out_refund
offsetinteger

The initial index from which to return the results.

orderingstring[]

Ordering of the results.

Default sort order is ascending. Put - before value for descending sort order: -id.

For sorting by multiple parameters write them as comma separated string: -client_id,id.

  • id - Id
  • -id - Id (descending)
  • invoice_date - Invoice date
  • -invoice_date - Invoice date (descending)
  • amount_total - Amount total
  • -amount_total - Amount total (descending)
  • created_at - Created at
  • -created_at - Created at (descending)
  • name - Name
  • -name - Name (descending)
payer_idnumber

Filter by payer ID

payment_state'in_payment' | 'not_paid' | 'paid' | 'partial' | 'reversed'

Filter by payment state

  • not_paid - not_paid
  • paid - paid
  • partial - partial
  • reversed - reversed
  • in_payment - in_payment

Response

Request successful.

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}