Skip to content

Rippling: Retrieve R&D credits

Rippling payrollApi.getCreditsRnd: arguments, response, policy and SDK examples.

← Payroll API operations · Get started

Operation rippling.payroll_api.get_credits_rnd

Provider route: GET /platform/api/credits/rnd. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["payrollApi"]["getCreditsRnd"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.payrollApi.getCreditsRnd(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.payroll_api.get_credits_rnd(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.companystringRequired within parent
query.einstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
creditsarrayOptional
credits[]ModelEach itemExpand Retrieve R&D credits — response body — credits item
errorMessagestringOptionalError message if the credits were not added

Referenced models: Retrieve R&D credits — response body — credits item

Retrieve R&D credits — response body — credits item
FieldTypePresenceDescription and constraints
$objectRootAn R&D Credit object
companystringOptionalRippling ID of the company
differentEinstringOptionalIf the filing is done for a different EIN, this field will contain the value of that Ein

This is the company the credits came from (Can be any EIN)

Please note that the credits will be added to “ein” entity only.
einstringRequired within parentEin of the company the credits need to be applied to.

Note: This needs to be sent even though the company has only one legal entity

This EIN does need to exist within Rippling and Rippling will throw an error message if the EIN doesn’t match an EIN present in Rippling.
endDatestringRequired within parentThis is the last date the financial year of the year for which filing is done. Date format is MM/DD/YYYY

Typically it’s 12/31/YYYY
returnFilingDatestringRequired within parentThis is the date the company filed to the IRS. Date format is MM/DD/YYYY
Format: date
returnTypestringOptionalThis field denotes the type of return. Available values:

'Form 1040 - Sole Proprietorship'
'Form 1065 - Partnership'
'Form 1120 - Corporate Tax Return'
'Form 1120S - S-Corp'
'Form 1120-F - Foreign Corporation'

Known values: 1040, 1065, 1120, 1120S, 1120F
totalCreditsstringRequired within parentThe value of the credits granted by IRS.
useDifferentEinbooleanOptionalIf the filing is done for a different EIN, this field should be set to True.

This indicates that the company is applying to a different EIN than the original 6765 filing

SDK function policy ID: rippling.payroll_api.get_credits_rnd. Catalog operation: payroll-api.get-credits-rnd. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.