Insert/Update Vouchers

To insert/update 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

code : HTTP Code for the response

200 means the request was correctly processed

206 means that not all records were inserted or processed

400 means that the request body is invalid or contains syntax errors

500 means a server error has happened

message: response message for the request (e.g. "Insertion successful" or "Missing required parameter")

vouchersInserted: Array of inserted vouchers

Request body structure

Field	Description	Type	Mandatory
vouchersRecords	Array of voucher objecs	See below for the the object structure To update an attribute also specify the progId, which is the identifier for the attribute	✓

vouchersRecords section

Field	Description	Type	Mandatory
voucherType	String	Voucher type code	✓
voucherBarcode	String	Voucher barcode	✓
entityCode	String	Code of the branch where the voucher is being used	✓
documentDate	String	Date of the document where the voucher is being used	✓
refDocument	String	Reference code of the document where the voucher is being used	✓
amount	Number	Voucher amount	✓
spent	Char	'T' or 'F' depending wether the voucher has been spent or not	✓
entityCodePurchase	String	Code of the issuing branch	✓
documentDatePurchase	String	Date of the issuing document	✓
refDocumentPurchase	Char	Issuing document reference	✓

Response example

{"success":true,"code":200,"message":"Inserimento/Update riuscito con successo.","vouchersInserted":[...], "vouchersUpdated": [...], "vouchersError": [...]}

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
    "vouchersRecords": [
        {
            "voucherType": "TEST",
            "voucherBarcode": "1111111111",
            "entityCode": 6,
            "documentDate": "2017-11-24 00:00:00:000",
            "refDocument": "98",
            "amount": 100.00,
            "convertionRateCompany": 1.00,
            "amountCompany": 100.00,
            "spent": "T",
            "entityCodePurchase": 6,
            "documentDatePurchase": "2017-10-24 00:00:00:000",
            "refDocumentPurchase": "abc"
        },
        {
            "voucherType": "TEST",
            "voucherBarcode": "1111111111",
            "entityCode": 6,
            "documentDate": "2017-11-24 00:00:00:000",
            "refDocument": "1-1093362172",
            "amount": 100.00,
            "convertionRateCompany": 1.00,
            "amountCompany": 100.00,
            "spent": "T",
            "entityCodePurchase": 6,
            "documentDatePurchase": "2017-10-24 00:00:00:000",
            "refDocumentPurchase": "abc"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert/Update Vouchers

Request

Request Code Samples

Responses