TRANXACT.AI Ayuda

API endpoints: CRM

The 134 CRM resources: their published and service-account paths, what may be done with each, and every field with its type.

Every CRM resource another product can reach, 134 in all. Each one is reached two ways: through the published API at /api/v1/<code> once an administrator has published it (its code is the resource name unless they chose another), or with a service account at /api/crm/<resource>. The verbs, parameters, filters and answers are the same for every resource and are in API endpoint reference: how to call TRANXACT.

Fields: * means required when creating; (read-only) means it is returned but not accepted on a create or change. org_id, created_at, updated_at, created_by and updated_by are on most records and are set by TRANXACT. The id is a uuid unless the table says otherwise. Field names are the JSON keys.

Cuentas y contactos

RecursoEndpointsOperacionesCampos
Accounts (accounts)/api/v1/accounts · /api/crm/accounts · /{id}list, get, create, change, deleteid uuid (read-only), account_no* text, name* text, account_type text, parent_id uuid, industry text, country text, currency* text, credit_limit numeric, owner_id uuid (read-only), is_active boolean, org_unit_id uuid (read-only), location_id uuid (read-only), warehouse_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), website text, phone text, email text, legal_name text, address_line1 text, city text, region text, postal_code text, employee_count integer, founded_year integer, description text, name_ar text, cr_number text, building_no text, district text, additional_no text, gstin text, pan text, state_code text, gst_registration_type text, pincode text, buyer_id_scheme text, buyer_id_number text, merged_into_id uuid (read-only), onboarding_status text (read-only), onboarding_updated_at timestamp with time zone (read-only)
Contacts (contacts)/api/v1/contacts · /api/crm/contacts · /{id}list, get, create, change, deleteid uuid (read-only), account_id uuid, first_name* text, last_name* text, native_name text, email text, phone text, title text, preferred_language text, consent_marketing boolean, consent_recorded_at timestamp with time zone (read-only), is_active boolean, location_id uuid (read-only), warehouse_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), linkedin_url text, personal_email text

Automatización

RecursoEndpointsOperacionesCampos
Follow-up Enrolments (followup-enrollments)/api/v1/followup-enrollments · /api/crm/followup-enrollments · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), sequence_id* uuid, subject_type text, subject_id* uuid, subject_label text (read-only), owner_id uuid, email text, next_step integer (read-only), next_due_at timestamp with time zone (read-only), status text, steps_done integer (read-only), last_step_at timestamp with time zone (read-only), started_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Follow-up Sequences (followup-sequences)/api/v1/followup-sequences · /api/crm/followup-sequences · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, applies_to text, steps jsonb, enrol_new_leads boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Sales Automation Rules (automation-rules)/api/v1/automation-rules · /api/crm/automation-rules · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), rule_code text (read-only), name* text, description text, job_code text (read-only), job_key text (read-only), is_enabled boolean, max_value numeric, tolerance_pct numeric, fence_days integer, threshold numeric, strategy text, reasons _text, settings jsonb, last_run_at timestamp with time zone (read-only), last_outcome text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Technician Skills (technician-skills)/api/v1/technician-skills · /api/crm/technician-skills · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), employee_id* uuid, skill* text, territory text, is_available boolean, max_jobs_per_day integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Transmisión

RecursoEndpointsOperacionesCampos
Broadcast Channels (broadcast-channels)/api/v1/broadcast-channels · /api/crm/broadcast-channels · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), broadcast_id* uuid, channel* text, connection_id uuid, social_account_id uuid, subject text, body text, body_local text, media_urls _text, link_url text, char_limit integer, status text (read-only), external_id text (read-only), external_url text (read-only), sent_at timestamp with time zone (read-only), recipients integer (read-only), delivered integer (read-only), impressions integer (read-only), engagements integer (read-only), clicks integer (read-only), error_message text (read-only), sort_order integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Broadcasts (broadcasts)/api/v1/broadcasts · /api/crm/broadcasts · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), broadcast_no text (read-only), campaign_id uuid, code* text, name* text, name_local text, purpose text, subject text, subject_local text, preheader text, body_html text, body_text text, body_local text, template_id uuid, media_urls _text, link_url text, segment_id uuid, audience_filter jsonb, audience_size integer (read-only), consent_purpose text, suppressed_count integer (read-only), scheduled_for timestamp with time zone, timezone text, throttle_per_minute integer, status text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), sent_count integer (read-only), delivered_count integer (read-only), bounced_count integer (read-only), opened_count integer (read-only), clicked_count integer (read-only), replied_count integer (read-only), unsubscribed_count integer (read-only), complained_count integer (read-only), failed_count integer (read-only), social_reach integer (read-only), social_engagements integer (read-only), cost numeric (read-only), currency text (read-only), notes text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), scheduled_by uuid (read-only)
Never Write To These (suppression-list)/api/v1/suppression-list · /api/crm/suppression-list · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), address* text, channel text, reason text, detail text, source_broadcast_id uuid (read-only), expires_at timestamp with time zone, added_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Credit Control

RecursoEndpointsOperacionesCampos
Credit Blocks (credit-blocks)/api/v1/credit-blocks · /api/crm/credit-blocks · /{id}list, getid uuid (read-only), block_no text (read-only), stage text (read-only), document_type text (read-only), document_id uuid (read-only), document_no text (read-only), account_id uuid (read-only), area_id uuid (read-only), risk_category text (read-only), reason text (read-only), exposure numeric (read-only), credit_limit numeric (read-only), status text (read-only), requested_by uuid (read-only), requested_at timestamp with time zone (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), decision_note text (read-only), used_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Credit Control Areas (credit-control-areas)/api/v1/credit-control-areas · /api/crm/credit-control-areas · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, org_unit_id uuid, default_limit numeric, check_order text, check_delivery text, check_invoice text, is_default boolean, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Credit Limits by Area (credit-area-limits)/api/v1/credit-area-limits · /api/crm/credit-area-limits · /{id}list, get, create, change, deleteid uuid (read-only), account_id* uuid, area_id* uuid, credit_limit* numeric, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Credit Risk Rules (credit-risk-rules)/api/v1/credit-risk-rules · /api/crm/credit-risk-rules · /{id}list, get, create, change, deleteid uuid (read-only), risk_category* text, area_id uuid, limit_pct numeric, max_limit numeric, behaviour text, max_overdue_days integer, check_delivery text, check_invoice text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Portal del cliente

RecursoEndpointsOperacionesCampos
Customer Portal Settings (customer-portal-settings)/api/v1/customer-portal-settings · /api/crm/customer-portal-settings · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), allow_pay_online boolean, allow_quote_accept boolean, allow_cases boolean, allow_returns boolean, include_child_accounts boolean, welcome_text text, support_email text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Compromiso y retención

RecursoEndpointsOperacionesCampos
Intervention Management (interventions)/api/v1/interventions · /api/crm/interventions · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), intervention_no text (read-only), subject_type text, subject_id* uuid, trigger_type text, trigger_ref text, playbook text, objective* text, owner_id uuid, priority text, status text, started_at timestamp with time zone, due_at timestamp with time zone, closed_at timestamp with time zone (read-only), outcome text, outcome_notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Previsiones y cuotas

