Agreement Field Mappings
Agreements sync from Kleer to HubSpot Subscriptions. Recurring rows and first-invoice rows are synced as HubSpot Line Items and associated with the subscription.
Available Fields
| Label | Kleer Field | Notes |
|---|---|---|
| Foreign ID | foreign-id |
External reference ID |
| Revision number | revision-nr |
|
| Client ref. (ID) | client-ref.id |
Associated client's Kleer ID |
| Description | description |
Agreement description |
| Start date | start-date |
|
| Start invoice date | start-invoice-date |
Date of first invoice |
| End date | end-date |
|
| Renewal notification date | renewal-notification-date |
|
| Your reference | your-reference |
Customer's reference |
| Our reference (user ID) | our-reference.id |
Kleer user ID |
| Currency | currency |
|
| Payment days | payment-days |
Days until payment is due |
| Invoice interval (months) | invoice-interval-months |
Billing frequency in months |
| Invoice day | invoice-day |
See enum values below |
| PO number | po-nr |
Purchase order number |
| Agreement number | agreement-nr |
|
| Subscription number | subscription-nr |
|
| Notes | notes |
Computed Fields
These fields are calculated by the integration:
| Label | Field | Description |
|---|---|---|
| Monthly recurring revenue | _mrr |
Calculated from recurring rows total and invoice interval |
| Annual recurring revenue | _arr |
MRR multiplied by 12 |
| Billing frequency | _billing_frequency |
Derived from invoice-interval-months — see enum below |
| Status | _status |
Derived from start/end dates — see enum below |
Enum Values
Invoice day (invoice-day)
| Value | Label |
|---|---|
INVOICE_AT_START |
Invoice at start |
PAY_AT_START |
Pay at start |
INVOICE_AT_END |
Invoice at end |
INVOICE_AT_START_MONTH |
Invoice at start of month |
INVOICE_60_DAYS_PRIOR_TO_PERIOD_START |
Invoice 60 days prior |
INVOICE_AT_END_MONTH |
Invoice at end of month |
INVOICE_ONE_DAY_PRIOR_TO_PERIOD_START |
Invoice 1 day prior |
INVOICE_FIVE_DAYS_PRIOR_TO_PERIOD_START |
Invoice 5 days prior |
Billing frequency (_billing_frequency)
Automatically derived from invoice-interval-months:
| Value | Label | Interval |
|---|---|---|
weekly |
Weekly | — |
biweekly |
Biweekly | — |
monthly |
Monthly | 1 month |
quarterly |
Quarterly | 3 months |
per_six_months |
Per six months | 6 months |
annually |
Annually | 12 months |
per_two_years |
Per two years | 24 months |
per_three_years |
Per three years | 36 months |
per_four_years |
Per four years | 48 months |
per_five_years |
Per five years | 60 months |
Status (_status)
Derived from the agreement's start and end dates:
| Value | Label | Condition |
|---|---|---|
active |
Active | Start date is in the past and end date is in the future (or not set) |
expired |
Expired | End date is in the past |
scheduled |
Scheduled | Start date is in the future |
Default HubSpot Object
Subscriptions — Can be changed from the object type selector.
Notes
- Recurring line items automatically get
recurringbillingfrequencyset based on the agreement'sinvoice-interval-months - Associations are automatically created to the related company (via
client-ref.id) if it exists in HubSpot - Subscriptions are created with
hs_invoice_creation: offsince invoicing is managed by Kleer