Customers

Retrieve customers from the Basecone office where you're user has rights to.

GET customers?companyid=:companyId&externalId=:id

Request properties

Property Type Description Optional
externalId String External customers unique Identifier. Yes
companyId Guid Company unique Identifier. No

Customers collection properties

Property Type Description
customersId Guid Unique identifier of customers
code string Code of customers
name string Name of customers
externalId string External identifier from accounting system

For details on customers properties see customer details.

For details on collections see collection details.

Example response:

{
    "customers" : [{
        "customersId" : "cec49cc1-e451-4388-877a-3cb1dddc46f9"
        "code" : "2025",
        "name" : "2jours",
        "externalId" : "2025",
        "_links" : [{
            "rel" : "self",
            "href" : "https://api.basecone.com/v1/customers/2025"
            }],
        }, {
        "customersId" : "930f5739-00dd-4160-b829-1c9c58806c51",
        "code" : "2033",
        "name" : "ASdasdfasdf",
        "externalId" : "2033",
        "_links" : [{
            "rel" : "self",
            "href" : "https://api.basecone.com/v1/customers/2033"
        }]
    }],
    "_links" : [{
        "rel" : "self",
        "href" : "https://api.basecone.com/v1/customers?limit=20&offset=0"
    }],
    "_metadata" : {
        "total" : 2,
        "count" : 2
    }
}