API Documentation
Invoices ¶
Invoices ¶
Supported filter params
-
project_id (array)
-
responsible_id (array)
-
company_id (array)
-
status (1: sent, 2: unsent)
-
payment_status (1: paid, 2: unpaid)
-
export_status (1: exported, 2: unexported)
-
tags
-
query
-
subsidiary_id (array)
-
invoiced_on_after
-
invoiced_on_before
-
sent_on_after
-
sent_on_before
-
pay_on_after
-
pay_on_before
Supported sort params
-
number
-
invoiced_on
-
sent_on
-
pay_on
-
delivery_on
-
discount
-
deleted_at
-
purchase_order_number
-
amount
-
amount_tax
-
amount_paid
-
amount_written_off
-
amount_unpaid
Supported aggregates params
-
total_amount
-
total_amount_paid
-
total_amount_written_off
-
total_amount_unpaid
-
total_amount_tax
Filter operations are supported on this endpoint.
GET /api/v2/invoices
Requests
GET /api/v2/invoices
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "15",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "c87b2d630883e82bcbe90da070866298",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:44.109+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:44.127+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1205"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "895"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "15"
}
]
},
"attachment": {
"data": null
}
}
}
],
"included": [
{
"id": "1205",
"type": "companies",
"attributes": {
"name": "Client820",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:44.096+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "895",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user900@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:44.000+02:00",
"last_seen_at": "2021-06-16T01:04:44.186+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 901,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:43.869+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"company": {
"data": {
"type": "companies",
"id": "1199"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "15",
"type": "invoice_attributions",
"attributes": {
"date_from": null,
"date_to": null,
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "15"
}
},
"budget": {
"data": {
"type": "deals",
"id": "141"
}
}
}
},
{
"id": "1199",
"type": "companies",
"attributes": {
"name": "Organization386",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:43.867+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "141",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "6354912850ff50baf440c09dbd715c1b",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:44.068+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 10000,
"invoiced_default": 12500,
"invoiced_normalized": 10000,
"pending_invoicing": -10000,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -10000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"creator": {
"data": {
"type": "people",
"id": "895"
}
},
"company": {
"data": {
"type": "companies",
"id": "1200"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "896"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "125"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1200",
"type": "companies",
"attributes": {
"name": "Client815",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:43.893+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "896",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user901@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:43.000+02:00",
"is_user": true,
"user_id": 902,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:43.904+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"company": {
"data": {
"type": "companies",
"id": "1201"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "125",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:44.019+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -12500,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -12500,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"company": {
"data": {
"type": "companies",
"id": "1203"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "897"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1201",
"type": "companies",
"attributes": {
"name": "Client816",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:43.900+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1203",
"type": "companies",
"attributes": {
"name": "Client818",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:44.013+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "897",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user902@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:43.000+02:00",
"is_user": true,
"user_id": 903,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:43.960+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"company": {
"data": {
"type": "companies",
"id": "1202"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1202",
"type": "companies",
"attributes": {
"name": "Client817",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:43.954+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 386
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/invoices?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/invoices?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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get invoicesGET/api/v2/invoices
GET /api/v2/invoices/1
Requests
GET /api/v2/invoices/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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "16",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "d8326911ec0c5543f5b8ac2896b1ace4",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:44.631+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:44.644+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1212"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "898"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "16"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1212",
"type": "companies",
"attributes": {
"name": "Client826",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:44.623+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "898",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user903@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:44.000+02:00",
"last_seen_at": "2021-06-16T01:04:44.734+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 904,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:44.399+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"company": {
"data": {
"type": "companies",
"id": "1206"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "16",
"type": "invoice_attributions",
"attributes": {
"date_from": null,
"date_to": null,
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "16"
}
},
"budget": {
"data": {
"type": "deals",
"id": "142"
}
}
}
},
{
"id": "1206",
"type": "companies",
"attributes": {
"name": "Organization387",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:44.397+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "142",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "4ac6195b23debd55fe0449943ab57108",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:44.601+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 10000,
"invoiced_default": 12500,
"invoiced_normalized": 10000,
"pending_invoicing": -10000,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -10000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"creator": {
"data": {
"type": "people",
"id": "898"
}
},
"company": {
"data": {
"type": "companies",
"id": "1207"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "899"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "126"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1207",
"type": "companies",
"attributes": {
"name": "Client821",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:44.436+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "899",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user904@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:44.000+02:00",
"is_user": true,
"user_id": 905,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:44.452+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"company": {
"data": {
"type": "companies",
"id": "1208"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "126",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:44.564+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -12500,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -12500,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"company": {
"data": {
"type": "companies",
"id": "1210"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "900"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1208",
"type": "companies",
"attributes": {
"name": "Client822",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:44.446+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1210",
"type": "companies",
"attributes": {
"name": "Client824",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:44.561+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "900",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user905@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:44.000+02:00",
"is_user": true,
"user_id": 906,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:44.513+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"company": {
"data": {
"type": "companies",
"id": "1209"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1209",
"type": "companies",
"attributes": {
"name": "Client823",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:44.506+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 387
}
},
"bill_to": {
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/invoices
Requests
POST /api/v2/invoices
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"number": "2016/20",
"invoiced_on": "2021-06-16",
"pay_on": "2021-06-26",
"currency": "EUR"
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "1218"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "18",
"type": "invoices",
"attributes": {
"number": "2016/20",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "974d9e4bd6195bf94467c7e522bba2ab",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:45.213+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:45.213+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 388
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1218"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "901"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1218",
"type": "companies",
"attributes": {
"name": "Client831",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:45.141+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 388
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "901",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user906@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:45.000+02:00",
"last_seen_at": "2021-06-16T01:04:45.192+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 907,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:44.858+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 388
}
},
"company": {
"data": {
"type": "companies",
"id": "1213"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1213",
"type": "companies",
"attributes": {
"name": "Organization388",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:44.856+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 388
}
},
"bill_to": {
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/invoices
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"invoiced_on": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/currency"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/invoiced_on"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/company"
}
}
]
}POST /api/v2/invoices
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"number": "2016/20",
"invoiced_on": "2021-06-16",
"pay_on": "2021-06-26",
"currency": "EUR",
"discount": 0.5555,
"tax1_value": 2.34567,
"tax2_value": 5.12345
},
"relationships": {
"deal": {
"data": {
"type": "deals",
"id": "145"
}
},
"company": {
"data": {
"type": "companies",
"id": "1232"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "21",
"type": "invoices",
"attributes": {
"number": "2016/20",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": "0.56",
"tax1_name": null,
"tax1_value": "2.35",
"tax2_name": null,
"tax2_value": "5.12",
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "9b9cda14b4d2140e5bcd4f81ab2f7205",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:46.018+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:46.018+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 390
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1232"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "907"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1232",
"type": "companies",
"attributes": {
"name": "Client843",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:45.944+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 390
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "907",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user912@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:45.000+02:00",
"last_seen_at": "2021-06-16T01:04:45.999+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 913,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:45.701+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 390
}
},
"company": {
"data": {
"type": "companies",
"id": "1227"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1227",
"type": "companies",
"attributes": {
"name": "Organization390",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:45.700+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 390
}
},
"bill_to": {
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Create an invoicePOST/api/v2/invoices
URI Parameters
- deal_id
number(required) Example: 1deal id
- invoiced_on
date(required) Example: 2018-01-01invoiced on
PATCH /api/v2/invoices/1
Requests
PATCH /api/v2/invoices/22
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"number": "02/2017"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "22",
"type": "invoices",
"attributes": {
"number": "02/2017",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "cb68eb447d4b499012be01a9413d1a58",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:46.400+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:46.463+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1240"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "910"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "20"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1240",
"type": "companies",
"attributes": {
"name": "Client850",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:46.395+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "910",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user915@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:46.000+02:00",
"last_seen_at": "2021-06-16T01:04:46.443+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 916,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:46.146+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"company": {
"data": {
"type": "companies",
"id": "1234"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "20",
"type": "invoice_attributions",
"attributes": {
"date_from": null,
"date_to": null,
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "22"
}
},
"budget": {
"data": {
"type": "deals",
"id": "146"
}
}
}
},
{
"id": "1234",
"type": "companies",
"attributes": {
"name": "Organization391",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:46.144+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "146",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "5ca2e55daf632c394916101915271895",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:46.382+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 10000,
"invoiced_default": 12500,
"invoiced_normalized": 10000,
"pending_invoicing": -10000,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -10000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"creator": {
"data": {
"type": "people",
"id": "910"
}
},
"company": {
"data": {
"type": "companies",
"id": "1235"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "911"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "130"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1235",
"type": "companies",
"attributes": {
"name": "Client845",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:46.170+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "911",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user916@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:46.000+02:00",
"is_user": true,
"user_id": 917,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:46.181+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"company": {
"data": {
"type": "companies",
"id": "1236"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "130",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:46.244+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -12500,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -12500,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"company": {
"data": {
"type": "companies",
"id": "1238"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "912"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1236",
"type": "companies",
"attributes": {
"name": "Client846",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:46.177+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1238",
"type": "companies",
"attributes": {
"name": "Client848",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:46.241+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "912",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user917@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:46.000+02:00",
"is_user": true,
"user_id": 918,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:46.215+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"company": {
"data": {
"type": "companies",
"id": "1237"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1237",
"type": "companies",
"attributes": {
"name": "Client847",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:46.211+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 391
}
},
"bill_to": {
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/invoices/23
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"invoiced_on": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/invoiced_on"
}
}
]
}PATCH /api/v2/invoices/26
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"number": "02/2017"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "26",
"type": "invoices",
"attributes": {
"number": "02/2017",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": "0.5555",
"tax1_name": null,
"tax1_value": "5.12345",
"tax2_name": null,
"tax2_value": "2.34567",
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "9e32fbbcf6b6f209aa1233519d5a2852",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:47.965+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:48.042+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1268"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "922"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "24"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1268",
"type": "companies",
"attributes": {
"name": "Client874",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:47.960+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "922",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user927@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:48.000+02:00",
"last_seen_at": "2021-06-16T01:04:48.021+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 928,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:47.722+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"company": {
"data": {
"type": "companies",
"id": "1262"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "24",
"type": "invoice_attributions",
"attributes": {
"date_from": null,
"date_to": null,
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "26"
}
},
"budget": {
"data": {
"type": "deals",
"id": "150"
}
}
}
},
{
"id": "1262",
"type": "companies",
"attributes": {
"name": "Organization395",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:47.721+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "150",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "b02b73273031ef76098ca3918879085a",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:47.946+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 10000,
"invoiced_default": 12500,
"invoiced_normalized": 10000,
"pending_invoicing": -10000,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -10000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"creator": {
"data": {
"type": "people",
"id": "922"
}
},
"company": {
"data": {
"type": "companies",
"id": "1263"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "923"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "134"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1263",
"type": "companies",
"attributes": {
"name": "Client869",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:47.745+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "923",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user928@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:47.000+02:00",
"is_user": true,
"user_id": 929,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:47.755+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"company": {
"data": {
"type": "companies",
"id": "1264"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "134",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:47.815+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -12500,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -12500,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"company": {
"data": {
"type": "companies",
"id": "1266"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "924"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1264",
"type": "companies",
"attributes": {
"name": "Client870",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:47.751+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1266",
"type": "companies",
"attributes": {
"name": "Client872",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:47.813+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "924",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user929@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:47.000+02:00",
"is_user": true,
"user_id": 930,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:47.788+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"company": {
"data": {
"type": "companies",
"id": "1265"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1265",
"type": "companies",
"attributes": {
"name": "Client871",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:47.784+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 395
}
},
"bill_to": {
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/invoices/27
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"number": "02/2017",
"discount": 0.8888,
"tax1_value": 3.34567,
"tax2_value": 6.12345
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "27",
"type": "invoices",
"attributes": {
"number": "02/2017",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": "0.89",
"tax1_name": null,
"tax1_value": "3.35",
"tax2_name": null,
"tax2_value": "6.12",
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "bef0247084e1de50344e0681f9ba1225",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:48.501+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:48.575+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1275"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "925"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "25"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1275",
"type": "companies",
"attributes": {
"name": "Client880",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:48.496+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "925",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user930@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:48.000+02:00",
"last_seen_at": "2021-06-16T01:04:48.555+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 931,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:48.250+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"company": {
"data": {
"type": "companies",
"id": "1269"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "25",
"type": "invoice_attributions",
"attributes": {
"date_from": null,
"date_to": null,
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "27"
}
},
"budget": {
"data": {
"type": "deals",
"id": "151"
}
}
}
},
{
"id": "1269",
"type": "companies",
"attributes": {
"name": "Organization396",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:48.249+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "151",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "2f1f4da5dd0edc92e0e3fe0a09a4de2b",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:48.482+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 10000,
"invoiced_default": 12500,
"invoiced_normalized": 10000,
"pending_invoicing": -10000,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -10000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"creator": {
"data": {
"type": "people",
"id": "925"
}
},
"company": {
"data": {
"type": "companies",
"id": "1270"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "926"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "135"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1270",
"type": "companies",
"attributes": {
"name": "Client875",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:48.272+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "926",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user931@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:48.000+02:00",
"is_user": true,
"user_id": 932,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:48.282+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"company": {
"data": {
"type": "companies",
"id": "1271"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "135",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:48.348+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -12500,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -12500,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"company": {
"data": {
"type": "companies",
"id": "1273"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "927"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1271",
"type": "companies",
"attributes": {
"name": "Client876",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:48.278+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1273",
"type": "companies",
"attributes": {
"name": "Client878",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:48.346+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "927",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user932@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:48.000+02:00",
"is_user": true,
"user_id": 933,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:48.315+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"company": {
"data": {
"type": "companies",
"id": "1272"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1272",
"type": "companies",
"attributes": {
"name": "Client877",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:48.311+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 396
}
},
"bill_to": {
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}DELETE /api/v2/invoices/1
Requests
DELETE /api/v2/invoices/28
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+jsonResponses
This response has no content.
PATCH /api/v2/invoices/1/send
Requests
PATCH /api/v2/invoices/29/send
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"to": [
"test@email.com"
],
"cc": [
"test@productive.io",
"test-2@productive.io"
],
"bcc": [
"mail@something.com"
],
"subject": "Mail title",
"body": "Lorem ipsum dolor si amet"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "29",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": "2021-06-16",
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "0aba5482fbc41573777feb0bad5ab870",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:49.560+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:49.771+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1292"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "934"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "27"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1292",
"type": "companies",
"attributes": {
"name": "Client895",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:49.556+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {
"to": [
"test@email.com"
],
"cc": [
"test@productive.io",
"test-2@productive.io"
],
"bcc": [
"mail@something.com"
]
},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "934",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user939@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:49.000+02:00",
"last_seen_at": "2021-06-16T01:04:49.601+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 940,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:49.282+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"company": {
"data": {
"type": "companies",
"id": "1286"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "27",
"type": "invoice_attributions",
"attributes": {
"date_from": null,
"date_to": null,
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "29"
}
},
"budget": {
"data": {
"type": "deals",
"id": "153"
}
}
}
},
{
"id": "1286",
"type": "companies",
"attributes": {
"name": "Organization398",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:49.281+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "153",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "1f7fccdedfae899cae4d2483afd3f22c",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:49.543+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 10000,
"invoiced_default": 12500,
"invoiced_normalized": 10000,
"pending_invoicing": -10000,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -10000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"creator": {
"data": {
"type": "people",
"id": "934"
}
},
"company": {
"data": {
"type": "companies",
"id": "1287"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "935"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "137"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1287",
"type": "companies",
"attributes": {
"name": "Client890",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:49.305+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "935",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user940@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:49.000+02:00",
"is_user": true,
"user_id": 941,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:49.315+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"company": {
"data": {
"type": "companies",
"id": "1288"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "137",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:49.382+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -12500,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -12500,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"company": {
"data": {
"type": "companies",
"id": "1290"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "936"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1288",
"type": "companies",
"attributes": {
"name": "Client891",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:49.311+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1290",
"type": "companies",
"attributes": {
"name": "Client893",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:49.379+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "936",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user941@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:49.000+02:00",
"is_user": true,
"user_id": 942,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:49.353+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"company": {
"data": {
"type": "companies",
"id": "1289"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1289",
"type": "companies",
"attributes": {
"name": "Client892",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:49.348+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 398
}
},
"bill_to": {
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/invoices/34/send
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+jsonBody
{
"data": {
"type": "invoices",
"attributes": {
"to": "invalid mail"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "invalid mail is not an email",
"source": {
"pointer": "data/attributes/to"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/subject"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/body"
}
}
]
}Sends an invoicePATCH/api/v2/invoices/{id}/send
URI Parameters
- id
number(required) Example: 1invoice id
Generated by aglio on 15 Jun 2021