RecursoEndpointsOperacionesCampos
Forecast Calls (forecast-submissions)/api/v1/forecast-submissions · /api/crm/forecast-submissions · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), submission_no text (read-only), period_id uuid (read-only), user_id uuid (read-only), level text (read-only), team_id uuid (read-only), pipeline_amount numeric (read-only), best_case_amount numeric (read-only), commit_amount numeric (read-only), closed_amount numeric (read-only), weighted_amount numeric (read-only), quota_amount numeric (read-only), forecast_commit numeric (read-only), forecast_best_case numeric (read-only), rolled_up_commit numeric (read-only), rolled_up_best_case numeric (read-only), adjusted_commit numeric (read-only), adjusted_best_case numeric (read-only), adjustment_note text (read-only), adjusted_by uuid (read-only), adjusted_at timestamp with time zone (read-only), notes text (read-only), status text (read-only), submitted_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Forecast Categories (forecast-categories)/api/v1/forecast-categories · /api/crm/forecast-categories · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, rolls_up_as* text, stages text, sort_order integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Forecast Snapshots (forecast-snapshots)/api/v1/forecast-snapshots · /api/crm/forecast-snapshots · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), snapshot_week text (read-only), snapshot_date date (read-only), period_id uuid (read-only), user_id uuid (read-only), pipeline_amount numeric (read-only), best_case_amount numeric (read-only), commit_amount numeric (read-only), closed_amount numeric (read-only), omitted_amount numeric (read-only), weighted_amount numeric (read-only), quota_amount numeric (read-only), submitted_commit numeric (read-only), deals integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Quota Periods (quota-periods)/api/v1/quota-periods · /api/crm/quota-periods · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), plan_id uuid (read-only), period_code text (read-only), seq integer (read-only), start_date date (read-only), end_date date (read-only), source text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Quota Plans (quota-plans)/api/v1/quota-plans · /api/crm/quota-plans · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), plan_no text (read-only), name* text, fiscal_year* text, period_type text, measure text, currency text, status text (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Quotas (quotas)/api/v1/quotas · /api/crm/quotas · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), plan_id* uuid, period_id* uuid, assignee_type text, user_id uuid, team_id uuid, territory_id uuid, product_line text, quota_amount numeric, quota_units numeric, currency text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Sales Team Members (sales-team-members)/api/v1/sales-team-members · /api/crm/sales-team-members · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), team_id* uuid, user_id* uuid, member_role text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Sales Teams (sales-teams)/api/v1/sales-teams · /api/crm/sales-teams · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, manager_user_id uuid, parent_team_id uuid, description text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Sales Territories (sales-territories)/api/v1/sales-territories · /api/crm/sales-territories · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, team_id uuid, parent_id uuid, countries text, regions text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Bandeja de entrada y calendario

RecursoEndpointsOperacionesCampos
Mailbox Apps (mailbox-apps)/api/v1/mailbox-apps · /api/crm/mailbox-apps · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), provider* text, client_id* text, client_secret_last4 text (read-only), tenant text, redirect_uri text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Centro de Interacción

RecursoEndpointsOperacionesCampos
Call Scripts (call-scripts)/api/v1/call-scripts · /api/crm/call-scripts · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, version integer (read-only), name* text, purpose text, language text, body* text, voicemail_body text, offer_transfer boolean, status text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Connected Channels (channel-connections)/api/v1/channel-connections · /api/crm/channel-connections · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), platform_code* text, code* text, name* text, name_local text, external_tenant text, external_account text, from_number text, from_email text, from_name text, reply_to text, base_url text, auth_type text, client_id text, credential_cipher bytea (read-only), credential_last4 text (read-only), token_expires_at timestamp with time zone (read-only), scopes _text, webhook_path text, webhook_secret_cipher bytea (read-only), recording_enabled boolean, recording_announcement text, transcription_enabled boolean, status text, last_checked_at timestamp with time zone (read-only), last_error text (read-only), daily_send_cap integer, rate_per_minute integer, notes text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Dispositions (call-dispositions)/api/v1/call-dispositions · /api/crm/call-dispositions · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, name_local text, category text, requires_followup boolean, creates_case boolean, creates_opportunity boolean, is_resolution boolean, sort_order integer, is_active boolean, name_ar text (read-only), name_bn text (read-only), name_de text (read-only), name_es text (read-only), name_fr text (read-only), name_hi text (read-only), name_it text (read-only), name_ja text (read-only), name_kn text (read-only), name_ko text (read-only), name_mr text (read-only), name_pt text (read-only), name_ru text (read-only), name_ta text (read-only), name_ur text (read-only), name_zh text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Interactions (calls)/api/v1/calls · /api/crm/calls · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), call_no text (read-only), connection_id uuid, queue_id uuid, channel text, direction text, account_id uuid, contact_id uuid, lead_id uuid, case_id uuid, opportunity_id uuid, from_address text, to_address text, caller_name text, agent_user_id uuid, external_id text (read-only), conference_url text (read-only), status text, started_at timestamp with time zone (read-only), queued_at timestamp with time zone (read-only), answered_at timestamp with time zone (read-only), ended_at timestamp with time zone (read-only), wait_seconds integer (read-only), talk_seconds integer (read-only), hold_seconds integer (read-only), wrap_seconds integer (read-only), transfer_count integer (read-only), within_target boolean (read-only), disposition text, outcome text, subject text, subject_local text, notes text, notes_local text, sentiment text, created_case_id uuid (read-only), created_opportunity_id uuid (read-only), created_lead_id uuid (read-only), interaction_id uuid (read-only), recorded boolean (read-only), recording_url text (read-only), transcript_id uuid (read-only), cost numeric (read-only), currency text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), ai_voice boolean (read-only), voice_profile_id uuid (read-only), call_script_id uuid (read-only), call_script_version integer (read-only), ai_token_hash text (read-only), ai_token_expires_at timestamp with time zone (read-only), ai_transfer boolean (read-only)
Queue Staffing (queue-members)/api/v1/queue-members · /api/crm/queue-members · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), queue_id* uuid, user_id* uuid, skills _text, proficiency integer, max_concurrent integer, is_supervisor boolean, is_active boolean, joined_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Queues (interaction-queues)/api/v1/interaction-queues · /api/crm/interaction-queues · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, name_local text, description text, connection_id uuid, channels _text, routing text, required_skills _text, priority integer, target_answer_seconds integer, max_wait_seconds integer, callback_after_seconds integer, max_queue_length integer, wrap_up_seconds integer, business_hours jsonb, holiday_calendar_id uuid (read-only), out_of_hours_action text, overflow_queue_id uuid, greeting text, greeting_local text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Recordings (call-recordings)/api/v1/call-recordings · /api/crm/call-recordings · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), call_id uuid (read-only), external_id text (read-only), url text (read-only), media_type text (read-only), duration_seconds integer (read-only), size_bytes bigint (read-only), announcement_played boolean (read-only), consent_given boolean (read-only), retain_until date, deleted_at timestamp with time zone (read-only), transcript text (read-only), transcript_language text (read-only), summary text, summary_local text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Who Is Available (agent-presence)/api/v1/agent-presence · /api/crm/agent-presence · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), user_id uuid (read-only), state text, reason text, since timestamp with time zone (read-only), external_state text (read-only), external_synced_at timestamp with time zone (read-only), current_call_id uuid (read-only), calls_today integer (read-only), talk_seconds_today integer (read-only), device text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Puntuación de clientes potenciales

