Skip to main content
POST
/
api
/
v1
/
invoices
/
documents
/
contracts
Create a new contract
curl --request POST \
  --url https://api.hevn.finance/api/v1/invoices/documents/contracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractorEmail": "<string>",
  "clientEmail": "<string>",
  "label": "<string>",
  "type": "service",
  "activationAt": "2023-11-07T05:31:56Z",
  "expirationAt": "2023-11-07T05:31:56Z",
  "fields": {},
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "priorityMethods": [],
  "paymentMethods": [
    {}
  ],
  "requireClientKyc": false,
  "requireClientW89": false,
  "requireContractorKyc": false,
  "requireContractorW89": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "client": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "entityName": "<string>",
    "avatarUrl": "<string>",
    "isBusiness": false,
    "address": {}
  },
  "contractor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "entityName": "<string>",
    "avatarUrl": "<string>",
    "isBusiness": false,
    "address": {}
  },
  "label": "<string>",
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentName": "<string>",
  "documentFileName": "<string>",
  "documentDownloadLink": "<string>",
  "amount": "<string>",
  "period": "<string>",
  "activationAt": "2023-11-07T05:31:56Z",
  "expirationAt": "2023-11-07T05:31:56Z",
  "signatureRequestId": "<string>",
  "signed": {},
  "clientAcceptance": {},
  "contractorAcceptance": {},
  "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fields": {},
  "priorityMethods": [],
  "paymentMethods": [
    {}
  ],
  "lastInvoice": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": "<string>",
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "contractorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contractorEmail": "<string>",
    "clientEmail": "<string>",
    "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "onchainTransactionId": "<string>",
    "invoiceDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "discount": "<string>",
    "comment": "<string>",
    "emailMessage": "<string>",
    "invoiceNumber": "<string>",
    "issuedDate": "2023-12-25",
    "dueDate": "2023-12-25",
    "paidAt": "2023-11-07T05:31:56Z"
  }
}

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 a new contract.

Exactly one of contractor_email or client_email must be set.

  • contractor_email — the creator is the client.
  • client_email — the creator is the contractor.
​
contractorEmail
string | null
Required string length: 3 - 320
​
clientEmail
string | null
Required string length: 3 - 320
​
label
string | null
Maximum string length: 200
​
type
enum<string>
default:service

Contract type.

Available options:
service,
employment,
nda,
contractor,
default_contractor,
custom,
vendor,
milestone,
msa,
other
​
period
enum<string> | null

Recurring billing period of a contract.

Available options:
weekly,
biweekly,
monthly,
quarterly,
yearly
​
activationAt
string<date-time> | null
​
expirationAt
string<date-time> | null
​
status
enum<string> | null

Contract status.

Available options:
pending_approval_by_contractor,
pending_approval_by_client,
active,
completed,
cancelled,
paused
​
fields
Fields · object
​
documentId
string<uuid> | null
​
priorityMethods
enum<string>[]

Transaction type - payment rail.

Includes all FiatPaymentType values (sepa/swift/ach/uaefts) plus extended fiat variants (wire/swift-usd/swift-eur/fedwire/pix) and non-fiat rails (crypto/card/internal/refund).

Available options:
sepa,
swift,
ach,
uaefts,
fedwire,
swift-usd,
swift-eur,
wire,
pix,
crypto,
card,
internal,
refund
​
paymentMethods
Paymentmethods · object[]
​
requireClientKyc
boolean
default:false
​
requireClientW89
boolean
default:false
​
requireContractorKyc
boolean
default:false
​
requireContractorW89
boolean
default:false

Response

Successful Response

Contract response.

​
id
string<uuid>
required
​
clientId
string<uuid>
required
​
contractorId
string<uuid>
required
​
type
enum<string>
required

Contract type.

Available options:
service,
employment,
nda,
contractor,
default_contractor,
custom,
vendor,
milestone,
msa,
other
​
status
enum<string>
required

Contract status.

Available options:
pending_approval_by_contractor,
pending_approval_by_client,
active,
completed,
cancelled,
paused
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
client
ContractParty · object

Minimal user data embedded in contract responses.

​
contractor
ContractParty · object

Minimal user data embedded in contract responses.

​
label
string | null
​
documentId
string<uuid> | null
​
documentName
string | null
​
documentFileName
string | null
​
documentDownloadLink
string | null
​
amount
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
currency
enum<string> | null

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

Available options:
USD,
EUR,
GBP,
JPY,
CHF,
CAD,
AUD,
NZD,
SEK,
NOK,
AED,
HKD
​
period
string | null
​
activationAt
string<date-time> | null
​
expirationAt
string<date-time> | null
​
signatureRequestId
string | null
​
signed
Signed · object
​
clientAcceptance
Clientacceptance · object
​
contractorAcceptance
Contractoracceptance · object
​
creatorId
string<uuid> | null
​
fields
Fields · object
​
priorityMethods
enum<string>[]

Transaction type - payment rail.

Includes all FiatPaymentType values (sepa/swift/ach/uaefts) plus extended fiat variants (wire/swift-usd/swift-eur/fedwire/pix) and non-fiat rails (crypto/card/internal/refund).

Available options:
sepa,
swift,
ach,
uaefts,
fedwire,
swift-usd,
swift-eur,
wire,
pix,
crypto,
card,
internal,
refund
​
paymentMethods
Paymentmethods · object[]
​
lastInvoice
ContractLastInvoice · object

Flat last invoice data embedded in contract responses.