API Documentation

API Endpoint

Document Styles

Document Styles

Supported filter params

  • id (array)

  • name (string)

GET /api/v2/document_styles
Requestsreturns, :aggregate_failures document_stylesreturns error

GET  /api/v2/document_styles

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1",
      "type": "document_styles",
      "attributes": {
        "name": "normal invoice",
        "styles": {
          "header": "test"
        }
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "443"
          }
        },
        "attachments": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/document_styles?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/document_styles?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/document_styles

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "code": "document_templates_unavailable",
      "title": "Access Denied",
      "detail": "Feature document templates unavailable",
      "source": {}
    }
  ]
}

Get document_styles
GET/api/v2/document_styles

GET /api/v2/document_styles/1
Requestsreturns, :aggregate_failures document_stylereturns error

GET  /api/v2/document_styles/4

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4",
    "type": "document_styles",
    "attributes": {
      "name": "normal invoice",
      "styles": {
        "header": "test"
      }
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "446"
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

GET  /api/v2/document_styles/6

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "code": "document_templates_unavailable",
      "title": "Access Denied",
      "detail": "Feature document templates unavailable",
      "source": {}
    }
  ]
}

Gets a document_style
GET/api/v2/document_styles/{id}

URI Parameters
HideShow
id
number (required) Example: 1

document style id

POST /api/v2/document_styles
Requestscreates, :aggregate_failures document_stylereturns errorreturns error

POST  /api/v2/document_styles

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "document_styles",
    "attributes": {
      "name": "test name",
      "styles": {
        "some_key": "some_value"
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "9",
    "type": "document_styles",
    "attributes": {
      "name": "test name",
      "styles": {
        "some_key": "some_value"
      }
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "450"
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/document_styles

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "document_styles",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/styles"
      }
    }
  ]
}

POST  /api/v2/document_styles

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "document_styles",
    "attributes": {
      "name": "test name",
      "styles": {
        "some_key": "some_value"
      }
    }
  }
}
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "title": "Access Denied",
      "detail": "You are not authorized to access this resource",
      "source": {}
    }
  ]
}

Create a document_style
POST/api/v2/document_styles

URI Parameters
HideShow
name
string (required) Example: Name

name

styles
json (required) Example: %7B%7D

styles

PATCH /api/v2/document_styles/1
Requestsupdates, :aggregate_failures document_stylereturns errorreturns error

PATCH  /api/v2/document_styles/13

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "document_styles",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "13",
    "type": "document_styles",
    "attributes": {
      "name": "new name",
      "styles": {
        "header": "test"
      }
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "454"
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/document_styles/14

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "document_styles",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

PATCH  /api/v2/document_styles/15

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "document_styles",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "code": "document_templates_unavailable",
      "title": "Access Denied",
      "detail": "Feature document templates unavailable",
      "source": {}
    }
  ]
}

Update a document_style
PATCH/api/v2/document_styles/{id}

URI Parameters
HideShow
id
number (required) Example: 1

document style id

DELETE /api/v2/document_styles/1
Requestsdestroys, :aggregate_failures document stylereturns error

DELETE  /api/v2/document_styles/16

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

DELETE  /api/v2/document_styles/18

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "title": "Access Denied",
      "detail": "You are not authorized to access this resource",
      "source": {}
    }
  ]
}

Destroys a document style
DELETE/api/v2/document_styles/{id}

URI Parameters
HideShow
id
number (required) Example: 1

document style id

POST /api/v2/document_styles/copy
Requestscreates duplicated document_stylereturns errorreturns error

POST  /api/v2/document_styles/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "document_style",
    "attributes": {
      "template_id": 20
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "21",
    "type": "document_styles",
    "attributes": {
      "name": "[DUPLICATE] normal invoice",
      "styles": {
        "header": "test"
      }
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "461"
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/document_styles/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/template_id"
      }
    }
  ]
}

POST  /api/v2/document_styles/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{}
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "code": "document_styler_unavailable",
      "title": "Access Denied",
      "detail": "Feature document styler unavailable",
      "source": {}
    }
  ]
}

Duplicates a document style
POST/api/v2/document_styles/copy

URI Parameters
HideShow
template_id
number (required) Example: 1

id of the document style to be copied

Generated by aglio on 01 Aug 2025