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

Invoice Ninja Company Gateways API

The Company Gateways API from Invoice Ninja — 2 operation(s) for company gateways.

Invoice Ninja Company Gateways API is one of 10 APIs that Invoice Ninja publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 5.0.

Requests are made against a single base URL, https://invoicing.co.

4 operations 2 paths 1 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
5.0
Base URL
https://invoicing.co
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Invoice Ninja Company Gateways API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Token (apiToken). By default, every request must be authenticated.

  • apiToken — API token created in the Invoice Ninja settings. Self-hosted installs may additionally require an X-Api-Secret header.

Paths & Operations 4

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

Company Gateways 4
GET
/api/v1/company_gateways
List company gateways
listCompanyGateways → 200
POST
/api/v1/company_gateways
Create company gateway
createCompanyGateway body → 201
GET
/api/v1/company_gateways/{id}
Get company gateway
getCompanyGateway 1 param → 200
PUT
/api/v1/company_gateways/{id}
Update company gateway
updateCompanyGateway 1 param body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is CompanyGateway (8 properties). Each schema is shown below with its type and property counts.

CompanyGateway
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

invoice-ninja-company-gateways-api-openapi.yml Raw ↑

Other APIs Invoice Ninja publishes across the network.

Invoice Ninja Activities API
Invoice Ninja Authentication API
Invoice Ninja Bank Integrations API
Invoice Ninja Bank Transaction Rules API
Invoice Ninja Bank Transactions API
Invoice Ninja Charts API
Invoice Ninja Client Gateway Tokens API
Invoice Ninja Companies API
Invoice Ninja Settings API