pre_invoices

Detail /pre_invoices/{uuid}

Get one pre-invoice by UUID (/pre_invoices/{uuid}). Returns record with header amounts, client/lead, dates, status, line items, addresses, and plan-conditional fields. Reference entities use UUIDs only.

GET

/pre_invoices/{uuid}

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/pre_invoices/{uuid}?fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "record": {
    "adjustment": "<string>",
    "adminnote": "<string>",
    "amount_due": "<string>",
    "billing_address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "client": [
      {}
    ],
    "clientnote": "<string>",
    "contact": [
      {}
    ],
    "contact_person": [
      {}
    ],
    "converted_invoice": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "currency": {
      "name": "<string>",
      "symbol": "<string>"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "date": "<string>",
    "discount_percent": "<string>",
    "discount_total": "<string>",
    "discount_type": "<string>",
    "document_full_number": "<string>",
    "document_number": "<string>",
    "document_prefix": "<string>",
    "expiry_date": "<string>",
    "items": [
      {}
    ],
    "lead": [
      {}
    ],
    "organization": [
      {}
    ],
    "organization_name": "<string>",
    "sale_agent": [
      {}
    ],
    "shipping_address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "status": "<string>",
    "subtotal": "<string>",
    "terms": "<string>",
    "total": "<string>",
    "total_tax": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>",
    "warehouse": {
      "name": "<string>"
    }

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Path Parameters

uuidstringrequired

Record identifier (uuid)

Query Parameters

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

Single record

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team