Pause contract

POST /api/v1/documents/contracts/{contract_id}/pause

Pause contract

cURL

curl --request POST \
  --url https://api.hevn.finance/api/v1/documents/contracts/{contract_id}/pause \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hevn.finance/api/v1/documents/contracts/{contract_id}/pause"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

200

{
  "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"
  }
}

{
  "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

Path Parameters

contract_id · string<uuid> · required

Response

200

application/json

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 | null

Minimal user data embedded in contract responses.

Show child attributes

contractor · ContractParty · object | null

Minimal user data embedded in contract responses.

Show child attributes

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 | null

clientAcceptance · Clientacceptance · object | null

contractorAcceptance · Contractoracceptance · object | null

creatorId · string<uuid> | null

fields · Fields · object | 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[]

lastInvoice · ContractLastInvoice · object | null

Flat last invoice data embedded in contract responses.

Show child attributes