Get the QuickBooks vendor linked to a vendor

GET/v1/api/store/{team_slug}/vendor/{hash_id}/external_id/{id}

v1Operation ID v1_public_vendor_external_id_get

Reads the QuickBooks Online vendor linked to this vendor for the QuickBooks connection {id}: its QuickBooks id and name, override (the override lock), attached_by_user and vendor_id, or an empty data when nothing is linked. Calls QuickBooks Online each time.

Permission

Any member of the team.

Side effects

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

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The vendor's id (id from List vendors). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example EDhVUaC6jbLbed
• idstringrequired

  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.

Response

200Successful response.

• dataobject | arrayrequired

  The linked QuickBooks record, or an empty list [] when nothing is linked.

  Child fields (5)

  • attached_by_userboolean

    True when someone linked it by hand.

  • idstring

    The QuickBooks Id.

  • namestring | null

    Its DisplayName in QuickBooks.

  • overrideboolean | integer | string

    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.

  • vendor_idstring
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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.

• 422The 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 (error.code external_integration_not_found, error.message null).

  Fix

  Use the QuickBooks connection id from List integrations.

  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 vendors can be read too. A link whose QuickBooks vendor no longer exists also answers an empty data.

Related

• PUTLink a vendor to a QuickBooks vendor/v1/api/store/{team_slug}/vendor/{hash_id}/external_id/{id}
• GETList integrations/v1/api/store/{team_slug}/setting/external_integration

Example request

curl

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

Example response 200

Response

{
  "data": {
    "attached_by_user": true,
    "id": "42",
    "name": "Example Blanks Co",
    "override": false,
    "vendor_id": "MFwvMEIK7ud89l"
  },
  "status": 200,
  "success": true
}