# Get the QuickBooks customer linked to a customer

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}
```

- API version: v1
- Operation ID: `v1_public_customer_external_id_get`
- Section: Customers › [Customers](https://developer.yoprint.com/reference/customers.md)
- Web page: https://developer.yoprint.com/reference/customers/v1-customer-external-id-get/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Reads the QuickBooks Online customer linked to this YoPrint customer, for the QuickBooks connection `{id}`. Returns `id` and `name` (its QuickBooks Id and DisplayName), `override` (the override lock), `attached_by_user` and `customer_id`, or an empty `data` when nothing is linked.

This calls QuickBooks Online each time. `{id}` is the QuickBooks connection's id from List integrations.

## Permission

Any member of the team.

## Business rules

- Customers synced from Shopify can't be linked to QuickBooks (422 "Shopify customers cannot be mapped to QuickBooks.").

## Side effects

- Calls the QuickBooks Online API with the team's connection.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The customer's id (`id` from List customers or Create a customer). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `EDhVUaC6jbLbed`.
- `id` (string, required): The QuickBooks Online connection's id (`id` from List integrations), not the QuickBooks record's Id. A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `uAu3dAKIaHyAYk`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/customer/EDhVUaC6jbLbed/external_id/uAu3dAKIaHyAYk' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (object | array, required): The linked QuickBooks record, or an empty list `[]` when nothing is linked.
  - `attached_by_user` (boolean, optional): True when someone linked it by hand.
  - `customer_id` (string, optional)
  - `id` (string, optional): The QuickBooks Id.
  - `name` (string | null, optional): Its DisplayName in QuickBooks.
  - `override` (boolean | integer | string, optional): The override lock: true means YoPrint never overwrites it. Returned exactly as `override_lock` was sent when linking (a JSON boolean when you sent one), and false when it was never set.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "attached_by_user": true,
    "customer_id": "V4keXwwxMQyXw7",
    "id": "58",
    "name": "Northwind Apparel",
    "override": false
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `{id}` is not a QuickBooks Online connection of the team (`error.code` `external_integration_not_found`, `error.message` null). Fix: Use the id of the QuickBooks connection from List integrations.
  - When: The customer is synced from Shopify (`validation_error`, "Shopify customers cannot be mapped to QuickBooks."). Fix: None: Shopify customers are not linked to QuickBooks.
  - When: The QuickBooks Online connection can't be used: it is waiting to be reconnected (`error.code` `auth_error`), or its sign-in expired, QuickBooks refused it or QuickBooks could not be reached (`bootstrap_error`, with the reason in `error.message`). Fix: Reconnect QuickBooks Online under Apps, or retry later.

## Notes

- Deleted customers can be read too.
- A link whose QuickBooks customer no longer exists also answers an empty `data`.

## Related

- [Link a customer to a QuickBooks customer](https://developer.yoprint.com/reference/customers/v1-customer-external-id-update.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}`
- [Unlink a customer from QuickBooks](https://developer.yoprint.com/reference/customers/v1-customer-external-id-delete.md): `DELETE /v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}`
- [List integrations](https://developer.yoprint.com/reference/integrations/v1-external-integration-index.md): `GET /v1/api/store/{team_slug}/setting/external_integration`