Invoices API

get specific entry

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

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEzOSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU2N30.aE-WgsMm1OgKRJ3naMuMf00XA0E29sAiAmthu_4bgvg
Host: example.org
Cookie: 

Route

GET /api/rest/admin/invoices/18

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"5d8e19b2b96dde0720b2fe2c29b3b503"
cache-control: max-age=0, private, must-revalidate
x-request-id: 6e9bcc70-61b3-42a4-a16d-118d0936ed5a
x-runtime: 0.008896
content-length: 2164

Status

200 OK

Body

{
  "data": {
    "id": "18",
    "type": "invoices",
    "links": {
      "self": "http://example.org/api/rest/admin/invoices/18"
    },
    "attributes": {
      "reference": "18",
      "state": "Approved",
      "invoice-type": "Auto Full",
      "start-date": "2025-12-26T12:46:07.352Z",
      "end-date": "2026-01-01T12:46:07.352Z",
      "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,
      "services-amount-spent": "0.0",
      "services-amount-earned": "0.0",
      "service-transactions-count": 0
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://example.org/api/rest/admin/invoices/18/relationships/account",
          "related": "http://example.org/api/rest/admin/invoices/18/account"
        },
        "data": {
          "type": "accounts",
          "id": "74"
        }
      },
      "originated-destinations": {
        "links": {
          "self": "http://example.org/api/rest/admin/invoices/18/relationships/originated-destinations",
          "related": "http://example.org/api/rest/admin/invoices/18/originated-destinations"
        }
      },
      "originated-networks": {
        "links": {
          "self": "http://example.org/api/rest/admin/invoices/18/relationships/originated-networks",
          "related": "http://example.org/api/rest/admin/invoices/18/originated-networks"
        }
      },
      "terminated-destinations": {
        "links": {
          "self": "http://example.org/api/rest/admin/invoices/18/relationships/terminated-destinations",
          "related": "http://example.org/api/rest/admin/invoices/18/terminated-destinations"
        }
      },
      "terminated-networks": {
        "links": {
          "self": "http://example.org/api/rest/admin/invoices/18/relationships/terminated-networks",
          "related": "http://example.org/api/rest/admin/invoices/18/terminated-networks"
        }
      },
      "service-data": {
        "links": {
          "self": "http://example.org/api/rest/admin/invoices/18/relationships/service-data",
          "related": "http://example.org/api/rest/admin/invoices/18/service-data"
        }
      }
    }
  }
}