Company

Representa a una compañía o negocio en particular, con sus productos y servicios, sus clientes, y sus configuraciones independientes.

Estructura de Datos

Atributo	Tipo	Descripción
`id`	`int`
`name`	`string`
`email`	`string`
`domain`	`string`
`custom_domain`	`string\\|null`
`expires_at`	`datetime`
`extension_days`	`int`
`options`	`int`
`plan`	`int`
`enabled`	`bool`
`strings_json`	`object`
`styles_json`	`object`
`custom_json`	`array`
`default_iso_lang`	`string`
`folder_name`	`string`
`created_at`	`datetime\\|null`
`updated_at`	`datetime\\|null`
`deleted_at`	`datetime\\|null`
`country_iso`	`string`
`time_zone_offset`	`string`
`direct_order_prefix`	`int\\|null`
`can_providers_pick_deliveries_from_pool`	`bool`	BitMask (({@link self::options} & 0x1) !== 0)
`can_providers_confirm_deliveries_from_clients`	`bool`	BitMask (({@link self::options} & 0x2) !== 0)
`can_clients_pick_providers_for_deliveries`	`bool`	BitMask (({@link self::options} & 0x4) !== 0)
`can_clients_choose_deliveries_after_provider_confirmation`	`bool`	BitMask (({@link self::options} & 0x8) !== 0)
`can_providers_confirm_deliveries_from_admins`	`bool`	BitMask (({@link self::options} & 0x10) !== 0)
`can_admins_choose_deliveries_after_provider_confirmation`	`bool`	BitMask (({@link self::options} & 0x20) !== 0)
`enable_delivery_orders_confirmation_by_admins_before_payment`	`bool`	BitMask (({@link self::options} & 0x40) !== 0)
`can_providers_forfeit_from_assigned_deliveries`	`bool`	BitMask (({@link self::options} & 0x80) !== 0)
`enable_pickups`	`bool`	BitMask (({@link self::options} & 0x100) !== 0)
`disable_deliveries`	`bool`	BitMask (({@link self::options} & 0x200) !== 0)
`disable_deliveries_scheduling`	`bool`	BitMask (({@link self::options} & 0x400) !== 0)
`enable_bot_for_deliveries`	`bool`	BitMask (({@link self::options} & 0x800) !== 0)
`can_providers_pick_services_from_pool`	`bool`	BitMask (({@link self::options} & 0x1000) !== 0)
`can_providers_confirm_services_from_clients`	`bool`	BitMask (({@link self::options} & 0x2000) !== 0)
`can_clients_pick_providers_for_services`	`bool`	BitMask (({@link self::options} & 0x4000) !== 0)
`can_clients_choose_services_after_provider_confirmation`	`bool`	BitMask (({@link self::options} & 0x8000) !== 0)
`can_providers_confirm_services_from_admins`	`bool`	BitMask (({@link self::options} & 0x10000) !== 0)
`can_admins_choose_services_after_provider_confirmation`	`bool`	BitMask (({@link self::options} & 0x20000) !== 0)
`enable_service_orders_confirmation_by_admins_before_payment`	`bool`	BitMask (({@link self::options} & 0x40000) !== 0)
`can_providers_forfeit_from_assigned_services`	`bool`	BitMask (({@link self::options} & 0x80000) !== 0)
`enable_services_on_branch_location`	`bool`	BitMask (({@link self::options} & 0x100000) !== 0)
`disable_services_on_client_location`	`bool`	BitMask (({@link self::options} & 0x200000) !== 0)
`disable_services_scheduling`	`bool`	BitMask (({@link self::options} & 0x400000) !== 0)
`enable_bot_for_services`	`bool`	BitMask (({@link self::options} & 0x800000) !== 0)
`enable_pod_code`	`bool`	BitMask (({@link self::options} & 0x1000000) !== 0)
`enable_pod_pictures`	`bool`	BitMask (({@link self::options} & 0x2000000) !== 0)
`enable_pod_forms`	`bool`	BitMask (({@link self::options} & 0x4000000) !== 0)
`enable_pod_signature`	`bool`	BitMask (({@link self::options} & 0x8000000) !== 0)
`enabled_pods`	`int`	BitMask (({@link self::options} & 0xf000000) >> 24)
`enable_bot_for_shoppers`	`bool`	BitMask (({@link self::options} & 0x40000000) !== 0)
`setting_uid`	`string`
`setting_slogan`	`string`
`setting_mail_footer`	`string`
`setting_mail_from`	`string\\|null`
`setting_mail_customizations`	`array`
`setting_pay_in_store`	`bool`
`setting_enable_invoices`	`bool`
`setting_enable_multi_providers`	`bool`
`setting_enable_phone_login`	`bool`
`setting_enable_coupons`	`bool`
`setting_invoice_format`	`array`
`setting_contact_phone`	`string\\|null`
`setting_contact_phone_whatsapp`	`string\\|null`
`setting_disable_balance`	`bool`
`setting_telegram_token`	`string\\|null`
`setting_whatsapp_phone_id`	`string\\|null`
`setting_whatsapp_messaging_token`	`string\\|null`
`setting_is_marketplace`	`bool`
`setting_work_schedule`	`array`
`setting_sync_schedule`	`array`
`setting_facebook_app_id`	`string`
`setting_facebook_secret_token`	`string`
`setting_apple_id`	`string`
`setting_apple_private_key`	`string`
`setting_apple_secret`	`string`
`setting_apple_team_id`	`string`
`setting_apple_client_id`	`string`
`setting_apple_redirect`	`string`
`setting_sockette_keys`	`array`
`setting_tip_threshold`	`int`
`setting_nearby_branches_distance`	`int`
`setting_provider_collecting_distance`	`int`
`setting_provider_arriving_distance`	`int`
`setting_min_nearby_branches_count`	`int`
`setting_max_nearby_branches_count`	`int`
`setting_nearby_providers_distance`	`int`
`setting_assignable_orders_mask`	`int`
`setting_auto_assign_delay_minutes`	`int`
`setting_auto_assign_prepared_mode`	`bool`
`setting_auto_assign_bid_count`	`int`
`setting_auto_assign_bid_attempts`	`int`
`setting_subcategories_count`	`int`
`setting_branch_closing_soon_message_delay`	`int\\|null`
`setting_two_step_verification_endpoints`	`array`
`setting_service_app_modifiers`	`array`
`setting_branch_invoice_tax_name`	`string\\|null`
`setting_branch_invoice_tax_prc`	`float\\|null`
`setting_payout_accounts`	`array\\|null`
`setting_taxes`	`array`
`setting_delivery_discount_prc`	`float`
`setting_service_app_name`	`string\\|null`
`setting_order_min_number`	`int`
`setting_last_order_dashboard`	`string\\|null`
`setting_terms_of_service`	`string\\|null`
`setting_checkout_disclaimer`	`string\\|null`
`setting_qr_logo`	`string\\|null`
`setting_use_providers_balance_payouts`	`bool\\|null`
`setting_auto_provider_invoice_config`	`AutoInvoiceConfig`
`setting_auto_branch_invoice_config`	`AutoInvoiceConfig`
`setting_google_account_json`	`array\\|null`
`setting_bancamiga_settings`	`array\\|null`
`setting_bancamiga_tokens`	`array\\|null`
`setting_optimal_route_settings`	`OptimalRouteSettings\\|null`
`setting_linked_servers`	`array\\|null`
`setting_hidden_status_mask`	`int`
`setting_is_full_verification_required`	`bool`
`setting_is_verification_required`	`bool`
`setting_cancel_on_payment_failure`	`bool`
`setting_default_promoted_banner`	`string\\|null`
`setting_disable_reports`	`bool`
`setting_sms_enabled`	`bool`
`setting_sms_default_provider`	`string\\|null`
`setting_sms_login_provider`	`string\\|null`
`setting_sms_providers`	`array`
`setting_sms_notifications_enabled`	`bool`
`setting_sms_expiration_in_minutes`	`int`
`setting_sms_cooldown_in_seconds`	`int`
`setting_sms_enabled_for_clients_tracking`	`bool`
`setting_first_purchase_bonus_e2`	`int`
`setting_system_expiration_hours`	`int`
`setting_disable_payment_emails`	`bool`
`setting_directions_api`	`string\\|null`
`setting_directions_key`	`string\\|null`
`setting_directions_url`	`string\\|null`
`setting_email_templates_dir`	`string\\|null`
`setting_unidigital_settings`	`UnidigitalSettings`
`setting_unidigital_config`	`UnidigitalConfig`
`setting_braze_settings`	`BrazeSettings`
`setting_delivery_actions`	`DeliveryActions\\|null`
`setting_sypago_settings`	`SyPagoSettings\\|null`
`setting_syspago_token`	`string\\|null`
`setting_hot_tag_days`	`int\\|null`
`setting_hot_tag_sales`	`int\\|null`
`setting_event`	`array\\|null`
`setting_event_ranges`	`Collection`
`setting_template`	`string`
`setting_linked_company_id`	`int\\|null`
`setting_legal_info`	`array\\|null`
`accounts`	`Account>`
`activeBalanceModifiers`	`BalanceModifier>`
`allCurrencies`	`Currency>`
`allLogs`	`ApiLog>`
`allSettings`	`CompanySetting>`
`allowed_settings`	`array`
`available_balance_e2`	`int`
`available_for_withdrawal_balance_e2`	`int`
`balance_e2`	`int`
`balanceModifiers`	`BalanceModifier>`
`balanceMovements`	`BalanceMovement>`
`branches`	`Branch>`
`cancellationReasons`	`CancellationReason>`
`categories`	`Category>`
`countries`	`Country>`
`currencies`	`Currency>`
`deliveryFees`	`DeliveryFee>`
`editable_settings`	`array`
`email_for_mails`	`string`
`forms`	`Form>`
`geofences`	`BranchGeofence>`
`goods`	`Good>`
`invoices`	`Invoice>`
`lastBalanceMovement`	`BalanceMovement\\|null`
`locked_for_withdrawal_balance_e2`	`int`
`logs`	`ApiLog>`
`orderedGoods`	`OrderedGood>`
`orders`	`Order>`
`paymentMethods`	`PaymentMethod>`
`payments`	`Payment>`
`pendingActions`	`PendingAction>`
`properties`	`Property>`
`providersWithAccess`	`Provider>`
`settings`	`array`
`template`	`CompanyTemplate`
`tokens`	`Collection<int, AccessToken>`
`workSchedules`	`WorkSchedule>`

