Skip to main content

Об’єкт XDoc

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

Параметр

Формат

Опис

body

XDocBodyForms

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

attachments

List<XDocAttachment>

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

comments

XDocCommentsList

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

doc_id

long

id документа

doc_uuid

UUID

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

uuidSender

String

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

uuidReceiver

String

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

docNumber

String

номер документа

dateCreated

long

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

dateChanged

long

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

dateRead

long

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

docDate

long

дата документа, зазначена в документі

chain_id

long

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

chain_uuid

UUID

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

family

int

сімейство

  • 1 - EDI

  • 2 - UZD

  • 4 - CERTIFICATS

  • 6 - ATS

  • 7 - ETTN

  • 8 - DISTRIBUTION

  • 9 - SIMPLEDOC (Вільний)

  • 10 - TENDER

  • 11 - AGREEMENT

  • 12 - OPENPRICE (Є-Товар)

hash

String

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

type

XDocType

об’єкт; тип документа

status

XDocStatus

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

exchange_status

String

сабстатус документа (детальніше)

is_archive

boolean

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

signInfo

XDocSignInfo

об’єкт; дані про підписи

chain

XChain

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

extraFields

Map<String, String>

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

tags

List<XTag>

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

statuses

List<XStatus>

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

multiExtraFields

Map<String, List<String>>

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

 

{
  "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"
}

 

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": {}
}

 

Back to top