POST api/Invoice/GetInvoicedChgError
Request Information
URI Parameters
None.
Body Parameters
DocBLInvoice| Name | Description | Type | Additional information |
|---|---|---|---|
| IN_BL_TYPE | string |
None. |
|
| IN_CP_ID | integer |
None. |
|
| IN_VOY_ID | integer |
None. |
|
| IN_BKG_ID | integer |
None. |
|
| IN_JOH_ID | integer |
None. |
|
| IN_CON_ID | integer |
None. |
|
| IN_TYPE | string |
None. |
|
| IN_IS_PROFORMA | string |
None. |
|
| IN_IS_TAX | string |
None. |
|
| IN_DOC_NUM | string |
None. |
|
| BIH_BANK_ID | integer |
None. |
|
| IN_SHIP_TYPE | string |
None. |
|
| IN_INV_DATE | date |
None. |
|
| IN_POST_DATE | date |
None. |
|
| IN_DUE_DATE | date |
None. |
|
| IN_REFERENCE | string |
None. |
|
| IN_NARRATION | string |
None. |
|
| IN_AR_ID | integer |
None. |
|
| IN_ARG_ID | integer |
None. |
|
| IN_CUR_ID | integer |
None. |
|
| IN_INV_DETAILS | Collection of BL_INV_DETAILS |
None. |
|
| IN_EX_RATE | Collection of VIN_EX_RATE |
None. |
|
| IN_HELP_INV_FLAG | string |
None. |
|
| IN_PROGRAM_ID | string |
None. |
|
| IN_CREATED_BY | integer |
None. |
|
| INV_SI_QR | string |
None. |
|
| INV_F_FILE_NAME | string |
None. |
|
| INV_PO_ID | integer |
None. |
|
| INV_SELECTED_CHARGE_CODES | string |
None. |
|
| IN_BK_LOC_ID | integer |
None. |
|
| IN_INV_LOC_ID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"IN_BL_TYPE": "sample string 1",
"IN_CP_ID": 1,
"IN_VOY_ID": 1,
"IN_BKG_ID": 1,
"IN_JOH_ID": 1,
"IN_CON_ID": 1,
"IN_TYPE": "sample string 2",
"IN_IS_PROFORMA": "sample string 3",
"IN_IS_TAX": "sample string 4",
"IN_DOC_NUM": "sample string 5",
"BIH_BANK_ID": 1,
"IN_SHIP_TYPE": "sample string 6",
"IN_INV_DATE": "2025-12-06T04:28:52.9571542+00:00",
"IN_POST_DATE": "2025-12-06T04:28:52.9571542+00:00",
"IN_DUE_DATE": "2025-12-06T04:28:52.9571542+00:00",
"IN_REFERENCE": "sample string 7",
"IN_NARRATION": "sample string 8",
"IN_AR_ID": 1,
"IN_ARG_ID": 1,
"IN_CUR_ID": 1,
"IN_INV_DETAILS": [
{
"BRR_SELECT": true,
"BRR_ID": 1,
"BRR_BKG_ID": 1,
"BRR_BKG_NUM": "sample string 1",
"BRR_CON_ID": 1,
"BRR_CON_NUM": "sample string 2",
"BRR_CHG_ID": 1,
"BRR_CHG_CODE": "sample string 3",
"BRR_PRINT_NAME": "sample string 4",
"BRR_NOTES": "sample string 5",
"VOY_ID": 1,
"VOY_CODE": "sample string 6",
"BRR_CUR_ID": 1,
"BRR_CUR_CODE": "sample string 7",
"BRR_AMOUNT": 1.1,
"BRR_INV_CUR_ID": 1,
"BRR_INV_CUR_CODE": "sample string 8",
"BRR_CONV_RATE": 1.1,
"BRR_INV_AMOUNT": 1.1,
"BRR_CP_CUR_ID": 1,
"BRR_CP_CUR_CODE": "sample string 9",
"BRR_EX_RATE": 1.1,
"BRR_LOC_AMOUNT": 1.1,
"BRR_TAX_F_AMOUNT": 1.1,
"BRR_TAX_L_AMOUNT": 1.1,
"BRR_TX1_ID": 1,
"BRR_TX1_CODE": "sample string 10",
"BRR_TX1_REF1_CODE": "sample string 11",
"BRR_TX1_REF1_F_AMT": 1.1,
"BRR_TX1_REF1_L_AMT": 1.1,
"BRR_TX1_REF2_CODE": "sample string 12",
"BRR_TX1_REF2_F_AMT": 1.1,
"BRR_TX1_REF2_L_AMT": 1.1,
"BRR_TX1_REF3_CODE": "sample string 13",
"BRR_TX1_REF3_F_AMT": 1.1,
"BRR_TX1_REF3_L_AMT": 1.1,
"BRR_TX2_ID": 1,
"BRR_TX2_CODE": "sample string 14",
"BRR_TX2_REF1_CODE": "sample string 15",
"BRR_TX2_REF1_F_AMT": 1.1,
"BRR_TX2_REF1_L_AMT": 1.1,
"BRR_TX2_REF2_CODE": "sample string 16",
"BRR_TX2_REF2_F_AMT": 1.1,
"BRR_TX2_REF2_L_AMT": 1.1,
"BRR_TX2_REF3_CODE": "sample string 17",
"BRR_TX2_REF3_F_AMT": 1.1,
"BRR_TX2_REF3_L_AMT": 1.1,
"BRR_COMMODITY_ID": 1,
"BRR_COMMODITY_CODE": "sample string 18",
"BRR_REMARKS": "sample string 19",
"BRR_CHG_OWNER": "sample string 20",
"BRR_RATE_TYPE": "sample string 21",
"BRR_TO_ID": 1,
"BRR_TO_NUM": "sample string 22",
"BRR_TRK_ID": 1,
"BRR_TRK_CODE": "sample string 23",
"BRR_BL_TYPE": "sample string 24",
"BRR_SHIP_TYPE": "sample string 25",
"BRR_AR_ID": 1,
"BRR_AR_NAME": "sample string 26"
},
{
"BRR_SELECT": true,
"BRR_ID": 1,
"BRR_BKG_ID": 1,
"BRR_BKG_NUM": "sample string 1",
"BRR_CON_ID": 1,
"BRR_CON_NUM": "sample string 2",
"BRR_CHG_ID": 1,
"BRR_CHG_CODE": "sample string 3",
"BRR_PRINT_NAME": "sample string 4",
"BRR_NOTES": "sample string 5",
"VOY_ID": 1,
"VOY_CODE": "sample string 6",
"BRR_CUR_ID": 1,
"BRR_CUR_CODE": "sample string 7",
"BRR_AMOUNT": 1.1,
"BRR_INV_CUR_ID": 1,
"BRR_INV_CUR_CODE": "sample string 8",
"BRR_CONV_RATE": 1.1,
"BRR_INV_AMOUNT": 1.1,
"BRR_CP_CUR_ID": 1,
"BRR_CP_CUR_CODE": "sample string 9",
"BRR_EX_RATE": 1.1,
"BRR_LOC_AMOUNT": 1.1,
"BRR_TAX_F_AMOUNT": 1.1,
"BRR_TAX_L_AMOUNT": 1.1,
"BRR_TX1_ID": 1,
"BRR_TX1_CODE": "sample string 10",
"BRR_TX1_REF1_CODE": "sample string 11",
"BRR_TX1_REF1_F_AMT": 1.1,
"BRR_TX1_REF1_L_AMT": 1.1,
"BRR_TX1_REF2_CODE": "sample string 12",
"BRR_TX1_REF2_F_AMT": 1.1,
"BRR_TX1_REF2_L_AMT": 1.1,
"BRR_TX1_REF3_CODE": "sample string 13",
"BRR_TX1_REF3_F_AMT": 1.1,
"BRR_TX1_REF3_L_AMT": 1.1,
"BRR_TX2_ID": 1,
"BRR_TX2_CODE": "sample string 14",
"BRR_TX2_REF1_CODE": "sample string 15",
"BRR_TX2_REF1_F_AMT": 1.1,
"BRR_TX2_REF1_L_AMT": 1.1,
"BRR_TX2_REF2_CODE": "sample string 16",
"BRR_TX2_REF2_F_AMT": 1.1,
"BRR_TX2_REF2_L_AMT": 1.1,
"BRR_TX2_REF3_CODE": "sample string 17",
"BRR_TX2_REF3_F_AMT": 1.1,
"BRR_TX2_REF3_L_AMT": 1.1,
"BRR_COMMODITY_ID": 1,
"BRR_COMMODITY_CODE": "sample string 18",
"BRR_REMARKS": "sample string 19",
"BRR_CHG_OWNER": "sample string 20",
"BRR_RATE_TYPE": "sample string 21",
"BRR_TO_ID": 1,
"BRR_TO_NUM": "sample string 22",
"BRR_TRK_ID": 1,
"BRR_TRK_CODE": "sample string 23",
"BRR_BL_TYPE": "sample string 24",
"BRR_SHIP_TYPE": "sample string 25",
"BRR_AR_ID": 1,
"BRR_AR_NAME": "sample string 26"
}
],
"IN_EX_RATE": [
{
"FROM_CUR_ID": 1,
"FROM_CUR_CODE": "sample string 1",
"TO_CUR_ID": 1,
"TO_CUR_CODE": "sample string 2",
"EX_RATE": 1.1
},
{
"FROM_CUR_ID": 1,
"FROM_CUR_CODE": "sample string 1",
"TO_CUR_ID": 1,
"TO_CUR_CODE": "sample string 2",
"EX_RATE": 1.1
}
],
"IN_HELP_INV_FLAG": "sample string 9",
"IN_PROGRAM_ID": "sample string 10",
"IN_CREATED_BY": 1,
"INV_SI_QR": "sample string 11",
"INV_F_FILE_NAME": "sample string 12",
"INV_PO_ID": 1,
"INV_SELECTED_CHARGE_CODES": "sample string 13",
"IN_BK_LOC_ID": 1,
"IN_INV_LOC_ID": 1
}
application/xml, text/xml
Sample:
<DocBLInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZealitAPI.Models">
<BIH_BANK_ID>1</BIH_BANK_ID>
<INV_F_FILE_NAME>sample string 12</INV_F_FILE_NAME>
<INV_PO_ID>1</INV_PO_ID>
<INV_SELECTED_CHARGE_CODES>sample string 13</INV_SELECTED_CHARGE_CODES>
<INV_SI_QR>sample string 11</INV_SI_QR>
<IN_ARG_ID>1</IN_ARG_ID>
<IN_AR_ID>1</IN_AR_ID>
<IN_BKG_ID>1</IN_BKG_ID>
<IN_BK_LOC_ID>1</IN_BK_LOC_ID>
<IN_BL_TYPE>sample string 1</IN_BL_TYPE>
<IN_CON_ID>1</IN_CON_ID>
<IN_CP_ID>1</IN_CP_ID>
<IN_CREATED_BY>1</IN_CREATED_BY>
<IN_CUR_ID>1</IN_CUR_ID>
<IN_DOC_NUM>sample string 5</IN_DOC_NUM>
<IN_DUE_DATE>2025-12-06T04:28:52.9571542+00:00</IN_DUE_DATE>
<IN_EX_RATE>
<VIN_EX_RATE>
<EX_RATE>1.1</EX_RATE>
<FROM_CUR_CODE>sample string 1</FROM_CUR_CODE>
<FROM_CUR_ID>1</FROM_CUR_ID>
<TO_CUR_CODE>sample string 2</TO_CUR_CODE>
<TO_CUR_ID>1</TO_CUR_ID>
</VIN_EX_RATE>
<VIN_EX_RATE>
<EX_RATE>1.1</EX_RATE>
<FROM_CUR_CODE>sample string 1</FROM_CUR_CODE>
<FROM_CUR_ID>1</FROM_CUR_ID>
<TO_CUR_CODE>sample string 2</TO_CUR_CODE>
<TO_CUR_ID>1</TO_CUR_ID>
</VIN_EX_RATE>
</IN_EX_RATE>
<IN_HELP_INV_FLAG>sample string 9</IN_HELP_INV_FLAG>
<IN_INV_DATE>2025-12-06T04:28:52.9571542+00:00</IN_INV_DATE>
<IN_INV_DETAILS>
<BL_INV_DETAILS>
<BRR_AMOUNT>1.1</BRR_AMOUNT>
<BRR_AR_ID>1</BRR_AR_ID>
<BRR_AR_NAME>sample string 26</BRR_AR_NAME>
<BRR_BKG_ID>1</BRR_BKG_ID>
<BRR_BKG_NUM>sample string 1</BRR_BKG_NUM>
<BRR_BL_TYPE>sample string 24</BRR_BL_TYPE>
<BRR_CHG_CODE>sample string 3</BRR_CHG_CODE>
<BRR_CHG_ID>1</BRR_CHG_ID>
<BRR_CHG_OWNER>sample string 20</BRR_CHG_OWNER>
<BRR_COMMODITY_CODE>sample string 18</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 2</BRR_CON_NUM>
<BRR_CP_CUR_CODE>sample string 9</BRR_CP_CUR_CODE>
<BRR_CP_CUR_ID>1</BRR_CP_CUR_ID>
<BRR_CUR_CODE>sample string 7</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 8</BRR_INV_CUR_CODE>
<BRR_INV_CUR_ID>1</BRR_INV_CUR_ID>
<BRR_LOC_AMOUNT>1.1</BRR_LOC_AMOUNT>
<BRR_NOTES>sample string 5</BRR_NOTES>
<BRR_PRINT_NAME>sample string 4</BRR_PRINT_NAME>
<BRR_RATE_TYPE>sample string 21</BRR_RATE_TYPE>
<BRR_REMARKS>sample string 19</BRR_REMARKS>
<BRR_SELECT>true</BRR_SELECT>
<BRR_SHIP_TYPE>sample string 25</BRR_SHIP_TYPE>
<BRR_TAX_F_AMOUNT>1.1</BRR_TAX_F_AMOUNT>
<BRR_TAX_L_AMOUNT>1.1</BRR_TAX_L_AMOUNT>
<BRR_TO_ID>1</BRR_TO_ID>
<BRR_TO_NUM>sample string 22</BRR_TO_NUM>
<BRR_TRK_CODE>sample string 23</BRR_TRK_CODE>
<BRR_TRK_ID>1</BRR_TRK_ID>
<BRR_TX1_CODE>sample string 10</BRR_TX1_CODE>
<BRR_TX1_ID>1</BRR_TX1_ID>
<BRR_TX1_REF1_CODE>sample string 11</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_CODE>sample string 12</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_CODE>sample string 13</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_TX2_CODE>sample string 14</BRR_TX2_CODE>
<BRR_TX2_ID>1</BRR_TX2_ID>
<BRR_TX2_REF1_CODE>sample string 15</BRR_TX2_REF1_CODE>
<BRR_TX2_REF1_F_AMT>1.1</BRR_TX2_REF1_F_AMT>
<BRR_TX2_REF1_L_AMT>1.1</BRR_TX2_REF1_L_AMT>
<BRR_TX2_REF2_CODE>sample string 16</BRR_TX2_REF2_CODE>
<BRR_TX2_REF2_F_AMT>1.1</BRR_TX2_REF2_F_AMT>
<BRR_TX2_REF2_L_AMT>1.1</BRR_TX2_REF2_L_AMT>
<BRR_TX2_REF3_CODE>sample string 17</BRR_TX2_REF3_CODE>
<BRR_TX2_REF3_F_AMT>1.1</BRR_TX2_REF3_F_AMT>
<BRR_TX2_REF3_L_AMT>1.1</BRR_TX2_REF3_L_AMT>
<VOY_CODE>sample string 6</VOY_CODE>
<VOY_ID>1</VOY_ID>
</BL_INV_DETAILS>
<BL_INV_DETAILS>
<BRR_AMOUNT>1.1</BRR_AMOUNT>
<BRR_AR_ID>1</BRR_AR_ID>
<BRR_AR_NAME>sample string 26</BRR_AR_NAME>
<BRR_BKG_ID>1</BRR_BKG_ID>
<BRR_BKG_NUM>sample string 1</BRR_BKG_NUM>
<BRR_BL_TYPE>sample string 24</BRR_BL_TYPE>
<BRR_CHG_CODE>sample string 3</BRR_CHG_CODE>
<BRR_CHG_ID>1</BRR_CHG_ID>
<BRR_CHG_OWNER>sample string 20</BRR_CHG_OWNER>
<BRR_COMMODITY_CODE>sample string 18</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 2</BRR_CON_NUM>
<BRR_CP_CUR_CODE>sample string 9</BRR_CP_CUR_CODE>
<BRR_CP_CUR_ID>1</BRR_CP_CUR_ID>
<BRR_CUR_CODE>sample string 7</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 8</BRR_INV_CUR_CODE>
<BRR_INV_CUR_ID>1</BRR_INV_CUR_ID>
<BRR_LOC_AMOUNT>1.1</BRR_LOC_AMOUNT>
<BRR_NOTES>sample string 5</BRR_NOTES>
<BRR_PRINT_NAME>sample string 4</BRR_PRINT_NAME>
<BRR_RATE_TYPE>sample string 21</BRR_RATE_TYPE>
<BRR_REMARKS>sample string 19</BRR_REMARKS>
<BRR_SELECT>true</BRR_SELECT>
<BRR_SHIP_TYPE>sample string 25</BRR_SHIP_TYPE>
<BRR_TAX_F_AMOUNT>1.1</BRR_TAX_F_AMOUNT>
<BRR_TAX_L_AMOUNT>1.1</BRR_TAX_L_AMOUNT>
<BRR_TO_ID>1</BRR_TO_ID>
<BRR_TO_NUM>sample string 22</BRR_TO_NUM>
<BRR_TRK_CODE>sample string 23</BRR_TRK_CODE>
<BRR_TRK_ID>1</BRR_TRK_ID>
<BRR_TX1_CODE>sample string 10</BRR_TX1_CODE>
<BRR_TX1_ID>1</BRR_TX1_ID>
<BRR_TX1_REF1_CODE>sample string 11</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_CODE>sample string 12</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_CODE>sample string 13</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_TX2_CODE>sample string 14</BRR_TX2_CODE>
<BRR_TX2_ID>1</BRR_TX2_ID>
<BRR_TX2_REF1_CODE>sample string 15</BRR_TX2_REF1_CODE>
<BRR_TX2_REF1_F_AMT>1.1</BRR_TX2_REF1_F_AMT>
<BRR_TX2_REF1_L_AMT>1.1</BRR_TX2_REF1_L_AMT>
<BRR_TX2_REF2_CODE>sample string 16</BRR_TX2_REF2_CODE>
<BRR_TX2_REF2_F_AMT>1.1</BRR_TX2_REF2_F_AMT>
<BRR_TX2_REF2_L_AMT>1.1</BRR_TX2_REF2_L_AMT>
<BRR_TX2_REF3_CODE>sample string 17</BRR_TX2_REF3_CODE>
<BRR_TX2_REF3_F_AMT>1.1</BRR_TX2_REF3_F_AMT>
<BRR_TX2_REF3_L_AMT>1.1</BRR_TX2_REF3_L_AMT>
<VOY_CODE>sample string 6</VOY_CODE>
<VOY_ID>1</VOY_ID>
</BL_INV_DETAILS>
</IN_INV_DETAILS>
<IN_INV_LOC_ID>1</IN_INV_LOC_ID>
<IN_IS_PROFORMA>sample string 3</IN_IS_PROFORMA>
<IN_IS_TAX>sample string 4</IN_IS_TAX>
<IN_JOH_ID>1</IN_JOH_ID>
<IN_NARRATION>sample string 8</IN_NARRATION>
<IN_POST_DATE>2025-12-06T04:28:52.9571542+00:00</IN_POST_DATE>
<IN_PROGRAM_ID>sample string 10</IN_PROGRAM_ID>
<IN_REFERENCE>sample string 7</IN_REFERENCE>
<IN_SHIP_TYPE>sample string 6</IN_SHIP_TYPE>
<IN_TYPE>sample string 2</IN_TYPE>
<IN_VOY_ID>1</IN_VOY_ID>
</DocBLInvoice>
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. |