API Documentation
Invoice Attributions ¶
GET /api/v2/invoice_attributions
Requests
GET /api/v2/invoice_attributions
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": "1",
"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": 374
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "2"
}
},
"budget": {
"data": {
"type": "deals",
"id": "129"
}
}
}
},
{
"id": "2",
"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": 374
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "2"
}
},
"budget": {
"data": {
"type": "deals",
"id": "129"
}
}
}
}
],
"included": [
{
"id": "2",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "0584e5884c3668e986ea7a1d268ee989",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:40.319+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:40.359+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1137"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "857"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "1"
},
{
"type": "invoice_attributions",
"id": "2"
}
]
},
"attachment": {
"data": null
}
}
},
{
"id": "129",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "ca33c32d20d3e9bc307520a53c952764",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:40.307+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 20000,
"invoiced_default": 25000,
"invoiced_normalized": 20000,
"pending_invoicing": -20000,
"pending_invoicing_default": -25000,
"pending_invoicing_normalized": -20000,
"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": 374
}
},
"creator": {
"data": {
"type": "people",
"id": "857"
}
},
"company": {
"data": {
"type": "companies",
"id": "1137"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "858"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "113"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1137",
"type": "companies",
"attributes": {
"name": "Client764",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.207+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "857",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user862@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:40.000+02:00",
"last_seen_at": "2021-06-16T01:04:40.392+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 863,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.186+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"company": {
"data": {
"type": "companies",
"id": "1136"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "858",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user863@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:40.000+02:00",
"is_user": true,
"user_id": 864,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.218+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"company": {
"data": {
"type": "companies",
"id": "1138"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "113",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:40.285+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -25000,
"pending_invoicing_default": -25000,
"pending_invoicing_normalized": -25000,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"company": {
"data": {
"type": "companies",
"id": "1140"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "859"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1136",
"type": "companies",
"attributes": {
"name": "Organization374",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:40.185+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1138",
"type": "companies",
"attributes": {
"name": "Client765",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.214+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1140",
"type": "companies",
"attributes": {
"name": "Client767",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.282+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "859",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user864@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:40.000+02:00",
"is_user": true,
"user_id": 865,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.256+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"company": {
"data": {
"type": "companies",
"id": "1139"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1139",
"type": "companies",
"attributes": {
"name": "Client766",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.248+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 374
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/invoice_attributions?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/invoice_attributions?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 2,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get invoice attributionsGET/api/v2/invoice_attributions
GET /api/v2/invoice_attributions/1
Requests
GET /api/v2/invoice_attributions/3
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": "3",
"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": 375
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "3"
}
},
"budget": {
"data": {
"type": "deals",
"id": "130"
}
}
}
},
"included": [
{
"id": "3",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "0bf51849b8daabfe06d6ed31770e5bbb",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:40.658+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:40.666+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1142"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "860"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "3"
}
]
},
"attachment": {
"data": null
}
}
},
{
"id": "130",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "51b32bd9d499953d22b3c6124cda8eed",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:40.645+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 10000,
"invoiced_default": 12500,
"invoiced_normalized": 10000,
"pending_invoicing": -10000,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -10000,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0,
"expense_billable": 0,
"expense_billable_default": 0,
"expense_billable_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"actual_rate": 0,
"actual_rate_default": 0,
"actual_rate_normalized": 0,
"budget_remaining": 0,
"budget_remaining_default": 0,
"budget_remaining_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"future_revenue": 0,
"future_revenue_default": 0,
"future_revenue_normalized": 0,
"future_budget_used": 0,
"future_budget_used_default": 0,
"future_budget_used_normalized": 0,
"future_cost": 0,
"future_cost_default": 0,
"future_cost_normalized": 0,
"forecasted_revenue": 0,
"forecasted_revenue_default": 0,
"forecasted_revenue_normalized": 0,
"forecasted_cost": 0,
"forecasted_cost_default": 0,
"forecasted_cost_normalized": 0,
"forecasted_profit": 0,
"forecasted_profit_default": 0,
"forecasted_profit_normalized": 0,
"forecasted_budget_used": 0,
"forecasted_budget_used_default": 0,
"forecasted_budget_used_normalized": 0,
"invoiced_rate": 0,
"invoiced_rate_default": 0,
"invoiced_rate_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"creator": {
"data": {
"type": "people",
"id": "860"
}
},
"company": {
"data": {
"type": "companies",
"id": "1142"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "861"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "114"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1142",
"type": "companies",
"attributes": {
"name": "Client768",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.548+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "860",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user865@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:40.000+02:00",
"last_seen_at": "2021-06-16T01:04:40.697+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 866,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.525+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"company": {
"data": {
"type": "companies",
"id": "1141"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "861",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user866@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:40.000+02:00",
"is_user": true,
"user_id": 867,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.559+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"company": {
"data": {
"type": "companies",
"id": "1143"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "114",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:40.622+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -12500,
"pending_invoicing_default": -12500,
"pending_invoicing_normalized": -12500,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"company": {
"data": {
"type": "companies",
"id": "1145"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "862"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1141",
"type": "companies",
"attributes": {
"name": "Organization375",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:40.523+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1143",
"type": "companies",
"attributes": {
"name": "Client769",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.555+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1145",
"type": "companies",
"attributes": {
"name": "Client771",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.619+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "862",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user867@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:40.000+02:00",
"is_user": true,
"user_id": 868,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.593+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"company": {
"data": {
"type": "companies",
"id": "1144"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1144",
"type": "companies",
"attributes": {
"name": "Client770",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.589+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 375
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Gets an invoice attributionGET/api/v2/invoice_attributions/{id}
URI Parameters
- id
number(required) Example: 1invoice attribution id
POST /api/v2/invoice_attributions
Requests
POST /api/v2/invoice_attributions
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": "invoice_attributions",
"attributes": {
"amount": 2000
},
"relationships": {
"invoice": {
"data": {
"type": "invoices",
"id": "4"
}
},
"budget": {
"data": {
"type": "deals",
"id": "131"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "5",
"type": "invoice_attributions",
"attributes": {
"date_from": null,
"date_to": null,
"amount": 2000,
"amount_default": 2500,
"amount_normalized": 2000,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "4"
}
},
"budget": {
"data": {
"type": "deals",
"id": "131"
}
}
}
},
"included": [
{
"id": "4",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "04962c60bd8f73383a8808c1339d58d5",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:40.990+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:41.041+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1147"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "863"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "4"
},
{
"type": "invoice_attributions",
"id": "5"
}
]
},
"attachment": {
"data": null
}
}
},
{
"id": "131",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "c451b507fbb75812f927fbdb8eccee10",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:40.977+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 12000,
"invoiced_default": 15000,
"invoiced_normalized": 12000,
"pending_invoicing": -12000,
"pending_invoicing_default": -15000,
"pending_invoicing_normalized": -12000,
"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": 376
}
},
"creator": {
"data": {
"type": "people",
"id": "863"
}
},
"company": {
"data": {
"type": "companies",
"id": "1147"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "864"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "115"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1147",
"type": "companies",
"attributes": {
"name": "Client772",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.878+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "863",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user868@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:41.000+02:00",
"last_seen_at": "2021-06-16T01:04:41.029+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 869,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.855+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"company": {
"data": {
"type": "companies",
"id": "1146"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "4",
"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": 376
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "4"
}
},
"budget": {
"data": {
"type": "deals",
"id": "131"
}
}
}
},
{
"id": "864",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user869@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:40.000+02:00",
"is_user": true,
"user_id": 870,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.893+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"company": {
"data": {
"type": "companies",
"id": "1148"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "115",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:40.955+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -15000,
"pending_invoicing_default": -15000,
"pending_invoicing_normalized": -15000,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"company": {
"data": {
"type": "companies",
"id": "1150"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "865"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1146",
"type": "companies",
"attributes": {
"name": "Organization376",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:40.854+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1148",
"type": "companies",
"attributes": {
"name": "Client773",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.887+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1150",
"type": "companies",
"attributes": {
"name": "Client775",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.953+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "865",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user870@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:40.000+02:00",
"is_user": true,
"user_id": 871,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:40.927+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"company": {
"data": {
"type": "companies",
"id": "1149"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1149",
"type": "companies",
"attributes": {
"name": "Client774",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:40.924+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 376
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/invoice_attributions
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": "invoice_attributions",
"attributes": {
"amount": ""
},
"relationships": {
"invoice": {
"data": {
"type": "invoices",
"id": "7"
}
},
"budget": {
"data": {
"type": "deals",
"id": "134"
}
}
}
}
}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/amount"
}
}
]
}Create an invoice attributionPOST/api/v2/invoice_attributions
URI Parameters
- invoice_id
number(required) Example: 1invoice id
- deal_id
number(required) Example: 1deal id
- amount
number(required) Example: 100amount
PATCH /api/v2/invoice_attributions/1
Requests
PATCH /api/v2/invoice_attributions/10
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "invoice_attributions",
"attributes": {
"amount": 5000
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "10",
"type": "invoice_attributions",
"attributes": {
"date_from": null,
"date_to": null,
"amount": 5000,
"amount_default": 6250,
"amount_normalized": 5000,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "10"
}
},
"budget": {
"data": {
"type": "deals",
"id": "136"
}
}
}
},
"included": [
{
"id": "10",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-06-16",
"sent_on": null,
"pay_on": "2021-06-26",
"delivery_on": null,
"paid_on": null,
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "2f83b13f5a2b6b9f8c640b4615fd5c25",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-06-16T01:04:42.717+02:00",
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"custom_fields": null,
"updated_at": "2021-06-16T01:04:42.770+02:00",
"sample_data": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 0,
"amount_paid_default": 0,
"amount_paid_normalized": 0,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": 0,
"amount_unpaid_default": 0,
"amount_unpaid_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1175"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "880"
}
},
"subsidiary": {
"data": null
},
"invoice_attributions": {
"data": [
{
"type": "invoice_attributions",
"id": "10"
}
]
},
"attachment": {
"data": null
}
}
},
{
"id": "136",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2021-06-16",
"end_date": null,
"number": 1,
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": true,
"sales_status_id": null,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"discount": null,
"email_key": "394073723b9fad692c3781dc7c8ad796",
"purchase_order_number": null,
"custom_fields": null,
"forecasted_billable_time": 0,
"forecasted_margin": 0,
"forecasted_budget_usage": 0,
"forecasted_time_usage": 0,
"budget_usage": 0,
"position": 1,
"global_position": 0,
"budget_revamp": false,
"future_booked_time": 0,
"probability": 50,
"budget_warning": null,
"billable_time": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_remaining_time": 0,
"unapproved_time": 0,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": null,
"deleted_at": null,
"created_at": "2021-06-16T01:04:42.704+02:00",
"note": null,
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2021-06-16",
"sales_closed_on": null,
"sample_data": null,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"work_cost": 0,
"work_cost_default": 0,
"work_cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 5000,
"invoiced_default": 6250,
"invoiced_normalized": 5000,
"pending_invoicing": -5000,
"pending_invoicing_default": -6250,
"pending_invoicing_normalized": -5000,
"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": 381
}
},
"creator": {
"data": {
"type": "people",
"id": "880"
}
},
"company": {
"data": {
"type": "companies",
"id": "1175"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "881"
}
},
"deal_status": {
"data": null
},
"project": {
"data": {
"type": "projects",
"id": "120"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1175",
"type": "companies",
"attributes": {
"name": "Client795",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:42.602+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "880",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user885@email.com",
"title": null,
"joined_at": "2021-06-16T01:04:42.000+02:00",
"last_seen_at": "2021-06-16T01:04:42.760+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 886,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:42.580+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"company": {
"data": {
"type": "companies",
"id": "1174"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "881",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user886@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:42.000+02:00",
"is_user": true,
"user_id": 887,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:42.614+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"company": {
"data": {
"type": "companies",
"id": "1176"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "120",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-06-16T01:04:42.681+02:00",
"board_count": 0,
"budget_count": 1,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": -6250,
"pending_invoicing_default": -6250,
"pending_invoicing_normalized": -6250,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"company": {
"data": {
"type": "companies",
"id": "1178"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "882"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1174",
"type": "companies",
"attributes": {
"name": "Organization381",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:04:42.579+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1176",
"type": "companies",
"attributes": {
"name": "Client796",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:42.610+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1178",
"type": "companies",
"attributes": {
"name": "Client798",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:42.678+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "882",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user887@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"invited_at": "2021-06-16T01:04:42.000+02:00",
"is_user": true,
"user_id": 888,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:04:42.650+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"company": {
"data": {
"type": "companies",
"id": "1177"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1177",
"type": "companies",
"attributes": {
"name": "Client797",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:04:42.646+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 381
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/invoice_attributions/11
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "invoice_attributions",
"attributes": {
"amount": ""
}
}
}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/amount"
}
}
]
}Update an invoice attributionPATCH/api/v2/invoice_attributions/{id}
URI Parameters
- id
number(required) Example: 1invoice attribution id
DELETE /api/v2/invoice_attributions/1
Requests
DELETE /api/v2/invoice_attributions/14
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
This response has no content.
Deletes an invoice attributionDELETE/api/v2/invoice_attributions/{id}
URI Parameters
- id
number(required) Example: 1invoice attribution id
Generated by aglio on 15 Jun 2021