- Added searchTaxPayerTin API

- Update CountryCodes
- Update getNotifications API in NotificationService to remove channel parameter
- Update getSubmission API in DocumentSubmissionService to add 2 new parameters
- Update getRecentDocuments API in DocumentService to rename direction parameter to invoiceDirection parameter
- Update searchDocuments API in DocumentService to remove continuationToken parameter, add pageNo parameter and rename direction parameter to invoiceDirection parameter

Author: klsheng

src/MyInvoisClient.php

@@ -280,6 +280,8 @@ public function __call($name, $args)
                 return call_user_func_array([$this->getNotificationService(), $name], $args);
             case 'validateTaxPayerTin':
                 return call_user_func_array([$this->getTaxPayerService(), $name], $args);
+            case 'searchTaxPayerTin':
+                return call_user_func_array([$this->getTaxPayerService(), $name], $args);
             default:
                 throw new BadMethodCallException($name . ' does not exist!');
         }

src/Service/Document/DocumentService.php

@@ -122,7 +122,7 @@ public function getDocumentDetail($id)
      * @param DateTime|string   $submissionDateTo       Optional: The end date and time when the document was submitted to the e-Invoice API, Time to be supplied in UTC timezone. Mandatory when ‘submissionDateFrom’ is provided
      * @param DateTime|string   $issueDateFrom          Optional: The start date and time when the document was issued. Mandatory when ‘issueDateTo’ is provided
      * @param DateTime|string   $issueDateTo            Optional: The end date and time when the document was issued. Mandatory when ‘issueDateFrom’ is provided
-     * @param string            $direction              Optional: direction of the document. Possible values: (Sent, Received)
+     * @param string            $invoiceDirection       Optional: direction of the document. Possible values: (Sent, Received)
      * @param string            $status                 Optional: status of the document. Possible values: (Valid, Invalid, Cancelled, Submitted)
      * @param string            $documentType           Optional: Document type code.
      * @param string            $receiverId             Optional: Document recipient identifier. Only can be used when ‘Direction’ filter is set to Sent. Possible values: (Business registration number, National ID(IC), Passport Number, Army ID)
@@ -135,7 +135,7 @@ public function getDocumentDetail($id)
      * @return array
      */
     public function getRecentDocuments($pageNo = 1, $pageSize = 20, $submissionDateFrom = null, 
-        $submissionDateTo = null, $issueDateFrom = null, $issueDateTo = null, $direction = null, 
+        $submissionDateTo = null, $issueDateFrom = null, $issueDateTo = null, $invoiceDirection = null, 
         $status = null, $documentType = null, $receiverId = null, $receiverIdType = null, $receiverTin = null,
         $issuerId = null, $issuerIdType = null, $issuerTin = null)
     {
@@ -151,7 +151,7 @@ public function getRecentDocuments($pageNo = 1, $pageSize = 20, $submissionDateF
             'submissionDateTo' => $submissionDateToString,
             'issueDateFrom' => $issueDateFromString,
             'issueDateTo' => $issueDateToString,
-            'direction' => $direction,
+            'invoiceDirection' => $invoiceDirection,
             'status' => $status,
             'documentType' => $documentType,
             'receiverId' => $receiverId,
@@ -175,24 +175,20 @@ public function getRecentDocuments($pageNo = 1, $pageSize = 20, $submissionDateF
      * @param string            $id                     Optional: Unique ID of the document to retrieve.
      * @param DateTime|string   $submissionDateFrom     Optional: The start date and time when the document was submitted to the e-Invoice API, Time to be supplied in UTC timezone. Mandatory when ‘submissionDateTo’ is provided or issueDate filters are not used
      * @param DateTime|string   $submissionDateTo       Optional: The end date and time when the document was submitted to the e-Invoice API, Time to be supplied in UTC timezone. Mandatory when ‘submissionDateFrom’ is provided or issueDate filters are not used
-     * @param string            $continuationToken      Optional: Token provided to navigate to the next page. Must be omitted or use an empty string when requesting the first page.
+     * @param int               $pageNo                 Optional: number of the page to retrieve. Typically this parameter value is derived from initial parameter less call when caller learns total amount of page of certain size
      * @param int               $pageSize               Optional: number of the documents to retrieve per page. Page size cannot exceed system configured maximum page size for this API. Default is 100
      * @param DateTime|string   $issueDateFrom          Optional: The start date and time when the document was issued. Mandatory when ‘issueDateTo’ is provided or submissionDate filters are not used
      * @param DateTime|string   $issueDateTo            Optional: The end date and time when the document was issued. Mandatory when ‘issueDateFrom’ is provided or submissionDate filters are not used
-     * @param string            $direction              Optional: direction of the document. Possible values: (Sent, Received). When not provided sent and received documents are retrieved.
+     * @param string            $invoiceDirection       Optional: direction of the document. Possible values: (Sent, Received). When not provided sent and received documents are retrieved.
      * @param string            $status                 Optional: status of the document. Possible values: (Valid, Invalid, Cancelled, Submitted)
      * @param string            $documentType           Optional: Unique name of the document type. Possible values: 01 [Invoice], 02 [Credit Note], 03 [Debit Note], 04 [Refund Note], 11 [Self-billed Invoice], 12 [Self-billed Credit Note], 13 [Self-billed Debit Note], 14 [Self-billed Refund Note]
-     * @param string            $receiverId             Optional: Document recipient identifier. Only can be used when ‘Direction’ filter is set to Sent. Possible values: (Business registration number, Passport Number, National ID)
-     * @param string            $receiverIdType         Optional: Document recipient identifier type. Only can be used when ‘Direction’ filter is set to Sent. Possible values: (BRN, PASSPORT, NRIC, ARMY) This is mandatory in case the receiverId is provided
-     * @param string            $receiverTin            Optional: Document recipient TIN. Only can be used when ‘Direction’ filter is set to Sent.
-     * @param string            $issuerTin              Optional: Document issuer identifier. Only can be used when ‘Direction’ filter is set to Received.
+     * @param string            $searchQuery            Optional: Free Text can be given. Possible Search parameters: (uuid, buyerTIN, supplierTIN, buyerName, supplierName, internalID, total) Special characters are not allowed
      * 
      * @return array
      */
     public function searchDocuments($id = null, $submissionDateFrom = null, $submissionDateTo = null, 
-        $continuationToken = null, $pageSize = 100, $issueDateFrom = null, $issueDateTo = null, $direction = null, 
-        $status = null, $documentType = null, $receiverId = null, $receiverIdType = null, $receiverTin = null,
-        $issuerTin = null)
+        $pageNo = 1, $pageSize = 100, $issueDateFrom = null, $issueDateTo = null, $invoiceDirection = null, 
+        $status = null, $documentType = null, $searchQuery = null)
     {
         $submissionDateFromString = ($submissionDateFrom instanceof DateTime) ? $submissionDateFrom->format('Y-m-d\TH:i:s\Z') : $submissionDateFrom;
         $submissionDateToString = ($submissionDateTo instanceof DateTime) ? $submissionDateTo->format('Y-m-d\TH:i:s\Z') : $submissionDateTo;
@@ -204,17 +200,14 @@ public function searchDocuments($id = null, $submissionDateFrom = null, $submiss
             'uuid' => $id,
             'submissionDateFrom' => $submissionDateFromString,
             'submissionDateTo' => $submissionDateToString,
-            'continuationToken' => $continuationToken,
+            'pageNo' => $pageNo,
             'pageSize' => $pageSize,
             'issueDateFrom' => $issueDateFromString,
             'issueDateTo' => $issueDateToString,
-            'direction' => $direction,
+            'invoiceDirection' => $invoiceDirection,
             'status' => $status,
             'documentType' => $documentType,
-            'receiverId' => $receiverId,
-            'receiverIdType' => $receiverIdType,
-            'receiverTin' => $receiverTin,
-            'issuerTin' => $issuerTin,
+            'searchQuery' => $searchQuery,
         ];
         $query = '?' . http_build_query($params);
 

src/Service/Document/DocumentSubmissionService.php

@@ -38,13 +38,21 @@ public function __construct(MyInvoisClient $client, $prodMode = false)
     /**
      * This API returns information on documents submitted during a single submission by taxpayer.
      * 
-     * @param string $id    Unique ID of the document submission to retrieve.
+     * @param string    $id         Mandatory: Unique ID of the document submission to retrieve.
+     * @param int       $pageNo     Optional: number of the page to retrieve
+     * @param int       $pageSize   Optional: number of the documents to retrieve per page. Page size cannot exceed system configured maximum page size for this API [100]
      * 
      * @return array
      */
-    public function getSubmission($id)
+    public function getSubmission($id, $pageNo = 1, $pageSize = 100)
     {
-        $url = $this->getBaseUrl() . '/' . $id;
+        $params = [
+            'pageNo' => $pageNo,
+            'pageSize' => $pageSize,
+        ];
+        $query = '?' . http_build_query($params);
+
+        $url = $this->getBaseUrl() . '/' . $id . $query;
 
         $response = $this->getClient()->request('GET', $url);
         return $response;

src/Service/Notification/NotificationService.php

@@ -44,14 +44,13 @@ public function __construct(MyInvoisClient $client, $prodMode = false)
      * @param string            $type       Optional: type of notifications to retrieve specified as ID of the type
      * @param string            $language   Optional: used to get notifications only if they were sent out in a specific language
      * @param string            $status     Optional: used to get notifications of certain status only, e.g., only those that were not delivered. Values: pending, batched, delivered, error
-     * @param string            $channel    Optional: used to get notifications delivered over certain channel only. Values: email, push
      * @param int               $pageNo     Optional: number of the page to retrieve. Typically this parameter value is derived from initial parameter less call when caller learns total amount of page of certain size
      * @param int               $pageSize   Optional: number of the packages to retrieve per page. Page size cannot exceed system configured maximum page size for this API which is 100
      * 
      * @return array
      */
     public function getNotifications($dateFrom = null, $dateTo = null, $type = null, $language = null, $status = null,
-        $channel = null, $pageNo = 1, $pageSize = 20)
+        $pageNo = 1, $pageSize = 20)
     {
         $dateFromString = ($dateFrom instanceof DateTime) ? $dateFrom->format('Y-m-d\TH:i:s\Z') : $dateFrom;
         $dateToString = ($dateTo instanceof DateTime) ? $dateTo->format('Y-m-d\TH:i:s\Z') : $dateTo;
@@ -62,7 +61,6 @@ public function getNotifications($dateFrom = null, $dateTo = null, $type = null,
             'type' => $type,
             'language' => $language,
             'status' => $status,
-            'channel' => $channel,
             'pageNo' => $pageNo,
             'pageSize' => $pageSize,
         ];

src/Service/Taxpayer/TaxPayerService.php

@@ -62,4 +62,32 @@ public function validateTaxPayerTin($tin, $idType, $idValue)
         }
         return $response;
     }
+
+    /**
+     * This API allows taxpayer's ERP system to search for a specific Tax Identification Number (TIN) 
+     * using the supported search parameters. The available search parameters are either 
+     * the Taxpayer Name or ID Type and ID Value, or all three parameters combined. 
+     * If all parameters are provided then the search would use an AND operator to make sure the result 
+     * found matches all search parameters provided.
+     *
+     * @param string $taxPayerName      The Taxpayer Name.
+     * @param string $idType            NRIC, Passport number, Business registration number, army number
+     * @param string $idValue           The actual value of the ID Type selected. For example, if NRIC selected as ID Type, then pass the NRIC value here.
+     * 
+     * @return string
+     */
+    public function searchTaxPayerTin($taxPayerName = '', $idType = '', $idValue = '')
+    {
+        $params = [
+            'idType' => $idType,
+            'idValue' => $idValue,
+            'taxpayerName' => $taxPayerName,
+        ];
+        $query = '?' . http_build_query($params);
+
+        $url = $this->getBaseUrl() . '/search/tin' .  $query;
+
+        $response = $this->getClient()->request('GET', $url);
+        return $response;
+    }
 }

src/Ubl/Constant/CountryCodes.php

@@ -51,6 +51,10 @@ public static function getItems()
                 CountryCodes::CODE => "AND",
                 CountryCodes::COUNTRY => "ANDORA"
             ],
+            [
+                CountryCodes::CODE => "ANT",
+                CountryCodes::COUNTRY => "NETHERLANDS ANTILLES"
+            ],
             [
                 CountryCodes::CODE => "ARE",
                 CountryCodes::COUNTRY => "UNITED ARAB EMIRATES"
@@ -1003,6 +1007,10 @@ public static function getItems()
                 CountryCodes::CODE => "WSM",
                 CountryCodes::COUNTRY => "SAMOA"
             ],
+            [
+                CountryCodes::CODE => "XKX",
+                CountryCodes::COUNTRY => "KOSOVO"
+            ],
             [
                 CountryCodes::CODE => "YEM",
                 CountryCodes::COUNTRY => "YEMEN"