CorefinityCorefinityDocs
Open the Control PanelControl Panel
Billing · 8 of 16

Get an invoice

Answers one invoice with its lines, the credits applied to it, its payments and its credit notes.

GET/api/corestack/billing/invoices/{invoice}

Path parameters

invoiceintegerRequired

The invoice's id. Digits only. At least 1.

Query parameters

accountinteger

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.

account_idinteger

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
accountobjectRequired
Fields
companyobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
idintegerRequired

At least 1.

amount_dueobjectRequired
Fields
amountstringRequired
currencystringRequired
credit_notesarray of objectsRequired
Fields of each item
amountobjectRequired
Fields
amountstringRequired
currencystringRequired
kindstringRequired

What the credit note is for, such as applied_credit or refund.

numberstringRequired

The credit note's number, as GET /corestack/billing/invoices/{invoice}/credit-notes/{number}/pdf takes it.

pdf_hrefstring or nullRequired

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 /corestack/billing/invoices/{invoice}/credit-notes/{number}/pdf.

credit_tax_amountobjectRequired

The VAT on the credits applied.

Fields
amountstringRequired
currencystringRequired
creditsarray of objectsRequired

The credits applied to the invoice.

Fields of each item
amountobjectRequired
Fields
amountstringRequired
currencystringRequired
creditobjectRequired
Fields
idintegerRequired

At least 1.

public_notestringRequired
credits_appliedobjectRequired
Fields
amountstringRequired
currencystringRequired
currencystringRequired
due_atstring or nullRequired

Format: date-time.

idintegerRequired

At least 1.

issued_atstring or nullRequired

Format: date-time.

linesarray of objectsRequired

The invoice's lines. In a list they are filled only with with=lines.

Fields of each item
amountobjectRequired
Fields
amountstringRequired
currencystringRequired
contract_lineobject or any or nullRequired
descriptionstringRequired
idintegerRequired

At least 1.

periodobject or any or nullRequired
quantitystringRequired

The quantity, a number as text.

unitstring or nullRequired
unit_priceobjectRequired

The price of one unit, with six decimal places.

Fields
amountstringRequired
currencystringRequired
next_collection_atstring or nullRequired

When the next automatic collection is booked, for an invoice that is open or unpaid. null when none is. Format: date-time.

numberstringRequired
paid_atstring or nullRequired

Format: date-time.

payment_terms_daysintegerRequired
paymentsarray of objectsRequired
Fields of each item
attemptobjectRequired

One attempt to collect an invoice.

Fields
action_urlstring or null

With action_required, where the cardholder confirms the payment.

amountobjectRequired
Fields
amountstringRequired
currencystringRequired
attempt_nointegerRequired
failureobject or any or nullRequired
idintegerRequired

At least 1.

mandateobject or any or nullRequired
methodobject or any or nullRequired
providerstringRequired

How the payment was made. bank_transfer is a transfer Corefinity recorded.

refundedobject or any or nullRequired

What was refunded of it, or null.

scheduled_forstring or nullRequired

Format: date-time.

settled_atstring or nullRequired

Format: date-time.

started_atstring or nullRequired

Format: date-time.

statestringRequired
pendingaction_requiredcollectingsucceededfailedcancelledrefundedpartially_refundedreversed
pdfobjectRequired
Fields
availablebooleanRequired

Whether the invoice's PDF can be downloaded.

periodobject or any or nullRequired
statusstringRequired
opencollectingpaidunpaidvoidrefundedwritten_off
status_labelstringRequired

The status as the Control Panel writes it.

subtotalobjectRequired
Fields
amountstringRequired
currencystringRequired
taxobjectRequired
Fields
amountobjectRequired
Fields
amountstringRequired
currencystringRequired
kindstringRequired
standardreverse_chargezerooutside_scope
notestring or nullRequired

The basis in a sentence, when VAT is not charged at the standard rate.

rate_percentnumberRequired
totalobjectRequired
Fields
amountstringRequired
currencystringRequired

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403billing_forbiddenBilling is for the organisation's owner and billing contacts. Ask one of them to do this.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
422invalidFix the field named in field; errors says why.
429rate_limitedWait 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"
{
  "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"
  }
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT