Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Invoiced Credit Notes API

The Credit Notes API from Invoiced — 2 operation(s) for credit notes.

Invoiced Credit Notes API is one of 9 APIs that Invoiced publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credit Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://api.invoiced.com, https://api.sandbox.invoiced.com.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.invoiced.com
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Invoiced Credit Notes API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. Use your Invoiced API key as the username and leave the password blank. API keys are created under Settings - Developers - API Keys.

Paths & Operations 5

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

Credit Notes 5
GET
/credit_notes
List all credit notes.
listCreditNotes 3 params → 200
POST
/credit_notes
Create a new credit note.
createCreditNote body → 201
GET
/credit_notes/{id}
Retrieve a credit note.
getCreditNote 1 param → 200
PATCH
/credit_notes/{id}
Update a credit note.
updateCreditNote 1 param body → 200
DELETE
/credit_notes/{id}
Delete a credit note.
deleteCreditNote 1 param → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are CreditNote (19 properties), LineItem (10 properties). Each schema is shown below with its type and property counts.

LineItem
object
10 properties
CreditNote
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

invoiced-credit-notes-api-openapi.yml Raw ↑

Other APIs Invoiced publishes across the network.

Invoiced Customers API
Invoiced Estimates API
Invoiced Events API
Invoiced Invoices API
Invoiced Items API
Invoiced Payments API
Invoiced Plans API
Invoiced Subscriptions API