DocumentInfo

Предупреждение

Структура относится к устаревшей версии Docflow API. Вместо нее используется структура DocumentInfoV3 последней версии Docflow API — V3.

Структура DocumentInfo представляет собой метаданные документа — данные, которые не меняются в течение его жизненного цикла.

message DocumentInfo
{
    optional DocumentType DocumentType = 1;
    optional DocumentDirection DocumentDirection = 2;
    optional bool IsTest = 3;
    optional string CustomDocumentId = 4;
    optional string FromDepartmentId = 5;
    optional string ToDepartmentId = 6;
    optional string CounteragentBoxId = 7;
    optional DocumentDateAndNumber DocumentDateAndNumber = 8;
    optional BasicDocumentInfo BasicDocumentInfo = 9;
    optional InvoiceDocumentInfo InvoiceInfo = 10;
    optional InvoiceCorrectionDocumentInfo InvoiceCorrectionInfo = 11;
    optional PriceListDocumentInfo PriceListInfo = 12;
    optional ContractDocumentInfo ContractInfo = 13;
    optional SupplementaryAgreementDocumentInfo SupplementaryAgreementInfo = 14;
    optional UniversalTransferDocumentInfo UniversalTransferDocumentInfo = 15;
    optional UniversalCorrectionDocumentInfo UniversalCorrectionDocumentInfo = 16;
    optional string AttachmentVersion = 17;
    required string Version = 18;
 }

  • DocumentType — тип документа, представленный структурой DocumentType.

  • DocumentDirection — направление документа относительно данного ящика (входящий или исходящий), представленный структурой DocumentDirection.

  • IsTest — признак того, что документ тестовый.

  • CustomDocumentId — идентификатор документа, определяемый внешней системой.

  • FromDepartmentId — идентификатор подразделения-отправителя документа.

  • ToDepartmentId — идентификатор подразделения-получателя документа.

  • CounteragentBoxId — идентификатор ящика контрагента.

  • DocumentDateAndNumber — дата и номер документа, представленные структурой DocumentDateAndNumber.

  • AttachmentVersion — идентификатор версии документа. Поле устарело, вместо него используйте поле Version.

  • Version — идентификатор версии документа.

  • Поля, содержащие метаданные документа. В зависимости от типа документа заполняется только одно из полей:

    • BasicDocumentInfo — поле со структурой BasicDocumentInfo для документов XmlTorg12, XmlAcceptanceCertificate, Torg12, AcceptanceCertificate, ProformaInvoice, Torg13.

    • InvoiceInfo — поле со структурой InvoiceDocumentInfo для документов Invoice или InvoiceRevision.

    • InvoiceCorrectionInfo — поле со структурой InvoiceCorrectionDocumentInfo для документов InvoiceCorrection или InvoiceCorrectionRevision.

    • PriceListInfo — поле со структурой PriceListDocumentInfo для документов PriceList.

    • ContractInfo — поле со структурой ContractDocumentInfo для документов Contract.

    • SupplementaryAgreementInfo — поле со структурой SupplementaryAgreementDocumentInfo для документов SupplementaryAgreement.

    • UniversalTransferDocumentInfo — поле со структурой UniversalTransferDocumentInfo для документов UniversalTransferDocument, UniversalTransferDocumentRevision.

    • UniversalCorrectionDocumentInfo — поле со структурой UniversalCorrectionDocumentInfo для документов UniversalCorrectionDocument, UniversalCorrectionDocumentRevision.

См. также

Структура используется: