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-04-15",
        "sent_on": null,
        "pay_on": "2021-04-25",
        "delivery_on": null,
        "paid_on": null,
        "discount": null,
        "tax1_name": null,
        "tax1_value": null,
        "tax2_name": null,
        "tax2_value": null,
        "deleted_at": null,
        "tag_list": [],
        "note": null,
        "exported_at": null,
        "export_integration_type_id": null,
        "note_interpolated": null,
        "email_key": "5cd0982944b4e9421ff9070c044a353b",
        "purchase_order_number": null,
        "export_invoice_url": null,
        "company_reference_id": null,
        "created_at": "2021-04-15T01:03:56.576+02:00",
        "exchange_rate": "1.25",
        "exchange_date": "2021-04-15",
        "custom_fields": null,
        "updated_at": "2021-04-15T01:03:56.585+02:00",
        "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": 370
          }
        },
        "bill_to": {
          "data": null
        },
        "bill_from": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1162"
          }
        },
        "document_type": {
          "data": null
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "852"
          }
        },
        "subsidiary": {
          "data": null
        },
        "invoice_attributions": {
          "data": [
            {
              "type": "invoice_attributions",
              "id": "15"
            }
          ]
        },
        "attachment": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "1162",
      "type": "companies",
      "attributes": {
        "name": "Client793",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.572+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "852",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user857@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:56.000+02:00",
        "last_seen_at": "2021-04-15T01:03:56.621+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 858,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:56.448+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1156"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "15",
      "type": "invoice_attributions",
      "attributes": {
        "date_from": null,
        "date_to": null,
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "15"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "141"
          }
        }
      }
    },
    {
      "id": "1156",
      "type": "companies",
      "attributes": {
        "name": "Organization370",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:56.447+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "141",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-04-15",
        "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": "d3e69de1020173e6482547c84b427eb6",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": 1,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-04-15T01:03:56.559+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-04-15",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 10000,
        "invoiced_default": 12500,
        "invoiced_normalized": 10000,
        "pending_invoicing": -10000,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -10000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "852"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1157"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "853"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "125"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1157",
      "type": "companies",
      "attributes": {
        "name": "Client788",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.469+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "853",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user858@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:03:56.000+02:00",
        "is_user": true,
        "user_id": 859,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:56.479+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1158"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "125",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-04-15T01:03:56.540+02:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": -12500,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -12500,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1160"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "854"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1158",
      "type": "companies",
      "attributes": {
        "name": "Client789",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.476+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1160",
      "type": "companies",
      "attributes": {
        "name": "Client791",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.537+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "854",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user859@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:03:56.000+02:00",
        "is_user": true,
        "user_id": 860,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:56.512+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1159"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1159",
      "type": "companies",
      "attributes": {
        "name": "Client790",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.508+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 370
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/invoices?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/invoices?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      }
    },
    "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-04-15",
      "sent_on": null,
      "pay_on": "2021-04-25",
      "delivery_on": null,
      "paid_on": null,
      "discount": null,
      "tax1_name": null,
      "tax1_value": null,
      "tax2_name": null,
      "tax2_value": null,
      "deleted_at": null,
      "tag_list": [],
      "note": null,
      "exported_at": null,
      "export_integration_type_id": null,
      "note_interpolated": null,
      "email_key": "4537a19a76f378d02b2833b66fa83ee9",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-04-15T01:03:56.859+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-04-15",
      "custom_fields": null,
      "updated_at": "2021-04-15T01:03:56.868+02:00",
      "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": 371
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1169"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "855"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "16"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1169",
      "type": "companies",
      "attributes": {
        "name": "Client799",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.855+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "855",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user860@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:56.000+02:00",
        "last_seen_at": "2021-04-15T01:03:56.896+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 861,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:56.732+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1163"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "16",
      "type": "invoice_attributions",
      "attributes": {
        "date_from": null,
        "date_to": null,
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "16"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "142"
          }
        }
      }
    },
    {
      "id": "1163",
      "type": "companies",
      "attributes": {
        "name": "Organization371",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:56.731+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "142",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-04-15",
        "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": "37648b3e669519094fb5d574feff17d8",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": 1,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-04-15T01:03:56.841+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-04-15",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 10000,
        "invoiced_default": 12500,
        "invoiced_normalized": 10000,
        "pending_invoicing": -10000,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -10000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "855"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1164"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "856"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "126"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1164",
      "type": "companies",
      "attributes": {
        "name": "Client794",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.754+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "856",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user861@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:03:56.000+02:00",
        "is_user": true,
        "user_id": 862,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:56.763+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1165"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "126",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-04-15T01:03:56.822+02:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": -12500,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -12500,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1167"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "857"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1165",
      "type": "companies",
      "attributes": {
        "name": "Client795",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.760+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1167",
      "type": "companies",
      "attributes": {
        "name": "Client797",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.820+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "857",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user862@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:03:56.000+02:00",
        "is_user": true,
        "user_id": 863,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:56.796+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1166"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1166",
      "type": "companies",
      "attributes": {
        "name": "Client796",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:56.792+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 371
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      }
    },
    "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-04-15",
      "pay_on": "2021-04-25",
      "currency": "EUR"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "1175"
        }
      }
    }
  }
}
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-04-15",
      "sent_on": null,
      "pay_on": "2021-04-25",
      "delivery_on": null,
      "paid_on": null,
      "discount": null,
      "tax1_name": null,
      "tax1_value": null,
      "tax2_name": null,
      "tax2_value": null,
      "deleted_at": null,
      "tag_list": [],
      "note": null,
      "exported_at": null,
      "export_integration_type_id": null,
      "note_interpolated": null,
      "email_key": "b5f91e7a6f49a68a7b09f76bab868c7d",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-04-15T01:03:57.331+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-04-15",
      "custom_fields": null,
      "updated_at": "2021-04-15T01:03:57.331+02:00",
      "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": 372
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1175"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "858"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": []
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1175",
      "type": "companies",
      "attributes": {
        "name": "Client804",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:57.266+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 372
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "858",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user863@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:57.000+02:00",
        "last_seen_at": "2021-04-15T01:03:57.314+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 864,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:57.007+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 372
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1170"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1170",
      "type": "companies",
      "attributes": {
        "name": "Organization372",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:57.006+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 372
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      }
    },
    "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-04-15",
      "pay_on": "2021-04-25",
      "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": "1189"
        }
      }
    }
  }
}
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-04-15",
      "sent_on": null,
      "pay_on": "2021-04-25",
      "delivery_on": null,
      "paid_on": null,
      "discount": "0.56",
      "tax1_name": null,
      "tax1_value": "2.35",
      "tax2_name": null,
      "tax2_value": "5.12",
      "deleted_at": null,
      "tag_list": [],
      "note": null,
      "exported_at": null,
      "export_integration_type_id": null,
      "note_interpolated": null,
      "email_key": "7af2fb5784229a751dbe3fa00cfdc3fe",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-04-15T01:03:58.029+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-04-15",
      "custom_fields": null,
      "updated_at": "2021-04-15T01:03:58.029+02:00",
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "amount": 0,
      "amount_default": 0,
      "amount_normalized": 0,
      "amount_tax": 0,
      "amount_tax_default": 0,
      "amount_tax_normalized": 0,
      "amount_with_tax": 0,
      "amount_with_tax_default": 0,
      "amount_with_tax_normalized": 0,
      "amount_paid": 0,
      "amount_paid_default": 0,
      "amount_paid_normalized": 0,
      "amount_written_off": 0,
      "amount_written_off_default": 0,
      "amount_written_off_normalized": 0,
      "amount_unpaid": 0,
      "amount_unpaid_default": 0,
      "amount_unpaid_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 374
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1189"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "864"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": []
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1189",
      "type": "companies",
      "attributes": {
        "name": "Client816",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:57.967+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 374
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "864",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user869@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:58.000+02:00",
        "last_seen_at": "2021-04-15T01:03:58.016+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 870,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:57.738+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 374
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1184"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1184",
      "type": "companies",
      "attributes": {
        "name": "Organization374",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:57.737+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 374
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      }
    },
    "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-04-15",
      "sent_on": null,
      "pay_on": "2021-04-25",
      "delivery_on": null,
      "paid_on": null,
      "discount": null,
      "tax1_name": null,
      "tax1_value": null,
      "tax2_name": null,
      "tax2_value": null,
      "deleted_at": null,
      "tag_list": [],
      "note": null,
      "exported_at": null,
      "export_integration_type_id": null,
      "note_interpolated": null,
      "email_key": "0fa59e915f1433001ec6c9f815fd5df6",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-04-15T01:03:58.335+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-04-15",
      "custom_fields": null,
      "updated_at": "2021-04-15T01:03:58.393+02:00",
      "currency": "EUR",
      "currency_default": "USD",
      "currency_normalized": "EUR",
      "amount": 0,
      "amount_default": 0,
      "amount_normalized": 0,
      "amount_tax": 0,
      "amount_tax_default": 0,
      "amount_tax_normalized": 0,
      "amount_with_tax": 0,
      "amount_with_tax_default": 0,
      "amount_with_tax_normalized": 0,
      "amount_paid": 0,
      "amount_paid_default": 0,
      "amount_paid_normalized": 0,
      "amount_written_off": 0,
      "amount_written_off_default": 0,
      "amount_written_off_normalized": 0,
      "amount_unpaid": 0,
      "amount_unpaid_default": 0,
      "amount_unpaid_normalized": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 375
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1197"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "867"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "20"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1197",
      "type": "companies",
      "attributes": {
        "name": "Client823",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:58.330+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "867",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user872@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:58.000+02:00",
        "last_seen_at": "2021-04-15T01:03:58.374+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 873,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:58.117+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1191"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "20",
      "type": "invoice_attributions",
      "attributes": {
        "date_from": null,
        "date_to": null,
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "22"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "146"
          }
        }
      }
    },
    {
      "id": "1191",
      "type": "companies",
      "attributes": {
        "name": "Organization375",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:58.116+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "146",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-04-15",
        "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": "55cd185c37c8225e0819af1ab58624fe",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": 1,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-04-15T01:03:58.317+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-04-15",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 10000,
        "invoiced_default": 12500,
        "invoiced_normalized": 10000,
        "pending_invoicing": -10000,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -10000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "867"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1192"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "868"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "130"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1192",
      "type": "companies",
      "attributes": {
        "name": "Client818",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:58.138+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "868",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user873@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:03:58.000+02:00",
        "is_user": true,
        "user_id": 874,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:58.148+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1193"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "130",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-04-15T01:03:58.207+02:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": -12500,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -12500,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1195"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "869"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1193",
      "type": "companies",
      "attributes": {
        "name": "Client819",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:58.144+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1195",
      "type": "companies",
      "attributes": {
        "name": "Client821",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:58.204+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "869",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user874@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:03:58.000+02:00",
        "is_user": true,
        "user_id": 875,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:58.181+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1194"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1194",
      "type": "companies",
      "attributes": {
        "name": "Client820",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:58.177+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 375
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      }
    },
    "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-04-15",
      "sent_on": null,
      "pay_on": "2021-04-25",
      "delivery_on": null,
      "paid_on": null,
      "discount": "0.5555",
      "tax1_name": null,
      "tax1_value": "5.12345",
      "tax2_name": null,
      "tax2_value": "2.34567",
      "deleted_at": null,
      "tag_list": [],
      "note": null,
      "exported_at": null,
      "export_integration_type_id": null,
      "note_interpolated": null,
      "email_key": "1435fd6ea1d1a4b03ddca623312fdfa5",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-04-15T01:03:59.723+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-04-15",
      "custom_fields": null,
      "updated_at": "2021-04-15T01:03:59.803+02:00",
      "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": 379
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1225"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "879"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "24"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1225",
      "type": "companies",
      "attributes": {
        "name": "Client847",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:59.718+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "879",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user884@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:59.000+02:00",
        "last_seen_at": "2021-04-15T01:03:59.784+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 885,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:59.495+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1219"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "24",
      "type": "invoice_attributions",
      "attributes": {
        "date_from": null,
        "date_to": null,
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "26"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "150"
          }
        }
      }
    },
    {
      "id": "1219",
      "type": "companies",
      "attributes": {
        "name": "Organization379",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:59.493+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "150",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-04-15",
        "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": "7534b1ea8c660daea1f3e64ef10ced1d",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": 1,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-04-15T01:03:59.704+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-04-15",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 10000,
        "invoiced_default": 12500,
        "invoiced_normalized": 10000,
        "pending_invoicing": -10000,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -10000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "879"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1220"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "880"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "134"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1220",
      "type": "companies",
      "attributes": {
        "name": "Client842",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:59.517+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "880",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user885@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:03:59.000+02:00",
        "is_user": true,
        "user_id": 886,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:59.526+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1221"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "134",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-04-15T01:03:59.585+02:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": -12500,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -12500,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1223"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "881"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1221",
      "type": "companies",
      "attributes": {
        "name": "Client843",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:59.523+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1223",
      "type": "companies",
      "attributes": {
        "name": "Client845",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:59.583+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "881",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user886@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:03:59.000+02:00",
        "is_user": true,
        "user_id": 887,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:59.558+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1222"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1222",
      "type": "companies",
      "attributes": {
        "name": "Client844",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:59.554+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 379
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      }
    },
    "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-04-15",
      "sent_on": null,
      "pay_on": "2021-04-25",
      "delivery_on": null,
      "paid_on": null,
      "discount": "0.89",
      "tax1_name": null,
      "tax1_value": "3.35",
      "tax2_name": null,
      "tax2_value": "6.12",
      "deleted_at": null,
      "tag_list": [],
      "note": null,
      "exported_at": null,
      "export_integration_type_id": null,
      "note_interpolated": null,
      "email_key": "af5b23bc2c2fff91381c74b4fdd27ab8",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-04-15T01:04:00.194+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-04-15",
      "custom_fields": null,
      "updated_at": "2021-04-15T01:04:00.266+02:00",
      "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": 380
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1232"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "882"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "25"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1232",
      "type": "companies",
      "attributes": {
        "name": "Client853",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:04:00.189+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "882",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user887@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:04:00.000+02:00",
        "last_seen_at": "2021-04-15T01:04:00.248+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 888,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:59.972+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1226"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "25",
      "type": "invoice_attributions",
      "attributes": {
        "date_from": null,
        "date_to": null,
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "27"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "151"
          }
        }
      }
    },
    {
      "id": "1226",
      "type": "companies",
      "attributes": {
        "name": "Organization380",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:59.970+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "151",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-04-15",
        "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": "fd6205f9338805f09f1e3edfa9b30b1d",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": 1,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-04-15T01:04:00.175+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-04-15",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 10000,
        "invoiced_default": 12500,
        "invoiced_normalized": 10000,
        "pending_invoicing": -10000,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -10000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "882"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1227"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "883"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "135"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1227",
      "type": "companies",
      "attributes": {
        "name": "Client848",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:59.993+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "883",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user888@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:04:00.000+02:00",
        "is_user": true,
        "user_id": 889,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:04:00.003+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1228"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "135",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-04-15T01:04:00.062+02:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": -12500,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -12500,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1230"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "884"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1228",
      "type": "companies",
      "attributes": {
        "name": "Client849",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:03:59.999+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1230",
      "type": "companies",
      "attributes": {
        "name": "Client851",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:04:00.059+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "884",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user889@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:04:00.000+02:00",
        "is_user": true,
        "user_id": 890,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:04:00.034+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1229"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1229",
      "type": "companies",
      "attributes": {
        "name": "Client850",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:04:00.031+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 380
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      }
    },
    "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-04-15",
      "sent_on": "2021-04-15",
      "pay_on": "2021-04-25",
      "delivery_on": null,
      "paid_on": null,
      "discount": null,
      "tax1_name": null,
      "tax1_value": null,
      "tax2_name": null,
      "tax2_value": null,
      "deleted_at": null,
      "tag_list": [],
      "note": null,
      "exported_at": null,
      "export_integration_type_id": null,
      "note_interpolated": null,
      "email_key": "cd39e49fa3748a011da75008c47a5376",
      "purchase_order_number": null,
      "export_invoice_url": null,
      "company_reference_id": null,
      "created_at": "2021-04-15T01:04:01.156+02:00",
      "exchange_rate": "1.25",
      "exchange_date": "2021-04-15",
      "custom_fields": null,
      "updated_at": "2021-04-15T01:04:01.350+02:00",
      "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": 382
        }
      },
      "bill_to": {
        "data": null
      },
      "bill_from": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1249"
        }
      },
      "document_type": {
        "data": null
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "891"
        }
      },
      "subsidiary": {
        "data": null
      },
      "invoice_attributions": {
        "data": [
          {
            "type": "invoice_attributions",
            "id": "27"
          }
        ]
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1249",
      "type": "companies",
      "attributes": {
        "name": "Client868",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:04:01.151+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {
          "to": [
            "test@email.com"
          ],
          "cc": [
            "test@productive.io",
            "test-2@productive.io"
          ],
          "bcc": [
            "mail@something.com"
          ]
        },
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "891",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user896@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:04:01.000+02:00",
        "last_seen_at": "2021-04-15T01:04:01.194+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 897,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:04:00.916+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1243"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "27",
      "type": "invoice_attributions",
      "attributes": {
        "date_from": null,
        "date_to": null,
        "amount": 10000,
        "amount_default": 12500,
        "amount_normalized": 10000,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "invoice": {
          "data": {
            "type": "invoices",
            "id": "29"
          }
        },
        "budget": {
          "data": {
            "type": "deals",
            "id": "153"
          }
        }
      }
    },
    {
      "id": "1243",
      "type": "companies",
      "attributes": {
        "name": "Organization382",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:04:00.915+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "153",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2021-04-15",
        "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": "59823621053d6ec682bd24b3d154574f",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "position": 1,
        "budget_revamp": false,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "rejected_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "delivered_on": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2021-04-15T01:04:01.137+02:00",
        "note": null,
        "sales_closed_at": null,
        "exchange_rate": "1.25",
        "exchange_date": "2021-04-15",
        "sales_closed_on": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 10000,
        "invoiced_default": 12500,
        "invoiced_normalized": 10000,
        "pending_invoicing": -10000,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -10000,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "891"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1244"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "892"
          }
        },
        "deal_status": {
          "data": null
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "137"
          }
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        },
        "contact": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1244",
      "type": "companies",
      "attributes": {
        "name": "Client863",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:04:00.937+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "892",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user897@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:04:00.000+02:00",
        "is_user": true,
        "user_id": 898,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:04:00.947+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1245"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "137",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-04-15T01:04:01.007+02:00",
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": -12500,
        "pending_invoicing_default": -12500,
        "pending_invoicing_normalized": -12500,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1247"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "893"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1245",
      "type": "companies",
      "attributes": {
        "name": "Client864",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:04:00.943+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1247",
      "type": "companies",
      "attributes": {
        "name": "Client866",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:04:01.004+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "893",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user898@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2021-04-15T01:04:00.000+02:00",
        "is_user": true,
        "user_id": 899,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:04:00.980+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1246"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1246",
      "type": "companies",
      "attributes": {
        "name": "Client865",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-04-15T01:04:00.976+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 382
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      }
    },
    "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


Generated by aglio on 14 Apr 2021