Retrieveinvoice

This api allows to retrieve a specific document.

Request URI

Request Structure

Field	Type	Mandatory	Description
`userName`	String	N	User name for authentication
`password`	String	N	Password for authentication
`serviceName`	String	N	Name of the service
`appCodeClient`	String	N	Client application code
`templateName`	String	N	Template name
`userCode`	String	N	User code
`maxFileNumber`	String	N	Maximum number of files to retrieve

Request Example

{ "userName": "wdluser", "password": "Q21wcl83MzU3", "serviceName": "CAMPARI_TEST", "appCodeClient": "camparitestws001", "templateName": "CAMPARI_FATTURE_PASSIVE_TEST", "userCode": "", "maxFileNumber": "3" }

Response Structure

Field	Type	Mandatory	Description
`authentication`	Boolean	N	Indicates whether the authentication was successful
`templateName`	String	N	Name of the template used in the service
`errorMessage`	String	N	Describes any error that occurred during the operation
`folderName`	String	N	Name of the folder
`status`	Integer	N	Status code
`files (0..∞)`
`idQueue`	Integer	N	Queue or process identifier
`fileName`	String	N	Name of the file
`fileBase64`	String	N	Base64-encoded file content
`hash`	String	N	Hash value of the file (integrity check)
`errorMessage`	String	N	Error message specific to this file
`idRecDoc`	Integer	N	Document record identifier
`files/otherInfo`
`files/otherInfo/fields (0..∞)`
`name`	String	N	Name of the additional metadata field
`value`	String	N	Value assigned to the metadata field

Response Example

{ "authentication": "boolean", "templateName": "string", "errorMessage": "string", "folderName": "string", "status": "integer", "files": [ { "idQueue": "integer", "fileBase64": "string", "fileName": "string", "hash": "string", "otherInfo": { "fields": [ { "name": "string", "value": "string" } ] } } ] }

Retrieveinvoice

0 Comments

Docs Navigation