Project

General

Profile

Actions

Task #19900

open

Invoice - Add Air Clearing Tab in Proceed for Air Invoice Popup

Added by Redmine Admin 3 months ago. Updated 3 months ago.

Status:
New
Priority:
Normal
Assignee:
-
Start date:
05/15/2026
Due date:
05/15/2026 (about 4 months late)
% Done:

0%

Estimated time:
0:00 h
GitLab ID:
4430
GitLab Milestone:
GitLab Ticket Number:
1538
GitLab Time Logged:
0
Lock Timeline Date:
No
gitlab project trace:

Description

The current Proceed for Air Invoice popup already allows users to select air shipments for invoicing through the following tabs:

  • House Air Way Bill (HAWB)
  • Master Air Way Bill (MAWB)

The Air Clearing invoices should also be handled from this same popup.

Therefore, a new tab must be added: "Air Clearing"

The existing invoice functions must remain unchanged:

  • + Add button
  • Checkbox selection
  • Create Invoices for Selected
  • Search
  • Reset
  • Pagination
  • Process Invoice
  • Process All Invoices
  • List of Generated Invoices
  • Activity Log

Scope of Change

Add New Tab

Add a new tab in the Proceed for Air Invoice popup: "Air Clearing"

Final tabs should be:

  • House Air Way Bill (HAWB)
  • Master Air Way Bill (MAWB)
  • Air Clearing

Air Clearing Tab – Search Filters

The Air Clearing tab should include filters similar to the HAWB tab, but adapted for Air Clearing.

Field Type Remarks
Clearing Reference Textbox Search by Air Clearing reference
HAWB Reference Textbox Search by HAWB reference, if available
MAWB Reference Textbox Search by MAWB reference, if available
Cargo Type Dropdown Import / Export
Date Range Date range picker Mandatory, same behaviour as existing Air Invoice popup

Recommended layout:

Clearing Reference | HAWB Reference | MAWB Reference | Cargo Type | Date Range

Air Clearing Tab – Grid Columns

The grid in the Air Clearing tab should show Air Clearing files only.

Column Description
Checkbox Select clearing file for bulk invoice creation
Expand Icon Expand to view bill-to/charge/BOE details
Clearing Reference Air Clearing file reference
HAWB Reference Linked HAWB reference, if available
MAWB Reference Linked MAWB reference, if available
Airport of Origin Origin airport
Airport of Destination Destination airport
Cargo Type Import / Export
Airline Name Airline linked to clearing file
Created On Air Clearing file created date
Action + button to add the file for invoicing

Expandable Row Behaviour

The Air Clearing tab should support expandable rows, similar to the current invoice selection behaviour.

When the user expands an Air Clearing row, the system should display:

1. Bill To / Client Summary

Column Description
Name Bill To party
Client Type Organisation / Individual
VAT Type VAT type
Total Amount Total sales amount for that Bill To

2. Bill of Entry Details

Column Description
Bill of Entry Reference BOE reference
Submitted Date BOE submitted date
Clearance Date Clearance date
Status BOE status

The BOE details must come from the Air Clearing BOE section.

Functional Requirements

1 – Add Air Clearing Tab

The system must add a new tab named: "Air Clearing" inside the existing Proceed for Air Invoice popup.

2 – Show Only Air Clearing Files

The Air Clearing tab must display only records from the Air Clearing module.

It must not show:

  • HAWB shipment records
  • MAWB shipment records
  • Ocean Clearing records
  • Ocean HBL / MBL records

3 – Search Air Clearing Files

Users must be able to search Air Clearing files using:

  • Clearing Reference
  • HAWB Reference
  • MAWB Reference
  • Cargo Type
  • Date Range

4 – Date Range Mandatory

Date Range should remain mandatory, same as the existing Air Invoice popup.

If Date Range is blank, display the same validation message already used in the current Air Invoice popup.

5 – Add Single Air Clearing File for Invoice

When user clicks the + button on an Air Clearing row:

  • The selected Air Clearing file should be loaded into the invoice screen.
  • The system should load sales charges from the Air Clearing Sales section.
  • Charges should be grouped by Bill To, same as existing invoice behaviour.
  • The user should be able to process invoice using the existing Process Invoice button.

6 – Create Invoices for Selected

When user selects one or more Air Clearing rows using checkboxes and clicks:

"Create Invoices for Selected"

the system should create invoice preparation records using the same existing logic used for selected HAWB/MAWB records.

The button behaviour should remain unchanged.

7 – Load Air Clearing Sales Charges Only