RecursoEndpointsOperacionesCampos
Lead Score History (lead-score-history)/api/v1/lead-score-history · /api/crm/lead-score-history · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), lead_id uuid (read-only), model_id uuid (read-only), score numeric (read-only), grade text (read-only), factors jsonb (read-only), trigger_kind text (read-only), actions_taken text (read-only), scored_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Lead Scoring Models (lead-scoring-models)/api/v1/lead-scoring-models · /api/crm/lead-scoring-models · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), model_no text (read-only), name* text, kind text, status text (read-only), is_active boolean (read-only), grade_a_min numeric, grade_b_min numeric, grade_c_min numeric, auto_qualify boolean, qualify_threshold numeric, route_threshold numeric, route_to_user_id uuid, decay_half_life_days integer, rescore_on_change boolean, intercept numeric (read-only), coefficients jsonb (read-only), training jsonb (read-only), trained_at timestamp with time zone (read-only), description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Lead Scoring Rules (lead-scoring-rules)/api/v1/lead-scoring-rules · /api/crm/lead-scoring-rules · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), model_id* uuid, rule_group text, attribute* text, operator text, value text, value_to text, points numeric, max_points numeric, label text, sort_order integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Marketing

RecursoEndpointsOperacionesCampos
Campaigns (campaigns)/api/v1/campaigns · /api/crm/campaigns · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), location_id uuid, campaign_no text (read-only), name* text, campaign_type text, channel text, audience_type text, segment_id uuid, objective text, start_date date, end_date date, status text, budget_amount numeric, actual_cost numeric, currency text, target_reach integer, target_conversions integer, cost_center_id uuid, owner_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Events (events)/api/v1/events · /api/crm/events · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), location_id uuid, event_no text (read-only), name* text, event_type text, campaign_id uuid, description text, starts_at timestamp with time zone, ends_at timestamp with time zone, venue text, is_virtual boolean, meeting_url text, capacity integer, registered_count integer (read-only), attended_count integer (read-only), cost numeric, cost_center_id uuid, status text, owner_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Segmentation (segments)/api/v1/segments · /api/crm/segments · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, subject_type text, is_dynamic boolean, criteria jsonb, member_count integer (read-only), last_built_at timestamp with time zone (read-only), is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Otros recursos

RecursoEndpointsOperacionesCampos
Tax filing calendar (tax-filing-calendar)/api/v1/tax-filing-calendar · /api/crm/tax-filing-calendar · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), registration_id uuid (read-only), jurisdiction_id uuid (read-only), period_kind text (read-only), period_code text (read-only), period_from date (read-only), period_to date (read-only), return_due_date date (read-only), payment_due_date date (read-only), prepayment_due_date date (read-only), form_code text (read-only), run_id uuid (read-only), status text, filed_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Tax jurisdiction totals (tax-jurisdiction-totals)/api/v1/tax-jurisdiction-totals · /api/crm/tax-jurisdiction-totals · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), run_id uuid (read-only), jurisdiction_id uuid (read-only), jurisdiction_code text (read-only), jurisdiction_name text (read-only), level text (read-only), parent_code text (read-only), authority_id uuid (read-only), authority_name text (read-only), registration_no text (read-only), tax_head text (read-only), rate_pct numeric (read-only), gross_sales numeric (read-only), exempt_sales numeric (read-only), taxable_base numeric (read-only), tax_collected numeric (read-only), tax_due numeric (read-only), input_credit numeric (read-only), net_payable numeric (read-only), transaction_count integer (read-only), variance numeric (read-only), is_registered boolean (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Tax jurisdiction zones (tax-jurisdiction-zones)/api/v1/tax-jurisdiction-zones · /api/crm/tax-jurisdiction-zones · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), jurisdiction_id* uuid, country* text, region_code text, county text, city text, postal_from text, postal_to text, postal_plus4_from text, postal_plus4_to text, is_partial boolean, effective_from date, effective_to date, source text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Tax registrations (tax-registrations)/api/v1/tax-registrations · /api/crm/tax-registrations · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), jurisdiction_id* uuid, authority_id uuid, code* text, name* text, tax_family text, registration_no text, nexus_kind text, nexus_threshold_amount numeric, nexus_threshold_txns integer, nexus_lookback_months integer, filing_frequency text, return_due_day integer, payment_due_day integer, prepayment_required boolean, prepayment_pct numeric, prepayment_due_day integer, vendor_discount_pct numeric, vendor_discount_cap numeric, filing_portal text, filing_method text, effective_from date, effective_to date, status text, notes text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Tax wizard findings (tax-wizard-findings)/api/v1/tax-wizard-findings · /api/crm/tax-wizard-findings · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), run_id uuid (read-only), step_id uuid (read-only), step_key text (read-only), finding_kind text (read-only), severity text (read-only), title text (read-only), title_local text (read-only), detail text (read-only), detail_local text (read-only), target_module text (read-only), target_resource text (read-only), target_id uuid (read-only), document_no text (read-only), jurisdiction_id uuid (read-only), amount numeric (read-only), expected_amount numeric (read-only), difference numeric (read-only), recommendation text (read-only), recommendation_local text (read-only), status text, resolved_by uuid (read-only), resolved_at timestamp with time zone (read-only), resolution text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Tax wizard runs (tax-wizard-runs)/api/v1/tax-wizard-runs · /api/crm/tax-wizard-runs · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), pack_id uuid (read-only), registration_id uuid (read-only), jurisdiction_id uuid (read-only), country text (read-only), tax_family text (read-only), period_kind text (read-only), period_code text (read-only), period_from date (read-only), period_to date (read-only), return_due_date date (read-only), payment_due_date date (read-only), currency text (read-only), status text (read-only), current_step integer (read-only), steps_total integer (read-only), steps_done integer (read-only), gross_sales numeric (read-only), exempt_sales numeric (read-only), taxable_sales numeric (read-only), tax_collected numeric (read-only), tax_due numeric (read-only), input_credit numeric (read-only), adjustments numeric (read-only), prepaid_amount numeric (read-only), vendor_discount numeric (read-only), net_payable numeric (read-only), penalty_amount numeric (read-only), interest_amount numeric (read-only), transaction_count integer (read-only), jurisdiction_count integer (read-only), open_findings integer (read-only), blocking_findings integer (read-only), return_id uuid (read-only), journal_id uuid (read-only), filed_at timestamp with time zone (read-only), filed_by uuid (read-only), filing_reference text (read-only), paid_at timestamp with time zone (read-only), payment_reference text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), started_by uuid (read-only), started_at timestamp with time zone (read-only), closed_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Tax wizard steps (tax-wizard-steps)/api/v1/tax-wizard-steps · /api/crm/tax-wizard-steps · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), run_id uuid (read-only), step_no integer (read-only), step_key text (read-only), title text (read-only), stage text (read-only), auto_kind text (read-only), is_mandatory boolean (read-only), needs_approval boolean (read-only), status text (read-only), result jsonb (read-only), findings_found integer (read-only), skip_reason text (read-only), ran_by uuid (read-only), ran_at timestamp with time zone (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), duration_ms integer (read-only), error_message text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Punto de venta

RecursoEndpointsOperacionesCampos
POS Registers (pos-registers)/api/v1/pos-registers · /api/crm/pos-registers · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), store_id* uuid, code* text, name* text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
POS Sessions (pos-sessions)/api/v1/pos-sessions · /api/crm/pos-sessions · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), session_no text (read-only), register_id uuid (read-only), store_id uuid (read-only), cashier_user_id uuid (read-only), business_date date (read-only), opened_at timestamp with time zone (read-only), opening_float numeric (read-only), closed_at timestamp with time zone (read-only), counted_cash numeric (read-only), expected_cash numeric (read-only), over_short numeric (read-only), close_note text (read-only), status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
POS Stores (pos-stores)/api/v1/pos-stores · /api/crm/pos-stores · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, location_id uuid, warehouse_id uuid, bin_id uuid, price_list_id uuid, currency text, country text, region text, prices_include_tax boolean, default_tax_code_id uuid, payment_provider_id uuid, cash_account_no text, card_account_no text, revenue_account_no text, tax_account_no text, over_short_account_no text, cogs_account_no text, inventory_account_no text, max_discount_pct numeric, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
POS Tickets (pos-tickets)/api/v1/pos-tickets · /api/crm/pos-tickets · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), ticket_no text (read-only), session_id uuid (read-only), store_id uuid (read-only), ticket_kind text (read-only), original_ticket_id uuid (read-only), account_id uuid (read-only), currency text (read-only), subtotal numeric (read-only), discount_total numeric (read-only), net_total numeric (read-only), tax_total numeric (read-only), total numeric (read-only), tendered numeric (read-only), change_given numeric (read-only), offline_ref text (read-only), sold_at timestamp with time zone (read-only), return_reason text (read-only), status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Precios

