Invoices API

create new entry

POST /api/rest/admin/billing/invoices

Parameters

Name	Description
data[type]	Resource type (invoices)
data[attributes][start-date]	Start date
data[attributes][end-date]	End date
data[relationships][account]	Account

Request

Headers

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

Route

POST /api/rest/admin/billing/invoices

Body

{"data":{"type":"invoices","attributes":{"start-date":"2024-02-12","end-date":"2024-03-12"},"relationships":{"account":{"data":{"type":"accounts","id":"31"}}}}}

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/"8865ec8a3e708ea1b69d7793e19930b8"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: dfbb5743-f3ed-4be3-9ff4-3c51b92af243
X-Runtime: 0.037838
Content-Length: 1922

Status

201 Created

Body

{
  "data": {
    "id": "4",
    "type": "invoices",
    "links": {
      "self": "http://example.org/api/rest/admin/billing/invoices/4"
    },
    "attributes": {
      "reference": "4",
      "state": "New",
      "invoice-type": "Manual",
      "start-date": "2024-02-12T00:00:00.000Z",
      "end-date": "2024-03-12T00:00:00.000Z",
      "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/4/relationships/account",
          "related": "http://example.org/api/rest/admin/billing/invoices/4/account"
        }
      },
      "originated-destinations": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/4/relationships/originated-destinations",
          "related": "http://example.org/api/rest/admin/billing/invoices/4/originated-destinations"
        }
      },
      "originated-networks": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/4/relationships/originated-networks",
          "related": "http://example.org/api/rest/admin/billing/invoices/4/originated-networks"
        }
      },
      "terminated-destinations": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/4/relationships/terminated-destinations",
          "related": "http://example.org/api/rest/admin/billing/invoices/4/terminated-destinations"
        }
      },
      "terminated-networks": {
        "links": {
          "self": "http://example.org/api/rest/admin/billing/invoices/4/relationships/terminated-networks",
          "related": "http://example.org/api/rest/admin/billing/invoices/4/terminated-networks"
        }
      }
    }
  }
}