Credit Resource - Overview

A Credit is the core object in a portfolio. A Credit is always attached to one Project. Since a Credit represents a specific economic activity that maintains compliance with one Incentive Program, it also means that a Credit is always linked to one Incentive Program. One or more (or none) Utilizations can be attached to a credit, as Utilizations represent individual monetization events of a Credit.

Methods

The API supports the following methods for Credit resources:

• List:
  • Returns a list of Credits that match the API request parameters. For example, you can retrieve all Credits that the API Credentials have access to, or you can filter the list of Credits based on certain parameters. Learn More

Resource Representation

The following JSON structure shows the format of a Credit resource:

{
    "id": integer,
    "created_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z),
    "updated_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z),
    "status": string,
    "account": {
       "id": integer,
       "title": string,  
    },
    "created_by": {
       "id": integer,
       "first_name": string,
       "last_name": string,
       "email": string,
    },
    "project": {
       "id": integer,
       "title": string,   
    },
    "incentive_program": {
        "title":  string,   
        "jurisdiction": {
            "code": string,
            "name": string,
            "name_full": string,
            "level": string,
            "gps_lng": float,
            "gps_lat": float,
            "geographic_levels": {
                "country": {
                    "code": string,
                    "name": string,
                },
                "province": {
                    "code": string,
                    "name": string,
                },
                "county": {},
                "town": {},
            },
        },              
    },
    "incentive_settings": {
        "type": string,
        "carry_forward_years": integer,
        "legislative_framework": string,   
    },      
    "jurisdiction": {
        "code": string,
        "name": string,
        "name_full": string,
        "level": string,
        "gps_lng": float,
        "gps_lat": float,
        "geographic_levels": {
            "country": {
                "code": string,
                "name": string
           },
           "province": {
                "code": string,
                "name": string,
           },
           "county": {
                "code": string,
                "name": string,
           },
           "town": {
                "code": string,
                "name": string,        
           }
       }
    },
    "local_currency": {
        "code": string,
        "name": string,    
        "html_code": string,   
        "hex_code": string,
        "unicode": string,
    },
    "amount": {
        "status": string,
        "usd": {
           "gross_total": integer,
           "gross_utilized": integer,
           "gross_remaining": integer,
           "budgeted_exchange_rate": float,
           "estimated_discount_total": float,    
           "net_total": float,
        },
        "local": {
           "gross_total": float,
           "gross_utilized": float,
           "gross_remaining": float,
        },
    },
    "amount_initial_estimate": {
       "gross_total": float,
       "budgeted_exchange_rate": float,
       "estimated_discount_total": float,    
    },
    "variance": {
        "actual_to_initial": {
           "base_amount_due_to_exchange_rate": integer,
           "base_amount_due_to_local_amount": integer,
           "base_credit_amount_total": float
           "credit_amount_percentage": integer,
        }
    },
    "vintage_tax_year": integer,
    "legal_entity": {
        "id": integer,
        "title": string,
    },   
    "site": {
        "id": integer,
        "title": string,
        "address": string,
        "gps_lng": float,
        "gps_lat": float,
    },
    "notes_general": string,
    "group_name": string,
    "activity_budget": float,
    "qualified_expenditures": float,
    "rate_of_incentive": float,
    "type_of_work": string,
    "date_certification_initial": string (format YYYY-MM-DD),
    "date_certification_final_estimated": string (format YYYY-MM-DD),
    "date_certification_final_actual": string (format YYYY-MM-DD),
    "date_activity_start": date,
    "date_activity_end": date,
    "date_audit_start": date,
    "date_audit_end": date,
    "date_credit_expiration_date": string (format YYYY-MM-DD),
    "status_certification": string,
    "status_monetization": string,
    "status_audit": string,
    "status_credit": string,
    "status_notes": string,
    "custom_data_points":[
        {
            "id": integer,
            "name": string,
            "type": string,
            "value": string,
        }
    ],
    "utilizations":{
        "item_count": integer
    },
    "compliance": {
        "start_year": integer,
        "number_of_years": integer,
        "milestones":[
            {
                "id": integer,
                "name": string,
                "type": string,
                "status": string,
                "threshold_due_date": string (format YYYY-MM-DD),
                "threshold_value_expected": string,
                "threshold_value_actual": string,
                "alert_start_days": integer,
                "alert_start_date": string (format YYYY-MM-DD),
                "in_alert_phase": boolean,
                "note": string,
                "date_completed": string (format YYYY-MM-DD),,
                "completed_by_name": string,
                "documents_count": integer,
            }
        ]
    }
}

