API Information

Integration Types & Schemas

Accounting Automation - Jobs

Send job data with accruals.

Objects

Name	Description
Root
MasterBillJob	A job data set representing cargo moved under a master bill of lading.
HouseBillJob	A job data set representing cargo moved under a house bill of lading.
Party	Represents a named party on a job.
PartyIdentifier	A code and context that can be used to uniquely identify a party.
PhoneNumber	A phone number and type object.
EmailAddress	An email address and type object.
CustomProperties	An object an input converter can utilize to pass any custom data back into a flow that can potentially be utilized by an output converter.
Location	A unique location.
UnLocode	A location representing a UN location code.
AirPort	A location representing an airport.
Address	A location representing a street address.
Weight
Volume
Accrual	An accrual is an expense or revenue item that is recorded in an accounting ledger as the services are provided, rather than when payment is made or received. An accrual will eventually be referenced as a line item on an AR or AP invoice.
Operator	A user in the accounting system.
AccrualAmount	The amount portion of the accrual and any subsequent invoicing information.
InvoiceAmount	An monetary amount that appears on the invoice in the billing currency.
AccountingAmount	A monetary amount that is associated with the invoice amount in an alternate currency.
AccrualInvoice	An AR or AP invoice that has been issued the references an accrual.
MasterBillJob_containers
HouseBillJob_containers
HouseBillJob_commercial_invoices
HouseBillJob_purchase_orders
Party_contact	A point of contact at the party.

Root top

Name	Data Type	Description	Required

MasterBillJob top

Name	Data Type	Description	Required
`job_type`	String	An indicator of the type of job being represented. Allowed values: master_bill_of_lading.	YES
`job_identifier`	String	The 'primary key' uniquely identifying the job in the issuer's accounting / tms system. For some systems, this may be the same as the job_reference.	YES
`job_reference`	String	A 'natural key' identifying the job in the issuer's accounting / tms system. This will typically be a more user friendly variant of the job_identifier. While a job_identifier can potentially be an unrelated id like a guid or numeric database id, the job_reference will typically represent a value that is presented to users to identify the job.	YES
`transport_mode`	String	The primary means of transport of the goods on their journey. Allowed values: sea, air, road, rail, sea_air, air_sea, inland_waterway, courier, rail_sea, rail_air, rail_road.
`master_bill_of_lading`	String	The master bill of lading number the carrier has assigned to this shipment.
`vessel_name`	String	The name of the vessel associated with the job.
`imo_number`	String	The International Maritime Organization (IMO) number of the ocean vessel. This should be the 7 digit number only.
`voyage_number`	String	The voyage number associated with the job. This can represent an ocean vessel's voyage number, a flight number or any other number that identifies the voyage routing.
`carrier`	Party	The party responsible for physically transporting the goods on the job.
`origin_agent`	Party	The freight forwarder facilitating the export process.
`destination_agent`	Party	The freight forwarder facilitating the import process.
`consignor`	Party	The party sending a shipment. May also be referred to as the sender, shipper or exporter. This represents the actual shipper party named on the master bill.
`consignee`	Party	The party financially responsible for receipt of a shipment. Typically, but not always, the consignee is the receiver of the shipment as well as the importer of record. This represents the actual consignee party named on the master bill.
`customer`	Party	The customer that is contracting the forwarder to move the goods.
`pickup`	Address	The physical original point of the shipment where the goods are retrieved from.
`place_of_receipt`	UnLocode \| AirPort	The location where goods are handed over to the carrier by the consignor or their agent.
`port_of_loading`	UnLocode \| AirPort	The port where goods are loaded by the carrier on to the vessel.
`port_of_discharge`	UnLocode \| AirPort	The port where goods are offloaded from the vessel by the carrier.
`place_of_delivery`	UnLocode \| AirPort	The location where goods are handed over from the carrier to the consignee or their agent.
`delivery`	Address	The physical destination point of the shipment where the goods are sent to.
`gross_weight`	Weight	The gross weight of goods on the job.
`chargeable_weight`	Weight	The chargeable weight of goods on the job.
`volume`	Volume	The total volume of the goods on the job.
`estimated_pickup_date`	DateTime	The estimated date the goods will be picked up from the origin point.
`pickup_date`	DateTime	The actual date the goods were picked up from the origin point.
`estimated_departure_date`	DateTime	The estimated date the goods will depart from the port of loading.
`departure_date`	DateTime	The actual date the goods departed from the port of loading.
`estimated_arrival_date`	DateTime	The estimated date the goods will arrive at the port of discharge.
`arrival_date`	DateTime	The actual date the goods arrived at the port of discharge.
`estimated_delivery_date`	DateTime	The estimated date the goods will be delivered.
`delivery_date`	DateTime	The actual date the goods were delivered.
`freight_payment_terms`	String	The freight terms of payment indicating the party responsible for freight charges. Allowed values: collect, prepaid, third_party.
`containerization_type`	String	The container load type used for the job. Allowed values: fcl, lcl, ftl, ltl.
`containers`	Array<MasterBillJob_containers>	All containers associated with the job.
`accruals`	Array<Accrual>	All accounting accruals associated directly with the job.
`house_bills_of_lading`	Array<HouseBillJob>	All house bill jobs moving under the same master bill.
`custom_properties`	CustomProperties
`created_at`	DateTime	The date this record was created.
`updated_at`	DateTime	The date this record was updated.

