Overview

To get started with the TI Backlog API suite, follow these steps: 

1. Meet prerequisites for access and development 
2. Receive customer identification codes 
3. Review the typical ordering flow with the Backlog API suite
4. Authenticate to receive an access token
5. Learn how to create and retrieve quotes for TI products
6. Learn how to create a test order
7. Learn how to access your order information
8. Learn how to change an order 
9. Learn how to retrieve shipment tracking
10. Learn how to retrieve a financial document
11. Learn how to create remittance advice
12. Get support

 

Step 1: Prerequisites for setup and review onboarding process

Only approved customers can build applications using the backlog API suite. To obtain approval:

1. Create a myTI account or log in to your existing myTI account
2. Associate your myTI account with a company account  
3. Log in to the API portal
4. Review the customer onboarding process
5. Submit the customer onboarding form and review
6. Setup TI as a vendor in your internal system
7. Review the API business guidebook for business and process knowledge

 

Step 2: Receive customer identification codes

1. After completion of the customer onboarding form, TI will provide your site's customer identification codes. These codes are used for backlog API connectivity for orders, change orders, quotes and remittance advice. These codes also appear on various outbound documents sent to the customer:
   1. The sold-to code is the buying entity
   2. The bill-to code is where TI bills invoices
   3. The payer code is where invoices are paid from
   4. The ship-to code(s) is where TI ships product
   5. The end customer identification code is only for approved contract manufacturers (CMs) or customers purchasing on behalf of another customer
2. TI's vendor information with banking details will also be provided with the customer identifications codes through email notification
   1. The customer can access TI's vendor information and financial information through a linked PDF. This is provided to facilitate the vendor setup in your system. The PDF will include the TI mailing address, NAICS code, federal tax ID number, annual revenue, and standard payment information. The PDF also includes the link to our annual reports, citizenship report and quality certifications. Depending on your introductory customer onboarding response we will indicate in this email notification the country of our bank for you to utilize in the vendor setup.

 

Step 3: Ordering flow overview

1. TI Standard API format is retrieve, if API push is preferred, refer to API Business Guidebook
2. Authenticate with your assigned API key and secret
3. Ensure that the part(s) you intend to order are included in your TI pricing agreement if not you could create a quote
4. Build your order with your desired payload and post to the backlog order API
5. The API will reply with a status code, 201 Created, and a JSON containing order acknowledgement
6. Query the backlog order API for the order status and additional order details
7. After order processing, retrieve shipment tracking through the advanced ship notice (ASN) retrieve API and invoices through the financial document retrieve API
8. The remittance advice API is mandatory. Call the remittance advice API to send remittance information to TI
9. Interested in seeing example code for each of these steps? Download our example code

 

Step 4: Authenticate

TI has secured its API suites with OAuth 2.0. Use your API key and secret to authenticate. After authorization, OAuth2 returns an access token used with APIs in the suite you have enabled. For more details, see the Authentication page.  

curl --request POST \   
       --url https://transact.ti.com/v1/oauth/accesstoken \   
       --header 'Content-Type: application/x-www-form-urlencoded' \   
       --data grant_type=client_credentials \   
       --data client_id=<<INSERT YOUR CLIENT KEY>> \   
       --data client_secret=<<INSERT YOUR SECRET>>

Step 5: Create and retrieve quotes for TI products

Quote API enables authorized customers to create a quote within the TI enterprise system. A quote can be submitted for multiple parts and quantities, and customers will receive a quote number for reference. Quote responses are typically available within 24 hours. For more details, see the backlog quote API page.

Create quote request example:

curl --request POST \
--url 'https://transact.ti.com/v1/quotes' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-binary @- <<DATA
{
	"Quote": {
		"CustomerQuoteIdentifier": "TEST-AW-20200224-G115",
		"CustomerSoldToIdentifier": 2425,
		"SupplierSoldToIdentifier": 2425,
		"CustomerQuoteReason": "CD",
		"CustomerContactName": "John Smith",
		"CustomerContactEmailAddress": "john-smith@test-customer123.com",
		"CustomerContactPhoneNumber": "888-888-8888",
		"CustomerEndCustomerIdentifier": "John Smith",
		"CustomerEndCustomerName": "Company XYZ",
		"CustomerEndCustomerCity": "Dallas",
		"CustomerEndCustomerCountry": "US",
		"CustomerEndCustomerPostalCode": "75208",
		"CustomerIntermediateCustomerName": "Company ABC",
		"CustomerIntermediateCustomerCity": "",
		"CustomerIntermediateCustomerCountry": "",
		"CustomerIntermediateCustomerPostalCode": "",
		"CustomerEndCustomerWebsite": "https://www.companyxyz.com",
		"LineItems": [
			{
				"CustomerQuoteLineItemNumber": 1,
				"SupplierProductIdentifier": "SN74LS00N",
				"CustomerProductIdentifier": "SN74LS00N",
				"CustomerQuoteItemQuantity": 2500,
				"CustomerTargetUnitPrice": 1.2,
				"CustomerCompetingSupplierName": "Competitor N",
				"CustomerItemComments": "Costdown Quote",
				"CustomerCompetingSupplierMaterial": "SNKLLPO23",
				"CustomerCompetingSupplierUnitPrice": 1.43,
				"CustomerCompetingSupplierCurrency": "USD"
			}
		]
	}
}
DATA

Create quote response example:

