GetCustomersByFieldsPaged

CRM service 1.4: Finds customers by VAT number, else by phone number, else by company name, and returns them a page at a time.


Service	CRM 1.4
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/CRM/V1_4/CRMServiceSecure.svc`
SOAPAction	`http://api.timelog.com/services/crm/1_4/ICRMService/GetCustomersByFieldsPaged`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Permissions	The customer privileges are not consulted.
Changes data	No
Safe to retry	Yes
Paging	Yes, up to 500 per page

How it works

A cascading match intended for 'does this company already exist?' checks. All three inputs are normalised by removing spaces and the characters - +.: before comparison. 1. cvr: customers whose VAT number matches cvr. If NO customer has exactly that VAT number: customers whose phone matches phone. If there is no exact VAT match and no phone match at all: customers whose name equals name or STARTS WITH it. The steps are OR'ed in one query, so a result can mix step 1 and step 2 hits. Each customer comes with its active contacts.

Parameters

Each parameter has one label: Required, Conditional (required depending on other values) or Optional. Send them in the order shown.

cvrstring

Conditional. VAT / CVR number. Empty or whitespace = not used. LIKE pattern after normalisation: without wildcards it is an exact match on the stored text.

namestring

Conditional. Company name; used only when step 1 and 2 find nothing exact.

phonestring

Conditional. Phone number; used only when no customer has exactly the cvr. Empty or whitespace = not used.

loadCustomFieldsboolean

Optional. Default false. Ignored - custom fields are never loaded.

loadExternalKeysboolean

Optional. Default false. Ignored - external keys are never loaded.

pageinteger

Required

1-based page number. Values <= 0 behave like 1.

pageSizeinteger

Required

Customers per page; values above 500 are lowered to 500. Must be > 0.

tokenSecurityToken

Required

The token from GetToken: Initials, Expires and Hash, sent back unchanged.

Request

POST /{account}/WebServices/CRM/V1_4/CRMServiceSecure.svc HTTP/1.1
Host: app{server-number}.timelog.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://api.timelog.com/services/crm/1_4/ICRMService/GetCustomersByFieldsPaged"

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:crm="http://api.timelog.com/services/crm/1_4"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <crm:GetCustomersByFieldsPaged>
      <crm:cvr>{cvr}</crm:cvr>
      <crm:name>{name}</crm:name>
      <crm:phone>{phone}</crm:phone>
      <crm:loadCustomFields>false</crm:loadCustomFields>
      <crm:loadExternalKeys>false</crm:loadExternalKeys>
      <crm:page>1</crm:page>
      <crm:pageSize>100</crm:pageSize>
      <crm:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </crm:token>
    </crm:GetCustomersByFieldsPaged>
  </soapenv:Body>
</soapenv:Envelope>

curl -X POST "https://app{server-number}.timelog.com/{account}/WebServices/CRM/V1_4/CRMServiceSecure.svc" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H 'SOAPAction: "http://api.timelog.com/services/crm/1_4/ICRMService/GetCustomersByFieldsPaged"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/CRM/V1_4/CRMServiceSecure.svc"
SOAP_ACTION = '"http://api.timelog.com/services/crm/1_4/ICRMService/GetCustomersByFieldsPaged"'

envelope = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:crm="http://api.timelog.com/services/crm/1_4"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <crm:GetCustomersByFieldsPaged>
      <crm:cvr>{cvr}</crm:cvr>
      <crm:name>{name}</crm:name>
      <crm:phone>{phone}</crm:phone>
      <crm:loadCustomFields>false</crm:loadCustomFields>
      <crm:loadExternalKeys>false</crm:loadExternalKeys>
      <crm:page>1</crm:page>
      <crm:pageSize>100</crm:pageSize>
      <crm:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </crm:token>
    </crm:GetCustomersByFieldsPaged>
  </soapenv:Body>
