(SQL Server) MyInvois Malaysia Get Document Types

See more Malaysia MyInvois Examples

There are multiple types of documents supported by MyInvois, and this API retrieves their definitions through API call.

For more information, see https://sdk.myinvois.hasil.gov.my/api/03-get-document-types/

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    -- Note: The access token is valid for a short amount of time.  Perhaps 1 hour.
    -- The access token is used in the "Authorization: Bearer <access_token>" header in subsequent requests until it expires.
    -- Your application would then need to get a new access token, and so on..
    -- To get an access token, see How to Get a MyInvois Access Token

    DECLARE @sb int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sb OUT

    DECLARE @success int
    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://preprod-api.myinvois.hasil.gov.my/api/v1.0/documenttypes', @sb
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sb
        RETURN
      END

    DECLARE @statusCode int
    EXEC sp_OAGetProperty @http, 'LastStatus', @statusCode OUT

    PRINT 'response status code = ' + @statusCode

    IF @statusCode <> 200
      BEGIN
        -- Failed.
        EXEC sp_OAMethod @sb, 'GetAsString', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sb
        RETURN
      END

    -- Sample response:

    -- {"result":
    --       [
    --          {"id":45,
    --             "invoiceTypeCode":4,
    --             "description":"Invoice",
    --             "activeFrom":"2015-02-13T13:15:00Z",
    --             "activeTo":"2027-03-01T00:00:00Z",
    --             "documentTypeVersions":
    --             [
    --                {"id":454,
    --                 "name":"1.0",
    --                 "description":"Invoice version 1.1",
    --                 "activeFrom":"2015-02-13T13:15:00Z",
    --                 "activeTo":"2027-03-01T00:00:00Z",
    --                 "versionNumber":1.1,
    --                 "status":"published"
    --                }
    --             ]
    --           }
    --       ]
    -- }

    -- Use this online tool to generate parsing code from sample JSON: 
    -- Generate Parsing Code from JSON

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'LoadSb', @success OUT, @sb

    DECLARE @id int

    DECLARE @invoiceTypeCode int

    DECLARE @description nvarchar(4000)

    DECLARE @activeFrom nvarchar(4000)

    DECLARE @activeTo nvarchar(4000)

    DECLARE @j int

    DECLARE @count_j int

    DECLARE @name nvarchar(4000)

    DECLARE @versionNumber nvarchar(4000)

    DECLARE @status nvarchar(4000)

    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @json, 'SizeOfArray', @count_i OUT, 'result'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @json, 'I', @i
        EXEC sp_OAMethod @json, 'IntOf', @id OUT, 'result[i].id'
        EXEC sp_OAMethod @json, 'IntOf', @invoiceTypeCode OUT, 'result[i].invoiceTypeCode'
        EXEC sp_OAMethod @json, 'StringOf', @description OUT, 'result[i].description'
        EXEC sp_OAMethod @json, 'StringOf', @activeFrom OUT, 'result[i].activeFrom'
        EXEC sp_OAMethod @json, 'StringOf', @activeTo OUT, 'result[i].activeTo'
        SELECT @j = 0
        EXEC sp_OAMethod @json, 'SizeOfArray', @count_j OUT, 'result[i].documentTypeVersions'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @json, 'J', @j
            EXEC sp_OAMethod @json, 'IntOf', @id OUT, 'result[i].documentTypeVersions[j].id'
            EXEC sp_OAMethod @json, 'StringOf', @name OUT, 'result[i].documentTypeVersions[j].name'
            EXEC sp_OAMethod @json, 'StringOf', @description OUT, 'result[i].documentTypeVersions[j].description'
            EXEC sp_OAMethod @json, 'StringOf', @activeFrom OUT, 'result[i].documentTypeVersions[j].activeFrom'
            EXEC sp_OAMethod @json, 'StringOf', @activeTo OUT, 'result[i].documentTypeVersions[j].activeTo'
            EXEC sp_OAMethod @json, 'StringOf', @versionNumber OUT, 'result[i].documentTypeVersions[j].versionNumber'
            EXEC sp_OAMethod @json, 'StringOf', @status OUT, 'result[i].documentTypeVersions[j].status'
            SELECT @j = @j + 1
          END
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sb
    EXEC @hr = sp_OADestroy @json


END
GO