API Documentation

API Endpoint

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
Requestsreturns invoices

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "15",
      "type": "invoices",
      "attributes": {
        "number": "2016/01",
        "subject": null,
        "invoiced_on": "2021-09-21",
        "sent_on": null,
        "pay_on": "2021-10-01",
        "delivery_on": null,
        "paid_on": null,
        "finalized_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": "56a40cfe197466b93bd0af2870925237",
        "purchase_order_number": null,
        "export_invoice_url": null,
        "company_reference_id": null,
        "created_at": "2021-09-21T01:05:06.198+02:00",
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "custom_fields": null,
        "updated_at": "2021-09-21T01:05:06.208+02:00",
        "sample_data": false,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "amount": 0,
        "amount_default": 0,
        "amount_normalized": 0,
        "amount_tax": 0,
        "amount_tax_default": 0,
        "amount_tax_normalized": 0,
        "amount_with_tax": 0,
        "amount_with_tax_default": 0,
        "amount_with_tax_normalized": 0,
        "amount_paid": 0,
        "amount_paid_default": 0,
        "amount_paid_normalized": 0,
        "amount_written_off": 0,
        "amount_written_off_default": 0,
        "amount_written_off_normalized": 0,
        "amount_unpaid": 0,
        "amount_unpaid_default": 0,
        "amount_unpaid_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        },
        "bill_to": {
          "data": null
        },
        "bill_from": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1219"
          }
        },
        "document_type": {
          "data": null
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "909"
          }
        },
        "subsidiary": {
          "data": null
        },
        "invoice_attributions": {
          "data": [
            {
              "type": "invoice_attributions",
              "id": "15"
            }
          ]
        },
        "attachment": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "1219",
      "type": "companies",
      "attributes": {
        "name": "Client822",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.193+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        }
      }
    },
    {
      "id": "909",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user914@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:06.000+02:00",
        "last_seen_at": "2021-09-21T01:05:06.234+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 915,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:06.053+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1213"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "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": 398
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "15"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "141"
          }
        }
      }
    },
    {
      "id": "1213",
      "type": "companies",
      "attributes": {
        "name": "Organization398",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:06.051+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        }
      }
    },
    {
      "id": "141",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-09-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": "9d624da8be7b2313949a05e595ce78b0",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-09-21T01:05:06.181+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "909"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1214"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "910"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "125"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1214",
      "type": "companies",
      "attributes": {
        "name": "Client817",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.078+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        }
      }
    },
    {
      "id": "910",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user915@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:06.000+02:00",
        "is_user": true,
        "user_id": 916,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:06.089+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1215"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "125",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-09-21T01:05:06.158+02:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1217"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "911"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1215",
      "type": "companies",
      "attributes": {
        "name": "Client818",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.085+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        }
      }
    },
    {
      "id": "1217",
      "type": "companies",
      "attributes": {
        "name": "Client820",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.155+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        }
      }
    },
    {
      "id": "911",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user916@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:06.000+02:00",
        "is_user": true,
        "user_id": 917,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:06.127+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1216"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1216",
      "type": "companies",
      "attributes": {
        "name": "Client819",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.122+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 398
          }
        }
      }
    }
  ],
  "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
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get invoices
GET/api/v2/invoices


GET /api/v2/invoices/1
Requestsreturns invoice

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "16",
    "type": "invoices",
    "attributes": {
      "number": "2016/01",
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": null,
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_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": "ef99f2c3eff479dc4fa11c77523bfa7b",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:06.490+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:06.498+02:00",
      "sample_data": false,
      "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": 399
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1226"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "912"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "16"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1226",
      "type": "companies",
      "attributes": {
        "name": "Client828",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.485+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        }
      }
    },
    {
      "id": "912",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user917@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:06.000+02:00",
        "last_seen_at": "2021-09-21T01:05:06.518+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 918,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:06.334+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1220"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "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": 399
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "16"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "142"
          }
        }
      }
    },
    {
      "id": "1220",
      "type": "companies",
      "attributes": {
        "name": "Organization399",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:06.333+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        }
      }
    },
    {
      "id": "142",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-09-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": "211d76313dfd35f5ba02e5c7dd20ebee",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-09-21T01:05:06.474+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "912"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1221"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "913"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "126"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1221",
      "type": "companies",
      "attributes": {
        "name": "Client823",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.358+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        }
      }
    },
    {
      "id": "913",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user918@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:06.000+02:00",
        "is_user": true,
        "user_id": 919,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:06.369+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1222"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "126",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-09-21T01:05:06.453+02:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1224"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "914"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1222",
      "type": "companies",
      "attributes": {
        "name": "Client824",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.365+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        }
      }
    },
    {
      "id": "1224",
      "type": "companies",
      "attributes": {
        "name": "Client826",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.451+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        }
      }
    },
    {
      "id": "914",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user919@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:06.000+02:00",
        "is_user": true,
        "user_id": 920,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:06.423+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1223"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1223",
      "type": "companies",
      "attributes": {
        "name": "Client825",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.418+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 399
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Gets an invoice
GET/api/v2/invoices/{id}

URI Parameters
HideShow
id
number (required) Example: 1

invoice id


POST /api/v2/invoices
Requestscreates invoicereturns errorcreates invoice

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+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "number": "2016/20",
      "invoiced_on": "2021-09-21",
      "pay_on": "2021-10-01",
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "1232"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "18",
    "type": "invoices",
    "attributes": {
      "number": "2016/20",
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": null,
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_on": "2021-09-21",
      "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": "ba936c5c769bab4d79bfcf7a0b93b6bd",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:06.915+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:06.915+02:00",
      "sample_data": false,
      "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": 400
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1232"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "915"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": []
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1232",
      "type": "companies",
      "attributes": {
        "name": "Client833",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:06.858+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 400
          }
        }
      }
    },
    {
      "id": "915",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user920@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:06.000+02:00",
        "last_seen_at": "2021-09-21T01:05:06.897+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 921,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:06.607+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 400
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1227"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1227",
      "type": "companies",
      "attributes": {
        "name": "Organization400",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:06.606+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 400
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/invoices

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "invoiced_on": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/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+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "number": "2016/20",
      "invoiced_on": "2021-09-21",
      "pay_on": "2021-10-01",
      "currency": "EUR",
      "discount": 0.5555,
      "tax1_value": 2.34567,
      "tax2_value": 5.12345
    },
    "relationships": {
      "deal": {
        "data": {
          "type": "deals",
          "id": "145"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1246"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "21",
    "type": "invoices",
    "attributes": {
      "number": "2016/20",
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": null,
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_on": "2021-09-21",
      "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": "1e571d04c3d98c31fcf348effa002836",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:07.633+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:07.633+02:00",
      "sample_data": false,
      "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": 402
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1246"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "921"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": []
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1246",
      "type": "companies",
      "attributes": {
        "name": "Client845",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:07.560+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 402
          }
        }
      }
    },
    {
      "id": "921",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user926@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:07.000+02:00",
        "last_seen_at": "2021-09-21T01:05:07.618+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 927,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:07.292+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 402
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1241"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1241",
      "type": "companies",
      "attributes": {
        "name": "Organization402",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:07.290+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 402
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Create an invoice
POST/api/v2/invoices

URI Parameters
HideShow
deal_id
number (required) Example: 1

deal id

invoiced_on
date (required) Example: 2018-01-01

invoiced on


PATCH /api/v2/invoices/1
Requestsupdates invoicereturns errorupdates invoiceupdates invoice

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+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "number": "02/2017"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "22",
    "type": "invoices",
    "attributes": {
      "number": "02/2017",
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": null,
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_on": "2021-09-21",
      "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": "fcfa9958b96e26558c0e7061daabd8a2",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:07.948+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:07.995+02:00",
      "sample_data": false,
      "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": 403
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1254"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "924"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "20"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1254",
      "type": "companies",
      "attributes": {
        "name": "Client852",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:07.944+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        }
      }
    },
    {
      "id": "924",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user929@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:07.000+02:00",
        "last_seen_at": "2021-09-21T01:05:07.977+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 930,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:07.723+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1248"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "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": 403
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "22"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "146"
          }
        }
      }
    },
    {
      "id": "1248",
      "type": "companies",
      "attributes": {
        "name": "Organization403",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:07.722+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        }
      }
    },
    {
      "id": "146",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-09-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": "0862e629707b6d55844bfbc9e178ed5f",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-09-21T01:05:07.933+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "924"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1249"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "925"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "130"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1249",
      "type": "companies",
      "attributes": {
        "name": "Client847",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:07.750+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        }
      }
    },
    {
      "id": "925",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user930@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:07.000+02:00",
        "is_user": true,
        "user_id": 931,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:07.759+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1250"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "130",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-09-21T01:05:07.818+02:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1252"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "926"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1250",
      "type": "companies",
      "attributes": {
        "name": "Client848",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:07.755+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        }
      }
    },
    {
      "id": "1252",
      "type": "companies",
      "attributes": {
        "name": "Client850",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:07.816+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        }
      }
    },
    {
      "id": "926",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user931@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:07.000+02:00",
        "is_user": true,
        "user_id": 932,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:07.791+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1251"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1251",
      "type": "companies",
      "attributes": {
        "name": "Client849",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:07.787+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 403
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/invoices/23

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "invoiced_on": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/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+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "number": "02/2017"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "26",
    "type": "invoices",
    "attributes": {
      "number": "02/2017",
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": null,
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_on": "2021-09-21",
      "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": "5c3615cf26ed2bdfec94c5cac34b15a8",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:09.324+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:09.384+02:00",
      "sample_data": false,
      "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": 407
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1282"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "936"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "24"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1282",
      "type": "companies",
      "attributes": {
        "name": "Client876",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.320+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        }
      }
    },
    {
      "id": "936",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user941@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:09.000+02:00",
        "last_seen_at": "2021-09-21T01:05:09.366+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 942,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:09.104+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1276"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "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": 407
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "26"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "150"
          }
        }
      }
    },
    {
      "id": "1276",
      "type": "companies",
      "attributes": {
        "name": "Organization407",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:09.102+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        }
      }
    },
    {
      "id": "150",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-09-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": "595727aa55affa61885026b057a0bfdf",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-09-21T01:05:09.309+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "936"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1277"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "937"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "134"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1277",
      "type": "companies",
      "attributes": {
        "name": "Client871",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.126+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        }
      }
    },
    {
      "id": "937",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user942@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:09.000+02:00",
        "is_user": true,
        "user_id": 943,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:09.136+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1278"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "134",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-09-21T01:05:09.193+02:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1280"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "938"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1278",
      "type": "companies",
      "attributes": {
        "name": "Client872",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.132+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        }
      }
    },
    {
      "id": "1280",
      "type": "companies",
      "attributes": {
        "name": "Client874",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.191+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        }
      }
    },
    {
      "id": "938",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user943@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:09.000+02:00",
        "is_user": true,
        "user_id": 944,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:09.167+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1279"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1279",
      "type": "companies",
      "attributes": {
        "name": "Client873",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.164+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 407
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/invoices/27

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "number": "02/2017",
      "discount": 0.8888,
      "tax1_value": 3.34567,
      "tax2_value": 6.12345
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "27",
    "type": "invoices",
    "attributes": {
      "number": "02/2017",
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": null,
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_on": "2021-09-21",
      "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": "65699bd43e834dae12c27879577759c2",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:09.742+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:09.810+02:00",
      "sample_data": false,
      "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": 408
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1289"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "939"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "25"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1289",
      "type": "companies",
      "attributes": {
        "name": "Client882",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.737+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        }
      }
    },
    {
      "id": "939",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user944@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:09.000+02:00",
        "last_seen_at": "2021-09-21T01:05:09.791+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 945,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:09.513+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1283"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "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": 408
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "27"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "151"
          }
        }
      }
    },
    {
      "id": "1283",
      "type": "companies",
      "attributes": {
        "name": "Organization408",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:09.512+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        }
      }
    },
    {
      "id": "151",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-09-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": "acd1717636caabb6f69c842855682621",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-09-21T01:05:09.725+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "939"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1284"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "940"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "135"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1284",
      "type": "companies",
      "attributes": {
        "name": "Client877",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.535+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        }
      }
    },
    {
      "id": "940",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user945@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:09.000+02:00",
        "is_user": true,
        "user_id": 946,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:09.544+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1285"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "135",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-09-21T01:05:09.605+02:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1287"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "941"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1285",
      "type": "companies",
      "attributes": {
        "name": "Client878",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.540+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        }
      }
    },
    {
      "id": "1287",
      "type": "companies",
      "attributes": {
        "name": "Client880",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.603+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        }
      }
    },
    {
      "id": "941",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user946@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:09.000+02:00",
        "is_user": true,
        "user_id": 947,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:09.577+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1286"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1286",
      "type": "companies",
      "attributes": {
        "name": "Client879",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:09.574+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 408
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Update an invoice
PATCH/api/v2/invoices/{id}

URI Parameters
HideShow
id
number (required) Example: 1

invoice id


DELETE /api/v2/invoices/1
Requestsarchives invoice and deletes comments

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+json
Responses204
This response has no content.

Deletes an invoice
DELETE/api/v2/invoices/{id}

URI Parameters
HideShow
id
number (required) Example: 1

invoice id


PATCH /api/v2/invoices/1/send
Requestssends invoice via mailreturns error

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+json
Body
{
  "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"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "29",
    "type": "invoices",
    "attributes": {
      "number": "2016/01",
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": "2021-09-21",
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_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": "49c9c8e8c57ffde48c103cfc8b052de7",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:10.701+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:10.884+02:00",
      "sample_data": false,
      "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": 410
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1306"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "948"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "27"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1306",
      "type": "companies",
      "attributes": {
        "name": "Client897",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:10.697+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {
          "to": [
            "test@email.com"
          ],
          "cc": [
            "test@productive.io",
            "test-2@productive.io"
          ],
          "bcc": [
            "mail@something.com"
          ]
        },
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        }
      }
    },
    {
      "id": "948",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user953@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:10.000+02:00",
        "last_seen_at": "2021-09-21T01:05:10.732+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 954,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:10.465+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1300"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "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": 410
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "29"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "153"
          }
        }
      }
    },
    {
      "id": "1300",
      "type": "companies",
      "attributes": {
        "name": "Organization410",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:10.463+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        }
      }
    },
    {
      "id": "153",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-09-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": "0b7d8b8f9f0f6fb8c9b8dc0cbc54d6ff",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-09-21T01:05:10.682+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "948"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1301"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "949"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "137"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1301",
      "type": "companies",
      "attributes": {
        "name": "Client892",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:10.489+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        }
      }
    },
    {
      "id": "949",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user954@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:10.000+02:00",
        "is_user": true,
        "user_id": 955,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:10.499+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1302"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "137",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-09-21T01:05:10.562+02:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1304"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "950"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1302",
      "type": "companies",
      "attributes": {
        "name": "Client893",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:10.495+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        }
      }
    },
    {
      "id": "1304",
      "type": "companies",
      "attributes": {
        "name": "Client895",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:10.559+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        }
      }
    },
    {
      "id": "950",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user955@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:10.000+02:00",
        "is_user": true,
        "user_id": 956,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:10.533+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1303"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1303",
      "type": "companies",
      "attributes": {
        "name": "Client894",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:10.529+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 410
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/invoices/34/send

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "to": "invalid mail"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "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 invoice
PATCH/api/v2/invoices/{id}/send

URI Parameters
HideShow
id
number (required) Example: 1

invoice id


PATCH /api/v2/invoices/1/finalize
Requestsfinalizes invoicefinalizes invoice

PATCH  /api/v2/invoices/40/finalize

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {
      "number": "05/2021"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "40",
    "type": "invoices",
    "attributes": {
      "number": "05/2021",
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": null,
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_on": "2021-09-21",
      "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": "050364f3d093c19575d1e4aa617a7370",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:14.456+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:14.509+02:00",
      "sample_data": false,
      "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": 419
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1375"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1000"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "50"
        }
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "36"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1375",
      "type": "companies",
      "attributes": {
        "name": "Client957",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.452+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        }
      }
    },
    {
      "id": "1000",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user985@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:14.000+02:00",
        "last_seen_at": "2021-09-21T01:05:14.497+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 986,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:14.225+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1369"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "50",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary50",
        "invoice_number_format": null,
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    },
    {
      "id": "36",
      "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": 419
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "40"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "162"
          }
        }
      }
    },
    {
      "id": "1369",
      "type": "companies",
      "attributes": {
        "name": "Organization419",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:14.223+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        }
      }
    },
    {
      "id": "162",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-09-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": "1c09cd74c9a485ba24cb5f433769c294",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-09-21T01:05:14.440+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1000"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1370"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1001"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "147"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1370",
      "type": "companies",
      "attributes": {
        "name": "Client952",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.247+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        }
      }
    },
    {
      "id": "1001",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user986@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:14.000+02:00",
        "is_user": true,
        "user_id": 987,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:14.257+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1371"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "147",
      "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-09-21T01:05:14.315+02:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1373"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1002"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1371",
      "type": "companies",
      "attributes": {
        "name": "Client953",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.253+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        }
      }
    },
    {
      "id": "1373",
      "type": "companies",
      "attributes": {
        "name": "Client955",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.312+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        }
      }
    },
    {
      "id": "1002",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user987@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:14.000+02:00",
        "is_user": true,
        "user_id": 988,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:14.288+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1372"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1372",
      "type": "companies",
      "attributes": {
        "name": "Client954",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.285+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 419
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/invoices/41/finalize

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invoices",
    "attributes": {}
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "41",
    "type": "invoices",
    "attributes": {
      "number": null,
      "subject": null,
      "invoiced_on": "2021-09-21",
      "sent_on": null,
      "pay_on": "2021-10-01",
      "delivery_on": null,
      "paid_on": null,
      "finalized_on": "2021-09-21",
      "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": "64e3970693e6f18827fcaece6628a98e",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-09-21T01:05:14.925+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-09-21",
      "custom_fields": null,
      "updated_at": "2021-09-21T01:05:14.985+02:00",
      "sample_data": false,
      "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": 420
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1382"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "1003"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "51"
        }
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "37"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1382",
      "type": "companies",
      "attributes": {
        "name": "Client963",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.920+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        }
      }
    },
    {
      "id": "1003",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user988@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:14.000+02:00",
        "last_seen_at": "2021-09-21T01:05:14.973+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 989,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:14.651+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1376"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "51",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary51",
        "invoice_number_format": "{sequence_id}-{company_code}-{n}",
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    },
    {
      "id": "37",
      "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": 420
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "41"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "163"
          }
        }
      }
    },
    {
      "id": "1376",
      "type": "companies",
      "attributes": {
        "name": "Organization420",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:14.650+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        }
      }
    },
    {
      "id": "163",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-09-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": "8142f37c45522da22a88ceea7e20108a",
        "purchase_order_number": null,
        "custom_fields": null,
        "position": null,
        "global_position": 0,
        "budget_revamp": false,
        "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,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-09-21T01:05:14.906+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-09-21",
        "sales_closed_on": null,
        "sample_data": false,
        "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,
        "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,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "1003"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1377"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "1004"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "148"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1377",
      "type": "companies",
      "attributes": {
        "name": "Client958",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.674+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        }
      }
    },
    {
      "id": "1004",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user989@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:14.000+02:00",
        "is_user": true,
        "user_id": 990,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:14.683+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1378"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "148",
      "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-09-21T01:05:14.750+02:00",
        "budget_closing_date": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1380"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1005"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1378",
      "type": "companies",
      "attributes": {
        "name": "Client959",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.680+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        }
      }
    },
    {
      "id": "1380",
      "type": "companies",
      "attributes": {
        "name": "Client961",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.747+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        }
      }
    },
    {
      "id": "1005",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user990@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:14.000+02:00",
        "is_user": true,
        "user_id": 991,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:14.720+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1379"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1379",
      "type": "companies",
      "attributes": {
        "name": "Client960",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:14.716+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 420
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Finalizes an invoice
PATCH/api/v2/invoices/{id}/finalize

URI Parameters
HideShow
id
number (required) Example: 1

invoice id


Generated by aglio on 20 Sep 2021