{
    "id": 116,
    "name": "Zupper by Ridery",
    "email": "noreply@dondemand.io",
    "domain": "panel-dev",
    "custom_domain": "dondemand.io",
    "expires_at": "2056-05-02 12:37:54",
    "extension_days": 0,
    "options": 1265637777,
    "plan": 2147483647,
    "enabled": true,
    "strings_json": {
        "strings": [],
        "version": 1
    },
    "styles_json": {
        "styles": {
            "color_primary": "/docs/3/company#070000",
            "color_accent": "/docs/3/company#070000",
            "company_logo": "https://dondemand-dev.sfo3.cdn.digitaloceanspaces.com/companies/69/logo/logo_116_1759503332.png",
            "company_logo_inv": "https://dondemand-dev.sfo3.cdn.digitaloceanspaces.com/companies/69/logo/logo_inv_116_1759634617.png"
        },
        "version": 52
    },
    "default_iso_lang": "es",
    "created_at": "2020-04-20 15:24:38",
    "updated_at": "2026-05-04 16:00:40",
    "deleted_at": null,
    "country_iso": "ve",
    "time_zone_offset": "-04:00",
    "direct_order_prefix": null,
    "can_providers_pick_deliveries_from_pool": true,
    "can_providers_confirm_deliveries_from_clients": false,
    "can_clients_pick_providers_for_deliveries": false,
    "can_clients_choose_deliveries_after_provider_confirmation": false,
    "can_providers_confirm_deliveries_from_admins": true,
    "can_admins_choose_deliveries_after_provider_confirmation": false,
    "enable_delivery_orders_confirmation_by_admins_before_payment": false,
    "can_providers_forfeit_from_assigned_deliveries": true,
    "enable_pickups": true,
    "disable_deliveries": false,
    "disable_deliveries_scheduling": false,
    "enable_bot_for_deliveries": true,
    "can_providers_pick_services_from_pool": true,
    "can_providers_confirm_services_from_clients": false,
    "can_clients_pick_providers_for_services": false,
    "can_clients_choose_services_after_provider_confirmation": false,
    "can_providers_confirm_services_from_admins": false,
    "can_admins_choose_services_after_provider_confirmation": false,
    "enable_service_orders_confirmation_by_admins_before_payment": false,
    "can_providers_forfeit_from_assigned_services": false,
    "enable_services_on_branch_location": true,
    "disable_services_on_client_location": true,
    "disable_services_scheduling": true,
    "enable_bot_for_services": false,
    "enable_pod_code": true,
    "enable_pod_pictures": true,
    "enable_pod_forms": false,
    "enable_pod_signature": true,
    "enabled_pods": 11,
    "enable_bot_for_shoppers": true,
    "settings": {
        "uid": "J505728482",
        "slogan": "Powered by DonDemand",
        "pay_in_store": true,
        "enable_invoices": true,
        "enable_multi_providers": false,
        "enable_phone_login": true,
        "enable_coupons": true,
        "contact_phone": "+584148440652",
        "contact_phone_whatsapp": "+584141942279",
        "disable_balance": false,
        "is_marketplace": true,
        "event": null,
        "template": "marketplace",
        "linked_company_id": null,
        "sockets_url": "https://sockets-dev.dondemand.io"
    }
}