</soapenv:Envelope>"""

response = requests.post(
    URL,
    data=envelope.encode("utf-8"),
    headers={"Content-Type": "text/xml; charset=utf-8", "SOAPAction": SOAP_ACTION},
    timeout=60,
)
result = parse_result(response)  # see "Responses and errors"

Replace every {…} placeholder with your own value.

Response

The call returns the standard response envelope. Check ResponseState first: a failed call still returns HTTP 200.

ResponseStatestring

Required

Success, Invalid or Error.

ErrorCodeinteger

0 on success, otherwise the error code. See Errors.

TotalPageCountinteger

Number of pages for the whole result with your pageSize. Keep calling with page + 1 until you have read them all.

ReturnCustomer[]

ResponseState Success with an empty Return and TotalPageCount 0.

Example response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetCustomersByFieldsPagedResponse xmlns="http://api.timelog.com/services/crm/1_4">
      <GetCustomersByFieldsPagedResult xmlns:a="http://api.timelog.com"
                                       xmlns:b="http://api.timelog.com/services/crm/1_4"
                                       xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:Customer>
            <a:Action>Original</a:Action>
            <a:IsCustomFieldsLoaded>false</a:IsCustomFieldsLoaded>
            <a:CustomFields i:nil="true"/>
            <a:IsExternalKeysLoaded>false</a:IsExternalKeysLoaded>
            <a:ExternalKeys i:nil="true"/>
            <b:ID>1001</b:ID>
            <b:GUID>3f2504e0-4f89-41d3-9a0c-305000000001</b:GUID>
            <b:Name>Example </b:Name>
            <b:No>1001</b:No>
            <b:TimeStamp>AAAAAAAAAAA=</b:TimeStamp>
            <b:VAT>0</b:VAT>
            <b:CalculateVAT>false</b:CalculateVAT>
            <b:DefaultDiscountPercent>0</b:DefaultDiscountPercent>
            <b:Address>
              <a:Address1>Example</a:Address1>
              <a:Address2>Example</a:Address2>
              <a:Address3>Example</a:Address3>
              <a:ZipCode>1000</a:ZipCode>
              <a:City>Copenhagen</a:City>
              <a:State>Example</a:State>
              <a:Country>DK</a:Country>
            </b:Address>
            <b:Fax>+45 00 00 00 00</b:Fax>
            <b:WebSite>https://www.example.com</b:WebSite>
            <b:Phone>+45 00 00 00 00</b:Phone>
            <b:Email>info@example.com</b:Email>
            <b:KAM>Example</b:KAM>
            <b:EAN>Example</b:EAN>
            <b:IsOIOCustomer>false</b:IsOIOCustomer>
            <b:CreditorID>Example</b:CreditorID>
            <b:AccountNo>1001</b:AccountNo>
            <b:Contacts>
              <b:ContactHeader>
                <b:GUID>3f2504e0-4f89-41d3-9a0c-305000000002</b:GUID>
                <b:FirstName>Example first</b:FirstName>
                <b:LastName>Example last</b:LastName>
              </b:ContactHeader>
            </b:Contacts>
            <b:Industry>Example</b:Industry>
            <b:Status>Example</b:Status>
            <b:VATNo>1001</b:VATNo>
            <b:Currency>DKK</b:Currency>
            <b:PaymentTermId>1001</b:PaymentTermId>
            <b:InvoicingAddress>
              <a:Address1>Example</a:Address1>
              <a:Address2>Example</a:Address2>
              <a:Address3>Example</a:Address3>
              <a:ZipCode>1000</a:ZipCode>
              <a:City>Copenhagen</a:City>
              <a:State>Example</a:State>
              <a:Country>DK</a:Country>
            </b:InvoicingAddress>
            <b:InvoicingName>Example invoicing</b:InvoicingName>
            <b:UseInvoicingAddress>false</b:UseInvoicingAddress>
            <b:CustomerSinceDate>2026-10-01T00:00:00</b:CustomerSinceDate>
            <b:NickName>Example nick</b:NickName>
            <b:OrganizationNumber>1001</b:OrganizationNumber>
            <b:KAM2>Example</b:KAM2>
            <b:Details>
              <b:Status>
                <b:ID>1001</b:ID>
                <b:Name>Example </b:Name>
                <b:Type>IsShownInCustomers</b:Type>
              </b:Status>
              <b:Industry>
                <b:ID>1001</b:ID>
                <b:Branche>Example</b:Branche>
              </b:Industry>
              <b:Currency>
                <a:ID>1001</a:ID>
                <a:Abbreviation>DKK</a:Abbreviation>
                <a:Rate>0</a:Rate>
                <a:RateDate>2026-10-01T00:00:00</a:RateDate>
                <a:DescriptiveName>Example descriptive</a:DescriptiveName>
              </b:Currency>
              <b:KAM>
                <a:ID>1001</a:ID>
                <a:Initials>ABC</a:Initials>
                <a:FullName>Example full</a:FullName>
              </b:KAM>
              <b:KAM2>
                <a:ID>1001</a:ID>
                <a:Initials>ABC</a:Initials>
                <a:FullName>Example full</a:FullName>
              </b:KAM2>
            </b:Details>
          </b:Customer>
        </a:Return>
        <a:ReturnTypeDescription>Customer</a:ReturnTypeDescription>
        <a:Request>…</a:Request>
        <a:ResponseState>Success</a:ResponseState>
        <a:Messages>
          <a:APIMessage>
            <a:Message>Duration of call was 0,0421337 sec.</a:Message>
            <a:Severity>Message</a:Severity>
            <a:ErrorCode>0</a:ErrorCode>
          </a:APIMessage>
        </a:Messages>
        <a:ErrorCode>0</a:ErrorCode>
        <a:IsReturnPaged>true</a:IsReturnPaged>
        <a:TotalPageCount>1</a:TotalPageCount>
      </GetCustomersByFieldsPagedResult>
    </GetCustomersByFieldsPagedResponse>
  </s:Body>
</s:Envelope>

Illustrative example: built from the service description (WSDL) in the same format as a real response, with made-up values. The Request block is shortened.

Errors

All errors come back with HTTP 200: check ResponseState, ErrorCode and Messages. The errors every operation can return (expired or invalid token, API not enabled, HTTPS required, general errors) are listed once in Responses and errors.

This operation has no errors of its own beyond the shared ones.

Was this page helpful?