RecursoEndpointsOperacionesCampos
Price List Entries (price-list-lines)/api/v1/price-list-lines · /api/crm/price-list-lines · /{id}list, get, create, change, deleteid uuid (read-only), price_list_id* uuid, item_id uuid, category_id uuid, uom text, min_quantity numeric, max_quantity numeric, unit_price numeric, discount_pct numeric, markup_pct numeric, price_basis text, is_negotiable boolean, min_margin_pct numeric, effective_from date, effective_to date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), formula_base text, surcharge_amount numeric
Price Lists (price-lists)/api/v1/price-lists · /api/crm/price-lists · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid, code* text, name* text, description text, currency text, list_type text, parent_list_id uuid, adjustment_pct numeric, rounding text, is_tax_inclusive boolean, status text, effective_from date, effective_to date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Pricing Procedures

RecursoEndpointsOperacionesCampos
Access Sequence Steps (pricing-access-steps)/api/v1/pricing-access-steps · /api/crm/pricing-access-steps · /{id}list, get, create, change, deleteid uuid (read-only), sequence_id* uuid, step_no* integer, key_fields _text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Customer Pricing Group Assignments (account-pricing-groups)/api/v1/account-pricing-groups · /api/crm/account-pricing-groups · /{id}list, get, create, change, deleteid uuid (read-only), account_id* uuid, group_id* uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Customer Pricing Groups (pricing-groups)/api/v1/pricing-groups · /api/crm/pricing-groups · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Price List Discount Steps (price-list-steps)/api/v1/price-list-steps · /api/crm/price-list-steps · /{id}list, get, create, change, deleteid uuid (read-only), price_list_id* uuid, line_id uuid, step_no* integer, label text, kind text, value* numeric, min_quantity numeric, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pricing Access Sequences (pricing-access-sequences)/api/v1/pricing-access-sequences · /api/crm/pricing-access-sequences · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pricing Condition Records (pricing-condition-records)/api/v1/pricing-condition-records · /api/crm/pricing-condition-records · /{id}list, get, create, change, deleteid uuid (read-only), condition_type_id* uuid, account_id uuid, pricing_group_id uuid, item_id uuid, category_id uuid, price_list_id uuid, min_quantity numeric, value* numeric, valid_from date, valid_to date, is_active boolean, notes text, supplier_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pricing Condition Types (pricing-condition-types)/api/v1/pricing-condition-types · /api/crm/pricing-condition-types · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, class text, calc text, source text, access_sequence_id uuid, is_active boolean, description text, charge_kind text, charge_to text, applies_to text, landed_cost_charge_type_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pricing Procedure by Document (pricing-procedure-assignments)/api/v1/pricing-procedure-assignments · /api/crm/pricing-procedure-assignments · /{id}list, get, create, change, deleteid uuid (read-only), document_type* text, procedure_id* uuid, apply_on_save boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pricing Procedure Steps (pricing-procedure-steps)/api/v1/pricing-procedure-steps · /api/crm/pricing-procedure-steps · /{id}list, get, create, change, deleteid uuid (read-only), procedure_id* uuid, step_no* integer, condition_type_id* uuid, base_from_step integer, is_mandatory boolean, is_statistical boolean, label text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pricing Procedures (pricing-procedures)/api/v1/pricing-procedures · /api/crm/pricing-procedures · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, is_default boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Sales Document Charges (sales-document-charges)/api/v1/sales-document-charges · /api/crm/sales-document-charges · /{id}list, get, create, change, deleteid uuid (read-only), document_type* text, document_id* uuid, line_id uuid, condition_type_id uuid, record_id uuid (read-only), step_no integer (read-only), charge_kind text, charge_to text, calc text (read-only), rate numeric (read-only), base_amount numeric (read-only), amount numeric, is_statistical boolean, origin text (read-only), description text, amount_invoiced numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Prospección

