DP Document Generator

Overview

This service generates a DP documents based on request parameters passed in via a REST API call.

Prerequisites

• Java JDK 8.x

Getting started

Step 1.

Clone this repository, and run with the following

sbt clean update compile run

Usage examples

Airway Bill (Paperang Format)

Generate a Airway Bill in paperang format with the following. This assumes that you are running the service locally.

curl --location --request POST 'localhost:9000/1.0/generate-awb' \
--header 'Content-Type: application/json' \
--data-raw '{
    "awbs": [
        {
            "trackingId": "A0000001",
            "fromName": "Shipper A",
            "postalCode": "Consignee A'\''s Postal Code",
            "toAddress": "Consignee A'\''s Address",
            "toContact": "Consignee A'\''s Contact",
            "toName": "Consignee A",
            "sortCode": "Consignee A'\''s Sort Code",
            "isCod": false
        }
    ]
}'

Receipt

Generate a receipt with the following. This assumes that you are running the service locally.

curl --location --request POST 'localhost:9000/1.0/generate-receipt' \
--header 'Content-Type: application/json' \
--data-raw '{
    "invoiceNumber": "INV000001",
    "invoiceDate": "2020-08-01",
    "invoiceTime": "10:11 AM1",
    "language": "EN",
    "locationUrl": "https://www.google.com",
    "locationContact": "Location'\''s Contact",
    "landingPageUrl": "https://www.google.com",
    "companyUrl": "https://www.google.com",
    "supportEmail": "[email protected]",
    "companyName": "Company A",
    "taxIdentification": null,
    "receiptUpdated": false,
    "gstDescription": "Standard GST",
    "codDescription": null,
    "grandTotal": "100 SGD",
    "receiptLedger": {},
    "reservations": [
        {
            "trackingId": "A0000001",
            "totalAmount": "49.90 SGD",
            "packImage": null,
            "toName": "Consignee A",
            "toContact": "Consignee A'\''s Contact",
            "toAddress1": "Consignee A'\''s Address",
            "deliveryFee": "10.00 SGD",
            "insuranceValue": "2.00 SGD",
            "gstValue": "1.00 SGD",
            "codValue": null,
            "codTotal": null,
            "imageUrl": null,
            "weight": "1 KG",
            "gstDescription": "Standard GST",
            "codDescription": null
        },
        {
            "trackingId": "A0000002",
            "totalAmount": "51.10 SGD",
            "packImage": null,
            "toName": "Consignee A",
            "toContact": "Consignee A'\''s Contact",
            "toAddress1": "Consignee A'\''s Address",
            "deliveryFee": "10.00 SGD",
            "insuranceValue": "2.00 SGD",
            "gstValue": "1.00 SGD",
            "codValue": null,
            "codTotal": null,
            "imageUrl": null,
            "weight": "1 KG",
            "gstDescription": "Standard GST",
            "codDescription": null
        }
    ],
    "fromName": "Shipper A",
    "idNumber": "A1023",
    "fromContact": "Shipper A'\''s Contact",
    "fromEmail": "Shipper A'\''s Email",
    "billingAddress": "Consignee A'\''s Billing Address",
    "billingPostcode": "Consignee A'\''s Billing Postcode",
    "prepaid": false,
    "country": "SG"
}'

License

These source codes (Airway Bill (AWB) Generator) incorporates source codes from iText (com.itextpdf.itextpdf 5.5.13, com.itextpdf.tool.xmlworker 5.5.13) and are published under GNU Affero General Public License version 3. Copyright (C) <2022> Copyright (C) iText® 5.5.13 ©2000-2018 iText Group NV (AGPL-version) for abovementioned source codes from iText

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Contributing

Pull requests are welcome. For major changes, please start a conversation first to discuss what you would like to change.