Endpoints

Insertar Company

Método	URI	Cabeceras
POST	`/companies`	N/A

Ver Json

Listar Company

{info} Soporta: Filters Carga dinámica Paginación

Método	URI	Cabeceras
GET	`/companies`	Authorization

Listar DashboardStat

Método	URI	Cabeceras
GET	`/companies/{companyId}/dashboard-stats`	Authorization

Listar Setting

Método	URI	Cabeceras
GET	`/companies/{companyId}/settings`	Authorization

Mostrar Company

Mostrar Domain

{info} Soporta: Carga dinámica

Método	URI	Cabeceras
GET	`/companies/domain/{domain}`	N/A

{
    "updated_at": "date"
}

Mostrar Domain

{info} Soporta: Carga dinámica

Método	URI	Cabeceras
GET	`/companies/domain/{domain}`	N/A

{
    "updated_at": "date"
}

Mostrar TermsOfService

Método	URI	Cabeceras
GET	`/companies/{companyId}/terms-of-service`	N/A

Mostrar Branch DayTime

Método	URI	Cabeceras
GET	`/companies/{companyId}/branches/{branchId}/day-time`	N/A

{
    "updated_at": "date"
}

Mostrar Branch DayTime

Método	URI	Cabeceras
GET	`/companies/{companyId}/branches/{branchId}/day-time`	N/A

