The expenses endpoint provides a list of every expense that the user making the request is allowed to see— across all projects to which the user belongs.
The response will contain an array of expense objects, sorted by the date attribute in descending order, available under the expenses key.
This endpoint returns structured Expense objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the expenses top-level JSON key. Please see our Response Format section for more information.
Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.
Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.
active_submission(ExpenseReportSubmission) - The active expense report the expense is submitted in. The response will includeactive_submission_id, which references the data in theexpense_report_submissionstop-level key.expense_budget(ExpenseBudget) - Retrieves the expense budget the expense is logged to. The response will includeexpense_budget_id, which references the data in theexpense_budgetstop-level key.expense_category(ExpenseCategory) - The category associated with the expense. The response will includeexpense_category, which references the data in theexpense_categoriestop-level key.external_references(ExternalReference) - Includes references to external integrations for this object.receipt(Attachments::ReceiptAttachment) - Information about receipts associated with this expense. The response will includereceipt_id, which references the data in theattachmentstop-level key.recent_submission(ExpenseReportSubmission) - The most recent expense report the expense was submitted in, including any rejected or cancelled reports. The response will includerecent_submission_id, which references the data in theexpense_report_submissionstop-level key.role(Role) - The role of the user. The response will includerole_id, which references the data in therolestop-level key.story(Story) - Linked task. The response will includestory_id, which references the data in thestoriestop-level key.user(User) - The user who created the expense. The response will includeuser_id, which references the data in theuserstop-level key.vendor(Vendor) - The party to which the expense is payable. The response will includevendor_id, which references the data in thevendorstop-level key.workspace(Workspace) - The project to which this expense belongs. The response will includeworkspace_id, which references the data in theworkspacestop-level key.
Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.
Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.
Filter for expenses associated with the specified expense report IDs, including from canceled and rejected reports. Give multiple report IDs in a comma separated list.
Note: Expenses are only associated with the most recent reports they were submitted in (recent_submission). If you re-submit an expense from a canceled or rejected report in a new report, the expense will only be returned in association with that most recent submission`.
curl -i -X GET \
'https://api.mavenlink.com/api/v1/expenses?approved=true&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&created_by=0&date_expensed_between=string&external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&from_archived_workspaces=false&has_external_references=true&in_active_invoice_id=0&include=string&invoiced=true&mine=true&on_my_account=true&only=string&optional_fields=user_can_edit&order=date%3Adesc&page=1&per_page=20&reimbursable=true&submitted=true&uninvoiced=true&unsubmitted=true&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&with_expense_approvals=true&with_expense_report_id=0&with_recent_expense_report_ids=string&without_external_reference_service_name=string&workspace_id=0'A list of Expenses have been retrieved.
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "expenses": { "property1": { "active_submission_id": "string", "amount_in_cents": 0, "category": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "date": "2019-08-24", "expense_budget_id": "string", "expense_category_id": "string", "external_reference_ids": [ "string" ], "foreign_exchange_amount": { "date": "2019-08-24T14:15:22Z", "rate": 0.1, "source_currency": "string", "source_value": 0.1 }, "is_billable": true, "is_invoiced": true, "notes": "string", "receipt_id": "string", "recent_submission_id": "string", "reimbursable": true, "role_id": "string", "story_id": "string", "taxable": true, "updated_at": "2019-08-24T14:15:22Z", "user_can_edit": true, "user_id": "string", "vendor_id": "string", "workspace_id": "string" }, "property2": { "active_submission_id": "string", "amount_in_cents": 0, "category": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "date": "2019-08-24", "expense_budget_id": "string", "expense_category_id": "string", "external_reference_ids": [ "string" ], "foreign_exchange_amount": { "date": "2019-08-24T14:15:22Z", "rate": 0.1, "source_currency": "string", "source_value": 0.1 }, "is_billable": true, "is_invoiced": true, "notes": "string", "receipt_id": "string", "recent_submission_id": "string", "reimbursable": true, "role_id": "string", "story_id": "string", "taxable": true, "updated_at": "2019-08-24T14:15:22Z", "user_can_edit": true, "user_id": "string", "vendor_id": "string", "workspace_id": "string" } }, "external_references": { "property1": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "stories": { "property1": { "ancestor_ids": [ "string" ], "ancestry_depth": 0, "archived": true, "archived_editable": true, "assigned_role_id": "string", "assignee_ids": [ "string" ], "assignment_timestamped_at": "2019-08-24T14:15:22Z", "attachment_ids": [ "string" ], "billable": true, "budget_estimate_in_cents": 0, "budget_used_in_cents": 0, "can_align_time": true, "can_edit": true, "can_post": true, "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "current_assignment_ids": [ "string" ], "custom_field_value_ids": [ "string" ], "custom_task_status_id": 0, "deleted_at": "2019-08-24T14:15:22Z", "descendant_ids": [ "string" ], "description": "string", "due_date": "2019-08-24", "external_reference_ids": [ "string" ], "fixed_fee": true, "follower_ids": [ "string" ], "formatted_description": "string", "google_document_ids": [ "string" ], "has_out_of_bounds_sads": true, "invoiced_balance_in_cents": 0, "is_time_trackable_type": true, "logged_billable_time_in_minutes": 0, "logged_nonbillable_time_in_minutes": 0, "parent_id": "string", "parsed_description": "string", "percentage_complete": 0, "position": 0, "potential_workspace_resource_ids": [ "string" ], "potential_workspace_resources_with_unnamed_ids": [ "string" ], "priority": 0, "project_plan": true, "read_only": true, "render_description_markdown": true, "reply_ids": [ "string" ], "root_id": "string", "source_dependency_ids": [ "string" ], "start_date": "2019-08-24", "state": "string", "status": "string", "story_state_change_ids": [ "string" ], "story_task_ids": [ "string" ], "story_type": "string", "sub_stories_billable_time_in_minutes": 0, "sub_stories_budget_estimate_in_cents": 0, "sub_stories_budget_used_in_cents": 0, "sub_stories_time_estimate_in_minutes": 0, "sub_story_count": 0, "sub_story_ids": [ "string" ], "subtree_depth": 0, "tag_ids": [ "string" ], "target_dependency_ids": [ "string" ], "time_estimate_in_minutes": 0, "time_trackable": true, "title": "string", "uninvoiced_balance_in_cents": 0, "updated_at": "2019-08-24T14:15:22Z", "weight": 0, "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] }, "property2": { "ancestor_ids": [ "string" ], "ancestry_depth": 0, "archived": true, "archived_editable": true, "assigned_role_id": "string", "assignee_ids": [ "string" ], "assignment_timestamped_at": "2019-08-24T14:15:22Z", "attachment_ids": [ "string" ], "billable": true, "budget_estimate_in_cents": 0, "budget_used_in_cents": 0, "can_align_time": true, "can_edit": true, "can_post": true, "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "current_assignment_ids": [ "string" ], "custom_field_value_ids": [ "string" ], "custom_task_status_id": 0, "deleted_at": "2019-08-24T14:15:22Z", "descendant_ids": [ "string" ], "description": "string", "due_date": "2019-08-24", "external_reference_ids": [ "string" ], "fixed_fee": true, "follower_ids": [ "string" ], "formatted_description": "string", "google_document_ids": [ "string" ], "has_out_of_bounds_sads": true, "invoiced_balance_in_cents": 0, "is_time_trackable_type": true, "logged_billable_time_in_minutes": 0, "logged_nonbillable_time_in_minutes": 0, "parent_id": "string", "parsed_description": "string", "percentage_complete": 0, "position": 0, "potential_workspace_resource_ids": [ "string" ], "potential_workspace_resources_with_unnamed_ids": [ "string" ], "priority": 0, "project_plan": true, "read_only": true, "render_description_markdown": true, "reply_ids": [ "string" ], "root_id": "string", "source_dependency_ids": [ "string" ], "start_date": "2019-08-24", "state": "string", "status": "string", "story_state_change_ids": [ "string" ], "story_task_ids": [ "string" ], "story_type": "string", "sub_stories_billable_time_in_minutes": 0, "sub_stories_budget_estimate_in_cents": 0, "sub_stories_budget_used_in_cents": 0, "sub_stories_time_estimate_in_minutes": 0, "sub_story_count": 0, "sub_story_ids": [ "string" ], "subtree_depth": 0, "tag_ids": [ "string" ], "target_dependency_ids": [ "string" ], "time_estimate_in_minutes": 0, "time_trackable": true, "title": "string", "uninvoiced_balance_in_cents": 0, "updated_at": "2019-08-24T14:15:22Z", "weight": 0, "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] } }, "workspaces": { "property1": { "access_level": "string", "account_color_id": "string", "account_id": 0, "account_insights_mapping_ids": [ "string" ], "actual_fees_includes_additional_line_items": true, "actual_fees_includes_expenses": true, "approver_id": "string", "approver_ids": [ "string" ], "archived": true, "billable_minutes": 0, "billing_milestone_ids": [ "string" ], "budget_remaining": "string", "budget_used": "string", "budget_used_in_cents": 0, "budgeted": true, "can_create_line_items": true, "can_invite": true, "change_orders_enabled": true, "client_lead_name": "string", "client_role_name": "string", "consultant_role_name": "string", "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_status_report_id": "string", "current_user_participation_id": "string", "custom_field_value_ids": [ "string" ], "default_rate": "string", "description": "string", "due_date": "2019-08-24", "effective_due_date": "2019-08-24", "estimated_minutes": 0, "exclude_archived_stories_percent_complete": true, "expenses_in_burn_rate": true, "external_link": { "url": "string", "text": "string" }, "external_reference_ids": [ "string" ], "financial_viewer_ids": [ "string" ], "has_active_expense_report_submissions": true, "has_active_timesheet_submissions": true, "has_budget_access": true, "incoming_email_address": "string", "lock_date": "2019-08-24", "minutes_logged": 0, "next_uncompleted_milestone_id": "string", "non_billable_minutes": 0, "over_budget": true, "participant_ids": [ "string" ], "participation_ids": [ "string" ], "percent_of_budget_used": 0, "percentage_complete": 0, "permissions": { "can_upload_files": true, "can_private_message": true, "can_join": true, "is_participant": true, "access_level": "string", "team_lead": true, "user_is_client": true, "can_change_price": true, "can_change_story_billable": true, "can_post": true, "can_edit": true, "restricted": true, "can_see_financials": true, "is_guest_on_project": true }, "possible_approver_ids": [ "string" ], "posts_require_privacy_decision": true, "price": "string", "price_in_cents": 0, "primary_counterpart_id": "string", "primary_maven_id": "string", "primary_workspace_group_id": "string", "provider_lead_name": "string", "rate_card_id": 0, "require_expense_approvals": true, "require_notes_on_time_entries": true, "require_time_approvals": true, "revenue_recognition_method_id": "string", "revenue_recognition_method_name": "string", "stage": "string", "start_date": "2019-08-24", "status": { "color": "string", "key": "string", "message": "string" }, "status_report_ids": [ "string" ], "stories_are_fixed_fee_by_default": true, "target_margin": 0.1, "task_status_set_id": "string", "task_status_set_name": "string", "task_statuses": [ "string" ], "tasks_default_non_billable": true, "time_trackable": true, "timesheet_submission_ids": [ "string" ], "title": "string", "total_expenses_in_cents": 0, "total_invoiced": "string", "total_minutes_approved": 0, "updated_at": "2019-08-24T14:15:22Z", "workspace_group_ids": [ "string" ], "workspace_invoice_preference_id": 0, "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] }, "property2": { "access_level": "string", "account_color_id": "string", "account_id": 0, "account_insights_mapping_ids": [ "string" ], "actual_fees_includes_additional_line_items": true, "actual_fees_includes_expenses": true, "approver_id": "string", "approver_ids": [ "string" ], "archived": true, "billable_minutes": 0, "billing_milestone_ids": [ "string" ], "budget_remaining": "string", "budget_used": "string", "budget_used_in_cents": 0, "budgeted": true, "can_create_line_items": true, "can_invite": true, "change_orders_enabled": true, "client_lead_name": "string", "client_role_name": "string", "consultant_role_name": "string", "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_status_report_id": "string", "current_user_participation_id": "string", "custom_field_value_ids": [ "string" ], "default_rate": "string", "description": "string", "due_date": "2019-08-24", "effective_due_date": "2019-08-24", "estimated_minutes": 0, "exclude_archived_stories_percent_complete": true, "expenses_in_burn_rate": true, "external_link": { "url": "string", "text": "string" }, "external_reference_ids": [ "string" ], "financial_viewer_ids": [ "string" ], "has_active_expense_report_submissions": true, "has_active_timesheet_submissions": true, "has_budget_access": true, "incoming_email_address": "string", "lock_date": "2019-08-24", "minutes_logged": 0, "next_uncompleted_milestone_id": "string", "non_billable_minutes": 0, "over_budget": true, "participant_ids": [ "string" ], "participation_ids": [ "string" ], "percent_of_budget_used": 0, "percentage_complete": 0, "permissions": { "can_upload_files": true, "can_private_message": true, "can_join": true, "is_participant": true, "access_level": "string", "team_lead": true, "user_is_client": true, "can_change_price": true, "can_change_story_billable": true, "can_post": true, "can_edit": true, "restricted": true, "can_see_financials": true, "is_guest_on_project": true }, "possible_approver_ids": [ "string" ], "posts_require_privacy_decision": true, "price": "string", "price_in_cents": 0, "primary_counterpart_id": "string", "primary_maven_id": "string", "primary_workspace_group_id": "string", "provider_lead_name": "string", "rate_card_id": 0, "require_expense_approvals": true, "require_notes_on_time_entries": true, "require_time_approvals": true, "revenue_recognition_method_id": "string", "revenue_recognition_method_name": "string", "stage": "string", "start_date": "2019-08-24", "status": { "color": "string", "key": "string", "message": "string" }, "status_report_ids": [ "string" ], "stories_are_fixed_fee_by_default": true, "target_margin": 0.1, "task_status_set_id": "string", "task_status_set_name": "string", "task_statuses": [ "string" ], "tasks_default_non_billable": true, "time_trackable": true, "timesheet_submission_ids": [ "string" ], "title": "string", "total_expenses_in_cents": 0, "total_invoiced": "string", "total_minutes_approved": 0, "updated_at": "2019-08-24T14:15:22Z", "workspace_group_ids": [ "string" ], "workspace_invoice_preference_id": 0, "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] } }, "users": { "property1": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] }, "property2": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] } }, "attachments": { "property1": { "created_at": "2019-08-24T14:15:22Z", "creator_name": "string", "deletable": true, "deleted_at": "2019-08-24T14:15:22Z", "filename": "string", "filesize": 0, "previewable": true, "updated_at": "2019-08-24T14:15:22Z", "url": "string", "view_in_new_tab": true }, "property2": { "created_at": "2019-08-24T14:15:22Z", "creator_name": "string", "deletable": true, "deleted_at": "2019-08-24T14:15:22Z", "filename": "string", "filesize": 0, "previewable": true, "updated_at": "2019-08-24T14:15:22Z", "url": "string", "view_in_new_tab": true } }, "expense_report_submissions": { "property1": { "comment": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_resolution_created_at_date": "2019-08-24T14:15:22Z", "current_resolution_creator_id": 0, "current_resolution_description": "string", "expense_ids": [ "string" ], "external_reference_ids": [ "string" ], "line_item_total_formatted": "string", "line_item_total_in_cents": 0, "locked": true, "permissions": { "can_cancel_submission": true, "can_approve_submission": true, "can_reject_submission": true, "can_resubmit_submission": true }, "resolution_description": "string", "resolution_ids": [ "string" ], "status": "string", "title": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "workspace_id": "string" }, "property2": { "comment": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "current_resolution_created_at_date": "2019-08-24T14:15:22Z", "current_resolution_creator_id": 0, "current_resolution_description": "string", "expense_ids": [ "string" ], "external_reference_ids": [ "string" ], "line_item_total_formatted": "string", "line_item_total_in_cents": 0, "locked": true, "permissions": { "can_cancel_submission": true, "can_approve_submission": true, "can_reject_submission": true, "can_resubmit_submission": true }, "resolution_description": "string", "resolution_ids": [ "string" ], "status": "string", "title": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "workspace_id": "string" } }, "expense_categories": { "property1": { "deleted_at": "2019-08-24T14:15:22Z", "name": "string" }, "property2": { "deleted_at": "2019-08-24T14:15:22Z", "name": "string" } }, "roles": { "property1": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "external_reference_ids": [ "string" ], "name": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "vendors": { "property1": { "archived": true, "external_reference_ids": [ "string" ], "externally_managed": true, "in_use": true, "name": "string" }, "property2": { "archived": true, "external_reference_ids": [ "string" ], "externally_managed": true, "in_use": true, "name": "string" } }, "expense_budgets": { "property1": { "billable": true, "burns_budget": true, "cost_per_unit_in_subunits": 0, "description": "string", "expected_by": "2019-08-24", "expense_ids": [ "string" ], "external_reference_ids": [ "string" ], "fixed_fee": true, "fixed_fee_item_ids": [ "string" ], "markup_per_unit_in_subunits": 0, "markup_percentage": 0.1, "markup_type": "string", "quantity": 0, "story_id": 0, "title": "string", "workspace_id": 0 }, "property2": { "billable": true, "burns_budget": true, "cost_per_unit_in_subunits": 0, "description": "string", "expected_by": "2019-08-24", "expense_ids": [ "string" ], "external_reference_ids": [ "string" ], "fixed_fee": true, "fixed_fee_item_ids": [ "string" ], "markup_per_unit_in_subunits": 0, "markup_percentage": 0.1, "markup_type": "string", "quantity": 0, "story_id": 0, "title": "string", "workspace_id": 0 } } }