Create invoice

POST /api/v1/documents/contracts/invoices

Create invoice

cURL

curl --request POST \
  --url https://api.hevn.finance/api/v1/documents/contracts/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractorEmail": "<string>",
  "contractorDisplayName": "<string>",
  "clientEmail": "<string>",
  "clientDisplayName": "<string>"
}
'

import requests

url = "https://api.hevn.finance/api/v1/documents/contracts/invoices"

payload = {
    "contractorEmail": "<string>",
    "contractorDisplayName": "<string>",
    "clientEmail": "<string>",
    "clientDisplayName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contractorEmail: '<string>',
    contractorDisplayName: '<string>',
    clientEmail: '<string>',
    clientDisplayName: '<string>'
  })
};

fetch('https://api.hevn.finance/api/v1/documents/contracts/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "onchainTransactionId": "<string>",
  "transaction": {
    "onchainTransactionId": "<string>",
    "amount": 123,
    "txHash": "<string>",
    "type": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "discount": "<string>",
  "comment": "<string>",
  "emailMessage": "<string>",
  "invoiceNumber": "<string>",
  "periodNumber": 123,
  "issuedDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "items": [
    {}
  ],
  "paymentMethods": [
    {
      "bankName": "<string>",
      "ibanNumber": "<string>",
      "beneficiaryName": "<string>",
      "bankAddress": "<string>",
      "currency": "<string>",
      "accountHolderFirstName": "<string>",
      "accountHolderLastName": "<string>",
      "accountHolderBusinessName": "<string>",
      "accountHolderAddress": {
        "streetAddress": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>"
      },
      "paymentReference": "<string>",
      "accountType": "sepa",
      "bic": "<string>"
    }
  ],
  "client": {
    "email": "<string>",
    "displayName": "<string>",
    "address": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>"
    }
  },
  "contractor": {
    "email": "<string>",
    "displayName": "<string>",
    "address": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>"
    }
  },
  "contract": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isRecurring": true,
    "period": "<string>",
    "activationAt": "2023-11-07T05:31:56Z",
    "expirationAt": "2023-11-07T05:31:56Z"
  },
  "invoiceLink": "<string>",
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "key": "<string>"
    }
  ],
  "paidAt": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Body

application/json

Request to create an invoice.

Participant data (email, display_name, address) is snapshotted at creation time. Amount is computed as sum of items[].price * items[].quantity. invoice_number is auto-generated per (contractor, client) pair.

contractorEmail · string · required

contractorDisplayName · string · required

clientEmail · string · required

clientDisplayName · string · required

currency · enum<string> · default: USD

Supported invoice/contract currencies. G10 majors + AED/HKD.

Available options: USD, EUR, GBP, JPY, CHF, CAD, AUD, NZD, SEK, NOK, AED, HKD

comment · string | null

emailMessage · string | null

Maximum string length: 2000

invoicePrefix · string · default: INV

Prefix for auto-generated invoice_number, e.g. "INV" → "INV-0001".

Required string length: 1 - 16

Pattern: ^[A-Za-z0-9_-]+$

issuedDate · string<date> | null

dueDate · string<date> | null

items · Items · object[]

discount · number string

Fixed discount in invoice currency. Subtracted from sum of items.

Required range: x >= 0

documentIds · string<uuid>[] | null

contractorAddress · UserAddress · object | null

Address schema for user.

Canonical field names: street_address, address_line_2, city, state, country, zip. Accepts legacy Align/IBAN field names (street_line_1, street_line_2, postal_code) for backward compatibility with existing JSONB data.

Show child attributes

clientAddress · UserAddress · object | null

Address schema for user.

Canonical field names: street_address, address_line_2, city, state, country, zip. Accepts legacy Align/IBAN field names (street_line_1, street_line_2, postal_code) for backward compatibility with existing JSONB data.

Show child attributes

banks · string<uuid>[] | null

onchain · boolean · default: false

Response

201

application/json

Successful Response

Invoice response.

id · string<uuid> · required

amount · string · required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

currency · enum<string> · required

Supported invoice/contract currencies. G10 majors + AED/HKD.

Available options: USD, EUR, GBP, JPY, CHF, CAD, AUD, NZD, SEK, NOK, AED, HKD

status · enum<string> · required

Invoice status.

Available options: draft, sent, paid, cancelled, client_paid, client_declined

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

onchainTransactionId · string | null

transaction · InvoiceTransactionInfo · object | null

Minimal transaction info embedded in invoice response.

Show child attributes

discount · string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

comment · string | null

emailMessage · string | null

invoiceNumber · string | null

periodNumber · integer | null

issuedDate · string<date> | null

dueDate · string<date> | null

items · Items · object[]

paymentMethods · (IBANAccountDetails · object | USExternalAccountDetails · object | SwiftAccountDetails · object | ContactWalletResponse · object | EmailAccountInput · object)[]

IBAN (SEPA) external account.

IBANAccountDetails

USExternalAccountDetails

SwiftAccountDetails

ContactWalletResponse

EmailAccountInput

Show child attributes

client · InvoiceParticipant · object | null

Minimal participant info for invoice response.

Show child attributes

contractor · InvoiceParticipant · object | null

Minimal participant info for invoice response.

Show child attributes

contract · InvoiceContractInfo · object | null

Minimal contract info embedded in invoice response.

Show child attributes

invoiceLink · string | null

documents · InvoiceDocumentInfo · object[]

Show child attributes

paidAt · string<date-time> | null