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

Earnipay Customers API

Customer management for invoicing

Earnipay Customers API is one of 13 APIs that Earnipay 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 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against the base URL https://e-invoicing.earnipay.com/v1.

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.0
API Version
1.0
Base URL
https://e-invoicing.earnipay.com/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Earnipay Customers API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT-auth). An API key is passed in the header as X-API-Key (API-Key).

  • JWT-auth — Enter JWT token
  • API-Key — API Key for third-party integrations

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.

Customers 5

Customer management for invoicing

POST
/v1/customers
Create new customer
CustomerController_createCustomer_v1 1 param body → 201400401403409
GET
/v1/customers
Get customers list
CustomerController_getCustomers_v1 8 params → 200401403
GET
/v1/customers/{id}
Get customer details
CustomerController_getCustomerById_v1 1 param → 200401403404
PATCH
/v1/customers/{id}
Update customer
CustomerController_updateCustomer_v1 1 param body → 200400401403404409
DELETE
/v1/customers/{id}
Delete customer
CustomerController_deleteCustomer_v1 1 param → 200401403404

Schemas 2

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

UpdateCustomerDto
object
10 properties
CreateCustomerDto
object
10 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

earnipay-customers-api-openapi.yml Raw ↑

Other APIs Earnipay publishes across the network.

Earnipay App API
Earnipay APP Provider API
Earnipay Authentication API
Earnipay Bank API
Earnipay Business API
Earnipay Invoices API
Earnipay IRN Generator API
Earnipay Payment Details API
Earnipay Products API
Earnipay QR Code Generator API
Earnipay Team API
Earnipay Users API