POST api/Invoice/PostAgencyInvoice
Request Information
URI Parameters
None.
Body Parameters
AgencyInvoice| Name | Description | Type | Additional information |
|---|---|---|---|
| IN_CP_ID | integer |
None. |
|
| IN_AG_ID | integer |
None. |
|
| IN_VOY_ID | integer |
None. |
|
| IN_INV_TYPE | string |
None. |
|
| IN_SHIP_TYPE | string |
None. |
|
| IN_INV_DATE | date |
None. |
|
| IN_POST_DATE | date |
None. |
|
| IN_REFERENCE | string |
None. |
|
| IN_NARRATION | string |
None. |
|
| IN_FROM_DATE | date |
None. |
|
| IN_TO_DATE | date |
None. |
|
| IN_AUTO_VDA | string |
None. |
|
| IN_PROGRAM_ID | string |
None. |
|
| IN_CREATED_BY | integer |
None. |
|
| IN_INV_DETAILS | Collection of AG_INV_DETAILS |
None. |
Request Formats
application/json, text/json
Sample:
{
"IN_CP_ID": 1,
"IN_AG_ID": 1,
"IN_VOY_ID": 1,
"IN_INV_TYPE": "sample string 1",
"IN_SHIP_TYPE": "sample string 2",
"IN_INV_DATE": "2025-12-06T05:21:17.1192796+00:00",
"IN_POST_DATE": "2025-12-06T05:21:17.1192796+00:00",
"IN_REFERENCE": "sample string 3",
"IN_NARRATION": "sample string 4",
"IN_FROM_DATE": "2025-12-06T05:21:17.1192796+00:00",
"IN_TO_DATE": "2025-12-06T05:21:17.1192796+00:00",
"IN_AUTO_VDA": "sample string 5",
"IN_PROGRAM_ID": "sample string 6",
"IN_CREATED_BY": 1,
"IN_INV_DETAILS": [
{
"BRR_SELECT": true,
"BRR_TYPE": "sample string 1",
"BRR_TYPE_CODE": "sample string 2",
"BRR_ID": 1,
"BRR_COL_AT": 1,
"BRR_COL_AT_CODE": "sample string 3",
"BRR_BKG_ID": 1,
"BRR_BKG_NUM": "sample string 4",
"BRR_CON_ID": 1,
"BRR_CON_NUM": "sample string 5",
"BRR_CHG_ID": 1,
"BRR_CHG_CODE": "sample string 6",
"VOY_ID": 1,
"VOY_CODE": "sample string 7",
"BRR_CUR_ID": 1,
"BRR_CUR_CODE": "sample string 8",
"BRR_AMOUNT": 1.1,
"BRR_INV_CUR_ID": 1,
"BRR_INV_CUR_CODE": "sample string 9",
"BRR_CONV_RATE": 1.1,
"BRR_INV_AMOUNT": 1.1,
"BRR_CP_CUR_ID": 1,
"BRR_CP_CUR_CODE": "sample string 10",
"BRR_EX_RATE": 1.1,
"BRR_LOC_AMOUNT": 1.1,
"BRR_AG_CUR_ID": 1,
"BRR_AG_CUR_CODE": "sample string 11",
"BRR_AG_EX_RATE": 1.1,
"BRR_AG_LOC_AMOUNT": 1.1,
"BRR_TAX_F_AMOUNT": 1.1,
"BRR_TAX_L_AMOUNT": 1.1,
"BRR_TAX_AG_L_AMOUNT": 1.1,
"BRR_TX1_ID": 1,
"BRR_TX1_CODE": "sample string 12",
"BRR_TX1_REF1_CODE": "sample string 13",
"BRR_TX1_REF1_F_AMT": 1.1,
"BRR_TX1_REF1_L_AMT": 1.1,
"BRR_TX1_REF1_AG_L_AMT": 1.1,
"BRR_TX1_REF2_CODE": "sample string 14",
"BRR_TX1_REF2_F_AMT": 1.1,
"BRR_TX1_REF2_L_AMT": 1.1,
"BRR_TX1_REF2_AG_L_AMT": 1.1,
"BRR_TX1_REF3_CODE": "sample string 15",
"BRR_TX1_REF3_F_AMT": 1.1,
"BRR_TX1_REF3_L_AMT": 1.1,
"BRR_TX1_REF3_AG_L_AMT": 1.1,
"BRR_COMMODITY_ID": 1,
"BRR_COMMODITY_CODE": "sample string 16",
"BRR_REMARKS": "sample string 17",
"BRR_RATE_TYPE": "sample string 18"
},
{
"BRR_SELECT": true,
"BRR_TYPE": "sample string 1",
"BRR_TYPE_CODE": "sample string 2",
"BRR_ID": 1,
"BRR_COL_AT": 1,
"BRR_COL_AT_CODE": "sample string 3",
"BRR_BKG_ID": 1,
"BRR_BKG_NUM": "sample string 4",
"BRR_CON_ID": 1,
"BRR_CON_NUM": "sample string 5",
"BRR_CHG_ID": 1,
"BRR_CHG_CODE": "sample string 6",
"VOY_ID": 1,
"VOY_CODE": "sample string 7",
"BRR_CUR_ID": 1,
"BRR_CUR_CODE": "sample string 8",
"BRR_AMOUNT": 1.1,
"BRR_INV_CUR_ID": 1,
"BRR_INV_CUR_CODE": "sample string 9",
"BRR_CONV_RATE": 1.1,
"BRR_INV_AMOUNT": 1.1,
"BRR_CP_CUR_ID": 1,
"BRR_CP_CUR_CODE": "sample string 10",
"BRR_EX_RATE": 1.1,
"BRR_LOC_AMOUNT": 1.1,
"BRR_AG_CUR_ID": 1,
"BRR_AG_CUR_CODE": "sample string 11",
"BRR_AG_EX_RATE": 1.1,
"BRR_AG_LOC_AMOUNT": 1.1,
"BRR_TAX_F_AMOUNT": 1.1,
"BRR_TAX_L_AMOUNT": 1.1,
"BRR_TAX_AG_L_AMOUNT": 1.1,
"BRR_TX1_ID": 1,
"BRR_TX1_CODE": "sample string 12",
"BRR_TX1_REF1_CODE": "sample string 13",
"BRR_TX1_REF1_F_AMT": 1.1,
"BRR_TX1_REF1_L_AMT": 1.1,
"BRR_TX1_REF1_AG_L_AMT": 1.1,
"BRR_TX1_REF2_CODE": "sample string 14",
"BRR_TX1_REF2_F_AMT": 1.1,
"BRR_TX1_REF2_L_AMT": 1.1,
"BRR_TX1_REF2_AG_L_AMT": 1.1,
"BRR_TX1_REF3_CODE": "sample string 15",
"BRR_TX1_REF3_F_AMT": 1.1,
"BRR_TX1_REF3_L_AMT": 1.1,
"BRR_TX1_REF3_AG_L_AMT": 1.1,
"BRR_COMMODITY_ID": 1,
"BRR_COMMODITY_CODE": "sample string 16",
"BRR_REMARKS": "sample string 17",
"BRR_RATE_TYPE": "sample string 18"
}
]
}
application/xml, text/xml
Sample:
<AgencyInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZealitAPI.Models">
<IN_AG_ID>1</IN_AG_ID>
<IN_AUTO_VDA>sample string 5</IN_AUTO_VDA>
<IN_CP_ID>1</IN_CP_ID>
<IN_CREATED_BY>1</IN_CREATED_BY>
<IN_FROM_DATE>2025-12-06T05:21:17.1192796+00:00</IN_FROM_DATE>
<IN_INV_DATE>2025-12-06T05:21:17.1192796+00:00</IN_INV_DATE>
<IN_INV_DETAILS>
<AG_INV_DETAILS>
<BRR_AG_CUR_CODE>sample string 11</BRR_AG_CUR_CODE>
<BRR_AG_CUR_ID>1</BRR_AG_CUR_ID>
<BRR_AG_EX_RATE>1.1</BRR_AG_EX_RATE>
<BRR_AG_LOC_AMOUNT>1.1</BRR_AG_LOC_AMOUNT>
<BRR_AMOUNT>1.1</BRR_AMOUNT>
<BRR_BKG_ID>1</BRR_BKG_ID>
<BRR_BKG_NUM>sample string 4</BRR_BKG_NUM>
<BRR_CHG_CODE>sample string 6</BRR_CHG_CODE>
<BRR_CHG_ID>1</BRR_CHG_ID>
<BRR_COL_AT>1</BRR_COL_AT>
<BRR_COL_AT_CODE>sample string 3</BRR_COL_AT_CODE>
<BRR_COMMODITY_CODE>sample string 16</BRR_COMMODITY_CODE>
<BRR_COMMODITY_ID>1</BRR_COMMODITY_ID>
<BRR_CONV_RATE>1.1</BRR_CONV_RATE>
<BRR_CON_ID>1</BRR_CON_ID>
<BRR_CON_NUM>sample string 5</BRR_CON_NUM>
<BRR_CP_CUR_CODE>sample string 10</BRR_CP_CUR_CODE>
<BRR_CP_CUR_ID>1</BRR_CP_CUR_ID>
<BRR_CUR_CODE>sample string 8</BRR_CUR_CODE>
<BRR_CUR_ID>1</BRR_CUR_ID>
<BRR_EX_RATE>1.1</BRR_EX_RATE>
<BRR_ID>1</BRR_ID>
<BRR_INV_AMOUNT>1.1</BRR_INV_AMOUNT>
<BRR_INV_CUR_CODE>sample string 9</BRR_INV_CUR_CODE>
<BRR_INV_CUR_ID>1</BRR_INV_CUR_ID>
<BRR_LOC_AMOUNT>1.1</BRR_LOC_AMOUNT>
<BRR_RATE_TYPE>sample string 18</BRR_RATE_TYPE>
<BRR_REMARKS>sample string 17</BRR_REMARKS>
<BRR_SELECT>true</BRR_SELECT>
<BRR_TAX_AG_L_AMOUNT>1.1</BRR_TAX_AG_L_AMOUNT>
<BRR_TAX_F_AMOUNT>1.1</BRR_TAX_F_AMOUNT>
<BRR_TAX_L_AMOUNT>1.1</BRR_TAX_L_AMOUNT>
<BRR_TX1_CODE>sample string 12</BRR_TX1_CODE>
<BRR_TX1_ID>1</BRR_TX1_ID>
<BRR_TX1_REF1_AG_L_AMT>1.1</BRR_TX1_REF1_AG_L_AMT>
<BRR_TX1_REF1_CODE>sample string 13</BRR_TX1_REF1_CODE>
<BRR_TX1_REF1_F_AMT>1.1</BRR_TX1_REF1_F_AMT>
<BRR_TX1_REF1_L_AMT>1.1</BRR_TX1_REF1_L_AMT>
<BRR_TX1_REF2_AG_L_AMT>1.1</BRR_TX1_REF2_AG_L_AMT>
<BRR_TX1_REF2_CODE>sample string 14</BRR_TX1_REF2_CODE>
<BRR_TX1_REF2_F_AMT>1.1</BRR_TX1_REF2_F_AMT>
<BRR_TX1_REF2_L_AMT>1.1</BRR_TX1_REF2_L_AMT>
<BRR_TX1_REF3_AG_L_AMT>1.1</BRR_TX1_REF3_AG_L_AMT>
<BRR_TX1_REF3_CODE>sample string 15</BRR_TX1_REF3_CODE>
<BRR_TX1_REF3_F_AMT>1.1</BRR_TX1_REF3_F_AMT>
<BRR_TX1_REF3_L_AMT>1.1</BRR_TX1_REF3_L_AMT>
<BRR_TYPE>sample string 1</BRR_TYPE>
<BRR_TYPE_CODE>sample string 2</BRR_TYPE_CODE>
<VOY_CODE>sample string 7</VOY_CODE>
<VOY_ID>1</VOY_ID>
</AG_INV_DETAILS>
<AG_INV_DETAILS>
<BRR_AG_CUR_CODE>sample string 11</BRR_AG_CUR_CODE>
<BRR_AG_CUR_ID>1</BRR_AG_CUR_ID>
<BRR_AG_EX_RATE>1.1</BRR_AG_EX_RATE>
<BRR_AG_LOC_AMOUNT>1.1</BRR_AG_LOC_AMOUNT>
<BRR_AMOUNT>1.1</BRR_AMOUNT>
<BRR_BKG_ID>1</BRR_BKG_ID>
<BRR_BKG_NUM>sample string 4</BRR_BKG_NUM>
<BRR_CHG_CODE>sample string 6</BRR_CHG_CODE>
<BRR_CHG_ID>1</BRR_CHG_ID>
<BRR_COL_AT>1</BRR_COL_AT>
<BRR_COL_AT_CODE>sample string 3</BRR_COL_AT_CODE>
<BRR_COMMODITY_CODE>sample string 16</BRR_COMMODITY_CODE>
<BRR_COMMODITY_ID>1</BRR_COMMODITY_ID>
<BRR_CONV_RATE>1.1</BRR_CONV_RATE>
<BRR_CON_ID>1</BRR_CON_ID>
<BRR_CON_NUM>sample string 5</BRR_CON_NUM>
<BRR_CP_CUR_CODE>sample string 10</BRR_CP_CUR_CODE>
<BRR_CP_CUR_ID>1</BRR_CP_CUR_ID>
<BRR_CUR_CODE>sample string 8</BRR_CUR_CODE>
<BRR_CUR_ID>1</BRR_CUR_ID>
<BRR_EX_RATE>1.1</BRR_EX_RATE>
<BRR_ID>1</BRR_ID>
<BRR_INV_AMOUNT>1.1</BRR_INV_AMOUNT>
<BRR_INV_CUR_CODE>sample string 9</BRR_INV_CUR_CODE>
<BRR_INV_CUR_ID>1</BRR_INV_CUR_ID>
<BRR_LOC_AMOUNT>1.1</BRR_LOC_AMOUNT>
<BRR_RATE_TYPE>sample string 18</BRR_RATE_TYPE>
<BRR_REMARKS>sample string 17</BRR_REMARKS>
<BRR_SELECT>true</BRR_SELECT>
<BRR_TAX_AG_L_AMOUNT>1.1</BRR_TAX_AG_L_AMOUNT>
<BRR_TAX_F_AMOUNT>1.1</BRR_TAX_F_AMOUNT>
<BRR_TAX_L_AMOUNT>1.1</BRR_TAX_L_AMOUNT>
<BRR_TX1_CODE>sample string 12</BRR_TX1_CODE>
<BRR_TX1_ID>1</BRR_TX1_ID>
<BRR_TX1_REF1_AG_L_AMT>1.1</BRR_TX1_REF1_AG_L_AMT>
<BRR_TX1_REF1_CODE>sample string 13</BRR_TX1_REF1_CODE>
<BRR_TX1_REF1_F_AMT>1.1</BRR_TX1_REF1_F_AMT>
<BRR_TX1_REF1_L_AMT>1.1</BRR_TX1_REF1_L_AMT>
<BRR_TX1_REF2_AG_L_AMT>1.1</BRR_TX1_REF2_AG_L_AMT>
<BRR_TX1_REF2_CODE>sample string 14</BRR_TX1_REF2_CODE>
<BRR_TX1_REF2_F_AMT>1.1</BRR_TX1_REF2_F_AMT>
<BRR_TX1_REF2_L_AMT>1.1</BRR_TX1_REF2_L_AMT>
<BRR_TX1_REF3_AG_L_AMT>1.1</BRR_TX1_REF3_AG_L_AMT>
<BRR_TX1_REF3_CODE>sample string 15</BRR_TX1_REF3_CODE>
<BRR_TX1_REF3_F_AMT>1.1</BRR_TX1_REF3_F_AMT>
<BRR_TX1_REF3_L_AMT>1.1</BRR_TX1_REF3_L_AMT>
<BRR_TYPE>sample string 1</BRR_TYPE>
<BRR_TYPE_CODE>sample string 2</BRR_TYPE_CODE>
<VOY_CODE>sample string 7</VOY_CODE>
<VOY_ID>1</VOY_ID>
</AG_INV_DETAILS>
</IN_INV_DETAILS>
<IN_INV_TYPE>sample string 1</IN_INV_TYPE>
<IN_NARRATION>sample string 4</IN_NARRATION>
<IN_POST_DATE>2025-12-06T05:21:17.1192796+00:00</IN_POST_DATE>
<IN_PROGRAM_ID>sample string 6</IN_PROGRAM_ID>
<IN_REFERENCE>sample string 3</IN_REFERENCE>
<IN_SHIP_TYPE>sample string 2</IN_SHIP_TYPE>
<IN_TO_DATE>2025-12-06T05:21:17.1192796+00:00</IN_TO_DATE>
<IN_VOY_ID>1</IN_VOY_ID>
</AgencyInvoice>
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. |