Coverage of the ActivePlatform functionality by API

The tables below provide a list of possible actions with entities and corresponding API requests:

Resellers

Section	Action	Request
Resellers	Get list of downstream resellers	`GET {base_url}/api/v3/resellers/{reseller_id}/child_resellers`
	Get list of resellers (Customer Store)	`GET {base_url}/api/v3/customer_store/resellers`
	Get downstream reseller	`GET {base_url}/api/v3/resellers/{reseller_id}`
	Get reseller (Customer Store)	`GET /api/v3/customer_store/resellers/{reseller_id}`

Accounts

Section	Action	Request
Accounts	Create account	`POST {base_url}/api/v3/resellers/{reseller_id}/accounts`
	Update account	`PATCH {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}`
	Get list of accounts	`GET {base_url}/api/v3/resellers/{reseller_id}/accounts`
	Get account	`GET {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}`
	Get list of accounts of downstream resellers	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_accounts`
	Get account of downstream reseller	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_accounts/{account_id}`
	Get user's auth by token	`GET {base_url}/api/v3/resellers/{reseller_id}/user_authentication/token`
	Get list of account attributes	`GET {base_url}/api/v3/resellers/{reseller_id}/account_attributes`

Product categories

Section	Action	Request
Product categories	Get list of product categories	`GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/product_categories`

Products

Section	Action	Request
Products	Get list of products	`GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/products`
Products	Get product	`GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/products/{product_id}`

Plans

Section	Action	Request
Plans	Get list of plans	`GET {base_url}/api/v3/resellers/{reseller_id}/plans`
	Get plan	`GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}`
	Get list of plans of downstream resellers	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_plans`
	Get plan of downstream reseller	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_plans/{plan_id}`
	Get list of switchable plans	`GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/switchable_plans`
	Get list of order attributes of plan	`GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/order_attributes`
	Validate order attributes of plan	`POST {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/order_attributes_validation`

Orders

Section	Action	Request
Orders	Get list of orders	`GET {base_url}/api/v3/resellers/{reseller_id}/orders`
	Get order	`GET {base_url}/api/v3/resellers/{reseller_id}/orders/{order_id}`
	Create sales order	`POST {base_url}/api/v3/resellers/{reseller_id}/sales_order`
	Create switch order	`POST {base_url}/api/v3/resellers/{reseller_id}/switch_order`
	Create change order	`POST {base_url}/api/v3/resellers/{reseller_id}/change_order`
	Create renewal order	`POST {base_url}/api/v3/resellers/{reseller_id}/renewal_order`
	Create prolong order	`POST {base_url}/api/v3/resellers/{reseller_id}/prolong_order`
	Cancel order	`POST {base_url}/api/v3/resellers/{reseller_id}/orders/{order_id}/cancel_operation`

Subscriptions

Section	Action	Request
Subscriptions	Get list of subscriptions	`GET {base_url}/api/v3/resellers/{reseller_id}/subscriptions`
	Get subscription	`GET {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}`
	Get list of subscriptions of downstream resellers	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_subscriptions`
	Get subscription of downstream reseller	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_subscriptions/{subscription_id}`
	Stop subscription	`POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/stop_operation`
	Activate subscription	`POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/activate_operation`
	Update subscription	`PATCH {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}`
	Delete subscription	`POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/delete_operation`

Charges

Section	Action	Request
Charges	Get list of end-customer charges	`GET {base_url}/api/v3/resellers/{reseller_id}/charges`
	Get end-customer charge	`GET {base_url}/api/v3/resellers/{reseller_id}/charges/{charge_id}`
	Get list of end-customer charges of downstream resellers	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_charges`
	Get end-customer charge of downstream reseller	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_charges/{charge_id}`
	Get list of reseller charges	`GET {base_url}/api/v3/resellers/{reseller_id}/reseller_charges`
	Get reseller charge	`GET {base_url}/api/v3/resellers/{reseller_id}/reseller_charges/{charge_id}`
	Get list of reseller charges of downstream resellers	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_reseller_charges`
	Get reseller charge of downstream reseller	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_reseller_charges/{charge_id}`
	Add taxes	`POST {base_url}/api/v3/resellers/{reseller_id}/taxes`
	Close charges	`PATCH {base_url}/api/v3/vendor/subscriptions/{subscription_id}/close_charges`

Corrections

