---
title: "Create invoice from contract"
method: POST
path: "/api/v1/documents/contracts/{contract_id}/create-invoice"
tags: ["invoices"]
---

# Create invoice from contract

`POST /api/v1/documents/contracts/{contract_id}/create-invoice`

## Path parameters

- `contract_id` string, uuid, required

## Headers

- `x-api-key` string, nullable

## Request body

- CreateInvoiceFromContractRequest — Create a one-off invoice for a contract's current billing period. Either party may call it; the invoice always flows from the contract's contractor to its client. Line items default to the contract's terms.
  - `amount` union
    - number
    - string
  - `comment` string, nullable
  - `invoicePrefix` string — Prefix for auto-generated invoice_number, e.g. "INV" → "INV-0001".
  - `period` integer, nullable
  - `addItems` object[]

## Response `201`

Successful Response

- InvoiceResponse — Invoice response. Carries no download link: the PDF is rendered on request at ``GET /public/invoices/{id}/pdf``. Add ``?details=<index into paymentMethods>`` for the copy naming that payment method; without it the copy carries no payment details.
  - `id` string, uuid, required
  - `onchainTransactionId` string, nullable
  - `transaction` InvoiceTransactionInfo — Minimal transaction info embedded in invoice response.
    - `onchainTransactionId` string, required
    - `amount` number, required
    - `txHash` string, required
    - `type` string, required
    - `createdAt` string, date-time, required
  - `amount` string, required
  - `discount` string, nullable
  - `currency` 'USD' | 'EUR' | 'GBP' | 'JPY' | 'CHF' | 'CAD' | 'AUD' | 'NZD' | 'SEK' | 'NOK' | 'AED' | 'HKD' | 'BRL' | 'MXN' | 'USDC' | 'USDT' | 'DAI' | 'SOL' | 'BTC' | 'ETH' | 'NEAR' | 'BNB' | 'XRP' | 'ADA' | 'DOGE' | 'TRX' | 'GRAM' | 'AVAX' | 'MATIC' | 'DOT' | 'LTC' | 'LINK' | 'ARB' | 'OP' | 'SUI', required — Supported invoice/contract currencies. G10 majors + AED/HKD, plus popular crypto tokens.
  - `comment` string, nullable
  - `emailMessage` string, nullable
  - `invoiceNumber` string, nullable
  - `periodNumber` integer, nullable
  - `issuedDate` string, date, nullable
  - `dueDate` string, date, nullable
  - `items` object[]
  - `paymentMethods` union[]
    - union
      - IBANAccountDetailsOutput — IBAN (SEPA) external account.
        - `bankName` string, required
        - `bankAddress` BankAddressDetails — The beneficiary bank's own address, kept apart from the holder's. Read/storage shape: only the street is guaranteed, because rows saved before this was structured hold a single free-text line that validates into ``address_line1`` alone. New input goes through BankAddressInput, which requires everything the banking provider does.
          - `addressLine1` string, required
          - `city` string, nullable
          - `state` string, nullable
          - `postalCode` string, nullable
          - `country` string, nullable
        - `currency` string, nullable
        - `accountHolderType` 'individual' | 'business', required — Account holder type.
        - `accountHolderFirstName` string, nullable
        - `accountHolderLastName` string, nullable
        - `accountHolderBusinessName` string, nullable
        - `accountHolderAddress` UserAddress — 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.
          - `streetAddress` string, nullable
          - `addressLine2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `country` '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' — ISO 3166-1 alpha-2 country codes.
          - `zip` string, nullable
        - `relationship` 'employee' | 'contractor' | 'vendor' | 'subsidiary' | 'merchant' | 'customer' | 'landlord' | 'family' | 'other' | 'self' — How a payout contact relates to the user. The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: ``SELF`` marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see ``SwipeluxRecipients._recipient_relationship`` — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.
        - `businessIndustry` string, nullable — 6-digit NAICS 2022 industry code for business recipients. Required by Swipelux before US ACH payout destinations of business recipients can be activated; ignored for individual recipients.
        - `paymentReference` string, nullable
        - `accountType` 'sepa' | 'uaefts'
        - `ibanNumber` string, nullable
        - `bic` string, nullable
        - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
      - USExternalAccountDetailsOutput — US domestic (ACH) external account.
        - `bankName` string, required
        - `bankAddress` BankAddressDetails — The beneficiary bank's own address, kept apart from the holder's. Read/storage shape: only the street is guaranteed, because rows saved before this was structured hold a single free-text line that validates into ``address_line1`` alone. New input goes through BankAddressInput, which requires everything the banking provider does.
          - `addressLine1` string, required
          - `city` string, nullable
          - `state` string, nullable
          - `postalCode` string, nullable
          - `country` string, nullable
        - `currency` string, nullable
        - `accountHolderType` 'individual' | 'business', required — Account holder type.
        - `accountHolderFirstName` string, nullable
        - `accountHolderLastName` string, nullable
        - `accountHolderBusinessName` string, nullable
        - `accountHolderAddress` UserAddress — 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.
          - `streetAddress` string, nullable
          - `addressLine2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `country` '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' — ISO 3166-1 alpha-2 country codes.
          - `zip` string, nullable
        - `relationship` 'employee' | 'contractor' | 'vendor' | 'subsidiary' | 'merchant' | 'customer' | 'landlord' | 'family' | 'other' | 'self' — How a payout contact relates to the user. The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: ``SELF`` marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see ``SwipeluxRecipients._recipient_relationship`` — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.
        - `businessIndustry` string, nullable — 6-digit NAICS 2022 industry code for business recipients. Required by Swipelux before US ACH payout destinations of business recipients can be activated; ignored for individual recipients.
        - `paymentReference` string, nullable
        - `accountType` 'ach' | 'fedwire'
        - `us` USAccountDetails, required — US domestic account details (ACH).
          - `accountNumber` string, nullable
          - `routingNumber` string, nullable
          - `bic` string, nullable
        - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
      - SwiftAccountDetailsOutput — SWIFT (international wire) external account.
        - `bankName` string, required
        - `bankAddress` BankAddressDetails — The beneficiary bank's own address, kept apart from the holder's. Read/storage shape: only the street is guaranteed, because rows saved before this was structured hold a single free-text line that validates into ``address_line1`` alone. New input goes through BankAddressInput, which requires everything the banking provider does.
          - `addressLine1` string, required
          - `city` string, nullable
          - `state` string, nullable
          - `postalCode` string, nullable
          - `country` string, nullable
        - `currency` string, nullable
        - `accountHolderType` 'individual' | 'business', required — Account holder type.
        - `accountHolderFirstName` string, nullable
        - `accountHolderLastName` string, nullable
        - `accountHolderBusinessName` string, nullable
        - `accountHolderAddress` UserAddress — 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.
          - `streetAddress` string, nullable
          - `addressLine2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `country` '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' — ISO 3166-1 alpha-2 country codes.
          - `zip` string, nullable
        - `relationship` 'employee' | 'contractor' | 'vendor' | 'subsidiary' | 'merchant' | 'customer' | 'landlord' | 'family' | 'other' | 'self' — How a payout contact relates to the user. The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: ``SELF`` marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see ``SwipeluxRecipients._recipient_relationship`` — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.
        - `businessIndustry` string, nullable — 6-digit NAICS 2022 industry code for business recipients. Required by Swipelux before US ACH payout destinations of business recipients can be activated; ignored for individual recipients.
        - `paymentReference` string, nullable
        - `accountType` 'swift'
        - `swift` SwiftDetails, required — SWIFT (international wire) account details.
          - `accountNumber` string, nullable
          - `routingNumber` string, nullable
          - `bic` string, nullable
        - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
      - PixAccountDetailsOutput — Brazil PIX external account.
        - `bankName` string, required
        - `bankAddress` BankAddressDetails — The beneficiary bank's own address, kept apart from the holder's. Read/storage shape: only the street is guaranteed, because rows saved before this was structured hold a single free-text line that validates into ``address_line1`` alone. New input goes through BankAddressInput, which requires everything the banking provider does.
          - `addressLine1` string, required
          - `city` string, nullable
          - `state` string, nullable
          - `postalCode` string, nullable
          - `country` string, nullable
        - `currency` string, nullable
        - `accountHolderType` 'individual' | 'business', required — Account holder type.
        - `accountHolderFirstName` string, nullable
        - `accountHolderLastName` string, nullable
        - `accountHolderBusinessName` string, nullable
        - `accountHolderAddress` UserAddress — 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.
          - `streetAddress` string, nullable
          - `addressLine2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `country` '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' — ISO 3166-1 alpha-2 country codes.
          - `zip` string, nullable
        - `relationship` 'employee' | 'contractor' | 'vendor' | 'subsidiary' | 'merchant' | 'customer' | 'landlord' | 'family' | 'other' | 'self' — How a payout contact relates to the user. The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: ``SELF`` marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see ``SwipeluxRecipients._recipient_relationship`` — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.
        - `businessIndustry` string, nullable — 6-digit NAICS 2022 industry code for business recipients. Required by Swipelux before US ACH payout destinations of business recipients can be activated; ignored for individual recipients.
        - `paymentReference` string, nullable
        - `accountType` 'pix'
        - `pix` PixDetails, required — Brazil PIX account details.
          - `pixKey` string, nullable
          - `accountNumber` string, nullable
        - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
      - LocalRailAccountDetailsOutput — Local payment rail account details.
        - `bankName` string, required
        - `bankAddress` BankAddressDetails — The beneficiary bank's own address, kept apart from the holder's. Read/storage shape: only the street is guaranteed, because rows saved before this was structured hold a single free-text line that validates into ``address_line1`` alone. New input goes through BankAddressInput, which requires everything the banking provider does.
          - `addressLine1` string, required
          - `city` string, nullable
          - `state` string, nullable
          - `postalCode` string, nullable
          - `country` string, nullable
        - `currency` string, nullable
        - `accountHolderType` 'individual' | 'business', required — Account holder type.
        - `accountHolderFirstName` string, nullable
        - `accountHolderLastName` string, nullable
        - `accountHolderBusinessName` string, nullable
        - `accountHolderAddress` UserAddress — 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.
          - `streetAddress` string, nullable
          - `addressLine2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `country` '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' — ISO 3166-1 alpha-2 country codes.
          - `zip` string, nullable
        - `relationship` 'employee' | 'contractor' | 'vendor' | 'subsidiary' | 'merchant' | 'customer' | 'landlord' | 'family' | 'other' | 'self' — How a payout contact relates to the user. The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: ``SELF`` marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see ``SwipeluxRecipients._recipient_relationship`` — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.
        - `businessIndustry` string, nullable — 6-digit NAICS 2022 industry code for business recipients. Required by Swipelux before US ACH payout destinations of business recipients can be activated; ignored for individual recipients.
        - `paymentReference` string, nullable
        - `accountType` 'spei' | 'pse' | 'transfers_3_0' | 'ukfps', required
        - `local` LocalRailDetails, required — Local payment rail account details for Swipelux regional accounts.
          - `accountNumber` string, nullable
          - `routingNumber` string, nullable
          - `paymentReference` string, nullable
        - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
      - ProviderUsdAccountDetailsOutput — One the banking provider USD account whose US details also carry its SWIFT BIC.
        - `bankName` string, required
        - `bankAddress` BankAddressDetails — The beneficiary bank's own address, kept apart from the holder's. Read/storage shape: only the street is guaranteed, because rows saved before this was structured hold a single free-text line that validates into ``address_line1`` alone. New input goes through BankAddressInput, which requires everything the banking provider does.
          - `addressLine1` string, required
          - `city` string, nullable
          - `state` string, nullable
          - `postalCode` string, nullable
          - `country` string, nullable
        - `currency` string, nullable
        - `accountHolderType` 'individual' | 'business', required — Account holder type.
        - `accountHolderFirstName` string, nullable
        - `accountHolderLastName` string, nullable
        - `accountHolderBusinessName` string, nullable
        - `accountHolderAddress` UserAddress — 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.
          - `streetAddress` string, nullable
          - `addressLine2` string, nullable
          - `city` string, nullable
          - `state` string, nullable
          - `country` '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' — ISO 3166-1 alpha-2 country codes.
          - `zip` string, nullable
        - `relationship` 'employee' | 'contractor' | 'vendor' | 'subsidiary' | 'merchant' | 'customer' | 'landlord' | 'family' | 'other' | 'self' — How a payout contact relates to the user. The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: ``SELF`` marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see ``SwipeluxRecipients._recipient_relationship`` — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.
        - `businessIndustry` string, nullable — 6-digit NAICS 2022 industry code for business recipients. Required by Swipelux before US ACH payout destinations of business recipients can be activated; ignored for individual recipients.
        - `paymentReference` string, nullable
        - `accountType` 'conduit'
        - `us` USAccountDetails — US domestic account details (ACH).
          - `accountNumber` string, nullable
          - `routingNumber` string, nullable
          - `bic` string, nullable
        - `beneficiaryName` string, nullable, required — Frontend-only alias derived from account holder fields.
      - ContactWalletResponse — Wallet payment method block used by invoice/payment method schemas.
        - `address` string, required
        - `chainId` string, nullable
        - `currency` string
        - `internal` boolean
      - EmailAccountInput — Email contact input.
        - `accountType` 'email'
        - `email` string, required
  - `status` 'draft' | 'sent' | 'paid' | 'cancelled' | 'client_paid' | 'client_declined', required — Invoice status.
  - `client` InvoiceParticipant — Minimal participant info for invoice response.
    - `email` string, required
    - `displayName` string, nullable
    - `address` UserAddress — 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.
      - `streetAddress` string, nullable
      - `addressLine2` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `country` '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' — ISO 3166-1 alpha-2 country codes.
      - `zip` string, nullable
  - `contractor` InvoiceParticipant — Minimal participant info for invoice response.
    - `email` string, required
    - `displayName` string, nullable
    - `address` UserAddress — 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.
      - `streetAddress` string, nullable
      - `addressLine2` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `country` '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' — ISO 3166-1 alpha-2 country codes.
      - `zip` string, nullable
  - `contract` InvoiceContractInfo — Minimal contract info embedded in invoice response.
    - `id` string, uuid, required
    - `type` 'service' | 'employment' | 'nda' | 'contractor' | 'vendor' | 'msa' | 'other', required — What the recurring agreement is for. A label only — it drives no logic.
    - `status` 'active' | 'paused' | 'completed' | 'cancelled', required — Contract status. A contract is live the moment it is created.
    - `period` string, nullable
    - `isRecurring` boolean, required
    - `activationAt` string, date-time, nullable
    - `expirationAt` string, date-time, nullable
  - `documents` InvoiceDocumentInfo[]
    - `id` string, uuid, required
    - `name` string, required
    - `key` string, required
  - `paidAt` string, date-time, nullable
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `422` — Validation Error

## Changes

- **2026-08-27** `7ed1b58c5607` — 10 breaking, 26 warning, 23 info
  - the response property `paymentMethods/items/anyOf[subschema #1: IBANAccountDetails]/ibanNumber` became optional for the status `201`
  - the response property `paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/us/accountNumber` became optional for the status `201`
  - the response property `paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/us/routingNumber` became optional for the status `201`
  - the response property `paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/swift/accountNumber` became optional for the status `201`
  - …55 more

[Change history](https://skmtc.dev/hevn-inc/apis/hevn-api/changes/api/v1/documents/contracts/:contract_id/create-invoice/post.md)

---

[API](https://skmtc.dev/hevn-inc/apis/hevn-api.md) · [All operations](https://skmtc.dev/hevn-inc/apis/hevn-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hevn-inc/hevn-api/revisions/7ed1b58c5607/schema)