Turn QuickBooks sync on or off for purchase orders

PUT/v1/api/store/{team_slug}/purchase_order/bulk_action/mark_quickbook/{on_or_off}

v1Operation ID v1_public_purchase_order_bulk_action_mark_quickbook

Sets whether up to 50 purchase orders sync to QuickBooks Online. End the path with on to let them sync, or off (any other word) to stop them syncing. The body is a JSON array of {id}.

Ids that are not purchase orders of the team are skipped. Answers success: true with data: null.

Permission

Any member of the team.

Business rules

• At most 50 ids per request (422 limit_reached).

Side effects

• Changes only the sync flag. Nothing is sent to QuickBooks by this call; the next sync follows the flag.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• on_or_offstringrequired

  on lets the purchase orders sync to QuickBooks Online; off stops them. Any word other than on counts as off.

  • One of: "on", "off"
  • Example on

Request body

application/json, required.

The body is an array of objects.

• idstringrequired

  A purchase order id.

Response

200Successful response.

• datanullrequired
• 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

  More than 50 ids (error.code limit_reached). Nothing is changed.

  Fix

  Send at most 50 per call.

  When

  An item has no id, or an id doesn't decode. error.code is validation_failed.

  Fix

  Send [{"id": "..."}].

Related

• POSTExport purchase orders by issue date/v1/api/store/{team_slug}/purchase_order/export

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/purchase_order/bulk_action/mark_quickbook/on' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '[    {      "id": "12vR7n9WUYn1CJ"    },    {      "id": "YJqSDANMFIj4p4"    }  ]'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}