Submission of GST Transaction Listings (CorpPass) (Sandbox)

Submission of GST Transaction Listings (CorpPass) (Sandbox) 1.0.1

This API can be used to submit GST Transaction Listing.

production
development
https://apisandbox.iras.gov.sg/iras/sb

Custom Gateway API Endpoint

Paths

/submitTransactionListingCorpPass

post /submitTransactionListingCorpPass
Client ID
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader (API Key)
X-IBM-Client-Secret
(apiKey located in header)
access_token
Optional in header
string

coppass Access token

body
Optional in body
object
Request
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Response
Example Request
Example Response
POST https://apisandbox.iras.gov.sg/iras/sb/gst/submitTransactionListingCorpPass

Definitions 

{
    "type": "object",
    "properties": {
        "filingInfo": {
            "type": "object",
            "properties": {
                "taxRefNo": {
                    "type": "string"
                },
                "gstRegNo": {
                    "type": "string"
                },
                "dtPeriodStart": {
                    "type": "string"
                },
                "dtPeriodEnd": {
                    "type": "string"
                }
            }
        },
        "data": {
            "type": "object",
            "properties": {
                "identifier": {
                    "type": "string"
                },
                "currentChunk": {
                    "type": "number"
                },
                "totalChunks": {
                    "type": "number"
                },
                "message": {
                    "type": "string"
                },
                "dtIAFCreation": {
                    "type": "string"
                },
                "iafVersion": {
                    "type": "string"
                }
            }
        }
    },
    "example": "{\r\n  \"filingInfo\": {\r\n    \"taxRefNo\": \"199000000A\",\r\n    \"gstRegNo\": \"MX0199000G\",\r\n    \"dtPeriodStart\": \"2017-01-01\",\r\n    \"dtPeriodEnd\": \"2017-12-31\"\r\n    },\r\n  \"data\": {\r\n    \"identifier\": \"390b25fa-4427-4b10-9ae2-34d6e0cd91a1\",\r\n    \"currentChunk\": 7,\r\n    \"totalChunks\": 10,\r\n    \"message\": \"dG9rZW5OYW1lIjogImFjY2Vzc190b2tlbiIsICJ0b2tlbl90eXBlIjogIkJlYXJlciIsICJhdXRoR3JhbnRJZCIsICJob3VzaW5ndHlI4ZDRkNTEwNC0yMDYtYTA5Mi0yYmU3YzZlNzkzNDMiLCAiYXVkIjogIm15aW5mbyIxNTA1ODkwNzUxLCAic2NvcGUiOiBbICJlZHVsZXZlbCIsICJob3VzaW5ndHlwZSIsICJyYWNlIiwgInJlZ2FkZCIsICJzZXgiLCAiaGRiddG9rZW5OYW1lIjogImFjY2Vzc190b2tlbiIsICJ0b2tlbl90eXBlIjogIkJlYXJlciIsICJhdXRoR3JhbnRJZCI6ICI4ZDRkNTEwNC0yMmMxLTRkZ5ndHl2Vzc190b2tlbiIsICJ0b2tlbl90eXBlIjogIkJlYXJlciIsICJhdXRoR3JhbnRJZCI6ICI4ZDRkNTEwNC0sICJyYWNlIiwgInJlZ5Mi0yYmU3YzZlNzkzNDMiLCAiYXVkIjogIm15aW5mbyIsICJuYmYiOiAxNTA1ODkwNzUxLCAic2NvcGUiOiBbICJlZHVsZXZlbCIsICJob3VzaW5ndHlwZSIsICJyYWNlIiwgInJlZ2FkZCIsICJzZXgiLCAiaGRiddG9rZW5OYW1lIjogImFjY2Vzc190b2tlbiIsICJ0b2tlbl90eXBlIjogIkJlYXJlciIsICJhdXRoR3JhbnRJZCI6ICI4ZDRkNTEwNC0yMmMxLTRkZDYtYTA5Mi0yYmU3YzZlNzkzNDMiLCAiYXVkIjogIm15aW5mbyIsICJuYmYiOiAxNTA1ODkwNzUxLCAic2NvcGUiOiBbICJlZHVsZXZlbCIsICJob3VzaW5ndHlwZSIsICJyYWNlIiwgInJlZ2FkZCIsICJzZXgiLCAiaGRid\",\r\n    \"dtIAFCreation\": \"2018-01-31\",\r\n    \"iafVersion\": \"IAFv1.0.0\"\r\n}\r\n}\r\n"
}
              
{
    "type": "object",
    "properties": {
        "returnCode": {
            "type": "integer",
            "format": "int32"
        },
        "data": {
            "type": "object",
            "properties": {
                "identifier": {
                    "type": "string"
                },
                "currentChunk": {
                    "type": "number"
                },
                "totalChunks": {
                    "type": "number"
                },
                "taxRefNo": {
                    "type": "string"
                },
                "gstRegNo": {
                    "type": "string"
                },
                "companyName": {
                    "type": "string"
                },
                "dtPeriodStart": {
                    "type": "string"
                },
                "dtPeriodEnd": {
                    "type": "string"
                },
                "declarantID": {
                    "type": "string"
                },
                "dtSubmission": {
                    "type": "string"
                }
            }
        },
        "info": {
            "type": "object",
            "properties": {
                "messageCode": {
                    "type": "number"
                },
                "message": {
                    "type": "string"
                },
                "fieldInfoList": {
                    "type": "array",
                    "items": {
                        "properties": {
                            "recordID": {
                                "type": "number"
                            },
                            "field": {
                                "type": "string"
                            },
                            "message": {
                                "type": "string"
                            }
                        },
                        "type": "object"
                    }
                }
            }
        }
    },
    "example": "{\r\n  \"returnCode\": 10,\r\n  \"data\": {\r\n    \"identifier\": \"390b25fa-4427-4b10-9ae2-34d6e0cd91a1\",\r\n    \"currentChunk\": 7,\r\n    \"totalChunks\": 10,\r\n\"taxRefNo\": \"190000000A\",\r\n\"gstRegNo\": \"MX0199000G\",\r\n\"companyName\": \"ABC PTE LTD\",\r\n    \"dtPeriodStart\": \"2017-01-01\",\r\n    \"dtPeriodEnd\": \"2017-12-31\",\r\n\"declarantID\": \"SXXXX567Z\",\r\n\"dtSubmission\": \"2018-01-02T20:18:25\"\r\n  },\r\n\r\n\"info\": {\r\n\"messageCode\": 850301,\r\n\"message\": \"Arguments Error\",\r\n\"fieldInfoList\": [\r\n{\r\n\"recordID\": 2457,\r\n\"field\": \"PurchaseTable.PurchaseValueSGD\",\r\n\"message\": \"Value should not be 0\"\r\n},\r\n{\r\n\"recordID\": 7855,\r\n\"field\": \"SupplyTable.SupplyFCY\",\r\n\"message\": \"Value should be 0\"\r\n}\r\n]\r\n}\r\n}\r\n"
}