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

HawkSoft Receipts API

Payment receipts on client records

HawkSoft Receipts API is one of 5 APIs that HawkSoft publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 3.0.

Requests are made against a single base URL, https://integration.hawksoft.app.

1 operations 1 paths 1 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0
Base URL
https://integration.hawksoft.app
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

HawkSoft Receipts 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 with partner-issued credentials.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Receipts 1

Payment receipts on client records

POST
/vendor/agency/{agencyId}/client/{clientId}/receipts
Post a payment receipt to a client (write-back, V3.0)
postReceipt 3 params body → 201401

Schemas 1

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

Receipt
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hawksoft-receipts-api-openapi.yml Raw ↑

Other APIs HawkSoft publishes across the network.

HawkSoft Agencies API
HawkSoft Attachments API
HawkSoft Clients API
HawkSoft Log Entries API