Resource Properties

The following table defines the properties that appear in this resource:

Key	Type	Definition
id	integer	The ID of the Credit.
created_at	string	The date and time that the Credit was created. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).
updated_at	string	The date and time that the Credit was last updated. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).
status	string	Overall status of the Credit. Potential values are: Pipeline, Active, Archived, Abandoned.
account	object	Contains information about the Incentify account this Credit is attached to.
account.id	integer	The ID of the Incentify account that owns this Credit.
account.title	string	The name of the Incentify account that owns this Credit.
created_by	object	Contains information about the user that loaded this Credit.
created_by.id	integer	The ID of the user that loaded this Credit.
created_by.first_name	string	The first name of the user who loaded this Credit.
created_by.last_name	string	The last name of the user who loaded this Credit.
created_by.email	string	The email address of the user who loaded this Credit.
project	object	Contains information about the Project.
project.id	integer	The ID of the Project.
project.title	string	The name of the Project.
incentive_program	object	Contains information about the Incentive Program this Credit is attached to.
incentive_program.id	integer	The ID of the Incentive Program.
incentive_program.title	string	The name of the Incentive Program.
incentive_program.jurisdiction	object	Contains information about the Jurisdiction of which the Incentive Program is attached to.
incentive_program.jurisdiction.id	integer	The ID of the Jurisdiction.
incentive_program.jurisdiction.code	string	The common "short code" of the state/country of the Jurisdiction.
incentive_program.jurisdiction.name	string	The name of the Jurisdiction (ie; California).
incentive_program.jurisdiction.name_full	string	The name of the Jurisdiction, including full geography (ie; California, United States).
incentive_program.jurisdiction.level	string	The geographic level of the Jurisdiction (Potential values: Country, Province, County, Town).
incentive_program.jurisdiction.gps_lng	float	The GPS longitude point of the Jurisdiction.
incentive_program.jurisdiction.gps_lat	float	The GPS latitude point of the Jurisdiction.
incentive_program.jurisdiction.google_place_id	string	The Google Place ID of the Jurisdiction.
incentive_program.jurisdiction.geographic_levels	object	Contains information about the "geographic levels" of this Jurisdiction (Country, Province, County, Town).
incentive_settings	object	Contains selections related to the Incentive Program specific only for this Credit.
incentive_settings.type	string	The program type, which values are configurable by the customer (ie; Refundable, Rebate, etc).
incentive_settings.carry_forward_years	integer	The number of year the program can be carried forward.
incentive_settings.legislative_framework	string	The type of the program framework (ie; Statutory, Discretionary or Negotiated).
jurisdiction	object	Contains information about the Jurisdiction of which the Credit is specific to. This MAY be different than the Jurisdiction the Incentive Program is attached to.
jurisdiction.id	integer	The ID of the Jurisdiction.
jurisdiction.code	string	The common "short code" of the state/country of the Jurisdiction.
jurisdiction.name	string	The name of the Jurisdiction (ie; California).
jurisdiction.name_full	string	The name of the Jurisdiction, including full geography (ie; California, United States).
jurisdiction.level	string	The geographic level of the Jurisdiction (Potential values: Country, Province, County, Town).
jurisdiction.gps_lng	float	The GPS longitude point of the Jurisdiction.
jurisdiction.gps_lat	float	The GPS latitude point of the Jurisdiction.
jurisdiction.google_place_id	string	The Google Place ID of the Jurisdiction.
jurisdiction.geographic_levels	object	Contains information about the "geographic levels" of this Jurisdiction (Country, Province, County, Town).
local_currency	object	Contains information about the Local Currency.
local_currency.code	string	The local currency code (ie; USD, CAD, EUR, etc)
local_currency.name	string	The local currency name (ie; United States Dollar, etc)
local_currency.html_code	string	The local currency HTML Code.
local_currency.hex_code	string	The local currency Hex Code.
local_currency.unicode	string	The local currency Unicode.
amount	object	Contains information about the Credit Amount.
amount.status	string	Can be either "Estimated" or "Final".
amount.usd	object	Contains information about the Credit Amount in USD.
amount.usd.gross_total	float	The total gross "face value" of the Credit in USD.
amount.usd.gross_utilized	float	The total amount utilized ("actualized") of gross "face value" of the Credit in USD.
amount.usd.gross_remaining	float	The total amount remaining (not utilized or "actualized") of gross "face value" of the Credit in USD.
amount.usd.budgeted_exchange_rate	float	The Budgeted Exchange Rate of the Credit.
amount.usd.estimated_discount_total	float	The total amount discounted (ie; due to fees, discount on transferable credit sales, etc) in USD.
amount.usd.net_total	float	The total net value of the Credit in USD (Gross minus the total amount discounted) in USD.
amount.local	object	Contains information about the Credit Amount in Local Currency.
amount.local.gross_total	float	The total gross "face value" of the Credit in Local Currency.
amount.local.gross_utilized	float	The total amount utilized ("actualized") of gross "face value" of the Credit in Local Currency.
amount.local.gross_remaining	float	The total amount remaining (not utilized or "actualized") of gross "face value" of the Credit in Local Currency.
amount_initial_estimate	object	Contains information about the initial estimate of the Credit Amount in Local Currency.
amount_initial_estimate.gross_total	float	The total initial estimate of the gross "face value" of the Credit in Local Currency.
amount_initial_estimate.gross_utilized	float	The total initial estimate of the amount utilized ("actualized") of gross "face value" of the Credit in Local Currency.
amount_initial_estimate.gross_remaining	float	The total initial estimate of the amount remaining (not utilized or "actualized") of gross "face value" of the Credit in Local Currency.
variance.actual_to_initial.base_amount_due_to_exchange_rate	integer	Variance in base/USD credit amount due to adjustments made to exchange rate from the initial estimate to the current/actual.
variance.actual_to_initial.base_amount_due_to_local_amount	integer	Variance in base/USD credit amount due to adjustments made to the local amount from the initial estimate to the current/actual.
variance.actual_to_initial.base_credit_amount_total	integer	Total variance in base/USD credit amount due to any adjustments made from the initial estimate to the current/actual.
variance.actual_to_initial.credit_amount_percentage	integer	Percentage representation of the total variance in base/USD credit amount due to any adjustments made from the initial estimate to the current/actual to the total initial value.
vintage_tax_year	integer	The first usable tax year of the Credit.
legal_entity	object	Contains information about the Legal Entity that is the "owner" of this Credit.
legal_entity.id	integer	The ID of the Legal Entity.
legal_entity.title	string	The company name of the Legal Entity.
site	object	Contains information about the Site (ie; location, such as a manufacturing facility) that this Credit is related to.
site.id	integer	The ID of the Site.
site.title	string	The name of the Site (ie; New York Headquarters, etc).
site.address	string	The street address of the Site.
site.gps_lng	float	The GPS longitude point.
site.gps_lat	float	The GPS latitude point.
notes_general	string	General credit notes.
group_name	string	Group name of credit.
activity_budget	float	The budget allocated to this Credit.
qualified_expenditures	float	The qualified expenditures of the activity budget for this Credit.
rate_of_incentive	float	The rate of incentive, in decimal format, of the activity budget for this Credit (ie; 0.3 means it is a 30% rate of incentive).
type_of_work	string	A short tag that defines what type of work this Credit is related to.
date_certification_initial	date	Initial certification date. Format is yyyy-mm-dd.
date_certification_final_estimated	date	Estimated final certification date. Format is yyyy-mm-dd.
date_certification_final_actual	date	Actual final certification date. Format is yyyy-mm-dd.
date_activity_start	date	The date the Credit activity will/did start. Format is yyyy-mm-dd.
date_activity_end	date	The date the Credit activity will/did end. Format is yyyy-mm-dd.
date_audit_start	date	The date the Credit audit will/did start. Format is yyyy-mm-dd.
date_audit_end	date	The date the Credit audit will/did end. Format is yyyy-mm-dd.
date_credit_expiration_date	date	The date the Credit will expire and can no longer be utilized/monetized. Format is yyyy-mm-dd.
status_certification	string	The phase (or status) of the Certification process. The possible values of this are entirely configurable by the customer.
status_monetization	string	The phase (or status) of the Monetization process. The possible values of this are entirely configurable by the customer.
status_audit	string	The phase (or status) of the Audit process. The possible values of this are entirely configurable by the customer.
status_credit	string	The phase (or status) of the Credit activity. This is different than the "status" property, which is a system-set, non-configurable status. The values of "Credit Status" are entirely configurable by the customer.
status_notes	string	Notes specific to the overall status of the Credit.
custom_data_points[]	list	Contains a list of custom data points (ie; not system default fields). Therefore, the format of each is included in the data. "id" is the unique ID of the custom data point. "name" is the visual name of the field. "type" is the format (ie; string, date, etc). "value" is the value entered for that custom data point.
utilizations	object	Contains summary information of Utilizations attached (see the Utilizations Resource).
utilizations.item_count	integer	The number of Utilizations attached to the Credit (if greater than zero, you can then make a request to the Utilizations Resource with the Credit ID to get a list of those Utilizations.
compliance.start_year	integer	The first year of the compliance milestones.
compliance.number_of_years	integer	The number of years the compliance milestones span starting from the first year of compliance.
compliance.milestones[]	list	Contains a list of compliance items set forth by the attached Compliance Template.
compliance.milestones[].id	integer	ID of the Compliance Item.
compliance.milestones[].name	string	Name of the Compliance Item (ie: New Jobs Created).
compliance.milestones[].type	string	Type, or format, of the Compliance Item (ie: number, currency, yesno, etc).
compliance.milestones[].status	string	Status values can be: Pending, In Progress, Completed and Cancelled
compliance.milestones[].threshold_due_date	date	Date the Compliance Item is due in order to remain compliant. Format is yyyy-mm-dd.
compliance.milestones[].threshold_value_expected	string	The value that must be achieved for the Compliance Item in order to remain compliant.
compliance.milestones[].threshold_value_actual	string	The actual value achieved, as compared to the expected threshold value.
compliance.milestones[].alert_start_days	integer	The actual value achieved, as compared to the expected threshold value.
compliance.milestones[].alert_start_date	date	The first date the "alert phase" should be evaluated. This is calculated as "alert_start_days" before the "threshold_due_date". Format is yyyy-mm-dd.
compliance.milestones[].in_alert_phase	boolean	Will be "true" if the date is after the "alert_start_date" and the milestone has (a) not met the threshold and (b) still active (ie; status is "pending" or "in progress").
compliance.milestones[].note	string	The general textual information in the "note" field managed by users.
compliance.milestones[].date_completed	string	The date a user marked the compliance milestone as "completed". Format is yyyy-mm-dd.
compliance.milestones[].completed_by_name	string	The name (first name last name) of the user who marked the compliance milestone as "completed".
compliance.milestones[].documents_count	string	The total number of documents uploaded to the compliance milestone.