--- swagger: "2.0" info: x-ibm-name: gst-returns-submission-production title: GST Returns Submission version: 1.0.3 description: This API can be used to submit GST F5 Return. schemes: - https basePath: /gst consumes: - application/json produces: - application/json securityDefinitions: Client ID: type: apiKey description: "" in: header name: X-IBM-Client-Id Client Secret: type: apiKey description: "" in: header name: X-IBM-Client-Secret security: - Client Secret: [] Client ID: [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /submitF5Return: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/Response' parameters: - name: body required: false in: body schema: $ref: '#/definitions/Request' - $ref: '#/parameters/access_token' tags: [] definitions: Request: description: "" 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 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 igdScheme: type: object properties: defImpPayableAmt: type: number defTotalGoodsImp: type: number declaration: type: object properties: 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: "\r\n{\r\n \"filingInfo\": {\r\n \"taxRefNo\": \"190000000A\",\r\n \ \"formType\": \"F5\",\r\n \"dtPeriodStart\": \"2017-10-01\",\r\n \"dtPeriodEnd\": \"2017-12-31\"\r\n},\r\n \"supplies\": {\r\n \"totStdSupply\": 50303,\r\n \ \"totZeroSupply\": 454533,\r\n \"totExemptSupply\": 326723\r\n},\r\n \ \"purchases\": {\r\n \"totTaxPurchase\": 700824\r\n},\r\n \"taxes\": {\r\n \ \"outputTaxDue\": 3521.21,\r\n \"inputTaxRefund\": 14468.90\r\n},\r\n \ \"schemes\": {\r\n \"totValueScheme\": 345887,\r\n \"touristRefundChk\": false,\r\n \"touristRefundAmt\": 0.00,\r\n \"badDebtChk\": true,\r\n \"badDebtReliefClaimAmt\": 1.00,\r\n \"preRegistrationChk\": false,\r\n \"preRegistrationClaimAmt\": 0.00\r\n},\r\n \"revenue\": {\r\n \"revenue\": 831600\r\n},\r\n \"igdScheme\": {\r\n \"defImpPayableAmt\": 0,\r\n \"defTotalGoodsImp\": 0\r\n},\r\n \"declaration\": {\r\n \"declarantDesgtn\": \"DIRECTOR\",\r\n \"contactPerson\": \"JANE LEE\",\r\n \"contactNumber\": \"91231234\",\r\n \"contactEmail\": \"jane.lee@abcpteltd.com.sg\"\r\n},\r\n \ \"reasons\": {\r\n \"grp1BadDebtRecoveryChk\": true,\r\n \"grp1PriorToRegChk\": false,\r\n \"grp1OtherReasonChk\": false,\r\n \"grp1OtherReasons\": \"\",\r\n \ \"grp2TouristRefundChk\": false,\r\n \"grp2AppvBadDebtReliefChk\": false,\r\n \ \"grp2CreditNotesChk\": false,\r\n \"grp2OtherReasonsChk\": true,\r\n \ \"grp2OtherReasons\": \"Indicate your reason\",\r\n \"grp3CreditNotesChk\": false,\r\n \"grp3OtherReasonsChk\": false,\r\n \"grp3OtherReasons\": \"\"\r\n}\r\n}\r\n" Response: description: "" type: object properties: returnCode: type: integer format: int32 data: type: object properties: filingInfo: type: object properties: taxRefNo: type: string gstRegNo: type: string formType: type: string dtPeriodStart: type: string dtPeriodEnd: type: string ackNo: type: string pymtRefNo: type: string companyName: type: string dtSubmission: 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 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 igdScheme: type: object properties: defNetGst: type: number defImpPayableAmt: type: number defTotalTaxAmt: type: number defTotalGoodsImp: type: number declaration: type: object properties: 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: "{\r\n \"returnCode\": 30,\r\n \"data\":{\r\n\t \"filingInfo\": {\r\n\t\t\"taxRefNo\": \"190000000A\",\r\n\t\t\"gstRegNo\": \"MX0199000G\",\r\n\t\t\"formType\": \"F5\",\r\n\t\t\"dtPeriodStart\": \"2017-10-01\",\r\n\t\t\"dtPeriodEnd\": \"2017-12-31\",\r\n\t\t\"ackNo\": \"72318768172368\",\r\n\t\t\"pymtRefNo\": \"\",\r\n\t\t\"companyName\": \"ABC PTE LTD\",\r\n\t\t\"dtSubmission\": \"2018-01-02T20:18:25\"\r\n\t},\r\n\t \ \"supplies\": {\r\n\t\t\"totStdSupply\": 50303,\r\n\t\t\"totZeroSupply\": 454533,\r\n\t\t\"totExemptSupply\": 326723,\r\n\t\t\"totValueSupply\": 831559 \r\n\t},\r\n\t \"purchases\": {\r\n\t\t\"totTaxPurchase\": 700824\r\n\t},\r\n\t \ \"taxes\": {\r\n\t\t\"outputTaxDue\": 3521.21,\r\n\t\t\"inputTaxRefund\": 14468.90,\r\n\t\t\"netGSTPaid\": -10947.69\r\n\t},\r\n\t \"schemes\": {\r\n\t\t\"totValueScheme\": 345887,\r\n\t\t\"touristRefundChk\": false,\r\n\t\t\"touristRefundAmt\": 0.00,\r\n\t\t\"badDebtChk\": true,\r\n\t\t\"badDebtReliefClaimAmt\": 1.00,\r\n\t\t\"preRegistrationChk\": false,\r\n\t\t\"preRegistrationClaimAmt\": 0.00\r\n\t},\r\n\t \"revenue\": {\r\n\t\t\"revenue\": 831600\r\n\t},\r\n\t \"igdScheme\": {\r\n\t \"defNetGst\": 0,\r\n\t\t\"defImpPayableAmt\": 0,\r\n\t\t\"defTotalTaxAmt\": 0,\r\n\t\t\"defTotalGoodsImp\": 0\r\n\t},\r\n\t \"declaration\": {\r\n\t \"declarantID\": \"SXXXX567Z\",\r\n\t\t\"declarantName\": \"JOHNNY NG\",\r\n\t\t\"declarantDesgtn\": \"DIRECTOR\",\r\n\t\t\"contactPerson\": \"JANE LEE\",\r\n\t\t\"contactNumber\": \"91231234\",\r\n\t\t\"contactEmail\": \"jane.lee@abcpteltd.com.sg\"\r\n\t},\r\n\t \"reasons\": {\r\n\t\t\"grp1BadDebtRecoveryChk\": true,\r\n\t\t\"grp1PriorToRegChk\": false,\r\n\t\t\"grp1OtherReasonChk\": false,\r\n\t\t\"grp1OtherReasons\": \"\",\r\n\t\t\"grp2TouristRefundChk\": false,\r\n\t\t\"grp2AppvBadDebtReliefChk\": false,\r\n\t\t\"grp2CreditNotesChk\": false,\r\n\t\t\"grp2OtherReasonsChk\": true,\r\n\t\t\"grp2OtherReasons\": \"Indicate your reason\",\r\n\t\t\"grp3CreditNotesChk\": false,\r\n\t\t\"grp3OtherReasonsChk\": false,\r\n\t\t\"grp3OtherReasons\": \"\"\r\n\t}\r\n \ },\r\n \"info\": {\r\n \"messageCode\": 850301,\r\n \"message\": \"Arguments Error\",\r\n \"fieldInfoList\": [\r\n {\r\n \"field\": \"idNumber\",\r\n \ \"message\": \"Incorrect ID Type and/or ID No\"\r\n },\r\n {\r\n \ \"field\": \"name\",\r\n \"message\": \"Must not be blank\"\r\n \ }\r\n ]\r\n }\r\n}" parameters: access_token: name: access_token type: string required: false in: header description: eyAidHlwIjogIkpXVCIsICJhbGciOiAiUlMyNTYiIH0.eyAic3ViIjogIlM5ODEyMzgxRCIsICJhdWRpdFRyYWNraW5nSWQiOiAiZjU0Njc3MGQtOTI4Ni00ODNlLTk0YzktZTllNDZlMTMwMzFiIiwgImlzcyI6ICJodHRwOi8vc3RnLWF1dGguYXBwcy5lLm5lY3Rhci5nb3Yuc2c6ODAvY29uc2VudC9vYXV0aDIiLCAidG9rZW5OYW1lIjogImFjY2Vzc190b2tlbiIsICJ0b2tlbl90eXBlIjogIkJlYXJlciIsICJhdXRoR3JhbnRJZCI6ICI4ZDRkNTEwNC0yMmMxLTRkZDYtYTA5Mi0yYmU3YzZlNzkzNDMiLCAiYXVkIjogIm15aW5mbyIsICJuYmYiOiAxNTA1ODkwNzUxLCAic2NvcGUiOiBbICJlZHVsZXZlbCIsICJob3VzaW5ndHlwZSIsICJyYWNlIiwgInJlZ2FkZCIsICJzZXgiLCAiaGRidHlwZSIsICJtb2JpbGVubyIsICJjcGZiYWxhbmNlcyIsICJoYW55dXBpbnlpbm5hbWUiLCAibWFycmllZG5hbWUiLCAiaGFueXVwaW55aW5hbGlhc25hbWUiLCAiYXNzZXNzYWJsZWluY29tZSIsICJtYXJpdGFsIiwgImFsaWFzbmFtZSIsICJuYXRpb25hbGl0eSIsICJkb2IiLCAibmFtZSIsICJjcGZjb250cmlidXRpb25zIiwgImVtYWlsIiBdLCAicmVhbG0iOiAiL215aW5mbyIsICJleHAiOiAxNTA1ODk0MzUxLCAiaWF0IjogMTUwNTg5MDc1MSwgImV4cGlyZXNfaW4iOiAzNjAwMDAwLCAianRpIjogIjI2MmM3ODk5LWY4YmQtNDVlOC05Mzc1LWRmYTY5YWUwNTA3YSIgfQ.maD5lnrRA84hm2Lz5gdUlM6ZVSsYxYlWodtMTesleDXJrD3hDeUVbmHGumeH4XogtmYacCWKh3geY5iItK4WLr_ft5oFzvXilWrud7zahFOR5QuOxhALzl8d1erDN4jCQfbT6xq98B7nRCG9JAB1qvEvnSGQLGSWxH3j4IxE5Jp5iP-3AzshXub-8JukAqnWZLiQsoJCUu8GBg0RfG85wRKwImPmnPyCoAwqTv2MlqhZQr5oXkkeRrqITkZQME3sFiqZmnExjHcml8Y__5h3FNvJSFdnnZSDW0471wBpYM9-jK7WdBR9rKS68sxdNa85y-TQ7YXcb5AHYPro9GGY6w x-ibm-endpoints: - endpointUrl: https://apiservices.iras.gov.sg/iras/prod description: Custom Gateway API Endpoint type: - production - development ...