Contract
========

.. _ContractRoot: 

ContractRoot
------------

The root collection in the data room that contains contract data

.. code-block:: json
   
 message ContractRoot {
  string id = 1;
  string account_id = 2;
  optional string customer_id = 3;
  string account_title = 4;
  string account_name = 5;
  string dataroom_id = 38;
  DataroomType dataroom_type = 6;
  ActivityLogStoragePeriod activity_log_storage_period = 7;
  optional uint32 max_users = 8;
  uint64 max_quantum = 9;
  optional uint32 contract_fees = 10;
  optional uint32 payment_term = 11;
  ContractMonth automatic_renewal = 12;
  bool renewal_only_with_po = 13;
  ContractMonth minimum_duration = 14;
  ContractMonth invoice_period = 15;
  uint32 notice_period = 16;
  optional string vat_id = 17;
  optional string supplier_id = 18;
  string first_name = 19;
  string last_name = 20;
  Language language = 21;
  optional Salutation salutation = 22;
  string email = 23;
  optional string mobile_phone_nr = 24;
  optional string company = 25;
  optional UserAddress address = 26;
  optional google.protobuf.Timestamp contract_start = 27;
  optional google.protobuf.Timestamp contract_end = 28;
  optional google.protobuf.Timestamp contract_paused = 29;
  optional google.protobuf.Timestamp contract_changed = 39;
  optional google.protobuf.Timestamp contract_next_termination_date = 30;
  ItemType item_type = 31;
  string name =32;
  string title = 33;
  optional bool can_increase_users = 34;
  optional google.protobuf.Timestamp gdpr_agreement_date = 35;
  optional bool needs_gpdr_agreement = 36;
  EffectivePermission effective_permission = 37;
  optional uint32 max_datarooms = 40;
  optional uint32 discount = 41;
  optional uint32 markup = 42;
 }

.. list-table::
   :widths: 20 20 60
   :header-rows: 1

   * - Field
     - Type
     - Description
   * - ``id``
     - ``string``
     -
   * - ``account_id``
     - ``string``
     -
   * - ``customer_id``
     - ``string``
     - optional 
   * - ``account_title``
     - ``string``
     -
   * - ``account_name``
     - ``string``
     -
   * - ``dataroom_id``
     - ``string``
     -
   * - ``dataroom_type``
     - ``DataroomType``
     -
   * - ``activity_log_storage_period``
     - ``ActivityLogStoragePeriod``
     -
   * - ``max_users``
     - ``optional uint32``
     -
   * - ``max_quantum``
     - ``uint64``
     -
   * - ``contract_fees``
     - ``uint32``
     - optional 
   * - ``payment_term``
     - ``uint32``
     - optional 
   * - ``automatic_renewal``
     - ``ContractMonth``
     -
   * - ``renewal_only_with_po``
     - ``bool``
     -
   * - ``minimum_duration``
     - ``ContractMonth``
     -
   * - ``invoice_period``
     - ``ContractMonth``
     -
   * - ``notice_period``
     - ``uint32``
     -
   * - ``vat_id``
     - ``string``
     - optional 
   * - ``supplier_id``
     - ``string``
     - optional 
   * - ``first_name``
     - ``string``
     -
   * - ``last_name``
     - ``string``
     -
   * - ``language``
     - ``Language``
     -
   * - ``salutation``
     - ``Salutation``
     - optional 
   * - ``email``
     - ``string``
     -
   * - ``mobile_phone_nr``
     - ``string``
     - optional 
   * - ``company``
     - ``string``
     - optional 

.. _ContractItem: 

ContractItem
------------

Interface for one contract item

.. code-block:: json

 message ContractItem {
  string id = 1;
  string title = 2;
  string dataroom_id = 3;
  google.protobuf.Timestamp modification_date = 6;
  google.protobuf.Timestamp creation_date = 7;
  ItemType item_type = 13;
  EffectivePermission effective_permission = 14;
  string name = 15;
  optional google.protobuf.Timestamp obsolete_date = 16;
  optional bool pdf_variant_exists = 17;
  optional bool pdf_variant_creatable = 18;
  optional string mime_type = 20;
 }

+---------------------------+-------------------------------+-------------+
| Field                     | Type                          | Description |
+===========================+===============================+=============+
| ``id```                   | ``string``                    |             |
+---------------------------+-------------------------------+-------------+
| ``title``                 | ``string``                    |             |
+---------------------------+-------------------------------+-------------+
| ``dataroom_id``           | ``string``                    |             |
+---------------------------+-------------------------------+-------------+
| ``modification_date``     | ``google.protobuf.Timestamp`` |             |
+---------------------------+-------------------------------+-------------+
| ``creation_date``         | ``google.protobuf.Timestamp`` |             |
+---------------------------+-------------------------------+-------------+
| ``item_type``             | ``ItemType``                  |             |
+---------------------------+-------------------------------+-------------+
| ``effective_permission``  | ``EffectivePermission``       |             |
+---------------------------+-------------------------------+-------------+
| ``name``                  | ``string``                    |             |
+---------------------------+-------------------------------+-------------+
| ``obsolete_date``         | ``google.protobuf.Timestamp`` | optional    |
+---------------------------+-------------------------------+-------------+
| ``pdf_variant_exists``    | ``bool``                      | optional    |
+---------------------------+-------------------------------+-------------+
| ``pdf_variant_creatable`` | ``bool``                      | optional    |
+---------------------------+-------------------------------+-------------+
| ``mime_type``             | ``string``                    | optional    |
+---------------------------+-------------------------------+-------------+