document-generation-service

Document generation service for Rollvolet CRM. Documents are generated based on HTML templates in which placeholders will be replaced with actual content.

Installation

To add the service to your stack, add the following snippet to docker-compose.yml:

services:
  documents:
    image: rollvolet/document-generation-service
    volumes:
      - ./config/templates:/templates
      - ./config/watermarks:/watermarks

Configuration

Templates

The following environment variables can be set to configure the absolute path to the template:

• OFFER_TEMPLATE_NL: absolute path of the offer template in Dutch (default: /templates/offerte-nl.html)
• OFFER_TEMPLATE_FR: absolute path of the offer template in French (default: /templates/offerte-fr.html)
• OFFER_HEADER_TEMPLATE_NL: absolute path of the offer header template in Dutch (default: /templates/offerte-header-nl.html)
• OFFER_HEADER_TEMPLATE_FR: absolute path of the offer header template in French (default: /templates/offerte-header-fr.html)
• ORDER_TEMPLATE_NL: absolute path of the order template in Dutch (default: /templates/bestelbon-nl.html)
• ORDER_TEMPLATE_FR: absolute path of the order template in French (default: /templates/bestelbon-fr.html)
• ORDER_HEADER_TEMPLATE_NL: absolute path of the order header template in Dutch (default: /templates/bestelbon-header-nl.html)
• ORDER_HEADER_TEMPLATE_FR: absolute path of the order header template in French (default: /templates/bestelbon-header-fr.html)
• DELIVERY_NOTE_TEMPLATE_NL: absolute path of the delivery note template in Dutch (default: /templates/leveringsbon-nl.html)
• DELIVERY_NOTE_TEMPLATE_FR: absolute path of the delivery note template in French (default: /templates/leveringsbon-fr.html)
• DELIVERY_NOTE_HEADER_TEMPLATE_NL: absolute path of the delivery note header template in Dutch (default: /templates/leveringsbon-header-nl.html)
• DELIVERY_NOTE_HEADER_TEMPLATE_FR: absolute path of the delivery note header template in French (default: /templates/leveringsbon-header-fr.html)
• PRODUCTION_TICKET_TEMPLATE_NL: absolute path of the production ticket template in Dutch (default: /templates/productiebon-nl.html)
• PRODUCTION_TICKET_WATERMARK_NL: absolute path of the production ticket watermark in Dutch (default: /watermarks/productiebon-nl.html)
• DEPOSIT_INVOICE_TEMPLATE_NL: absolute path of the deposit invoice template in Dutch (default: /templates/voorschotfactuur-nl.html)
• DEPOSIT_INVOICE_TEMPLATE_FR: absolute path of the deposit invoice template in French (default: /templates/voorschotfactuur-fr.html)
• DEPOSIT_INVOICE_HEADER_TEMPLATE_NL: absolute path of the deposit invoice header template in Dutch (default: /templates/voorschotfactuur-header-nl.html)
• DEPOSIT_INVOICE_HEADER_TEMPLATE_FR: absolute path of the deposit invoice header template in French (default: /templates/voorschotfactuur-header-fr.html)
• DEPOSIT_INVOICE_CREDIT_NOTE_TEMPLATE_NL: absolute path of the credit note for a deposit invoice template in Dutch (default: /templates/voorschotfactuur-creditnota-nl.html)
• DEPOSIT_INVOICE_CREDIT_NOTE_TEMPLATE_FR: absolute path of the credit note for a deposit invoice template in French (default: /templates/voorschotfactuur-creditnota-fr.html)
• INVOICE_TEMPLATE_NL: absolute path of the invoice template in Dutch (default: /templates/factuur-nl.html)
• INVOICE_TEMPLATE_FR: absolute path of the invoice template in French (default: /templates/factuur-fr.html)
• INVOICE_HEADER_TEMPLATE_NL: absolute path of the invoice header template in Dutch (default: /templates/factuur-header-nl.html)
• INVOICE_HEADER_TEMPLATE_FR: absolute path of the invoice header template in French (default: /templates/factuur-header-fr.html)
• CREDIT_NOTE_TEMPLATE_NL: absolute path of the credit note template in Dutch (default: /templates/creditnota-nl.html)
• CREDIT_NOTE_TEMPLATE_FR: absolute path of the credit note template in French (default: /templates/creditnota-fr.html)
• CREDIT_NOTE_HEADER_TEMPLATE_NL: absolute path of the credit note header template in Dutch (default: /templates/creditnota-header-nl.html)
• CREDIT_NOTE_HEADER_TEMPLATE_FR: absolute path of the credit note header template in French (default: /templates/creditnota-header-fr.html)
• VISIT_REPORT_TEMPLATE_NL: absolute path of the visit report template in Dutch (default: /templates/bezoekrapport-nl.html)
• VISIT_SUMMARY_TEMPLATE_NL: absolute path of the visit summary template in Dutch (default: /templates/bezoek-samenvatting-nl.html)
• VISIT_SUMMARY_ENTRY_TEMPLATE_NL: absolute path of the visit summary entry template in Dutch (default: /templates/bezoek-samenvatting-entry-nl.html)
• INTERVENTION_REPORT_TEMPLATE_NL: absolute path of the intervention report template in Dutch (default: /templates/interventierapport-nl.html)
• FOOTER_TEMPLATE_NL: absolute path of the footer template in Dutch (default: /templates/footer-nl.html)
• FOOTER_TEMPLATE_FR: absolute path of the footer template in French (default: /templates/footer-fr.html)