{
	"Quote": {
		"CustomerQuoteIdentifier": "TEST-AW-20200224-G115",
		"CustomerSoldToIdentifier": 2425,
		"CustomerQuoteReason": "CD",
		"CustomerContactName": "John Smith",
		"SupplierEndCustomerName": "Company XYZ",
		"SupplierEndCustomerWebSite": "https://companyxyz.com",
		"SupplierQuoteStatus": "Accept",
		"SupplierSoldToIdentifier": 114207,
		"SupplierQuoteValidFromDate": "2021-09-15T00:00:00Z",
		"SupplierQuoteValidToDate": "2022-03-14T00:00:00Z",
		"LineItems": [
			{
				"CustomerQuoteLineItemNumber": 1,
				"SupplierQuoteItemStatus": "Pending",
				"SupplierProductIdentifier": "SN74LS00N",
				"CustomerProductIdentifier": "SN74LS00N",
				"CustomerQuoteItemQuantity": 2500,
				"CustomerTargetUnitPrice": 1.2,
				"CustomerCompetingSupplierName": "Competitor N",
				"SupplierQuoteItemComments": "Costdown Quote",
				"Description": "Quote created with number: 26679695"
			}
		]
	}
}

Quote responses are typically available in 30 minutes - 24 hours after submitting a quote. "SupplierQuoteStatus" indicates whether a quote is Accepted, Rejected or Changed. "SupplierQuoteItemStatus" indicates whether a line item is Pending, Bid or No Bid.

Retrieve quote request example:

curl --request GET \   
--url 'https://transact.ti.com/v1/quotes/{customerQuoteNumber}' \
--header 'Authorization: Bearer {access_token}' \

Retrieve quote response example:

{
	"Quote": {
		"CustomerQuoteIdentifier": "TEST-AW-20200224-G115",
		"CustomerSoldToIdentifier": 2425,
		"CustomerQuoteReason": "CD",
		"CustomerContactName": "John Smith",
		"CustomerEndCustomerName": "Company XYZ",
		"CustomerEndCustomerWebsite": "https://companyxyz.com",
		"SupplierEndCustomerName": "XYZ CORPORATION",
		"SupplierEndCustomerWebSite": "https://companyxyz.com",
		"SupplierQuoteStatus": "Accept",
		"SupplierSoldToIdentifier": "114207",
		"SupplierSoldToName": "YOUR COMPANY NAME",
		"SupplierQuoteValidFromDate": "2021-09-15T00:00:00Z",
		"SupplierQuoteValidToDate": "2022-03-14T00:00:00Z",
		"LineItems": [
			{
				"SupplierQuoteLineItemNumber": 10,
				"SupplierQuoteItemStatus": "Pending",
				"SupplierProductIdentifier": "SN74LS00N",
				"CustomerProductIdentifier": "SN74LS00N",
				"CustomerQuoteItemQuantity": 2500,
				"CustomerTargetUnitPrice": 1.2,
				"SupplierUnitPrice": 0,
				"SupplierUnitPriceCurrency": "USD",
				"CustomerCompetingSupplierName": "Competitor N",
				"SupplierQuoteItemComments": "Costdown Quote",
				"SupplierProductLeadTime": 35,
				"SupplierProductMinimumQuantity": 90,
				"SupplierProductNextQuantityIncrement": 90,
				"SupplierProductPackageType": "JEDEC TRAY (5+1)",
				"SupplierProductRestrictionOfHazardousSubstancesCompliant": "Y",
				"SupplierProductCancellationWindowWeeks": 5,
				"SupplierProductRescheduleWindowWeeks": 5,
				"SupplierNonCancellableNonReturnableProduct": false,
				"SupplierProductType": "STD",
				"SupplierProductMoistureLevel": "3",
				"SupplierProductExportControlClassificationNumber": "EAR99",
				"SupplierPaymentTerms": "Per Negotiated Terms"
			}
		]
	}
}

Step 6: Create test order

Backlog test orders are simulated in our pre-production test environment and are specifically intended to assist in the development of the customer's application.  Information returned is simulated test data for demonstrative purposes only and does not represent processed information.  

Backlog test order create url: https://transact-pre.ti.com/v1/orders/create (pre-production)  

1. To place an order (test or production), the customer must be approved, setups configured and completed the onboarding process
2. Once the customer has successfully placed a test for both order entry and change, follow the user acceptance testing scenarios in the API business guidebook to complete the testing phase

Example Backlog test order create request: 

curl --request POST \
--url 'https://transact-pre.ti.com/v1/orders/create' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-binary @- <<DATA
{
  "Order": {
    "CustomerPurchaseOrderIdentifier": "TEST-AW-20200224-G115",
    "CustomerPurchaseOrderDate": "YYYY-MM-DD",
    "CustomerSoldToIdentifier": "111111",
    "CustomerShipToIdentifier": "111111",
    "CustomerEndCustomerIdentifier": "",
    "
    "LineItems": [
      {
        "CustomerPurchaseOrderLineItemNumber": "1",
        "SupplierProductIdentifier": "SN74LS00N",
        "CustomerProductIdentifier": "CPN-XXX",
        "CustomerExpectedUnitPrice": "0.987",
        "Schedules": [
          {
            "CustomerRequestedQuantity": "2000",
            "CustomerRequestedDate": "2023-06-15"
          },
          {
            "CustomerRequestedQuantity": "3000",
            "CustomerRequestedDate": "2023-07-15"
          }
        ]
      },
      {
        "CustomerPurchaseOrderLineItemNumber": "2",
        "SupplierProductIdentifier": "SN74LS00N",
        "CustomerProductIdentifier": "",
        "CustomerExpectedUnitPrice": "1",
        "Schedules": [
          {
            "CustomerRequestedQuantity": "4000",
            "CustomerRequestedDate": "2023-08-01"
          }
        ]
      }
    ]
  }
}

