Search Documents

Overview

The Search Documents API has various enhanced filters for precise queries and provides access to large result set in a paginated way.

Search documents allows users to query the system and return list of documents that have been received or issued.

To invoke this API, users must provide values for either the submissionDateFrom and submissionDateTo filter parameters or the issueDateFrom and issueDateTo filter parameters. Users can combine these optional filters in various ways to obtain precise results.

Results will be returned in a paginated format based on the specified pageSize, allowing users to navigate through multiple pages of results.

Note: The values of the input filter parameters should remain consistent when requesting subsequent pages of results.

Days difference between submissionDateFrom and submissionDateTo filter parameters, and issueDateFrom and issueDateTo filter parameters should not exceed a configured number of days set by e-Invoice system administrators (Current configuration is 30 days).

Results list is ordered based on registration date of the submission descending (newest documents submitted into the e-Invoice system appear first).

Signature

This is REST based that accepts the below URL filter parameters to search for documents.

Signature: GET /api/v1.0/documents/search?&uuid={uuid}&submissionDateFrom={submissionDateFrom}&submissionDateTo={submissionDateTo}&pageSize={pageSize}&pageNo={pageNo}&issueDateFrom={issueDateFrom}&issueDateTo={issueDateTo}&invoiceDirection={invoiceDirection}&status={status}&documentType={documentType}&searchQuery={searchQuery}

Inputs

This API accepts standard e-Invoice API header parameters for authenticated call.

URL parameters accepted:

Outputs

Successful Response

This API returns HTTP status code 200.

The resulting structure is part of a single object containing result structure.

Throttling and Rate limiting

To allow consistent performance for all taxpayers using e-Invoice API and prevent overuse of resources, this API has throttling limits set per taxpayer (current configuration is 1 Request every 2 Seconds). The throttling limit is subject to change by e-Invoice system administrators.

See the standard error response for more details when your calls to the API are throttled.

Error Response

Error situations are reported back by this API through the standard error response.

Additional considerations

Days difference between submissionDateFrom and submissionDateTo filter parameters, and issueDateFrom and issueDateTo filter parameters are currently configured to 30 days. Days difference value can be changed by e-Invoice system administrators.

There are no maximum number of documents that can be returned by this endpoint. You can use the various optional filters to get the desired documents results.

Receiver of the documents can retrieve documents that are in statuses Valid or Cancelled. If document exists, and is issued to given receiver, but status is Submitted or Invalid, document will not be part of the response. Issuer of the documents can retrieve documents in any status. The document validation or public URL can be created using below -

{envbaseurl}/uuid-of-document/share/longid

where {envbaseurl} need to be replaced with MyInvois portal Base URL

Notes