Karbon · Schema
BillingInvoiceWithPayment
A Karbon invoice with associated payment records
CompanyAccountingPractice ManagementWorkflowsCollaborationProfessional ServicesSoftware-as-a-Service
Properties
| Name | Type | Description |
|---|---|---|
| InvoiceKey | string | The unique key assigned to an invoice by Karbon |
| InvoiceNumber | string | The invoice number of the invoice |
| TotalAmountDue | number | Remaining amount due on the invoice, including taxes minus any payments |
| InvoiceTotal | number | Invoice total, including taxes |
| InvoiceSubTotal | number | The sum of the line items of the invoice, excluding taxes |
| InvoiceTaxTotal | number | Total of the taxes on the invoice |
| InvoiceDate | string | The date the invoice was issued as an ISO 8601 timestamp |
| PaymentDueDate | string | The date the invoice is due as an ISO 8601 timestamp |
| UpdatedAt | string | A timestamp showing when the invoice was last updated as an ISO 8601 timestamp |
| CurrencyCode | string | A three letter ISO 4217 currency code denoting the currency used in the invoice, e.g. AUD, USD, CAD, NZD, EUR, GBP |
| PaymentInstructions | stringnull | Payment instructions added to the invoice |
| InvoiceStatus | string | Current status of the invoice |
| Client | objectnull | The Karbon Client Billing Contact |
| TaxLineItems | array | An array of tax types and values from invoice line items |
| LineItems | array | An array of invoice line items |
| Payments | array | An array of invoice payments |
| Data | array | The collection of data that is used to create the rendered (HTML/PDF) invoice sent to the billing contact |
| InvoiceMagicLink | stringnull | A link firms can send to clients to pay the invoice through Karbon Payments. Only returned once the invoice has been posted; otherwise `null`. |
| InvoicePdfUrl | stringnull | A link to the rendered invoice PDF, which firms can use to preview the invoice, download it, or send it to their clients. The token in the URL is valid for 15 minutes. Only returned once the invoice h |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/karbonhq/json-schema/karbonhq-billing-invoice-with-payment-schema.json",
"title": "BillingInvoiceWithPayment",
"description": "A Karbon invoice with associated payment records",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/karbonhq-billing-api-openapi.yml#/components/schemas/BillingInvoiceWithPayment",
"type": "object",
"allOf": [
{
"$ref": "#/$defs/BillingInvoice"
},
{
"$ref": "#/$defs/BillingInvoiceLineItems"
},
{
"$ref": "#/$defs/BillingInvoicePayments"
},
{
"$ref": "#/$defs/BillingInvoiceData"
}
],
"properties": {
"InvoiceMagicLink": {
"type": [
"string",
"null"
],
"description": "A link firms can send to clients to pay the invoice through Karbon Payments. Only returned once the invoice has been posted; otherwise `null`."
},
"InvoicePdfUrl": {
"type": [
"string",
"null"
],
"description": "A link to the rendered invoice PDF, which firms can use to preview the invoice, download it, or send it to their clients. The token in the URL is valid for 15 minutes. Only returned once the invoice has been posted or sent; otherwise `null`."
}
},
"$defs": {
"BillingBaseInvoice": {
"description": "A Karbon invoice",
"type": "object",
"required": [
"InvoiceKey",
"InvoiceNumber",
"TotalAmountDue",
"InvoiceTotal",
"InvoiceSubTotal",
"InvoiceTaxTotal",
"InvoiceDate",
"PaymentDueDate",
"UpdatedAt",
"CurrencyCode",
"InvoiceStatus"
],
"properties": {
"InvoiceKey": {
"type": "string",
"description": "The unique key assigned to an invoice by Karbon"
},
"InvoiceNumber": {
"type": "string",
"description": "The invoice number of the invoice"
},
"TotalAmountDue": {
"type": "number",
"description": "Remaining amount due on the invoice, including taxes minus any payments"
},
"InvoiceTotal": {
"type": "number",
"description": "Invoice total, including taxes"
},
"InvoiceSubTotal": {
"type": "number",
"description": "The sum of the line items of the invoice, excluding taxes"
},
"InvoiceTaxTotal": {
"type": "number",
"description": "Total of the taxes on the invoice"
},
"InvoiceDate": {
"type": "string",
"description": "The date the invoice was issued as an ISO 8601 timestamp"
},
"PaymentDueDate": {
"type": "string",
"description": "The date the invoice is due as an ISO 8601 timestamp"
},
"UpdatedAt": {
"type": "string",
"description": "A timestamp showing when the invoice was last updated as an ISO 8601 timestamp"
},
"CurrencyCode": {
"type": "string",
"description": "A three letter ISO 4217 currency code denoting the currency used in the invoice, e.g. AUD, USD, CAD, NZD, EUR, GBP"
},
"PaymentInstructions": {
"type": [
"string",
"null"
],
"description": "Payment instructions added to the invoice"
},
"InvoiceStatus": {
"type": "string",
"enum": [
"Approved",
"AwaitingPayment",
"Paid",
"Exported",
"Voided"
],
"description": "Current status of the invoice"
}
}
},
"BillingClient": {
"required": [
"Client"
],
"description": "The details of the invoice recipient at the point in time the invoice was drafted or payment creator at the point the payment was received",
"properties": {
"Client": {
"type": [
"object",
"null"
],
"description": "The Karbon Client Billing Contact",
"properties": {
"ClientKey": {
"type": "string",
"description": "The unique key of the billed Client"
},
"ClientType": {
"type": "string",
"description": "The client type, e.g. Contact or Organization"
},
"Name": {
"type": "string",
"description": "The name of the client at the point the invoice was drafted"
},
"AddressLine": {
"type": "string",
"description": "The billing address of the cient at the point the invoice was drafted"
},
"City": {
"type": "string",
"description": "The billing address city of the cient at the point the invoice was drafted"
},
"StateProvinceCounty": {
"type": "string",
"description": "The billing address state/province/country of the cient at the point the invoice was drafted"
},
"ZipCode": {
"type": "string",
"description": "The billing address zip/postal code of the cient at the point the invoice was drafted"
},
"Country": {
"type": "string",
"description": "The billing address country of the cient at the point the invoice was drafted"
},
"EmailAddress": {
"type": "string",
"description": "The billing email address of the cient at the point the invoice was drafted"
}
}
}
}
},
"BillingInvoice": {
"type": "object",
"description": "A Karbon Invoice record",
"allOf": [
{
"$ref": "#/$defs/BillingBaseInvoice"
},
{
"$ref": "#/$defs/BillingClient"
},
{
"$ref": "#/$defs/BillingTaxLineItems"
}
]
},
"BillingInvoiceData": {
"type": "object",
"description": "A collection of the data associated with an invoice",
"properties": {
"Data": {
"type": "array",
"description": "The collection of data that is used to create the rendered (HTML/PDF) invoice sent to the billing contact",
"items": {
"$ref": "#/$defs/BillingInvoiceDataItem"
}
}
}
},
"BillingInvoiceDataExpense": {
"description": "A line item on a Karbon invoice",
"type": "object",
"properties": {
"Billed": {
"type": "number",
"description": "The total billed value of expenses"
},
"Expenses": {
"type": "array",
"items": {
"$ref": "#/$defs/BillingInvoiceDataExpenseItem"
}
}
}
},
"BillingInvoiceDataExpenseItem": {
"description": "An expense line item on a Karbon invoice",
"type": "object",
"allOf": [
{
"properties": {
"ExpenseKey": {
"type": "string"
},
"Description": {
"type": "string",
"description": "The description of the expense"
},
"Billed": {
"type": "number",
"description": "An the billed value of a specific expense"
}
}
},
{
"$ref": "#/$defs/BillingInvoiceDataTax"
}
]
},
"BillingInvoiceDataItem": {
"type": "object",
"description": "A single component of the data used to create the rendered (HTML/PDF) invoice",
"properties": {
"EntityKey": {
"type": "string",
"description": "The unique key of the source of the billing"
},
"EntityType": {
"type": "string",
"description": "The type of the source of the billing"
},
"Billed": {
"type": "number",
"format": "double",
"description": "The value of the billed amount"
},
"Expenses": {
"$ref": "#/$defs/BillingInvoiceDataExpense"
},
"Service": {
"$ref": "#/$defs/BillingInvoiceDataService"
},
"Work": {
"$ref": "#/$defs/BillingInvoiceDataWork"
}
}
},
"BillingInvoiceDataService": {
"description": "A service line item on a Karbon invoice",
"type": [
"object",
"null"
],
"allOf": [
{
"properties": {
"WorkType": {
"type": "string",
"description": "The work type associated with the service"
},
"Billed": {
"type": "number",
"description": "The billed value of the service"
}
}
},
{
"$ref": "#/$defs/BillingInvoiceDataTax"
}
]
},
"BillingInvoiceDataTax": {
"description": "A breakdown of tax related to invoice, lineitems and data",
"type": "object",
"properties": {
"TaxRate": {
"type": [
"number",
"null"
],
"format": "double",
"description": "The tax rated applied to the billed amount"
},
"TaxRateName": {
"type": [
"string",
"null"
],
"description": "The name of the tax rate applied to the billed amount"
},
"TaxAmount": {
"type": [
"number",
"null"
],
"format": "double",
"description": "The value of tax component in the billed amount"
}
}
},
"BillingInvoiceDataWork": {
"type": [
"object",
"null"
],
"description": "The breakdown of the billing that stems from work",
"allOf": [
{
"properties": {
"FeeType": {
"type": "string",
"description": "The fee type of the billed amount"
},
"WorkType": {
"type": "string",
"description": "The tax rated applied to the billed amount"
},
"InvoiceType": {
"type": "string",
"description": "Denotes whether the invoice is final or not"
},
"Billed": {
"type": "number",
"format": "double",
"description": "The value of the billed amount"
},
"TimeEntries": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/BillingInvoiceDataWorkTimeEntry"
}
},
{
"type": "null"
}
]
}
}
},
{
"$ref": "#/$defs/BillingInvoiceDataTax"
}
]
},
"BillingInvoiceDataWorkTimeEntry": {
"description": "The details of an invoiced time entry",
"properties": {
"TimeEntryKey": {
"type": "string",
"description": "The unique identifier of the time entry"
},
"ColleagueKey": {
"type": "string",
"description": "The unique ID of the user that logged the time"
},
"RoleName": {
"type": "string",
"description": "The role on the time entry"
},
"TaskTypeName": {
"type": "string",
"description": "The task ype on the time entry"
},
"Billed": {
"type": "number",
"description": "The billed value of the time entry"
}
}
},
"BillingInvoiceLineItems": {
"type": "object",
"required": [
"LineItems"
],
"description": "A breakdown of line items from the invoice",
"properties": {
"LineItems": {
"description": "An array of invoice line items",
"type": "array",
"items": {
"description": "A line item on a Karbon invoice",
"type": "object",
"properties": {
"LineItemKey": {
"type": "string",
"description": "A unique GUID for the line item"
},
"BillableItemEntityKey": {
"type": "string",
"description": "The unique key of the related entity the line item was created from, could be a Contact, WorkItem or TimeEntry"
},
"BillableItemType": {
"type": "string",
"enum": [
"TimeEntry",
"Expense",
"Entity"
],
"description": "The source type of the line item"
},
"Description": {
"type": "string",
"description": "The description of charge the line item covers"
},
"Quantity": {
"type": "number",
"description": "The quantity of units for a line item"
},
"UnitPrice": {
"type": "string",
"description": "The per unit price of the line item"
},
"Amount": {
"type": "number",
"description": "The amount of the line item calculated as UnitPrice * Quantity, excluding taxes"
},
"TaxRate": {
"type": [
"number",
"null"
],
"description": "The percentage tax rate, expressed as an integer - e.g. 15% is rendered as 15.0000"
},
"TaxRateName": {
"type": [
"string",
"null"
],
"description": "The user specified name of tax rate, e.g. GST, VAT, PST"
}
}
}
}
}
},
"BillingInvoicePayments": {
"type": "object",
"required": [
"Payments"
],
"description": "Details of the payments related to the invoice",
"properties": {
"Payments": {
"description": "An array of invoice payments",
"type": "array",
"items": {
"description": "A payment on a Karbon invoice",
"type": "object",
"properties": {
"PaymentKey": {
"type": "string",
"description": "A unique ID for the payment"
},
"PaymentReference": {
"type": "string",
"description": "The Karbon reference number for the payment"
},
"PaymentType": {
"type": "string",
"enum": [
"ManualPayment",
"ManualPaymentReversed",
"Payment"
],
"description": "The type of payment"
},
"PaymentDate": {
"type": "string",
"format": "date",
"description": "The datestamp the payment was made, for manual payments this is the date only"
},
"Amount": {
"type": "number",
"description": "The value of the payment"
}
}
}
}
}
},
"BillingTaxLineItems": {
"type": "object",
"description": "Details of the tax components of the invoice",
"properties": {
"TaxLineItems": {
"description": "An array of tax types and values from invoice line items",
"type": "array",
"items": {
"description": "A tax line item detailing the tax code and amount on Karbon invoice",
"properties": {
"TaxName": {
"type": "string",
"description": "The name of the tax"
},
"TaxValue": {
"type": "number",
"description": "The value of the tax in the invoice currency"
}
}
}
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/karbonhq-billing-invoice-with-payment"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.