> ## Documentation Index
> Fetch the complete documentation index at: https://hevninc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create invoice from contract



## OpenAPI

````yaml /openapi.json post /api/v1/documents/contracts/{contract_id}/create-invoice
openapi: 3.1.0
info:
  title: HEVN API
  description: Backend API for HEVN mobile neobank
  version: 0.1.2
servers:
  - url: https://api.hevn.finance
    description: Production
security: []
paths:
  /api/v1/documents/contracts/{contract_id}/create-invoice:
    post:
      tags:
        - invoices
      summary: Create invoice from contract
      operationId: >-
        create_invoice_from_contract_api_v1_documents_contracts__contract_id__create_invoice_post
      parameters:
        - name: contract_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Contract Id
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInvoiceFromContractRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    CreateInvoiceFromContractRequest:
      properties:
        amount:
          anyOf:
            - type: number
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Amount
        comment:
          anyOf:
            - type: string
            - type: 'null'
          title: Comment
        invoicePrefix:
          type: string
          maxLength: 16
          minLength: 1
          pattern: ^[A-Za-z0-9_-]+$
          title: Invoiceprefix
          description: Prefix for auto-generated invoice_number, e.g. "INV" → "INV-0001".
          default: INV
        contractorAddress:
          anyOf:
            - $ref: '#/components/schemas/UserAddress'
            - type: 'null'
        periodStart:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Periodstart
        addItems:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Additems
      type: object
      title: CreateInvoiceFromContractRequest
      description: >-
        Request to create an invoice from a contract.


        Either party (client or contractor) of the contract may create the
        invoice;

        attribution always flows from ``contract.contractor`` to

        ``contract.client``. Amount defaults to the contract amount when not

        provided. ``contractor_address`` is optional — when omitted, the
        snapshot

        stored on the contract (or the linked contact's address) is used.

        ``invoice_number`` is auto-generated per (contractor, client) pair as
        e.g.

        ``"INV-0001"``.
    InvoiceResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        onchainTransactionId:
          anyOf:
            - type: string
            - type: 'null'
          title: Onchaintransactionid
        transaction:
          anyOf:
            - $ref: '#/components/schemas/InvoiceTransactionInfo'
            - type: 'null'
        amount:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Amount
        discount:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Discount
        currency:
          $ref: '#/components/schemas/Currency'
        comment:
          anyOf:
            - type: string
            - type: 'null'
          title: Comment
        emailMessage:
          anyOf:
            - type: string
            - type: 'null'
          title: Emailmessage
        invoiceNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Invoicenumber
        periodNumber:
          anyOf:
            - type: integer
            - type: 'null'
          title: Periodnumber
        issuedDate:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Issueddate
        dueDate:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Duedate
        items:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Items
        paymentMethods:
          items:
            anyOf:
              - $ref: '#/components/schemas/IBANAccountDetails-Output'
              - $ref: '#/components/schemas/USExternalAccountDetails-Output'
              - $ref: '#/components/schemas/SwiftAccountDetails-Output'
              - $ref: '#/components/schemas/ContactWalletResponse'
              - $ref: '#/components/schemas/EmailAccountInput'
          type: array
          title: Paymentmethods
        status:
          $ref: '#/components/schemas/InvoiceStatus'
        client:
          anyOf:
            - $ref: '#/components/schemas/InvoiceParticipant'
            - type: 'null'
        contractor:
          anyOf:
            - $ref: '#/components/schemas/InvoiceParticipant'
            - type: 'null'
        contract:
          anyOf:
            - $ref: '#/components/schemas/InvoiceContractInfo'
            - type: 'null'
        invoiceLink:
          anyOf:
            - type: string
            - type: 'null'
          title: Invoicelink
        documents:
          items:
            $ref: '#/components/schemas/InvoiceDocumentInfo'
          type: array
          title: Documents
        paidAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Paidat
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      required:
        - id
        - amount
        - currency
        - status
        - createdAt
        - updatedAt
      title: InvoiceResponse
      description: Invoice response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserAddress:
      properties:
        streetAddress:
          anyOf:
            - type: string
            - type: 'null'
          title: Streetaddress
        addressLine2:
          anyOf:
            - type: string
            - type: 'null'
          title: Addressline2
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        state:
          anyOf:
            - type: string
            - type: 'null'
          title: State
        country:
          anyOf:
            - $ref: '#/components/schemas/CountryCode'
            - type: 'null'
        zip:
          anyOf:
            - type: string
            - type: 'null'
          title: Zip
      type: object
      title: UserAddress
      description: >-
        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.
    InvoiceTransactionInfo:
      properties:
        onchainTransactionId:
          type: string
          title: Onchaintransactionid
        amount:
          type: number
          title: Amount
        txHash:
          type: string
          title: Txhash
        type:
          type: string
          title: Type
        createdAt:
          type: string
          format: date-time
          title: Createdat
      type: object
      required:
        - onchainTransactionId
        - amount
        - txHash
        - type
        - createdAt
      title: InvoiceTransactionInfo
      description: Minimal transaction info embedded in invoice response.
    Currency:
      type: string
      enum:
        - USD
        - EUR
        - GBP
        - JPY
        - CHF
        - CAD
        - AUD
        - NZD
        - SEK
        - NOK
        - AED
        - HKD
      title: Currency
      description: Supported invoice/contract currencies. G10 majors + AED/HKD.
    IBANAccountDetails-Output:
      properties:
        bankName:
          type: string
          title: Bankname
        bankAddress:
          anyOf:
            - type: string
            - type: 'null'
          title: Bankaddress
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        accountHolderType:
          $ref: '#/components/schemas/AlignAccountHolderType'
        accountHolderFirstName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderfirstname
        accountHolderLastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderlastname
        accountHolderBusinessName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderbusinessname
        accountHolderAddress:
          anyOf:
            - $ref: '#/components/schemas/UserAddress'
            - type: 'null'
        relationship:
          anyOf:
            - $ref: '#/components/schemas/app__schemas__base__ContactRelationship'
            - type: 'null'
        paymentReference:
          anyOf:
            - type: string
            - type: 'null'
          title: Paymentreference
        accountType:
          type: string
          enum:
            - sepa
            - uaefts
          title: Accounttype
          default: sepa
        ibanNumber:
          type: string
          title: Ibannumber
        bic:
          anyOf:
            - type: string
            - type: 'null'
          title: Bic
        beneficiaryName:
          anyOf:
            - type: string
            - type: 'null'
          title: Beneficiaryname
          description: Frontend-only alias derived from account holder fields.
          readOnly: true
      type: object
      required:
        - bankName
        - accountHolderType
        - ibanNumber
        - beneficiaryName
      title: IBANAccountDetails
      description: IBAN (SEPA) external account.
    USExternalAccountDetails-Output:
      properties:
        bankName:
          type: string
          title: Bankname
        bankAddress:
          anyOf:
            - type: string
            - type: 'null'
          title: Bankaddress
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        accountHolderType:
          $ref: '#/components/schemas/AlignAccountHolderType'
        accountHolderFirstName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderfirstname
        accountHolderLastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderlastname
        accountHolderBusinessName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderbusinessname
        accountHolderAddress:
          anyOf:
            - $ref: '#/components/schemas/UserAddress'
            - type: 'null'
        relationship:
          anyOf:
            - $ref: '#/components/schemas/app__schemas__base__ContactRelationship'
            - type: 'null'
        paymentReference:
          anyOf:
            - type: string
            - type: 'null'
          title: Paymentreference
        accountType:
          type: string
          enum:
            - ach
            - fedwire
          title: Accounttype
          default: ach
        us:
          $ref: '#/components/schemas/USAccountDetails'
        beneficiaryName:
          anyOf:
            - type: string
            - type: 'null'
          title: Beneficiaryname
          description: Frontend-only alias derived from account holder fields.
          readOnly: true
      type: object
      required:
        - bankName
        - accountHolderType
        - us
        - beneficiaryName
      title: USExternalAccountDetails
      description: US domestic (ACH) external account.
    SwiftAccountDetails-Output:
      properties:
        bankName:
          type: string
          title: Bankname
        bankAddress:
          anyOf:
            - type: string
            - type: 'null'
          title: Bankaddress
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        accountHolderType:
          $ref: '#/components/schemas/AlignAccountHolderType'
        accountHolderFirstName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderfirstname
        accountHolderLastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderlastname
        accountHolderBusinessName:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountholderbusinessname
        accountHolderAddress:
          anyOf:
            - $ref: '#/components/schemas/UserAddress'
            - type: 'null'
        relationship:
          anyOf:
            - $ref: '#/components/schemas/app__schemas__base__ContactRelationship'
            - type: 'null'
        paymentReference:
          anyOf:
            - type: string
            - type: 'null'
          title: Paymentreference
        accountType:
          type: string
          const: swift
          title: Accounttype
          default: swift
        swift:
          $ref: '#/components/schemas/SwiftDetails'
        beneficiaryName:
          anyOf:
            - type: string
            - type: 'null'
          title: Beneficiaryname
          description: Frontend-only alias derived from account holder fields.
          readOnly: true
      type: object
      required:
        - bankName
        - accountHolderType
        - swift
        - beneficiaryName
      title: SwiftAccountDetails
      description: SWIFT (international wire) external account.
    ContactWalletResponse:
      properties:
        address:
          type: string
          title: Address
        chainId:
          anyOf:
            - type: string
            - type: 'null'
          title: Chainid
        currency:
          type: string
          title: Currency
          default: EUR
        internal:
          type: boolean
          title: Internal
          default: false
      type: object
      required:
        - address
      title: ContactWalletResponse
      description: Wallet payment method block used by invoice/payment method schemas.
    EmailAccountInput:
      properties:
        accountType:
          type: string
          const: email
          title: Accounttype
          default: email
        email:
          type: string
          title: Email
      type: object
      required:
        - email
      title: EmailAccountInput
      description: Email contact input.
    InvoiceStatus:
      type: string
      enum:
        - draft
        - sent
        - paid
        - cancelled
        - client_paid
        - client_declined
      title: InvoiceStatus
      description: Invoice status.
    InvoiceParticipant:
      properties:
        email:
          type: string
          title: Email
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
        address:
          anyOf:
            - $ref: '#/components/schemas/UserAddress'
            - type: 'null'
      type: object
      required:
        - email
      title: InvoiceParticipant
      description: Minimal participant info for invoice response.
    InvoiceContractInfo:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        type:
          $ref: '#/components/schemas/ContractType'
        status:
          $ref: '#/components/schemas/ContractStatus'
        period:
          anyOf:
            - type: string
            - type: 'null'
          title: Period
        isRecurring:
          type: boolean
          title: Isrecurring
        activationAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Activationat
        expirationAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expirationat
      type: object
      required:
        - id
        - type
        - status
        - isRecurring
      title: InvoiceContractInfo
      description: Minimal contract info embedded in invoice response.
    InvoiceDocumentInfo:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        key:
          type: string
          title: Key
      type: object
      required:
        - id
        - name
        - key
      title: InvoiceDocumentInfo
      description: |-
        Document attached to an invoice.

        `key` is a short-lived signed token. To download call
        GET /documents/download/{id}?key={key}.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    CountryCode:
      type: string
      enum:
        - AF
        - AX
        - AL
        - DZ
        - AS
        - AD
        - AO
        - AI
        - AQ
        - AG
        - AR
        - AM
        - AW
        - AU
        - AT
        - AZ
        - BS
        - BH
        - BD
        - BB
        - BY
        - BE
        - BZ
        - BJ
        - BM
        - BT
        - BO
        - BQ
        - BA
        - BW
        - BV
        - BR
        - IO
        - BN
        - BG
        - BF
        - BI
        - CV
        - KH
        - CM
        - CA
        - KY
        - CF
        - TD
        - CL
        - CN
        - CX
        - CC
        - CO
        - KM
        - CG
        - CD
        - CK
        - CR
        - CI
        - HR
        - CU
        - CW
        - CY
        - CZ
        - DK
        - DJ
        - DM
        - DO
        - EC
        - EG
        - SV
        - GQ
        - ER
        - EE
        - SZ
        - ET
        - FK
        - FO
        - FJ
        - FI
        - FR
        - GF
        - PF
        - TF
        - GA
        - GM
        - GE
        - DE
        - GH
        - GI
        - GR
        - GL
        - GD
        - GP
        - GU
        - GT
        - GG
        - GN
        - GW
        - GY
        - HT
        - HM
        - VA
        - HN
        - HK
        - HU
        - IS
        - IN
        - ID
        - IR
        - IQ
        - IE
        - IM
        - IL
        - IT
        - JM
        - JP
        - JE
        - JO
        - KZ
        - KE
        - KI
        - KP
        - KR
        - KW
        - KG
        - LA
        - LV
        - LB
        - LS
        - LR
        - LY
        - LI
        - LT
        - LU
        - MO
        - MG
        - MW
        - MY
        - MV
        - ML
        - MT
        - MH
        - MQ
        - MR
        - MU
        - YT
        - MX
        - FM
        - MD
        - MC
        - MN
        - ME
        - MS
        - MA
        - MZ
        - MM
        - NA
        - NR
        - NP
        - NL
        - NC
        - NZ
        - NI
        - NE
        - NG
        - NU
        - NF
        - MK
        - MP
        - 'NO'
        - OM
        - PK
        - PW
        - PS
        - PA
        - PG
        - PY
        - PE
        - PH
        - PN
        - PL
        - PT
        - PR
        - QA
        - RE
        - RO
        - RU
        - RW
        - BL
        - SH
        - KN
        - LC
        - MF
        - PM
        - VC
        - WS
        - SM
        - ST
        - SA
        - SN
        - RS
        - SC
        - SL
        - SG
        - SX
        - SK
        - SI
        - SB
        - SO
        - ZA
        - GS
        - SS
        - ES
        - LK
        - SD
        - SR
        - SJ
        - SE
        - CH
        - SY
        - TW
        - TJ
        - TZ
        - TH
        - TL
        - TG
        - TK
        - TO
        - TT
        - TN
        - TR
        - TM
        - TC
        - TV
        - UG
        - UA
        - AE
        - GB
        - US
        - UM
        - UY
        - UZ
        - VU
        - VE
        - VN
        - VG
        - VI
        - WF
        - EH
        - YE
        - ZM
        - ZW
      title: CountryCode
      description: ISO 3166-1 alpha-2 country codes.
    AlignAccountHolderType:
      type: string
      enum:
        - individual
        - business
      title: AlignAccountHolderType
      description: Account holder type.
    app__schemas__base__ContactRelationship:
      type: string
      enum:
        - charity
        - commercial_investment
        - corporate_card
        - credit_card
        - dividend
        - family
        - financial_services
        - good_sold
        - goods_bought
        - government
        - insurance
        - intergroup_transfer
        - intra_group_dividends
        - information_technology
        - leasing
        - loan_charges
        - merchant_settlement
        - mobile_wallet
        - none
        - non_resident_transfer_between_accounts
        - pension
        - personal_expenses
        - prepaid_cards
        - professional
        - rental
        - resident_transfer_between_accounts
        - salaries
        - telecommunications
        - travel
        - utility_bill
      title: ContactRelationship
      description: >-
        Unified contact relationship / transfer purpose.


        Values match Align AlignTransferPurpose (the more granular set).

        Mapped to Swipelux AccountHolderRelationship via
        ``swipelux_relationship``.
    USAccountDetails:
      properties:
        accountNumber:
          type: string
          title: Accountnumber
        routingNumber:
          type: string
          title: Routingnumber
      type: object
      required:
        - accountNumber
        - routingNumber
      title: USAccountDetails
      description: US domestic account details (ACH).
    SwiftDetails:
      properties:
        accountNumber:
          type: string
          title: Accountnumber
        routingNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Routingnumber
        bic:
          type: string
          title: Bic
      type: object
      required:
        - accountNumber
        - bic
      title: SwiftDetails
      description: SWIFT (international wire) account details.
    ContractType:
      type: string
      enum:
        - service
        - employment
        - nda
        - contractor
        - default_contractor
        - custom
        - vendor
        - milestone
        - msa
        - other
      title: ContractType
      description: Contract type.
    ContractStatus:
      type: string
      enum:
        - pending_approval_by_contractor
        - pending_approval_by_client
        - active
        - completed
        - cancelled
        - paused
      title: ContractStatus
      description: Contract status.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      x-default: Bearer <token>

````