{
    "updated_at": "date"
}

Actualizar Company

Actualizar SetExpiration

Método	URI	Cabeceras
POST	`/companies/{companyId}/set-expiration`	Authorization

{
    "expires_at": "required|date",
    "extension_days": "nullable|integer|min:0"
}

Actualizar

Método	URI	Cabeceras
PATCH	`/companies/{companyId}`	Authorization

Ver Json

Actualizar Setting

Método	URI	Cabeceras
PATCH	`/companies/{companyId}/settings`	Authorization

Ver Json

Actualizar Setting

Método	URI	Cabeceras
POST	`/companies/{companyId}/settings`	Authorization

Ver Json

Eliminar Company

Método	URI	Cabeceras
DELETE	`/companies/{companyId}`	Authorization

Restaurar Company

Método	URI	Cabeceras
POST	`/companies/{companyId}/restore`	Authorization

Acciones de Company

Resolve

{info} Soporta: Carga dinámica

Método	URI	Cabeceras
GET	`/domains/{domainToResolve}`	N/A

Show Domain

{info} Soporta: Carga dinámica

Método	URI	Cabeceras
GET	`/branches/domain/{domainName}`	N/A

Show Domain

{info} Soporta: Carga dinámica

Método	URI	Cabeceras
GET	`/companies/{companyId}/branch-groups/domain/{domainName}`	N/A