RecursoEndpointsOperacionesCampos
Prospects (prospects)/api/v1/prospects · /api/crm/prospects · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), location_id uuid, prospect_no text (read-only), prospect_type text, first_name text, last_name text, preferred_name text, email text, phone text, date_of_birth date, country text, city text, organization_name text, industry text, employee_count integer, annual_revenue numeric, source text, source_detail text, campaign_id uuid, referral_id uuid (read-only), owner_id uuid, stage text, score numeric, score_basis text, rating text, interest_program_id uuid, interest_term_id uuid, estimated_value numeric, account_id uuid (read-only), contact_id uuid (read-only), applicant_id uuid (read-only), opportunity_id uuid (read-only), converted_at timestamp with time zone (read-only), disqualify_reason text (read-only), next_action text, next_action_at date, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), linkedin_url text, personal_email text
Referrals (referrals)/api/v1/referrals · /api/crm/referrals · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), referral_no text (read-only), referrer_type text, referrer_id uuid, referrer_name text, referrer_email text, referred_name* text, referred_email text, referred_phone text, prospect_id uuid, program_id uuid, campaign_id uuid, status text, submitted_at timestamp with time zone (read-only), converted_at timestamp with time zone (read-only), reward_type text, reward_amount numeric, reward_status text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
RecursoEndpointsOperacionesCampos
Arrangement Installments (util-arrangement-installments)/api/v1/util-arrangement-installments · /api/crm/util-arrangement-installments · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), arrangement_id uuid (read-only), seq integer (read-only), due_date date (read-only), amount numeric (read-only), paid_amount numeric (read-only), status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Bill Lines (util-bill-lines)/api/v1/util-bill-lines · /api/crm/util-bill-lines · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), bill_id uuid (read-only), line_no integer (read-only), agreement_id uuid (read-only), service_type text (read-only), line_type text (read-only), description text (read-only), quantity numeric (read-only), unit_rate numeric (read-only), amount numeric (read-only), tier_no integer (read-only), read_from_id uuid (read-only), read_to_id uuid (read-only), estimated boolean (read-only), tax_code_id uuid (read-only), revenue_account_no text (read-only), cost_center_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Customer · Credit Profile (customer-credit)/api/v1/customer-credit · /api/crm/customer-credit · /{id}list, get, create, change, deleteid uuid (read-only), account_id* uuid, org_unit_id uuid, credit_limit numeric, currency text, order_limit numeric, includes_open_orders boolean, includes_undelivered boolean, credit_rating text, rating_agency text, rating_date date, internal_score numeric, risk_category text, on_limit_breach text, is_on_credit_hold boolean, hold_reason text, hold_placed_on date, hold_placed_by uuid, has_credit_insurance boolean, insurer text, insured_amount numeric, has_guarantee boolean, guarantee_expires date, requires_prepayment boolean, requires_letter_of_credit boolean, reviewed_on date, reviewed_by uuid, next_review_on date, effective_from date, effective_to date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Customer · Financial (customer-financials)/api/v1/customer-financials · /api/crm/customer-financials · /{id}list, get, create, change, deleteid uuid (read-only), account_id* uuid, site_id uuid, org_unit_id uuid, currency text, payment_terms_id uuid, payment_method text, bank_name text, bank_account_last4 text, mandate_reference text, mandate_signed_on date, invoice_grouping text, statement_cycle text, dunning_profile text, is_dunning_exempt boolean, late_fee_pct numeric, standard_discount_pct numeric, early_settlement_discount_pct numeric, rebate_scheme text, withholding_tax_pct numeric, tax_registration_no text, effective_from date, effective_to date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Customer · Relationships (customer-relationships)/api/v1/customer-relationships · /api/crm/customer-relationships · /{id}list, get, create, change, deleteid uuid (read-only), from_account_id* uuid, to_account_id* uuid, from_site_id uuid, to_site_id uuid, relationship* text, rolls_up_credit boolean, share_pct numeric, notes text, effective_from date, effective_to date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Customer · Selling Context (customer-orgs)/api/v1/customer-orgs · /api/crm/customer-orgs · /{id}list, get, create, change, deleteid uuid (read-only), account_id* uuid, org_unit_id* uuid, local_account_no text, supplier_number_at_customer text, currency text, price_list_id uuid, payment_terms_id uuid, salesperson_id uuid, sales_channel text, territory text, order_type_default text, allow_partial_ship boolean, allow_backorder boolean, requires_credit_check boolean, revenue_account_no text, receivable_account_no text, status text, effective_from date, effective_to date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Customer Sites (customer-sites)/api/v1/customer-sites · /api/crm/customer-sites · /{id}list, get, create, change, deleteid uuid (read-only), account_id* uuid, site_no* text, name* text, address_id uuid, is_sold_to boolean, is_ship_to boolean, is_bill_to boolean, is_payer boolean, is_install_at boolean, is_service_at boolean, is_primary boolean, selling_org_unit_id uuid, ship_via text, freight_terms text, incoterm text, delivery_lead_days integer, delivery_window text, delivery_instructions text, requires_appointment boolean, source_warehouse_id uuid, invoice_delivery text, invoice_email text, requires_po_number boolean, customer_reference text, tax_registration_no text, tax_jurisdiction text, is_tax_exempt boolean, tax_exemption_no text, tax_exemption_expires date, contact_id uuid, phone text, email text, status text, notes text, effective_from date, effective_to date, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Interaction Events (call-events)/api/v1/call-events · /api/crm/call-events · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), call_id uuid (read-only), seq integer (read-only), event_kind text (read-only), from_user_id uuid (read-only), to_user_id uuid (read-only), to_queue_id uuid (read-only), detail text (read-only), payload jsonb (read-only), occurred_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Recipients (broadcast-recipients)/api/v1/broadcast-recipients · /api/crm/broadcast-recipients · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), broadcast_id uuid (read-only), channel text (read-only), contact_id uuid (read-only), lead_id uuid (read-only), account_id uuid (read-only), address text (read-only), display_name text (read-only), locale text (read-only), status text (read-only), suppression_reason text (read-only), external_id text (read-only), sent_at timestamp with time zone (read-only), delivered_at timestamp with time zone (read-only), first_opened_at timestamp with time zone (read-only), last_opened_at timestamp with time zone (read-only), open_count integer (read-only), click_count integer (read-only), bounced_at timestamp with time zone (read-only), bounce_type text (read-only), unsubscribed_at timestamp with time zone (read-only), error_message text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Relaciones

RecursoEndpointsOperacionesCampos
Activities (activities)/api/v1/activities · /api/crm/activities · /{id}list, get, create, change, deleteid uuid (read-only), activity_type text, subject* text, due_at timestamp with time zone, status text, account_id uuid, contact_id uuid, opportunity_id uuid, owner_id uuid (read-only), notes text, org_unit_id uuid (read-only), location_id uuid (read-only), warehouse_id uuid (read-only), lead_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), source text (read-only), external_id text (read-only), mailbox_connection_id uuid (read-only), direction text (read-only), from_address text (read-only), to_addresses text (read-only), body_text text (read-only), starts_at timestamp with time zone (read-only), ends_at timestamp with time zone (read-only), location_text text (read-only), calendar_event_id text (read-only), calendar_pushed_at timestamp with time zone (read-only), calendar_push_error text (read-only)
Interaction History (interactions)/api/v1/interactions · /api/crm/interactions · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), subject_type* text, subject_id* uuid, interaction_type text, direction text, channel text, subject* text, body text, occurred_at timestamp with time zone, duration_minutes integer, outcome text, sentiment text, campaign_id uuid, event_id uuid, performed_by uuid (read-only), is_automatic boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Relationship Management (relationships)/api/v1/relationships · /api/crm/relationships · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), from_type* text, from_id* uuid, to_type* text, to_id uuid, to_label text, relationship_type* text, strength text, is_primary boolean, since_date date, until_date date, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Tasks & Follow-ups (tasks)/api/v1/tasks · /api/crm/tasks · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), task_no text (read-only), title* text, description text, task_type text, subject_type text, subject_id uuid, assigned_to uuid, due_at timestamp with time zone, remind_at timestamp with time zone, priority text, status text, completed_at timestamp with time zone (read-only), completed_by uuid (read-only), outcome text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), campaign_id uuid (read-only)

Ventas

RecursoEndpointsOperacionesCampos
Lead Contacts (lead-contacts)/api/v1/lead-contacts · /api/crm/lead-contacts · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), lead_id uuid, lead_name text, first_name text, last_name text, email text, mobile text, office_phone text, extension text, job_title text, country text, state text, city text, area text, postal_code text, address_line1 text, address_line2 text, linkedin_url text, business_card text, status text, owner_name text, ownership_type text, lead_group text, about text, notes text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Leads (leads)/api/v1/leads · /api/crm/leads · /{id}list, get, create, change, deleteid uuid (read-only), source text, company* text, contact_name text, email text, phone text, score integer (read-only), score_factors jsonb (read-only), status text, owner_id uuid (read-only), converted_account_id uuid (read-only), org_unit_id uuid (read-only), location_id uuid (read-only), warehouse_id uuid (read-only), website text, job_title text, industry text, company_size text, linkedin_url text, city text, country text, notes text, state text, postal_code text, address_line1 text, address_line2 text, metro_area text, annual_revenue numeric, sic_code text, naics_code text, locations_count integer, fiscal_year_end text, owner_name text, ownership_type text, description text, lead_group text, contact_first_name text, contact_last_name text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), score_grade text (read-only), score_model_id uuid (read-only), scored_at timestamp with time zone (read-only), routed_at timestamp with time zone (read-only), closed_reason text (read-only), campaign_id uuid, personal_email text
Opportunities (opportunities)/api/v1/opportunities · /api/crm/opportunities · /{id}list, get, create, change, deleteid uuid (read-only), opp_no text (read-only), account_id* uuid, name* text, stage text (read-only), amount numeric, currency text (read-only), probability integer (read-only), close_date date, owner_id uuid (read-only), loss_reason text (read-only), ar_invoice_id uuid (read-only), org_unit_id uuid (read-only), location_id uuid (read-only), warehouse_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), forecast_category text (read-only), forecast_override_reason text (read-only), team_id uuid, territory_id uuid, product_line text, closed_at timestamp with time zone (read-only), renewal_of_contract_id uuid (read-only)

Canales de venta

