# Об’єкт XDoc

 **Опис параметрів об’єкта**

<table class="colwidths-given docutils align-default" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%A4%D0%BE%D1%80%D0%BC%D0%B0%D1%82-%D0%9E%D0%BF%D0%B8%D1%81" style="width: 100%;"><colgroup><col style="width: 14.0644%;"></col><col style="width: 19.5465%;"></col><col style="width: 66.3891%;"></col></colgroup><thead><tr class="row-odd"><th class="head">Параметр

</th><th class="head">Формат

</th><th class="head">Опис

</th></tr></thead><tbody><tr class="row-odd"><td>body

</td><td>[XDocBodyForms](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdocbodyforms)

</td><td>об’єкт; тіла документів

</td></tr><tr class="row-even"><td>attachments

</td><td>List&lt;[XDocAttachment](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdocattachment)&gt;

</td><td>масив об’єктів; вкладення (може не використовуватися)

</td></tr><tr class="row-odd"><td>comments

</td><td>[XDocCommentsList](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdoccommentslist)

</td><td>об’єкт (в якому масив об’єктів); список коментарів

</td></tr><tr class="row-even"><td>doc\_id

</td><td>long

</td><td>id документа

</td></tr><tr class="row-odd"><td>doc\_uuid

</td><td>UUID

</td><td>унікальний ідентифікатор документа/квитанції

</td></tr><tr class="row-even"><td>uuidSender

</td><td>String

</td><td>унікальний ідентифікатор відправника

</td></tr><tr class="row-odd"><td>uuidReceiver

</td><td>String

</td><td>унікальний ідентифікатор одержувача

</td></tr><tr class="row-even"><td>docNumber

</td><td>String

</td><td>номер документа

</td></tr><tr class="row-odd"><td>dateCreated

</td><td>long

</td><td>дата створення документа (unix timestamp); після відправки: дата відправки/отримання документа

</td></tr><tr class="row-even"><td>dateChanged

</td><td>long

</td><td>дата останньої зміни документа (unix timestamp)

</td></tr><tr class="row-odd"><td>dateRead

</td><td>long

</td><td>дата прочитання документа (unix timestamp)

</td></tr><tr class="row-even"><td>docDate

</td><td>long

</td><td>дата документа, зазначена в документі

</td></tr><tr class="row-odd"><td>chain\_id

</td><td>long

</td><td>id ланцюжка документів

</td></tr><tr class="row-even"><td>chain\_uuid

</td><td>UUID

</td><td>унікальний ідентифікатор ланцюжка документів

</td></tr><tr class="row-odd"><td>family

</td><td>int

</td><td>сімейство

- 1 - EDI
- 2 - UZD
- 4 - CERTIFICATS
- 6 - ATS
- 7 - ETTN
- 8 - DISTRIBUTION
- 9 - SIMPLEDOC (Вільний)
- 10 - TENDER
- 11 - AGREEMENT
- 12 - OPENPRICE (Є-Товар)

</td></tr><tr class="row-even"><td>hash

</td><td>String

</td><td>хеш-значення, отримане в результаті обробки

</td></tr><tr class="row-odd"><td>type

