Document

Retrieve a document from Basecone by it's unique identifier.

GET documents/:id

Company properties

Property Type Description Optional
DocumentId Guid Unique identifier of the document. No
Name String The name of the document. No
TransactionProposalId Guid Unique identifier of the transaction proposal if available. No
TransactionId Guid Unique identifier of the transaction if available. No
Source string Import source of the document, possible values are WebPortal,WebService,MailImporter. No
SourceMetadata complex Additional specific details concerning the source of the document. Yes
Type string The type of a document, possible values are Unstructured,Structured,Storage. Yes
CreatedOn datetime Created date. Yes
ModifiedOn datetime Last modified date. Yes
Tag complex Details on the tag information of this document, if any. Yes
User complex Reference to the user who imported this document. Yes
Company complex Reference to the company this document belongs to. Yes
Lock complex Details on the lock of this document, if any. Yes
LookupIdentifier complex Document link to expose this document, if any. Premium APP users can see this link as soon as the document has been authorized for booking. Yes

Example response:

{
    "documentId": "20124957-a908-4552-8f4f-9e849199d1df",
    "name": "2Jours",
    "source": "WebService"
}

TagDetails properties

Property Type Description
Code string The tag code, possible values are CASH, JNL,PNV,SLS,BNK,CUST.
CodeValue string The tag code translated for the company language.
CustomTags complex A list of custom tags, only possible if tag code is CUST.

CustomTag properties

Property Type Description
CustomTagId Guid Unique identifier of the custom tag.
Label string The label if this custom tag.
    {
        "customTagId": "3e00a63f-d793-4237-92c0-cd2dde243a12",
        "label": "My own tag",
        "_links": [
            {
                "rel": "self",
                "href": "http://api.basecone.com/customtags/3e00a63f-d793-4237-92c0-cd2dde243a12"
            }
        ]
    }

DocumentLock properties

Property Type Description
LockDate Datetime The date this document was locked.
LockUser complex The reference to the user who has this document locked.

UserReference properties

Property Type Description
UserId Guid Unique identifier of the user.
    {
        "userId": "3e00a63f-d793-4237-92c0-cd2dde243a12",
        "_links": [
            {
                "rel": "self",
                "href": "http://api.basecone.com/users/3e00a63f-d793-4237-92c0-cd2dde243a12"
            }
        ]
    }

CompanyReference properties

Property Type Description
CompanyId Guid Unique identifier of the company.
CompanyCode string The code of this company.
{
    {
        "companyId": "fb8f9584-3fc6-4cc7-abda-530ff397ea82",
        "companyCode": "1028",
        "_links": [
            {
                "rel": "self",
                "href": "http://api.basecone.com/companies/fb8f9584-3fc6-4cc7-abda-530ff397ea82"
            }
        ]
    },
}

LookupIdentifier properties

Property Type Description
Identifier string Unique identifier of the lookup link.
Link string Link to the document referenced by this identifier.
    {
        "lookupIdentifier":{
            "identifier": "AAA1CQ==299E6856244F48BD884389E48F285B20",
            "link": "https://secure.basecone.com/lookup?GUID=AAA1CQ==299E6856244F48BD884389E48F285B20"
        }
    }