Available Invoice Fields List API

The Invoice Field List API is for users that want to retrieve the list of fields available for use with Transware’s Invoice-related APIs.

HTTP Method	URL	Authentication Type
GET	/api/v1/invoices/fields	Bearer Token

Request Query String Parameter

An optional query parameter can be passed as part of the request if you are looking for a certain field.

Name	Type	Required	Description
fieldName	String	Optional	Define a single term for which you can search and determine if a field is available with that name. This is always a contains search, so a request passing “number” will return results like: Pro NumberInvoice NumberBill of Lading Number

Response Parameters

The response will contain all available fields and their data type.

Name	Type	Description
fieldID	Numeric	The unique ID of each field in VTM’s database. When interacting with other Transware Invoice APIs that include defining a list of fields (like the Invoice Search API), this is the value that should be used
fieldTechnicalName	String	The unique name of each field in VTM’s database
fieldDisplayName	String	The display name of each field in VTM’s database (will match what is used in the Transware web interface)
fieldDataType	String	The data type used for each field (numeric, string, date etc)

Sample Request

https://transware.vtm.com/api/v1/invoices/fields

With the optional query parameter used:

https://transware.vtm.com/api/v1/invoices/fields?fieldName=num

Sample Response

{
    "result": [
        {
            "fieldID": 3,
            "fieldTechnicalName": "FP_PRO_NUMBER",
            "fieldDisplayName": "Pro Number",
            "fieldDataType": "String"
        },
        {
            "fieldID": 6,
            "fieldTechnicalName": "FP_BILL_LADING_NUMBER",
            "fieldDisplayName": "B/L Number",
            "fieldDataType": "String"
        },
        {
            "fieldID": 53,
            "fieldTechnicalName": "TRACKING_NUMBER",
            "fieldDisplayName": "Tracking Number",
            "fieldDataType": "String"
        },
        {
            "fieldID": 57,
            "fieldTechnicalName": "Container_Number",
            "fieldDisplayName": "Container Number",
            "fieldDataType": "String"
        }
    ]
}