Skip to content

Get an invoice

GET
/invoices/{invoice}
curl --request GET \
--url https://api.connectato.com/v1/invoices/example \
--header 'Authorization: Bearer <token>'

Scope: read_invoices.

invoice
required
string
/^inv_[0-9a-z]{26}$/

The public id (inv_...).

InvoiceResource

Media typeapplication/json
InvoiceResource
object
id
required

The invoice’s public id (inv_...).

string
/^inv_[0-9a-z]{26}$/
order_id
required

The order it was issued for (ord_...); null once that order is deleted.

string | null
/^ord_[0-9a-z]{26}$/
kind
required

invoice, or storno: the credit note reversing an invoice in full (negative totals and quantities). New values may appear: treat one you do not know as such.

string
reversed_invoice_id
required

For a storno, the invoice it reverses (inv_...); null for an invoice.

string | null
/^inv_[0-9a-z]{26}$/
status
required

pending (asked, waiting its turn), submitting (the invoicing software is being asked now), failed (refused or never sent, see error_code; may be asked again), needs_attention (outcome unknown: a document may exist at the vendor, a person checks it in the app), issued (numbered, final), cancelled (issued, then cancelled at the vendor), reversed (issued, then reversed by an issued storno), discarded (no document came of it). New values may appear: treat one you do not know as such.

string
error_code
required

Why it is failed or needs_attention, a stable code: order_refused, account_unavailable, not_supported, credentials_rejected, rate_limited, invalid_data, vendor_rejected, not_sent, outcome_unknown, document_unread. Null in any other status. New codes may appear. New values may appear: treat one you do not know as such.

string | null
error_message
required

The code’s meaning, in English; the app shows the merchant the full reason in their language.

string | null
vendor_message
required

The invoicing software’s own words when it answered, as it sent them, in its language: for display only, never to parse.

string | null
series
required

The series as the invoicing software numbered it (e.g. FCT); null until issued.

string | null
number
required

The number inside the series, a string with its leading zeros (e.g. 0042); null until issued.

string | null
issue_date
required

The document’s date, a plain day in the organization’s calendar; until issued, the day it was asked for.

string format: date
due_date
required

The payment due day; null for a storno or without one.

string | null format: date
integration_id
required

The invoicing account it goes through (int_...); null once that integration is removed.

string | null
/^int_[0-9a-z]{26}$/
currency
required

ISO 4217.

string
prices_include_tax
required

Whether the lines’ unit prices include tax.

boolean
totals
required

Net (without tax) + tax = total; negative on a storno.

object
net
required
object
amount
required
string
currency
required
string
tax
required
object
amount
required
string
currency
required
string
total
required
object
amount
required
string
currency
required
string
buyer
required

The buyer as invoiced, in the v1 address shape (first_name and last_name null: an invoice names the buyer whole; company = the name for a company buyer), plus its fiscal code and trade register number. The seller is the organization itself and is not copied on the invoice.

object
name
required
string | null
first_name
required
string | null
last_name
required
string | null
company
required
string | null
email
required
string | null
phone
required
string | null
address_line_1
required
string | null
address_line_2
required
string | null
city
required
string | null
region
required
string | null
region_code
required
string | null
postal_code
required
string | null
country_code
required
string | null
locality_code
required
string | null
tax_id
required
string | null
registration_number
required
string | null
lines
required

The lines by position, at most 250 (MAX_LINES); lines_count is the full count.

Array<object>
object
kind
required

New values may appear: treat one you do not know as such.

string
code
required

The product code (the store’s SKU); null without one.

string | null
name
required
string
quantity
required

A decimal string, trailing zeros trimmed (2, 1.5); negative on a storno.

string
unit
required
string
unit_price
required

With tax when the invoice’s prices_include_tax.

object
amount
required
string
currency
required
string
tax_rate
required

A percentage as a decimal string (21.0000 = 21%).

string
net
required

After discounts: net + tax = total.

object
amount
required
string
currency
required
string
tax
required
object
amount
required
string
currency
required
string
total
required
object
amount
required
string
currency
required
string
lines_count
required

How many lines the invoice has.

integer
created_at
required
string format: date-time
updated_at
required
string format: date-time

Example generated

{
"id": "example",
"order_id": "example",
"kind": "example",
"reversed_invoice_id": "example",
"status": "example",
"error_code": "example",
"error_message": "example",
"vendor_message": "example",
"series": "example",
"number": "example",
"issue_date": "2026-04-15",
"due_date": "2026-04-15",
"integration_id": "example",
"currency": "example",
"prices_include_tax": true,
"totals": {
"net": {
"amount": "example",
"currency": "example"
},
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
},
"buyer": {
"name": "example",
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"locality_code": "example",
"tax_id": "example",
"registration_number": "example"
},
"lines": [
{
"kind": "example",
"code": "example",
"name": "example",
"quantity": "example",
"unit": "example",
"unit_price": {
"amount": "example",
"currency": "example"
},
"tax_rate": "example",
"net": {
"amount": "example",
"currency": "example"
},
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"lines_count": 1,
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

No valid access token.

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

WWW-Authenticate
string

Bearer: send an access token as a Bearer token.

The app was not granted the scope (insufficient_scope).

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

No such resource in the organization (not_found).

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Too many requests: retry after Retry-After seconds.

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Retry-After
integer

Seconds to wait before retrying.