BudgetPrograms
Defined in: src/budgets/client.gen.ts:8
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BudgetPrograms(
_core):BudgetPrograms
Defined in: src/budgets/client.gen.ts:9
Parameters
Section titled “Parameters”Returns
Section titled “Returns”BudgetPrograms
Methods
Section titled “Methods”get(
id,options?):Promise<{budget_blueprints:object[];budget_program_status:"BUDGET_PROGRAM_STATUS_ACTIVE"|"BUDGET_PROGRAM_STATUS_INACTIVE"|"BUDGET_PROGRAM_STATUS_DELETED";created_at:string;creator_user_id?:string|null;description?:string|null;employee_filter?: {employment_status?:"EMPLOYMENT_STATUS_ACTIVE"|"EMPLOYMENT_STATUS_INACTIVE"|"EMPLOYMENT_STATUS_PENDING"|null;employment_type?:"EMPLOYMENT_TYPE_FULL_TIME"|"EMPLOYMENT_TYPE_PART_TIME"|"EMPLOYMENT_TYPE_CONTRACTOR"|"EMPLOYMENT_TYPE_INTERN"|"EMPLOYMENT_TYPE_FREELANCE"|null; } |null;existing_budget_ids?:string[] |null;id:string;name:string;updated_at:string; }>
Defined in: src/budgets/client.gen.ts:18
Get Budget Program
Retrieves a Budget Program by ID
GET /v1/budget_programs/{id} — requires OAuth scope: budgets.readonly, budgets
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ budget_blueprints: object[]; budget_program_status: "BUDGET_PROGRAM_STATUS_ACTIVE" | "BUDGET_PROGRAM_STATUS_INACTIVE" | "BUDGET_PROGRAM_STATUS_DELETED"; created_at: string; creator_user_id?: string | null; description?: string | null; employee_filter?: { employment_status?: "EMPLOYMENT_STATUS_ACTIVE" | "EMPLOYMENT_STATUS_INACTIVE" | "EMPLOYMENT_STATUS_PENDING" | null; employment_type?: "EMPLOYMENT_TYPE_FULL_TIME" | "EMPLOYMENT_TYPE_PART_TIME" | "EMPLOYMENT_TYPE_CONTRACTOR" | "EMPLOYMENT_TYPE_INTERN" | "EMPLOYMENT_TYPE_FREELANCE" | null; } | null; existing_budget_ids?: string[] | null; id: string; name: string; updated_at: string; }>
list()
Section titled “list()”list(
query?,options?):PagePromise<{items:object[];next_cursor?:string|null; }>
Defined in: src/budgets/client.gen.ts:37
List Budget Programs
Lists Budget Programs belonging to this account
GET /v1/budget_programs — requires OAuth scope: budgets.readonly, budgets
Await for a single page, or for await to iterate items across all pages.
Parameters
Section titled “Parameters”query?
Section titled “query?”cursor?
Section titled “cursor?”string | null
limit?
Section titled “limit?”number | null
options?
Section titled “options?”Returns
Section titled “Returns”PagePromise<{ items: object[]; next_cursor?: string | null; }>