You can cancel active invoices with this endpoint.
This endpoint returns structured Invoice 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 invoices top-level JSON key. Please see our Response Format section for more information.
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.
additional_items(AdditionalItem) - When included, theadditional_item_idsarray will reference all additional items included in the invoice.billing_milestones(BillingMilestone) - When included, thebilling_milestone_idsarray will reference all billing milestones included in the invoice.expense_budgets(ExpenseBudget) - Retrieves expense budgets included on the invoice. The response will includeexpense_budget_ids, which references the data in theexpense_budgetstop-level key.expenses(Expense) - When included, theexpense_idsarray will reference all expenses included in the invoice.external_references(ExternalReference) - Includes references to external integrations for this object.fixed_fee_items(FixedFeeItem) - When included, thefixed_fee_itemsarray will reference all fixed fee items included in the invoice.recipient(User) - The User who received the invoice. Namely, the client lead at the time that the invoice was created (or null, if no lead client existed at the time).time_entries(TimeEntry) - When included, thetime_entry_idsarray will reference all time entries included in the invoice.user(User) - The user who created the invoice.workspaces(Workspace) - When included, theworkspace_idsarray will reference all projects covered by the invoice.
- https://api.mavenlink.com/api/v1https://api.mavenlink.com/api/v1/invoices/{id}/cancel
curl -i -X PUT \
'https://api.mavenlink.com/api/v1/invoices/{id}/cancel?include=string'Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "invoices": { "property1": { "additional_item_ids": [ "string" ], "balance_in_cents": 0, "billing_milestone_ids": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "draft": true, "due_date": "2019-08-24", "expense_budget_ids": [ "string" ], "expense_ids": [ "string" ], "external_reference_ids": [ "string" ], "fixed_fee_item_ids": [ "string" ], "invoice_date": "2019-08-24", "message": "string", "payment_schedule": 0, "project_code": "string", "purchase_order": "string", "recipient_id": "string", "status": "string", "tax_rate": 0.1, "time_entry_ids": [ "string" ], "title": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "user_invoice_number": 0, "user_invoice_title": "string", "workspace_ids": [ "string" ] }, "property2": { "additional_item_ids": [ "string" ], "balance_in_cents": 0, "billing_milestone_ids": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "draft": true, "due_date": "2019-08-24", "expense_budget_ids": [ "string" ], "expense_ids": [ "string" ], "external_reference_ids": [ "string" ], "fixed_fee_item_ids": [ "string" ], "invoice_date": "2019-08-24", "message": "string", "payment_schedule": 0, "project_code": "string", "purchase_order": "string", "recipient_id": "string", "status": "string", "tax_rate": 0.1, "time_entry_ids": [ "string" ], "title": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string", "user_invoice_number": 0, "user_invoice_title": "string", "workspace_ids": [ "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" } }, "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" ] } }, "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" ] } }, "additional_items": { "property1": { "amount_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "notes": "string", "taxable": true, "workspace_id": 0 }, "property2": { "amount_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "notes": "string", "taxable": true, "workspace_id": 0 } }, "time_entries": { "property1": { "active_submission_id": "string", "approved": true, "billable": true, "cost_rate_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "date_performed": "2019-08-24", "external_reference_ids": [ "string" ], "invoice_id": "string", "is_invoiced": true, "location": "string", "location_id": 0, "notes": "string", "rate_in_cents": 0, "recent_submission_id": "string", "role_id": "string", "story_id": "string", "taxable": true, "time_in_minutes": 0, "updated_at": "2019-08-24T14:15:22Z", "user_can_edit": true, "user_id": "string", "workspace_id": "string" }, "property2": { "active_submission_id": "string", "approved": true, "billable": true, "cost_rate_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "currency_base_unit": 0, "currency_symbol": "string", "date_performed": "2019-08-24", "external_reference_ids": [ "string" ], "invoice_id": "string", "is_invoiced": true, "location": "string", "location_id": 0, "notes": "string", "rate_in_cents": 0, "recent_submission_id": "string", "role_id": "string", "story_id": "string", "taxable": true, "time_in_minutes": 0, "updated_at": "2019-08-24T14:15:22Z", "user_can_edit": true, "user_id": "string", "workspace_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, "rate_source": "string", "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, "rate_source": "string", "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" } }, "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 } }, "fixed_fee_items": { "property1": { "amount_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "notes": "string", "story_id": 0, "taxable": true, "workspace_id": 0 }, "property2": { "amount_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "currency": "string", "notes": "string", "story_id": 0, "taxable": true, "workspace_id": 0 } }, "billing_milestones": { "property1": { "amount_in_cents": 0, "billing_type": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "date_to_invoice": "2019-08-24", "external_reference_ids": [ "string" ], "invoice_id": "string", "invoice_ids": [ "string" ], "story_id": "string", "title": "string", "updated_at": "2019-08-24T14:15:22Z", "workspace_id": "string" }, "property2": { "amount_in_cents": 0, "billing_type": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "date_to_invoice": "2019-08-24", "external_reference_ids": [ "string" ], "invoice_id": "string", "invoice_ids": [ "string" ], "story_id": "string", "title": "string", "updated_at": "2019-08-24T14:15:22Z", "workspace_id": "string" } } }