Sign in
invoices

Create invoice from contract

post/api/v1/documents/contracts/{contract_id}/create-invoice

Path parameters

contract_idstring uuid required

Headers

x-api-keystring nullable

Request body

commentstring nullable
invoicePrefixstring

Prefix for auto-generated invoice_number, e.g. "INV" → "INV-0001".

periodinteger nullable
addItemsobject[]

Response

Successful Response

idstring uuid required
onchainTransactionIdstring nullable
amountstring required
discountstring 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.

commentstring nullable
emailMessagestring nullable
invoiceNumberstring nullable
periodNumberinteger nullable
issuedDatestring date nullable
dueDatestring date nullable
itemsobject[]
status'draft' | 'sent' | 'paid' | 'cancelled' | 'client_paid' | 'client_declined' required

Invoice status.

paidAtstring date-time nullable
createdAtstring date-time required
updatedAtstring date-time required

Changes

Changed in 1 of the 4 revisions of this API.102623

  • 7ed1b58c5607102623See the full diff
    • ▲

      the response property paymentMethods/items/anyOf[subschema #1: IBANAccountDetails]/ibanNumber became optional for the status 201

      response-property-became-optional

    • ▲

      the response property paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/us/accountNumber became optional for the status 201

      response-property-became-optional

    • ▲

      the response property paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/us/routingNumber became optional for the status 201

      response-property-became-optional

    • ▲

      the response property paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/swift/accountNumber became optional for the status 201

      response-property-became-optional

    • ▲

      the response property paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/swift/bic became optional for the status 201

      response-property-became-optional

    • ▲

      response property paymentMethods/items/anyOf[subschema #1: IBANAccountDetails]/ibanNumber list-of-types was widened by adding types null to media type application/json of response 201

      response-property-list-of-types-widened

    • ▲

      response property paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/us/accountNumber list-of-types was widened by adding types null to media type application/json of response 201

      response-property-list-of-types-widened

    • ▲

      response property paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/us/routingNumber list-of-types was widened by adding types null to media type application/json of response 201

      response-property-list-of-types-widened

    • ▲

      response property paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/swift/accountNumber list-of-types was widened by adding types null to media type application/json of response 201

      response-property-list-of-types-widened

    • ▲

      response property paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/swift/bic list-of-types was widened by adding types null to media type application/json of response 201

      response-property-list-of-types-widened

    • ●

      removed the request property contractorAddress

      request-property-removed

    • ●

      removed the request property periodStart

      request-property-removed

    • ●

      removed the optional property invoiceLink from the response with the 201 status

      response-optional-property-removed

    • ●

      added the new ADA enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new ARB enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new AVAX enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new BNB enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new BRL enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new DAI enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new DOGE enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new DOT enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new ETH enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new GRAM enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new LINK enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new LTC enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new MATIC enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new MXN enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new NEAR enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new OP enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new SOL enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new SUI enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new TRX enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new USDC enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new USDT enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new XRP enum value to the currency response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new optional request property period

      new-optional-request-property

    • ○

      added the optional property paymentMethods/items/anyOf[subschema #1: IBANAccountDetails]/businessIndustry to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/businessIndustry to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/us/bic to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/businessIndustry to the response with the 201 status

      response-optional-property-added

    • ○

      added BankAddressDetails to the paymentMethods/items/anyOf[subschema #1: IBANAccountDetails]/bankAddress response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added BankAddressDetails to the paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/bankAddress response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added BankAddressDetails to the paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/bankAddress response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added ContactRelationship to the paymentMethods/items/anyOf[subschema #1: IBANAccountDetails]/relationship response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added ContactRelationship to the paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/relationship response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added ContactRelationship to the paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/relationship response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      added PixAccountDetails-Output LocalRailAccountDetails-Output ProviderUsdAccountDetails-Output to the paymentMethods/items/ response property anyOf list for the response status 201

      response-property-any-of-added

    • ○

      removed app__schemas__base__ContactRelationship from the paymentMethods/items/anyOf[subschema #1: IBANAccountDetails]/relationship response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed app__schemas__base__ContactRelationship from the paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/relationship response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed app__schemas__base__ContactRelationship from the paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/relationship response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed subschema #1 from the paymentMethods/items/anyOf[subschema #1: IBANAccountDetails]/bankAddress response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed subschema #1 from the paymentMethods/items/anyOf[subschema #2: USExternalAccountDetails]/bankAddress response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed subschema #1 from the paymentMethods/items/anyOf[subschema #3: SwiftAccountDetails]/bankAddress response property anyOf list for the response status 201

      response-property-any-of-removed

    • ○

      removed the custom enum value from the contract/anyOf[subschema #1: InvoiceContractInfo]/type response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the default_contractor enum value from the contract/anyOf[subschema #1: InvoiceContractInfo]/type response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the milestone enum value from the contract/anyOf[subschema #1: InvoiceContractInfo]/type response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the pending_approval_by_client enum value from the contract/anyOf[subschema #1: InvoiceContractInfo]/status response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the pending_approval_by_contractor enum value from the contract/anyOf[subschema #1: InvoiceContractInfo]/status response property for the response status 201

      response-property-enum-value-removed

    This revision also has 47 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog