Document Details

Get the detail of a document by unique identifier

URL : /api/v1/xdocument/{DocumentId}

Method : GET

Auth required : Key-Value pairs on Header

Example : https://demo.calybra.com/api/v1/xdocument/02116ec1-3e33-45fe-be38-7970dfa2f74b

Success Response

Code : 200 OK

Content examples

{
    "DocumentId": "35a12853-3f21-446c-af30-aeaa3171652e",
    "Number": 1,
    "Date": "2023-04-19T00:00:00",
    "CompanyId": "c7a1092a-f106-4439-93b7-7c370d6a05bd",
    "CompanyCode": null,
    "CompanyName": "Customer 1 ltd",
    "Notes": null,
    "InternalNotes": null,
    "Rows": [
        {
            "RowNumber": 1,
            "ItemCode": "P104",
            "ItemSupplierCode": null,
            "Description": "Prodotto finito neutro",
            "Quantity": 1.235,
            "MeasureUnitId": "kg",
            "Batch": "L230951142",
            "BatchDueDate": "2023-04-15T00:00:00",
            "Price": 2.20000,
            "Discount": 0.000,
            "VatPercentage": 22.000,
            "Notes": "",
            "Ingredient": null,
            "ProductId": "247dc67c-7094-42bd-ab95-87d7cafc2d32",
            "ItemId": "5ab332c0-ffca-41ab-9698-eb420a57b57a"
        },
        {
            "RowNumber": 2,
            "ItemCode": "P101",
            "ItemSupplierCode": null,
            "Description": "CUSTOM01",
            "Quantity": 1.000,
            "MeasureUnitId": "n",
            "Batch": "L230951143",
            "BatchDueDate": "2023-04-10T00:00:00",
            "Price": 0.00000,
            "Discount": 0.000,
            "VatPercentage": 22.000,
            "Notes": "",
            "Ingredient": null,
            "ProductId": "247dc67c-7094-42bd-ab95-87d7cafc2d32",
            "ItemId": "6793d992-40db-4c91-b33c-e7ba755814a6"
        }
    ],
    "DocumentTypeId": "9e55170b-2cc1-4095-91dc-6e51ae30f195",
    "DocumentTypeDescription": "Delivery Document"
}

Get the detail of a document by number and year

URL : /api/v1/xdocument?{Number}&year{Year}

Method : GET

Auth required : Key-Value pairs on Header

Example : https://demo.calybra.com/api/v1/xdocument/?number=1&year=2023

Success Response

Code : 200 OK

Content examples

{
    "DocumentId": "35a12853-3f21-446c-af30-aeaa3171652e",
    "Number": 1,
    "Date": "2023-04-19T00:00:00",
    "CompanyId": "c7a1092a-f106-4439-93b7-7c370d6a05bd",
    "CompanyCode": null,
    "CompanyName": "Customer 1 ltd",
    "Notes": null,
    "InternalNotes": null,
    "Rows": [
        {
            "RowNumber": 1,
            "ItemCode": "P104",
            "ItemSupplierCode": null,
            "Description": "Prodotto finito neutro",
            "Quantity": 1.235,
            "MeasureUnitId": "kg",
            "Batch": "L230951142",
            "BatchDueDate": "2023-04-15T00:00:00",
            "Price": 2.20000,
            "Discount": 0.000,
            "VatPercentage": 22.000,
            "Notes": "",
            "Ingredient": null,
            "ProductId": "247dc67c-7094-42bd-ab95-87d7cafc2d32",
            "ItemId": "5ab332c0-ffca-41ab-9698-eb420a57b57a"
        },
        {
            "RowNumber": 2,
            "ItemCode": "P101",
            "ItemSupplierCode": null,
            "Description": "CUSTOM01",
            "Quantity": 1.000,
            "MeasureUnitId": "n",
            "Batch": "L230951143",
            "BatchDueDate": "2023-04-10T00:00:00",
            "Price": 0.00000,
            "Discount": 0.000,
            "VatPercentage": 22.000,
            "Notes": "",
            "Ingredient": null,
            "ProductId": "247dc67c-7094-42bd-ab95-87d7cafc2d32",
            "ItemId": "6793d992-40db-4c91-b33c-e7ba755814a6"
        }
    ],
    "DocumentTypeId": "9e55170b-2cc1-4095-91dc-6e51ae30f195",
    "DocumentTypeDescription": "Delivery Document"
}