Invoices API

get listing

GET /api/rest/customer/v1/invoices

Parameters

Name	Description
filter[id]	id filter
filter[reference-eq]	reference eq filter
filter[reference-not-eq]	reference not eq filter
filter[reference-cont]	reference cont filter
filter[reference-start]	reference start filter
filter[reference-end]	reference end filter
filter[reference-in]	reference in filter
filter[reference-not-in]	reference not in filter
filter[reference-cont-any]	reference cont any filter
filter[start-date-eq]	start date eq filter
filter[start-date-not-eq]	start date not eq filter
filter[start-date-gt]	start date gt filter
filter[start-date-gteq]	start date gteq filter
filter[start-date-lt]	start date lt filter
filter[start-date-lteq]	start date lteq filter
filter[start-date-in]	start date in filter
filter[start-date-not-in]	start date not in filter
filter[end-date-eq]	end date eq filter
filter[end-date-not-eq]	end date not eq filter
filter[end-date-gt]	end date gt filter
filter[end-date-gteq]	end date gteq filter
filter[end-date-lt]	end date lt filter
filter[end-date-lteq]	end date lteq filter
filter[end-date-in]	end date in filter
filter[end-date-not-in]	end date not in filter
filter[amount-spent-eq]	amount spent eq filter
filter[amount-spent-not-eq]	amount spent not eq filter
filter[amount-spent-gt]	amount spent gt filter
filter[amount-spent-gteq]	amount spent gteq filter
filter[amount-spent-lt]	amount spent lt filter
filter[amount-spent-lteq]	amount spent lteq filter
filter[amount-spent-in]	amount spent in filter
filter[amount-spent-not-in]	amount spent not in filter
filter[originated-amount-spent-eq]	originated amount spent eq filter
filter[originated-amount-spent-not-eq]	originated amount spent not eq filter
filter[originated-amount-spent-gt]	originated amount spent gt filter
filter[originated-amount-spent-gteq]	originated amount spent gteq filter
filter[originated-amount-spent-lt]	originated amount spent lt filter
filter[originated-amount-spent-lteq]	originated amount spent lteq filter
filter[originated-amount-spent-in]	originated amount spent in filter
filter[originated-amount-spent-not-in]	originated amount spent not in filter
filter[originated-calls-count-eq]	originated calls count eq filter
filter[originated-calls-count-not-eq]	originated calls count not eq filter
filter[originated-calls-count-gt]	originated calls count gt filter
filter[originated-calls-count-gteq]	originated calls count gteq filter
filter[originated-calls-count-lt]	originated calls count lt filter
filter[originated-calls-count-lteq]	originated calls count lteq filter
filter[originated-calls-count-in]	originated calls count in filter
filter[originated-calls-count-not-in]	originated calls count not in filter
filter[originated-successful-calls-count-eq]	originated successful calls count eq filter
filter[originated-successful-calls-count-not-eq]	originated successful calls count not eq filter
filter[originated-successful-calls-count-gt]	originated successful calls count gt filter
filter[originated-successful-calls-count-gteq]	originated successful calls count gteq filter
filter[originated-successful-calls-count-lt]	originated successful calls count lt filter
filter[originated-successful-calls-count-lteq]	originated successful calls count lteq filter
filter[originated-successful-calls-count-in]	originated successful calls count in filter
filter[originated-successful-calls-count-not-in]	originated successful calls count not in filter
filter[originated-calls-duration-eq]	originated calls duration eq filter
filter[originated-calls-duration-not-eq]	originated calls duration not eq filter
filter[originated-calls-duration-gt]	originated calls duration gt filter
filter[originated-calls-duration-gteq]	originated calls duration gteq filter
filter[originated-calls-duration-lt]	originated calls duration lt filter
filter[originated-calls-duration-lteq]	originated calls duration lteq filter
filter[originated-calls-duration-in]	originated calls duration in filter
filter[originated-calls-duration-not-in]	originated calls duration not in filter
filter[originated-billing-duration-eq]	originated billing duration eq filter
filter[originated-billing-duration-not-eq]	originated billing duration not eq filter
filter[originated-billing-duration-gt]	originated billing duration gt filter
filter[originated-billing-duration-gteq]	originated billing duration gteq filter
filter[originated-billing-duration-lt]	originated billing duration lt filter
filter[originated-billing-duration-lteq]	originated billing duration lteq filter
filter[originated-billing-duration-in]	originated billing duration in filter
filter[originated-billing-duration-not-in]	originated billing duration not in filter
filter[originated-first-call-at-eq]	originated first call at eq filter
filter[originated-first-call-at-not-eq]	originated first call at not eq filter
filter[originated-first-call-at-gt]	originated first call at gt filter
filter[originated-first-call-at-gteq]	originated first call at gteq filter
filter[originated-first-call-at-lt]	originated first call at lt filter
filter[originated-first-call-at-lteq]	originated first call at lteq filter
filter[originated-first-call-at-in]	originated first call at in filter
filter[originated-first-call-at-not-in]	originated first call at not in filter
filter[originated-last-call-at-eq]	originated last call at eq filter
filter[originated-last-call-at-not-eq]	originated last call at not eq filter
filter[originated-last-call-at-gt]	originated last call at gt filter
filter[originated-last-call-at-gteq]	originated last call at gteq filter
filter[originated-last-call-at-lt]	originated last call at lt filter
filter[originated-last-call-at-lteq]	originated last call at lteq filter
filter[originated-last-call-at-in]	originated last call at in filter
filter[originated-last-call-at-not-in]	originated last call at not in filter
filter[terminated-amount-spent-eq]	terminated amount spent eq filter
filter[terminated-amount-spent-not-eq]	terminated amount spent not eq filter
filter[terminated-amount-spent-gt]	terminated amount spent gt filter
filter[terminated-amount-spent-gteq]	terminated amount spent gteq filter
filter[terminated-amount-spent-lt]	terminated amount spent lt filter
filter[terminated-amount-spent-lteq]	terminated amount spent lteq filter
filter[terminated-amount-spent-in]	terminated amount spent in filter
filter[terminated-amount-spent-not-in]	terminated amount spent not in filter
filter[terminated-calls-count-eq]	terminated calls count eq filter
filter[terminated-calls-count-not-eq]	terminated calls count not eq filter
filter[terminated-calls-count-gt]	terminated calls count gt filter
filter[terminated-calls-count-gteq]	terminated calls count gteq filter
filter[terminated-calls-count-lt]	terminated calls count lt filter
filter[terminated-calls-count-lteq]	terminated calls count lteq filter
filter[terminated-calls-count-in]	terminated calls count in filter
filter[terminated-calls-count-not-in]	terminated calls count not in filter
filter[terminated-successful-calls-count-eq]	terminated successful calls count eq filter
filter[terminated-successful-calls-count-not-eq]	terminated successful calls count not eq filter
filter[terminated-successful-calls-count-gt]	terminated successful calls count gt filter
filter[terminated-successful-calls-count-gteq]	terminated successful calls count gteq filter
filter[terminated-successful-calls-count-lt]	terminated successful calls count lt filter
filter[terminated-successful-calls-count-lteq]	terminated successful calls count lteq filter
filter[terminated-successful-calls-count-in]	terminated successful calls count in filter
filter[terminated-successful-calls-count-not-in]	terminated successful calls count not in filter
filter[terminated-calls-duration-eq]	terminated calls duration eq filter
filter[terminated-calls-duration-not-eq]	terminated calls duration not eq filter
filter[terminated-calls-duration-gt]	terminated calls duration gt filter
filter[terminated-calls-duration-gteq]	terminated calls duration gteq filter
filter[terminated-calls-duration-lt]	terminated calls duration lt filter
filter[terminated-calls-duration-lteq]	terminated calls duration lteq filter
filter[terminated-calls-duration-in]	terminated calls duration in filter
filter[terminated-calls-duration-not-in]	terminated calls duration not in filter
filter[terminated-billing-duration-eq]	terminated billing duration eq filter
filter[terminated-billing-duration-not-eq]	terminated billing duration not eq filter
filter[terminated-billing-duration-gt]	terminated billing duration gt filter
filter[terminated-billing-duration-gteq]	terminated billing duration gteq filter
filter[terminated-billing-duration-lt]	terminated billing duration lt filter
filter[terminated-billing-duration-lteq]	terminated billing duration lteq filter
filter[terminated-billing-duration-in]	terminated billing duration in filter
filter[terminated-billing-duration-not-in]	terminated billing duration not in filter
filter[terminated-first-call-at-eq]	terminated first call at eq filter
filter[terminated-first-call-at-not-eq]	terminated first call at not eq filter
filter[terminated-first-call-at-gt]	terminated first call at gt filter
filter[terminated-first-call-at-gteq]	terminated first call at gteq filter
filter[terminated-first-call-at-lt]	terminated first call at lt filter
filter[terminated-first-call-at-lteq]	terminated first call at lteq filter
filter[terminated-first-call-at-in]	terminated first call at in filter
filter[terminated-first-call-at-not-in]	terminated first call at not in filter
filter[terminated-last-call-at-eq]	terminated last call at eq filter
filter[terminated-last-call-at-not-eq]	terminated last call at not eq filter
filter[terminated-last-call-at-gt]	terminated last call at gt filter
filter[terminated-last-call-at-gteq]	terminated last call at gteq filter
filter[terminated-last-call-at-lt]	terminated last call at lt filter
filter[terminated-last-call-at-lteq]	terminated last call at lteq filter
filter[terminated-last-call-at-in]	terminated last call at in filter
filter[terminated-last-call-at-not-in]	terminated last call at not in filter
filter[account-id-eq]	account id eq filter
filter[account-id-not-eq]	account id not eq filter
filter[account-id-in]	account id in filter
filter[account-id-not-in]	account id not in filter

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjI0LCJhdWQiOlsiY3VzdG9tZXItdjEiXSwiZXhwIjoxNzEwMjU0MjAyfQ.6lTpRGITzGpIFOG_EG4XbGyR-eXdK0G878KsJ5MqsgA
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/invoices

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/"3a605aef016f5b05c12a51060aba6814"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 754f18ff-68d6-49c9-8fd9-6a08d0727207
X-Runtime: 0.011974
Content-Length: 2280