The header and footer templates are included in the following documents:

• offer
• deposit invoice
• invoice

Volumes

All generated files (final output as well as intermediary files) are stored in /tmp.

API

All endpoints receive a JSON body containing the data required to fill in the variables in the templates. The service doesn't query a database itself. The response of each request is a file.

POST /documents/visit-report

Generates a visit report (PDF file) for a given customer request. The request body must contain a customer request, including the related customer, contact, building, way-of-entry, language and visit.

POST /documents/visit-summary

Generates a visit report (PDF file) for a selection of requests. The request body must contain the requests, including the related customer, contact, building, way-of-entry, language and visit.

POST /documents/intervention-report

Generates an intervention report (PDF file) for a given intervention. The request body must contain an intervention, including the related customer, contact, building, way-of-entry, language and planning venet.

POST /documents/offer

Generates an offer (PDF file) for a given offer with a set of offerlines. The request body must contain the visitor initials and an offer. The offer must include the related offerlines with VAT rate, customer, contact, building, request and customer/contact telephones.

POST /documents/order

Generates an order (PDF file) for a given order with a set of ordered offerlines. The request body must contain the visitor initials and an order. The order must include the offer together with its related request, ordered offerlines and VAT rates, customer, contact, building and customer/contact telephones.

POST /documents/delivery-note

Generates a delivery note (PDF file) for a given order with a set of offerlines. The request body must contain the visitor initials and an order. The order must include the offer together with its related request and ordered offerlines, customer, contact, building and customer/contact telephones.

POST /documents/production-ticket

Generates a template for a production ticket (PDF file) with the customer and order details prefilled. The request body must contain the order. The order must contain the offer together with its related request, customer, contact, building and customer/contact telephones.

POST /documents/production-ticket-watermark

Generates a production ticket with a watermark (PDF file) stating it's already fulfilled. The request body must contain the production-ticket PDF file that must be watermarked.

POST /documents/invoice

Generates an invoice or credit note (PDF file) for a given invoice with a set of ordered offerlines.

POST /documents/deposit-invoice

Generates a deposit invoice (PDF file) for a given deposit invoice with a set of ordered offerlines.

POST /documents/certificate

Generates a VAT certificate (PDF file) for a given invoice.