RecursoEndpointsOperacionesCampos
Channel Connectors (commerce-connectors)/api/v1/commerce-connectors · /api/crm/commerce-connectors · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, platform* text, sandbox_flavour text, shop_domain text, base_url text, api_version text, marketplace_id text, seller_id text, region text, client_id text, token_expires_at timestamp with time zone (read-only), secrets_set text (read-only), webhook_key text (read-only), account_id uuid, warehouse_id uuid, location_id uuid, currency text, sync_inventory boolean, poll_orders boolean, confirm_orders boolean, stock_buffer numeric, orders_cursor text (read-only), last_order_poll_at timestamp with time zone (read-only), last_inventory_sync_at timestamp with time zone (read-only), status text (read-only), last_error text (read-only), is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Channel Orders (commerce-orders)/api/v1/commerce-orders · /api/crm/commerce-orders · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), connector_id uuid (read-only), channel_order_id text (read-only), channel_order_no text (read-only), ordered_at timestamp with time zone (read-only), customer_name text (read-only), customer_email text (read-only), currency text (read-only), total numeric (read-only), sales_order_id uuid (read-only), status text (read-only), error text (read-only), received_via text (read-only), times_seen integer (read-only), payload jsonb (read-only), fulfilment_status text (read-only), tracking_no text (read-only), carrier text (read-only), fulfilment_pushed_at timestamp with time zone (read-only), fulfilment_error text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Channel Payouts (commerce-settlements)/api/v1/commerce-settlements · /api/crm/commerce-settlements · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), connector_id uuid (read-only), settlement_ref text (read-only), period_start date (read-only), period_end date (read-only), currency text (read-only), gross_sales numeric (read-only), fees numeric (read-only), refunds numeric (read-only), net_payout numeric (read-only), order_count integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Channel SKUs (commerce-sku-map)/api/v1/commerce-sku-map · /api/crm/commerce-sku-map · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), connector_id* uuid, channel_sku* text, item_id* uuid, channel_product_id text, channel_variant_id text, inventory_item_id text, last_pushed_qty numeric (read-only), last_pushed_at timestamp with time zone (read-only), is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Channel Sync Runs (commerce-sync-runs)/api/v1/commerce-sync-runs · /api/crm/commerce-sync-runs · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), connector_id uuid (read-only), run_kind text (read-only), trigger_kind text (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), counts jsonb (read-only), error text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Channel Webhooks (commerce-events)/api/v1/commerce-events · /api/crm/commerce-events · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), connector_id uuid (read-only), topic text (read-only), external_id text (read-only), verified boolean (read-only), outcome text (read-only), detail text (read-only), source_address text (read-only), received_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Sales Order Types

RecursoEndpointsOperacionesCampos
Sales Order Settings (sales-order-settings)/api/v1/sales-order-settings · /api/crm/sales-order-settings · /{id}list, get, create, change, deleteid uuid (read-only), zero_total_rule text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Sales Order Types (order-types)/api/v1/order-types · /api/crm/order-types · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, kind text, number_prefix text, number_digits integer, next_number bigint, default_warehouse_id uuid, credit_check text, allow_partial_ship text, is_default boolean, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Venta

RecursoEndpointsOperacionesCampos
Deliveries (deliveries)/api/v1/deliveries · /api/crm/deliveries · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), delivery_no text (read-only), sales_order_id uuid, account_id* uuid, delivery_date date, status text, ship_to_address text, incoterms text, goods_issued_at timestamp with time zone (read-only), notes text, location_id uuid (read-only), warehouse_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), currency text, exchange_rate numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), eway_bill_required boolean (read-only), consignment_value numeric (read-only)
Quotation Approval Rules (quote-approval-rules)/api/v1/quote-approval-rules · /api/crm/quote-approval-rules · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid, code* text, name* text, priority integer, amount_threshold numeric, discount_pct_threshold numeric, account_id uuid, approver_kind text, levels integer, approver_role text, approver_employee_id uuid, due_in_hours integer, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Quotation Approvals (quote-approvals)/api/v1/quote-approvals · /api/crm/quote-approvals · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), quotation_id uuid (read-only), rule_id uuid (read-only), level_no integer (read-only), approver_kind text (read-only), approver_user_id uuid (read-only), approver_employee_id uuid (read-only), approver_role text (read-only), routed_by text (read-only), amount numeric (read-only), discount_pct numeric (read-only), currency text (read-only), status text (read-only), requested_by uuid (read-only), requested_at timestamp with time zone (read-only), due_at timestamp with time zone (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), comment text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Quotations (quotations)/api/v1/quotations · /api/crm/quotations · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), quote_no text (read-only), account_id* uuid, contact_id uuid, opportunity_id uuid, quote_date date, valid_until date, currency* text, status text, subtotal numeric (read-only), tax_total numeric (read-only), total numeric (read-only), payment_terms_days integer, notes text, location_id uuid (read-only), warehouse_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), exchange_rate numeric, base_total numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), accepted_via text (read-only), accepted_by_portal_user_id uuid (read-only), supplier_gstin text (read-only), buyer_gstin text (read-only), place_of_supply text (read-only), is_interstate boolean (read-only), is_reverse_charge boolean (read-only), export_type text (read-only), cgst_total numeric (read-only), sgst_total numeric (read-only), igst_total numeric (read-only), cess_total numeric (read-only), charges_total numeric (read-only), accrued_charges_total numeric (read-only)
Sales Orders (sales-orders)/api/v1/sales-orders · /api/crm/sales-orders · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), so_no text (read-only), account_id* uuid, contact_id uuid, quotation_id uuid, opportunity_id uuid, order_date date, requested_date date, currency* text, status text, subtotal numeric (read-only), tax_total numeric (read-only), total numeric (read-only), customer_po_ref text, ship_to_address text, notes text, location_id uuid (read-only), warehouse_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), cancelled_at timestamp with time zone (read-only), cancelled_by uuid (read-only), cancel_reason text (read-only), reversed_by_id uuid (read-only), reverses_id uuid (read-only), exchange_rate numeric, base_total numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), edi_interchange_id uuid (read-only), customer_po_date date (read-only), source_channel text (read-only), channel_order_ref text (read-only), commerce_connector_id uuid (read-only), supplier_gstin text (read-only), buyer_gstin text (read-only), place_of_supply text (read-only), is_interstate boolean (read-only), is_reverse_charge boolean (read-only), export_type text (read-only), cgst_total numeric (read-only), sgst_total numeric (read-only), igst_total numeric (read-only), cess_total numeric (read-only), order_type_id uuid, charges_total numeric (read-only), accrued_charges_total numeric (read-only)
Shipments (shipments)/api/v1/shipments · /api/crm/shipments · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), shipment_no text (read-only), delivery_id uuid, account_id uuid, carrier text, service_level text, tracking_no text, ship_date date, eta_date date, delivered_at timestamp with time zone (read-only), freight_cost numeric, currency text, status text, notes text, location_id uuid (read-only), warehouse_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), exchange_rate numeric, base_freight_cost numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Servicio

RecursoEndpointsOperacionesCampos
Field Work Orders (work-orders)/api/v1/work-orders · /api/crm/work-orders · /{id}list, get, create, change, deleteid uuid (read-only), wo_no text (read-only), case_id uuid, account_id* uuid, work_type text, priority text, status text, scheduled_at timestamp with time zone, technician_id uuid, summary* text, completion_notes text, org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), location_id uuid (read-only), warehouse_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), required_skill text
Service Cases (cases)/api/v1/cases · /api/crm/cases · /{id}list, get, create, change, deleteid uuid (read-only), case_no text (read-only), account_id* uuid, contact_id uuid, source text, subject* text, description text, priority text, status text, sla_due_at timestamp with time zone, assigned_to uuid (read-only), org_unit_id uuid (read-only), cost_center_id uuid (read-only), profit_center_id uuid (read-only), location_id uuid (read-only), warehouse_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only), portal_user_id uuid (read-only)

Servicio y comentarios

