POST api/TransportOrder/VendorInvRetriveCharges
Request Information
URI Parameters
None.
Body Parameters
VendorInvoice| Name | Description | Type | Additional information |
|---|---|---|---|
| VIN_TYPE | string |
None. |
|
| VIN_CP_ID | integer |
None. |
|
| VIN_CHG_ID | integer |
None. |
|
| VIN_INV_DATE | date |
None. |
|
| VIN_POST_DATE | date |
None. |
|
| VIN_DUE_DATE | date |
None. |
|
| VIN_REFERENCE | string |
None. |
|
| VIN_NARRATION | string |
None. |
|
| VIN_TO_ID | integer |
None. |
|
| VIN_AP_ID | integer |
None. |
|
| VIN_APG_ID | integer |
None. |
|
| VIN_CUR_ID | integer |
None. |
|
| VIN_TDS_ID | integer |
None. |
|
| VIN_TO_DRV_FLAG | integer |
None. |
|
| VIN_INC_DRAFT | string |
None. |
|
| BL_VIN_DETAILS_V1 | Collection of BL_VIN_DETAILS_V1 |
None. |
|
| VIN_ATTACHMENT | Collection of VIN_ATTACHMENT |
None. |
|
| VIN_MODE | string |
None. |
|
| VIN_PROGRAM_ID | string |
None. |
|
| VIN_CREATED_BY | integer |
None. |
|
| VIN_ADV_PAY | string |
None. |
|
| VIN_IOU | string |
None. |
|
| VIN_IS_INVOICEABLE | string |
None. |
|
| VIN_SELECTED_CHARGE_CODES | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"VIN_TYPE": "sample string 1",
"VIN_CP_ID": 1,
"VIN_CHG_ID": 1,
"VIN_INV_DATE": "2025-12-06T04:24:01.7725312+00:00",
"VIN_POST_DATE": "2025-12-06T04:24:01.7725312+00:00",
"VIN_DUE_DATE": "2025-12-06T04:24:01.7725312+00:00",
"VIN_REFERENCE": "sample string 3",
"VIN_NARRATION": "sample string 4",
"VIN_TO_ID": 1,
"VIN_AP_ID": 1,
"VIN_APG_ID": 1,
"VIN_CUR_ID": 1,
"VIN_TDS_ID": 1,
"VIN_TO_DRV_FLAG": 1,
"VIN_INC_DRAFT": "sample string 5",
"BL_VIN_DETAILS_V1": [
{
"BRC_SELECT": true,
"BRC_ID": 1,
"BRC_BKG_ID": 1,
"BRC_BKG_NUM": "sample string 1",
"BRC_CON_ID": 1,
"BRC_CON_NUM": "sample string 2",
"BRC_CHG_ID": 1,
"BRC_CHG_CODE": "sample string 3",
"VOY_ID": 1,
"VOY_CODE": "sample string 4",
"BRC_CUR_ID": 1,
"BRC_CUR_CODE": "sample string 5",
"BRC_AMOUNT": 1.1,
"BRC_AMOUNT_NEW": 1.1,
"BRC_INV_CUR_ID": 1,
"BRC_INV_CUR_CODE": "sample string 6",
"BRC_CONV_RATE": 1.1,
"BRC_INV_AMOUNT": 1.1,
"BRC_CP_CUR_ID": 1,
"BRC_CP_CUR_CODE": "sample string 7",
"BRC_EX_RATE": 1.1,
"BRC_LOC_AMOUNT": 1.1,
"BRC_TAX_F_AMOUNT": 1.1,
"BRC_TAX_L_AMOUNT": 1.1,
"BRC_TX1_ID": 1,
"BRC_TX1_CODE": "sample string 8",
"BRC_TX1_REF1_CODE": "sample string 9",
"BRC_TX1_REF1_F_AMT": 1.1,
"BRC_TX1_REF1_L_AMT": 1.1,
"BRC_TX1_REF2_CODE": "sample string 10",
"BRC_TX1_REF2_F_AMT": 1.1,
"BRC_TX1_REF2_L_AMT": 1.1,
"BRC_TX1_REF3_CODE": "sample string 11",
"BRC_TX1_REF3_F_AMT": 1.1,
"BRC_TX1_REF3_L_AMT": 1.1,
"BRC_TX2_ID": 1,
"BRC_TX2_CODE": "sample string 12",
"BRC_TX2_REF1_CODE": "sample string 13",
"BRC_TX2_REF1_F_AMT": 1.1,
"BRC_TX2_REF1_L_AMT": 1.1,
"BRC_TX2_REF2_CODE": "sample string 14",
"BRC_TX2_REF2_F_AMT": 1.1,
"BRC_TX2_REF2_L_AMT": 1.1,
"BRC_TX2_REF3_CODE": "sample string 15",
"BRC_TX2_REF3_F_AMT": 1.1,
"BRC_TX2_REF3_L_AMT": 1.1,
"BRC_COMMODITY_ID": 1,
"BRC_COMMODITY_CODE": "sample string 16",
"BRC_REMARKS": "sample string 17",
"BRC_CHG_OWNER": "sample string 18",
"BRC_RATE_TYPE": "sample string 19",
"BRC_TO_ID": 1,
"BRC_TO_NUM": "sample string 20",
"BRC_TRK_ID": 1,
"BRC_TRK_CODE": "sample string 21"
},
{
"BRC_SELECT": true,
"BRC_ID": 1,
"BRC_BKG_ID": 1,
"BRC_BKG_NUM": "sample string 1",
"BRC_CON_ID": 1,
"BRC_CON_NUM": "sample string 2",
"BRC_CHG_ID": 1,
"BRC_CHG_CODE": "sample string 3",
"VOY_ID": 1,
"VOY_CODE": "sample string 4",
"BRC_CUR_ID": 1,
"BRC_CUR_CODE": "sample string 5",
"BRC_AMOUNT": 1.1,
"BRC_AMOUNT_NEW": 1.1,
"BRC_INV_CUR_ID": 1,
"BRC_INV_CUR_CODE": "sample string 6",
"BRC_CONV_RATE": 1.1,
"BRC_INV_AMOUNT": 1.1,
"BRC_CP_CUR_ID": 1,
"BRC_CP_CUR_CODE": "sample string 7",
"BRC_EX_RATE": 1.1,
"BRC_LOC_AMOUNT": 1.1,
"BRC_TAX_F_AMOUNT": 1.1,
"BRC_TAX_L_AMOUNT": 1.1,
"BRC_TX1_ID": 1,
"BRC_TX1_CODE": "sample string 8",
"BRC_TX1_REF1_CODE": "sample string 9",
"BRC_TX1_REF1_F_AMT": 1.1,
"BRC_TX1_REF1_L_AMT": 1.1,
"BRC_TX1_REF2_CODE": "sample string 10",
"BRC_TX1_REF2_F_AMT": 1.1,
"BRC_TX1_REF2_L_AMT": 1.1,
"BRC_TX1_REF3_CODE": "sample string 11",
"BRC_TX1_REF3_F_AMT": 1.1,
"BRC_TX1_REF3_L_AMT": 1.1,
"BRC_TX2_ID": 1,
"BRC_TX2_CODE": "sample string 12",
"BRC_TX2_REF1_CODE": "sample string 13",
"BRC_TX2_REF1_F_AMT": 1.1,
"BRC_TX2_REF1_L_AMT": 1.1,
"BRC_TX2_REF2_CODE": "sample string 14",
"BRC_TX2_REF2_F_AMT": 1.1,
"BRC_TX2_REF2_L_AMT": 1.1,
"BRC_TX2_REF3_CODE": "sample string 15",
"BRC_TX2_REF3_F_AMT": 1.1,
"BRC_TX2_REF3_L_AMT": 1.1,
"BRC_COMMODITY_ID": 1,
"BRC_COMMODITY_CODE": "sample string 16",
"BRC_REMARKS": "sample string 17",
"BRC_CHG_OWNER": "sample string 18",
"BRC_RATE_TYPE": "sample string 19",
"BRC_TO_ID": 1,
"BRC_TO_NUM": "sample string 20",
"BRC_TRK_ID": 1,
"BRC_TRK_CODE": "sample string 21"
}
],
"VIN_ATTACHMENT": [
{
"VIA_ID": 1,
"VIA_ATH_NAME": "sample string 1",
"VIA_FILE_NAME": "sample string 2",
"VIA_DETAILS": "sample string 3"
},
{
"VIA_ID": 1,
"VIA_ATH_NAME": "sample string 1",
"VIA_FILE_NAME": "sample string 2",
"VIA_DETAILS": "sample string 3"
}
],
"VIN_MODE": "sample string 6",
"VIN_PROGRAM_ID": "sample string 7",
"VIN_CREATED_BY": 1,
"VIN_ADV_PAY": "sample string 8",
"VIN_IOU": "sample string 9",
"VIN_IS_INVOICEABLE": "sample string 10",
"VIN_SELECTED_CHARGE_CODES": "sample string 11"
}
application/xml, text/xml
Sample:
<VendorInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZealitAPI.Models">
<BL_VIN_DETAILS_V1>
<BL_VIN_DETAILS_V1>
<BRC_AMOUNT>1.1</BRC_AMOUNT>
<BRC_AMOUNT_NEW>1.1</BRC_AMOUNT_NEW>
<BRC_BKG_ID>1</BRC_BKG_ID>
<BRC_BKG_NUM>sample string 1</BRC_BKG_NUM>
<BRC_CHG_CODE>sample string 3</BRC_CHG_CODE>
<BRC_CHG_ID>1</BRC_CHG_ID>
<BRC_CHG_OWNER>sample string 18</BRC_CHG_OWNER>
<BRC_COMMODITY_CODE>sample string 16</BRC_COMMODITY_CODE>
<BRC_COMMODITY_ID>1</BRC_COMMODITY_ID>
<BRC_CONV_RATE>1.1</BRC_CONV_RATE>
<BRC_CON_ID>1</BRC_CON_ID>
<BRC_CON_NUM>sample string 2</BRC_CON_NUM>
<BRC_CP_CUR_CODE>sample string 7</BRC_CP_CUR_CODE>
<BRC_CP_CUR_ID>1</BRC_CP_CUR_ID>
<BRC_CUR_CODE>sample string 5</BRC_CUR_CODE>
<BRC_CUR_ID>1</BRC_CUR_ID>
<BRC_EX_RATE>1.1</BRC_EX_RATE>
<BRC_ID>1</BRC_ID>
<BRC_INV_AMOUNT>1.1</BRC_INV_AMOUNT>
<BRC_INV_CUR_CODE>sample string 6</BRC_INV_CUR_CODE>
<BRC_INV_CUR_ID>1</BRC_INV_CUR_ID>
<BRC_LOC_AMOUNT>1.1</BRC_LOC_AMOUNT>
<BRC_RATE_TYPE>sample string 19</BRC_RATE_TYPE>
<BRC_REMARKS>sample string 17</BRC_REMARKS>
<BRC_SELECT>true</BRC_SELECT>
<BRC_TAX_F_AMOUNT>1.1</BRC_TAX_F_AMOUNT>
<BRC_TAX_L_AMOUNT>1.1</BRC_TAX_L_AMOUNT>
<BRC_TO_ID>1</BRC_TO_ID>
<BRC_TO_NUM>sample string 20</BRC_TO_NUM>
<BRC_TRK_CODE>sample string 21</BRC_TRK_CODE>
<BRC_TRK_ID>1</BRC_TRK_ID>
<BRC_TX1_CODE>sample string 8</BRC_TX1_CODE>
<BRC_TX1_ID>1</BRC_TX1_ID>
<BRC_TX1_REF1_CODE>sample string 9</BRC_TX1_REF1_CODE>
<BRC_TX1_REF1_F_AMT>1.1</BRC_TX1_REF1_F_AMT>
<BRC_TX1_REF1_L_AMT>1.1</BRC_TX1_REF1_L_AMT>
<BRC_TX1_REF2_CODE>sample string 10</BRC_TX1_REF2_CODE>
<BRC_TX1_REF2_F_AMT>1.1</BRC_TX1_REF2_F_AMT>
<BRC_TX1_REF2_L_AMT>1.1</BRC_TX1_REF2_L_AMT>
<BRC_TX1_REF3_CODE>sample string 11</BRC_TX1_REF3_CODE>
<BRC_TX1_REF3_F_AMT>1.1</BRC_TX1_REF3_F_AMT>
<BRC_TX1_REF3_L_AMT>1.1</BRC_TX1_REF3_L_AMT>
<BRC_TX2_CODE>sample string 12</BRC_TX2_CODE>
<BRC_TX2_ID>1</BRC_TX2_ID>
<BRC_TX2_REF1_CODE>sample string 13</BRC_TX2_REF1_CODE>
<BRC_TX2_REF1_F_AMT>1.1</BRC_TX2_REF1_F_AMT>
<BRC_TX2_REF1_L_AMT>1.1</BRC_TX2_REF1_L_AMT>
<BRC_TX2_REF2_CODE>sample string 14</BRC_TX2_REF2_CODE>
<BRC_TX2_REF2_F_AMT>1.1</BRC_TX2_REF2_F_AMT>
<BRC_TX2_REF2_L_AMT>1.1</BRC_TX2_REF2_L_AMT>
<BRC_TX2_REF3_CODE>sample string 15</BRC_TX2_REF3_CODE>
<BRC_TX2_REF3_F_AMT>1.1</BRC_TX2_REF3_F_AMT>
<BRC_TX2_REF3_L_AMT>1.1</BRC_TX2_REF3_L_AMT>
<VOY_CODE>sample string 4</VOY_CODE>
<VOY_ID>1</VOY_ID>
</BL_VIN_DETAILS_V1>
<BL_VIN_DETAILS_V1>
<BRC_AMOUNT>1.1</BRC_AMOUNT>
<BRC_AMOUNT_NEW>1.1</BRC_AMOUNT_NEW>
<BRC_BKG_ID>1</BRC_BKG_ID>
<BRC_BKG_NUM>sample string 1</BRC_BKG_NUM>
<BRC_CHG_CODE>sample string 3</BRC_CHG_CODE>
<BRC_CHG_ID>1</BRC_CHG_ID>
<BRC_CHG_OWNER>sample string 18</BRC_CHG_OWNER>
<BRC_COMMODITY_CODE>sample string 16</BRC_COMMODITY_CODE>
<BRC_COMMODITY_ID>1</BRC_COMMODITY_ID>
<BRC_CONV_RATE>1.1</BRC_CONV_RATE>
<BRC_CON_ID>1</BRC_CON_ID>
<BRC_CON_NUM>sample string 2</BRC_CON_NUM>
<BRC_CP_CUR_CODE>sample string 7</BRC_CP_CUR_CODE>
<BRC_CP_CUR_ID>1</BRC_CP_CUR_ID>
<BRC_CUR_CODE>sample string 5</BRC_CUR_CODE>
<BRC_CUR_ID>1</BRC_CUR_ID>
<BRC_EX_RATE>1.1</BRC_EX_RATE>
<BRC_ID>1</BRC_ID>
<BRC_INV_AMOUNT>1.1</BRC_INV_AMOUNT>
<BRC_INV_CUR_CODE>sample string 6</BRC_INV_CUR_CODE>
<BRC_INV_CUR_ID>1</BRC_INV_CUR_ID>
<BRC_LOC_AMOUNT>1.1</BRC_LOC_AMOUNT>
<BRC_RATE_TYPE>sample string 19</BRC_RATE_TYPE>
<BRC_REMARKS>sample string 17</BRC_REMARKS>
<BRC_SELECT>true</BRC_SELECT>
<BRC_TAX_F_AMOUNT>1.1</BRC_TAX_F_AMOUNT>
<BRC_TAX_L_AMOUNT>1.1</BRC_TAX_L_AMOUNT>
<BRC_TO_ID>1</BRC_TO_ID>
<BRC_TO_NUM>sample string 20</BRC_TO_NUM>
<BRC_TRK_CODE>sample string 21</BRC_TRK_CODE>
<BRC_TRK_ID>1</BRC_TRK_ID>
<BRC_TX1_CODE>sample string 8</BRC_TX1_CODE>
<BRC_TX1_ID>1</BRC_TX1_ID>
<BRC_TX1_REF1_CODE>sample string 9</BRC_TX1_REF1_CODE>
<BRC_TX1_REF1_F_AMT>1.1</BRC_TX1_REF1_F_AMT>
<BRC_TX1_REF1_L_AMT>1.1</BRC_TX1_REF1_L_AMT>
<BRC_TX1_REF2_CODE>sample string 10</BRC_TX1_REF2_CODE>
<BRC_TX1_REF2_F_AMT>1.1</BRC_TX1_REF2_F_AMT>
<BRC_TX1_REF2_L_AMT>1.1</BRC_TX1_REF2_L_AMT>
<BRC_TX1_REF3_CODE>sample string 11</BRC_TX1_REF3_CODE>
<BRC_TX1_REF3_F_AMT>1.1</BRC_TX1_REF3_F_AMT>
<BRC_TX1_REF3_L_AMT>1.1</BRC_TX1_REF3_L_AMT>
<BRC_TX2_CODE>sample string 12</BRC_TX2_CODE>
<BRC_TX2_ID>1</BRC_TX2_ID>
<BRC_TX2_REF1_CODE>sample string 13</BRC_TX2_REF1_CODE>
<BRC_TX2_REF1_F_AMT>1.1</BRC_TX2_REF1_F_AMT>
<BRC_TX2_REF1_L_AMT>1.1</BRC_TX2_REF1_L_AMT>
<BRC_TX2_REF2_CODE>sample string 14</BRC_TX2_REF2_CODE>
<BRC_TX2_REF2_F_AMT>1.1</BRC_TX2_REF2_F_AMT>
<BRC_TX2_REF2_L_AMT>1.1</BRC_TX2_REF2_L_AMT>
<BRC_TX2_REF3_CODE>sample string 15</BRC_TX2_REF3_CODE>
<BRC_TX2_REF3_F_AMT>1.1</BRC_TX2_REF3_F_AMT>
<BRC_TX2_REF3_L_AMT>1.1</BRC_TX2_REF3_L_AMT>
<VOY_CODE>sample string 4</VOY_CODE>
<VOY_ID>1</VOY_ID>
</BL_VIN_DETAILS_V1>
</BL_VIN_DETAILS_V1>
<VIN_ADV_PAY>sample string 8</VIN_ADV_PAY>
<VIN_APG_ID>1</VIN_APG_ID>
<VIN_AP_ID>1</VIN_AP_ID>
<VIN_ATTACHMENT>
<VIN_ATTACHMENT>
<VIA_ATH_NAME>sample string 1</VIA_ATH_NAME>
<VIA_DETAILS>sample string 3</VIA_DETAILS>
<VIA_FILE_NAME>sample string 2</VIA_FILE_NAME>
<VIA_ID>1</VIA_ID>
</VIN_ATTACHMENT>
<VIN_ATTACHMENT>
<VIA_ATH_NAME>sample string 1</VIA_ATH_NAME>
<VIA_DETAILS>sample string 3</VIA_DETAILS>
<VIA_FILE_NAME>sample string 2</VIA_FILE_NAME>
<VIA_ID>1</VIA_ID>
</VIN_ATTACHMENT>
</VIN_ATTACHMENT>
<VIN_CHG_ID>1</VIN_CHG_ID>
<VIN_CP_ID>1</VIN_CP_ID>
<VIN_CREATED_BY>1</VIN_CREATED_BY>
<VIN_CUR_ID>1</VIN_CUR_ID>
<VIN_DUE_DATE>2025-12-06T04:24:01.7725312+00:00</VIN_DUE_DATE>
<VIN_INC_DRAFT>sample string 5</VIN_INC_DRAFT>
<VIN_INV_DATE>2025-12-06T04:24:01.7725312+00:00</VIN_INV_DATE>
<VIN_IOU>sample string 9</VIN_IOU>
<VIN_IS_INVOICEABLE>sample string 10</VIN_IS_INVOICEABLE>
<VIN_MODE>sample string 6</VIN_MODE>
<VIN_NARRATION>sample string 4</VIN_NARRATION>
<VIN_POST_DATE>2025-12-06T04:24:01.7725312+00:00</VIN_POST_DATE>
<VIN_PROGRAM_ID>sample string 7</VIN_PROGRAM_ID>
<VIN_REFERENCE>sample string 3</VIN_REFERENCE>
<VIN_SELECTED_CHARGE_CODES>sample string 11</VIN_SELECTED_CHARGE_CODES>
<VIN_TDS_ID>1</VIN_TDS_ID>
<VIN_TO_DRV_FLAG>1</VIN_TO_DRV_FLAG>
<VIN_TO_ID>1</VIN_TO_ID>
<VIN_TYPE>sample string 1</VIN_TYPE>
</VendorInvoice>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |