Get document

To get one or more document, 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
* 204 means a duplicate record was found in KeepIT, and that no insertion was performed
* 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")
* documents: Array that contains the documents

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

Field	Description	Type	Mandatory
documentRef	Reference to the document that has to be extracted	String
entityCode	Extracts the documents of the given shop	String	Mandatory when documentRef is set
documentDate	Extracts the documents with the given date	Date (format 'YYYY-MM-DD')	Mandatory when documentRef is set
system	Code of the system to be used to filter the recent documents when no other parameter is set	String	Mandatory when no other parameter is set
completeExtraction	If set to `T`, extracts ALL the documents (even the ones before the last request)	Char(1)
languageId	Language code used to extract descriptions for the document codes (e.g. docType, currency, causal etc). Defaults to 'IT' if not specified	Char(2)

* In case documentRef, entityCode, documentDate and completeExtraction are not specified, the web service will retrieve all the documents since the last request.
* The web service is paginated, and will return a chunk of 10 elements at most.

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

Field	Description	Type	Mandatory
start	Pagination offset parameter. The WS will retrieve the elements starting from the one with the index specified here. For example, if 'start' is set to 23, the documents from the 23rd to the 33rd will be returned.	Number

!! IMPORTANT NOTE !!

With completeExtraction = 'F' you should ALWAYS set the start header to 0.
This is because you're extracting 10 documents at a time since the last request and marking them as read, with a process similar to popping data from a list.
The set of data you're reading will shrink at each request.
Even with the start header always set to 0 you'll eventually exhaust the documents that need to be extracted (once moreRows is false).

With completeExtraction = 'T' , instead, you have to increase the start header by 10 at each request, because you're reading a set of data that won't shrink. Once a requests has moreRows equals to false, then the end of the set has been reached.

The response is composed as follows

Document Header section

Field	Description	Type
docType	Document type	Char(20)
docTypeDescription	Description for the docType	Varchar(250)
currency	Currency used in the document values	Varchar(250)
currencyDescription	Description for the currency	Varchar(250)
causal	Document causal	Varchar(250)
causalDescription	Description for the causal	Varchar(250)
year	Document year	Decimal(4, 0)
documentDate	Document date	Datetime
movementDate	Movement date	Datetime
refDocument	Reference code for the document	Varchar(250)
entityCode	Code of the shop	Varchar(250)
entityCodeDescription	Description for the entityCode	Varchar(250)
transportDocument	Code of the transport document	Varchar(250)
supplierDocument	Code of the supplier document	Varchar(250)
supplierCode	Supplier code	Varchar(250)
supplierDenomination	Denomination of the supplier	Varchar(250)
customerCode	Customer code	Varchar(250)
customerDenomination	Denomination of the customer	Varchar(500)
consolidated	Indicates wether the document is consolidated ('T') or not ('F')	Char(1)
entityCodeDest	Code of the destination shop	Varchar(250)
entityCodeDestDescription	Description for the entityCodeDest	Varchar(250)
deliveryDate	Delivery date	Datetime
note	Document notes	Varchar(1024)
totalQuantity	Total packages quantity	Decimal(7, 2)

Document Details section

Field	Description	Type
rowNumber	The number row	Int(11)
barcode	Barcode for the SKU	Varchar(50)
quantity	Article quantity	Decimal(10, 2)
orderRow	Order row number	Decimal(15, 0)
cessionPrice	Article cession price	Decimal(7, 2)
note	Notes for the row	Varchar(1024)

Document Packages section

Field	Description	Type
packageNumber	Package number	Varchar(250)
packageBarcode	Barcode for the package	Varchar(250)
externalPackage	Barcode for the external package	Varchar(250)
consolidated	Indicates wether the package is consolidated ('T') or not ('F')	Char(1)
movementDate	Package movement date	Datetime

Package Details section

Field	Description	Type
packageNumber	Package number	Varchar(250)
rowNumber	Row number	Int(11)
quantity	Package quantity	Decimal(7, 2)

Response example

{
    "success": true,
    "code": 200,
    "message": "Insert/update successful",
    "errorObjects": [],
    "documents": [{
        "documentHeaders": {
            "progId": "identifier",
            "fk_ini06": "document type",
            "fk_ini15": "document causal",
            "year": "document year",
            "document_date": "document date",
            "movement_date": "movement date",
            "fk_ini14": "document currency",
            "ref_document": "document number",
            "fk_ent03": "shop/store",
            "transport_document": "delivery note number",
            "supplier_document": "supplier document number",
            "fk_doc04_master": "linked document identifier",
            "fk_crm01_supplier": "supplier identifier",
            "fk_crm01_customer": "billing customer identifier",
            "consolidated": "indicates wether the document is consolidated or not ('T' for consolidated or 'F' for not consolidated)",
            "fk_ent03_dest": "recipient shop/store",
            "delivery_date": "delivery date",
            "note": "notes",
            "packages_number": "packages number",
            "total_quantity": "total pieces amount"
        },
        "documentDetails": [{
            "progId": "identifier",
            "row_number": "row number",
            "fk_art02": "movement SKU",
            "quantity": "quantity",
            "fk_doc05_order": "order row reference",
            "cession_price": "cession price",
            "note": "row notes"
        }],
        "documentPackages": [{
            "progId": "identifier",
            "package_number": "package number",
            "pakcage_barcode": "package barcode",
            "external_package": "external package code",
            "consolidated": "indicates wether the package is consolidated ('T') or not ('F')",
            "movement_date": "package movement date"
        }],
        "packageDetails": [{
            "progId": "identifier",
            "fk_doc06": "package reference",
            "fk_doc05": "document row reference",
            "quantity": "quantity"
        }]
    }]
}

Notes

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request Code Samples

Responses