Download invoices as one PDF

POST/v1/api/store/{team_slug}/invoice/export_pdf

v1Operation ID v1_public_invoice_export_pdf

Returns one PDF with up to 100 invoices, made while you wait (<date and time> - invoices.pdf, shown inline). Nothing is stored. Ids that aren't your team's invoices are skipped without an error.

Permission

Any member of the team.

Business rules

• 1 to 100 invoices per call: "The invoice may not have more than 100 items."

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• invoicearray of objectsrequired
  • 1 to 100 items
  Fields of each item (1)

  • idstringrequired

    An invoice hash id.

Response

200Binary download response.

The answer is a file (application/pdf), not JSON. The example saves it with curl -o.

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

  invoice is missing, empty or has more than 100 entries.

  Fix

  Send 1 to 100 { "id": ... } objects under invoice.

Notes

• If none of the ids is yours you may get an empty PDF rather than an error: check your ids first.

Related

• POSTFilter invoices/v2/api/store/{team_slug}/v2/invoice/filter
• GETGet an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/invoice/export_pdf' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "invoice": [      {        "id": "cBRpSf5nw6upt5"      },      {        "id": "gtnwEWU4Npp9eC"      }    ]  }' \  -o document.pdf

Example response 200

A application/pdf file.