Table of Contents

Terms

Definitions of terms used in this document can be found in the glossary.

Country/Company/Account Model

BravoTran maps a company in the FFS to an account in BravoTran. Often a company represents a country in the FFS. It’s ok to have more than one account in BravoTran for a country if that country has multiple companies, but it’s not ok to have one account in BravoTran represent multiple companies / countries. BravoTran will discuss this with you before starting the implementation.

General

updated_at – ISO 8601 timestamp (ex 2024-04-25T08:00:00Z) of when the entity was last updated. BravoTran uses this as a “version” to prevent overwriting with old data if updates get out of sync.
- This should be whenever any applicable data was updated, for example, with jobs, if an accrual is added or edited, this timestamp should update. If a shipment is added to a consol, both the shipment and consol updated_at should change.
external_id – unique and immutable identifier for the entity used as a “foreign key” between BravoTran and the FFS. This will be used in “upserts” to BravoTran’s database.
- If multiple tables are being combined into the orgs file, these should be prefixed with what type they are to keep the external_id unique in BravoTran. For example, vendor-123
- This is not visible to the end user and is often the primary key in the database.
[x] – represents an index in what would be an array in JSON.
- For example, a job can have multiple way_bills, so there would be way_bill_1_number, way_bill_1_type, way_bill_2_number, way_bill_2_type, etc. We don’t care if they’re 0 or 1 indexed, just as long as they’re unique.
Whenever there is an amount there should be a corresponding currency.
Order of columns doesn’t matter.

Outbound

FFS → BravoTran

Filename Conventions

Each file should have the entity type as well as a unix timestamp to ensure files don’t get overwritten if there is a delay processing them by BravoTran.

[ENTITY_TYPE]-[UNIX_TIMESTAMP].csv

Uploading to the SFTP

When uploading files to the SFTP they must be uploaded as [ENTITY_TYPE]-[UNIX_TIMESTAMP].csv.part and then renamed to [ENTITY_TYPE]-[UNIX_TIMESTAMP].csv once complete. This will ensure BravoTran doesn’t start importing partial files.