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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hevn Inc

Hevn Inc invoices API

The invoices API from Hevn Inc — 14 operation(s) for invoices.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hevn Inc invoices API is one of 31 APIs that Hevn Inc 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 18 operations across 14 paths, and defines 35 schemas. It is described by OpenAPI 3.1.0, at version 0.1.2.

Requests are made against a single base URL, https://api.hevn.finance.

18 operations 14 paths 35 schemas 4 GET12 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.2
Base URL
https://api.hevn.finance/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Hevn Inc invoices API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer). An API key is passed in the header as x-api-key (ApiKeyAuth).

  • ApiKeyAuth — Alternative HEVN API key header. The CLI defaults to Authorization Bearer unless configured with HEVNAPIKEYHEADER=X-Api-Key.

Paths & Operations 18

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

invoices 18
POST
/api/v1/documents/contracts/invoices
Create invoice
create_invoice_api_v1_documents_contracts_invoices_post 1 param body → 201422
GET
/api/v1/documents/contracts/invoices
List invoices for current user
list_invoices_api_v1_documents_contracts_invoices_get 1 param → 200422
POST
/api/v1/documents/contracts/invoices/uploaded
Create incoming invoice from uploaded document
create_uploaded_invoice_api_v1_documents_contracts_invoices_uploaded_post 1 param body → 201422
POST
/api/v1/documents/contracts/invoices/share_link
Generate a share link for invoice creation
invoice_share_link_api_v1_documents_contracts_invoices_share_link_post 1 param → 200422
POST
/api/v1/documents/contracts/invoices/batch_invoicing
Generate invoices for multiple contracts
batch_invoicing_api_v1_documents_contracts_invoices_batch_invoicing_post 1 param body → 200422
GET
/api/v1/documents/contracts/invoices/{invoice_id}
Get invoice by ID
get_invoice_api_v1_documents_contracts_invoices__invoice_id__get 2 params → 200422
PUT
/api/v1/documents/contracts/invoices/{invoice_id}
Update invoice (set transactionhash)
update_invoice_api_v1_documents_contracts_invoices__invoice_id__put 2 params body → 200422
POST
/api/v1/documents/contracts/{contract_id}/create-invoice
Create invoice from contract
create_invoice_from_contract_api_v1_documents_contracts__contract_id__create_invoice_post 2 params body → 201422
POST
/api/v1/documents/contracts/invoices/ai_parse
AI parse invoice PDF and return invoice preview
ai_parse_invoice_api_v1_documents_contracts_invoices_ai_parse_post 2 params → 200422
POST
/api/v1/invoices/documents/contracts/invoices
Create invoice
create_invoice_package_alias_api_v1_invoices_documents_contracts_invoices_post 1 param body → 201422
GET
/api/v1/invoices/documents/contracts/invoices
List invoices for current user
list_invoices_package_alias_api_v1_invoices_documents_contracts_invoices_get 1 param → 200422
POST
/api/v1/invoices/documents/contracts/invoices/uploaded
Create incoming invoice from uploaded document
create_uploaded_invoice_package_alias_api_v1_invoices_documents_contracts_invoices_uploaded_post 1 param body → 201422
POST
/api/v1/invoices/documents/contracts/invoices/share_link
Generate a share link for invoice creation
invoice_share_link_package_alias_api_v1_invoices_documents_contracts_invoices_share_link_post 1 param → 200422
POST
/api/v1/invoices/documents/contracts/invoices/batch_invoicing
Generate invoices for multiple contracts
batch_invoicing_package_alias_api_v1_invoices_documents_contracts_invoices_batch_invoicing_post 1 param body → 200422
GET
/api/v1/invoices/documents/contracts/invoices/{invoice_id}
Get invoice by ID
get_invoice_package_alias_api_v1_invoices_documents_contracts_invoices__invoice_id__get 2 params → 200422
PUT
/api/v1/invoices/documents/contracts/invoices/{invoice_id}
Update invoice (set transactionhash)
update_invoice_package_alias_api_v1_invoices_documents_contracts_invoices__invoice_id__put 2 params body → 200422
POST
/api/v1/invoices/documents/contracts/{contract_id}/create-invoice
Create invoice from contract
create_invoice_from_contract_package_alias_api_v1_invoices_documents_contracts__contract_id__create_invoice_post 2 params body → 201422
POST
/api/v1/invoices/documents/contracts/invoices/ai_parse
AI parse invoice PDF and return invoice preview
ai_parse_invoice_package_alias_api_v1_invoices_documents_contracts_invoices_ai_parse_post 2 params → 200422

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are InvoiceResponse (23 properties), CreateInvoiceRequest (17 properties), PublicInvoiceResponse (16 properties), IBANAccountDetails-Output (14 properties). Each schema is shown below with its type and property counts.