HouseBillJob top

Name	Data Type	Description	Required
`job_type`	String	An indicator of the type of job being represented. Allowed values: house_bill_of_lading.	YES
`job_identifier`	String	The 'primary key' uniquely identifying the job in the issuer's accounting / tms system. For some systems, this may be the same as the job_reference.	YES
`job_reference`	String	A 'natural key' identifying the job in the issuer's accounting / tms system. This will typically be a more user friendly variant of the job_identifier. While a job_identifier can potentially be an unrelated id like a guid or numeric database id, the job_reference will typically represent a value that is presented to users to identify the job.	YES
`direction`	String	The directionality of the job that is being billed. foreign_to_foreign is also known as triangle, third-party or cross-trade shipments. Allowed values: import, export, domestic, foreign_to_foreign.
`transport_mode`	String	The primary means of transport of the goods on their journey. Allowed values: sea, air, road, rail, sea_air, air_sea, inland_waterway, courier, rail_sea, rail_air, rail_road.
`master_bill_of_lading`	String	The master bill of lading number the carrier has assigned to this shipment.
`house_bill_of_lading`	String	The house bill of lading number the forwarder has assigned to this shipment.
`vessel_name`	String	The name of the vessel associated with the job.
`imo_number`	String	The International Maritime Organization (IMO) number of the ocean vessel. This should be the 7 digit number only.
`voyage_number`	String	The voyage number associated with the job. This can represent an ocean vessel's voyage number, a flight number or any other number that identifies the voyage routing.
`carrier`	Party	The party responsible for physically transporting the goods on the job.
`consignor`	Party	The party sending a shipment. May also be referred to as the sender, shipper or exporter. This represents the actual shipper party named on the master bill.
`consignee`	Party	The party financially responsible for receipt of a shipment. Typically, but not always, the consignee is the receiver of the shipment as well as the importer of record. This represents the actual consignee party named on the master bill.
`customer`	Party	The customer that is contracting the forwarder to move the goods.
`pickup`	Address	The physical original point of the shipment where the goods are retrieved from.
`port_of_loading`	UnLocode \| AirPort	The port where goods are loaded by the carrier on to the vessel.
`port_of_discharge`	UnLocode \| AirPort	The port where goods are offloaded from the vessel by the carrier.
`delivery`	Address	The physical destination point of the shipment where the goods are sent to.
`gross_weight`	Weight	The gross weight of goods on the job.
`chargeable_weight`	Weight	The chargeable weight of goods on the job.
`volume`	Volume	The total volume of the goods on the job.
`estimated_pickup_date`	DateTime	The estimated date the goods will be picked up from the origin point.
`pickup_date`	DateTime	The actual date the goods were picked up from the origin point.
`estimated_departure_date`	DateTime	The estimated date the goods will depart from the port of loading.
`departure_date`	DateTime	The actual date the goods departed from the port of loading.
`estimated_arrival_date`	DateTime	The estimated date the goods will arrive at the port of discharge.
`arrival_date`	DateTime	The actual date the goods arrived at the port of discharge.
`estimated_delivery_date`	DateTime	The estimated date the goods will be delivered.
`delivery_date`	DateTime	The actual date the goods were delivered.
`description_of_goods`	String	A generalized description of the type of goods moving on the job.
`freight_payment_terms`	String	The freight terms of payment indicating the party responsible for freight charges. Allowed values: collect, prepaid, third_party.
`inco_terms`	String	The terms of sale defining the responsibilities of the consignor/seller and consignee/buyer. Expired terms dat, daf, des, deq, ddu are included for backwards compatibility sake, though it is very highly recommended to no longer utilize them. Allowed values: exw, fca, fas, fob, cfr, cif, cpt, cip, dap, dpu, ddp, dat, daf, des, deq, ddu.
`inco_terms_location`	String	The named place or port in the inco terms defining the location the terms are applicable for. Using terms of "FOB CNYTN" the location would be CNYTN
`containerization_type`	String	The container load type used for the job. Allowed values: fcl, lcl, ftl, ltl.
`containers`	Array<HouseBillJob_containers>	All containers associated with the job.
`commercial_invoices`	Array<HouseBillJob_commercial_invoices>	All commercial invoices associated with the job.
`purchase_orders`	Array<HouseBillJob_purchase_orders>	All purchase orders associated with the job.
`accruals`	Array<Accrual>	All accounting accruals associated directly with the job.
`custom_properties`	CustomProperties
`created_at`	DateTime	The date this record was created.
`updated_at`	DateTime	The date this record was updated.

