Skip to main content
POST
/
api
/
v1
/
documents
/
contracts
/
invoices
/
ai_parse
AI parse invoice PDF and return invoice preview
curl --request POST \
  --url https://api.hevn.finance/api/v1/documents/contracts/invoices/ai_parse \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "<string>",
  "items": [
    {
      "name": "<string>",
      "quantity": 123,
      "price": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "comment": "<string>",
  "invoiceNumber": "<string>",
  "issuedDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "client": {
    "email": "<string>",
    "displayName": "<string>",
    "address": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>"
    }
  },
  "contractor": {
    "email": "<string>",
    "displayName": "<string>",
    "address": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>"
    }
  },
  "paymentMethods": [],
  "contract": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "documentName": "<string>",
    "documentLink": "<string>"
  },
  "invoiceLink": "<string>",
  "documents": []
}

Authorizations

​
Authorization
string
header
default:Bearer <token>
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-key
string | null

Query Parameters

​
document_id
string<uuid> | null

Response

Successful Response

​
id
string<uuid>
required
​
amount
number
required
​
currency
string
required
​
status
enum<string>
required

Invoice status.

Available options:
draft,
sent,
paid,
cancelled,
client_paid,
client_declined
​
items
PublicInvoiceItem · object[]
required
​
createdAt
string<date-time>
required
​
comment
string | null
​
invoiceNumber
string | null
​
issuedDate
string<date> | null
​
dueDate
string<date> | null
​
client
InvoiceParticipant · object

Minimal participant info for invoice response.

​
contractor
InvoiceParticipant · object

Minimal participant info for invoice response.

​
paymentMethods
(IBANAccountDetails · object | USExternalAccountDetails · object | SwiftAccountDetails · object | ContactWalletResponse · object | EmailAccountInput · object)[]

IBAN (SEPA) external account.

​
contract
PublicInvoiceContractInfo · object
​
invoiceLink
string | null
​
documents
InvoiceDocumentInfo · object[]