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

Invoice creation, management, and FIRS validation

Earnipay Invoices API is one of 13 APIs that Earnipay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 11 operations across 8 paths, and defines 7 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.

11 operations 8 paths 7 schemas 1 DELETE3 GET1 PATCH6 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 Invoices 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 11

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

Invoices 11

Invoice creation, management, and FIRS validation

POST
/v1/invoices
Create new invoice
InvoiceController_createInvoice_v1 1 param body → 201400401403
GET
/v1/invoices
Get invoices list
InvoiceController_getInvoices_v1 11 params → 200401403
POST
/v1/invoices/{id}/approve
Approve invoice
InvoiceController_approveInvoice_v1 2 params body → 200400403404
POST
/v1/invoices/{id}/reject
Reject invoice
InvoiceController_rejectInvoice_v1 2 params body → 200400403404
GET
/v1/invoices/{id}
Get invoice details
InvoiceController_getInvoiceById_v1 1 param → 200401403404
PATCH
/v1/invoices/{id}
Update invoice
InvoiceController_updateInvoice_v1 1 param body → 200400401403404
DELETE
/v1/invoices/{id}
Cancel invoice
InvoiceController_cancelInvoice_v1 1 param → 200400401403404
POST
/v1/invoices/{id}/generate-qr
Generate QR code
InvoiceController_generateQrCode_v1 1 param → 200400401403404
GET
/v1/invoices/{id}/pdf
Download invoice PDF
InvoiceController_downloadPdf_v1 1 param → 200401403404
POST
/v1/invoices/{id}/submit-to-app
Submit invoice to APP provider
InvoiceController_submitToApp_v1 1 param → 200400404
POST
/v1/invoices/validate
Validate invoice data against FIRS schema
InvoiceController_validateInvoiceData_v1 body → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ValidateInvoiceDataDto (12 properties), CreateInvoiceDto (11 properties), UpdateInvoiceDto (9 properties), InvoiceItemDto (7 properties). Each schema is shown below with its type and property counts.

ApproveInvoiceDto
object
1 property
CreateInvoiceDto
object
11 properties 3 required
UpdateInvoiceDto
object
9 properties
ValidateInvoiceDataDto
object
12 properties 10 required
ValidateInvoiceResponse
object
5 properties 4 required
RejectInvoiceDto
object
2 properties 1 required
InvoiceItemDto
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

earnipay-invoices-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 Customers API
Earnipay IRN Generator API
Earnipay Payment Details API
Earnipay Products API
Earnipay QR Code Generator API
Earnipay Team API
Earnipay Users API