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 APP Provider API

Third-party APP provider integration (Taxly) for FIRS submission

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

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

This API exposes 4 operations across 4 paths. 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.

4 operations 4 paths 0 schemas 2 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 APP Provider 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 4

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

APP Provider 4

Third-party APP provider integration (Taxly) for FIRS submission

GET
/v1/api/v1/businesses/{businessId}/app/connection-test
Test APP provider connection
AppProviderController_testConnection_v1 1 param → 200
POST
/v1/api/v1/businesses/{businessId}/app/invoices/{invoiceId}/submit
Submit invoice to APP provider
AppProviderController_submitInvoice_v1 1 param → 200400
PATCH
/v1/api/v1/businesses/{businessId}/app/invoices/{invoiceId}/payment-status
Update invoice payment status in FIRS
AppProviderController_updatePaymentStatus_v1 1 param → 200
GET
/v1/api/v1/businesses/{businessId}/app/invoices/search
Search invoices from FIRS system
AppProviderController_searchInvoices_v1 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

earnipay-app-provider-api-openapi.yml Raw ↑

Other APIs Earnipay publishes across the network.

Earnipay App API
Earnipay Authentication API
Earnipay Bank API
Earnipay Business API
Earnipay Customers 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