GHC Invoicing Packages

High level overview diagrams

• Sequence diagram

info

TODO: this file is to describe specifics about what packages do. The sequence diagram above shows how they interact. Word descriptions, diagrams, or anything that makes sense to get into the details of the packages should go here. For the most part, I'd expect a paragraph or two. But when needed, can go deeper. Useful PRs are also something to consider. I do not expect the filenames to be left in this doc unless a file needs to be called out. But for now, they are here are a memory jogger of what these packages are and what to describe. Then the files names can be erased. I do think leaving the directory paths on this page is useful.

In the Bins and CLI tools, leaving the filenames might be useful, because only certain files pertain directly to invoicing.

Bins

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

ghc-pricing-parser used to read the pricing template and import data into the GHC rate engine. A fake pricing template was created to test with.

mymove/
├── bin
│   ├── generate-payment-request-edi
│   ├── ghc-pricing-parser
│   ├── prime-api-client
│   ├── send-to-gex

CLI tools

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

mymove/
├── cmd
│   ├── generate-payment-request-edi
│   │   ├── logger.go
│   │   └── main.go
│   ├── ghc-pricing-parser
│   │   └── main.go
│   ├── milmove
│   │   ├── bin
│   │   │   └── Mymove_server
│   ├── milmove-tasks
│   │   ├── connect_to_gex_via_sftp.go
│   │   ├── main.go
│   │   ├── post_file_to_gex.go
│   │   ├── process_edis.go
│   │   ├── save_ghc_fuel_price_data.go
│   ├── prime-api-client
│   │   ├── main.go
│   │   ├── prime
│   │   ├── support
│   │   │   ├── get_payment_request_edi.go
│   │   │   ├── hide_non_fake_move_task_orders.go
│   │   │   ├── process_reviewed_payment_requests.go
│   │   │   ├── recalculate_payment_request.go
│   │   │   └── update_payment_request_status.go
│   ├── send-to-gex
│   │   └── main.go

Payment Request

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

/mymove/pkg/payment_request
├── payment_request_helper.go
├── payment_request_helper_test.go
├── send_to_syncada.go
├── send_to_syncada_test.go
├── service_param_list_fetcher.go
├── service_param_list_valid.go
├── service_param_list_valid_test.go

Service Param Value Lookups

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

Initial PR to setup service item param lookup framework

/mymove/pkg/payment_request/service_param_value_lookups
└── service_param_value_lookups
    ├── actual_pickup_date_lookup.go
    ├── actual_pickup_date_lookup_test.go
    ├── contract_code_lookup.go
    ├── contract_code_lookup_test.go
    ├── cubic_feet_billed_lookup.go
    ├── cubic_feet_billed_lookup_test.go
    ├── cubic_feet_crating_lookup.go
    ├── cubic_feet_crating_lookup_test.go
    ├── dimension_height_lookup.go
    ├── dimension_height_lookup_test.go
    ├── dimension_length_lookup.go
    ├── dimension_length_lookup_test.go
    ├── dimension_width_lookup.go
    ├── dimension_width_lookup_test.go
    ├── distance_zip3_lookup.go
    ├── distance_zip3_lookup_test.go
    ├── distance_zip5_lookup.go
    ├── distance_zip5_lookup_test.go
    ├── distance_zip_sit_dest_lookup.go
    ├── distance_zip_sit_dest_lookup_test.go
    ├── distance_zip_sit_origin_lookup.go
    ├── distance_zip_sit_origin_lookup_test.go
    ├── eia_fuel_price_lookup.go
    ├── eia_fuel_price_lookup_test.go
    ├── fsc_weight_based_distance_multiplier_lookup.go
    ├── fsc_weight_based_distance_multiplier_lookup_test.go
    ├── lookup_query_helpers.go
    ├── lookup_query_helpers_test.go
    ├── mto_available_to_prime_at_lookup.go
    ├── mto_available_to_prime_at_lookup_test.go
    ├── not_implemented_lookup.go
    ├── number_days_sit_lookup.go
    ├── number_days_sit_lookup_test.go
    ├── psi_domestic_linehaul_lookup.go
    ├── psi_domestic_linehaul_lookup_test.go
    ├── requested_pickup_date_lookup.go
    ├── requested_pickup_date_lookup_test.go
    ├── service_area_lookup.go
    ├── service_area_lookup_test.go
    ├── service_param_value_lookups.go
    ├── service_param_value_lookups_test.go
    ├── service_params_cache.go
    ├── service_params_cache_test.go
    ├── services_schedule_lookup.go
    ├── services_schedule_lookup_test.go
    ├── sit_schedule_lookup.go
    ├── sit_schedule_lookup_test.go
    ├── weight_adjusted_lookup.go
    ├── weight_adjusted_lookup_test.go
    ├── weight_billed_lookup.go
    ├── weight_billed_lookup_test.go
    ├── weight_estimated_lookup.go
    ├── weight_estimated_lookup_test.go
    ├── weight_original_lookup.go
    ├── weight_original_lookup_test.go
    ├── weight_reweigh_lookup.go
    ├── weight_reweigh_lookup_test.go
    ├── zip_address_lookup.go
    ├── zip_address_lookup_test.go
    ├── zip_sit_origin_hhg_actual_address_lookup.go
    ├── zip_sit_origin_hhg_actual_address_lookup_test.go
    ├── zip_sit_origin_hhg_original_address_lookup.go
    └── zip_sit_origin_hhg_original_address_lookup_test.go

DB tools

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

mymove/pkg/services
├── db_tools.go
├── dbtools
│   ├── db_tools_service_test.go
│   ├── logger.go
│   ├── table_from_slice_creator.go
│   └── table_from_slice_creator_test.go

MilMove GHC FuelPrice

The GHC FuelPrice service is utilized by the milmove-tasks command save_ghc_fuel_price_data.go.

The task is scheduled to run 🔒daily at 5:30 AM EST via an AWS ECS task. Weekly price data is supposed to be released by the government around ~5PM EST on Mondays unless there is a holiday schedule.

The task calls the EIA API v2.1.0 to retrieve the weekly No. 2 diesel fuel price for the U.S. This weekly price is used in the pricing calculations for Fuel Surcharge service items. You can access their technical documentation here. With version 2.1.0 the EIA API added the seriesid endpoint. This allows us to use the series_id url parameter that we used in the v1 api as a keyword path parameter. The specific path we use is https://api.eia.gov/v2/seriesid/PET.EMD_EPD2D_PTE_NUS_DPG.W.

The package is made up of four main files and accompanying test files:

• ghc_diesel_fuel_price_data.go
  • Defines the Diesel Fuel Price Info Struct, which contains the EIA data struct and is instantiated with the function that will fetch the EIA data
  • The EIA Data struct is shaped to model the response data that is returned from the EIA API and is populated when the fetcher function unmarshals the JSON data returned from the API call.
• ghc_diesel_fuel_price_fetcher.go
  • Includes the function for fetching the fuel data from the EIA API and populating the EIA data struct
  • Also calls the EIA Data validator
• ghc_diesel_fuel_price_validator.go
  • validates different values returned by the EIA API to ensure that we have retrieved the correct price information.
  • values we validate:
    • duoarea - must be NUS
    • area-name - must be U.S.
    • frequency - must be weekly
    • date format - must match a key in the map retrieved from the function getEIADateFormatMap
    • product - must be EPD2D
    • process - must be PTE
    • series - must be EMD_EPD2D_PTE_NUS_DPG
    • units - must be $/gal
    • fuel data array - must have a length greater than zero
• ghc_diesel_fuel_price_storer.go
  • takes the retrieved EIA data and checks the ghc_diesel_fuel_prices table if there is already an entry for that period.
  • If there is an entry, it updates the price if it differs.
  • If there isn't then a new entry is created

GHC Import

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

mymove/pkg/services
├── ghcimport
│   ├── fixtures
│   │   ├── re_services_data.sql
│   │   └── stage_ghc_pricing.sql
│   ├── ghc_rateengine_importer.go
│   ├── ghc_rateengine_importer_test.go
│   ├── import_re_contract.go
│   ├── import_re_contract_test.go
│   ├── import_re_contract_years.go
│   ├── import_re_contract_years_test.go
│   ├── import_re_domestic_accessorial_prices.go
│   ├── import_re_domestic_accessorial_prices_test.go
│   ├── import_re_domestic_linehaul_prices.go
│   ├── import_re_domestic_linehaul_prices_test.go
│   ├── import_re_domestic_other_prices.go
│   ├── import_re_domestic_other_prices_test.go
│   ├── import_re_domestic_service_area.go
│   ├── import_re_domestic_service_area_prices.go
│   ├── import_re_domestic_service_area_prices_test.go
│   ├── import_re_domestic_service_area_test.go
│   ├── import_re_intl_accessorial_prices.go
│   ├── import_re_intl_accessorial_prices_test.go
│   ├── import_re_intl_other_prices.go
│   ├── import_re_intl_other_prices_test.go
│   ├── import_re_intl_prices.go
│   ├── import_re_intl_prices_test.go
│   ├── import_re_rate_area.go
│   ├── import_re_rate_area_test.go
│   ├── import_re_shipment_type_prices.go
│   ├── import_re_shipment_type_prices_test.go
│   ├── import_re_task_order_fees.go
│   ├── import_re_task_order_fees_test.go
│   ├── load_service_map.go
│   ├── load_service_map_test.go
│   ├── logger.go
│   ├── map_zip_codes_to_re_rate_areas.go
│   ├── map_zip_codes_to_re_rate_areas_test.go
│   ├── shared.go
│   ├── shared_test.go
│   ├── zip3_to_rate_area_mappings.go
│   └── zip5_to_rate_area_mappings.go

GHC Rate Engine

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

