API Documentation
Document Types ¶
Document Types ¶
Supported filter params
-
subsidiary_id (array)
-
exportable_type_id (array) (1: invoice, 2: deal, 3: budget)
-
status (1: active, 2: archived)
GET /api/v2/document_types
Requests
GET /api/v2/document_types
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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "1",
"type": "document_types",
"attributes": {
"name": "normal invoice",
"tax1_name": "VAT",
"tax1_value": "25.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "5"
}
}
}
}
],
"included": [
{
"id": "5",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary5",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 233
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/document_types?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/document_types?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,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get document_typesGET/api/v2/document_types
GET /api/v2/document_types/1
Requests
GET /api/v2/document_types/2
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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2",
"type": "document_types",
"attributes": {
"name": "normal invoice",
"tax1_name": "VAT",
"tax1_value": "25.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 234
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "6"
}
}
}
},
"included": [
{
"id": "6",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary6",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 234
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Gets a document_typeGET/api/v2/document_types/{id}
URI Parameters
- id
number
(required) Example: 1document type id
POST /api/v2/document_types
Requests
POST /api/v2/document_types
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_types",
"attributes": {
"name": "test name",
"locale": "hr_HR",
"exportable_type_id": 1
},
"relationships": {
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "7"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "4",
"type": "document_types",
"attributes": {
"name": "test name",
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"locale": "hr_HR",
"document_template_id": null,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "7"
}
}
}
},
"included": [
{
"id": "7",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary7",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 235
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/document_types
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_types",
"attributes": {
"name": ""
}
}
}
Responses
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/locale"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/subsidiary"
}
}
]
}
POST /api/v2/document_types
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_types",
"attributes": {
"name": "test name",
"locale": "hr_HR",
"exportable_type_id": 1,
"tax1_value": 2.34567,
"tax2_value": 5.12345
},
"relationships": {
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "10"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "8",
"type": "document_types",
"attributes": {
"name": "test name",
"tax1_name": null,
"tax1_value": "2.35",
"tax2_name": null,
"tax2_value": "5.12",
"locale": "hr_HR",
"document_template_id": null,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "10"
}
}
}
},
"included": [
{
"id": "10",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary10",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 238
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Create a document_typePOST/api/v2/document_types
URI Parameters
- name
string
(required) Example: Namename
- locale
string
(required) Example: en_USlocale
- subsidiary_id
number
(required) Example: 1subsidiary id
PATCH /api/v2/document_types/1
Requests
PATCH /api/v2/document_types/9
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_types",
"attributes": {
"name": "new name"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "9",
"type": "document_types",
"attributes": {
"name": "new name",
"tax1_name": "VAT",
"tax1_value": "25.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "11"
}
}
}
},
"included": [
{
"id": "11",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary11",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 239
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/document_types/10
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_types",
"attributes": {
"tax1_value": 0,
"tax2_value": null
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "10",
"type": "document_types",
"attributes": {
"name": "Standard Document Type",
"tax1_name": "VAT",
"tax1_value": "0.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "12"
}
}
}
},
"included": [
{
"id": "12",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary12",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 240
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/document_types/11
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_types",
"attributes": {
"name": ""
}
}
}
Responses
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_types/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_types",
"attributes": {
"name": "new name"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "13",
"type": "document_types",
"attributes": {
"name": "new name",
"tax1_name": "VAT",
"tax1_value": "5.12345",
"tax2_name": null,
"tax2_value": "2.34567",
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 243
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "15"
}
}
}
},
"included": [
{
"id": "15",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary15",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 243
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/document_types/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_types",
"attributes": {
"name": "new name",
"tax1_value": 3.45678,
"tax2_value": 6.12345
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "14",
"type": "document_types",
"attributes": {
"name": "new name",
"tax1_name": "VAT",
"tax1_value": "3.46",
"tax2_name": null,
"tax2_value": "6.12",
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": null,
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 244
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "16"
}
}
}
},
"included": [
{
"id": "16",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary16",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 244
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Update a document_typePATCH/api/v2/document_types/{id}
URI Parameters
- id
number
(required) Example: 1document type id
PATCH /api/v2/document_types/1/archive
Requests
PATCH /api/v2/document_types/15/archive
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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "15",
"type": "document_types",
"attributes": {
"name": "normal invoice",
"tax1_name": "VAT",
"tax1_value": "25.0",
"tax2_name": null,
"tax2_value": null,
"locale": "en_US",
"document_template_id": 1,
"exportable_type_id": 1,
"note": null,
"footer": null,
"template_options": {},
"archived_at": "2021-01-24T00:03:57.000+01:00",
"header_template": null,
"body_template": null,
"footer_template": null,
"scss_template": null,
"exporter_options": {},
"email_template": null,
"email_subject": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 245
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "17"
}
}
}
},
"included": [
{
"id": "17",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary17",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 245
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Archives a document typePATCH/api/v2/document_types/{id}/archive
URI Parameters
- id
number
(required) Example: 1document type id
Generated by aglio on 23 Jan 2021