Document
When a document is imported and it goes through various procedures, all the information obtained about it is stored within an object called Document. This object saves the data within a number of properties (attributes) that are defined by the schema Document.
This following table will show in more detail the attributes take part in the component document and a brief description about the type of data store by each one.
| ATTRIBUTES | TYPE | DESCRIPTION |
|---|---|---|
| id | String | Id of the document. |
| account | String | Account the document belongs to. |
| environment | String | The environment the document belongs to. |
| company | String | Company the document belongs to. |
| creator | String | User that uploaded the document. |
| clientData | Object | Additional data to be added to each document. These data has been included to the document by a client. |
| type | String | Type of the document. |
| name | String | The original name of the document. |
| creation | String | Upload timestamp (date-time). |
| images | Array | Array of URLs to access the document extracted images. |
| original | String | URL to access the original file. |
| mimetype | String | The document format. |
| data | Object | The data obtained from the document. ⚠️ |
| publicState | String | The document state. |
| confidence | String | Marker of the confidence level document obtains.There are four confidence levels. |
| validationInfo | Object | Object that stores data come from the validation process. |
| approvalInfo | Object | Object that stores data come from the approval process. Some data are the beginning date or the steps that are necessary to approve the document. |
| approvedBy | Array | User that approved the document. |
| rejectedBy | Array | User that rejected the document. |
| requiredSigns | Array | Array that contains the users or groups has been requiered to approve the document. |
| import | Object | Object that stores data come from import process such as the reference id or the import method. |
| exports | Array | Object that stores data come from export process such as their reference id or their timestamp. |
| archived | Boolean | Marker that indicates if the document has been archived or not. |
| geometry | Object | Object that contains information of physical aspects of the document as the width or height of the pages or the boxes positions. |
| skippedBy | Array | User that skipped the document. |
| canLock | Boolean | Marker that indicates if the conditions for locking the document are complied or not. |
| canUnlock | Boolean | MarKer that indicates if the conditions for unlocking the document are complied or not. |
| canEdit | Boolean | Marker that indicates if the conditions for editing the document are complied or not. |
| canSign | Boolean | Marker that indicates if the conditions for signing the document are complied or not. |
Next, you will be able to observe how the properties of schema Document are organised and displayed with this following example.
{
"result": {
"_id": "52543ec6d13ac7000bb90823",
"account": "28b05b800123456789000000",
"environment": "28b05b800123456789000000",
"company": "54aadbb7e79e2aba5d25f3e3",
"creator": "28b05b800123456789000000",
"clientData": {},
"type": "invoice",
"name": "Invoice_INVCZ4761199.pdf",
"creation": "2022-04-11T14:44:22.785Z",
"images": [
"https://kinequo.blob.core.windows.net/midas/invoices/images/63f34163e8a7430008b38007-1.png",
"https://kinequo.blob.core.windows.net/midas/invoices/images/63f34163e8a7430008b38007-2.png"
],
"original": "https://kinequo.blob.core.windows.net/midas/invoices/originals/52543ec6d13ac7000bb90823?st=2022-04-29T07%3A16%3A58Z&se=2022-04-29T07%3A46%3A58Z&sp=r&sv=2018-03-28&sr=b&sig=%2FmjG8fY516G2E5qrKhGhg269uuNdq94CJKznssYYxDvI%3D",
"mimetype": "application/pdf",
"data": {..... },
"publicState": "approved",
"confidence": "high",
"validationInfo": {
"errors": []
},
"approvalInfo": {
"reconciliation": {
"lines": {}
},
"beginning": "2023-02-01T00:21:03.455+00:00",
"result": "approved",
"steps": [],
"appliedWorkflow": null
},
"approvedBy": [],
"rejectedBy": [],
"requiredSigns": [],
"import": {
"ref": "62547ec6d13ac7000b590822",
"channel":,
"info": { }
},
"exports": [],
"archived": false,
"geometry": {
"pages": [
{
"width": 8.2639,
"height": 11.6944,
"angle": 0,
"unit": "inch"
}
],
"boxes": {
"documentNumber": [
{
"page": 0,
"box": [
7.0372,
2.1752,
7.8873,
2.1644,
7.8765,
2.3152,
7.0265,
2.3152
]
}
],
"seriesCode": [],
"issueDate": [
{
"page": 0,
"box": [
7.1556,
2.3367,
7.8873,
2.3367,
7.8765,
2.4767,
7.1556,
2.466
]
}
],
"period": [],
"clientCode": [],
"deliveryNoteRef": [],
"orderRef": [],
"contractRef": [],
"incoterms": [],
"invoiceRef": [],
"documentType": [
{
"page": 0,
"box": [
0.495,
1.7122,
1.5172,
1.7122,
1.528,
1.9706,
0.4842,
1.9598
]
}
],
"additionalNotes": [],
"legalNotes": [],
"sign": [],
"paymentMethod": [
{
"page": 0,
"box": [
2.7116,
4.3073,
3.5078,
4.3073,
3.5078,
4.4473,
2.7116,
4.4473
]
}
],
"IBAN": [
{
"page": 0,
"box": [
0.9361,
4.7489,
1.2267,
4.7489,
1.2159,
4.8888,
0.9361,
4.8888
]
},
{
"page": 0,
"box": [
1.2482,
4.7489,
1.5495,
4.7489,
1.5495,
4.8888,
1.2482,
4.8888
]
},
{
"page": 0,
"box": [
1.571,
4.7489,
1.8723,
4.7489,
1.8723,
4.8888,
1.571,
4.8888
]
},
{
"page": 0,
"box": [
1.9046,
4.7489,
2.1843,
4.7489,
2.1843,
4.8996,
1.8938,
4.8888
]
},
{
"page": 0,
"box": [
2.2166,
4.7489,
2.5071,
4.7489,
2.5071,
4.8996,
2.2059,
4.8996
]
},
{
"page": 0,
"box": [
2.5394,
4.7489,
2.83,
4.7489,
2.83,
4.8996,
2.5394,
4.8996
]
}
],
"SWIFT": [
{
"page": 0,
"box": [
1.3558,
4.8996,
2.2274,
4.8996,
2.2274,
5.0396,
1.345,
5.0396
]
}
],
"bankSortCode": [],
"bankAccountNumber": [],
"bankRoutingNumber": [],
"bankAccountName": [
{
"page": 0,
"box": [
1.0437,
4.6089,
1.3235,
4.6089,
1.3128,
4.7489,
1.0437,
4.7489
]
},
{
"page": 0,
"box": [
1.345,
4.6089,
1.797,
4.6089,
1.797,
4.7489,
1.345,
4.7489
]
},
{
"page": 0,
"box": [
1.8292,
4.6089,
2.1521,
4.6089,
2.1413,
4.7381,
1.8185,
4.7489
]
},
{
"page": 0,
"box": [
2.1736,
4.6089,
2.3995,
4.6089,
2.3995,
4.7381,
2.1736,
4.7381
]
}
],
"paymentTerms": [],
"issuerName": [
{
"page": 0,
"box": [
0.5057,
0.4523,
1.1298,
0.4523,
1.1191,
0.7753,
0.495,
0.7753
]
},
{
"page": 0,
"box": [
1.1944,
0.4523,
2.3565,
0.4523,
2.3565,
0.7861,
1.1836,
0.7753
]
},
{
"page": 0,
"box": [
2.4211,
0.4523,
3.2388,
0.4523,
3.2388,
0.7861,
2.4211,
0.7861
]
},
{
"page": 0,
"box": [
3.3034,
0.4523,
3.8737,
0.4523,
3.8737,
0.7861,
3.3034,
0.7861
]
}
],
"issuerTaxId": [
{
"page": 0,
"box": [
7.0265,
1.5076,
7.7474,
1.5076,
7.7366,
1.626,
7.0265,
1.626
]
}
],
"issuerAddress": [
{
"page": 0,
"box": [
7.0695,
1.0984,
7.1448,
1.0984,
7.1448,
1.2168,
7.0695,
1.2168
]
},
{
"page": 0,
"box": [
7.1771,
1.0984,
7.5968,
1.0984,
7.586,
1.2276,
7.1663,
1.2168
]
},
{
"page": 0,
"box": [
7.6183,
1.0984,
7.7582,
1.0984,
7.7474,
1.2168,
7.6075,
1.2276
]
},
{
"page": 0,
"box": [
7.048,
1.2384,
7.3708,
1.2384,
7.36,
1.3568,
7.048,
1.3568
]
},
{
"page": 0,
"box": [
7.4031,
1.2384,
7.7582,
1.2384,
7.7474,
1.3568,
7.3923,
1.3568
]
}
],
"issuerEmail": [
{
"page": 0,
"box": [
6.7359,
1.3784,
7.7151,
1.3784,
7.7151,
1.4968,
6.7252,
1.4968
]
}
],
"issuerPhoneNumber": [],
"issuerFax": [],
"issuerWebsite": [],
"recipientName": [
{
"page": 0,
"box": [
0.4735,
2.1644,
1.0545,
2.1644,
1.0545,
2.3152,
0.4735,
2.3152
]
},
{
"page": 0,
"box": [
1.0868,
2.1644,
1.2697,
2.1644,
1.2697,
2.3152,
1.0868,
2.3152
]
}
],
"recipientTaxId": [
{
"page": 0,
"box": [
0.7855,
2.3367,
1.528,
2.3367,
1.5172,
2.4767,
0.7855,
2.4767
]
}
],
"recipientAddress": [
{
"page": 0,
"box": [
0.495,
2.4983,
0.6026,
2.4983,
0.6026,
2.649,
0.495,
2.649
]
},
{
"page": 0,
"box": [
0.6349,
2.4983,
0.9899,
2.4983,
0.9899,
2.6598,
0.6349,
2.649
]
},
{
"page": 0,
"box": [
1.0222,
2.4983,
1.4634,
2.4983,
1.4742,
2.6598,
1.0222,
2.6598
]
},
{
"page": 0,
"box": [
1.4957,
2.4983,
1.6248,
2.4983,
1.6248,
2.6598,
1.5064,
2.6598
]
},
{
"page": 0,
"box": [
1.6571,
2.4983,
2.0552,
2.4983,
2.066,
2.6598,
1.6571,
2.6598
]
},
{
"page": 0,
"box": [
2.0875,
2.4983,
2.2274,
2.4983,
2.2274,
2.6598,
2.0983,
2.6598
]
},
{
"page": 0,
"box": [
2.2597,
2.4983,
2.6793,
2.4983,
2.6901,
2.6598,
2.2597,
2.6598
]
},
{
"page": 0,
"box": [
2.7116,
2.4983,
2.7977,
2.4983,
2.8084,
2.6598,
2.7223,
2.6598
]
},
{
"page": 0,
"box": [
2.83,
2.4983,
2.9053,
2.4983,
2.9053,
2.649,
2.83,
2.649
]
},
{
"page": 0,
"box": [
0.4842,
2.6706,
0.8823,
2.6598,
0.8716,
2.8213,
0.4735,
2.8213
]
},
{
"page": 0,
"box": [
0.9469,
2.6598,
1.3988,
2.6706,
1.3881,
2.8213,
0.9361,
2.8213
]
},
{
"page": 0,
"box": [
0.495,
2.8428,
0.9577,
2.8428,
0.9577,
3.0044,
0.495,
2.9936
]
}
],
"recipientEmail": [],
"recipientPhoneNumber": [],
"recipientFax": [],
"recipientWebsite": [],
"shippingAddress": [],
"dues": [
{
"date": [],
"amount": []
}
],
"totalGrossAmount": [],
"totalFeesAmount": [],
"totalDiscountAmount": [],
"totalTaxBaseAmount": [],
"totalTaxAmount": [],
"withholdingTaxRate": [],
"withholdingTaxAmount": [],
"reimbursableExpensesAmount": [],
"totalAmount": [
{
"page": 0,
"box": [
7.1341,
4.2966,
7.5752,
4.2858,
7.5752,
4.4366,
7.1341,
4.4366
]
},
{
"page": 0,
"box": [
7.1341,
5.4057,
7.5645,
5.4165,
7.5645,
5.5565,
7.1341,
5.5457
]
}
],
"additionalChargesAmount": [],
"additionalDiscountsAmount": [],
"totalDueAmount": [
{
"page": 0,
"box": [
7.3277,
2.6706,
7.7582,
2.6706,
7.7582,
2.8213,
7.3277,
2.8213
]
}
],
"lines": [
{
"group": [],
"identifier": [],
"providerRef": [],
"clientRef": [],
"description": [
{
"page": 0,
"box": [
1.6678,
3.8551,
2.1628,
3.8658,
2.1628,
3.9951,
1.6571,
3.9843
]
},
{
"page": 0,
"box": [
2.1951,
3.8658,
2.335,
3.8658,
2.335,
3.9951,
2.1843,
3.9951
]
},
{
"page": 0,
"box": [
2.3673,
3.8658,
2.9698,
3.8658,
2.9591,
4.0058,
2.3565,
3.9951
]
},
{
"page": 0,
"box": [
2.9914,
3.8658,
3.3464,
3.8551,
3.3464,
4.0058,
2.9914,
4.0058
]
},
{
"page": 0,
"box": [
3.3787,
3.8551,
4.0243,
3.8551,
4.0243,
3.9951,
3.368,
4.0058
]
},
{
"page": 0,
"box": [
1.6678,
4.0274,
1.9799,
4.0058,
1.9799,
4.1458,
1.6678,
4.1458
]
},
{
"page": 0,
"box": [
2.0014,
4.0058,
2.6578,
4.0166,
2.6578,
4.1566,
2.0014,
4.1458
]
}
],
"date": [],
"quantity": [
{
"page": 0,
"box": [
4.6915,
3.8658,
4.8529,
3.8658,
4.8529,
3.9735,
4.6915,
3.9735
]
}
],
"unitOfMeasurement": [],
"grossUnitPrice": [
{
"page": 0,
"box": [
5.3263,
3.8551,
5.7137,
3.8658,
5.7029,
3.9951,
5.3263,
3.9951
]
}
],
"taxBaseUnitPrice": [],
"totalUnitPrice": [],
"grossAmount": [],
"discountAmount": [
{
"page": 0,
"box": [
6.2948,
3.8551,
6.553,
3.8551,
6.553,
3.9843,
6.2948,
3.9843
]
}
],
"discountRate": [],
"feesAmount": [],
"feesRate": [],
"taxBaseAmount": [],
"taxRate": [],
"taxAmount": [],
"totalAmount": [
{
"page": 0,
"box": [
7.1879,
3.8551,
7.586,
3.8551,
7.5752,
3.9951,
7.1879,
3.9951
]
}
]
}
],
"breakdowns": [
{
"taxRate": [
{
"page": 0,
"box": [
6.4024,
5.0396,
6.6391,
5.0396,
6.6391,
5.1796,
6.3916,
5.1688
]
}
],
"taxBaseAmount": [
{
"page": 0,
"box": [
7.1448,
4.6627,
7.5752,
4.6627,
7.5645,
4.8027,
7.1341,
4.8027
]
}
],
"taxAmount": [
{
"page": 0,
"box": [
7.2632,
5.0504,
7.586,
5.0396,
7.5752,
5.1688,
7.2632,
5.1688
]
}
],
"RERate": [],
"REAmount": [],
"totalAmount": [],
"grossAmount": [],
"discountBaseAmount": [],
"discountAmount": [],
"discountRate": [],
"feesBaseAmount": [],
"feesAmount": [],
"feesRate": []
}
]
}
},
"skippedBy": []
},
"canLock": false,
"canUnlock": false,
"canEdit": false,
"canSign": false
}
A detail we would like to highlight is tha the most of these attributes are generic for all types of documents. Nevertheless, there is one ,the attribute data, that contains a number of particularities ⚠️. These particularities are:
- The values of attribute data depends on the type of the document.
- The values of attribute data are defined by an specific schema.
On the following pages we are going to explain the different schemas we use to store and exhibit the characteristic data of each type of document.
Updated 5 months ago