GET collaboration/contacts/{contactId}/object-references/customer-references

Returns a list of customers that is connected/related to/referencing the specified contact. You will only receive customers from current system database. Use $db to receive customers from other databases.

Note: Log in to check if your API client have access to run this resource
Version: 4
Success HTTP Status Code: 200
Maximum items from list ($top): 80

Uri parameters

{contactId} Integer Contact identifier

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

CustomerId Integer Customer identifier.
Name String Name of customer (name of company or surname/familyname/lastname of a person).

See the page about filters and sorting on how to use sortable parameters

CustomerId Integer Customer identifier
Name String Name of customer (name of company or surname/familyname/lastname of a person)

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Customers>
2
     <Customer>
3
          <CustomerId
CustomerId

Customer identifier

>
{Integer}</CustomerId>
4
          <Database
Database

Company code/database the object belongs to

>
{String}</Database>
5
          <ExternalCustomerId
ExternalCustomerId

External customer reference/identifier. Can be used in external systems.

>
{String}</ExternalCustomerId>
6
          <Status
Status

Status of the customer. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete

>
{Integer}</Status>
7
          <Firstname
Firstname

Secondary name of a company or firstname of a person

>
{String}</Firstname>
8
          <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>
{String}</Name>
9
          <CustomerLink
CustomerLink

Customer reference

>
{String}</CustomerLink>
10
     </Customer>
11
</Customers>
1
{
2
     "customers": [
3
          {
4
               "customerId
CustomerId

Customer identifier

":
"{Integer}",
5
               "database
Database

Company code/database the object belongs to

":
"{String}",
6
               "externalCustomerId
ExternalCustomerId

External customer reference/identifier. Can be used in external systems.

":
"{String}",
7
               "status
Status

Status of the customer. 1:New, 2:Pending internal approvement, 4:Active, 9:Obsolete

":
"{Integer}",
8
               "firstname
Firstname

Secondary name of a company or firstname of a person

":
"{String}",
9
               "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

":
"{String}",
10
               "customerLink
CustomerLink

Customer reference

":
"{String}"
11
          }
12
     ]
13
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100053 HTTP 403 You have only admittance to your own suppliers