Example Backlog test order create response: 

{
  "Orders": [
    {
      "AsOfDateTime": "2023-02-24 17:02:11",
      "SupplierOrderStatus": "ACCEPT",
      "CustomerPurchaseOrderIdentifier": "TEST-AW-20200224-G115",
      "CustomerSoldToIdentifier": "111111",
      "CustomerShipToIdentifier": "111111",
      "LineItems": [
        {
          "CustomerPurchaseOrderLineItemNumber": "1",
          "SupplierProductIdentifier": "SN74LS00N",
          "CustomerExpectedUnitPrice": "0.987",
          "Schedules": [
            {
              "CustomerRequestedQuantity": 2000,
              "CustomerRequestedDate": "2023-06-15"
            },
            {
              "CustomerRequestedQuantity": 3000,
              "CustomerRequestedDate": "2023-07-15"
            }
          ]
        },
        {
          "CustomerPurchaseOrderLineItemNumber": "2",
          "SupplierProductIdentifier": "SN74LS00N",
          "CustomerExpectedUnitPrice": 1,
          "Schedules": [
            {
              "CustomerRequestedQuantity": 4000,
              "CustomerRequestedDate": "2023-08-01"
            }
          ]
        }
      ]
    }
  ]
}

When you are ready to place a production Backlog order, review all of the parameters that you would like to send in the request payload and use the Production versions of the Authentication and Backlog order create API URLs: https://transact.ti.com/v1/oauth and https://transact.ti.com/v1/orders/create.

To learn more about test and production ordering, see the Backlog order API documentation page.

 

Step 7:  Query order details

Using the backlog order retrieve API, you can access order details using your customer purchase order number or supplier order number.

Example order retrieve details using customer purchase order number:

curl --request POST \
--url 'https://transact-pre.ti.com/v1/orders/retrieve' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-binary @- <<DATA

{
  "CustomerPurchaseOrderIdentifier": "TEST-AW-20200224-G115"
  }


​

Example order retrieve details using supplier order number: 

​
curl --request POST \
--url 'https://transact-pre.ti.com/v1/orders/retrieve' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-binary @- <<DATA

{
    "SupplierOrderIdentifier": "1000004607"
}

​

Example response:

