(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<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

    sb.i = CkStringBuilder::ckCreate()
    If sb.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkHttp::ckQuickGetSb(http,"https://preprod-api.myinvois.hasil.gov.my/api/v1.0/documenttypes",sb)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sb)
        ProcedureReturn
    EndIf

    statusCode.i = CkHttp::ckLastStatus(http)
    Debug "response status code = " + Str(statusCode)

    If statusCode <> 200
        ; Failed.
        Debug CkStringBuilder::ckGetAsString(sb)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sb)
        ProcedureReturn
    EndIf

    ; 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

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(json,sb)

    id.i
    invoiceTypeCode.i
    description.s
    activeFrom.s
    activeTo.s
    j.i
    count_j.i
    name.s
    versionNumber.s
    status.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(json,"result")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        id = CkJsonObject::ckIntOf(json,"result[i].id")
        invoiceTypeCode = CkJsonObject::ckIntOf(json,"result[i].invoiceTypeCode")
        description = CkJsonObject::ckStringOf(json,"result[i].description")
        activeFrom = CkJsonObject::ckStringOf(json,"result[i].activeFrom")
        activeTo = CkJsonObject::ckStringOf(json,"result[i].activeTo")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(json,"result[i].documentTypeVersions")
        While j < count_j
            CkJsonObject::setCkJ(json, j)
            id = CkJsonObject::ckIntOf(json,"result[i].documentTypeVersions[j].id")
            name = CkJsonObject::ckStringOf(json,"result[i].documentTypeVersions[j].name")
            description = CkJsonObject::ckStringOf(json,"result[i].documentTypeVersions[j].description")
            activeFrom = CkJsonObject::ckStringOf(json,"result[i].documentTypeVersions[j].activeFrom")
            activeTo = CkJsonObject::ckStringOf(json,"result[i].documentTypeVersions[j].activeTo")
            versionNumber = CkJsonObject::ckStringOf(json,"result[i].documentTypeVersions[j].versionNumber")
            status = CkJsonObject::ckStringOf(json,"result[i].documentTypeVersions[j].status")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sb)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure