{
  "opencollection": "1.0.0",
  "info": {
    "name": "HEVN 2FA contracts API",
    "version": "0.1.2"
  },
  "items": [
    {
      "info": {
        "name": "contracts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List contracts for current user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/documents/contracts",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List contracts for current user"
        },
        {
          "info": {
            "name": "Create a new contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/documents/contracts",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new contract"
        },
        {
          "info": {
            "name": "Attach a document to a contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/attach-document",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Attach a document to a contract"
        },
        {
          "info": {
            "name": "List fillable document templates and their fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/templates"
          },
          "docs": "List fillable document templates and their fields"
        },
        {
          "info": {
            "name": "Generate plain-text scope description from a role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/generate_scope_prefill",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate plain-text scope description from a role"
        },
        {
          "info": {
            "name": "Persist prepared contract markdown as a document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/prepare_document",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Persist prepared contract markdown as a document"
        },
        {
          "info": {
            "name": "Preview contract document generated from a saved contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/preview_document",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Preview contract document generated from a saved contract"
        },
        {
          "info": {
            "name": "Preview contract document generated from a saved contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/preview",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Preview contract document generated from a saved contract"
        },
        {
          "info": {
            "name": "Get contract by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get contract by ID"
        },
        {
          "info": {
            "name": "Update contract terms and schedule",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update contract terms and schedule"
        },
        {
          "info": {
            "name": "Delete contract",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete contract"
        },
        {
          "info": {
            "name": "Close contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/close",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Close contract"
        },
        {
          "info": {
            "name": "Pause contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/pause",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Pause contract"
        },
        {
          "info": {
            "name": "Approve contract by client or contractor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/approve",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Approve contract by client or contractor"
        },
        {
          "info": {
            "name": "Set contractor payment methods for contract",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/payment_methods",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Set contractor payment methods for contract"
        },
        {
          "info": {
            "name": "Update contract label",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/label",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update contract label"
        },
        {
          "info": {
            "name": "Send contract for signing",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/documents/contracts/:contract_id/send-for-signing",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Send contract for signing"
        },
        {
          "info": {
            "name": "List contracts for current user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List contracts for current user"
        },
        {
          "info": {
            "name": "Create a new contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Create a new contract"
        },
        {
          "info": {
            "name": "Attach a document to a contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/attach-document",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Attach a document to a contract"
        },
        {
          "info": {
            "name": "List fillable document templates and their fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/templates"
          },
          "docs": "List fillable document templates and their fields"
        },
        {
          "info": {
            "name": "Generate plain-text scope description from a role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/generate_scope_prefill",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate plain-text scope description from a role"
        },
        {
          "info": {
            "name": "Persist prepared contract markdown as a document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/prepare_document",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Persist prepared contract markdown as a document"
        },
        {
          "info": {
            "name": "Preview contract document generated from a saved contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/preview_document",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Preview contract document generated from a saved contract"
        },
        {
          "info": {
            "name": "Preview contract document generated from a saved contract",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/preview",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Preview contract document generated from a saved contract"
        },
        {
          "info": {
            "name": "Get contract by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get contract by ID"
        },
        {
          "info": {
            "name": "Update contract terms and schedule",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update contract terms and schedule"
        },
        {
          "info": {
            "name": "Delete contract",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete contract"
        },
        {
          "info": {
            "name": "Close contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/close",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Close contract"
        },
        {
          "info": {
            "name": "Pause contract",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/pause",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Pause contract"
        },
        {
          "info": {
            "name": "Approve contract by client or contractor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/approve",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Approve contract by client or contractor"
        },
        {
          "info": {
            "name": "Set contractor payment methods for contract",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/payment_methods",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Set contractor payment methods for contract"
        },
        {
          "info": {
            "name": "Update contract label",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/label",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update contract label"
        },
        {
          "info": {
            "name": "Send contract for signing",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hevn.finance/api/v1/invoices/documents/contracts/:contract_id/send-for-signing",
            "headers": [
              {
                "name": "x-api-key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "contract_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Send contract for signing"
        }
      ]
    }
  ],
  "bundled": true
}