GuidesAPI Reference
API Reference

List uploaded customer data files for the tenant

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

Returns uploaded customer data files for the authenticated tenant. Supports optional filtering by one or more file statuses, pagination via $top/$skip, and sorting via $orderBy. When no filters or pagination are provided, all files are returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
fileStatus
array of strings

Optional file status filter. Accepts one or more values via repeated parameters (e.g. ?fileStatus=COMPLETE&fileStatus=IN_PROGRESS).

fileStatus
integer
1 to 1000

Page size — number of records to return. Maximum 1000. When omitted, all records are returned.

integer
≥ 0
Defaults to 0

Number of records to skip (offset). Defaults to 0.

string

Sort field and direction (e.g. "createdDate desc"). Defaults to lastUpdateDate descending. Allowed fields: fileStatus, fileOriginalFileName, createdDate, createdById, templateName, importProfileName, importProfileManualInd, importProfilePassThroughInd, applyTaxCodeMappings, fileLoadType, sourceType, numOfRows, companyCode, countryCode, duplicateRecordsCount.

Responses

400

Invalid request parameters

401

Unauthorized

500

Server error

Updated 15 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago

Did this page help you?