POST api/EWB/Invoice?AppSecret={AppSecret}&TransporterId={TransporterId}&User={User}&IPAddress={IPAddress}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AppSecret | string |
Required |
|
| TransporterId | string |
Required |
|
| User | string |
Required |
|
| IPAddress | string |
Required |
Body Parameters
Invoice| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | string |
None. |
|
| TranDtls | TranDtls |
None. |
|
| DocDtls | DocDtls |
None. |
|
| SellerDtls | SellerDtls |
None. |
|
| BuyerDtls | BuyerDtls |
None. |
|
| DispDtls | DispDtls |
None. |
|
| ShipDtls | ShipDtls |
None. |
|
| ItemList | Collection of ItemList |
None. |
|
| ValDtls | ValDtls |
None. |
|
| PayDtls | PayDtls |
None. |
|
| RefDtls | RefDtls |
None. |
|
| AddlDocDtls | Collection of AddlDocDtl |
None. |
|
| ExpDtls | ExpDtls |
None. |
|
| EwbDtls | EwbDtls |
None. |
Request Formats
application/json, text/json
Sample:
{
"Version": "sample string 1",
"TranDtls": {
"TaxSch": "sample string 1",
"SupTyp": "sample string 2",
"RegRev": "sample string 3",
"EcmGstin": {},
"IgstOnIntra": "sample string 5"
},
"DocDtls": {
"Typ": "sample string 1",
"No": "sample string 2",
"Dt": "sample string 3"
},
"SellerDtls": {
"Gstin": "sample string 1",
"LglNm": "sample string 2",
"TrdNm": "sample string 3",
"Addr1": "sample string 4",
"Addr2": "sample string 5",
"Loc": "sample string 6",
"Pin": 7,
"Stcd": "sample string 8",
"Ph": "sample string 9",
"Em": "sample string 10"
},
"BuyerDtls": {
"Gstin": "sample string 1",
"LglNm": "sample string 2",
"TrdNm": "sample string 3",
"Pos": "sample string 4",
"Addr1": "sample string 5",
"Addr2": "sample string 6",
"Loc": "sample string 7",
"Pin": 8,
"Stcd": "sample string 9",
"Ph": "sample string 10",
"Em": "sample string 11"
},
"DispDtls": {
"Nm": "sample string 1",
"Addr1": "sample string 2",
"Addr2": "sample string 3",
"Loc": "sample string 4",
"Pin": 5,
"Stcd": "sample string 6"
},
"ShipDtls": {
"Gstin": "sample string 1",
"LglNm": "sample string 2",
"TrdNm": "sample string 3",
"Addr1": "sample string 4",
"Addr2": "sample string 5",
"Loc": "sample string 6",
"Pin": 7,
"Stcd": "sample string 8"
},
"ItemList": [
{
"SlNo": "sample string 1",
"PrdDesc": "sample string 2",
"IsServc": "sample string 3",
"HsnCd": "sample string 4",
"Barcde": "sample string 5",
"Qty": 6.1,
"FreeQty": 7.1,
"Unit": "sample string 8",
"UnitPrice": 9.1,
"TotAmt": 10.1,
"Discount": 11.1,
"PreTaxVal": 12.1,
"AssAmt": 13.1,
"GstRt": 14.1,
"IgstAmt": 15.1,
"CgstAmt": 16.1,
"SgstAmt": 17.1,
"CesRt": 18.1,
"CesAmt": 19.1,
"CesNonAdvlAmt": 20.1,
"StateCesRt": 21.1,
"StateCesAmt": 22.1,
"StateCesNonAdvlAmt": 23.1,
"OthChrg": 24.1,
"TotItemVal": 25.1,
"OrdLineRef": "sample string 26",
"OrgCntry": "sample string 27",
"PrdSlNo": "sample string 28",
"BchDtls": {
"Nm": "sample string 1",
"ExpDt": "sample string 2",
"WrDt": "sample string 3"
},
"AttribDtls": [
{
"Nm": "sample string 1",
"Val": "sample string 2"
},
{
"Nm": "sample string 1",
"Val": "sample string 2"
}
]
},
{
"SlNo": "sample string 1",
"PrdDesc": "sample string 2",
"IsServc": "sample string 3",
"HsnCd": "sample string 4",
"Barcde": "sample string 5",
"Qty": 6.1,
"FreeQty": 7.1,
"Unit": "sample string 8",
"UnitPrice": 9.1,
"TotAmt": 10.1,
"Discount": 11.1,
"PreTaxVal": 12.1,
"AssAmt": 13.1,
"GstRt": 14.1,
"IgstAmt": 15.1,
"CgstAmt": 16.1,
"SgstAmt": 17.1,
"CesRt": 18.1,
"CesAmt": 19.1,
"CesNonAdvlAmt": 20.1,
"StateCesRt": 21.1,
"StateCesAmt": 22.1,
"StateCesNonAdvlAmt": 23.1,
"OthChrg": 24.1,
"TotItemVal": 25.1,
"OrdLineRef": "sample string 26",
"OrgCntry": "sample string 27",
"PrdSlNo": "sample string 28",
"BchDtls": {
"Nm": "sample string 1",
"ExpDt": "sample string 2",
"WrDt": "sample string 3"
},
"AttribDtls": [
{
"Nm": "sample string 1",
"Val": "sample string 2"
},
{
"Nm": "sample string 1",
"Val": "sample string 2"
}
]
}
],
"ValDtls": {
"AssVal": 1.1,
"CgstVal": 2.1,
"SgstVal": 3.1,
"IgstVal": 4.1,
"CesVal": 5.1,
"StCesVal": 6.1,
"Discount": 7.1,
"OthChrg": 8.1,
"RndOffAmt": 9.1,
"TotInvVal": 10.1,
"TotInvValFc": 11.1
},
"PayDtls": {
"Nm": "sample string 1",
"AccDet": "sample string 2",
"Mode": "sample string 3",
"FinInsBr": "sample string 4",
"PayTerm": "sample string 5",
"PayInstr": "sample string 6",
"CrTrn": "sample string 7",
"DirDr": "sample string 8",
"CrDay": 9.1,
"PaidAmt": 10.1,
"PaymtDue": 11.1
},
"RefDtls": {
"InvRm": "sample string 1",
"DocPerdDtls": {
"InvStDt": "sample string 1",
"InvEndDt": "sample string 2"
},
"PrecDocDtls": [
{
"InvNo": "sample string 1",
"InvDt": "sample string 2",
"OthRefNo": "sample string 3"
},
{
"InvNo": "sample string 1",
"InvDt": "sample string 2",
"OthRefNo": "sample string 3"
}
],
"ContrDtls": [
{
"RecAdvRefr": "sample string 1",
"RecAdvDt": "sample string 2",
"TendRefr": "sample string 3",
"ContrRefr": "sample string 4",
"ExtRefr": "sample string 5",
"ProjRefr": "sample string 6",
"PORefr": "sample string 7",
"PORefDt": "sample string 8"
},
{
"RecAdvRefr": "sample string 1",
"RecAdvDt": "sample string 2",
"TendRefr": "sample string 3",
"ContrRefr": "sample string 4",
"ExtRefr": "sample string 5",
"ProjRefr": "sample string 6",
"PORefr": "sample string 7",
"PORefDt": "sample string 8"
}
]
},
"AddlDocDtls": [
{
"Url": "sample string 1",
"Docs": "sample string 2",
"Info": "sample string 3"
},
{
"Url": "sample string 1",
"Docs": "sample string 2",
"Info": "sample string 3"
}
],
"ExpDtls": {
"ShipBNo": "sample string 1",
"ShipBDt": "sample string 2",
"Port": "sample string 3",
"RefClm": "sample string 4",
"ForCur": "sample string 5",
"CntCode": "sample string 6",
"ExpDuty": {}
},
"EwbDtls": {
"TransId": "sample string 1",
"TransName": "sample string 2",
"Distance": 3,
"TransDocNo": "sample string 4",
"TransDocDt": "sample string 5",
"VehNo": "sample string 6",
"VehType": "sample string 7",
"TransMode": "sample string 8"
}
}
application/xml, text/xml
Sample:
<Invoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apis.Areas.EInvoice.Models">
<AddlDocDtls>
<AddlDocDtl>
<Docs>sample string 2</Docs>
<Info>sample string 3</Info>
<Url>sample string 1</Url>
</AddlDocDtl>
<AddlDocDtl>
<Docs>sample string 2</Docs>
<Info>sample string 3</Info>
<Url>sample string 1</Url>
</AddlDocDtl>
</AddlDocDtls>
<BuyerDtls>
<Addr1>sample string 5</Addr1>
<Addr2>sample string 6</Addr2>
<Em>sample string 11</Em>
<Gstin>sample string 1</Gstin>
<LglNm>sample string 2</LglNm>
<Loc>sample string 7</Loc>
<Ph>sample string 10</Ph>
<Pin>8</Pin>
<Pos>sample string 4</Pos>
<Stcd>sample string 9</Stcd>
<TrdNm>sample string 3</TrdNm>
</BuyerDtls>
<DispDtls>
<Addr1>sample string 2</Addr1>
<Addr2>sample string 3</Addr2>
<Loc>sample string 4</Loc>
<Nm>sample string 1</Nm>
<Pin>5</Pin>
<Stcd>sample string 6</Stcd>
</DispDtls>
<DocDtls>
<Dt>sample string 3</Dt>
<No>sample string 2</No>
<Typ>sample string 1</Typ>
</DocDtls>
<EwbDtls>
<Distance>3</Distance>
<TransDocDt>sample string 5</TransDocDt>
<TransDocNo>sample string 4</TransDocNo>
<TransId>sample string 1</TransId>
<TransMode>sample string 8</TransMode>
<TransName>sample string 2</TransName>
<VehNo>sample string 6</VehNo>
<VehType>sample string 7</VehType>
</EwbDtls>
<ExpDtls>
<CntCode>sample string 6</CntCode>
<ExpDuty />
<ForCur>sample string 5</ForCur>
<Port>sample string 3</Port>
<RefClm>sample string 4</RefClm>
<ShipBDt>sample string 2</ShipBDt>
<ShipBNo>sample string 1</ShipBNo>
</ExpDtls>
<ItemList>
<ItemList>
<AssAmt>13.1</AssAmt>
<AttribDtls>
<AttribDtl>
<Nm>sample string 1</Nm>
<Val>sample string 2</Val>
</AttribDtl>
<AttribDtl>
<Nm>sample string 1</Nm>
<Val>sample string 2</Val>
</AttribDtl>
</AttribDtls>
<Barcde>sample string 5</Barcde>
<BchDtls>
<ExpDt>sample string 2</ExpDt>
<Nm>sample string 1</Nm>
<WrDt>sample string 3</WrDt>
</BchDtls>
<CesAmt>19.1</CesAmt>
<CesNonAdvlAmt>20.1</CesNonAdvlAmt>
<CesRt>18.1</CesRt>
<CgstAmt>16.1</CgstAmt>
<Discount>11.1</Discount>
<FreeQty>7.1</FreeQty>
<GstRt>14.1</GstRt>
<HsnCd>sample string 4</HsnCd>
<IgstAmt>15.1</IgstAmt>
<IsServc>sample string 3</IsServc>
<OrdLineRef>sample string 26</OrdLineRef>
<OrgCntry>sample string 27</OrgCntry>
<OthChrg>24.1</OthChrg>
<PrdDesc>sample string 2</PrdDesc>
<PrdSlNo>sample string 28</PrdSlNo>
<PreTaxVal>12.1</PreTaxVal>
<Qty>6.1</Qty>
<SgstAmt>17.1</SgstAmt>
<SlNo>sample string 1</SlNo>
<StateCesAmt>22.1</StateCesAmt>
<StateCesNonAdvlAmt>23.1</StateCesNonAdvlAmt>
<StateCesRt>21.1</StateCesRt>
<TotAmt>10.1</TotAmt>
<TotItemVal>25.1</TotItemVal>
<Unit>sample string 8</Unit>
<UnitPrice>9.1</UnitPrice>
</ItemList>
<ItemList>
<AssAmt>13.1</AssAmt>
<AttribDtls>
<AttribDtl>
<Nm>sample string 1</Nm>
<Val>sample string 2</Val>
</AttribDtl>
<AttribDtl>
<Nm>sample string 1</Nm>
<Val>sample string 2</Val>
</AttribDtl>
</AttribDtls>
<Barcde>sample string 5</Barcde>
<BchDtls>
<ExpDt>sample string 2</ExpDt>
<Nm>sample string 1</Nm>
<WrDt>sample string 3</WrDt>
</BchDtls>
<CesAmt>19.1</CesAmt>
<CesNonAdvlAmt>20.1</CesNonAdvlAmt>
<CesRt>18.1</CesRt>
<CgstAmt>16.1</CgstAmt>
<Discount>11.1</Discount>
<FreeQty>7.1</FreeQty>
<GstRt>14.1</GstRt>
<HsnCd>sample string 4</HsnCd>
<IgstAmt>15.1</IgstAmt>
<IsServc>sample string 3</IsServc>
<OrdLineRef>sample string 26</OrdLineRef>
<OrgCntry>sample string 27</OrgCntry>
<OthChrg>24.1</OthChrg>
<PrdDesc>sample string 2</PrdDesc>
<PrdSlNo>sample string 28</PrdSlNo>
<PreTaxVal>12.1</PreTaxVal>
<Qty>6.1</Qty>
<SgstAmt>17.1</SgstAmt>
<SlNo>sample string 1</SlNo>
<StateCesAmt>22.1</StateCesAmt>
<StateCesNonAdvlAmt>23.1</StateCesNonAdvlAmt>
<StateCesRt>21.1</StateCesRt>
<TotAmt>10.1</TotAmt>
<TotItemVal>25.1</TotItemVal>
<Unit>sample string 8</Unit>
<UnitPrice>9.1</UnitPrice>
</ItemList>
</ItemList>
<PayDtls>
<AccDet>sample string 2</AccDet>
<CrDay>9.1</CrDay>
<CrTrn>sample string 7</CrTrn>
<DirDr>sample string 8</DirDr>
<FinInsBr>sample string 4</FinInsBr>
<Mode>sample string 3</Mode>
<Nm>sample string 1</Nm>
<PaidAmt>10.1</PaidAmt>
<PayInstr>sample string 6</PayInstr>
<PayTerm>sample string 5</PayTerm>
<PaymtDue>11.1</PaymtDue>
</PayDtls>
<RefDtls>
<ContrDtls>
<ContrDtl>
<ContrRefr>sample string 4</ContrRefr>
<ExtRefr>sample string 5</ExtRefr>
<PORefDt>sample string 8</PORefDt>
<PORefr>sample string 7</PORefr>
<ProjRefr>sample string 6</ProjRefr>
<RecAdvDt>sample string 2</RecAdvDt>
<RecAdvRefr>sample string 1</RecAdvRefr>
<TendRefr>sample string 3</TendRefr>
</ContrDtl>
<ContrDtl>
<ContrRefr>sample string 4</ContrRefr>
<ExtRefr>sample string 5</ExtRefr>
<PORefDt>sample string 8</PORefDt>
<PORefr>sample string 7</PORefr>
<ProjRefr>sample string 6</ProjRefr>
<RecAdvDt>sample string 2</RecAdvDt>
<RecAdvRefr>sample string 1</RecAdvRefr>
<TendRefr>sample string 3</TendRefr>
</ContrDtl>
</ContrDtls>
<DocPerdDtls>
<InvEndDt>sample string 2</InvEndDt>
<InvStDt>sample string 1</InvStDt>
</DocPerdDtls>
<InvRm>sample string 1</InvRm>
<PrecDocDtls>
<PrecDocDtl>
<InvDt>sample string 2</InvDt>
<InvNo>sample string 1</InvNo>
<OthRefNo>sample string 3</OthRefNo>
</PrecDocDtl>
<PrecDocDtl>
<InvDt>sample string 2</InvDt>
<InvNo>sample string 1</InvNo>
<OthRefNo>sample string 3</OthRefNo>
</PrecDocDtl>
</PrecDocDtls>
</RefDtls>
<SellerDtls>
<Addr1>sample string 4</Addr1>
<Addr2>sample string 5</Addr2>
<Em>sample string 10</Em>
<Gstin>sample string 1</Gstin>
<LglNm>sample string 2</LglNm>
<Loc>sample string 6</Loc>
<Ph>sample string 9</Ph>
<Pin>7</Pin>
<Stcd>sample string 8</Stcd>
<TrdNm>sample string 3</TrdNm>
</SellerDtls>
<ShipDtls>
<Addr1>sample string 4</Addr1>
<Addr2>sample string 5</Addr2>
<Gstin>sample string 1</Gstin>
<LglNm>sample string 2</LglNm>
<Loc>sample string 6</Loc>
<Pin>7</Pin>
<Stcd>sample string 8</Stcd>
<TrdNm>sample string 3</TrdNm>
</ShipDtls>
<TranDtls>
<EcmGstin />
<IgstOnIntra>sample string 5</IgstOnIntra>
<RegRev>sample string 3</RegRev>
<SupTyp>sample string 2</SupTyp>
<TaxSch>sample string 1</TaxSch>
</TranDtls>
<ValDtls>
<AssVal>1.1</AssVal>
<CesVal>5.1</CesVal>
<CgstVal>2.1</CgstVal>
<Discount>7.1</Discount>
<IgstVal>4.1</IgstVal>
<OthChrg>8.1</OthChrg>
<RndOffAmt>9.1</RndOffAmt>
<SgstVal>3.1</SgstVal>
<StCesVal>6.1</StCesVal>
<TotInvVal>10.1</TotInvVal>
<TotInvValFc>11.1</TotInvValFc>
</ValDtls>
<Version>sample string 1</Version>
</Invoice>
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. |