Introduction
The TAI software is a sophisticated TMS that allows for management of freight loads in detail. TAI works best when paired with Salesforce as the front-end CRM capability. Data can be initiated from Salesforce and sent into TAI as the customer opportunity is created. In addition, details about shipments can be returned into Salesforce so that the sales reps/brokers can see status information about loads that they've processed.
Function Overview
The different connectors enabled are set up to send required data from Salesforce to initiate capabilities in TAI. There are also functions that allow the retrieval of this data from TAI for display and/or reporting in Salesforce
Implementation Strategy
The typical implementation will be to map as much information as is available in the Salesforce objects into TAI, and then send that information to TAI when the business justification for initiating delivery has been reached. You will need to add information onto Salesforce records so that you can store the TAI record ids for these items - as it is required for later communication with TAI to identify records using their TAI record identifiers.
Implementation Instructions
Delete Commissions
text
Get Accounting Profile
text
Get Commissions
text
Get Customer
text
Get Shipment
text
Post Carrier
text
Post Commission
text
Post Customer
text
Post Shipment
text
Post Staff
text
Put Accounting Profile
text
Put Carrier
text
Put Customer
text
Put Staff
text
API Function Data Dictionary
This document provides details on the Nexus API fields, their event types, and data types, grouped by API function.
DELETE Commissions
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| commissionId | Outbound | Number |
GET AccountingProfile
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| preferredInvoicingMethod | Inbound | Text |
| statementDeliveryFrequency | Inbound | Text |
| collectionNoticeDeliveryFrequency | Inbound | Text |
| invoicingAutomationMethod | Inbound | Text |
| enablePastDueNotification | Inbound | Boolean |
| OriginatingRecordId | Inbound | Text |
| paymentPreference | Inbound | Text |
| creditLimit | Inbound | Number |
| podRequiredWithInvoice | Inbound | Boolean |
| bolRequiredWithInvoice | Inbound | Boolean |
| includeShipmentOwnerOnInvoice | Inbound | Boolean |
| allowZeroMarginInvoiceAutomation | Inbound | Boolean |
| organizationId | Outbound | Number |
GET Commissions
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| amountMaximum | Inbound | Number |
| ignoreHouseCommission | Inbound | Boolean |
| calculationType | Inbound | Text |
| organizationId | Inbound | Number |
| rate | Inbound | Number |
| commissionId | Inbound | Number |
| OriginatingRecordId | Inbound | Text |
| staffId | Inbound | Number |
| inHouseCommission | Inbound | Boolean |
| sourceOrganizationId | Inbound | Number |
| amountMinimum | Inbound | Number |
| priority | Inbound | Number |
| shipmentTypes | Inbound | Text |
| OrganizationId | Outbound | Number |
GET Customer
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| name | Inbound | Text |
| streetAddress | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| city | Inbound | Text |
| state | Inbound | Text |
| zipCode | Inbound | Text |
| country | Inbound | Text |
| phone | Inbound | Text |
| mobile | Inbound | Text |
| fax | Inbound | Text |
| enabled | Inbound | Boolean |
| webAddress | Inbound | Text |
| parentIds | Inbound | Text |
| referenceNumber | Inbound | Text |
| notes | Inbound | Text |
| modifiedById | Inbound | Number |
| modifiedByName | Inbound | Text |
| modifiedDate | Inbound | Text |
| createdDate | Inbound | Text |
| organizationType | Inbound | Text |
| paymentPreference | Inbound | Text |
| creditLimit | Inbound | Number |
| taxNumber | Inbound | Text |
| preferredInvoicingMethod | Inbound | Text |
| statementDeliveryFrequency | Inbound | Text |
| collectionNoticeDeliveryFrequency | Inbound | Text |
| invoicingAutomationMethod | Inbound | Text |
| invoiceDeliveryInstructions | Inbound | Text |
| podRequiredWithInvoice | Inbound | Boolean |
| bolRequiredWithInvoice | Inbound | Boolean |
| includeShipmentOwnerOnInvoice | Inbound | Boolean |
| allowZeroMarginInvoiceAutomation | Inbound | Boolean |
| enablePastDueNotification | Inbound | Boolean |
| organizationId | Inbound | Number |
| OriginatingRecordId | Inbound | Text |
| city | Inbound | Text |
| state | Inbound | Text |
| zipCode | Inbound | Text |
| streetAddress | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| country | Inbound | Text |
| organizationId | Outbound | Number |
GET Shipment
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| shipmentId | Inbound | Number |
| latitude | Inbound | Number |
| longitude | Inbound | Number |
| lastLocationUpdate | Inbound | DateTime |
| mileage | Inbound | Number |
| name | Inbound | Text |
| referenceNumber | Inbound | Text |
| staffID | Inbound | Number |
| staffName | Inbound | Text |
| staffReferenceNumber | Inbound | Text |
| salesRepNames | Inbound | Text |
| billToOrganizationId | Inbound | Number |
| officeOrganizationId | Inbound | Number |
| officeName | Inbound | Text |
| totalBuy | Inbound | Number |
| totalSell | Inbound | Number |
| status | Inbound | Text |
| carrierMasterId | Inbound | Number |
| dotNumber | Inbound | Text |
| mcNumber | Inbound | Text |
| trackingURL | Inbound | Text |
| city | Inbound | Text |
| state | Inbound | Text |
| zipCode | Inbound | Text |
| phoneNumber | Inbound | Text |
| tariffName | Inbound | Text |
| transitType | Inbound | Text |
| buy | Inbound | Number |
| sell | Inbound | Number |
| attachmentUrl | Inbound | Text |
| attachmentType | Inbound | Text |
| documentId | Inbound | Number |
| shipmentType | Inbound | Text |
| stackable | Inbound | Boolean |
| trailerType | Inbound | Text |
| trailerSize | Inbound | Text |
| weightUnits | Inbound | Text |
| dimensionUnits | Inbound | Text |
| serviceLevel | Inbound | Text |
| importExport | Inbound | Text |
| referenceType | Inbound | Text |
| value | Inbound | Text |
| companyName | Inbound | Text |
| streetAddress | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| country | Inbound | Text |
| contactName | Inbound | Text |
| phone | Inbound | Text |
| fax | Inbound | Text |
| Inbound | Text | |
| instructions | Inbound | Text |
| notes | Inbound | Text |
| airportOrTerminalCode | Inbound | Text |
| estimatedReadyDateTime | Inbound | DateTime |
| estimatedCloseDateTime | Inbound | DateTime |
| appointmentReadyDateTime | Inbound | DateTime |
| appointmentCloseDateTime | Inbound | DateTime |
| actualArrivalDateTime | Inbound | DateTime |
| actualDepartureDateTime | Inbound | DateTime |
| stopType | Inbound | Text |
| referenceType | Inbound | Text |
| handlingQuantity | Inbound | Number |
| packagingType | Inbound | Text |
| length | Inbound | Number |
| width | Inbound | Number |
| height | Inbound | Number |
| weightTotal | Inbound | Number |
| hazardousMaterial | Inbound | Boolean |
| piecesTotal | Inbound | Number |
| freightClass | Inbound | Text |
| nmfc | Inbound | Text |
| description | Inbound | Text |
| additionalMarkings | Inbound | Text |
| unNumber | Inbound | Text |
| packingGroup | Inbound | Text |
| hazmatCustomClassDescription | Inbound | Text |
| hazmatPieceDescription | Inbound | Text |
| harmonizedCode | Inbound | Text |
| hazardClasses | Inbound | Text |
| code | Inbound | Text |
| type | Inbound | Text |
| createdDate | Inbound | DateTime |
| resolved | Inbound | Boolean |
| driverCellPhoneNumber | Inbound | Text |
| hazmatEmergencyContactNumber | Inbound | Text |
| name | Inbound | Text |
| OriginatingRecordId | Inbound | Text |
| referenceNumber | Inbound | Text |
| name | Inbound | Text |
| scac | Inbound | Text |
| value | Inbound | Text |
| status | Inbound | Text |
| city | Inbound | Text |
| zipCode | Inbound | Text |
| referenceNumber | Inbound | Text |
| shipmentId | Outbound | Number |
POST Carrier
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| OriginatingRecordId | Inbound | Text |
| country | Inbound | Text |
| lspCarrierId | Inbound | Number |
| streetAddress | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| city | Inbound | Text |
| state | Inbound | Text |
| zipCode | Inbound | Text |
| country | Inbound | Text |
| brokerAuthority | Inbound | Text |
| carrierName | Inbound | Text |
| commonAuthority | Inbound | Text |
| contractAuthority | Inbound | Text |
| dotNumber | Inbound | Text |
| dotStatus | Inbound | Text |
| drivers | Inbound | Number |
| fax | Inbound | Text |
| iataCode | Inbound | Text |
| intrastate | Inbound | Boolean |
| streetAddress | Inbound | Text |
| mailingPhone | Inbound | Text |
| mailingFax | Inbound | Text |
| motorCarrierNumber | Inbound | Text |
| outOfService | Inbound | Boolean |
| phone | Inbound | Text |
| powerUnits | Inbound | Number |
| rating | Inbound | Text |
| scac | Inbound | Text |
| trackingUrl | Inbound | Text |
| tsaCompliance | Inbound | Text |
| webUrl | Inbound | Text |
| carrierNotes | Inbound | Text |
| creditCardProcessingFee | Inbound | Number |
| creditLimit | Inbound | Number |
| netTerms | Inbound | Number |
| paymentFrequency | Inbound | Number |
| preferredPaymentType | Inbound | Text |
| contactInformationId | Inbound | Number |
| companyName | Inbound | Text |
| contactName | Inbound | Text |
| mobile | Inbound | Text |
| Inbound | Text | |
| requires1099 | Inbound | Boolean |
| supportedShipmentTypes | Inbound | Text |
| taxId | Inbound | Text |
| lspCarrierContactId | Inbound | Number |
| airportsServiced | Inbound | Text |
| contactType | Inbound | Text |
| isFavorite | Inbound | Boolean |
| title | Inbound | Text |
| nightPhone | Inbound | Text |
| lspCarrierInsuranceId | Inbound | Number |
| insuranceType | Inbound | Text |
| effectiveDate | Inbound | DateTime |
| expirationDate | Inbound | DateTime |
| policyNumber | Inbound | Text |
| insuredAmount | Inbound | Number |
| insuredAmountPerPound | Inbound | Number |
| notes | Inbound | Text |
| sourceType | Inbound | Text |
| trailerType | Inbound | Text |
| status | Inbound | Text |
| acceptCreditCard | Inbound | Boolean |
| streetAddressTwo | Inbound | Text |
| city | Inbound | Text |
| state | Inbound | Text |
| zipCode | Inbound | Text |
| country | Inbound | Text |
| fax | Inbound | Text |
| streetAddress | Inbound | Text |
| phone | Inbound | Text |
| companyName | Inbound | Text |
| contactName | Inbound | Text |
| mobile | Inbound | Text |
| Inbound | Text | |
| streetAddress | Inbound | Text |
| zipCode | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| phone | Inbound | Text |
| zipCode | Inbound | Text |
| zipCode | Inbound | Text |
| state | Inbound | Text |
| numberOfUnits | Inbound | Number |
| city | Inbound | Text |
| phone | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| city | Inbound | Text |
| state | Inbound | Text |
| country | Inbound | Text |
| fax | Inbound | Text |
| streetAddress | Inbound | Text |
| state | Inbound | Text |
| companyName | Inbound | Text |
| city | Inbound | Text |
| country | Inbound | Text |
| mcNumber | Outbound | Text |
| dotNumber | Outbound | Text |
| acceptCreditCard | Outbound | Boolean |
| carrierNotes | Outbound | Text |
| creditCardProcessingFee | Outbound | Number |
| creditLimit | Outbound | Number |
| intrastate | Outbound | Boolean |
| netTerms | Outbound | Number |
| paymentFrequency | Outbound | Text |
| preferredPaymentType | Outbound | Text |
| companyName | Outbound | Text |
| contactName | Outbound | Text |
| streetAddress | Outbound | Text |
| streetAddressTwo | Outbound | Text |
| city | Outbound | Text |
| state | Outbound | Text |
| zipCode | Outbound | Text |
| country | Outbound | Text |
| phone | Outbound | Text |
| fax | Outbound | Text |
| mobile | Outbound | Text |
| Outbound | Text | |
| requires1099 | Outbound | Boolean |
| supportedShipmentTypes | Outbound | Text |
| status | Outbound | Text |
| taxId | Outbound | Text |
POST Commission
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| shipmentTypes | Inbound | Text |
| priority | Inbound | Number |
| OriginatingRecordId | Inbound | Text |
| amountMaximum | Inbound | Number |
| staffId | Inbound | Number |
| rate | Inbound | Number |
| commissionId | Inbound | Number |
| calculationType | Inbound | Text |
| isHouseCommission | Inbound | Boolean |
| organizationId | Inbound | Number |
| sourceOrganizationId | Inbound | Number |
| amountMinimum | Inbound | Number |
| ignoreHouseCommission | Inbound | Boolean |
| amountMaximum | Outbound | Number |
| ignoreHouseCommission | Outbound | Boolean |
| shipmentTypes | Outbound | Text |
| staffId | Outbound | Number |
| amountMinimum | Outbound | Number |
| isHouseCommission | Outbound | Boolean |
| rate | Outbound | Number |
| sourceOrganizationId | Outbound | Number |
| organizationId | Outbound | Number |
| priority | Outbound | Number |
| calculationType | Outbound | Text |
POST Customer
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| includeShipmentOwnerOnInvoice | Inbound | Boolean |
| allowZeroMarginInvoiceAutomation | Inbound | Boolean |
| webAddress | Inbound | Text |
| modifiedById | Inbound | Number |
| invoiceDeliveryInstructions | Inbound | Text |
| city | Inbound | Text |
| name | Inbound | Text |
| country | Inbound | Text |
| taxNumber | Inbound | Text |
| streetAddress | Inbound | Text |
| organizationId | Inbound | Number |
| notes | Inbound | Text |
| enabled | Inbound | Boolean |
| preferredInvoicingMethod | Inbound | Text |
| invoicingAutomationMethod | Inbound | Text |
| createdDate | Inbound | DateTime |
| OriginatingRecordId | Inbound | Text |
| phone | Inbound | Text |
| modifiedByName | Inbound | Text |
| state | Inbound | Text |
| statementDeliveryFrequency | Inbound | Text |
| fax | Inbound | Text |
| country | Inbound | Text |
| bolRequiredWithInvoice | Inbound | Boolean |
| streetAddress | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| city | Inbound | Text |
| creditLimit | Inbound | Number |
| state | Inbound | Text |
| modifiedDate | Inbound | DateTime |
| zipCode | Inbound | Text |
| zipCode | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| mobile | Inbound | Text |
| parentIds | Inbound | Text |
| referenceNumber | Inbound | Text |
| organizationType | Inbound | Text |
| paymentPreference | Inbound | Text |
| collectionNoticeDeliveryFrequency | Inbound | Text |
| enablePastDueNotification | Inbound | Boolean |
| podRequiredWithInvoice | Inbound | Boolean |
| webAddress | Outbound | Text |
| country | Outbound | Text |
| allowZeroMarginInvoiceAutomation | Outbound | Boolean |
| referenceNumber | Outbound | Text |
| streetAddressTwo | Outbound | Text |
| streetAddress | Outbound | Text |
| city | Outbound | Text |
| notes | Outbound | Text |
| bolRequiredWithInvoice | Outbound | Boolean |
| collectionNoticeDeliveryFrequency | Outbound | Text |
| name | Outbound | Text |
| streetAddressTwo | Outbound | Text |
| zipCode | Outbound | Text |
| invoicingAutomationMethod | Outbound | Text |
| creditLimit | Outbound | Number |
| mobile | Outbound | Text |
| includeShipmentOwnerOnInvoice | Outbound | Boolean |
| taxNumber | Outbound | Text |
| city | Outbound | Text |
| statementDeliveryFrequency | Outbound | Text |
| phone | Outbound | Text |
| fax | Outbound | Text |
| invoiceDeliveryInstructions | Outbound | Text |
| state | Outbound | Text |
| podRequiredWithInvoice | Outbound | Boolean |
| state | Outbound | Text |
| paymentPreference | Outbound | Text |
| preferredInvoicingMethod | Outbound | Text |
| enablePastDueNotification | Outbound | Boolean |
| parentId | Outbound | Number |
| streetAddress | Outbound | Text |
| country | Outbound | Text |
| zipCode | Outbound | Text |
| enabled | Outbound | Boolean |
POST Shipment
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| OriginatingRecordId | Inbound | Text |
| proNumber | Inbound | Text |
| carrierSCAC | Inbound | Text |
| carrierName | Inbound | Text |
| city | Inbound | Text |
| poReference | Inbound | Text |
| apiQuoteNumber | Inbound | Text |
| shipperReferenceNumber | Inbound | Text |
| secondaryBOLNumber | Inbound | Text |
| serviceLevel | Inbound | Text |
| streetAddress | Inbound | Text |
| newLiabilityCoverage | Inbound | Number |
| usedLiabilityCoverage | Inbound | Number |
| companyName | Inbound | Text |
| Inbound | Text | |
| fax | Inbound | Text |
| tariffDescription | Inbound | Text |
| tsaCompliance | Inbound | Text |
| pricingInstructions | Inbound | Text |
| zipCode | Inbound | Text |
| state | Inbound | Text |
| apiQuoteNumber | Inbound | Text |
| priceLineHaul | Inbound | Number |
| accessorialPrice | Inbound | Number |
| priceTotal | Inbound | Number |
| shipmentStatus | Inbound | Text |
| billToType | Inbound | Text |
| billOfLadingURL | Inbound | Text |
| accessorialCode | Inbound | Text |
| billToAccountNumber | Inbound | Text |
| shipmentID | Inbound | Number |
| country | Inbound | Text |
| streetAddressTwo | Inbound | Text |
| phone | Inbound | Text |
| transitTime | Inbound | Number |
| priceFuelSurcharge | Inbound | Number |
| instructions | Outbound | Text |
| trailerType | Outbound | Text |
| amount | Outbound | Number |
| hazmatPieceDescription | Outbound | Text |
| trailerSize | Outbound | Text |
| companyName | Outbound | Text |
| freightClass | Outbound | Text |
| state | Outbound | Text |
| isCommitted | Outbound | Boolean |
| additionalMarkings | Outbound | Text |
| unNumber | Outbound | Text |
| nmfc | Outbound | Text |
| Outbound | Text | |
| fax | Outbound | Text |
| code | Outbound | Text |
| airportOrTerminalCode | Outbound | Text |
| zipCode | Outbound | Text |
| referenceNumber | Outbound | Text |
| weightTotal | Outbound | Number |
| height | Outbound | Number |
| referenceType | Outbound | Text |
| harmonizedCode | Outbound | Text |
| serviceLevel | Outbound | Text |
| length | Outbound | Number |
| contactName | Outbound | Text |
| hazardClasses | Outbound | Text |
| estimatedReadyDateTime | Outbound | DateTime |
| streetAddressTwo | Outbound | Text |
| referenceType | Outbound | Text |
| description | Outbound | Text |
| allowNewShipmentNotifications | Outbound | Boolean |
| packingGroup | Outbound | Number |
| tariffDescription | Outbound | Text |
| value | Outbound | Text |
| dimensionUnits | Outbound | Text |
| city | Outbound | Text |
| carrierSCAC | Outbound | Text |
| actualArrivalDateTime | Outbound | DateTime |
| rateShipment | Outbound | Boolean |
| customerId | Outbound | Number |
| importExport | Outbound | Text |
| streetAddress | Outbound | Text |
| width | Outbound | Number |
| appointmentReadyDateTime | Outbound | DateTime |
| weightUnits | Outbound | Text |
| value | Outbound | Text |
| piecesTotal | Outbound | Number |
| customerReferenceNumber | Outbound | Text |
| shipmentType | Outbound | Text |
| stopType | Outbound | Text |
| packagingType | Outbound | Text |
| stackable | Outbound | Boolean |
| appointmentCloseDateTime | Outbound | DateTime |
| country | Outbound | Text |
| phone | Outbound | Text |
| notes | Outbound | Text |
| estimatedCloseDateTime | Outbound | DateTime |
| actualDepartureDateTime | Outbound | DateTime |
| handlingQuantity | Outbound | Number |
| hazmatCustomClassDescription | Outbound | Text |
| hazardousMaterial | Outbound | Boolean |
| type | Outbound | Text |
| name | Outbound | Text |
| driverCellPhoneNumber | Outbound | Text |
| createdDate | Outbound | DateTime |
| resolved | Outbound | Boolean |
| hazmatEmergencyContactNumber | Outbound | Text |
POST Staff
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| staffSettings | Inbound | Text |
| zipCode | Inbound | Text |
| state | Inbound | Text |
| OriginatingRecordId | Inbound | Text |
| login | Inbound | Text |
| referenceNumber | Inbound | Text |
| shipmentPickedUpStatusChangeNotification | Inbound | Boolean |
| mobile | Inbound | Text |
| title | Inbound | Text |
| defaultShipmentType | Inbound | Text |
| staffId | Inbound | Number |
| phone | Inbound | Text |
| organizationId | Inbound | Number |
| shipmentDeliveredStatusChangeNotification | Inbound | Boolean |
| country | Inbound | Text |
| tariffSettings | Inbound | Text |
| proofOfDeliveryNotification | Inbound | Boolean |
| streetAddressTwo | Inbound | Text |
| shipmentOutForDeliveryStatusChangeNotification | Inbound | Boolean |
| streetAddress | Inbound | Text |
| city | Inbound | Text |
| Inbound | Text | |
| permissions | Inbound | Text |
| includeInARCollectionNotices | Inbound | Boolean |
| invoiceNotification | Inbound | Boolean |
| shipmentStatusChangeNotification | Inbound | Boolean |
| contactName | Inbound | Text |
| enabled | Inbound | Boolean |
| fax | Inbound | Text |
| organizationId | Outbound | Number |
| permissions | Outbound | Text |
| phone | Outbound | Text |
| password | Outbound | Text |
| enabled | Outbound | Boolean |
| mobile | Outbound | Text |
| state | Outbound | Text |
| shipmentStatusChangeNotification | Outbound | Boolean |
| country | Outbound | Text |
| invoiceNotification | Outbound | Boolean |
| city | Outbound | Text |
| shipmentOutForDeliveryStatusChangeNotification | Outbound | Boolean |
| streetAddressTwo | Outbound | Text |
| contactName | Outbound | Text |
| login | Outbound | Text |
| defaultShipmentType | Outbound | Text |
| Outbound | Text | |
| includeInARCollectionNotices | Outbound | Boolean |
| proofOfDeliveryNotification | Outbound | Boolean |
| staffSettings | Outbound | Text |
| shipmentPickedUpStatusChangeNotification | Outbound | Boolean |
| shipmentDeliveredStatusChangeNotification | Outbound | Boolean |
| title | Outbound | Text |
| tariffSettings | Outbound | Text |
| streetAddress | Outbound | Text |
| fax | Outbound | Text |
| zipCode | Outbound | Text |
| referenceNumber | Outbound | Text |
PUT AccountingProfile
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| OriginatingRecordId | Inbound | Text |
| customerOrganizationId | Outbound | Number |
| allowZeroMarginInvoiceAutomation | Outbound | Boolean |
| paymentPreference | Outbound | Text |
| podRequiredWithInvoice | Outbound | Boolean |
| invoiceDeliveryInstructions | Outbound | Text |
| invoicingAutomationMethod | Outbound | Text |
| includeShipmentOwnerOnInvoice | Outbound | Boolean |
| statementDeliveryFrequency | Outbound | Text |
| taxNumber | Outbound | Text |
| bolRequiredWithInvoice | Outbound | Boolean |
| preferredInvoicingMethod | Outbound | Text |
| creditLimit | Outbound | Number |
| enablePastDueNotification | Outbound | Boolean |
| collectionNoticeDeliveryFrequency | Outbound | Text |
PUT Carrier
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| OriginatingRecordId | Inbound | Text |
| contactName | Outbound | Text |
| country | Outbound | Text |
| city | Outbound | Text |
| netTerms | Outbound | Number |
| status | Outbound | Text |
| preferredPaymentType | Outbound | Text |
| paymentFrequency | Outbound | Number |
| Outbound | Text | |
| phone | Outbound | Text |
| lspCarrierId | Outbound | Number |
| state | Outbound | Text |
| zipCode | Outbound | Text |
| creditCardProcessingFee | Outbound | Number |
| taxId | Outbound | Text |
| requires1099 | Outbound | Boolean |
| creditLimit | Outbound | Number |
| fax | Outbound | Text |
| acceptCreditCard | Outbound | Boolean |
| carrierNotes | Outbound | Text |
| streetAddress | Outbound | Text |
| mobile | Outbound | Text |
| intrastate | Outbound | Boolean |
| companyName | Outbound | Text |
| streetAddressTwo | Outbound | Text |
| supportedShipmentTypes | Outbound | Text |
PUT Commission
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| OriginatingRecordId | Inbound | Text |
| amountMaximum | Outbound | Number |
| organizationId | Outbound | Number |
| commissionId | Outbound | Number |
| rate | Outbound | Number |
| shipmentTypes | Outbound | Text |
| calculationType | Outbound | Text |
| staffId | Outbound | Number |
| isHouseCommission | Outbound | Boolean |
| sourceOrganizationId | Outbound | Number |
| ignoreHouseCommission | Outbound | Boolean |
| amountMinimum | Outbound | Number |
| priority | Outbound | Number |
PUT Customer
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| OriginatingRecordId | Inbound | Text |
| city | Outbound | Text |
| notes | Outbound | Text |
| name | Outbound | Text |
| organizationId | Outbound | Number |
| streetAddress | Outbound | Text |
| country | Outbound | Text |
| city | Outbound | Text |
| referenceNumber | Outbound | Text |
| zipCode | Outbound | Text |
| fax | Outbound | Text |
| phone | Outbound | Text |
| mobile | Outbound | Text |
| state | Outbound | Text |
| streetAddress | Outbound | Text |
| state | Outbound | Text |
| webAddress | Outbound | Text |
| streetAddressTwo | Outbound | Text |
| streetAddressTwo | Outbound | Text |
| zipCode | Outbound | Text |
| country | Outbound | Text |
| enabled | Outbound | Boolean |
PUT Staff
API Field Details
| Nexus API Field Name | Event Type | Data Type |
|---|---|---|
| OriginatingRecordId | Inbound | Text |
| phone | Outbound | Text |
| state | Outbound | Text |
| mobile | Outbound | Text |
| streetAddressTwo | Outbound | Text |
| title | Outbound | Text |
| shipmentPickedUpStatusChangeNotification | Outbound | Boolean |
| shipmentDeliveredStatusChangeNotification | Outbound | Boolean |
| shipmentStatusChangeNotification | Outbound | Boolean |
| proofOfDeliveryNotification | Outbound | Boolean |
| shipmentOutForDeliveryStatusChangeNotification | Outbound | Boolean |
| contactName | Outbound | Text |
| country | Outbound | Text |
| staffId | Outbound | Number |
| zipCode | Outbound | Text |
| includeInARCollectionNotices | Outbound | Boolean |
| invoiceNotification | Outbound | Boolean |
| city | Outbound | Text |
| streetAddress | Outbound | Text |
| fax | Outbound | Text |
| referenceNumber | Outbound | Text |
| enabled | Outbound | Boolean |