How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HighLevel Invoice API

Documentation for invoice API

HighLevel Invoice API is one of 117 APIs that HighLevel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 60 JSON Schema definitions.

Tagged areas include Invoices. The published artifact set on APIs.io includes an OpenAPI specification and 60 JSON Schemas.

This API exposes 12 operations across 9 paths, and defines 55 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://services.leadconnectorhq.com.

12 operations 9 paths 55 schemas 1 DELETE4 GET2 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.gohighlevel.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

HighLevel Invoice API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (Location-Access). It accepts HTTP bearer tokens (JWT) (Location-Access-Only). It accepts HTTP bearer tokens (JWT) (Agency-Access). It accepts HTTP bearer tokens (JWT) (Agency-Access-Only).

  • bearer — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access-Only — Use the Access Token generated with user type as Sub-Account.
  • Agency-Access — Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
  • Agency-Access-Only — Use the Access Token generated with user type as Agency.

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 2 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Invoice 12

Documentation for invoice API

GET
/invoices/generate-invoice-number
Generate Invoice Number
generate-invoice-number 3 params → 200400401422
GET
/invoices/settings
Get Invoice Settings
get-invoice-settings 3 params → 200400401422
GET
/invoices/{invoiceId}
Get invoice
get-invoice 4 params → 200400401422
PUT
/invoices/{invoiceId}
Update invoice
update-invoice 2 params body → 200400401422
DELETE
/invoices/{invoiceId}
Delete invoice
delete-invoice 4 params → 200400401422
PATCH
/invoices/{invoiceId}/late-fees-configuration
Update invoice late fees configuration
update-invoice-late-fees-configuration 2 params body → 200400401422
POST
/invoices/{invoiceId}/void
Void invoice
void-invoice 2 params body → 200400401422
POST
/invoices/{invoiceId}/send
Send invoice
send-invoice 2 params body → 200400401422
POST
/invoices/{invoiceId}/record-payment
Record a manual payment for an invoice
record-invoice 2 params body → 200400401422
PATCH
/invoices/stats/last-visited-at
Update invoice last visited at
update-invoice-last-visited-at 1 param body → 200400401
POST
/invoices/
Create Invoice
create-invoice 1 param body → 200400401422
GET
/invoices/
List invoices
list-invoices 13 params → 200400401422

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are GetInvoiceResponseDto (25 properties), UpdateInvoiceDto (24 properties), VoidInvoiceResponseDto (23 properties), CreateInvoiceDto (23 properties). Each schema is shown below with its type and property counts.

CreateInvoiceResponseDto
object
23 properties 19 required
UpdateInvoiceResponseDto
object
23 properties 19 required
DiscountDto
object
3 properties 1 required
PatchInvoiceStatsLastViewedDto
object
1 property 1 required
SentToDto
object
4 properties 1 required
SendInvoicesResponseDto
object
3 properties 3 required
BacsDirectDebitDTO
object
2 properties 2 required
ListInvoicesResponseDto
object
2 properties 2 required
ReminderSettingsDto
object
2 properties 2 required
LateFeesGraceDto
object
2 properties 2 required
ContactDetailsDto
object
8 properties 4 required
GetInvoiceSettingsResponseDto
object
20 properties
Address
object
6 properties
AttachmentsDto
object
5 properties 5 required
VoidInvoiceDto
object
2 properties 2 required
USBankAccountDto
object
2 properties 2 required
DefaultInvoiceResponseDto
object
23 properties 19 required
CustomNotificationDto
object
16 properties 16 required
CardDto
object
2 properties 2 required
ProcessingFeeDto
object
3 properties 1 required
UpdateInvoiceLateFeesConfigurationDto
object
3 properties 3 required
ReminderExecutionDetailsList
object
ProcessingFeePaidChargeDto
object
4 properties 4 required
ItemTaxDto
object
6 properties 3 required
PaymentScheduleDto
object
2 properties 2 required
BecsDirectDebitDTO
object
2 properties 2 required
AdditionalEmailsDto
object
1 property 1 required
TotalSummaryDto
object
3 properties 3 required
RecordPaymentDto
object
10 properties 6 required
CreateInvoiceDto
object
23 properties 11 required
ChequeDto
object
1 property 1 required
VoidInvoiceResponseDto
object
23 properties 19 required
InvoiceSettingsSenderConfigurationDto
object
2 properties
InvoiceItemDto
object
12 properties 4 required
DeleteInvoiceResponseDto
object
23 properties 19 required
AddressDto
object
6 properties
RecordPaymentResponseDto
object
2 properties 2 required
SendInvoiceDto
object
7 properties 5 required
StripePaymentMethodDto
object
1 property 1 required
ReminderDto
object
14 properties 11 required
GenerateInvoiceNumberResponseDto
object
1 property
SepaDirectDebitDTO
object
3 properties 3 required
PaymentMethodDto
object
1 property 1 required
LateFeesMaxFeesDto
object
2 properties 2 required
BusinessDetailsDto
object
6 properties
InvoiceProductSettingsDto
object
2 properties
UpdateInvoiceDto
object
24 properties 7 required
GetInvoiceResponseDto
object
25 properties 20 required
AutoPaymentDetailsDto
object
11 properties 1 required
LateFeesFrequencyDto
object
2 properties 2 required
CustomNotificationItemDto
object
7 properties 3 required
RemindersConfigurationDto
object
2 properties 2 required
InvoiceSettingsBusinessDetailsDto
object
6 properties 1 required
TipsConfigurationDto
object
2 properties 2 required
LateFeesConfigurationDto
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-invoice-api-openapi.yml Raw ↑

Other APIs HighLevel publishes across the network.

HighLevel Account API
HighLevel Actions API
HighLevel Affiliates API
HighLevel Agents API
HighLevel App Billing Management API
HighLevel App Management API
HighLevel Appointment Notes API
HighLevel Appointments API
HighLevel Associations API
HighLevel Availability API
HighLevel Blogs API
HighLevel Brand Boards API
Where this information came from

This is an independent, third-party profile of HighLevel Invoice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.