Use this operation to return uploaded customer data files for the authenticated tenant. You can filter results using file status and pagination via $top and $skip (offset). You can also sort results using $orderBy. If you don't provide any filters or pagination, this operation returns all files.

Base URL:

https://vat-compliance-service.vertexcloud.com/documents

Provide request parameters to view uploaded customer data files	Upload your data files to generate the upload URL description
`/object/array of objects`	GET - List uploaded customer data files for the tenant.

Request

All request parameters are optional.

List uploaded customer data files for the tenant parameter name	List uploaded customer data files for the tenant parameter format	List uploaded customer data files for the tenant request parameter description
`fileStatus`	array of strings	File status filter. Accepts one or more values via repeated parameters, such as `?fileStatus=COMPLETE&fileStatus=IN_PROGRESS` Allowed: `NOT_STARTED`, `IN_PROGRESS`, `READY_FOR_REVIEW`, `COMPLETE`, `FAILED`, `IMPORT_IN_PROGRESS`, `IMPORT_SUCCESSFUL`, `IMPORT_FAILED`, `FAILED_PROCESSING`, `UPLOAD_FAILED`, `RULES_PROCESSING`, `RULES_PROCESSING_COMPLETED`, `RULES_PROCESSING_FAILED`, `UPLOAD_IN_PROGRESS`, `SPLIT_PROCESS_COMPLETED`, `REJECTED`, `FILE_SPLITTING_IN_PROGRESS`, `AUTO_IMPORT_PENDING`, `DETECTION_IN_PROGRESS`, `DUPLICATE_REVIEW`, `DETECTION_FAILED`, `REVIEW_IN_PROGRESS`, `PENDING_UPLOAD`, `PENDING_VALIDATION`, `VALIDATION_FAILED`, `PROCESSING_ERROR`
`$top`	integer	Page size is the number of records to return. The maximum value is 1000. When empty, all records are returned.
`$skip`	integer	Number of records to skip (offset). Defaults to `0`.
`$orderBy`	string	Sort field and direction, such as `createdDate desc`. Defaults to `lastUpdateDate desc`. Allowed fields: `fileStatus`, `fileOriginalFileName`, `createdDate`, `createdById`, `templateName`, `importProfileName`, `importProfileManualInd`, `importProfilePassThroughInd`, `applyTaxCodeMappings`, `fileLoadType`, `sourceType`, `numOfRows`, `companyCode`, `countryCode`, `duplicateRecordsCount`.

Example request

curl --request GET \
     --url 'https://vat-compliance-service.vertexcloud.com/documents?fileStatus=COMPLETE&fileStatus=IN_PROGRESS&$orderBy=createdDate%20desc' \
     --header 'accept: application/json'

Response

An HTTP 200 Success response includes a StorageMeta array of objects. Each object includes the following fields populated according to the state of the customer data file.

List uploaded customer data files for the tenant response field	List uploaded customer data files for the tenant response description
`fileId`	The internal seven-digit file ID.
`fileDispCode`	File disposition code.
`fileName`	A unique string representing the file name.
`fileDesc`	A unique string file description.
`enabledInd`	Enabled indicator. `true` / `false`
`readOnlyInd`	Read-only indicator. `true` / `false`
`draftInd`	Draft indicator. `true` / `false`
`createdDate`	Created date.
`createdById`	Created by ID.
`createdByUserFirstName`	Created by user's first name.
`createdByDataReleaseId`	Created by data release ID.
`lastUpdateDate`	Last updated date.
`lastUpdateById`	Last updated by ID.
`updatedByDataReleaseId`	Updated by Data Release ID.
`sizeInBytes`	The file size in bytes.
`numOfRows`	The number of rows in this customer data file.
`uuid`	Universally Unique Identifier.
`templateId`	Template ID.
`templateName`	Template name.
`fileOriginalFileName`	File original filename.
`fileStatus`	File status. Allowed values: `NOT_STARTED`, `IN_PROGRESS`, `READY_FOR_REVIEW`, `COMPLETE`, `FAILED`, `IMPORT_IN_PROGRESS`, `IMPORT_SUCCESSFUL`, `IMPORT_FAILED`, `FAILED_PROCESSING`, `UPLOAD_FAILED`, `RULES_PROCESSING`, `RULES_PROCESSING_COMPLETED`, `RULES_PROCESSING_FAILED`, `UPLOAD_IN_PROGRESS`, `SPLIT_PROCESS_COMPLETED`, `REJECTED`, `FILE_SPLITTING_IN_PROGRESS`, `AUTO_IMPORT_PENDING`, `DETECTION_IN_PROGRESS`, `DUPLICATE_REVIEW`, `DETECTION_FAILED`, `REVIEW_IN_PROGRESS`, `PENDING_UPLOAD`, `PENDING_VALIDATION`, `VALIDATION_FAILED`, `PROCESSING_ERROR`
`recordCount`	Record count.
`docRepoUuid`	Document repository UUID.
`fileOrigin`	File origin.
`originalFileDocRepoUuid`	Original file document repository UUID.
`removedRowsDocRepoUuid`	Removed rows document repository UUID.
`auditDetailsDocRepoUuid`	Audit details document repository UUID.
`importProfileId`	Import profile ID.
`importProfileName`	Import profile name.
`importProfileManualInd`	Import profile manual indicator. `true` / `false`
`importProfilePassThroughInd`	Import file pass-through indicator. `true` / `false`
`duplicateDetectionInd`	Duplicate detection indicator. `true` / `false`
`duplicateDetectionInitiated`	Duplicate detection initiated. `true` / `false`
`automaticRulesetApplied`	Automatic ruleset applied. `true` / `false`
`dataStartsOn`	Data starts on line number.
`fileLoadType`	File load type description.
`combinedFile`	Combined file. `true` / `false`
`combinedFileId`	Combined file ID.
`sourceType`	Source type description.
`taxCodeMappingsApplied`	Tax code mappings applied to this file. `true` / `false`
`companyCode`	Company code associated with this file.
`countryCode`	Country code associated with this file.
`splitFile`	Split file. `true` / `false`
`splitFileId`	Split file ID.
`splitFileIds`	An array of split file IDs.
`reviewProcessApplied`	The review process applied. `true` / `false`
`dataFileUpload`	Data file upload. `true` / `false`
`dataImportUser`	Data import user. `true` / `false`
`limitedRoleAccess`	Limited role access. `true` / `false`
`seqIndicator`	Sequence indicator. `true` / `false`
`ruleProcessingStatus`	Rule processing status description.
`duplicateRecordsCount`	Duplicate records count number.
`unreviewedDuplicatesCount`	Unreviewed duplicate count number.
`exportToGCInd`	Export to Global Compliance (GC) indicator. `true` / `false`
`saftData`	Standard Audit File for Tax (SAFT) data. `true` / `false`
`enableOSeriesOption`	Enable O Series option. `true` / `false`

Example response

{
  "StorageMeta": [
    {
      "fileId": 0,
      "fileDispCode": "string",
      "fileName": "string",
      "fileDesc": "string",
      "enabledInd": true,
      "readOnlyInd": true,
      "draftInd": true,
      "createdDate": 0,
      "createdById": 0,
      "createdByUserFirstName": "string",
      "createdByDataReleaseId": 0,
      "lastUpdateDate": 0,
      "lastUpdateById": 0,
      "updatedByDataReleaseId": 0,
      "sizeInBytes": 0,
      "numOfRows": 0,
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "templateId": 0,
      "templateName": "string",
      "fileOriginalFileName": "string",
      "fileStatus": "NOT_STARTED",
      "recordCount": 0,
      "docRepoUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fileOrigin": "string",
      "originalFileDocRepoUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "removedRowsDocRepoUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "auditDetailsDocRepoUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "importProfileId": 0,
      "importProfileName": "string",
      "importProfileManualInd": true,
      "importProfilePassThroughInd": true,
      "exportToGCInd": true,
      "taxCodeMappingsApplied": true,
      "companyCode": "string",
      "countryCode": "string",
      "reviewProcessApplied": true,
      "saftData": true,
      "enableOSeriesOption": true
    }
  ]
}