RecursoEndpointsOperacionesCampos
Communication Consent (consents)/api/v1/consents · /api/crm/consents · /{id}list, get, create, change, deleteid uuid (read-only), subject_type* text, subject_id* uuid, channel* text, purpose text, opted_in boolean, basis text, captured_at timestamp with time zone (read-only), captured_via text, withdrawn_at timestamp with time zone (read-only), notes text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Communication Templates (templates)/api/v1/templates · /api/crm/templates · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, channel text, purpose text, subject text, body* text, merge_fields _text, language text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Concierge (concierge)/api/v1/concierge · /api/crm/concierge · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), request_no text (read-only), subject_type text, subject_id* uuid, category text, channel text, subject* text, detail text, priority text, assigned_to uuid, status text, sla_due_at timestamp with time zone, first_response_at timestamp with time zone (read-only), resolved_at timestamp with time zone (read-only), resolution text, satisfaction_score integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Survey Responses (survey-responses)/api/v1/survey-responses · /api/crm/survey-responses · /{id}list, get, create, change, deleteid uuid (read-only), survey_id* uuid, subject_type text, subject_id uuid, submitted_at timestamp with time zone (read-only), score integer, sentiment text (read-only), comment text, followed_up boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Surveys & Feedback (surveys)/api/v1/surveys · /api/crm/surveys · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, survey_type text, audience_type text, segment_id uuid, event_id uuid, campaign_id uuid, introduction text, opens_at timestamp with time zone, closes_at timestamp with time zone, is_anonymous boolean, status text, sent_count integer, response_count integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Servicios públicos

RecursoEndpointsOperacionesCampos
Customer Requests (util-requests)/api/v1/util-requests · /api/crm/util-requests · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), request_no text (read-only), request_type text (read-only), channel text (read-only), status text (read-only), service_account_id uuid (read-only), portal_user_id uuid (read-only), problem_type text (read-only), full_name text (read-only), email text (read-only), phone text (read-only), address_text text (read-only), postal_code text (read-only), requested_date date (read-only), details text (read-only), source_ip text (read-only), service_order_id uuid (read-only), reviewed_by uuid (read-only), reviewed_at timestamp with time zone (read-only), review_note text (read-only), premise_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Portal Account Links (util-portal-links)/api/v1/util-portal-links · /api/crm/util-portal-links · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), portal_user_id uuid (read-only), service_account_id uuid (read-only), status text (read-only), linked_via text (read-only), linked_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Premises (util-premises)/api/v1/util-premises · /api/crm/util-premises · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), premise_no* text, address_line1* text, address_line2 text, city text, region text, postal_code text, country text, parcel_apn text, district text, premise_type text, route_id uuid, route_seq integer, latitude numeric, longitude numeric, service_types _text, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Service Accounts (util-accounts)/api/v1/util-accounts · /api/crm/util-accounts · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), account_no* text, customer_account_id* uuid, contact_id uuid, account_class text, status text (read-only), billing_cycle_id uuid, mailing_address text, email text, phone text, language text, paperless boolean, autopay boolean (read-only), life_support boolean, life_support_note text, deposit_held numeric (read-only), credit_balance numeric (read-only), collection_hold_until date, opened_on date (read-only), closed_on date (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Service Agreements (util-agreements)/api/v1/util-agreements · /api/crm/util-agreements · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), agreement_no text (read-only), service_account_id uuid (read-only), premise_id uuid (read-only), service_type text (read-only), rate_plan_id* uuid, meter_id uuid (read-only), start_date date (read-only), end_date date (read-only), status text (read-only), connection text (read-only), billed_through date (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Facturación de servicios públicos

RecursoEndpointsOperacionesCampos
Bill Runs (util-bill-runs)/api/v1/util-bill-runs · /api/crm/util-bill-runs · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), run_no* text, billing_cycle_id uuid, period_start* date, period_end* date, bill_date date, due_date date, status text (read-only), bill_count integer (read-only), exception_count integer (read-only), total_amount numeric (read-only), prepared_by uuid (read-only), prepared_at timestamp with time zone (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), posted_by uuid (read-only), posted_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Billing Cycles (util-billing-cycles)/api/v1/util-billing-cycles · /api/crm/util-billing-cycles · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, read_day integer, bill_day integer, due_days integer, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Leak Adjustments (util-leak-adjustments)/api/v1/util-leak-adjustments · /api/crm/util-leak-adjustments · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), adjustment_no text (read-only), service_account_id uuid (read-only), bill_id uuid (read-only), service_type text (read-only), method text (read-only), billed_qty numeric (read-only), normal_qty numeric (read-only), excess_qty numeric (read-only), billed_amount numeric (read-only), adjusted_amount numeric (read-only), credit_amount numeric (read-only), reason text (read-only), status text (read-only), requested_by uuid (read-only), requested_at timestamp with time zone (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), decision_note text (read-only), credit_memo_id uuid (read-only), to_credit_balance numeric (read-only), journal_id uuid (read-only), shown_on_bill_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Rate Blocks (util-rate-tiers)/api/v1/util-rate-tiers · /api/crm/util-rate-tiers · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), rate_plan_id* uuid, season text, tier_no* integer, from_qty numeric, to_qty numeric, unit_rate* numeric, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Rate Fees (util-rate-fees)/api/v1/util-rate-fees · /api/crm/util-rate-fees · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), rate_plan_id* uuid, code* text, description* text, fee_type text, amount* numeric, taxable boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Rate Plans (util-rate-plans)/api/v1/util-rate-plans · /api/crm/util-rate-plans · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, service_type* text, customer_class text, unit text, fixed_charge numeric, minimum_bill numeric, summer_months _int4, tax_code_id uuid, revenue_account_no text, effective_from date, effective_to date, status text, notes text, service_charge_account_no text, cost_center_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Utility Bills (util-bills)/api/v1/util-bills · /api/crm/util-bills · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), bill_no text (read-only), bill_kind text (read-only), bill_run_id uuid (read-only), service_account_id uuid (read-only), period_start date (read-only), period_end date (read-only), bill_date date (read-only), due_date date (read-only), currency text (read-only), previous_balance numeric (read-only), credit_applied numeric (read-only), deposit_applied numeric (read-only), subtotal numeric (read-only), tax_total numeric (read-only), total numeric (read-only), amount_due numeric (read-only), usage_summary jsonb (read-only), status text (read-only), exception_reason text (read-only), ar_invoice_id uuid (read-only), rebill_of_id uuid (read-only), cancel_reason text (read-only), charge_reason text (read-only), autopay_mandate_id uuid (read-only), emailed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Servicios de caja y pagos

