Insert documents

To insert 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")

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

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

Document Headers section

Field	Description	Type	Mandatory
docType	Document type	Varchar(250)	✓
causal	Document causal	Varchar(250)	✓
currency	Document currency	Varchar(250)	✓
year	Document year	Decimal(4, 0)	✓
documentDate	Document date	Datetime	✓
refDocument	Document number	Varchar(250)	✓
entityCode	Shop/store	Varchar(250)	✓
movementDate	Movement date	Datetime	✓
transportDocument	Delivery note number	Varchar(250)	✓
supplierDocument	Supplier document number	Varchar(250)	✓
supplier	Supplier identifier	Varchar(250)	✓
customer	Billing customer identifier	Varchar(250)	✓
consolidated	Indicates wether the document is consolidated or not ('T' for consolidated or 'F' for not consolidated)	Char(1)	✓
consolidatedTransfer	Indicates wether the transfer document should be created automatically and is consolidated or not ('T' for consolidated or 'F' for not consolidated)	Char(1)
deliveryDate	Delivery date	Datetime	✓
note	Document notes	Varchar(1024)
packagesNumber	packages number	Decimal(7, 0)
totalQuantity	total pieces amount	Decimal(7, 2)	✓
system	The system which performed the call	Varchar(250)	✓
externalCode	External code for the document	Varchar(250)	✓
The following fields must be specified only when comparing goods of a related document
relatedDocumentDate	Related document date	Datetime
relatedRefDocument	Related document number	Varchar(250)
relatedEntityCode	Related shop/store code	Varchar(250)
The following field must be specified only when trasferring goods
entityCodeDest	Recipient shop/store code	Varchar(250)
percDiscount1	Percentage for the graduated discount 1	Number
percDiscount2	Percentage for the graduated discount 2	Number
percDiscount3	Percentage for the graduated discount 3	Number
percDiscount4	Percentage for the graduated discount 4	Number
percYearDiscount	Percentage for the yearly discount	Number
payment	Code of the payment method	Varchar(255)
confirmationDateOrder	Order confirmation date	Datetime
limitDate	Date that indicates the last day of accepted delivery	Datetime
buyer	Subject code for the buyer	Varchar(255)
seasonCode	Code for the seaason	Varchar(255)

Document Details section

Field	Description	Type	Mandatory
rowNumber	Row number	Int(11)	✓
barcode	Article barcode	Varchar(250)	✓
quantity	Quantity	Decimal(10, 2)	✓
orderRow	Order row reference	Varchar(250)
cessionPrice	Cession price	Decimal(7, 2)
note	Row notes	Varchar(1024)
percDiscount1	Percentage of graduated discount 1	Number
percDiscount2	Percentage of graduated discount 2	Number
percDiscount2	Percentage of discount 2	Number
deliveryDate	Package delivery date	Datetime

Document Packages section

Field	Description	Type	Mandatory
packageNumber	Package number	Varchar(250)	✓
pakcageBarcode	Package barcode	Varchar(250)	✓
externalPackage	External package code	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	Mandatory
rowNumber	Document row reference	Varchar(250)	✓
packageNumber	Package reference	Varchar(250)	✓
quantity	quantity	Int(11)	✓

documentsRecords example

"documentsRecords": [{
    "documentHeaders": {
        "docType": "document type",
        "causal": "document causal",
        "currency": "document currency",
        "year": "document year",
        "documentDate": "document date",
        "refDocument": "document number",
        "entityCode": "shop/store",
        "relatedDocumentDate": "related document date",
        "relatedRefDocument": "related document number",
        "relatedEntityCode": "related shop/store",
        "movementDate": "movement date",
        "transportDocument": "delivery note number",
        "supplierDocument": "supplier document number",
        "supplier": "supplier identifier",
        "customer": "billing customer identifier",
        "consolidated": "indicates wether the document is consolidated or not ('T' for consolidated or 'F' for not consolidated)",
        "consolidatedTransfer": "indicates wether the transfer document should be created automatically and is consolidated or not ('T' for consolidated or 'F' for not consolidated)",
        "entityCodeDest": "recipient shop/store",
        "deliveryDate": "delivery date",
        "note": "notes",
        "packagesNumber": "packages number",
        "totalQuantity": "total pieces amount",
        "system": "Caller system",
        "externalCode": "External code for the document"
    },
    "documentDetails": [{
        "rowNumber": "row number",
        "barcode": "article barcode",
        "quantity": "quantity",
        "orderRow": "order row reference",
        "cessionPrice": "cession price",
        "note": "row notes"
    }],
    "documentPackages": [{
        "packageNumber": "package number",
        "pakcageBarcode": "package barcode",
        "externalPackage": "external package code",
        "consolidated": "indicates wether the package is consolidated ('T') or not ('F')",
        "movementDate": "package movement date"
    }],
    "packageDetails": [{
        "rowNumber": "document row reference",
        "packageNumber": "package reference",
        "quantity": "quantity"
    }]
}]

Response example

{
    "success": true,
    "code": 200,
    "message": "Insert/update successful"
}

Notes

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

Request

Query Params

Header Params

Body Params application/json

Example

{
    "documentsRecords": [
        {
            "documentHeaders": {
                "documentDate": "2019-06-20 16:00:00",
                "movementDate": "2019-06-20 16:00:00",
                "totalQuantity": 0,
                "docType": "9",
                "consolidated": "T",
                "refDocument": "VENDBOLLA1-1170",
                "causal": "1",
                "currency": "RUB",
                "entityCode": 1170,
                "system": "RUSSIA",
                "year": 2019,
                "customer": "CICCIO"
            },
            "documentDetails": [
                {
                    "barcode": "500007351207                  ",
                    "quantity": 2,
                    "rowNumber": 1
                },
                {
                    "barcode": "500007763704                  ",
                    "quantity": 2,
                    "rowNumber": 2
                },
                {
                    "barcode": "500006682005                  ",
                    "quantity": 1,
                    "rowNumber": 3
                }
            ]
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request Code Samples

Responses