</td><td>[XDocType](https://wiki-v2.edin.ua/link/367#bkmrk-%D0%A2%D0%B0%D0%B1%D0%BB%D0%B8%D1%86%D1%8F-2.-%D0%9E%D0%BF%D0%B8%D1%81-%D1%82%D0%B8%D0%BF%D1%96)

</td><td>об’єкт; тип документа

</td></tr><tr class="row-even"><td>status

</td><td>[XDocStatus](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdocstatus)

</td><td>об’єкт; статус пари документів у відправника і одержувача

</td></tr><tr class="row-odd"><td>exchange\_status

</td><td>String

</td><td>сабстатус документа ([детальніше](https://wiki-v2.edin.ua/books/robota-z-api/page/sabstatusi-kvitanciidokumentiv))

</td></tr><tr class="row-even"><td>is\_archive

</td><td>boolean

</td><td>відмітка; Архівний документ чи ні

</td></tr><tr class="row-odd"><td>signInfo

</td><td>[XDocSignInfo](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdocsigninfo)

</td><td>об’єкт; дані про підписи

</td></tr><tr class="row-even"><td>chain

</td><td>XChain

</td><td>об’єкт; дані пов’язаних ланцюжків

</td></tr><tr class="row-odd"><td>extraFields

</td><td>Map&lt;String, String&gt;

</td><td>масив об’єктів; набір індексів (аналог індексних таблиць)

</td></tr><tr class="row-even"><td>tags

</td><td>List&lt;[XTag](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xtag-v-parametrax-objekta-xdoc)&gt;

</td><td>масив об’єктів; прикріплені теги

</td></tr><tr class="row-odd"><td>statuses

</td><td>List&lt;[XStatus](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xstatus)&gt;

</td><td>масив об’єктів; статуси обробки відправлених документів

</td></tr><tr class="row-even"><td>multiExtraFields

</td><td>Map&lt;String, List&lt;String&gt;&gt;

</td><td>масив об’єктів; мультиіндекс. Приклад: {„key1“: \[„val1“, „val2“\], „key2“: \[„val1“, „val2“\]}. Використовується, наприклад для обробки передаваємого рядка =&gt; розбивка рядка за умовою =&gt; індексування кожного шматка

</td></tr></tbody></table>

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%C2%A0-%7B-%22at"><summary>JSON приклад</summary>

```
{
  "attachments": [],
  "body": {
    "forms": {
      "json": {
        "type": {
          "id": 2,
          "name": "json"
        }
      }
    }
  },
  "chain_id": 0,
  "comments": [],
  "dateChanged": 0,
  "dateCreated": 1574421527,
  "dateRead": 0,
  "docDate": 1565211600,
  "docNumber": "2019-08-08-TEST-001",
  "doc_id": 143,
  "doc_uuid": "6ffc8dfa-1cd5-4137-82cf-29b5969c2e74",
  "extraFields": {
    "basis_doc_date": "1565211600",
    "basis_doc_number": "1",
    "basis_doc_subtype": "007",
    "doc_date": "1565211600",
    "doc_num": "2019-08-08-TEST-001",
    "order_number": "1",
    "recipient": "9864232319979",
    "sender": "9864232319962",
    "sub_doc_type_id": "006"
  },
  "family": 1,
  "hash": "D4733FDDDEBE23B4E38DC5F257604234",
  "is_archive": false,
  "multiExtraFields": {},
  "status": {
    "status": 1,
    "title": "open"
  },
  "statuses": [],
  "tags": [],
  "type": {
    "description": "Коммерческий документ",
    "title": "comdoc",
    "type": 28
  },
  "uuidReceiver": "9864232319979",
  "uuidSender": "9864232319962"
}
```

</details><details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%D0%B4%D0%BB%D1%8F-%D1%81%D0%B5%D1%80"><summary>JSON приклад для сервіса Вільний</summary>

```json
{
  "body": {
    "forms": {
      "json": {
        "type": {
          "id": 2,
          "name": "json"
        }
      }
    }
  },
  "attachments": [
    {
      "id": 247,
      "docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
      "attachmentUUID": "66c673fe-4beb-48e1-94bc-16bbae74ead6",
      "fileName": "21-Speed-Front-Suspension-MTB-Snow-Beach-Bike-Fat-Bike.jpg",
      "createDate": 1613753224,
      "type": "image/jpeg",
      "signs": [],
      "signHash": "EQt6XqKdKdTsjH1e+zgHOyi6FwFohC/jS5XyBgYN4k8="
    },
    {
      "id": 249,
      "docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
      "attachmentUUID": "37280d06-c85e-42bc-aa97-670950d1739f",
      "fileName": "1613469397472.png",
      "createDate": 1613754039,
      "type": "image/png",
      "signs": [],
      "signHash": "6zcK6RDHUxAV3icq6p0uMHmGfA1DYhfKZz053tw75+Y="
    },
    {
      "id": 250,
      "docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
      "attachmentUUID": "14904c6b-a83d-4e08-9bbf-5427d1d015f0",
      "fileName": "8cb20e57bcf705981d4605d6af413a91.png",
      "createDate": 1613754581,
      "type": "image/png",
      "signs": [],
      "signHash": "B5qPxPAju4pZ3x9blBo+NQVFRv8TU/5rxkwAWnhAyPw="
    }
  ],
  "comments": [],
  "doc_id": 125,
  "doc_uuid": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
  "uuidSender": "7c30a623-b84f-44d1-bda1-fdcc5f8be3d7",
  "uuidReceiver": "831714cf-064b-4ce9-bdc4-b6a79784639c",
  "uuidReceivers": [
    "831714cf-064b-4ce9-bdc4-b6a79784639c"
  ],
  "docNumber": "1613753224",
  "dateCreated": 1613753224,
  "dateChanged": 1613754581,
  "dateRead": 0,
  "docDate": 1613753224,
  "chain_id": 0,
  "family": 9,
  "hash": "D6387945D930C872219A5BA48FD50849",
  "type": {
    "type": 122,
    "title": "simple_doc",
    "description": "simple_doc"
  },
  "status": {
    "status": 1,
    "title": "open"
  },
  "exchange_status": "000000000000000000000000",
  "is_archive": false,
  "extraFields": {
    "doc_title": "rock&roll123",
    "action": "0"
  },
  "tags": [],
  "statuses": [],
  "multiExtraFields": {}
}
```

</details>