vCita Sales Reports API
The Sales Reports API from vCita — 3 operation(s) for sales reports.
The Sales Reports API from vCita — 3 operation(s) for sales reports.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vcita:vcita-sales-reports-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Sales Reports API
description: Unified OpenAPI specification for sales domain
version: '3.0'
x-generated:
sourceFiles:
- legacy_v1_sales.json
- sales_reports.json
- payment_plans.json
- payments.json
- payment_gateway.json
- legacy_v2_settings_services.json
- legacy_v2_settings_categories.json
- client_cards.json
- client_payment_cards.json
- creditNote.json
- estimates.json
- coupons.json
- invoice.json
- coupon.json
pathNormalizations:
- file: legacy_v1_sales.json
basePath: /platform/v1
transformations:
- original: /leadgen
normalized: /platform/v1/leadgen
basePath: /platform/v1
- original: /payments
normalized: /platform/v1/payments
basePath: /platform/v1
- original: /payments/{payment_uid}
normalized: /platform/v1/payments/{payment_uid}
basePath: /platform/v1
- original: /payments/{payment_uid}/match
normalized: /platform/v1/payments/{payment_uid}/match
basePath: /platform/v1
- original: /invoices
normalized: /platform/v1/invoices
basePath: /platform/v1
- original: /invoices/{invoice_id}
normalized: /platform/v1/invoices/{invoice_id}
basePath: /platform/v1
- original: /payment/cards/sync_card
normalized: /platform/v1/payment/cards/sync_card
basePath: /platform/v1
- original: /payment/cards/{card_id}
normalized: /platform/v1/payment/cards/{card_id}
basePath: /platform/v1
- original: /payment/checkout/
normalized: /platform/v1/payment/checkout/
basePath: /platform/v1
- original: /payment/checkout/{url_key}
normalized: /platform/v1/payment/checkout/{url_key}
basePath: /platform/v1
- original: /payment/client_packages
normalized: /platform/v1/payment/client_packages
basePath: /platform/v1
- original: /payment/client_packages/cancel_redemption
normalized: /platform/v1/payment/client_packages/cancel_redemption
basePath: /platform/v1
- original: /payment/client_packages/update_usage
normalized: /platform/v1/payment/client_packages/update_usage
basePath: /platform/v1
- original: /payment/packages
normalized: /platform/v1/payment/packages
basePath: /platform/v1
- original: /payment/packages/{package_id}
normalized: /platform/v1/payment/packages/{package_id}
basePath: /platform/v1
- original: /payment/settings
normalized: /platform/v1/payment/settings
basePath: /platform/v1
- original: /payment/settings/update_default_currency
normalized: /platform/v1/payment/settings/update_default_currency
basePath: /platform/v1
- original: /payment_statuses/{id}/apply_coupon
normalized: /platform/v1/payment_statuses/{id}/apply_coupon
basePath: /platform/v1
- original: /payment_statuses/{id}/validate_coupon
normalized: /platform/v1/payment_statuses/{id}/validate_coupon
basePath: /platform/v1
- original: /services
normalized: /platform/v1/services
basePath: /platform/v1
- original: /services/availability
normalized: /platform/v1/services/availability
basePath: /platform/v1
- original: /services/{service_uid}
normalized: /platform/v1/services/{service_uid}
basePath: /platform/v1
- original: /services/{service_uid}/availability
normalized: /platform/v1/services/{service_uid}/availability
basePath: /platform/v1
- file: payments.json
basePath: /business/payments
transformations:
- original: /v1/card_requests
normalized: /business/payments/v1/card_requests
basePath: /business/payments
- original: /v1/card_requests/{client_uid}
normalized: /business/payments/v1/card_requests/{client_uid}
basePath: /business/payments
- original: /v1/cards/{uid}
normalized: /business/payments/v1/cards/{uid}
basePath: /business/payments
- original: /v1/carts
normalized: /business/payments/v1/carts
basePath: /business/payments
- original: /v1/carts/{uid}
normalized: /business/payments/v1/carts/{uid}
basePath: /business/payments
- original: /v1/carts/{uid}/cancel
normalized: /business/payments/v1/carts/{uid}/cancel
basePath: /business/payments
- original: /v1/carts/{uid}/cart_completed
normalized: /business/payments/v1/carts/{uid}/cart_completed
basePath: /business/payments
- original: /v1/client_packages/{uid}
normalized: /business/payments/v1/client_packages/{uid}
basePath: /business/payments
- original: /v1/deposits
normalized: /business/payments/v1/deposits
basePath: /business/payments
- original: /v1/deposits/{uid}
normalized: /business/payments/v1/deposits/{uid}
basePath: /business/payments
- original: /v1/estimates
normalized: /business/payments/v1/estimates
basePath: /business/payments
- original: /v1/estimates/{estimate_uid}
normalized: /business/payments/v1/estimates/{estimate_uid}
basePath: /business/payments
- original: /v1/invoices
normalized: /business/payments/v1/invoices
basePath: /business/payments
- original: /v1/invoices/{invoice_uid}
normalized: /business/payments/v1/invoices/{invoice_uid}
basePath: /business/payments
- original: /v1/invoices/{invoice_uid}/cancel
normalized: /business/payments/v1/invoices/{invoice_uid}/cancel
basePath: /business/payments
- original: /v1/packages/reorder
normalized: /business/payments/v1/packages/reorder
basePath: /business/payments
- original: /v1/payment_requests
normalized: /business/payments/v1/payment_requests
basePath: /business/payments
- original: /v1/payment_requests/{payment_request_uid}/send_link
normalized: /business/payments/v1/payment_requests/{payment_request_uid}/send_link
basePath: /business/payments
- original: /v1/payment_requests/{payment_request_uid}
normalized: /business/payments/v1/payment_requests/{payment_request_uid}
basePath: /business/payments
- original: /v1/payments
normalized: /business/payments/v1/payments
basePath: /business/payments
- original: /v1/payments/{payment_uid}
normalized: /business/payments/v1/payments/{payment_uid}
basePath: /business/payments
- original: /v1/payouts
normalized: /business/payments/v1/payouts
basePath: /business/payments
- original: /v1/payouts/{provider_payout_id}
normalized: /business/payments/v1/payouts/{provider_payout_id}
basePath: /business/payments
- original: /v1/product_orders
normalized: /business/payments/v1/product_orders
basePath: /business/payments
- original: /v1/product_orders/{product_order_uid}
normalized: /business/payments/v1/product_orders/{product_order_uid}
basePath: /business/payments
- original: /v1/products
normalized: /business/payments/v1/products
basePath: /business/payments
- original: /v1/products/{product_uid}
normalized: /business/payments/v1/products/{product_uid}
basePath: /business/payments
- original: /v1/refunds
normalized: /business/payments/v1/refunds
basePath: /business/payments
- original: /v1/scheduled_payments_rules
normalized: /business/payments/v1/scheduled_payments_rules
basePath: /business/payments
- original: /v1/scheduled_payments_rules/{uid}/cancel
normalized: /business/payments/v1/scheduled_payments_rules/{uid}/cancel
basePath: /business/payments
- original: /v1/scheduled_payments_rules/{uid}
normalized: /business/payments/v1/scheduled_payments_rules/{uid}
basePath: /business/payments
- original: /v1/tax_bulk
normalized: /business/payments/v1/tax_bulk
basePath: /business/payments
- original: /v1/tax_bulk/apply_defaults
normalized: /business/payments/v1/tax_bulk/apply_defaults
basePath: /business/payments
- original: /v1/taxes
normalized: /business/payments/v1/taxes
basePath: /business/payments
- original: /v1/taxes/{tax_uid}
normalized: /business/payments/v1/taxes/{tax_uid}
basePath: /business/payments
- original: /v1/transactions
normalized: /business/payments/v1/transactions
basePath: /business/payments
- original: /v1/transactions/{provider_transaction_id}
normalized: /business/payments/v1/transactions/{provider_transaction_id}
basePath: /business/payments
- file: estimates.json
basePath: /platform/v1
transformations:
- original: /estimates
normalized: /platform/v1/estimates
basePath: /platform/v1
pathConflicts: []
componentConflicts:
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_payment_plans
files:
- merged
- payment_plans.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_client_cards
files:
- merged
- client_cards.json
totalPaths: 87
totalComponents: 13
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- name: Sales Reports
paths:
/v3/sales/reports/forecast_payments:
get:
summary: Retrieve Payments Forecast Data
description: '## Overview
Fetch detailed data for the Payments forecast widget, providing predictions of future payments on a month-by-month basis. This endpoint is accessible with **Staff Tokens** only.
Available for **Staff, Directory, and Client tokens**'
responses:
'200':
description: Successful response containing Payments forecast data.
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
$ref: '#/components/schemas/PaymentsForecast'
tags:
- Sales Reports
security:
- Bearer: []
operationId: getV3SalesReportsForecastPayments
x-operation-id-source: derived
/v3/sales/reports/payment_plans_summary:
get:
operationId: getPaymentPlansSummary
summary: Retrieve Payment Plans Summary
description: '## Overview
Fetch the totals shown at the top of the payment plans page: what plans collected this year, how many plans are active, what active plans will charge in the next 4 weeks, and what failed installments of paused plans require review. The totals cover all of the business''s plans and do not take any list filters.
Amounts are in the business currency, and payments and plans in any other currency are not included in them. Plan counts include every currency. Only the plans the requesting staff member can see in the payment plans list are counted.
Available for **Staff tokens**.'
responses:
'200':
description: Successful response containing the payment plans summary.
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
$ref: '#/components/schemas/PaymentPlansSummary'
example:
success: true
data:
currency: USD
collected_this_year:
amount: 12500
count: 41
plans:
active_count: 18
paused_count: 3
total_count: 27
active_installments_due_4_weeks:
amount: 4200
count: 14
plans_require_review:
amount: 950
'401':
description: Missing, expired or invalid bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- message: Authentication is required to access this resource
'403':
description: The token is valid but not permitted to view payments of this business.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- message: You are not allowed to perform this action
tags:
- Sales Reports
security:
- Bearer: []
/v3/sales/reports/payments_widget:
get:
summary: Retrieve Payments Widget Data
description: '## Overview
Fetch summarized data for the Payments widget, including total payments, overdue payments, and pending estimates. This endpoint is accessible with **Staff Tokens** only.
Available for **Staff, Directory, and Client tokens**'
responses:
'200':
description: Successful response containing Payments widget data.
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
$ref: '#/components/schemas/PaymentsWidget'
tags:
- Sales Reports
security:
- Bearer: []
operationId: getV3SalesReportsPaymentsWidget
x-operation-id-source: derived
components:
schemas:
PaymentsWidget:
type: object
description: Payments widget data containing total payments, overdue payments summary, and pending estimates. Each section is wrapped in a success/data envelope.
properties:
total_payments:
type: object
description: Total payments section wrapped in success/data envelope.
properties:
success:
type: boolean
description: Whether the total_payments sub-query succeeded.
data:
type: object
properties:
current_year:
type: number
description: Total payment amount collected for the current year.
last_year:
type: number
description: Total payment amount collected in the previous year.
overdue_payments_summary:
type: object
description: Overdue payments summary section wrapped in success/data envelope.
properties:
success:
type: boolean
description: Whether the overdue_payments_summary sub-query succeeded.
data:
type: object
properties:
total_overdue:
type: number
nullable: true
description: The total overdue amount of payment requests. Null if no overdue payments.
total_overdue_count:
type: number
description: The total number of overdue payment requests.
last_week:
type: number
nullable: true
description: Total overdue payment requests amount from the last week.
last_week_count:
type: number
description: Number of overdue payment requests from the last week.
last_month:
type: number
nullable: true
description: Total overdue payment requests amount from the last month.
last_month_count:
type: number
description: Number of overdue payment requests from the last month.
old:
type: number
nullable: true
description: The total amount for overdue payment requests that are older than 30 days.
old_count:
type: number
description: Count of older overdue payment request transactions that are older than 30 days.
pending_estimates:
type: object
description: Pending estimates section wrapped in success/data envelope.
properties:
success:
type: boolean
description: Whether the pending_estimates sub-query succeeded.
data:
type: object
properties:
count:
type: number
description: The total count of pending payment estimates that have not yet been confirmed.
PaymentPlansSummary:
type: object
description: Totals of the business's payment plans. Amounts, and the payment and installment counts that go with them, are in the business currency; payments and plans in any other currency are not included in them. The plan counts in `plans` include plans in every currency, the same as the payment plans list. Only the plans the requesting staff member can see in the payment plans list are counted.
properties:
currency:
type: string
description: Three-letter ISO 4217 code of the business currency that every amount is in (e.g., "USD")
collected_this_year:
type: object
description: Payments collected by payment plans since January 1 of the current year, in the business time zone, until now. A partially refunded payment is counted at its amount minus the refunded part, and a fully refunded payment is not counted.
properties:
amount:
type: number
description: The total amount of those payments, net of partial refunds (e.g., 12500.0)
count:
type: integer
minimum: 0
description: The number of those payments (e.g., 41)
required:
- amount
- count
plans:
type: object
description: Counts of the business's payment plans by status.
properties:
active_count:
type: integer
minimum: 0
description: The number of plans in `active` status (e.g., 18)
paused_count:
type: integer
minimum: 0
description: The number of plans in `paused` status (e.g., 3)
total_count:
type: integer
minimum: 0
description: The number of plans in any status (e.g., 27)
required:
- active_count
- paused_count
- total_count
active_installments_due_4_weeks:
type: object
description: Installments that `active` plans will charge in the next 4 weeks. Every installment due in that window is counted, so a weekly plan can add up to 4, but never more than the installments the plan has left. Each installment is counted at the plan's `amount`.
properties:
amount:
type: number
description: The total amount of those installments (e.g., 4200.0)
count:
type: integer
minimum: 0
description: The number of those installments (e.g., 14)
required:
- amount
- count
plans_require_review:
type: object
description: Plans in `paused` status, whose last scheduled installment failed to charge. Use `plans.paused_count` for the number of these plans.
properties:
amount:
type: number
description: The sum of the failed installments of the paused plans, one per plan, at the amount that failed to charge. For a linked plan that failed on its last installment, this is the remaining balance, which can be lower than the plan's `amount` (e.g., 950.0)
required:
- amount
required:
- currency
- collected_this_year
- plans
- active_installments_due_4_weeks
- plans_require_review
ErrorResponse:
type: object
properties:
success:
type: boolean
enum:
- false
errors:
type: array
items:
type: object
properties:
field:
type: string
description: The name of the field that caused the error (e.g., "currency").
code:
type: string
description: A machine-readable error code (e.g., "invalid", "missing").
message:
type: string
description: A human-readable error message describing the issue.
required:
- success
- errors
PaymentsForecast:
type: object
description: Forecast payments data. Response is a map where keys are date strings (YYYY-MM-DD format, representing the start of each week) and values are forecast objects for that week.
additionalProperties:
type: object
description: Forecast data for a specific week.
properties:
total_amount:
type: number
format: double
description: The total forecasted payment amount for the given week.
calendar_week:
type: integer
description: The ISO calendar week number (e.g., 5 for the 5th week of the year).
week_end_date:
type: string
format: date
description: The end date of the week in YYYY-MM-DD format.
example:
'2026-02-01':
total_amount: 10
calendar_week: 5
week_end_date: '2026-02-07'
'2026-02-08':
total_amount: 200
calendar_week: 6
week_end_date: '2026-02-14'
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
ClientPaymentCards:
type: http
scheme: bearer
description: Provide a valid bearer token in the Authorization header.
PaymentPlans:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
x-provenance:
method: searched
source: https://developers.intandem.tech:443/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.intandem.tech/reference/createpaymentplan.md
- https://developers.intandem.tech/reference/delete_business-payments-v1-deposits-uid.md
- https://developers.intandem.tech/reference/delete_business-payments-v1-products-product-uid.md
- https://developers.intandem.tech/reference/delete_business-payments-v1-tax-bulk.md
- https://developers.intandem.tech/reference/delete_business-payments-v1-taxes-tax-uid.md
- https://developers.intandem.tech/reference/delete_platform-v1-payment-cards-card-id.md
- https://developers.intandem.tech/reference/delete_v2-coupons-uid.md
- https://developers.intandem.tech/reference/delete_v3-payment-processing-payment-gateways-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-card-requests-client-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-carts-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-client-packages-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-deposits-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-deposits.md
- https://developers.intandem.tech/reference/get_business-payments-v1-estimates-estimate-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-invoices-invoice-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-payment-requests-payment-request-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-payment-requests.md
- https://developers.intandem.tech/reference/get_business-payments-v1-payments-payment-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-payments.md
- https://developers.intandem.tech/reference/get_business-payments-v1-payouts-provider-payout-id.md
- https://developers.intandem.tech/reference/get_business-payments-v1-product-orders-product-order-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-products-product-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-products.md
- https://developers.intandem.tech/reference/get_business-payments-v1-scheduled-payments-rules-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-scheduled-payments-rules.md
- https://developers.intandem.tech/reference/get_business-payments-v1-taxes-tax-uid.md
- https://developers.intandem.tech/reference/get_business-payments-v1-taxes.md
- https://developers.intandem.tech/reference/get_business-payments-v1-transactions-provider-transaction-id.md
- https://developers.intandem.tech/reference/get_platform-v1-clients-payment-cards.md
- https://developers.intandem.tech/reference/get_platform-v1-estimates.md
- https://developers.intandem.tech/reference/get_platform-v1-invoices-invoice-id.md
- https://developers.intandem.tech/reference/get_platform-v1-invoices.md
- https://developers.intandem.tech/reference/get_platform-v1-payment-checkout-url-key.md
- https://developers.intandem.tech/reference/get_platform-v1-payment-packages-package-id.md
- https://developers.intandem.tech/reference/get_platform-v1-payment-packages.md
- https://developers.intandem.tech/reference/get_platform-v1-payment-settings.md
- https://developers.intandem.tech/reference/get_platform-v1-payment-statuses-id-validate-coupon.md
- https://developers.intandem.tech/reference/get_platform-v1-payments-payment-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-payments.md
- https://developers.intandem.tech/reference/get_platform-v1-services-availability.md
- https://developers.intandem.tech/reference/get_platform-v1-services-service-uid-availability.md
- https://developers.intandem.tech/reference/get_platform-v1-services-service-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-services.md
- https://developers.intandem.tech/reference/get_v2-coupons-uid.md
- https://developers.intandem.tech/reference/get_v2-coupons-valid-coupons.md
- https://developers.intandem.tech/reference/get_v2-coupons.md
- https://developers.intandem.tech/reference/get_v2-settings-categories.md
- https://developers.intandem.tech/reference/get_v3-payment-processing-payment-gateways-uid.md
- https://developers.intandem.tech/reference/get_v3-payment-processing-payment-gateways.md
- https://developers.intandem.tech/reference/get_v3-payments-client-payment-cards.md
- https://developers.intandem.tech/reference/get_v3-payments-credit-notes-uid.md
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-sales-reports-api-openapi.yml