For Air Clearing invoice processing, the system must load only Sales charges from the Air Clearing file.

It must not load:

  • Cost charges
  • Deleted sales charges
  • Cancelled/invalid charges
  • Charges already fully invoiced

8 – Group Air Clearing Sales Charges by Bill To

When an Air Clearing file is selected for invoicing, the system must load the sales charges from the Air Clearing Sales section and group them by Bill To party.

Each distinct Bill To party should appear as a separate invoice group on the invoice screen.

Example:

PROFIX LTD

  Brokerage Fee    

  Bill of Entry

VOLVO LTD

  Documentation Fee

Each Bill To group should be processed using the existing Process Invoice button.

If multiple Bill To groups exist, the user should also be able to use Process All Invoices to process all groups using the existing invoice logic.

The grouping must be based on the Bill To value maintained on each Air Clearing Sales charge line, not only on the shipper, consignee, or clearing file customer.

This is important because one Air Clearing File may contain sales charges billed to different parties.

9 – Invoice Header Information

When an Air Clearing file is selected, the invoice detail screen should show Air Clearing / Air shipment information.

The current invoice screen header may remain structurally the same, but field labels should be Air-appropriate where required.

Recommended header title: "Air Clearing Information" or "Airway Bill Information"

10 – Air Clearing Header Field Mapping

For Air Clearing invoices, the system should reuse the Airway Bill Information style already used for HAWB invoices, but add the Air Clearing-specific fields.

The header should display the following fields where data is available:

Field Source
Clearing Ref Air Clearing reference
MAWB Ref MAWB reference, if available
HAWB Ref HAWB reference, if available
BOE ref. BOE references linked to the Air Clearing file
Airline Airline
Flight Number Flight number
Airport of Origin Origin airport
Airport of Destination Destination airport
Cargo Type Import / Export
Shipper Shipper / Exporter
Consignee Consignee / Importer
Weight Weight, if available
Volume (m3) Volume, if available
Description Description / Nature of goods

11 – BOE Reference Display in Header

When an Air Clearing file is selected for invoicing, the system should display the BOE reference(s) linked to that Air Clearing File in the invoice header.

Use one field:

BOE Ref.

If multiple BOEs exist, concatenate all BOE references in one field, separated by commas.

Example:

BOE Ref.: 43150603693/0, 56555089104/0

If no BOE exists, the field may remain blank or display:

BOE Ref.: -

12 – Invoice Charges Grid Remains Unchanged

The Invoice Charges grid should remain unchanged.

Existing columns such as the following should continue to be used:

  • Charge Code
  • Description
  • Currency
  • Prepaid / Collect
  • Amount Excl. VAT
  • VAT
  • Discount Value
  • Exchange Rate
  • Total Amount

For Air Clearing, the values must come from the Air Clearing Sales section.

13 Existing Invoice Buttons Remain Unchanged

The following buttons and behaviours should remain unchanged:

  • Process Invoice
  • Process All Invoices
  • Create Invoices for Selected
  • Add +
  • Search
  • Reset
  • Back
  • Generated Invoice list
  • Remarks
  • Activity Log

This ticket is only to add Air Clearing as an additional selectable source for Air Invoice.

14 – Generated Invoice Linkage

Invoices generated from Air Clearing must be linked to:

Air Clearing File ID

This is important because the Air Clearing workflow will later check whether a standard invoice exists before allowing cancellation.

12 – Activity Log

When an invoice is generated from an Air Clearing file, the system must add an entry in the Air Clearing Activity Log.

Examples:

<username> saved and generated a DRAFT invoice.

<username> saved and generated a PROFORMA invoice with reference: <INVOICE_REF>

<username> saved and generated a STANDARD invoice with reference: <INVOICE_REF>

The log should appear inside the Air Clearing file Activity Log section.

Validation Rules

Scenario Rule
Date range blank Must not search without date range
No Air Clearing sales charges Do not allow invoice processing
Sales charge already invoiced Follow existing invoice rules
Air Clearing file Cancelled Should not be selectable for invoice or do not bring as per existing rules for ocean
Air Clearing file Draft / Completed Can be selectable if sales charges are valid
Standard invoice already generated Prevent duplicate standard invoice if existing logic does so
BOE references Display concatenated in header if multiple exist

Suggested Error Messages

Scenario Message
No sales charges No sales charges available for invoice.
Cancelled file Cancelled Air Clearing files cannot be invoiced.
Already invoiced One or more selected charges have already been invoiced.
Date range missing Please select a date range.

Use existing system messages where already available.

Acceptance Criteria

1 – Air Clearing Tab Displayed