Update Styles

Método	URI	Cabeceras
POST	`/companies/{companyId}/styles`	Authorization

{
    "color_primary": {
        "string": true,
        "regex": "/^#(?:[0-9a-fA-F]{3}){1,2}$/"
    },
    "color_accent": {
        "string": true,
        "regex": "/^#(?:[0-9a-fA-F]{3}){1,2}$/"
    },
    "company_logo": "image|mimes:jpeg,png|max:1024",
    "company_logo_inv": "image|mimes:jpeg,png|max:1024"
}

List

Método	URI	Cabeceras
GET	`/companies/{companyId}/banks`	N/A

{
    "image_mode": "string|in:list,square,all",
    "filter": "string|in:mobile_payment,transfer,ci"
}

Index Allowed

Método	URI	Cabeceras
GET	`/companies/{companyId}/allowed-settings`	Authorization

Calculate

Método	URI	Cabeceras
GET	`/companies/{companyId}/branches/{branchId}/calculate-fees`	Authorization

{
    "latitude_e6": "required|integer|between:-90000000,90000000",
    "longitude_e6": "required|integer|between:-180000000,180000000",
    "subtotal_e2": "integer|min:0",
    "subtotal_full_e2": "integer|min:0",
    "base_price_e2": "integer|min:0",
    "balance_e2": "integer",
    "selected_delivery_id": "nullable|integer",
    "payment_method_type": "string|in:gateway,form,post-payment,balance",
    "payment_method_id": "nullable",
    "payment_method_currency_iso": "string|min:3|max:8",
    "coupon_id": "nullable|integer",
    "is_gift": "nullable|boolean",
    "client_id": "integer",
    "items": [
        {
            "good_id": "required|integer|exists:goods,id",
            "quantity": "required|integer|min:1",
            "provider_id": "integer",
            "properties": [
                {
                    "property_id": "required|integer",
                    "value": "required|string"
                }
            ]
        }
    ],
    "goods": [
        "integer"
    ],
    "good_ids": {
        "string": true,
        "regex": "/^[0-9]+(,[0-9]+)*$/"
    },
    "time": {
        "string": true,
        "regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
    },
    "datetime": "date|after:now",
    "use_local_tz": "boolean"
}

Calculate

Método	URI	Cabeceras
POST	`/companies/{companyId}/branches/{branchId}/calculate-fees`	Authorization

{
    "latitude_e6": "required|integer|between:-90000000,90000000",
    "longitude_e6": "required|integer|between:-180000000,180000000",
    "subtotal_e2": "integer|min:0",
    "subtotal_full_e2": "integer|min:0",
    "base_price_e2": "integer|min:0",
    "balance_e2": "integer",
    "selected_delivery_id": "nullable|integer",
    "payment_method_type": "string|in:gateway,form,post-payment,balance",
    "payment_method_id": "nullable",
    "payment_method_currency_iso": "string|min:3|max:8",
    "coupon_id": "nullable|integer",
    "is_gift": "nullable|boolean",
    "client_id": "integer",
    "items": [
        {
            "good_id": "required|integer|exists:goods,id",
            "quantity": "required|integer|min:1",
            "provider_id": "integer",
            "properties": [
                {
                    "property_id": "required|integer",
                    "value": "required|string"
                }
            ]
        }
    ],
    "goods": [
        "integer"
    ],
    "good_ids": {
        "string": true,
        "regex": "/^[0-9]+(,[0-9]+)*$/"
    },
    "time": {
        "string": true,
        "regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
    },
    "datetime": "date|after:now",
    "use_local_tz": "boolean"
}

Calculate V2

Método	URI	Cabeceras
POST	`/companies/{companyId}/branches/{branch}/calculate-fees-for-all`	Authorization

