DigiOffice Gateway Web Services

<back to all web services

GenerateDocumentBatch

Queue multiple (corporate identity) document(s) to generate later via the DigiOffice background agent.

Requires Authentication 
System.NotSupportedException: Unknown language 'mjs', Supported languages: csharp, typescript, dart, java, kotlin, python, swift, vbnet, fsharp
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(MetadataTypes metadataTypes, MetadataTypesConfig typesConfig, String lang, IRequest req, Action`1 configure)
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(List`1 metadataTypes, String lang, IRequest req, Action`1 configure)
   at ServiceStack.Metadata.BaseMetadataHandler.d__12.MoveNext()

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

HTTP + JSV

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

POST /jsv/reply/GenerateDocumentBatch HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
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
				},
				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,
				Direction: Left2Right
			},
			OutputType: String
		}
	],
	DontRegister: False,
	SendMail: False
}

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

{
	Processed: 0,
	TrackAndTraceUrl: String
}