Party top

Name	Data Type	Description
`identifiers`	Array<PartyIdentifier>	An array of all applicable identifiers that can be used to identify the party.
`name`	String	The entity's name.
`address_1`	String	The address' street number and name.
`address_2`	String	The address' secondary address information.
`city`	String	The address' city component.
`country_subdivision`	String	The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data.
`country`	String	The address' 2 character ISO-3166-2 country Code.
`postal_code`	String	The unique postal code identifier for the address.
`contact`	Party_contact	A point of contact at the party.
`custom_properties`	CustomProperties

PartyIdentifier top

Name	Data Type	Description	Required
`code`	String	The identifier code	YES
`code_type`	String	The type of data that the identifier code represents. Allowed values: accounting_system_external_identifier, tax_id, iata, scac, legal_entity_id, duns.	YES
`code_country`	String	The 2 character ISO-3166-2 country code that the id code was issued in / by.

PhoneNumber top

Name	Data Type	Description	Required
`phone_type`	String	The type of phone number. Allowed values: main, mobile, work, home, fax, other.	YES
`phone_number`	String	The actual phone number. When at all possible, to increase interoperability, phone numbers should be formatted according to RFC3966. Also see libphonenumber when parsing phone numbers.	YES

EmailAddress top

Name	Data Type	Description	Required
`email_type`	String	The type of email address. Allowed values: main, work, personal, other.	YES
`email_address`	String	The email address	YES

CustomProperties top

Name	Data Type	Description	Required

Location top

Name	Data Type	Description	Required

UnLocode top

Name	Data Type	Description	Required
`type`	String	A location type identifier Allowed values: unlocode.	YES
`unlocode`	String	The UN/Locode identifier for the sea port.	YES
`unlocode_description`	String	A free text description of the UN/Locode.

AirPort top

Name	Data Type	Description	Required
`type`	String	A location type identifier Allowed values: airport.	YES
`iata_code`	String	The IATA airport location identifier.	YES
`iata_code_description`	String	A free text description of the IATA Code.
`unlocode`	String	The UN/Locode identifier correlated with the IATA code.

Address top

Name	Data Type	Description	Required
`type`	String	A location type identifier. Allowed values: address.	YES
`name`	String	A name for the address. Typically the name of the business located at the address.
`address_1`	String	The address' street number and name.	YES
`address_2`	String	The address' secondary address information.
`city`	String	The address' city component.	YES
`country_subdivision`	String	The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data.
`country`	String	The address' 2 character ISO-3166-2 country Code.	YES
`postal_code`	String	The unique postal code identifier for the address.
`unlocode`	String	A UN/Locode identifier correlated with the address.
`unlocode_description`	String	A free text description of the UN/Locode.

Weight top

Name	Data Type	Description	Required
`amount`	Decimal	The numeric weight amount	YES
`unit`	String	The unit of measure associated with the amount property. tonne = Metric Tonne (1,000 kilograms), ton = Imperial Tonne (1,000 pounds) Allowed values: kilogram, tonne, pound, ton.	YES

Volume top

Name	Data Type	Description	Required
`amount`	Decimal	The numeric volume amount	YES
`unit`	String	The unit of measure associated with the amount property. gallon - US liquid gallon (3.785411784 litres), imperial_gallon = UK gallon (4.54609 litres) Allowed values: cubic_meter, cubic_foot, liter, gallon, imperial_gallon.	YES

Accrual top

Name	Data Type	Description
`accounting_system_identifier`	String	The 'primary key' uniquely identifying the accrual in the issuer's accounting system. Some systems will not have identifiers for individual accruals, in these cases, the property can be omitted.
`line_number`	Decimal	A line number that can be used to sort the invoice lines in the correct presentation order. The number must be greater than 0.
`charge_code`	String	A code used by the issuer's accounting system to identify the goods or service associated with the charge.
`charge_classification`	String	A code used by the issuer's accounting system that classifies the type of charge.
`description`	String	A description of the goods or services associated with the line.
`cost`	AccrualAmount	The cost portion of the accrual.
`revenue`	AccrualAmount	The revenue portion of the accrual.
`operator`	Operator	The operator (forwarder's clerk) responsible for managing the accrual.
`department_code`	String	A code used by the issuer's accounting system to identify the department linked to the accrual. The department code will typically identify the line of business associated with the accrual. You might see a code here identifying the accrual as being issued by the Forwarding Air Import department or something similar.
`branch_code`	String	A code used by the issuer's accounting system to identify the branch linked to the accrual. A branch is typically associated with a physical location thus may also be referred to as an office code.
`custom_properties`	CustomProperties

Operator top

Name	Data Type	Description	Required
`accounting_system_identifier`	String	The 'primary key' uniquely identifying the user in the issuer's accounting system. Typically, this will be the operator's username.	YES
`name`	String	The operator's full name.
`phone_numbers`	Array<PhoneNumber>
`email_addresses`	Array<EmailAddress>

AccrualAmount top

Name	Data Type	Description	Required
`invoice_amount`	InvoiceAmount	The amount as defined in the currency that the accrual will ultimately be invoice in.	YES
`accounting_system_amount`	AccountingAmount	The amount as defined in the currency that the accrual is recorded in in the accounting system.
`posted`	Boolean	Indicates whether the accrual has been invoiced or not.
`creditor`	Party	The party that is owed payment. On a cost accrual, this is typically a carrier, a customs broker, or other logistics provider that the forwarder is contracting with and paying directly. For revenue accruals, this is typically the forwarder.
`debtor`	Party	The party that must remit payment. On a revenue accrual, this is typically the forwarder's customer. On a cost accrual, this is typically the forwarder.
`invoice`	AccrualInvoice
`apportioned_from_job`	String	The job identifier that this accrual has been apportioned or prorated from. Apportionment is a process that prorates cost or revenue amounts from a higher level job, like a master bill, to a lower level job, like a house bill. As an example, freight costs are typically accrued against the master bill job and then apportioned to each individual house bill job. In this scenario, if this accrual amount represented the house bill's freight accrual, the apportioned_from_job property would represent the master bill's job identifier.

InvoiceAmount top

Name	Data Type	Description	Required
`total`	Decimal	The total amount including taxes/vat.	YES
`currency`	String	The ISO 4217 currency code indicating the currency the amount is billed in.	YES
`subtotal`	Decimal	The invoice amount without tax/vat.
`total_tax`	Decimal	The tax/vat amount associated with the invoice amount.

AccountingAmount top

Name	Data Type	Description	Required
`total`	Decimal	The total amount including taxes/vat.	YES
`currency`	String	The ISO 4217 currency code indicating the currency the amount is billed in.	YES
`subtotal`	Decimal	The invoice amount without tax/vat.
`total_tax`	Decimal	The tax/vat amount associated with the invoice amount.
`exchange_rate`	Decimal	The exchange rate representing the conversion of this object's total to the invoice amount's total. The rate is represented as a decimal percentage (.ie 100% = 1.0). The conversion formula is simply this object's total * exchange_rate = invoice_amount.total.	YES

AccrualInvoice top

Name	Data Type	Description	Required
`accounting_system_identifier`	String	The 'primary key' uniquely identifying the invoice in the issuer's accounting system. For some systems, this may be the same as the invoice_number.
`invoice_number`	String	An external identifier for the invoice. Typically, the invoice number is either unique accross the entire accounting system or unique per debtor.	YES
`invoice_date`	String	The date that is the basis for all invoice aging purposes such as the due date and any terms based discounts.
`due_date`	String	The date the debtor must pay the creditor in full.

MasterBillJob_containers top

Name	Data Type	Description	Required
`container_number`	String	The ISO 6346 11 digit unique container identifier.	YES

HouseBillJob_containers top

Name	Data Type	Description	Required
`container_number`	String	The ISO 6346 11 digit unique container identifier.	YES

HouseBillJob_commercial_invoices top

Name	Data Type	Description	Required
`invoice_number`	String	The unique tracking number assigned to the commercial invoice by the seller.	YES

HouseBillJob_purchase_orders top

Name	Data Type	Description	Required
`order_number`	String	The unique tracking number assigned to the purchase order by the seller.	YES

Party_contact top

Name	Data Type	Description
`name`	String	The name of the contact
`phone_numbers`	Array<PhoneNumber>
`email_addresses`	Array<EmailAddress>

Introduction to Open Connect

API Information

Integration Types & Schemas

Accounting Automation - Jobs

Objects