Returns the internal Clear Books ID of a contact from an external ID.
Field | Type | Description | |
---|---|---|---|
externalId | string | The external ID of the contact. | required |
Field | Type | Description | |
---|---|---|---|
return | integer | The internal Clear Books ID of the contact. | optional |
<?xml version="1.0" encoding="UTF-8"?> <Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"> <Header> <authenticate xmlns="https://secure.clearbooks.co.uk/api/accounting/soap/"> <apiKey xmlns="">yourApiKey</apiKey> </authenticate> </Header> <Body> <getEntityIdFromExternalId xmlns="https://secure.clearbooks.co.uk/api/accounting/soap/"> <externalId>ABCD1234</externalId> </getEntityIdFromExternalId> </Body> </Envelope> |
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://secure.clearbooks.co.uk/api/accounting/soap/"> <SOAP-ENV:Body> <ns1:getEntityIdFromExternalIdResponse> <return>20</return> </ns1:getEntityIdFromExternalIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Clear Books is proudly registered with the Financial Conduct Authority as an Account Information Services Provider (register no. 843585).