Vision Developers
GET/apps/accounting/v1/credit-notes/{reference}/pdf

getCreditNotePdf

The credit note as a PDF — the same document Send to Customer attaches.

App
Accounting
Contract
Accounting API 0.32.0
Lifecycle
preview
Runtime
not-public
Operation ID
getCreditNotePdf
Canonical origin
https://accounting.runonvision.com

Availability: This is a preview contract with runtime status not-public. Publication documents an approved interface; it does not imply public production access.

Purpose and use cases

GET /apps/accounting/v1/credit-notes/{reference}/pdf

The owning App is Vision Accounting. Accounting owns financial records, exact arithmetic, approvals, audit evidence, workspace grants, and ledger invariants.

Request

GET https://accounting.runonvision.com/apps/accounting/v1/credit-notes/{reference}/pdf

Authentication and authorization

Send a Vision-issued bearer token for the exact App audience. The token must include the accounting entitlement and satisfy the aws-… accounting workspace required binding.

  • Required scope: accounting:payments:read

Human roles are not declared in OpenAPI. Record-level and business permission checks remain the owning App's authority.

Headers

  • Authorization: Bearer <access-token> — required.
  • Accept: application/json — recommended where a JSON response is declared.

Undeclared tracing, idempotency, conditional-request, and version headers are not assumed on this page.

Path and query parameters

NameLocationTypeRulesDescription
referencepathstringrequired; pattern ^ACN-[A-Z0-9]{12}$Not described in the contract.

Request body

This operation declares no request body.

Runnable examples

Placeholder values are generated from the approved schema and are not live credentials or customer data. Replace every angle-bracket or shell variable value. Examples cannot be run until the App has a routed base URL and your client has the required grant.

cURL
curl 'https://accounting.runonvision.com/apps/accounting/v1/credit-notes/${REFERENCE}/pdf' \
  --request GET \
  --header 'authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'accept: application/json'
JavaScript (server-side)
const response = await fetch('https://accounting.runonvision.com/apps/accounting/v1/credit-notes/${REFERENCE}/pdf', {
  method: 'GET',
  headers: {
    authorization: `Bearer ${ACCESS_TOKEN}`,
    accept: 'application/json',
  },
}

if (!response.ok) throw new Error(`Vision API ${response.status}`)
const result = await response.json()
Python 3 standard library
import json
import urllib.parse
import urllib.request

request = urllib.request.Request(
    'https://accounting.runonvision.com/apps/accounting/v1/credit-notes/${REFERENCE}/pdf',
    data=None,
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer <ACCESS_TOKEN>"
},
    method='GET',
)
with urllib.request.urlopen(request, timeout=30) as response:
    result = json.load(response)

The current TypeScript reference client covers Platform token exchange and core reads. No native SDK helper is declared for this operation; use the HTTP contract directly and follow the SDK guidance.

Responses

StatusMeaningSchema
200PDFstring · binary
401Safe Accounting errorobject
403Safe Accounting errorobject
404Safe Accounting errorobject
503Safe Accounting errorobject

Success response schema

string · binary
200 illustrative response
"<response>"

Errors and troubleshooting

Error bodies and codes are shown only where the approved contract declares them. Use status, the declared error schema, and any correlation identifier returned by the App; do not infer that two Apps share one envelope.

  • 401 — Safe Accounting error
  • 403 — Safe Accounting error
  • 404 — Safe Accounting error
  • 503 — Safe Accounting error

Collection behavior

Pagination: not declared. Filtering/search: not declared. Sorting: not declared.

Cursor lifetime, cursor binding, stable ordering, maximum traversal, and unknown-filter behavior are not assumed unless stated by a parameter description or schema constraint above.

Operational behavior

  • Rate limit: No operation-specific limit or 429 response is declared.
  • Retry: Retry only when the documented error model or response headers authorize it. Timeout and backoff values are not declared by this operation.
  • Idempotency: No idempotency header or replay window is declared.
  • Concurrency: No ETag, If-Match, or optimistic-version header is declared.

Security and privacy

  • Keep client credentials and bearer tokens on trusted servers.
  • Send only to the exact approved HTTPS origin and audience.
  • Treat response data according to the owning App's classification and retention policy; the OpenAPI contract does not itself grant data access.
  • Do not log credentials, tokens, complete private payloads, or secrets.

Edge cases and known documentation gaps

  • One or more parameters have no field-level description.
  • Business roles, timeout, retry budget, rate value, idempotency window, and concurrency behavior are absent unless explicitly stated above.

Contract history and evidence