{
  "CustomerPurchaseOrderIdentifier": "TEST-AW-20200224-G115",
  "SupplierOrderIdentifier": "1000004607",
  "Orders": [
    {
      "AsOfDateTime": "2023-03-27 20:57:06",
      "SupplierOrderIdentifier": "1000000000",
      "SupplierOrderStatus": "OPEN",
      "CustomerPurchaseOrderIdentifier": "TEST-AW-20200224-G115",
      "CustomerSoldToIdentifier": "111111",
      "CustomerShipToIdentifier": "111111",
      "LineItems": [
        {
          "SupplierOrderLineItemNumber": "000010",
          "CustomerPurchaseOrderLineItemNumber": "1",
          "SupplierOrderItemStatus": "Not Delivered",
          "SupplierChangeOrderWindow": "NON",
          "SupplierProductIdentifier": "SN74LS00N",
          "SupplierTotalOrderItemQuantity": 5000,
          "CustomerExpectedUnitPrice": "0.152",
          "SupplierUnitPrice": 1,
          "CustomerCertificateOfConformance": "YES",
          "LineItemMessages": [
            {
              "Code": "TI-TXT-051",
              "Type": "INFO",
              "Message": "Customer expected price mismatch with TI price"
            },
            {
              "Code": "TI-TXT-089",
              "Type": "INFO",
              "Message": "Item quantity does not match rated quantity; Rating has not been applied"
            }
          ],
           "Schedules": [
            {
              "CustomerRequestedQuantity": 2000,
              "CustomerRequestedDate": "2023-06-15",
              "Confirmations": [
                {
                  "SupplierScheduleLineNumber": "0005",
                  "SupplierConfirmedQuantity": 2000,
                  "CustomerRequestedShipDate": "2023-06-12",
                  "SupplierEstimatedShipDate": "2023-06-12",
                  "SupplierEstimatedDeliveryDate": "2023-06-15",
                  "SupplierDeliveredQuantity": 0
                }
              ]
            },
            {
              "CustomerRequestedQuantity": 3000,
              "CustomerRequestedDate": "2020-07-15",
              "Confirmations": [
                {
                  "SupplierScheduleLineNumber": "0006",
                  "SupplierConfirmedQuantity": 3000,
                  "CustomerRequestedShipDate": "2023-07-10",
                  "SupplierEstimatedShipDate": "2023-07-10",
                  "SupplierEstimatedDeliveryDate": "2023-07-15",
                  "SupplierDeliveredQuantity": 0
                }
              ]
            }
          ]
        },
        {
          "SupplierOrderLineItemNumber": "000020",
          "CustomerPurchaseOrderLineItemNumber": "2",
          "SupplierOrderItemStatus": "Not Delivered",
          "SupplierChangeOrderWindow": "NON",
          "SupplierProductIdentifier": "SN74LS00N",
          "SupplierTotalOrderItemQuantity": 4000,
          "CustomerExpectedUnitPrice": "1.00",
          "SupplierUnitPrice": 1,
          "Schedules": [
            {
              "CustomerRequestedQuantity": 4000,
              "CustomerRequestedDate": "2023-08-01",
              "Confirmations": [
                {
                  "SupplierScheduleLineNumber": "0002",
                  "SupplierConfirmedQuantity": 4000,
                  "CustomerRequestedShipDate": "2023-07-29",
                  "SupplierEstimatedShipDate": "2023-07-29",
                  "SupplierEstimatedDeliveryDate": "2023-08-01",
                  "SupplierDeliveredQuantity": 0
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

To learn more about ordering and available order details, see the Backlog order API documentation page.

 

Step 8: Learn how to change an order 

First step in requesting changes to an order is to verify you have created a test order.

Below listed data parameters are from the orders create request payload identifying the test order number that was created, the date the order created, the status of the order, and customer PO number identifying that order.

•  AsOfDateTime "2023-01-30 18:11:04"
•  SupplierOrderIdentifier "1111111111"
•  SupplierOrderStatus "OPEN"
•  CustomerPurchaseOrderIdentifier "PO-Order1"

The order data fields in the change order request payload must be an exact match to the original order request.

Example of test order request:

  {
	"Order": {
		"CustomerPurchaseOrderIdentifier": "PO-Order1",
		"CustomerPurchaseOrderDate": "2022-12-01",
		"CustomerSoldToIdentifier": "111111",
		"CustomerShipToIdentifier": "111111",
		"LineItems": [
			{
				"CustomerPurchaseOrderLineItemNumber": "1",
				"SupplierProductIdentifier": "SN74LVC139ADR",
				"CustomerProductIdentifier": "SN74LVC139ADR",
				"CustomerExpectedUnitPrice": 2.15,
				"Schedules": [
					{
						"CustomerRequestedQuantity": 10000,
						"CustomerRequestedDate": "2023-06-05"
					}
				]
			}
		]
	}
}

Test any of the following scenarios for order change using the backlog test orders change url: https://transact-pre.ti.com/v1/orders/change (pre-production)  

1. Customer request date change - set CustomerItemChangeIndicator to "U", and modify CustomerRequestedDate  as needed. 
2. Customer request quantity change - set CustomerItemChangeIndicator to "U", and modify CustomerRequestedQuanity  as needed
3. Customer expected Unit Price (+/-)  set CustomerItemChangeIndicator to "U", and modify CustomerExpectedUnitPrice  as needed

Modified example of orders change request:

"Order": {
		"CustomerPurchaseOrderIdentifier": "PO-Order1",
		"CustomerPurchaseOrderDate": "2022-12-01",
		"CustomerSoldToIdentifier": "167435",
		"CustomerShipToIdentifier": "167435",
		"LineItems": [
			{
				"CustomerPurchaseOrderLineItemNumber": "1",
				"CustomerItemChangeIndicator": "U",
				"SupplierProductIdentifier": "SN74LVC139ADR",
				"CustomerProductIdentifier": "SN74LVC139ADR",
				"CustomerExpectedUnitPrice": 2.15,
				"Schedules": [
					{
						"CustomerRequestedQuantity": 10000,
						"CustomerRequestedDate": "2023-06-05"
					}
				]
			}
		]
	}
}

How to cancel an order using the backlog test orders change url: https://transact-pre.ti.com/v1/orders/change (pre-production)  with the below parameter indicator for each line item.

 4. Cancel order test scenario - To cancel the complete order, the CustomerItemChangeIndicator must be set to "X" for all items (1-n) in the order. To cancel an individual item(s), only list those items with the CustomerItemChangeIndicator set to "X" and remove all other items that should remain part of the order.

 

Modified example change orders request for cancellation:

{
	"Order": {
		"CustomerPurchaseOrderIdentifier": "PO-Order2",
		"CustomerPurchaseOrderDate": "2023-01-01",
		"CustomerSoldToIdentifier": "111111",
		"CustomerShipToIdentifier": "111111",
		"LineItems": [
			{
				"CustomerPurchaseOrderLineItemNumber": "1",
				"CustomerItemChangeIndicator": "X",
				"SupplierProductIdentifier": "SN74LVC139",
				"CustomerProductIdentifier": "SN74LVC139",
				"CustomerExpectedUnitPrice": 1.15,
				"Schedules": [
					{
						"CustomerRequestedQuantity": 10000,
						"CustomerRequestedDate": "2023-06-05"
		      		
       "LineItems": [
			{
				"CustomerPurchaseOrderLineItemNumber": "2",
				"CustomerItemChangeIndicator": "X",
				"SupplierProductIdentifier": "SN74LVC139ADR",
				"CustomerProductIdentifier": "SN74LVC139ADR",
				"CustomerExpectedUnitPrice": 2.15,
				"Schedules": [
					{
						"CustomerRequestedQuantity": 10000,
						"CustomerRequestedDate": "2023-06-05"
					}
				]
			}
		]
	}
}
				

Contact API support for assistance to test the change order API with your API test code.

 

Step 9: Learn how to retrieve shipment tracking

After packing your order, when it's ready to ship TI generates shipment tracking information accessible through the advanced ship notification (ASN) API. The response includes detailed information regarding your shipment, such as shipment tracking number, carrier information and commercial invoices. The API is available in push or retrieve implementations. 

Example request for retrieve:

curl --request POST \
--url 'https://transact-pre.ti.com/v1/advance-ship-notices/retrieve/?SupplierOrderIdentifier=123456789&
CustomerSoldToIdentifier=ABC123456&RequestCommercialInvoicePDF=X&RequestWaybillPDF=X' \
--header 'Authorization: Bearer {access_token}'

Example response:

{
  "CustomerSoldToIdentifier": "ABCDEF",
  "SupplierOrderIdentifier": "1234567890",
  "CustomerPurchaseOrderIdentifier": "T1234567",
  "SupplierWayBillIdentifier": "5678901234",
  "RequestCommercialInvoicePDF": "X",
  "RequestWaybillPDF": "X",
  "Data": {
    "ConsolidatedInformation": [
      {
        "ShipmentEstimatedDateOfArrival": {},
        "ShipmentGoodsIssueDate": {},
        "ShipmentNumberOfPallet": "1",
        "ShipmentGrossWeight": "2.450",
        "ShipmentGrossWeightUnitOfMeasure": "KG",
        "ShipmentNumberOfPieces": "2",
        "ShipmentNetWeight": "0.264",
        "ShipmentNetWeightUnitOfMeasure": "KG",
        "ShipmentServiceLevelCode": "ABC",
        "ShipmentProductDescription": "ABC DEF GHI",
        "CarrierShipmentMasterTrackingNumber": "123456",
        "CarrierShipmentBoxTrackingNumber": "CUSTOMER XLR8",
        "SupplierShippingDate": {},
        "SupplierShippingPoint": "1808",
        "SupplierShippingCondition": "EG",
        "CustomerSoldToIdentifier": "0000123456",
        "SpecialProcessingIndicator": "string",
        "ModeOfTransport": "05",
        "CustomerBuyerCode": "12345",
        "CustomerShipperVendorCode": "ABCDEFG",
        "SupplierShipTrackReference": "123456789012",
        "SupplierSoldToPartyName": "CUSTOMER CORPORATION",
        "ShipmentInternalTransactionNumberList": [
          {
            "ShipmentInternalTransactionNumber": "1234"
          }
        ],
        "ForwardingAgentDetails": {
          "ForwarderCompanyName": "XYZ",
          "ForwarderStandardCarrierAccessCode": "ABCD",
          "SupplierCarrierIdentifier": "12345",
          "SupplierCarrierTrackingWebSite": "https://www.carrierxyz.com"
        },
        "SupplierWayBillNumberList": [
          {
            "SupplierWayBillIdentifier": "5678901234",
            "SupplierWayBillCreationDate": {},
            "SupplierWayBillCreationTime": "09:15:08",
            "SupplierWaybillPDF": "string"
          }
        ],
        "SupplierCommercialInvoicelist": [
          {
            "SupplierCommercialInvoiceIdentifier": "987654321",
            "SupplierCommercialInvoiceDate": {},
            "SupplierCommercialInvoiceTime": "22:32:40",
            "SupplierIncotermCode": "DDP",
            "SupplierIncotermDescription": "Buyers Dock",
            "SupplierCommercialInvoiceValue": "100.100",
            "SupplierCommercialInvoiceCurrency": "USD",
            "SupplierCommercialInvoicePDF": "string"
          }
        ],
        "ShipToDetails": {
          "CustomerShipToPlantIdentifier": "00001234",
          "CustomerShipToCompanyName": "XYZ",
          "CustomerShipToContactName": "010-234-2010",
          "CustomerShipToAddress1": "123 Main St",
          "CustomerShipToAddress2": "ABC",
          "CustomerShipToCity": "Fort Worth",
          "CustomerShipToState": "TX",
          "CustomerShipToZipCode": "12345-1234",
          "CustomerShipToCountry": "US",
          "CustomerShipToCompanyNameAdditionalDetail": "ABCD"
        },
        "ShipFromDetails": {
          "SupplierShipFromPlantIdentifier": "00001234",
          "SupplierShipFromCompanyName": "Texas Instruments",
          "SupplierShipFromContactName": "010-234-2010",
          "SupplierShipFromAddress1": "13601 Independence Parkway",
          "SupplierShipFromAddress2": "ABC",
          "SupplierShipFromCity": "Fort Worth",
          "SupplierShipFromState": "TX",
          "SupplierShipFromZipCode": "12345-1234",
          "SupplierShipFromCountry": "US",
          "SupplierShipFromEmailAddress": "test@test.com",
          "SupplierShipFromPhoneNumber": "010-101-2031"
        },
        "SupplierCrossDockDetails": {
          "SupplierCrossDockPlantIdentifier": "00001234",
          "SupplierCrossDockCompanyName": "XYZ",
          "SupplierCrossDockContactName": "010-234-2010",
          "SupplierCrossDockAddress1": "123 Main St",
          "SupplierCrossDockAddress2": "ABC",
          "SupplierCrossDockCity": "Fort Worth",
          "SupplierCrossDockState": "TX",
          "SupplierCrossDockZipCode": "12345-1234",
          "SupplierCrossDockCountry": "US"
        },
        "ImporterDetails": {
          "ImporterCompanyName": "XYZ",
          "ImporterContactName": "010-234-2010",
          "ImporterAddress1": "13601 Independence Parkway",
          "ImporterAddress2": "ABC",
          "ImporterCity": "Fort Worth",
          "ImporterState": "TX",
          "ImporterZipCode": "12345-1234",
          "ImporterCountry": "US"
        },
        "SupplierManifestIdentifierList": {
          "SupplierManifestIdentifier": "7890123456"
        },
        "BookingOrderDetails": [
          {
            "CustomerPurchaseOrderIdentifier": "T1234567",
            "CustomerPurchaseOrderDate": {},
            "PassThrus": [
              {
                "SupplierOrderIdentifier": "1234567890",
                "CustomerPassthru1": "ZREF*00001*URL=www.test.com",
                "CustomerPassthru2": "ZREF*00002*URL=www.test.com",
                "CustomerPassthru3": "ZREF*00003*URL=www.test.com",
                "CustomerPassthru4": "ZREF*00004*URL=www.test.com",
                "CustomerPassthru5": "ZREF*00005*URL=www.test.com",
                "CustomerPassthru6": "ZREF*00006*URL=www.test.com",
                "CustomerPassthru7": "ZREF*00007*URL=www.test.com",
                "CustomerPassthru8": "ZREF*00008*EML=test@test.com",
                "CustomerPassthru9": "ZREF*00009*URL=www.test.com",
                "CustomerPassthru10": "ZREF*00010*URL=www.test.com",
                "CustomerPassthru11": "ZREF*00011*URL=www.test.com",
                "CustomerPassthru12": "ZREF*00012*EML=test@test.com",
                "CustomerPassthru13": "ZREF*00013*URL=www.test.com",
                "CustomerPassthru14": "ZREF*00014*URL=www.test.com",
                "CustomerPassthru15": "ZREF*00015*URL=www.test.com"
              }
            ],
            "PackageDetails": [
              {
                "PackageHandlingUnitIdentifier": "1234567890",
                "PackageContainerVolume": "0.000",
                "PackageContainerVolumeUnitOfMeasure": "CDM",
                "PackageLength": "0.000",
                "PackageWidth": "0.000",
                "PackageHeight": "0.000",
                "PackageLWHUnitOfMeasure": "MM",
                "PackageTrackingNumber": "123456789012",
                "PackageNumberOfLineItems": "0",
                "PackageAlternateHandlingUnitIdentifier": "ABCDEFGH",
                "PackageNetWeight": "0.000",
                "PackageGrossWeight": "0.000",
                "PackageWeightUnitOfMeasure": "KG",
                "ItemDetails": [
                  {
                    "SupplierProductIdentifier": "TPS12345",
                    "CustomerProductIdentifier": "ABCDEFG",
                    "SupplierProductDescription": "TPS12345 description",
                    "SupplierDeliveryLineItemNumber": "000010",
                    "SupplierDeliveryIdentifier": "0123456789",
                    "SupplierOrderIdentifier": "1234567890",
                    "SupplierOrderLineItemNumber": "000010",
                    "CustomerPurchaseOrderIdentifier": "T1234567",
                    "CustomerPurchaseOrderItemNumber": "2",
                    "CustomerPurchaseOrderDate": {},
                    "SupplierItemNumberOfUnitsShipped": "000000000001",
                    "SupplierItemBaseUnitOfMeasure": "EA",
                    "SupplierItemGrossWeight": "1.450",
                    "SupplierItemNetWeight": "0.165",
                    "SupplierItemWeightUnitOfMeasure": "KG",
                    "SupplierCommercialInvoiceIdentifier": "987654321",
                    "SupplierCommercialInvoiceItem": "000001",
                    "SupplierCommercialInvoiceUnitprice": "123.000000",
                    "SupplierCommercialInvoiceValue": "123.000000",
                    "SupplierCommercialInvoiceCurrency": "USD",
                    "SupplierCountryOfOriginCode": "PH",
                    "SupplierCountryOfOriginDescription": "Philippines",
                    "SupplierAssemblyCountryOfOriginCode3Character": "PHL",
                    "SupplierAssemblyCountryOfOriginCode2Character": "PH",
                    "SupplierAssemblyCountryOfOriginDescription": "Philippines",
                    "SupplierItemHarmonizedTariffScheduleExportCode": "8901234567",
                    "SupplierItemHarmonizedTariffScheduleExportDescription": "Electronic Integrated Circuits, Other",
                    "SupplierItemHarmonizedTariffScheduleImportCode": "8901234567",
                    "SupplierItemHarmonizedTariffScheduleImportDescription": "Electronic Integrated Circuits, Other",
                    "SupplierItemConfirmDate": {},
                    "SupplierOrderType": "ZJR",
                    "SupplierDeliveryLineItemTotalQuantity": "24000.000",
                    "SupplierDeliveryLineItemTotalQuantityUnitOfMeasure": "EA",
                    "SupplierItemGoodsIssueDate": {},
                    "SupplierItemGoodsIssueTime": "05:23:19",
                    "CustomerItemPassThru1": "ZOI6*00001*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru2": "ZOI6*00002*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru3": "ZOI6*00003*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru4": "ZOI6*00004*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru5": "ZOI6*00005*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru6": "ZOI6*00006*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru7": "ZOI6*00007*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru8": "ZOI6*00008*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru9": "ZOI6*00009*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru10": "ZOI6*00010*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru11": "ZOI6*00011*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru12": "ZOI6*00012*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru13": "ZOI6*00013*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru14": "ZOI6*00014*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "CustomerItemPassThru15": "ZOI6*00015*GUID=DE14935C47D74658E10000000AB490BB/010/20191008130206",
                    "SupplierShipTrackCodeList": [
                      {
                        "SupplierShipTrackCode": "012345ABC",
                        "SupplierAlternateShipTrackCode": "HIJKLM",
                        "SupplierChipCountryOfOriginCode3Character": "USA",
                        "SupplierChipCountryOfOriginCode2Character": "US",
                        "SupplierChipCountryOfOriginDescription": "USA",
                        "SupplierItemShipTrackCodeQuantity": "3000",
                        "SupplierBatchNumber": "1234567PHI",
                        "SupplierShipDate": {},
                        "SupplierDateCode": "2110",
                        "SupplierAlternateTrackingIdentifier": "ABCDEFGHIJK"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Contact API support for further instructions to test the ASN with your API test code.

 

Step 10: Learn how to retrieve financial document

The financial document API provides invoice information for payments. To retrieve an invoice using the financial document API, the purchase order number is a required part of the retrieve's JSON payload. Financial documents become available after TI processes shipment.

To retrieve a PDF, see documentation for configuration options.

Example:

curl --request POST \
--url 'https://transact-pre.ti.com/v1/financial-documents/retrieve' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-binary @- <<DATA
{
  "CustomerSoldToIdentifier": "123",
  "SupplierFinancialDocumentIdentifier": "1234567890",
  "CustomerReferenceIdentifier": "",
  "SupplierDeliveryIdentifier": "",
  "CustomerPurchaseOrderIdentifier": "",
  "SupplierDocumentStatus": "",
  "SupplierDocumentCreatedFromDate": "",
  "SupplierDocumentCreatedToDate": "",
  "RequestPDF": ""
}

Example response:

{
  "CustomerSoldToIdentifier": "123",
  "SupplierFinancialDocumentIdentifier": "1234567890",
  "TotalNumberOfDocuments": "1",
  "Documents": [
    {
      "SupplierDocumentType": "INVOICE",
      "SupplierFinancialDocumentIdentifier": "1234567890",
      "SupplierDocumentCreatedDate": "2020-05-11",
      "SupplierDocumentStatus": "CLEARED",
      "SupplierDocumentCurrency": "USD",
      "CustomerPurchaseOrderIdentifier": "PO1234",
      "CustomerReferenceIdentifier": "0100000200",
      "SupplierGrossWeight": "100.000",
      "SupplierNetWeight": "100.000",
      "SupplierWeightUnit": "GRM",
      "SupplierCarrier": "FEDEX EXPRESS",
      "DocumentValue": {
        "SupplierTotalAmount": "15,000.00"
      },
      "SalesOrder": {
        "SupplierOrderIdentifier": "1000001234",
        "SupplierOrderLineItemNumber": "000000",
        "CustomerPurchaseOrderIdentifier": "PO1234",
        "CustomerPurchaseOrderDate": "2020-01-01"
      },
      "PaymentTerms": {
        "SupplierIncoterms1": "TERMS1",
        "SupplierIncoterms2": "TERMS2",
        "SupplierTermsOfDelivery": "SHIPPING TERMS",
        "SupplierTermsOfPayment": "Net XX Days from Invoice Date",
        "PaymentTermsText": [
          {
            "SupplierPaymentTermsText": "Up to XX.XX.2020 without deduction"
          }
        ]
      },
      "CreditManager": {
        "SupplierCreditManagerName": "Bill Johnson",
        "SupplierCreditManagerTelephone": "1234567890",
        "SupplierCreditManagerEmail": "bj-noreply@ti.com"
      },
      "Delivery": {
        "SupplierDeliveryIdentifier": "0200000300",
        "SupplierDeliveryLineItemNumber": "000000",
        "SupplierDeliveryDate": "2020-04-13",
        "SupplierGoodsMovementDate": "2020-05-11"
      },
      "Waybill": {
        "SupplierWaybillNumber": "123456",
        "SupplierNumberOfBoxes": "1"
      },
      "Partners": [
        {
          "PartnerTypeDescription": "Sender",
          "Name1": "Texas Instruments Incorporated",
          "Name2": "Semiconductor",
          "StreetAddress": "12500 TI Boulevard",
          "City": "Dallas",
          "Region": "TX",
          "PostalCode": "75243",
          "Country": "US"
        },
        {
          "PartnerTypeDescription": "Remit To",
          "Name1": "For ACH Transfer send to:",
          "Name2": "Texas Instruments ",
          "Name3": "Bank Acct 1234567890, ABA 123456789",
          "Name4": "SWIFT 12345678",
          "City": "DALLAS",
          "Region": "TX",
          "PostalCode": "75202",
          "Country": "US"
        },
        {
          "PartnerTypeDescription": "Sold-to Party",
          "CustomerNumber": "123",
          "Name1": "TEST CUSTOMER",
          "Name2": " TEST CUSTOMER Line 2",
          "StreetAddress": "123 MAIN BLVD",
          "City": "SAN FRANCISCO",
          "Region": "CA",
          "PostalCode": "94102",
          "Country": "US"
        },
        {
          "PartnerTypeDescription": "Bill-to Party",
          "Name1": "TEST CUSTOMER",
          "Name2": "ATTN: ACCOUNTS PAYABLE DEPT",
          "StreetAddress": "123 MAIN BLVD",
          "City": "SAN FRANCISCO",
          "Region": "CA",
          "PostalCode": "94102",
          "Country": "US"
        },
        {
          "PartnerTypeDescription": "Ship-to Party",
          "CustomerNumber": "123",
          "Name1": "TEST CUSTOMER",
          "Name2": "TEST CUSTOMER Line 2",
          "StreetAddress": "123 MAIN BLVD",
          "City": "SAN FRANCISCO",
          "Region": "CA",
          "PostalCode": "94102",
          "Country": "US"
        }
      ],
      "Items": [
        {
          "SupplierOrderLineItemNumber": "000010",
          "SupplierProductIdentifier": "SM1234",
          "CustomerPartNumber": "CPN5678",
          "SupplierProductDescription": "SM1234 description",
          "SupplierItemQuantity": "300.000",
          "SupplierUnitPrice": "50.00",
          "SupplierItemValue": "15,000.00",
          "SupplierGrossWeight": "100.000",
          "SupplierNetWeight": "100.000",
          "SupplierCommercialInvoiceNumber": "1234567890",
          "SalesOrder": {
            "SupplierOrderIdentifier": "1000001234",
            "SupplierOrderLineItemNumber": "000010",
            "CustomerPurchaseOrderIdentifier": "PO1234",
            "CustomerPurchaseOrderLineItemNumber": "1",
            "CustomerPurchaseOrderDate": "2020-01-01"
          },
          "Delivery": {
            "SupplierDeliveryIdentifier": "0200000300",
            "SupplierDeliveryLineItemNumber": "000010",
            "SupplierDeliveryDate": "2020-04-13",
            "SupplierGoodsMovementDate": "2020-05-11",
            "SupplierGrossWeight": "100.000",
            "SupplierNetWeight": "100.000"
          },
          "ItemVAT": [
            {
              "SupplierTaxIndicator": "O1",
              "SupplierTaxRate": "6.250",
              "SupplierTaxAmount": "0.00",
              "SupplierTaxJurisdiction": "USTX0000000000"
            },
            {
              "SupplierTaxIndicator": "O1",
              "SupplierTaxRate": "0.500",
              "SupplierTaxAmount": "0.00",
              "SupplierTaxJurisdiction": "USTX7804500000"
            },
            {
              "SupplierTaxIndicator": "O1",
              "SupplierTaxRate": "1.250",
              "SupplierTaxAmount": "0.00",
              "SupplierTaxJurisdiction": "USTX7804518860"
            },
            {
              "SupplierTaxIndicator": "O1",
              "SupplierTaxRate": "0.000",
              "SupplierTaxAmount": "0.00",
              "SupplierTaxJurisdiction": "USTX7804518860"
            },
            {
              "SupplierTaxIndicator": "O1",
              "SupplierTaxRate": "0.250",
              "SupplierTaxAmount": "0.00",
              "SupplierTaxJurisdiction": "USTX7804518860"
            },
            {
              "SupplierTaxIndicator": "O1",
              "SupplierTaxRate": "0.000",
              "SupplierTaxAmount": "0.00",
              "SupplierTaxJurisdiction": "USTX7804518860"
            }
          ]
        }
      ]
    }
  ]
}

Contact API support for further instructions to test the financial document API retrieve with your API test code.

 

Step 11: Create remittance advice

The customer’s system can call the remittance advice API to send remittance information in order to create a remittance advice record in the TI enterprise system.

Each request must contain both header and item sections.  Header sections identifies customer’s remittance advice, payer account, and total payment information.  Item section can contain one or any numbers of detailed records, with specific payment and associated financial document information. For more details, see the backlog remittance advice API page.

Request example:

curl --request POST \
--url 'https://transact.ti.com/v1/remittance-advice' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-binary @- <<DATA
{
	"CustomerRemittanceAdviceIdentifier": "CustomerRemit100",
	"CustomerPayerIdentifier": "CustomerPayer1",
	"CustomerPaymentAmount": "100000",
	"CustomerCurrency": "USD",
	"Items": [
		{
			"CustomerNetPaymentAmount": "20000",
			"SupplierFinancialDocumentIdentifier": "1234567890",
			"CustomerFinancialDocumentIdentifier": "CustomerDoc123"
		},
		{
			"CustomerNetPaymentAmount": "30000",
			"SupplierFinancialDocumentIdentifier": "1234567891",
			"CustomerFinancialDocumentIdentifier": "CustomerDoc124"
		},
		{
			"CustomerNetPaymentAmount": "50000",
			"SupplierFinancialDocumentIdentifier": "1234567892",
			"CustomerFinancialDocumentIdentifier": ""
		}
	]
}
DATA

Response example:

{
	"SupplierRemittanceAdviceIdentifier": "0620062214281851",
	"CustomerRemittanceAdviceIdentifier": "CustomerRemit100",
	"CustomerPayerIdentifier": "CustomerPayer1",
	"CustomerPaymentAmount": "100000",
	"CustomerCurrency": "USD",
	"Messages": [
		{
			"Code": "TI-TXT-012013",
			"Type": "INFO",
			"Message": "Remittance Advice 0620062214281851 posted"
		}
	],
	"Items": [
		{
			"CustomerNetPaymentAmount": "20000",
			"SupplierFinancialDocumentIdentifier": "1234567890",
			"CustomerFinancialDocumentIdentifier": "CustomerDoc123"
		},
		{
			"CustomerNetPaymentAmount": "30000",
			"SupplierFinancialDocumentIdentifier": "1234567891",
			"CustomerFinancialDocumentIdentifier": "CustomerDoc124"
		},
		{
			"CustomerNetPaymentAmount": "50000",
			"SupplierFinancialDocumentIdentifier": "1234567892",
			"CustomerFinancialDocumentIdentifier": ""
		}
	]
}

Step 12: Where to find technical support

For technical support, see the TI E2E™ design support forums or post your question.