Get an invoice
Answers one invoice with its lines, the credits applied to it, its payments and its credit notes.
Path parameters
The invoice's id. Digits only. At least 1.
Query parameters
The billing account to read, by its id (see GET /corestack/billing/account). Left out, the request acts on your company's default billing account. An account that does not exist and one that is not your company's answer the same 404. At least 1.
The same as account, under the name the MCP tools use. Send one of the two: when they name different accounts the request is refused 422 invalid on account_id. At least 1.
Returns
200 The invoice.
Fields of the 200 answer
Fields
Fields
At least 1.
At least 1.
Fields
Fields of each item
Fields
What the credit note is for, such as applied_credit or refund.
The credit note's number, as GET / takes it.
The credit note's PDF for a browser that is signed in to the Control Panel, as a path; null until the PDF exists. With a token, download it from GET /.
The VAT on the credits applied.
Fields
The credits applied to the invoice.
Fields of each item
Fields
Fields
At least 1.
Fields
Format: date-time.
At least 1.
Format: date-time.
The invoice's lines. In a list they are filled only with with=lines.
Fields of each item
Fields
At least 1.
The quantity, a number as text.
The price of one unit, with six decimal places.
Fields
When the next automatic collection is booked, for an invoice that is open or unpaid. null when none is. Format: date-time.
Format: date-time.
Fields of each item
One attempt to collect an invoice.
Fields
With action_required, where the cardholder confirms the payment.
Fields
At least 1.
How the payment was made. bank_transfer is a transfer Corefinity recorded.
What was refunded of it, or null.
Format: date-time.
Format: date-time.
Format: date-time.
pendingaction_requiredcollectingsucceededfailedcancelledrefundedpartially_refundedreversedFields
Whether the invoice's PDF can be downloaded.
opencollectingpaidunpaidvoidrefundedwritten_offThe status as the Control Panel writes it.
Fields
Fields
Fields
standardreverse_chargezerooutside_scopeThe basis in a sentence, when VAT is not charged at the standard rate.
Fields
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | billing_forbidden | Billing is for the organisation's owner and billing contacts. Ask one of them to do this. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/billing/invoices/1 \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/billing/invoices/1');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/billing/invoices/1', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/corestack/billing/invoices/1",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"account": {
"company": {
"id": 1180,
"name": "Northwind Digital"
},
"id": 3107
},
"amount_due": {
"amount": "660.00",
"currency": "GBP"
},
"credit_notes": [
{
"amount": {
"amount": "50.00",
"currency": "GBP"
},
"kind": "applied_credit",
"number": "CN-CF-100042",
"pdf_href": "/billing/invoices/8123/credit-notes/CN-CF-100042/pdf"
}
],
"credit_tax_amount": {
"amount": "10.00",
"currency": "GBP"
},
"credits": [
{
"amount": {
"amount": "50.00",
"currency": "GBP"
},
"credit": {
"id": 310,
"public_note": "Welcome credit"
}
}
],
"credits_applied": {
"amount": "50.00",
"currency": "GBP"
},
"currency": "GBP",
"due_at": "2026-12-01T00:30:00Z",
"id": 8123,
"issued_at": "2026-12-01T00:30:00Z",
"lines": [
{
"amount": {
"amount": "600.00",
"currency": "GBP"
},
"contract_line": {
"id": 9001,
"kind": "package",
"label": "CC8 · Northwind UK 1"
},
"description": "CC8 · Northwind UK 1",
"id": 61020,
"period": {
"end": "2026-12-01T00:00:00Z",
"start": "2026-11-01T00:00:00Z"
},
"quantity": "720",
"unit": "hour",
"unit_price": {
"amount": "0.833333",
"currency": "GBP"
}
}
],
"next_collection_at": null,
"number": "CF-100042",
"paid_at": "2026-12-01T00:31:12Z",
"payment_terms_days": 0,
"payments": [
{
"attempt": {
"amount": {
"amount": "660.00",
"currency": "GBP"
},
"attempt_no": 1,
"failure": null,
"id": 7731,
"mandate": null,
"method": {
"added_at": "2026-11-01T09:05:00Z",
"brand": "visa",
"exp_month": 12,
"exp_year": 2030,
"id": 4410,
"kind": "card",
"label": null,
"last4": "4242",
"provider": "stripe",
"role": "primary",
"state": "active",
"wallet": null
},
"provider": "stripe",
"refunded": null,
"scheduled_for": null,
"settled_at": "2026-12-01T00:31:12Z",
"started_at": "2026-12-01T00:31:00Z",
"state": "succeeded"
}
}
],
"pdf": {
"available": true
},
"period": {
"end": "2026-12-01T00:00:00Z",
"start": "2026-11-01T00:00:00Z"
},
"status": "paid",
"status_label": "Paid",
"subtotal": {
"amount": "600.00",
"currency": "GBP"
},
"tax": {
"amount": {
"amount": "120.00",
"currency": "GBP"
},
"kind": "standard",
"note": null,
"rate_percent": 20
},
"total": {
"amount": "720.00",
"currency": "GBP"
}
}{
"message": "Unauthenticated."
}{
"code": "billing_forbidden",
"message": "Billing is available to your company's owner and billing contacts.",
"reason": "billing_forbidden"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "invalid",
"errors": {
"account_id": [
"Send account or account_id, not both: they name different billing accounts."
]
},
"field": "account_id",
"message": "Send account or account_id, not both: they name different billing accounts.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}