Status

200 OK

Body

{
  "data": [
    {
      "id": "cdff9418-e07d-11ee-bc8d-0242ac120003",
      "type": "invoices",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/invoices/cdff9418-e07d-11ee-bc8d-0242ac120003"
      },
      "attributes": {
        "reference": "6",
        "start-date": "2024-03-05T14:35:42.662Z",
        "end-date": "2024-03-11T14:35:42.663Z",
        "has-pdf": false,
        "amount-spent": "0.0",
        "originated-amount-spent": "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-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/customer/v1/invoices/cdff9418-e07d-11ee-bc8d-0242ac120003/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/invoices/cdff9418-e07d-11ee-bc8d-0242ac120003/account"
          }
        }
      }
    },
    {
      "id": "ce034cde-e07d-11ee-bc8d-0242ac120003",
      "type": "invoices",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/invoices/ce034cde-e07d-11ee-bc8d-0242ac120003"
      },
      "attributes": {
        "reference": "7",
        "start-date": "2024-03-05T14:35:42.687Z",
        "end-date": "2024-03-11T14:35:42.687Z",
        "has-pdf": false,
        "amount-spent": "0.0",
        "originated-amount-spent": "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-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/customer/v1/invoices/ce034cde-e07d-11ee-bc8d-0242ac120003/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/invoices/ce034cde-e07d-11ee-bc8d-0242ac120003/account"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/customer/v1/invoices?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/customer/v1/invoices?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}