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 Customers API

The Customers API from Invoiced — 3 operation(s) for customers.

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

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

This API exposes 6 operations across 3 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.

6 operations 3 paths 2 schemas 1 DELETE3 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 Customers 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 6

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

Customers 6
GET
/customers
List all customers.
listCustomers 3 params → 200
POST
/customers
Create a new customer.
createCustomer body → 201
GET
/customers/{id}
Retrieve a customer.
getCustomer 1 param → 200
PATCH
/customers/{id}
Update a customer.
updateCustomer 1 param body → 200
DELETE
/customers/{id}
Delete a customer.
deleteCustomer 1 param → 204
GET
/customers/{id}/balance
Retrieve a customer's credit balance and amount outstanding.
getCustomerBalance 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Customer (22 properties), CustomerBalance (4 properties). Each schema is shown below with its type and property counts.

CustomerBalance
object
4 properties
Customer
object
22 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

invoiced-customers-api-openapi.yml Raw ↑

Other APIs Invoiced publishes across the network.

Invoiced Credit Notes API
Invoiced Estimates API
Invoiced Events API
Invoiced Invoices API
Invoiced Items API
Invoiced Payments API
Invoiced Plans API
Invoiced Subscriptions API