DigiOffice Gateway Web Services

<back to all web services

GenerateDocument

Generate custom Document (Don't use from inside VSTO's)

Requires Authentication
GenerateDocument Parameters:
NameParameterData TypeRequiredDescription
UserqueryUserReferenceNoDigiOffice user
SendMailqueryboolNoSend the generated e-mail via the e-mail queue.
ConfigurationSourcequeryConfigurationSourceYesConfigurationSource: DocumentgeneratorDocument of RegistratieProfiel.
RegistrationMetaDataqueryRegistrationMetaDataYesSet references to bind with Registration profile
DataSourceEntityqueryCommonEntityBaseReferenceNoEntity instance used as data source parent, if not exists default is Document registration instance.
CustomDataquerystringNoHier 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.
WatermarkqueryWatermarkNoInsert a watermark into the document.
OutputTypequerystringNoType van het gegenereerde document, bijvoorbeeld: Doc, Docx, Pdf.
ShouldUpdateDocumentFilequeryboolNoShould update the document file.
UserReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
LoginNameformstringNo
UserPrincipalNameformstringNo
FullNameformstringNo
EmailAddressformstringNo
GlobalIDformGuid?No
ConfigurationSource Parameters:
NameParameterData TypeRequiredDescription
DocumentgeneratorDocumentformDocumentgeneratorDocumentReferenceNoDocument genereren op basis van een DocGenDocument.
RegistrationProfileformRegistrationProfileReferenceNoDocument genereren op basis van een RegistratieProfiel.
RegisteredDocumentformDocumentReferenceNoUse existing document registration.
DraftDocumentRegistrationformMessageQueueReferenceNoUse draft document registration.
DocumentgeneratorTypeformTypeNo
DocumentgeneratorTypeNameformstringNoDocumentgeneratorType voor bijvoorbeeld Word of Email.
TemplateExtensionformstringNo
OutputExtensionformstringNo
DocumentgeneratorDocumentReference Parameters:
NameParameterData TypeRequiredDescription
IDformGuid?No
NameformstringNo
GlobalIDformGuid?No
RegistrationProfileReference Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
GlobalIDformGuid?No
DocumentReference Parameters:
NameParameterData TypeRequiredDescription
IDformGuid?No
CodeformstringNo
VersionCodeformstringNo
RootDocIDformGuid?No
InternalInvoiceCodeformstringNo
CompanyNumberformint?No
DocumentTypeIDformstringNo
InvoiceTypeformint?No
RegProfCatIDformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
ExternNrformstringNo
InternNummerformstringNo
MessageQueueReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
GlobalIDformGuid?No
RegistrationMetaData Parameters:
NameParameterData TypeRequiredDescription
VersioningformVersioningType?NoHoe moet het versiebeheer worden toegepast?
PreviousDocumentformDocumentReferenceNoPrevious document will be used for registration of a new version.
CompanyformCompanyReferenceNoCompany
RelationformRelationReferenceNoRelation
PersonformPersonReferenceNoPerson
ProjectformProjectReferenceNoProject
SubProjectsformList<SubProject>NoSub projects
SignersformList<Signer>NoSigners
FieldsformList<Field>NoBevat velden die gebruikt worden als additionele metadata voor het document, naast de vaste koppelingen zoals gebruiker, project en relatie.
AttachmentsformList<Attachment>NoAttachments die aan de documentregistratie gekoppeld moet worden.
CompanyReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
Numberformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
RelationReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
CreditorNumberformint?No
DebtorNumberformint?No
GlobalLocationNumberformstringNo
GlobalIDformGuid?No
ExternalIDformstringNo
PersonReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
Numberformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
ProjectReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
CodeformstringNo
TypeExternalIDformstringNo
CompanyNumberformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
SubProject Parameters:
NameParameterData TypeRequiredDescription
ProjectformProjectReferenceNo
Signer Parameters:
NameParameterData TypeRequiredDescription
UserformUserReferenceNo
PersonformPersonReferenceNo
RelationformRelationReferenceNo
ContactPersonformContactPersonReferenceNo
RegisteredDocumentformDocumentReferenceNo
TypeformSignerTypeNo
ClosingSentenceformstringNo
NameformstringNo
SubsidiaryformstringNo
FunctionformstringNo
DepartmentformstringNo
PhoneNumberformstringNo
FaxNumberformstringNo
MobileNumberformstringNo
EmailformstringNo
CustomTextformstringNo
SignatureformList<string>No
SignatureVisibleformbool?No
Visibleformbool?No
ContactPersonReference Parameters:
NameParameterData TypeRequiredDescription
IDformint?No
GlobalIDformGuid?No
ExternalIDformstringNo
RelationIDformint?No
PersonIDformint?No
Field Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
OldValueformstringNo
ValueformstringNo
TitleformstringNo
Attachment Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
AttachmentDataformAttachmentDataNo
AttachmentData Parameters:
NameParameterData TypeRequiredDescription
ContentTypeformstringNo
DataformstringNoData base64-encoded zonder padding.
CommonEntityBaseReference Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
ExternalIDformstringNo
GlobalIDformGuid?No
Watermark Parameters:
NameParameterData TypeRequiredDescription
TextformstringNo
FontFamilyTextformstringNo
FontFamilyformFontFamilyNo
DirectionformDirection?No
StrokeColorTextformstringNo
StrokeColorformColorNo
FillColorTextformstringNo
FillColorformColorNo
GenerateDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformGuidYesContains the registration ID of the generated (corporate identity) document

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GenerateDocument HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"__type":"IDB.DocumentGenerator.SDK.Operations.General.GenerateDocument, IDB.DocumentGenerator.SDK","User":{"__type":"IDB.API.Entities.UserReference, IDB.API","ID":0,"LoginName":"String","UserPrincipalName":"String","FullName":"String","EmailAddress":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"SendMail":false,"ConfigurationSource":{"__type":"IDB.API.DocumentGenerator.ConfigurationSource, IDB.API","DocumentgeneratorDocument":{"__type":"IDB.API.Entities.DocumentgeneratorDocumentReference, IDB.API","ID":"00000000-0000-0000-0000-000000000000","Name":"String"},"RegistrationProfile":{"__type":"IDB.API.Entities.RegistrationProfileReference, IDB.API"},"RegisteredDocument":{"__type":"IDB.API.Entities.DocumentReference, IDB.API","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"},"DraftDocumentRegistration":{"__type":"IDB.API.Entities.MessageQueueReference, IDB.API","ID":0},"DocumentgeneratorType":null,"TemplateExtension":"String","OutputExtension":"String"},"RegistrationMetaData":{"__type":"IDB.DocumentGenerator.SDK.DTO.RegistrationMetaData, IDB.DocumentGenerator.SDK","Versioning":"New","PreviousDocument":{"__type":"IDB.API.Entities.DocumentReference, IDB.API","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"},"Company":{"__type":"IDB.API.Entities.CompanyReference, IDB.API","ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Relation":{"__type":"IDB.API.Entities.RelationReference, IDB.API","ID":0,"CreditorNumber":0,"DebtorNumber":0,"GlobalLocationNumber":"String","GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Person":{"__type":"IDB.API.Entities.PersonReference, IDB.API","ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Project":{"__type":"IDB.API.Entities.ProjectReference, IDB.API","ID":0,"Code":"String","TypeExternalID":"String","CompanyNumber":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"SubProjects":[{"__type":"IDB.API.DocumentGenerator.SubProject, IDB.API","Project":{"__type":"IDB.API.Entities.ProjectReference, IDB.API","ID":0,"Code":"String","TypeExternalID":"String","CompanyNumber":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"}}],"Signers":[{"__type":"IDB.API.DocumentGenerator.Signer, IDB.API","User":{"__type":"IDB.API.Entities.UserReference, IDB.API","ID":0,"LoginName":"String","UserPrincipalName":"String","FullName":"String","EmailAddress":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"Person":{"__type":"IDB.API.Entities.PersonReference, IDB.API","ID":0,"Number":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"Relation":{"__type":"IDB.API.Entities.RelationReference, IDB.API","ID":0,"CreditorNumber":0,"DebtorNumber":0,"GlobalLocationNumber":"String","GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String"},"ContactPerson":{"__type":"IDB.API.Entities.ContactPersonReference, IDB.API","ID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","ExternalID":"String","RelationID":0,"PersonID":0},"RegisteredDocument":{"__type":"IDB.API.Entities.DocumentReference, IDB.API","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"},"Type":"MainSigner","ClosingSentence":"String","Name":"String","Subsidiary":"String","Function":"String","Department":"String","PhoneNumber":"String","FaxNumber":"String","MobileNumber":"String","Email":"String","CustomText":"String","Signature":["String"],"SignatureVisible":false,"Visible":false}],"Fields":[{"__type":"IDB.API.Common.Field, IDB.API","Name":"String","OldValue":"String","Value":"String","Title":"String = String -> String"}],"Attachments":[{"__type":"IDB.API.DocumentGenerator.Attachment, IDB.API","Name":"String","AttachmentData":{"__type":"IDB.API.DocumentGenerator.AttachmentData, IDB.API","ContentType":"String","Data":"String"}}]},"DataSourceEntity":{"__type":"IDB.API.Entities.CommonEntityBaseReference, IDB.API","ID":"String","ExternalID":"String","GlobalID":"00000000-0000-0000-0000-000000000000"},"CustomData":"String","Watermark":{"__type":"IDB.API.DocumentGenerator.Watermark, IDB.API","Text":"String","FontFamilyText":null,"Direction":"Left2Right","StrokeColorText":null,"FillColorText":null},"OutputType":"String","ShouldUpdateDocumentFile":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"__type":"IDB.DocumentGenerator.SDK.DTO.General.GenerateDocumentResponse, IDB.DocumentGenerator.SDK","DocumentID":"00000000-0000-0000-0000-000000000000"}