home

Indirect Tax

Sovos Docs

Malaysia

Enabling support for Malaysia involves confirming prerequisites and product IDs, registering with the Inland Revenue Board of Malaysia (IRBM) tax authority, and setting up credentials.

Prerequisites

  • Client ID and secret, obtained from the IRBM Portal

  • A signing certificate file and signing key ID, obtained from a Malaysian Certification Authority (CA)

Available products

my_UBLInvoice__1.0
Outbound electronic invoice
my_UBLInvoice_Polling_1.0
Inbound electronic invoice

Configure transmission credentials for Malaysia

Transmission credential setup connects your Sovos account to the Inland Revenue Board of Malaysia (IRBM) tax authority and is required to begin sending documents to the tax authority.

  1. Request a ClientID and a Client Secret from IRBM in an email addressed to sdkmyinvois@hasil.gov.my with the following information inside the body of the email:
    • Tax identification number

    • Business registration number

    • Company name

    • Company email address

    • ERP system name

  2. Add your transmission credentials to your Admin Settings or via the Configuration v2 resource (API).

Samples for uploading transmission credentials for Malaysia

The request and response samples for uploading new transmission credentials using the dedicated Create settings endpoint.

Request sample

Request sample for uploading new transmissions credentials:

curl --location --request POST 'https://api-test.sovos.com/v2/configurations/organizations/YOUR-ORG-ID/settings' \
--header 'x-correlationId: developer-guide' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "context": "transmission",
        "configurations": [
            {
                "name": "partner_credentials_irbm",
                "value": {
                    "client_id": INSERT-CLIENTID-HERE,
                    "client_secret": INSERT-SECRET-HERE
                },
                "scope": {
                    "category": "MY_INV",
                    "productId": "my_UBLInvoice__1.0",
                    "orgId": YOUR-ORG-ID,
                    "taxId": YOUR-COMPANY-TAXID
                }
            }
        ]
    }
]'

Response sample

Response sample for uploading new transmissions credentials:

{
    "status": 201,
    "message": "Created",
    "success": true,
    "timestamp": 1664826411521,
    "data": [
        {
            "message": "Configurations are created",
            "statusCode": 201,
            "configurationContextResponse": {
                "context": "Transmission",
                "configurations": [
                    {
                        "id": SETTING-ID,
                        "name": "partner_credentials_irbm",
                        "value": {
                            "client_id": INSERT-CLIENTID-HERE,
                            "client_secret": INSERT-CLIENTSECRET-HERE
                        },
                        "scope": {
                            "category": "MY_INV",
                            "productId": "my_UBLInvoice__1.0",
                            "orgId": YOUR-ORG-ID,
			    "taxId": YOUR-COMPANY-TAXID
                        },
                        "auditData": {
                            "createdAt": 1664826410,
                            "createdBy": "user@company.com",
                            "isDeleted": false,
                            "version": 1
                        }
                    }
                ]
            }
        }
    ]
}

Configure the signing credentials for Malaysia

Signing credentials are required for all businesses.
  1. Request a signing certificate from the Malaysian CA.
    Note: The certificate must be a valid X.509 soft certificate that matches the profile.
  2. Add your signing credentials to your Admin Settings or via the Configuration v2 resource (API).
Additional setup for Malaysia:
  • Complete and return an Appointment Letter to Sovos, or your reseller.

  • Complete and return a Support and Change Management Document to Sovos, or your reseller.

Samples for uploading signing credentials for Malaysia

The request and response samples for uploading new signing credentials using the dedicated Create settings endpoint.

Request sample

Request sample for uploading new signing credentials:

curl --location --request POST 'https://api-test.sovos.com/v2/configurations/organizations/YOUR-ORG-ID/settings' \
--header 'x-correlationId: developer-guide' \
--data-raw '[
    {
        "context": "signing",
        "configurations": [
            {
                "name": "credentials",
                "value": {
                    "certificateFileData": INSERT-CERT-HERE,
                    "password": INSERT-PASSWORD-HERE
                },
                "scope": {
                    "category": "MY_INV",
                    "productId": "my_UBLInvoice__1.0",
                    "orgId": YOUR-ORG-ID,
                    "taxId": YOUR-COMPANY-TAXID
                }
            }
        ]
    }
]'

Response sample

Response sample for uploading new signing credentials:

{
    "status": 201,
    "message": "Created",
    "success": true,
    "timestamp": 1667465886908,
    "data": [
        {
            "message": "Configurations are created",
            "statusCode": 201,
            "configurationContextResponse": {
                "context": "Signing",
                "configurations": [
                    {
                        "id": SETTING-ID,
                        "name": "credentials",
                        "value": {
                            "certificateFileData": "*****",
                            "password": "*****"
                        },
                        "scope": {
                            "category": "MY_INV",
                            "productId": "my_UBLInvoice__1.0",
                            "orgId": YOUR-ORG-ID,
                            "taxId": YOUR-COMPANY-TAXIDhe
                        },
                        "auditData": {
                            "createdAt": 1667465886,
                            "createdBy": "user@company.com",
                            "isDeleted": false,
                            "version": 1
                        }
                    }
                ]
            }
        }
    ]
}