ZATCA Compliance Invoices Testing API
POST
https://apisandbox.whitebooks.in/einvoice/compliance/invoicesIt performs compliance checks on einvoice documents.
Parameters
header parameters
Auth-KeystringoptionalAuth-Key
Accept-LanguagestringoptionalAccept-Language
Accept-VersionstringrequiredAccept-Version
Request Body
application/jsonrequired
VersionstringoptionalVersion Type
Example: "1.1"
TranDtlsobjectoptionalTaxSchstringoptionalTax type
Example: "GST"
SupTypstringoptionalSupply Type
Example: "B2B"
RegRevstringoptionalReg Rev
Example: "Y"
EcmGstinstringoptionalnullableEcom GSTIN
Example: null
IgstOnIntrastringoptionalIGST On Intra
Example: "N"
DocDtlsobjectoptionalTypstringoptionalType
Example: "INV"
NostringoptionalInvoice Number
Example: "MAHI/10"
DtstringoptionalInvoice Date
Example: "08/08/2020"
SellerDtlsobjectoptionalGstinstringoptionalGST Number
Example: "29AABCT1332L000"
LglNmstringoptionalLegal Name
Example: "ABC company pvt ltd"
TrdNmstringoptionalTrade Name
Example: "NIC Industries"
Addr1stringoptionalAddress1
Example: "5th block, kuvempu layout"
Addr2stringoptionalAddress2
Example: "kuvempu layout"
LocstringoptionalLocation Name
Example: "GANDHINAGAR"
PinnumberoptionalPincode Number
Example: 560001
StcdstringoptionalState Code
Example: "29"
PhstringoptionalPhone Number
Example: "9000000000"
EmstringoptionalEmail Id
Example: "abc@gmail.com"
BuyerDtlsobjectoptionalGstinstringoptionalGST Number
Example: "29AWGPV7107B1Z1"
LglNmstringoptionalLegal Name
Example: "XYZ company pvt ltd"
TrdNmstringoptionalTrade Name
Example: "XYZ Industries"
PosstringoptionalPlace of Supply
Example: "37"
Addr1stringoptionalAddress1
Example: "7th block, kuvempu layout"
Addr2stringoptionalAddress2
Example: "kuvempu layout"
LocstringoptionalLocation Name
Example: "GANDHINAGAR"
PinnumberoptionalPincode Number
Example: 560004
StcdstringoptionalState Code
Example: "29"
PhstringoptionalPhone Number
Example: "9000000000"
EmstringoptionalEmail Id
Example: "abc@gmail.com"
DispDtlsobjectoptionalNmstringoptionalName
Example: "ABC company pvt ltd"
Addr1stringoptionalAddress1
Example: "7th block, kuvempu layout"
Addr2stringoptionalAddress2
Example: "kuvempu layout"
LocstringoptionalLocation Name
Example: "Banagalore"
PinnumberoptionalPincode Number
Example: 518360
StcdstringoptionalState Name
Example: "37"
ShipDtlsobjectoptionalGstinstringoptionalGST Number
Example: "29AWGPV7107B1Z1"
LglNmstringoptionalLegal Name
Example: "CBE company pvt ltd"
TrdNmstringoptionalTrade Name
Example: "kuvempu layout"
Addr1stringoptionalAddress1
Example: "7th block, kuvempu layout"
Addr2stringoptionalAddress2
Example: "kuvempu layout"
LocstringoptionalLocation Name
Example: "Banagalore"
PinnumberoptionalPincode Number
Example: 518360
StcdstringoptionalState Name
Example: "37"
ItemListarray<einvoicetypeGENERATEversionV1_1_ItemList>optionalArray items:
SlNostringoptionalSerial Number
Example: "1"
IsServcstringoptionalService
Example: "N"
PrdDescstringoptionalProduct Description
Example: "Rice"
HsnCdstringoptionalHSN Code
Example: "1001"
BarcdestringoptionalBar Code
Example: "123456"
BchDtlsobjectoptionalNmstringoptionalTax type
Example: "123456"
ExpdtstringoptionalTax type
Example: "01/08/2020"
wrDtstringoptionalTax type
Example: "01/09/2020"
QtynumberoptionalQuntity
Example: 100.345
FreeQtynumberoptionalFree Quntity
Example: 10
UnitstringoptionalUnits Of Measurment
Example: "NOS"
UnitPricenumberoptionalUnit Price
Example: 99.545
TotAmtnumberoptionalTotal Amount
Example: 9988.84
DiscountnumberoptionalDiscount
Example: 10
PreTaxValnumberoptionalDiscount
Example: 1
AssAmtnumberoptionalAssesment Amount
Example: 9978.84
GstRtnumberoptionalnullablegst Rate
Example: 12
SgstAmtnumberoptionalSgst Rate
Example: 0
IgstAmtnumberoptionalIgst Rate
Example: 1197.46
CgstAmtnumberoptionalCgst Rate
Example: 0
CesRtnumberoptionalCess Rate
Example: 5
CesAmtnumberoptionalCess Amount
Example: 498.94
CesNonAdvlAmtnumberoptionalCesNonAd value
Example: 10
StateCesRtnumberoptionalState Cess Rate
Example: 12
StateCesAmtnumberoptionalState Cess Amount
Example: 1197.46
StateCesNonAdvlAmtnumberoptionalState Cess none advance Amount
Example: 5
OthChrgnumberoptionalOther Charges
Example: 10
TotItemValnumberoptionalTotal Item Value
Example: 12897.7
OrdLineRefstringoptionalTotal Item Value
Example: "3256"
OrgCntrystringoptionalTotal Item Value
Example: "AG"
PrdSlNostringoptionalTotal Item Value
Example: "12345"
AttribDtlsarray<einvoicetypeGENERATEversionV1_1_AttribDtls>optionalArray items:
NmstringoptionalTax type
Example: "Rice"
ValstringoptionalTax type
Example: "10000"
ValDtlsobjectoptionalAssValnumberoptionalAssestment Val
Example: 9978.84
CgstValnumberoptionalCgst Value
Example: 0
SgstValnumberoptionalSgst Value
Example: 0
IgstValnumberoptionalIgst Value
Example: 1197.46
CesValnumberoptionalCess Value
Example: 508.94
StCesValnumberoptionalStCess Value
Example: 1202.46
DiscountnumberoptionalStCess Value
Example: 10
OthChrgnumberoptionalStCess Value
Example: 20
RndOffAmtnumberoptionalRound off
Example: 0.3
TotInvValnumberoptionalTotal Invoice Value
Example: 12908
TotInvValFcnumberoptionalStCess Value
Example: 12897.7
PayDtlsobjectoptionalNmstringoptionalState Name
Example: "ABCDE"
AccdetstringoptionalState Name
Example: "5697389713210"
ModestringoptionalState Name
Example: "Cash"
FininsbrstringoptionalState Name
Example: "SBIN11000"
PaytermstringoptionalState Name
Example: "100"
PayinstrstringoptionalState Name
Example: "Gift"
CrtrnstringoptionalState Name
Example: "test"
DirdrstringoptionalState Name
Example: "test"
CrdaynumberoptionalState Name
Example: 100
PaidamtnumberoptionalState Name
Example: 10000
PaymtduenumberoptionalState Name
Example: 5000
RefDtlsobjectoptionalInvRmstringoptionalGST Number
Example: "TEST"
DocPerdDtlsobjectoptionalInvStDtstringoptionalState Name
Example: "01/08/2020"
InvEndDtstringoptionalState Name
Example: "01/09/2020"
PrecDocDtlsarray<einvoicetypeGENERATEversionV1_1_PrecDocDtls>optionalArray items:
InvNostringoptionalState Name
Example: "DOC/002"
InvDtstringoptionalState Name
Example: "01/08/2020"
OthRefNostringoptionalState Name
Example: "123456"
ContrDtlsarray<einvoicetypeGENERATEversionV1_1_ContrDtls>optionalArray items:
RecAdvRefrstringoptionalState Name
Example: "DOC/002"
RecAdvDtstringoptionalState Name
Example: "01/08/2020"
TendrefrstringoptionalState Name
Example: "Abc001"
ContrrefrstringoptionalState Name
Example: "Co123"
ExtrefrstringoptionalState Name
Example: "Yo456"
ProjrefrstringoptionalState Name
Example: "Doc-456"
PorefrstringoptionalState Name
Example: "Doc-789"
PoRefDtstringoptionalState Name
Example: "01/08/2020"
AddlDocDtlsarray<einvoicetypeGENERATEversionV1_1_AddlDocDtls>optionalArray items:
UrlstringoptionalState Name
Example: "https://einv-apisandbox.nic.in"
DocsstringoptionalState Name
Example: "Test Doc"
InfostringoptionalState Name
Example: "Document Test"
ExpDtlsobjectoptionalShipBNostringoptionalState Name
Example: "A-248"
ShipBDtstringoptionalState Name
Example: "01/08/2020"
PortstringoptionalState Name
Example: "INABG1"
RefClmstringoptionalState Name
Example: "N"
ForCurstringoptionalState Name
Example: "AED"
CntCodestringoptionalState Name
Example: "AE"
EwbDtlsobjectoptionalTransidstringoptionalState Name
Example: "12AWGPV7107B1Z1"
TransnamestringoptionalState Name
Example: "XYZ EXPORTS"
DistancenumberoptionalState Name
Example: 100
TransdocnostringoptionalState Name
Example: "DOC01"
TransdocDtstringoptionalState Name
Example: "01/08/2020"
VehnostringoptionalState Name
Example: "ka123456"
VehtypestringoptionalState Name
Example: "R"
TransModestringoptionalState Name
Example: "1"
Response
HTTP OK. Returned on successful validation of simplified invoice.
Frequently Asked Questions
Requests are submitted via HTTP POST to
/einvoice/compliance/invoices. Required parameters: Accept-Version (header parameter). A JSON request body (Content-Type: application/json) is accepted per the schema specifications shown in the request documentation.For Compliance Invoice Request (POST
/einvoice/compliance/invoices), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 200 (HTTP OK. Returned on successful validation of simplified invoice.), HTTP 400 (HTTP Bad Request. Returned when the submitted request is invalid.), HTTP 401 (Returned when username and password are not added or added as wrong values.), HTTP 500 (HTTP Internal Server Error. Returned when the service faces internal errors.).It performs compliance checks on einvoice documents.
No example available.