List invoices

Retrieves the list of invoices

GET /manage/company/invoice?offset={offset}&limit={limit}

URI Parameters

Name In Required Type Description

offset

query

False

integer

Offset of the first invoice in the list, default: 0

limit

query

False

integer

Maximum number of invoices returned, default: 20, maximum: 100

Responses

Name Type Description

200 OK

InvoiceListResponse

Invoice list response object

Produces

  • application/json

Security

Every request requires a JWT access token for authentication in the Authorisation HTTP header. Please see the API authentication page for details about how to get a JWT token.

Authorization: Bearer {JWT_TOKEN}

Roles

  • Wenenu Owner

  • Wenenu Billing Admin

Sample request

GET https://wenenu.com/manage/company/invoice?offset=0&limit=20 HTTP/1.1
Authorization: Bearer {jwt_token}

Sample Response

Status code: 200 OK

{
  "result": [
    {
      "id": 29,
      "name": "INV/2021/03/0010",
      "invoice_date": "2021-03-16T00:00:00.000+00:00",
      "amount_total": 240.0,
      "payment_state": "DUE",
      "invoice_date_due": "2021-04-30T00:00:00.000+00:00",
      "currency_id": 2,
      "currency": "USD"
    }
  ],
  "total": 1
}

Definitions

InvoiceListResponse

Name Type Description

result

Invoice[]

List of the requested invoices

total

long

Total number of invoices

Invoice

Name Type Description

id

integer

Numeric identifier of the invoice

currency_id

integer

Currency id of the invoice

currency

string

Three-letters ISO currency code of the invoice

amount_total

float

The total value of the invoice

invoice_date

string

Invoice issue date in ISO 8601 format

invoice_date_due

string

Invoice due date in ISO 8601 format

name

string

The number of the invoice

payment_state

string

Payment state of the invoice, possible values are NEW, DUE and PAID