RecursoEndpointsOperacionesCampos
Autopay (util-autopay)/api/v1/util-autopay · /api/crm/util-autopay · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), service_account_id uuid (read-only), card_token text (read-only), card_mask text (read-only), consent_text text (read-only), consent_at timestamp with time zone (read-only), consent_ip text (read-only), enrolled_via text (read-only), status text (read-only), cancelled_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Cash Drawers (util-cash-drawers)/api/v1/util-cash-drawers · /api/crm/util-cash-drawers · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, location_text text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Cash Sessions (util-cash-sessions)/api/v1/util-cash-sessions · /api/crm/util-cash-sessions · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), session_no text (read-only), drawer_id uuid (read-only), cashier_user_id uuid (read-only), business_date date (read-only), opened_at timestamp with time zone (read-only), opening_float numeric (read-only), closed_at timestamp with time zone (read-only), counted_cash numeric (read-only), counted_checks numeric (read-only), expected_cash numeric (read-only), expected_checks numeric (read-only), over_short numeric (read-only), close_note text (read-only), close_approved_by uuid (read-only), close_approved_at timestamp with time zone (read-only), deposit_ref text (read-only), status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Lockbox & Bank Files (util-payment-imports)/api/v1/util-payment-imports · /api/crm/util-payment-imports · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), import_no text (read-only), file_name text (read-only), channel text (read-only), rows_total integer (read-only), rows_posted integer (read-only), rows_duplicate integer (read-only), rows_rejected integer (read-only), amount_posted numeric (read-only), detail jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Online Payments (util-payment-requests)/api/v1/util-payment-requests · /api/crm/util-payment-requests · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), request_no text (read-only), service_account_id uuid (read-only), portal_user_id uuid (read-only), provider_id uuid (read-only), amount numeric (read-only), currency text (read-only), status text (read-only), provider_reference text (read-only), payment_id uuid (read-only), confirmed_via text (read-only), confirmed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Refunds (util-refunds)/api/v1/util-refunds · /api/crm/util-refunds · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), refund_no text (read-only), service_account_id uuid (read-only), source text (read-only), amount numeric (read-only), method text (read-only), journal_id uuid (read-only), reason text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Utility Payments (util-payments)/api/v1/util-payments · /api/crm/util-payments · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), payment_no text (read-only), service_account_id uuid (read-only), session_id uuid (read-only), channel text (read-only), tender text (read-only), amount numeric (read-only), currency text (read-only), applied_amount numeric (read-only), unapplied_amount numeric (read-only), card_last4 text (read-only), check_no text (read-only), reference text (read-only), external_ref text (read-only), received_at timestamp with time zone (read-only), status text (read-only), credit_journal_id uuid (read-only), void_reason text (read-only), void_requested_by uuid (read-only), void_requested_at timestamp with time zone (read-only), void_approved_by uuid (read-only), void_approved_at timestamp with time zone (read-only), taken_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Cobranzas de servicios públicos

RecursoEndpointsOperacionesCampos
Collection Actions (util-collection-actions)/api/v1/util-collection-actions · /api/crm/util-collection-actions · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), service_account_id uuid (read-only), bill_id uuid (read-only), action text (read-only), amount numeric (read-only), channel text (read-only), mail_status text (read-only), service_order_id uuid (read-only), detail jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Payment Arrangements (util-arrangements)/api/v1/util-arrangements · /api/crm/util-arrangements · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), arrangement_no text (read-only), service_account_id uuid (read-only), total_amount numeric (read-only), down_payment numeric (read-only), installments integer (read-only), start_date date (read-only), status text (read-only), requested_via text (read-only), approved_by uuid (read-only), approved_at timestamp with time zone (read-only), broken_at timestamp with time zone (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Servicio de campo de servicios públicos

RecursoEndpointsOperacionesCampos
Utility Service Orders (util-service-orders)/api/v1/util-service-orders · /api/crm/util-service-orders · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), order_no text (read-only), order_type text (read-only), priority text, status text (read-only), service_account_id uuid (read-only), premise_id uuid (read-only), meter_id uuid (read-only), agreement_id uuid (read-only), scheduled_date date, assigned_user_id uuid (read-only), description text, source text (read-only), request_id uuid (read-only), alarm_id uuid (read-only), exception_id uuid (read-only), started_at timestamp with time zone (read-only), completed_at timestamp with time zone (read-only), completed_by uuid (read-only), completion_notes text (read-only), completion_read numeric (read-only), new_meter_id uuid (read-only), new_meter_start_read numeric (read-only), cancel_reason text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Utility Settings (util-settings)/api/v1/util-settings · /api/crm/util-settings · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), grace_days integer, notice_days integer, final_notice_days integer, disconnect_days integer, late_fee_flat numeric, late_fee_pct numeric, late_fee_min_balance numeric, reconnect_fee numeric, deposit_residential numeric, deposit_commercial numeric, high_usage_pct integer, low_usage_pct integer, bill_due_days integer, revenue_account_no text, deposit_account_no text, credit_account_no text, bad_debt_account_no text, public_forms_enabled boolean, portal_link_factor text, receivable_account_no text, cash_account_no text, service_charge_account_no text, late_fee_account_no text, reconnect_fee_account_no text, leak_adjustment_account_no text, cost_center_id uuid, leak_max_per_year integer, leak_method text, leak_requires_approval boolean, leak_history_bills integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Medidores y lecturas de servicios públicos

RecursoEndpointsOperacionesCampos
Device Alarms (util-device-alarms)/api/v1/util-device-alarms · /api/crm/util-device-alarms · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), device_id uuid (read-only), meter_id uuid (read-only), alarm_type text (read-only), raised_at timestamp with time zone (read-only), status text (read-only), detail text (read-only), service_order_id uuid (read-only), cleared_at timestamp with time zone (read-only), acknowledged_by uuid (read-only), acknowledged_at timestamp with time zone (read-only), cleared_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
IoT Devices (util-iot-devices)/api/v1/util-iot-devices · /api/crm/util-iot-devices · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), key_id text (read-only), device_label* text, meter_id uuid, auth_mode text, secret_hash text (read-only), secret_cipher bytea (read-only), secret_last4 text (read-only), secret_issued_at timestamp with time zone (read-only), status text, max_reads_per_minute integer, last_seen_at timestamp with time zone (read-only), last_ip text (read-only), battery_pct numeric (read-only), signal_dbm numeric (read-only), firmware text, rejected_count integer (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Meter History (util-meter-installs)/api/v1/util-meter-installs · /api/crm/util-meter-installs · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), meter_id uuid (read-only), premise_id uuid (read-only), agreement_id uuid (read-only), action text (read-only), installed_at timestamp with time zone (read-only), removed_at timestamp with time zone (read-only), start_read numeric (read-only), end_read numeric (read-only), service_order_id uuid (read-only), notes text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Meter Reads (util-reads)/api/v1/util-reads · /api/crm/util-reads · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), meter_id uuid (read-only), premise_id uuid (read-only), read_at timestamp with time zone (read-only), reading numeric (read-only), consumption numeric (read-only), source text (read-only), read_type text (read-only), status text (read-only), rolled_over boolean (read-only), device_id uuid (read-only), import_id uuid (read-only), billed_bill_id uuid (read-only), note text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Meter Tests (util-meter-tests)/api/v1/util-meter-tests · /api/crm/util-meter-tests · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), meter_id* uuid, test_date date, result* text, accuracy_pct numeric, tested_by text, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Meters (util-meters)/api/v1/util-meters · /api/crm/util-meters · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), serial_no* text, service_type* text, make text, model text, size text, unit text, multiplier numeric, dials integer, read_type text, status text (read-only), premise_id uuid (read-only), installed_on date (read-only), last_reading numeric (read-only), last_read_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Read Exceptions (util-read-exceptions)/api/v1/util-read-exceptions · /api/crm/util-read-exceptions · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), read_id uuid (read-only), meter_id uuid (read-only), kind text (read-only), detail text (read-only), status text (read-only), resolved_by uuid (read-only), resolved_at timestamp with time zone (read-only), resolution_note text (read-only), service_order_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Read Files (AMR) (util-read-imports)/api/v1/util-read-imports · /api/crm/util-read-imports · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), import_no text (read-only), file_name text (read-only), file_format text (read-only), rows_total integer (read-only), rows_accepted integer (read-only), rows_exception integer (read-only), rows_rejected integer (read-only), rows_duplicate integer (read-only), detail jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Read Routes (util-routes)/api/v1/util-routes · /api/crm/util-routes · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, read_method text, billing_cycle_id uuid, reader_user_id uuid, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)