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

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEzNywiYXVkIjpbImFkbWluIl0sImV4cCI6MTc4NjM2MDI5M30.FzHHopolbgUe-boWn4CbFNB1kPFtpAPML9gbFfu1ywY
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/"29a362b870dc33cc5d487f4450bdc163"
cache-control: max-age=0, private, must-revalidate
x-request-id: cc054112-cbec-43b6-9776-d87477c00432
x-runtime: 0.006595
content-length: 788

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",
        "html-template": "<html><body>{{ invoice.reference }}</body></html>",
        "filename-template": "invoice-{{invoice.reference}}"
      }
    },
    {
      "id": "4",
      "type": "invoice-templates",
      "links": {
        "self": "http://example.org/api/rest/admin/invoice-templates/4"
      },
      "attributes": {
        "name": "invoice_template2",
        "html-template": "<html><body>{{ invoice.reference }}</body></html>",
        "filename-template": "invoice-{{invoice.reference}}"
      }
    }
  ],
  "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"
  }
}