production
development
https://apisandbox.iras.gov.sg/iras/sb
Custom Gateway API Endpoint
Paths
/submitF7ReturnCorpPass
post /submitF7ReturnCorpPass
Client Secret
X-IBM-Client-Secret
(apiKey located in header)
Client Id
X-IBM-Client-Id
(apiKey located in header)
body
Optional in body
object
access_token
Optional in header
string
coppass Access token
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://apisandbox.iras.gov.sg/iras/sb/gst/submitF7ReturnCorpPass
Definitions
{
"type": "object",
"properties": {
"filingInfo": {
"type": "object",
"properties": {
"taxRefNo": {
"type": "string"
},
"formType": {
"type": "string"
},
"dtPeriodStart": {
"type": "string"
},
"dtPeriodEnd": {
"type": "string"
}
}
},
"supplies": {
"type": "object",
"properties": {
"totStdSupply": {
"type": "number"
},
"totZeroSupply": {
"type": "number"
},
"totExemptSupply": {
"type": "number"
}
}
},
"purchases": {
"type": "object",
"properties": {
"totTaxPurchase": {
"type": "number"
}
}
},
"taxes": {
"type": "object",
"properties": {
"outputTaxDue": {
"type": "number"
},
"inputTaxRefund": {
"type": "number"
},
"prevGSTPaid": {
"type": "number"
},
"netDifference": {
"type": "number"
}
}
},
"schemes": {
"type": "object",
"properties": {
"totValueScheme": {
"type": "number"
},
"touristRefundChk": {
"type": "boolean"
},
"touristRefundAmt": {
"type": "number"
},
"badDebtChk": {
"type": "boolean"
},
"badDebtReliefClaimAmt": {
"type": "number"
},
"preRegistrationChk": {
"type": "boolean"
},
"preRegistrationClaimAmt": {
"type": "number"
}
}
},
"revenue": {
"type": "object",
"properties": {
"revenue": {
"type": "number"
}
}
},
"RCElectronicMktplaceOpr": {
"type": "object",
"properties": {
"RCChk": {
"type": "boolean"
},
"totImpServAmt": {
"type": "number"
},
"OVRChk": {
"type": "boolean"
},
"totDigitalServAmt": {
"type": "number"
}
}
},
"igdScheme": {
"type": "object",
"properties": {
"defImpPayableAmt": {
"type": "number"
},
"prevDefImpGSTPayable": {
"type": "number"
},
"diffDefImpGSTPayable": {
"type": "number"
},
"defTotalGoodsImp": {
"type": "number"
}
}
},
"ErrorDescription": {
"type": "object",
"properties": {
"descriptionOfError": {
"type": "string"
}
}
},
"declaration": {
"type": "object",
"properties": {
"declareTrueCompleteChk": {
"type": "boolean"
},
"declareIncRtnFalseInfoChk": {
"type": "boolean"
},
"declarantDesgtn": {
"type": "string"
},
"contactPerson": {
"type": "string"
},
"contactNumber": {
"type": "string"
},
"contactEmail": {
"type": "string"
}
}
},
"reasons": {
"type": "object",
"properties": {
"grp1BadDebtRecoveryChk": {
"type": "boolean"
},
"grp1PriorToRegChk": {
"type": "boolean"
},
"grp1OtherReasonChk": {
"type": "boolean"
},
"grp1OtherReasons": {
"type": "string"
},
"grp2TouristRefundChk": {
"type": "boolean"
},
"grp2AppvBadDebtReliefChk": {
"type": "boolean"
},
"grp2CreditNotesChk": {
"type": "boolean"
},
"grp2OtherReasonsChk": {
"type": "boolean"
},
"grp2OtherReasons": {
"type": "string"
},
"grp3CreditNotesChk": {
"type": "boolean"
},
"grp3OtherReasonsChk": {
"type": "boolean"
},
"grp3OtherReasons": {
"type": "string"
}
}
}
},
"example": "{\"filingInfo\":{\"taxRefNo\":\"190000000A\",\"formType\":\"F7\",\"dtPeriodStart\":\"2017-10-01\",\"dtPeriodEnd\":\"2017-12-31\"},\"supplies\":{\"totStdSupply\":503,\"totZeroSupply\":454533,\"totExemptSupply\":326723},\"purchases\":{\"totTaxPurchase\":700824},\"taxes\":{\"outputTaxDue\":3521.21,\"inputTaxRefund\":14468.9,\"prevGSTPaid\":4468.9,\"netDifference\":10000},\"schemes\":{\"totValueScheme\":345887,\"touristRefundChk\":false,\"touristRefundAmt\":0,\"badDebtChk\":false,\"badDebtReliefClaimAmt\":0,\"preRegistrationChk\":false,\"preRegistrationClaimAmt\":0},\"revenue\":{\"revenue\":781759},\"RCElectronicMktplaceOpr\":{\"RCChk\":true,\"totImpServAmt\":45326,\"OVRChk\":false,\"totDigitalServAmt\":0},\"igdScheme\":{\"defImpPayableAmt\":0,\"prevDefImpGSTPayable\":0,\"diffDefImpGSTPayable\":0,\"defTotalGoodsImp\":0},\"ErrorDescription\":{\"descriptionOfError\":\"ErrorMessage\"},\"declaration\":{\"declareTrueCompleteChk\":true,\"declareIncRtnFalseInfoChk\":true,\"declarantDesgtn\":\"DIRECTOR\",\"contactPerson\":\"JANE LEE\",\"contactNumber\":\"91231234\",\"contactEmail\":\"jane.lee@abcpteltd.com.sg\"},\"reasons\":{\"grp1BadDebtRecoveryChk\":true,\"grp1PriorToRegChk\":false,\"grp1OtherReasonChk\":false,\"grp1OtherReasons\":\"\",\"grp2TouristRefundChk\":false,\"grp2AppvBadDebtReliefChk\":false,\"grp2CreditNotesChk\":false,\"grp2OtherReasonsChk\":false,\"grp2OtherReasons\":\"\",\"grp3CreditNotesChk\":false,\"grp3OtherReasonsChk\":false,\"grp3OtherReasons\":\"\"}}"
}
{
"type": "object",
"properties": {
"returnCode": {
"type": "number"
},
"data": {
"type": "object",
"properties": {
"filingInfo": {
"type": "object",
"properties": {
"ackNo": {
"type": "string"
},
"companyName": {
"type": "string"
},
"dtPeriodStart": {
"type": "string"
},
"dtPeriodEnd": {
"type": "string"
},
"dtSubmission": {
"type": "string"
},
"formType": {
"type": "string"
},
"gstRegNo": {
"type": "string"
},
"pymtRefNo": {
"type": "string"
},
"taxRefNo": {
"type": "string"
}
}
},
"supplies": {
"type": "object",
"properties": {
"totStdSupply": {
"type": "number"
},
"totZeroSupply": {
"type": "number"
},
"totExemptSupply": {
"type": "number"
},
"totValueSupply": {
"type": "number"
}
}
},
"purchases": {
"type": "object",
"properties": {
"totTaxPurchase": {
"type": "number"
}
}
},
"taxes": {
"type": "object",
"properties": {
"outputTaxDue": {
"type": "number"
},
"inputTaxRefund": {
"type": "number"
},
"netGSTPaid": {
"type": "number"
},
"prevGSTPaid": {
"type": "number"
},
"netDifference": {
"type": "number"
}
}
},
"schemes": {
"type": "object",
"properties": {
"totValueScheme": {
"type": "number"
},
"touristRefundChk": {
"type": "boolean"
},
"touristRefundAmt": {
"type": "number"
},
"badDebtChk": {
"type": "boolean"
},
"badDebtReliefClaimAmt": {
"type": "number"
},
"preRegistrationChk": {
"type": "boolean"
},
"preRegistrationClaimAmt": {
"type": "number"
}
}
},
"revenue": {
"type": "object",
"properties": {
"revenue": {
"type": "number"
}
}
},
"RCElectronicMktplaceOpr": {
"type": "object",
"properties": {
"RCChk": {
"type": "boolean"
},
"totImpServAmt": {
"type": "number"
},
"OVRChk": {
"type": "boolean"
},
"totDigitalServAmt": {
"type": "number"
}
}
},
"igdScheme": {
"type": "object",
"properties": {
"defImpPayableAmt": {
"type": "number"
},
"prevDefImpGSTPayable": {
"type": "number"
},
"diffDefImpGSTPayable": {
"type": "number"
},
"diffDefImpNetGST": {
"type": "number"
},
"diffDefTotalTaxAmt": {
"type": "number"
},
"defTotalTaxAmt": {
"type": "number"
},
"defTotalGoodsImp": {
"type": "number"
}
}
},
"ErrorDescription": {
"type": "object",
"properties": {
"descriptionOfError": {
"type": "string"
}
}
},
"declaration": {
"type": "object",
"properties": {
"declareTrueCompleteChk": {
"type": "boolean"
},
"declareIncRtnFalseInfoChk": {
"type": "boolean"
},
"declarantID": {
"type": "string"
},
"declarantName": {
"type": "string"
},
"declarantDesgtn": {
"type": "string"
},
"contactPerson": {
"type": "string"
},
"contactNumber": {
"type": "string"
},
"contactEmail": {
"type": "string"
}
}
},
"reasons": {
"type": "object",
"properties": {
"grp1BadDebtRecoveryChk": {
"type": "boolean"
},
"grp1PriorToRegChk": {
"type": "boolean"
},
"grp1OtherReasonChk": {
"type": "boolean"
},
"grp1OtherReasons": {
"type": "string"
},
"grp2TouristRefundChk": {
"type": "boolean"
},
"grp2AppvBadDebtReliefChk": {
"type": "boolean"
},
"grp2CreditNotesChk": {
"type": "boolean"
},
"grp2OtherReasonsChk": {
"type": "boolean"
},
"grp2OtherReasons": {
"type": "string"
},
"grp3CreditNotesChk": {
"type": "boolean"
},
"grp3OtherReasonsChk": {
"type": "boolean"
},
"grp3OtherReasons": {
"type": "string"
}
}
}
}
},
"info": {
"type": "object",
"properties": {
"messageCode": {
"type": "number"
},
"message": {
"type": "string"
},
"fieldInfoList": {
"type": "array",
"items": {
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"example": "{\"returnCode\":10,\"data\":{\"filingInfo\":{\"ackNo\":\"72318768172368\",\"companyName\":\"ABC PTE LTD\",\"dtPeriodStart\":\"2017-10-01\",\"dtPeriodEnd\":\"2017-12-31\",\"dtSubmission\":\"2018-01-02T20:18:25\",\"formType\":\"F7\",\"gstRegNo\":\"XXXXXXXXXX\",\"pymtRefNo\":\"\",\"taxRefNo\":\"XXXXXXXXXX\"},\"supplies\":{\"totStdSupply\":503,\"totZeroSupply\":454533,\"totExemptSupply\":326723,\"totValueSupply\":781759},\"purchases\":{\"totTaxPurchase\":700824},\"taxes\":{\"outputTaxDue\":3521.21,\"inputTaxRefund\":14468.9,\"netGSTPaid\":-10947.69,\"prevGSTPaid\":-7947.69,\"netDifference\":-3000},\"schemes\":{\"totValueScheme\":345887,\"touristRefundChk\":false,\"touristRefundAmt\":0,\"badDebtChk\":false,\"badDebtReliefClaimAmt\":0,\"preRegistrationChk\":false,\"preRegistrationClaimAmt\":0},\"revenue\":{\"revenue\":781759},\"RCElectronicMktplaceOpr\":{\"RCChk\":true,\"totImpServAmt\":45326,\"OVRChk\":false,\"totDigitalServAmt\":0},\"igdScheme\":{\"defImpPayableAmt\":0,\"prevDefImpGSTPayable\":0,\"diffDefImpGSTPayable\":0,\"diffDefImpNetGST\":0,\"diffDefTotalTaxAmt\":0,\"defTotalTaxAmt\":0,\"defTotalGoodsImp\":0},\"ErrorDescription\":{\"descriptionOfError\":\"Error Message\"},\"declaration\":{\"declareTrueCompleteChk\":true,\"declareIncRtnFalseInfoChk\":true,\"declarantID\":\"SXXXX567Z\",\"declarantName\":\"JOHNNY NG\",\"declarantDesgtn\":\"DIRECTOR\",\"contactPerson\":\"JANE LEE\",\"contactNumber\":\"91231234\",\"contactEmail\":\"jane.lee@abcpteltd.com.sg\"},\"reasons\":{\"grp1BadDebtRecoveryChk\":true,\"grp1PriorToRegChk\":false,\"grp1OtherReasonChk\":false,\"grp1OtherReasons\":\"\",\"grp2TouristRefundChk\":false,\"grp2AppvBadDebtReliefChk\":false,\"grp2CreditNotesChk\":false,\"grp2OtherReasonsChk\":false,\"grp2OtherReasons\":\"\",\"grp3CreditNotesChk\":false,\"grp3OtherReasonsChk\":false,\"grp3OtherReasons\":\"\"}},\"info\":{\"messageCode\":850301,\"message\":\"Arguments Error\",\"fieldInfoList\":[{\"field\":\"idNumber\",\"message\":\"Incorrect ID Type and/or ID No\"},{\"field\":\"name\",\"message\":\"Must not be blank\"}]}}"
}