PRproductive
Reports

Get invoice reports

Changed on

Retrieve aggregated invoice report data grouped by configurable dimensions.

get/api/v2/reports/invoice_reports

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/reports/invoice_reports
  • Auth
    none declared

Query parameters

OR

Filters

{
  "0": {
    "id": {
      "eq": "123"
    }
  },
  "$op": "and"
}
sortstring[]

Sort invoice report

group'company' | 'created_at' | 'creator' | 'currency' | 'custom_fields' | 'delivery_on' | 'einvoice_status' | 'fiscalization_status' | 'invoice' | 'invoice_aging' | 'invoice_state' | 'invoice_status' | 'invoice_type' | 'invoiced_on' | 'issuer' | 'last_activity_at' | 'month' | 'organization' | 'overdue_status' | 'paid_on' | 'pay_on' | 'payment_status' | 'quarter' | 'sent_on' | 'sent_status' | 'subsidiary' | 'week' | 'year'

Group invoice report

Response

Collection invoice report

Example response

{
  "data": [
    {
      "id": "r-008",
      "type": "invoice_reports",
      "attributes": {
        "total": "12500.00",
        "subtotal": "11363.64",
        "tax": "1136.36",
        "paid": "0.00",
        "outstanding": "12500.00",
        "status": "draft",
        "invoice_id": 234,
        "company_id": 65111,
        "currency": "USD"
      }
    }
  ],
  "included": [],
  "meta": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 42,
    "page_size": 30,
    "max_page_size": 200
  }
}

Changes

  • fa3060fd0144Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • f11a8740641aRevision changes
    • breaking

      the /// response's property type changed from integer to boolean for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from string to no type for status

    • breaking

      the /// response's property type changed from string to no type for status

    • breaking

      the /// response's property type changed from string to object for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from string to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    This list may be incomplete.