Skip to main content
Get an invoice

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as supplier.id. id is always returned. Fields: id, url, invoice_number, title, category, issued_date, due_date, created_at, updated_at, deleted_at, supplier, recipient, amounts, review, workflows, alerts, relationships, note, payment, delivery, references, additional_properties, origin.

Response

The invoice, with counts of related resources.

id
string<uuid>
required
url
string<uri>
required

The invoice in the Watchdog app.

invoice_number
string | null
required
title
string | null
required
category
enum<string>
required
Available options:
invoice,
credit_note,
self_billed_invoice
issued_date
string<date> | null
required
due_date
string<date> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
deleted_at
string<date-time> | null
required
supplier
object
required
recipient
object
required
amounts
object
required
review
object
required
read-only
workflows
object
required

Processing that follows import, such as matching and compliance checks. Poll until settled, then read alerts.

alerts
object
required
relationships
object
required
note
string | null
required

The invoice-wide note in its original wording. Null means unavailable; empty text stays empty.

payment
object
required
delivery
object
required
references
object
required
additional_properties
object[] | null
required

Other named details found in the source, with where they were found. Null when not available; empty when none were found.

origin
object
required