mymove/pkg/services
├── ghc_rate_engine.go
├── ghcrateengine
│   ├── counseling_services_pricer.go
│   ├── counseling_services_pricer_test.go
│   ├── domestic_crating_pricer.go
│   ├── domestic_crating_pricer_test.go
│   ├── domestic_destination_additional_days_sit_pricer.go
│   ├── domestic_destination_additional_days_sit_pricer_test.go
│   ├── domestic_destination_first_day_sit_pricer.go
│   ├── domestic_destination_first_day_sit_pricer_test.go
│   ├── domestic_destination_pricer.go
│   ├── domestic_destination_pricer_test.go
│   ├── domestic_destination_shuttling_pricer.go
│   ├── domestic_destination_shuttling_pricer_test.go
│   ├── domestic_destination_sit_delivery_pricer.go
│   ├── domestic_destination_sit_delivery_pricer_test.go
│   ├── domestic_linehaul_pricer.go
│   ├── domestic_linehaul_pricer_test.go
│   ├── domestic_origin_additional_days_sit_pricer.go
│   ├── domestic_origin_additional_days_sit_pricer_test.go
│   ├── domestic_origin_first_day_sit_pricer.go
│   ├── domestic_origin_first_day_sit_pricer_test.go
│   ├── domestic_origin_pricer.go
│   ├── domestic_origin_pricer_test.go
│   ├── domestic_origin_shuttling_pricer.go
│   ├── domestic_origin_shuttling_pricer_test.go
│   ├── domestic_origin_sit_pickup_pricer.go
│   ├── domestic_origin_sit_pickup_pricer_test.go
│   ├── domestic_pack_pricer.go
│   ├── domestic_pack_pricer_test.go
│   ├── domestic_shorthaul_pricer.go
│   ├── domestic_shorthaul_pricer_test.go
│   ├── domestic_uncrating_pricer.go
│   ├── domestic_uncrating_pricer_test.go
│   ├── domestic_unpack_pricer.go
│   ├── domestic_unpack_pricer_test.go
│   ├── fuel_surcharge_pricer.go
│   ├── fuel_surcharge_pricer_test.go
│   ├── ghc_rate_engine_service_test.go
│   ├── management_services_pricer.go
│   ├── management_services_pricer_test.go
│   ├── param_convert.go
│   ├── param_convert_test.go
│   ├── pricer_formatters.go
│   ├── pricer_formatters_test.go
│   ├── pricer_helpers.go
│   ├── pricer_helpers_test.go
│   ├── pricer_query_helpers.go
│   ├── pricer_query_helpers_test.go
│   ├── service_item_pricer.go
│   ├── service_item_pricer_test.go
│   ├── shared.go
│   └── shared_test.go

Invoice

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

mymove/pkg/services
├── invoice
│   ├── gex_sender_http.go
│   ├── gex_sender_http_test.go
│   ├── ghc_payment_request_invoice_generator.go
│   ├── ghc_payment_request_invoice_generator_test.go
│   ├── invoice_service_test.go
│   ├── invoice_upload_updater.go
│   ├── process_edi824.go
│   ├── process_edi824_test.go
│   ├── process_edi997.go
│   ├── process_edi997_test.go
│   ├── sftp_client_wrapper.go
│   ├── store_invoice.go
│   ├── syncada_sftp_reader.go
│   ├── syncada_sftp_reader_test.go
│   ├── syncada_sftp_sender.go
│   └── syncada_sftp_sender_test.go
├── invoice.go

MTO Shipment Updater

TODO: Add description

• Add description for this package/section.
• After description is added, filenames (unless it is useful to leave here) can be removed.
• Leave directory names in section.
• Be sure to leave filename if the whole package doesn't pertain to invoicing. Leaving only the filenames that are important to invoicing. (E.g., bin and cmd packages. )

updateShipmentRecord calls ShipmentRecalculatePaymentRequest

mymove/pkg/services
├── mto_shipment
│   ├── mto_shipment_updater.go
│   ├── mto_shipment_updater_test.go
├── mto_shipment.go

Payment Request

mymove/pkg/services
├── payment_request
│   ├── payment_request_creator.go
│   ├── payment_request_creator_test.go
│   ├── payment_request_fetcher.go
│   ├── payment_request_fetcher_test.go
│   ├── payment_request_list_fetcher.go
│   ├── payment_request_list_fetcher_test.go
│   ├── payment_request_recalculator.go
│   ├── payment_request_recalculator_test.go
│   ├── payment_request_reviewed_fetcher.go
│   ├── payment_request_reviewed_fetcher_test.go
│   ├── payment_request_reviewed_processor.go
│   ├── payment_request_reviewed_processor_test.go
│   ├── payment_request_service_test.go
│   ├── payment_request_shipment_recalculate.go
│   ├── payment_request_shipment_recalculate_test.go
│   ├── payment_request_shipments_sit_balance.go
│   ├── payment_request_shipments_sit_balance_test.go
│   ├── payment_request_status_updater.go
│   ├── payment_request_status_updater_test.go
│   ├── upload_creator.go
│   └── upload_creator_test.go
├── payment_request.go

Reweigh Updater

doUpdateReweigh calls ShipmentRecalculatePaymentRequest

mymove/pkg/services
├── reweigh
│   ├── reweigh_updater.go
│   ├── reweigh_updater_test.go
├── reweigh.go