Complete customer data file Upload
Use the Complete customer data file Upload request to notify VAT Compliance that the data file upload succeeded. This triggers an automated workflow for VAT Compliance to track the file, scan for viruses and validate, and then add the file to the Working Files tab on the My Files page.
Once the Complete customer data file Upload request is complete, follow the process for uploading final data to VAT Compliance. The process varies depending on whether you used an automatic or manual import profile. For general import instructions, refer to Importing your Data.
Base URL:
https://vat-compliance-service.vertexcloud.com/documents
| Complete customer data file Upload endpoint | Complete customer data file Upload description |
|---|---|
/{vrn} | POST - Marks the uploaded customer data file as complete and optionally triggers metadata processing and restaging. |
Request
The Vertex Resource Name (VRN) is required. All other request parameters are optional.
| Complete customer data file Upload request parameter name | Complete customer data file Upload request parameter format | Complete customer data file Upload request parameter description |
|---|---|---|
vrn | string | Vertex Resource Name (VRN) is a unique identifier for cloud platform resources. Copy the VRN that the Upload your data files to generate the upload URL operation generates. |
metadata | Boolean | Indicates whether metadata processing should be triggered. Default = true. |
restage | Boolean | Indicates whether the file should be restaged. Default = true. |
Example request
curl --request PATCH \
--url https://vat-compliance-service.vertexcloud.com/document/{vrn} \
--header 'accept: application/json'
Response
A response includes a message about the file status.
| Complete customer data file Upload response field | Complete customer data file Upload response description |
|---|---|
message | A message indicating the file status and whether the workflow was triggered |
Example response
{
"message": "File status updated. Workflow triggered."
}
Updated 1 day ago
