Invoice Service Data API

get listing

GET /api/rest/admin/billing/invoice-service-data

Parameters

Name Description
filter[id] id filter
filter[amount-eq] amount eq filter
filter[amount-not-eq] amount not eq filter
filter[amount-gt] amount gt filter
filter[amount-gteq] amount gteq filter
filter[amount-lt] amount lt filter
filter[amount-lteq] amount lteq filter
filter[amount-in] amount in filter
filter[amount-not-in] amount not in filter
filter[transactions-count-eq] transactions count eq filter
filter[transactions-count-not-eq] transactions count not eq filter
filter[transactions-count-gt] transactions count gt filter
filter[transactions-count-gteq] transactions count gteq filter
filter[transactions-count-lt] transactions count lt filter
filter[transactions-count-lteq] transactions count lteq filter
filter[transactions-count-in] transactions count in filter
filter[transactions-count-not-in] transactions count not in filter
filter[spent-eq] spent eq filter
filter[spent-not-eq] spent not eq filter
filter[invoice-id-eq] invoice id eq filter
filter[invoice-id-not-eq] invoice id not eq filter
filter[invoice-id-in] invoice id in filter
filter[invoice-id-not-in] invoice id not in filter
filter[invoice-account-id-eq] invoice account id eq filter
filter[invoice-account-id-not-eq] invoice account id not eq filter
filter[invoice-account-id-in] invoice account id in filter
filter[invoice-account-id-not-in] invoice account id not in filter
filter[service-id-eq] service id eq filter
filter[service-id-not-eq] service id not eq filter
filter[service-id-in] service id in filter
filter[service-id-not-in] service id not in filter

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NDgsInN1YiI6MzB9.0WKg4iQYPILKIQnWFAskTuZ8u22yYZBSNr5YHlJHDr0
Host: example.org
Cookie: 

Route

GET /api/rest/admin/billing/invoice-service-data

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"9fa75c22e7f0c3100fd5e4b2622ce022"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 69dde67e-b663-4fbf-9bf7-069e560d1de3
X-Runtime: 0.009358
Content-Length: 1498

Status

200 OK

Body

{
  "data": [
    {
      "id": "1",
      "type": "invoice-service-data",
      "links": {
        "self": "http://example.org/api/rest/admin/billing/invoice-service-data/1"
      },
      "attributes": {
        "amount": "0.0",
        "transactions-count": 31,
        "spent": false
      },
      "relationships": {
        "invoice": {
          "links": {
            "self": "http://example.org/api/rest/admin/billing/invoice-service-data/1/relationships/invoice",
            "related": "http://example.org/api/rest/admin/billing/invoice-service-data/1/invoice"
          }
        },
        "service": {
          "links": {
            "self": "http://example.org/api/rest/admin/billing/invoice-service-data/1/relationships/service",
            "related": "http://example.org/api/rest/admin/billing/invoice-service-data/1/service"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "invoice-service-data",
      "links": {
        "self": "http://example.org/api/rest/admin/billing/invoice-service-data/2"
      },
      "attributes": {
        "amount": "82.0",
        "transactions-count": 41,
        "spent": true
      },
      "relationships": {
        "invoice": {
          "links": {
            "self": "http://example.org/api/rest/admin/billing/invoice-service-data/2/relationships/invoice",
            "related": "http://example.org/api/rest/admin/billing/invoice-service-data/2/invoice"
          }
        },
        "service": {
          "links": {
            "self": "http://example.org/api/rest/admin/billing/invoice-service-data/2/relationships/service",
            "related": "http://example.org/api/rest/admin/billing/invoice-service-data/2/service"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/billing/invoice-service-data?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/billing/invoice-service-data?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}