{
    "latitude_e6": "required|integer|between:-90000000,90000000",
    "longitude_e6": "required|integer|between:-180000000,180000000",
    "subtotal_e2": "integer|min:0",
    "subtotal_full_e2": "integer|min:0",
    "base_price_e2": "integer|min:0",
    "balance_e2": "integer",
    "selected_delivery_id": "nullable|integer",
    "payment_method_type": "string|in:gateway,form,post-payment,balance",
    "payment_method_id": "nullable",
    "payment_method_currency_iso": "string|min:3|max:8",
    "coupon_id": "nullable|integer",
    "is_gift": "nullable|boolean",
    "client_id": "integer",
    "items": [
        {
            "good_id": "required|integer|exists:goods,id",
            "quantity": "required|integer|min:1",
            "provider_id": "integer",
            "properties": [
                {
                    "property_id": "required|integer",
                    "value": "required|string"
                }
            ]
        }
    ],
    "goods": [
        "integer"
    ],
    "good_ids": {
        "string": true,
        "regex": "/^[0-9]+(,[0-9]+)*$/"
    },
    "time": {
        "string": true,
        "regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
    },
    "datetime": "date|after:now",
    "use_local_tz": "boolean"
}

Report

{info} Soporta: Paginación Filters Carga dinámica

Método	URI	Cabeceras
GET	`/companies/{companyId}/earnings-report`	N/A

Report

{info} Soporta: Paginación Filters Carga dinámica

Método	URI	Cabeceras
GET	`/companies/{companyId}/payments-report`	N/A

Report

Método	URI	Cabeceras
POST	`/companies/{companyId}/bancamiga-report`	N/A

{
    "file": "required|file|mimes:xlsx,xlsm,xltx,xltm,xls,xlt,ods,ots,slk,xml,gnumeric,htm,html,csv,tsv,txt",
    "csv_settings": {
        "delimiter": "string",
        "enclosure": "string",
        "line_ending": "string",
        "use_bom": "boolean",
        "include_separator_line": "boolean",
        "excel_compatibility": "boolean",
        "escape_character": "string",
        "contiguous": "boolean",
        "input_encoding": "string",
        "output_encoding": "string"
    }
}

Report

Método	URI	Cabeceras
POST	`/companies/{companyId}/bnc-pos-report`	N/A

{
    "file": "required|file|mimes:xlsx,xlsm,xltx,xltm,xls,xlt,ods,ots,slk,xml,gnumeric,htm,html,csv,tsv,txt",
    "csv_settings": {
        "delimiter": "string",
        "enclosure": "string",
        "line_ending": "string",
        "use_bom": "boolean",
        "include_separator_line": "boolean",
        "excel_compatibility": "boolean",
        "escape_character": "string",
        "contiguous": "boolean",
        "input_encoding": "string",
        "output_encoding": "string"
    }
}

Relaciones

accounts HasMany Account
activeBalanceModifiers HasMany BalanceModifier
allCurrencies HasMany Currency
allLogs HasMany ApiLog
balanceModifiers HasMany BalanceModifier
balanceMovements HasMany BalanceMovement
branches HasMany Branch
cancellationReasons HasMany CancellationReason
categories HasMany Category
countries HasMany Country
currencies HasMany Currency
deliveryFees HasMany DeliveryFee
forms HasMany Form
geofences HasMany BranchGeofence
goods HasMany Good
invoices HasMany Invoice
lastBalanceMovement HasOne BalanceMovement
logs HasMany ApiLog
orderedGoods HasMany OrderedGood
orders HasMany Order
paymentMethods HasMany PaymentMethod
payments HasMany Payment
pendingActions HasMany PendingAction
properties HasMany Property
providersWithAccess HasMany Provider
tokens HasMany AccessToken
workSchedules HasMany WorkSchedule

Administración

Métodos de Pago

Calificaciones

Company

Estructura de Datos

Endpoints

Insertar Company

Listar Company

Listar DashboardStat

Listar Setting

Mostrar Company

Mostrar Domain

Mostrar Domain

Mostrar TermsOfService

Mostrar Branch DayTime

Mostrar Branch DayTime

Actualizar Company

Actualizar SetExpiration

Actualizar

Actualizar Setting

Actualizar Setting

Eliminar Company

Restaurar Company

Acciones de Company

Resolve

Show Domain

Show Domain

Update Styles

List

Index Allowed

Calculate

Calculate

Calculate V2

Report

Report

Report

Report

Relaciones