Given I open the Proceed for Air Invoice popup,
When the popup loads,
Then I should see a new tab:

  • Air Clearing

alongside:

  • House Air Way Bill (HAWB)
  • Master Air Way Bill (MAWB)

2 – Air Clearing Search Filters Displayed

Given I click the Air Clearing tab,
When the tab opens,
Then I should see filters for:

  • Clearing Reference
  • HAWB Reference
  • MAWB Reference
  • Cargo Type
  • Date Range

3 – Search Air Clearing Files

Given I enter valid search criteria,
When I click Search,
Then the system should display matching Air Clearing files only.

4 – Display Air Clearing Grid

Given Air Clearing records exist,
When search results load,
Then the grid should display Air Clearing details including:

  • Clearing Reference
  • HAWB Reference
  • MAWB Reference
  • Airport of Origin
  • Airport of Destination
  • Cargo Type
  • Airline Name
  • Created On
  • Action

5 – Expand Air Clearing Row

Given an Air Clearing record is displayed,
When I click the expand icon,
Then the system should show:

  • Bill To / client summary
  • BOE details

6 – Add Single Air Clearing File

Given an Air Clearing file has valid sales charges,
When I click the + button,
Then the system should load the Air Clearing file into the invoice screen.

7 – Load Sales Charges Only

Given an Air Clearing file is selected,
When the invoice screen loads,
Then the system should display sales charges from the Air Clearing Sales section only.

8 – Group Charges by Bill To

Given an Air Clearing file contains sales charges for more than one Bill To party,
When the file is selected for invoicing,
Then the invoice screen should display the sales charges grouped by Bill To party.

9 – Process Invoice per Bill To Group

Given the invoice screen displays multiple Bill To groups,
When I click Process Invoice for one group,
Then the system should generate an invoice only for that selected Bill To group.

10 – Process All Bill To Groups

Given the invoice screen displays multiple Bill To groups,
When I click Process All Invoices,
Then the system should process invoices for all Bill To groups using the existing invoice logic.

11 – Display Air Clearing Header

Given I select an Air Clearing file for invoicing,
When the invoice screen loads,
Then the header section should display an air-related title such as:

  • Air Clearing Information

and should not display:

  • Bill of Lading Information

12 – Display Air Clearing Header Fields

Given I select an Air Clearing file for invoicing,
When the invoice screen loads,
Then the header should display air-related fields such as:

  • Clearing Ref.
  • File Ref.
  • MAWB Ref.
  • HAWB Ref.
  • BOE Ref.
  • Airline Name
  • Flight Number
  • Shipper
  • Consignee
  • Airport of Origin
  • Airport of Destination
  • Weight
  • Volume
  • Description

where values are available.

13 – Display BOE References

Given an Air Clearing File has one BOE,
When the file is selected for invoicing,
Then the invoice header should display that BOE reference.

Given an Air Clearing File has multiple BOEs,
When the file is selected for invoicing,
Then the invoice header should display all BOE references concatenated with commas.

Example:

BOE Ref.: 43150603693/0, 56555089104/0

Given an Air Clearing File has no BOE,
When the file is selected for invoicing,
Then the BOE Ref. field should display blank or -.

14 – Ocean Fields Not Displayed for Air Clearing

Given I select an Air Clearing file for invoicing,
When the invoice screen loads,
Then the system should not display sea-specific labels such as:

  • Vessel Name
  • Voyage Number
  • Container Reference
  • Bill of Lading Information

15 – Process Invoice

Given Air Clearing sales charges are loaded,
When I click Process Invoice,
Then the system should generate invoice using the existing invoice process.

16 – Process All Invoices

Given multiple Bill To groups exist,
When I click Process All Invoices,
Then the system should process invoices using the existing process all invoices logic.

17 – Create Invoices for Selected

Given I select one or more Air Clearing files using checkboxes,
When I click Create Invoices for Selected,
Then the system should create invoice preparation records using the selected Air Clearing files.

18 – Prevent Cancelled File Invoice

Given an Air Clearing file is Cancelled,
When the Air Clearing tab loads,
Then the Cancelled file should either not be displayed or should not be selectable for invoice.

19 – Invoice Linked to Air Clearing File

Given an invoice is generated from Air Clearing,
When the invoice is saved,
Then the invoice should be linked to the Air Clearing File ID.

20 – Activity Log Updated

Given an invoice is generated from Air Clearing,
When invoice generation is completed,
Then the system should add an invoice generation entry in the related Air Clearing Activity Log.


GitLab Sync Log

[]

Actions

Also available in: Atom PDF