ContactWalletResponse
object
Wallet payment method block used by invoice/payment method schemas.
4 properties 1 required
InvoiceDocumentInfo
object
Document attached to an invoice. key is a short-lived signed token. To download call GET /documents/download/{id}?key={key}.
3 properties 3 required
app__schemas__base__ContactRelationship
string
Unified contact relationship / transfer purpose. Values match Align AlignTransferPurpose (the more granular set). Mapped to Swipelux AccountHolderRelationship…
ValidationError
object
3 properties 3 required
BatchInvoiceResult
object
6 properties 2 required
InvoiceShareLinkResponse
object
Response with a share link for invoice creation.
3 properties 3 required
HTTPValidationError
object
1 property
ContractStatus
string
Contract status.
Currency
string
Supported invoice/contract currencies. G10 majors + AED/HKD.
BatchInvoicingResponse
object
1 property
InvoiceResponse
object
Invoice response.
23 properties 6 required
InvoiceStatus
string
Invoice status.
CreateInvoiceFromContractRequest
object
Request to create an invoice from a contract. Either party (client or contractor) of the contract may create the invoice; attribution always flows from contrac…
6 properties
USExternalAccountDetails-Output
object
US domestic (ACH) external account.
13 properties 4 required
InvoiceTransactionInfo
object
Minimal transaction info embedded in invoice response.
5 properties 5 required
UpdateInvoiceRequest
object
Request to update an invoice.
2 properties 1 required
PublicInvoiceResponse
object
16 properties 6 required
USAccountDetails
object
US domestic account details (ACH).
2 properties 2 required
SwiftDetails
object
SWIFT (international wire) account details.
3 properties 2 required
AlignAccountHolderType
string
Account holder type.
UserAddress
object
Address schema for user. Canonical field names: streetaddress, addressline2, city, state, country, zip. Accepts legacy Align/IBAN field names (streetline1, str…
6 properties
ContractType
string
Contract type.
EmailAccountInput
object
Email contact input.
2 properties 1 required
IBANAccountDetails-Output
object
IBAN (SEPA) external account.
14 properties 4 required
PublicInvoiceItem
object
3 properties
PublicInvoiceContractInfo
object
3 properties 1 required
CreateInvoiceRequest
object
Request to create an invoice. Participant data (email, displayname, address) is snapshotted at creation time. Amount is computed as sum of items[].price items[…
17 properties 4 required
InvoiceContractInfo
object
Minimal contract info embedded in invoice response.
7 properties 4 required
BatchContractInvoiceRequest
object
Per-contract invoice options for batch invoicing. A call without finalize creates the period invoice as a DRAFT (or updates its items if a DRAFT already exists…
5 properties 3 required
CreateUploadedInvoiceRequest
object
Create an incoming invoice from a manually uploaded/local document. Current user is the client/payer. Payment methods are resolved from saved contacts; direct…
12 properties 2 required
CountryCode
string
ISO 3166-1 alpha-2 country codes.
InvoiceParticipant
object
Minimal participant info for invoice response.
3 properties 1 required
BatchInvoicingRequest
array
Generate invoices for multiple contracts.
SwiftAccountDetails-Output
object
SWIFT (international wire) external account.
13 properties 4 required
InvoiceListResponse
object
List of invoices.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hevn-inc-invoices-api-openapi.yml Raw ↑

Other APIs Hevn Inc publishes across the network.

Hevn Inc 2FA API
AE Profile APIs.io
Hevn Inc Activity API
AE Profile APIs.io
Hevn Inc apps API
AE Profile APIs.io
Hevn Inc apps-transfer API
AE Profile APIs.io
Hevn Inc auth API
AE Profile APIs.io
Hevn Inc B2B API
AE Profile APIs.io
Hevn Inc Balance API
AE Profile APIs.io
Hevn Inc Banks API
AE Profile APIs.io
Hevn Inc Cards API
AE Profile APIs.io
Hevn Inc Chat API
AE Profile APIs.io
Hevn Inc contracts API
AE Profile APIs.io
Hevn Inc Devices API
AE Profile APIs.io
#invoices
← Back to H APIs
API Details
ID
hevn-inc:hevn-inc-invoices-api
Base URL
https://api.hevn.finance/api/v1
Docs
https://hevninc.mintlify.app/
Provider
Hevn Inc
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network