"use strict";
export class GenerateDocumentBatchResponse {
/** @param {{BatchID?:string,Processed?:number,TrackAndTraceUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description ID of the batch */
BatchID;
/**
* @type {number}
* @description Document processed count */
Processed;
/**
* @type {string}
* @description Track and Trace url */
TrackAndTraceUrl;
}
export class UserReference {
/** @param {{ID?:number,LoginName?:string,UserPrincipalName?:string,FullName?:string,EmailAddress?:string,GlobalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
ID;
/** @type {string} */
LoginName;
/** @type {string} */
UserPrincipalName;
/** @type {string} */
FullName;
/** @type {string} */
EmailAddress;
/** @type {?string} */
GlobalID;
}
export class DocumentgeneratorDocumentReference {
/** @param {{ID?:string,Name?:string,GlobalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
ID;
/** @type {string} */
Name;
/** @type {?string} */
GlobalID;
}
export class RegistrationProfileReference {
/** @param {{ID?:string,GlobalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ID;
/** @type {?string} */
GlobalID;
}
export class DocumentReference {
/** @param {{ID?:string,Code?:string,VersionCode?:string,RootDocID?:string,InternalInvoiceCode?:string,CompanyNumber?:number,DocumentTypeID?:string,InvoiceType?:number,RegProfCatID?:number,GlobalID?:string,ExternalID?:string,ExternNr?:string,ExternVersieNr?:string,InternNummer?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
ID;
/** @type {string} */
Code;
/** @type {string} */
VersionCode;
/** @type {?string} */
RootDocID;
/** @type {string} */
InternalInvoiceCode;
/** @type {?number} */
CompanyNumber;
/** @type {string} */
DocumentTypeID;
/** @type {?number} */
InvoiceType;
/** @type {?number} */
RegProfCatID;
/** @type {?string} */
GlobalID;
/** @type {string} */
ExternalID;
/** @type {string} */
ExternNr;
/** @type {string} */
ExternVersieNr;
/** @type {string} */
InternNummer;
}
/** @typedef {'Create'|'Register'} */
export var DocInfoAction;
(function (DocInfoAction) {
DocInfoAction["Create"] = "Create"
DocInfoAction["Register"] = "Register"
})(DocInfoAction || (DocInfoAction = {}));
/** @typedef {'New'|'Change'|'NewVersionPrimary'|'NewVersionSecondary'|'NewFromExistingDocument'} */
export var DocInfoMode;
(function (DocInfoMode) {
DocInfoMode["New"] = "New"
DocInfoMode["Change"] = "Change"
DocInfoMode["NewVersionPrimary"] = "NewVersionPrimary"
DocInfoMode["NewVersionSecondary"] = "NewVersionSecondary"
DocInfoMode["NewFromExistingDocument"] = "NewFromExistingDocument"
})(DocInfoMode || (DocInfoMode = {}));
/** @typedef {'Off'|'AllowUserInteraction'|'DoNotAllowUserInteraction'} */
export var DocInfoSilentMode;
(function (DocInfoSilentMode) {
DocInfoSilentMode["Off"] = "Off"
DocInfoSilentMode["AllowUserInteraction"] = "AllowUserInteraction"
DocInfoSilentMode["DoNotAllowUserInteraction"] = "DoNotAllowUserInteraction"
})(DocInfoSilentMode || (DocInfoSilentMode = {}));
export class DocumentInfo {
/** @param {{Action?:DocInfoAction,Mode?:DocInfoMode,Version?:string,SilentMode?:DocInfoSilentMode}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {DocInfoAction} */
Action;
/** @type {DocInfoMode} */
Mode;
/** @type {string} */
Version;
/** @type {DocInfoSilentMode} */
SilentMode;
}
export class MessageQueueReference {
/** @param {{ID?:number,GlobalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
ID;
/** @type {?string} */
GlobalID;
}
export class ConfigurationSource {
/** @param {{DocumentgeneratorDocument?:DocumentgeneratorDocumentReference,RegistrationProfile?:RegistrationProfileReference,RegisteredDocument?:DocumentReference,UnRegisteredDocument?:DocumentInfo,DraftDocumentRegistration?:MessageQueueReference,DocumentgeneratorType?:string,DocumentgeneratorTypeName?:string,TemplateExtension?:string,OutputExtension?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {DocumentgeneratorDocumentReference}
* @description Document genereren op basis van een DocGenDocument. */
DocumentgeneratorDocument;
/**
* @type {RegistrationProfileReference}
* @description Document genereren op basis van een RegistratieProfiel. */
RegistrationProfile;
/**
* @type {DocumentReference}
* @description Use existing document registration. */
RegisteredDocument;
/**
* @type {DocumentInfo}
* @description Use documentInfo. */
UnRegisteredDocument;
/**
* @type {MessageQueueReference}
* @description Use draft document registration. */
DraftDocumentRegistration;
/** @type {string} */
DocumentgeneratorType;
/**
* @type {string}
* @description DocumentgeneratorType voor bijvoorbeeld Word of Email. */
DocumentgeneratorTypeName;
/** @type {string} */
TemplateExtension;
/** @type {string} */
OutputExtension;
}
/** @typedef {'New'|'Change'|'Primary'|'Secondary'} */
export var VersioningType;
(function (VersioningType) {
VersioningType["New"] = "New"
VersioningType["Change"] = "Change"
VersioningType["Primary"] = "Primary"
VersioningType["Secondary"] = "Secondary"
})(VersioningType || (VersioningType = {}));
export class CompanyReference {
/** @param {{ID?:number,Number?:number,GlobalID?:string,ExternalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
ID;
/** @type {?number} */
Number;
/** @type {?string} */
GlobalID;
/** @type {string} */
ExternalID;
}
export class RelationReference {
/** @param {{ID?:number,CreditorNumber?:number,DebtorNumber?:number,GlobalLocationNumber?:string,GlobalID?:string,ExternalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
ID;
/** @type {?number} */
CreditorNumber;
/** @type {?number} */
DebtorNumber;
/** @type {string} */
GlobalLocationNumber;
/** @type {?string} */
GlobalID;
/** @type {string} */
ExternalID;
}
export class PersonReference {
/** @param {{ID?:number,Number?:number,GlobalID?:string,ExternalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
ID;
/** @type {?number} */
Number;
/** @type {?string} */
GlobalID;
/** @type {string} */
ExternalID;
}
export class ProjectReference {
/** @param {{ID?:number,Code?:string,TypeExternalID?:string,CompanyNumber?:number,GlobalID?:string,ExternalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
ID;
/** @type {string} */
Code;
/** @type {string} */
TypeExternalID;
/** @type {?number} */
CompanyNumber;
/** @type {?string} */
GlobalID;
/** @type {string} */
ExternalID;
}
export class SubProject {
/** @param {{Project?:ProjectReference}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ProjectReference} */
Project;
}
export class ContactPersonReference {
/** @param {{ID?:number,GlobalID?:string,ExternalID?:string,RelationID?:number,PersonID?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
ID;
/** @type {?string} */
GlobalID;
/** @type {string} */
ExternalID;
/** @type {?number} */
RelationID;
/** @type {?number} */
PersonID;
}
/** @typedef {'MainSigner'|'AdditionalSigner'|'ConfirmationDeclarant'|'AdditionalConfirmationDeclarant'} */
export var SignerType;
(function (SignerType) {
SignerType["MainSigner"] = "MainSigner"
SignerType["AdditionalSigner"] = "AdditionalSigner"
SignerType["ConfirmationDeclarant"] = "ConfirmationDeclarant"
SignerType["AdditionalConfirmationDeclarant"] = "AdditionalConfirmationDeclarant"
})(SignerType || (SignerType = {}));
export class Signer {
/** @param {{MainSignerPostFix?:string,User?:UserReference,Person?:PersonReference,Relation?:RelationReference,ContactPerson?:ContactPersonReference,RegisteredDocument?:DocumentReference,Type?:SignerType,ClosingSentence?:string,Name?:string,Subsidiary?:string,Function?:string,Department?:string,PhoneNumber?:string,FaxNumber?:string,MobileNumber?:string,Email?:string,CustomText?:string,Signature?:string[],Initials?:string[],SignatureVisible?:boolean,InitialsVisible?:boolean,Visible?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
MainSignerPostFix;
/** @type {UserReference} */
User;
/** @type {PersonReference} */
Person;
/** @type {RelationReference} */
Relation;
/** @type {ContactPersonReference} */
ContactPerson;
/** @type {DocumentReference} */
RegisteredDocument;
/** @type {SignerType} */
Type;
/** @type {string} */
ClosingSentence;
/** @type {string} */
Name;
/** @type {string} */
Subsidiary;
/** @type {string} */
Function;
/** @type {string} */
Department;
/** @type {string} */
PhoneNumber;
/** @type {string} */
FaxNumber;
/** @type {string} */
MobileNumber;
/** @type {string} */
Email;
/** @type {string} */
CustomText;
/** @type {string[]} */
Signature;
/** @type {string[]} */
Initials;
/** @type {?boolean} */
SignatureVisible;
/** @type {?boolean} */
InitialsVisible;
/** @type {?boolean} */
Visible;
}
export class Field {
/** @param {{Name?:string,OldValue?:string,Value?:string,Title?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
OldValue;
/** @type {string} */
Value;
/** @type {string} */
Title;
}
export class AttachmentData {
/** @param {{ContentType?:string,Data?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ContentType;
/**
* @type {string}
* @description Data base64-encoded zonder padding. */
Data;
}
export class Attachment {
/** @param {{Name?:string,AttachmentData?:AttachmentData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {AttachmentData} */
AttachmentData;
}
export class RegistrationMetaData {
/** @param {{Versioning?:VersioningType,PreviousDocument?:DocumentReference,Company?:CompanyReference,Relation?:RelationReference,Person?:PersonReference,Project?:ProjectReference,SubProjects?:SubProject[],Signers?:Signer[],Fields?:Field[],Attachments?:Attachment[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?VersioningType}
* @description Hoe moet het versiebeheer worden toegepast? */
Versioning;
/**
* @type {DocumentReference}
* @description Previous document will be used for registration of a new version. */
PreviousDocument;
/**
* @type {CompanyReference}
* @description Company */
Company;
/**
* @type {RelationReference}
* @description Relation */
Relation;
/**
* @type {PersonReference}
* @description Person */
Person;
/**
* @type {ProjectReference}
* @description Project */
Project;
/**
* @type {SubProject[]}
* @description Sub projects */
SubProjects;
/**
* @type {Signer[]}
* @description Signers */
Signers;
/**
* @type {Field[]}
* @description Bevat velden die gebruikt worden als additionele metadata voor het document, naast de vaste koppelingen zoals gebruiker, project en relatie. */
Fields;
/**
* @type {Attachment[]}
* @description Attachments die aan de documentregistratie gekoppeld moet worden. */
Attachments;
}
export class CommonEntityBaseReference {
/** @param {{ID?:string,ExternalID?:string,GlobalID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ID;
/** @type {string} */
ExternalID;
/** @type {?string} */
GlobalID;
}
/** @typedef {number} */
export var Direction;
(function (Direction) {
Direction[Direction["Left2Right"] = 0] = "Left2Right"
Direction[Direction["UpLeft2DownRight"] = 45] = "UpLeft2DownRight"
Direction[Direction["Up2Down"] = 90] = "Up2Down"
Direction[Direction["UpRight2DownLeft"] = 135] = "UpRight2DownLeft"
Direction[Direction["Right2Left"] = 180] = "Right2Left"
Direction[Direction["DownRight2UpLeft"] = 225] = "DownRight2UpLeft"
Direction[Direction["Down2Up"] = 270] = "Down2Up"
Direction[Direction["DownLeft2UpRight"] = 315] = "DownLeft2UpRight"
})(Direction || (Direction = {}));
export class Watermark {
/** @param {{Text?:string,FontFamilyName?:string,Direction?:Direction,StrokeColorText?:string,StrokeColor?:Color,FillColorText?:string,FillColor?:Color}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Text;
/** @type {string} */
FontFamilyName;
/** @type {?Direction} */
Direction;
/** @type {string} */
StrokeColorText;
/** @type {Color} */
StrokeColor;
/** @type {string} */
FillColorText;
/** @type {Color} */
FillColor;
}
export class BatchDocument {
/** @param {{ConfigurationSource?:ConfigurationSource,RegistrationMetaData?:RegistrationMetaData,DataSourceEntity?:CommonEntityBaseReference,CustomData?:string,Watermark?:Watermark,OutputType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ConfigurationSource}
* @description ConfigurationSource: DocumentgeneratorDocument of RegistratieProfiel. */
ConfigurationSource;
/**
* @type {RegistrationMetaData}
* @description Set references to bind with Registration profile */
RegistrationMetaData;
/**
* @type {CommonEntityBaseReference}
* @description Entity instance used as data source parent, if not exists default is Document registration instance. */
DataSourceEntity;
/**
* @type {string}
* @description Hier kan de (dynamische) data voor het document geplaatst worden, de data kan middels tekstblokken en placeholders worden geplaatst.Het formaat binnen CustomData staat vrij maar vereist een 'root' element. */
CustomData;
/**
* @type {Watermark}
* @description Insert a watermark into the document. */
Watermark;
/**
* @type {string}
* @description Type van het gegenereerde document, bijvoorbeeld: Doc, Docx, Pdf. */
OutputType;
}
export class GenerateDocumentBatch {
/** @param {{User?:UserReference,Description?:string,Documents?:BatchDocument[],DontRegister?:boolean,SendMail?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {UserReference}
* @description Owner of the badge (DigiOffice user) */
User;
/**
* @type {string}
* @description Description of the badge */
Description;
/**
* @type {BatchDocument[]}
* @description Corporate identity document(s) to be generate */
Documents = [];
/**
* @type {?boolean}
* @description Generated document is not registered in DigiOffice DMS. */
DontRegister;
/**
* @type {boolean}
* @description Send the generated e-mail via the e-mail queue. */
SendMail;
}
JavaScript GenerateDocumentBatch DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/GenerateDocumentBatch HTTP/1.1
Host: dogw.klokgroep.nl
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"User":{"ID":0,"LoginName":"String","UserPrincipalName":"String","FullName":"String","EmailAddress":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"Description":"String","Documents":[{"ConfigurationSource":{"DocumentgeneratorDocument":{"ID":"00000000-0000-0000-0000-000000000000","Name":"String"},"RegistrationProfile":{},"RegisteredDocument":{"ID":"00000000-0000-0000-0000-000000000000","Code":"String","VersionCode":"String","RootDocID":"00000000-0000-0000-0000-000000000000","InternalInvoiceCode":"String","CompanyNumber":0,"DocumentTypeID":"String","InvoiceType":0,"RegProfCatID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String","ExternVersieNr":"String"},"UnRegisteredDocument":{"Action":"Create","Mode":"New","Version":"String","SilentMode":"Off"},"DraftDocumentRegistration":{"ID":0},"DocumentgeneratorType":null,"TemplateExtension":"String","OutputExtension":"String"},"RegistrationMetaData":{"Versioning":"New","PreviousDocument":{"ID":"00000000-0000-0000-0000-000000000000","Code":"String","VersionCode":"String","RootDocID":"00000000-0000-0000-0000-000000000000","InternalInvoiceCode":"String","CompanyNumber":0,"DocumentTypeID":"String","InvoiceType":0,"RegProfCatID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String","ExternVersieNr":"String"},"Company":{"ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Relation":{"ID":0,"CreditorNumber":0,"DebtorNumber":0,"GlobalLocationNumber":"String","GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Person":{"ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Project":{"ID":0,"Code":"String","TypeExternalID":"String","CompanyNumber":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"SubProjects":[{"Project":{"ID":0,"Code":"String","TypeExternalID":"String","CompanyNumber":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"}}],"Signers":[{"MainSignerPostFix":"String","User":{"ID":0,"LoginName":"String","UserPrincipalName":"String","FullName":"String","EmailAddress":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"Person":{"ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Relation":{"ID":0,"CreditorNumber":0,"DebtorNumber":0,"GlobalLocationNumber":"String","GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"ContactPerson":{"ID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String","RelationID":0,"PersonID":0},"RegisteredDocument":{"ID":"00000000-0000-0000-0000-000000000000","Code":"String","VersionCode":"String","RootDocID":"00000000-0000-0000-0000-000000000000","InternalInvoiceCode":"String","CompanyNumber":0,"DocumentTypeID":"String","InvoiceType":0,"RegProfCatID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String","ExternVersieNr":"String"},"Type":"MainSigner","ClosingSentence":"String","Name":"String","Subsidiary":"String","Function":"String","Department":"String","PhoneNumber":"String","FaxNumber":"String","MobileNumber":"String","Email":"String","CustomText":"String","Signature":["String"],"Initials":["String"],"SignatureVisible":false,"InitialsVisible":false,"Visible":false}],"Fields":[{"Name":"String","OldValue":"String","Value":"String","Title":"String = String -> String"}],"Attachments":[{"Name":"String","AttachmentData":{"ContentType":"String","Data":"String"}}]},"DataSourceEntity":{"ID":"String","ExternalID":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"CustomData":"String","Watermark":{"Text":"String","FontFamilyName":"String","Direction":"Left2Right","StrokeColorText":null,"FillColorText":null},"OutputType":"String"}],"DontRegister":false,"SendMail":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"BatchID":"00000000-0000-0000-0000-000000000000","Processed":0,"TrackAndTraceUrl":"String"}