Invoices API

get specific entry

GET /api/rest/admin/billing/invoices/:id

Request

Headers

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

Route

GET /api/rest/admin/billing/invoices/3

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/"3f839f31619f61fbd8203d4318d3987a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: f453d123-cc32-4336-8bbf-c2b2e3e8e4b5
X-Runtime: 0.012853
Content-Length: 1930

Status

200 OK

Body

{
  "data": {
    "id": "3",
    "type": "invoices",
    "links": {
      "self": "http://example.org/api/rest/admin/billing/invoices/3"
    },
    "attributes": {
      "reference": "3",
      "state": "Approved",
      "invoice-type": "Auto Full",
      "start-date": "2024-03-05T14:35:25.627Z",
      "end-date": "2024-03-11T14:35:25.627Z",
      "pdf-path": null,
      "odt-path": null,
      "amount-spent": "0.0",
      "amount-earned": "0.0",
      "originated-amount-spent": "0.0",
      "originated-amount-earned": "0.0",
      "originated-calls-count": 0,
      "originated-successful-calls-count": 0,
      "originated-calls-duration": 0,
      "originated-billing-duration": 0,
      "originated-first-call-at": null,
      "originated-last-call-at": null,
      "terminated-amount-spent": "0.0",
      "terminated-amount-earned": "0.0",
      "terminated-calls-count": 0,
      "terminated-successful-calls-count": 0,
      "terminated-calls-duration": 0,
      "terminated-billing-duration": 0,
      "terminated-first-call-at": null,
      "terminated-last-call-at": null
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/3/relationships/account",
          "related": "http://example.org/api/rest/admin/billing/invoices/3/account"
        }
      },
      "originated-destinations": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/3/relationships/originated-destinations",
          "related": "http://example.org/api/rest/admin/billing/invoices/3/originated-destinations"
        }
      },
      "originated-networks": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/3/relationships/originated-networks",
          "related": "http://example.org/api/rest/admin/billing/invoices/3/originated-networks"
        }
      },
      "terminated-destinations": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/3/relationships/terminated-destinations",
          "related": "http://example.org/api/rest/admin/billing/invoices/3/terminated-destinations"
        }
      },
      "terminated-networks": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/3/relationships/terminated-networks",
          "related": "http://example.org/api/rest/admin/billing/invoices/3/terminated-networks"
        }
      }
    }
  }
}