Invoice template API

get listing

GET /api/rest/admin/invoice-template

Parameters

Name Description
filter[id] id filter
filter[name-eq] name eq filter
filter[name-not-eq] name not eq filter
filter[name-cont] name cont filter
filter[name-start] name start filter
filter[name-end] name end filter
filter[name-in] name in filter
filter[name-not-in] name not in filter
filter[name-cont-any] name cont any filter
filter[filename-eq] filename eq filter
filter[filename-not-eq] filename not eq filter
filter[filename-cont] filename cont filter
filter[filename-start] filename start filter
filter[filename-end] filename end filter
filter[filename-in] filename in filter
filter[filename-not-in] filename not in filter
filter[filename-cont-any] filename cont any filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEyOSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU2Nn0.gTjdIgga8DRsdkrCf1TGNJtz-sr12KzD5asmJtmS7Mg
Host: example.org
Cookie: 

Route

GET /api/rest/admin/invoice-template

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/"8e1ac1fcd38dcb720fc20707bc986791"
cache-control: max-age=0, private, must-revalidate
x-request-id: 5b976049-0fcd-4989-8968-c8ec71a5cf78
x-runtime: 0.006385
content-length: 600

Status

200 OK

Body

{
  "data": [
    {
      "id": "3",
      "type": "invoice-templates",
      "links": {
        "self": "http://example.org/api/rest/admin/invoice-templates/3"
      },
      "attributes": {
        "name": "invoice_template1",
        "filename": "filename.odt"
      }
    },
    {
      "id": "4",
      "type": "invoice-templates",
      "links": {
        "self": "http://example.org/api/rest/admin/invoice-templates/4"
      },
      "attributes": {
        "name": "invoice_template2",
        "filename": "filename.odt"
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/invoice-templates?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/invoice-templates?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}