Archive

Retrieve all documents for a specific company, or all companies accessible for this apikey in Basecone.

GET documents/archive?companyId=:id

Request properties

Property Type Description Optional
CompanyId GUID Use this query parameter to filter documents by CompanyId. Yes
FileName String Use this query parameter to search documents by file name.
exaple: https://${rootAddress}/documents/archive?FileName=${fileName}&CompanyId=${companyId} 		Yes

Sorting

Sorting can be performed by using the sort parameter, for the date of upload. The current default value is returning the most recent uploads first.

Document collection properties

Property Type Description
Documents Array A list of documents.
_links Array A list of useful preconfigured uri's a client app can use to navigate this resource collection.
_metadata Complex object Optional object with additional information concerning the current returned result.

For details on document properties see document details.

For details on collections see collection details.

Example response:

{
    "documents":[
    {
        "documentId": "fe455a0c-9a2c-468e-8bf6-5eb92e324e05",
        "name": "Invoice_201700113",
        "documentMetadata":[],
        "currentWorkFlow": "Recognized",
        "documentImportSource": "WebPortal",
        "tagDetails":
        {
            "code": "PNV",
            "codeValue": "INK", 
            "customTags":[]
        },
        "transactionProposalId": "8c85cf20-ba57-42b8-8e00-50786931a880",
        "transactionId": null,
        "totalComments": 0,
        "createdOn": "2021-05-19T15:47:54.303",
        "companyId": "74ac2a72-79bb-480c-be72-fb07c93488cf",
        "currentAuthorizer": null,
        "isCredit": false,
        "transactionDate": null,
        "dueDate": null,
        "total": 0.0000,
        "currencyCode": "EUR",
        "project": null,
        "costCenter": "KP2",
        "_links":[
        {
            "rel": "self",
            "href": "http://localhost:54634/documents/fe455a0c-9a2c-468e-8bf6-5eb92e324e05"
        }],
        "authorizedDate": null,
        "relation": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": null,
            "code": null
        },
        "invoiceNumber": null,
        "description": null,
        "authorizers": [
        ],
        "readyToBeAuthorized": null,
        "lines": null,
        "authorizersCount": 0,
        "lineCount": 0,
        "period": null
    },
    {
        "documentId": "43b579b6-3bf0-43a5-8540-265766e540fb",
        "name": "Invoice_201700112",
        "documentMetadata":[],
        "currentWorkFlow": "Recognized",
        "documentImportSource": "WebPortal",
        "tagDetails":
        {
            "code": "SLS", 
            "codeValue": "VRK", 
            "customTags":[]
        },
        "transactionProposalId": "593b029d-3ccf-4037-b6b0-520d3629591c",
        "transactionId": null,
        "totalComments": 0,
        "createdOn": "2021-05-19T15:47:54.303",
        "companyId": "74ac2a72-79bb-480c-be72-fb07c93488cf",
        "currentAuthorizer": null,
        "isCredit": false,
        "transactionDate": null,
        "dueDate": null,
        "total": 0.0000,
        "currencyCode": "EUR",
        "project": null,
        "costCenter": null,
        "_links":[
        {
            "rel": "self", 
            "href": "http://api.basecone.com/documents/43b579b6-3bf0-43a5-8540-265766e540fb"
        }],
        "authorizedDate": "2023-05-30T05:06:45.303",
        "relation": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": null,
            "code": null
        },
        "invoiceNumber": null,
        "description": null,
        "authorizers": [
            {
                "name": "authoriser1",
                "action": "authorized",
                "type": "BeforeBooking"
            },
            {
                "name": "authoriser2",
                "action": "authorized",
                "type": "BeforeBooking"
            }
        ],
        "readyToBeAuthorized": null,
        "lines": null,
        "authorizersCount": 2,
        "lineCount": 0,
        "period": null
    }
    ],
    "_links":[
    {
        "rel": "self",
        "href": "http://api.basecone.com/documents?limit=20&offset=0"
    }],
    "_metadata":
    {
        "total": 27,
        "count": 20
    }
}