Document Handoff
Provides a ZIP package of electronic documents (commonly invoices), together with an index file linking each document to its Invoice ID. The report can be configured to include documents based on creation date, invoice modification date, or statement association within the specified report schedule.
Structure
The zip file will contain all documents at the root level. The zip file will contain a DocumentIndex.csv file and each document. Example:
- /DocumentIndex.csv
- /12345.pdf
- /23343.png

Document Index File
The Document Index is a CSV (Comma-Separated Values) file included within the ZIP package. It links each document to a Conferma Invoice ID. The file contains a single header row declaring the column names. The table below describes the structure of the Document Index file.
Column Index | Column Name | Description | Example |
---|---|---|---|
1 | InvoiceID | Integer. Unique ID generated by Conferma when an Invoice is manually rekeyed in SNAP or SNAP+. | 1234567 |
2 | DocumentID | Integer. Unique ID generated by Conferma when receiving an electronic document. The DocumentID is used as the filename. | 2435546 |
3 | FileType | String. The file type of the electronic document. The file type is retained as extension of the original document. | |
4 | OriginalDocumentName | String. On delivery of the electronic document, Conferma store the original document name and save the file to disc using the DocumentID as the filename. | ParkHouseHotel.pdf |
7 | Message | String. This is currently a blank field which has been added to support future development. | " " |
6 | DeploymentID | Integer. Unique ID generated by Conferma when a deployment is created. | 1234567 |
5 | CardPoolName | String. Name of the Card Pool. | RS Fulfillment |
Documents Types
The SNAP document file names are derived from a unique ID generated by Conferma when the documents are received and stored. The SNAP documents will be delivered in their original formats. Conferma will not standardise the documents to a specific format (such as PDF). The following file types (extensions) are supported by SNAP and can be present in the document export file.
- png
- jpg
- jpeg
- tif
- tiff
- doc
- docx
Updated 5 days ago