APappdirect
PurchaseOrder

List all purchase order invoices

Changed on

List all purchase order invoices

get/billing/v1/orders/{orderId}/invoices

Request

Path parameters

orderIdnumber required

The specific order id for which information is requested

Query parameters

countstring

Number of results to fetch. Used for paging.

excludeFreeboolean

Exclude invoices whose amount is zero

fromDatenumber

Filter by the start date of the invoice

sortField'DATE' | 'INVOICE_ID' | 'TOTAL'

The filed to be used for sorting com.appdirect.backend.api.billing.types.OrderSortWS.

sortOrder'ASC' | 'DESC'

Sort order org.springframework.data.domain.Sort.Direction.

startstring

First result index. Used for paging.

status'CARRIED' | 'PAID' | 'UNPAID' | 'VOIDED'

Filter by the status of the invoice

toDatenumber

Filter by the end date of the invoice

Response

OK

creationDatenumber nullable

Creation date for the invoice.

orderIdsstring[]

Array of Order IDs

currency'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN'

Supported currencies for the system

dueDatenumber nullable

Due date for the invoice.

invoiceIdnumber nullable

Invoice ID.

referenceNumberstring nullable

Reference number.

status'PAID' | 'UNPAID' | 'CARRIED' | 'VOIDED'
totalnumber nullable

Invoice total.

Example response

[
  {
    "company": {
      "href": "...",
      "id": "..."
    },
    "creationDate": 12345,
    "currency": "DKK",
    "dueDate": 12345,
    "invoiceId": 12345,
    "links": [
      {
        "href": "...",
        "rel": "..."
      },
      {
        "href": "...",
        "rel": "..."
      }
    ],
    "referenceNumber": "...",
    "status": "PAID",
    "total": 12345,
    "user": {
      "href": "...",
      "id": "..."
    }
  }
]

Changes