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": "2020-10-21",
"sent_on": null,
"pay_on": "2020-10-31",
"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": "5109e10e4ce56a5c23d4f4fd9706d5fa",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-10-21T01:04:38.159+02:00",
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"custom_fields": 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": 356
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1037"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "764"
}
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "15"
}
]
},
"attachment": {
"data": null
}
}
}
],
"included": [
{
"id": "1037",
"type": "companies",
"attributes": {
"name": "Client682",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.154+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "764",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user769@email.com",
"title": null,
"joined_at": "2020-10-21T01:04:38.000+02:00",
"last_seen_at": "2020-10-21T01:04:38.210+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:38.050+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"company": {
"data": {
"type": "companies",
"id": "1031"
}
},
"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": 356
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "15"
}
},
"budget": {
"data": {
"type": "deals",
"id": "104"
}
}
}
},
{
"id": "1031",
"type": "companies",
"attributes": {
"name": "Organization356",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-10-21T01:04:38.049+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "104",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-10-21",
"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": "42a8f80e32ce7ddd31fbd1955f53bf76",
"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,
"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": "2020-10-21T01:04:38.141+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"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": 356
}
},
"creator": {
"data": {
"type": "people",
"id": "764"
}
},
"company": {
"data": {
"type": "companies",
"id": "1032"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "765"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "125"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1032",
"type": "companies",
"attributes": {
"name": "Client677",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.065+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "765",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user770@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:38.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:38.075+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"company": {
"data": {
"type": "companies",
"id": "1033"
}
},
"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,
"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,
"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": 356
}
},
"company": {
"data": {
"type": "companies",
"id": "1035"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "766"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1033",
"type": "companies",
"attributes": {
"name": "Client678",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.071+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1035",
"type": "companies",
"attributes": {
"name": "Client680",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.120+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "766",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user771@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:38.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:38.102+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"company": {
"data": {
"type": "companies",
"id": "1034"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1034",
"type": "companies",
"attributes": {
"name": "Client679",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.098+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 356
}
},
"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": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
}
}
}
}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": "2020-10-21",
"sent_on": null,
"pay_on": "2020-10-31",
"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": "384bbb1d4ac88cdcddc1029d18536f5a",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-10-21T01:04:38.430+02:00",
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"custom_fields": 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": 357
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1044"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "767"
}
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "16"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1044",
"type": "companies",
"attributes": {
"name": "Client688",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.426+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "767",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user772@email.com",
"title": null,
"joined_at": "2020-10-21T01:04:38.000+02:00",
"last_seen_at": "2020-10-21T01:04:38.467+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:38.324+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"company": {
"data": {
"type": "companies",
"id": "1038"
}
},
"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": 357
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "16"
}
},
"budget": {
"data": {
"type": "deals",
"id": "105"
}
}
}
},
{
"id": "1038",
"type": "companies",
"attributes": {
"name": "Organization357",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-10-21T01:04:38.323+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "105",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-10-21",
"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": "7a7176f31e023169c485fa5336f61a9f",
"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,
"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": "2020-10-21T01:04:38.414+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"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": 357
}
},
"creator": {
"data": {
"type": "people",
"id": "767"
}
},
"company": {
"data": {
"type": "companies",
"id": "1039"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "768"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "126"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1039",
"type": "companies",
"attributes": {
"name": "Client683",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.339+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "768",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user773@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:38.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:38.348+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"company": {
"data": {
"type": "companies",
"id": "1040"
}
},
"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,
"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,
"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": 357
}
},
"company": {
"data": {
"type": "companies",
"id": "1042"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "769"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1040",
"type": "companies",
"attributes": {
"name": "Client684",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.345+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1042",
"type": "companies",
"attributes": {
"name": "Client686",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.392+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "769",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user774@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:38.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:38.374+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"company": {
"data": {
"type": "companies",
"id": "1041"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1041",
"type": "companies",
"attributes": {
"name": "Client685",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.370+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 357
}
},
"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": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
}
}
}
}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": "2020-10-21",
"pay_on": "2020-10-31",
"currency": "EUR"
},
"relationships": {
"deal": {
"data": {
"type": "deals",
"id": "106"
}
},
"company": {
"data": {
"type": "companies",
"id": "1050"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "18",
"type": "invoices",
"attributes": {
"number": "2016/20",
"subject": null,
"invoiced_on": "2020-10-21",
"sent_on": null,
"pay_on": "2020-10-31",
"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": "d404e2d97e0066989e1b186ea27a832e",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-10-21T01:04:38.734+02:00",
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"custom_fields": 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": 358
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1050"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "770"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1050",
"type": "companies",
"attributes": {
"name": "Client693",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:38.673+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 358
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "770",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user775@email.com",
"title": null,
"joined_at": "2020-10-21T01:04:38.000+02:00",
"last_seen_at": "2020-10-21T01:04:38.716+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:38.576+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 358
}
},
"company": {
"data": {
"type": "companies",
"id": "1045"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1045",
"type": "companies",
"attributes": {
"name": "Organization358",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-10-21T01:04:38.575+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 358
}
},
"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": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
}
}
}
}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": "2020-10-21",
"pay_on": "2020-10-31",
"currency": "EUR",
"discount": 0.5555,
"tax1_value": 2.34567,
"tax2_value": 5.12345
},
"relationships": {
"deal": {
"data": {
"type": "deals",
"id": "108"
}
},
"company": {
"data": {
"type": "companies",
"id": "1064"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "21",
"type": "invoices",
"attributes": {
"number": "2016/20",
"subject": null,
"invoiced_on": "2020-10-21",
"sent_on": null,
"pay_on": "2020-10-31",
"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": "c15aa56efa98e213ab1f81fce98f9a26",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-10-21T01:04:39.148+02:00",
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"custom_fields": 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": 360
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1064"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "776"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1064",
"type": "companies",
"attributes": {
"name": "Client705",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:39.086+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 360
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "776",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user781@email.com",
"title": null,
"joined_at": "2020-10-21T01:04:39.000+02:00",
"last_seen_at": "2020-10-21T01:04:39.134+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:38.984+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 360
}
},
"company": {
"data": {
"type": "companies",
"id": "1059"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1059",
"type": "companies",
"attributes": {
"name": "Organization360",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-10-21T01:04:38.982+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 360
}
},
"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": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
}
}
}
}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": "2020-10-21",
"sent_on": null,
"pay_on": "2020-10-31",
"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": "6b082cf7e838748c779428647b516e5a",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-10-21T01:04:39.330+02:00",
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"custom_fields": 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": 361
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1072"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "779"
}
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "20"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1072",
"type": "companies",
"attributes": {
"name": "Client712",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:39.326+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "779",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user784@email.com",
"title": null,
"joined_at": "2020-10-21T01:04:39.000+02:00",
"last_seen_at": "2020-10-21T01:04:39.367+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:39.218+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"company": {
"data": {
"type": "companies",
"id": "1066"
}
},
"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": 361
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "22"
}
},
"budget": {
"data": {
"type": "deals",
"id": "109"
}
}
}
},
{
"id": "1066",
"type": "companies",
"attributes": {
"name": "Organization361",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-10-21T01:04:39.217+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "109",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-10-21",
"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": "517de18ebfe3c1059b2fa247d8708ac3",
"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,
"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": "2020-10-21T01:04:39.314+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"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": 361
}
},
"creator": {
"data": {
"type": "people",
"id": "779"
}
},
"company": {
"data": {
"type": "companies",
"id": "1067"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "780"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "130"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1067",
"type": "companies",
"attributes": {
"name": "Client707",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:39.233+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "780",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user785@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:39.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:39.243+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"company": {
"data": {
"type": "companies",
"id": "1068"
}
},
"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,
"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,
"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": 361
}
},
"company": {
"data": {
"type": "companies",
"id": "1070"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "781"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1068",
"type": "companies",
"attributes": {
"name": "Client708",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:39.239+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1070",
"type": "companies",
"attributes": {
"name": "Client710",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:39.291+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "781",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user786@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:39.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:39.273+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"company": {
"data": {
"type": "companies",
"id": "1069"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1069",
"type": "companies",
"attributes": {
"name": "Client709",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:39.269+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 361
}
},
"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": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
}
}
}
}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": "2020-10-21",
"sent_on": null,
"pay_on": "2020-10-31",
"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": "e867b5e24eb6f34e2b81d42c08446123",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-10-21T01:04:40.176+02:00",
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"custom_fields": 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": 365
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1100"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "791"
}
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "24"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1100",
"type": "companies",
"attributes": {
"name": "Client736",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.171+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "791",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user796@email.com",
"title": null,
"joined_at": "2020-10-21T01:04:40.000+02:00",
"last_seen_at": "2020-10-21T01:04:40.226+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:40.068+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"company": {
"data": {
"type": "companies",
"id": "1094"
}
},
"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": 365
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "26"
}
},
"budget": {
"data": {
"type": "deals",
"id": "113"
}
}
}
},
{
"id": "1094",
"type": "companies",
"attributes": {
"name": "Organization365",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-10-21T01:04:40.067+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "113",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-10-21",
"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": "4060bc8a50052028abdb09828ddd50b6",
"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,
"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": "2020-10-21T01:04:40.160+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"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": 365
}
},
"creator": {
"data": {
"type": "people",
"id": "791"
}
},
"company": {
"data": {
"type": "companies",
"id": "1095"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "792"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "134"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1095",
"type": "companies",
"attributes": {
"name": "Client731",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.083+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "792",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user797@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:40.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:40.093+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"company": {
"data": {
"type": "companies",
"id": "1096"
}
},
"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,
"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,
"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": 365
}
},
"company": {
"data": {
"type": "companies",
"id": "1098"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "793"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1096",
"type": "companies",
"attributes": {
"name": "Client732",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.089+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1098",
"type": "companies",
"attributes": {
"name": "Client734",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.135+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "793",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user798@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:40.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:40.117+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"company": {
"data": {
"type": "companies",
"id": "1097"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1097",
"type": "companies",
"attributes": {
"name": "Client733",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.113+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 365
}
},
"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": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
}
}
}
}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": "2020-10-21",
"sent_on": null,
"pay_on": "2020-10-31",
"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": "7f60d7f7eb7e1031a11872be703abf1f",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-10-21T01:04:40.469+02:00",
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"custom_fields": 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": 366
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1107"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "794"
}
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "25"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1107",
"type": "companies",
"attributes": {
"name": "Client742",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.464+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "794",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user799@email.com",
"title": null,
"joined_at": "2020-10-21T01:04:40.000+02:00",
"last_seen_at": "2020-10-21T01:04:40.521+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:40.359+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"company": {
"data": {
"type": "companies",
"id": "1101"
}
},
"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": 366
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "27"
}
},
"budget": {
"data": {
"type": "deals",
"id": "114"
}
}
}
},
{
"id": "1101",
"type": "companies",
"attributes": {
"name": "Organization366",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-10-21T01:04:40.357+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "114",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-10-21",
"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": "48cd25c4def39de932d9ec5a185a958e",
"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,
"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": "2020-10-21T01:04:40.451+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"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": 366
}
},
"creator": {
"data": {
"type": "people",
"id": "794"
}
},
"company": {
"data": {
"type": "companies",
"id": "1102"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "795"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "135"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1102",
"type": "companies",
"attributes": {
"name": "Client737",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.374+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "795",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user800@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:40.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:40.384+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"company": {
"data": {
"type": "companies",
"id": "1103"
}
},
"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,
"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,
"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": 366
}
},
"company": {
"data": {
"type": "companies",
"id": "1105"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "796"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1103",
"type": "companies",
"attributes": {
"name": "Client738",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.381+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1105",
"type": "companies",
"attributes": {
"name": "Client740",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.429+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "796",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user801@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:40.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:40.410+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"company": {
"data": {
"type": "companies",
"id": "1104"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1104",
"type": "companies",
"attributes": {
"name": "Client739",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:40.407+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 366
}
},
"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": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
}
}
}
}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": "2020-10-21",
"sent_on": "2020-10-21",
"pay_on": "2020-10-31",
"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": "2678fcf48d117aeea3751516e81a27b5",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2020-10-21T01:04:41.125+02:00",
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"custom_fields": 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": 368
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1124"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "803"
}
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "27"
}
]
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "1124",
"type": "companies",
"attributes": {
"name": "Client757",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:41.120+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": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "803",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user808@email.com",
"title": null,
"joined_at": "2020-10-21T01:04:41.000+02:00",
"last_seen_at": "2020-10-21T01:04:41.165+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:41.016+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"company": {
"data": {
"type": "companies",
"id": "1118"
}
},
"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": 368
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "29"
}
},
"budget": {
"data": {
"type": "deals",
"id": "116"
}
}
}
},
{
"id": "1118",
"type": "companies",
"attributes": {
"name": "Organization368",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2020-10-21T01:04:41.014+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "116",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2020-10-21",
"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": "f01029abe12664cc78c9892100e0978a",
"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,
"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": "2020-10-21T01:04:41.108+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2020-10-21",
"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": 368
}
},
"creator": {
"data": {
"type": "people",
"id": "803"
}
},
"company": {
"data": {
"type": "companies",
"id": "1119"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "804"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "137"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
}
}
},
{
"id": "1119",
"type": "companies",
"attributes": {
"name": "Client752",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:41.031+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "804",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user809@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:41.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:41.041+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"company": {
"data": {
"type": "companies",
"id": "1120"
}
},
"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,
"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,
"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": 368
}
},
"company": {
"data": {
"type": "companies",
"id": "1122"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "805"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1120",
"type": "companies",
"attributes": {
"name": "Client753",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:41.037+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1122",
"type": "companies",
"attributes": {
"name": "Client755",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:41.086+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "805",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user810@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2020-10-21T01:04:41.000+02:00",
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2020-10-21T01:04:41.067+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"company": {
"data": {
"type": "companies",
"id": "1121"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1121",
"type": "companies",
"attributes": {
"name": "Client754",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2020-10-21T01:04:41.063+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 368
}
},
"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": 30,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
}
}
}
}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 20 Oct 2020