Get Vouchers Export

To retrieve one or more vouchers, it's necessary to make a POST call, passing a JSON body as specified below.

The web service response will be composed of:

success : Boolean that indicated wether the request was successful or not

valueObjectList : is an array containing all the voucer information. Read below for the response structure

This is the list of fields that can be passed in the request body:

Field	Description	Type	Mandatory
languageId	Language for the article localized strings (`IT` or `EN`, defaults to user languare or `IT` if omitted)	String
completeExtraction	If set to `T`, extracts ALL the movements (even the ones before the last request)	Char(1)

Notes

In case completeExtraction is not T the web service will retrieve all the modified vouchers since the last request (in this case, the parameter system must be set in the body request, representing the system the recalls will be retrieved from).

The web service is paginated, and will return a chunk of 20 elements at most.

There a limit of 100 calls for this API

This is the list of fields that can be passed in the request parameters:

Field	Description	Type	Mandatory
start	Pagination offset parameter. (only if `completeExtraction` is `T`) The WS will retrieve the elements starting from the one with the index specified here. For example, if 'start' is set to 23, the vouchers from the 23rd to the 43rd will be returned.	Number

The response is composed as follows

Field	Description	Type
voucherBarcode	Barcode of the voucher	Varchar(250)
voucherType	Type of voucher	Varchar(250)
voucherTypeDescription	Description of type voucher	Varchar(250)
amount	Amount of the voucher	Decimal(15,2)
spent	It indicates if the voucher was used or not	Char(1)
amountCompany	The amount of the voucher in the company currency	Decimal(15,2)
convertionRateCompany	Indicates the convertion rate used to calculate the company amount from the local amount	Decimal(15,9)
amountSite	The amount of the voucher in the site currency	Decimal(15,2)
convertionRateSite	Indicates the convertion rate used to calculate the site total amount from the local totale amount	Decimal(15,9)
entityCodeIssued	Alphanueric code of the entity of document issued	Varchar(250)
entityCodeIssuedDescription	Description of the entity	Varchar(250)
refDocumentIssued	Unique reference document	Varchar(250)
documentDateIssued	Date of the document issued	Date
customerCodeIssued	Alphanumeric code of the subject of document issued	Varchar(250)
entityCodeUsed	Alphanueric code of the entity of document used	Varchar(250)
entityCodeUsedDescription	Description of the entity	Varchar(250)
refDocumentUsed	Unique reference document	Varchar(250)
documentDateUsed	Date of the document used	Date
customerCodeUsed	Alphanumeric code of the subject of document used	Varchar(250)

Response example

{
  "success": true,
  "valueObjectList": [
      {
        "voucherBarcode": "8015922230406",
        "voucherType": "1",
        "voucherTypeDescription": "Buono merce",
        "amount": 109,
        "spent": "F",
        "amountCompany": 109,
        "convertionRateCompany": 1,
        "amountSite": null,
        "convertionRateSite": 1,
        "entityCodeIssued": "1150",
        "entityCodeIssuedDescription": "1150 Negozio",
        "refDocumentIssued": "10-1",
        "documentDateIssued": "20-06-15",
        "customerCodeIssued": "100000",
        "entityCodeUsed": null,
        "entityCodeUsedDescription": null,
        "refDocumentUsed": null,
        "documentDateUsed": "",
        "customerCodeUsed": null
    },
    {
        "voucherBarcode": "8015922338508",
        "voucherType": "1",
        "voucherTypeDescription": "Buono merce",
        "amount": 109,
        "spent": "T",
        "amountCompany": 109,
        "convertionRateCompany": 1,
        "amountSite": null,
        "convertionRateSite": 1,
        "entityCodeIssued": "1150",
        "entityCodeIssuedDescription": "1150 Negozio",
        "refDocumentIssued": "10-5",
        "documentDateIssued": "20-06-15",
        "customerCodeIssued": "100000",
        "entityCodeUsed": "1150",
        "entityCodeUsedDescription": "1150 Negozio",
        "refDocumentUsed": "10-6",
        "documentDateUsed": "20-06-15",
        "customerCodeUsed": "100000"
    }]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Get Vouchers Export

Request

Request Code Samples

Responses