Section	Action	Request
Corrections	Create correction	`POST {base_url}/api/v3/resellers/{reseller_id}/corrections`
Corrections	Update correction status	`PATCH {base_url}/api/v3/resellers/{reseller_id}/corrections/{correction_id}`

Discounts

Section	Action	Request
Discounts	Get best reseller discount	`GET {base_url}/api/v3/resellers/{reseller_id}/reseller_discounts`

Invoices

Section	Action	Request
Invoices	Get list of invoices	`GET {base_url}/api/v3/resellers/{reseller_id}/invoices`
Invoices	Get invoice	`GET {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}`

Invoices with external management

Section	Action	Request
Invoices with external management	Approve invoice	`POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/approve_invoices`
	Complete invoice	`POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/complete_invoices`
	Approve invoice by ID	`POST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/approve`
	Complete invoice by ID	`POST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/complete`
	Revoke invoice approval by ID	`POST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/revoke`

Closing documents

Section	Action	Request
Closing documents	Send closing document from ERP	`POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices`
	Get closing document	`GET {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices?filter[key]=key`
	Update closing document	`PATCH {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices/{external_invoice_id}`
	Delete closing document	`DELETE {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices/{external_invoice_id}`
	Send notifications on closing documents	`POST {base_url}/api/v3/resellers/{reseller_id}/notifications/external_invoices`

Managers

Section	Action	Request
Managers	Create manager	`POST {base_url}/api/v3/resellers/{reseller_id}/managers`
	Update manager	`PATCH {base_url}/api/v3/resellers/{reseller_id}/managers/{manager_id}`
	Get list of managers	`GET {base_url}/api/v3/resellers/{reseller_id}/managers`
	Get manager	`GET {base_url}/api/v3/resellers/{reseller_id}/managers/{manager_id}`
	Get list of managers of downstream resellers	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_managers`
	Get manager of downstream reseller	`GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_managers/{manager_id}`
	Get list of roles	`GET {base_url}/api/v3/resellers/{reseller_id}/manager_roles`

Payments

Section	Action	Request
Payments	Create payment	`POST {base_url}/api/v3/resellers/{reseller_id}/payments`
	Get list of payments	`GET {base_url}/api/v3/resellers/{reseller_id}/payments`
	Get payment	`GET {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id}`
	Cancel payment	`DELETE {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id}`
	Complete payment by ID	`PATCH {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id}`
	Complete payment from balance	`PATCH {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id}`
	Complete payment by document ID	`POST {base_url}/api/v3/resellers/{reseller_id}/payments/{document_id}`

Free access documents

Section	Action	Request
Free access documents	Create free access document	`POST {base_url}/api/v3/resellers/{reseller_id}/free_access_documents`
	Update free access document	`PUT {base_url}/api/v3/resellers/{reseller_id}/free_access_documents/{free_access_document_id}`
	Get list of free access documents	`GET {base_url}/api/v3/resellers/{reseller_id}/free_access_documents`
	Delete free access document	`DELETE {base_url}/api/v3/resellers/{reseller_id}/free_access_documents/{free_access_document_id}`

Asynchronous tasks

Section	Action	Request
Asynchronous tasks	Get async task	`GET {base_url}/api/v3/resellers/{reseller_id}/async_tasks/{async_task_id}`

Currency rates

Section	Action	Request
Currency rates	Get list of currency rates	`GET {base_url}/api/v3/resellers/{reseller_id}/currency_rates`
Currency rates	Update currency rates	`PATCH {base_url}/api/v3/resellers/{reseller_id}/currency_rates`

Notes

Section	Action	Request
Notes	Create note	`POST {base_url}/api/v3/resellers/{reseller_id}/notes`
	Get list of notes	`GET {base_url}/api/v3/resellers/{reseller_id}/notes`
	Get note	`GET {base_url}/api/v3/resellers/{reseller_id}/notes/{note_id}`
	Delete note	`DELETE {base_url}/api/v3/resellers/{reseller_id}/notes/{note_id}`

Analytics

Section	Action	Request
Analytics	Get reseller analytics	`GET {base_url}/api/v3/resellers/{reseller_id}/reseller_analytics`
	Get daily drafts	`GET {base_url}/api/v3/analytics_daily_drafts`
	Get daily analytics	`GET {base_url}/api/v3/analytics_daily`
	Get monthly analytics	`GET {base_url}/api/v3/analytics_monthly`