389 lines
10 KiB
Markdown
Executable File
389 lines
10 KiB
Markdown
Executable File
# Índice API UCRM — CRM v1.0
|
|
|
|
> **Generado automáticamente** desde `unmscrm.apib`
|
|
> Ejecutar `php .agent/scripts/gen_index_ucrm_apib.php` para regenerar.
|
|
|
|
**Base URL:** `https://{ipserver}/crm/api/v1.0/`
|
|
**Auth:** Header `X-Auth-App-Key: {apitoken}`
|
|
|
|
---
|
|
|
|
## Resumen de Grupos
|
|
|
|
- **Clients** (4 endpoints)
|
|
- **Client Bank Accounts** (5 endpoints)
|
|
- **Client Contacts** (5 endpoints)
|
|
- **Client Logs** (4 endpoints)
|
|
- **Client Tags** (5 endpoints)
|
|
- **Credit Note Templates** (0 endpoints)
|
|
- **Credit Notes** (3 endpoints)
|
|
- **Custom Attributes** (5 endpoints)
|
|
- **Document Templates** (0 endpoints)
|
|
- **Documents** (5 endpoints)
|
|
- **Geocoding** (2 endpoints)
|
|
- **Email** (0 endpoints)
|
|
- **Fees** (2 endpoints)
|
|
- **Invoice Templates** (0 endpoints)
|
|
- **Invoices** (3 endpoints)
|
|
- **Invoice Items** (4 endpoints)
|
|
- **Job Attachments** (3 endpoints)
|
|
- **Job Comments** (3 endpoints)
|
|
- **Job Tasks** (3 endpoints)
|
|
- **Jobs** (3 endpoints)
|
|
- **Organizations** (0 endpoints)
|
|
- **Payment Methods** (5 endpoints)
|
|
- **Payment Plans** (4 endpoints)
|
|
- **Payments** (3 endpoints)
|
|
- **Payment Tokens** (0 endpoints)
|
|
- **Credit Cards** (3 endpoints)
|
|
- **Permission Groups** (0 endpoints)
|
|
- **Products** (10 endpoints)
|
|
- **Proforma Invoice Templates** (0 endpoints)
|
|
- **Quote Templates** (0 endpoints)
|
|
- **Quotes** (2 endpoints)
|
|
- **Refund** (0 endpoints)
|
|
- **Service Plans** (6 endpoints)
|
|
- **Service Plan Groups** (3 endpoints)
|
|
- **Service Surcharges** (5 endpoints)
|
|
- **Service Suspension** (5 endpoints)
|
|
- **Service UISP Location** (2 endpoints)
|
|
- **Services** (10 endpoints)
|
|
- **Service Change Requests** (2 endpoints)
|
|
- **Prepaid Service Periods** (2 endpoints)
|
|
- **Surcharges** (5 endpoints)
|
|
- **Taxes** (4 endpoints)
|
|
- **Tickets** (3 endpoints)
|
|
- **Ticket Activity** (0 endpoints)
|
|
- **Ticket Comment Attachments** (0 endpoints)
|
|
- **Ticket Comments** (0 endpoints)
|
|
- **Ticket Groups** (5 endpoints)
|
|
- **Ticket Tags** (5 endpoints)
|
|
- **Users** (0 endpoints)
|
|
- **Webhook Events** (0 endpoints)
|
|
- **General** (0 endpoints)
|
|
- **Mobile** (0 endpoints)
|
|
- **Client Zone Credit Cards** (3 endpoints)
|
|
- **Client Zone Dashboard** (0 endpoints)
|
|
- **Client Zone Invoices** (1 endpoints)
|
|
- **Client Zone Payments** (1 endpoints)
|
|
- **Client Zone Quotes** (1 endpoints)
|
|
- **Client Zone Services** (1 endpoints)
|
|
- **Client Zone Service Plans** (3 endpoints)
|
|
- **Client Zone Tickets** (2 endpoints)
|
|
- **Client Zone Tickets Activities** (1 endpoints)
|
|
- **Client Zone Tickets Comments** (2 endpoints)
|
|
- **Client Zone Tickets Comments Attachments** (1 endpoints)
|
|
- **Client Zone Authentication** (0 endpoints)
|
|
- **Client Zone Client** (0 endpoints)
|
|
- **Client Zone Service Change Requests** (2 endpoints)
|
|
- **Client Zone Prepaid Service Periods** (1 endpoints)
|
|
- **Client Zone Overview** (0 endpoints)
|
|
- **Client Zone Login Token** (0 endpoints)
|
|
|
|
**Total: 162 endpoints en 69 grupos**
|
|
|
|
---
|
|
|
|
## Clients
|
|
|
|
- GET `/clients` — —
|
|
- GET `/clients/` — —
|
|
- PATCH `/clients/` — —
|
|
- POST `/clients/authenticated` — —
|
|
|
|
## Client Bank Accounts
|
|
|
|
- GET `/clients/bank-accounts/` — —
|
|
- PATCH `/clients/bank-accounts/` — —
|
|
- DELETE `/clients/bank-accounts/` — —
|
|
- GET `/clients/` — —
|
|
- POST `/clients/` — —
|
|
|
|
## Client Contacts
|
|
|
|
- GET `/clients/contacts/` — —
|
|
- PATCH `/clients/contacts/` — —
|
|
- DELETE `/clients/contacts/` — —
|
|
- GET `/clients/` — —
|
|
- POST `/clients/` — —
|
|
|
|
## Client Logs
|
|
|
|
- GET `/client-logs` — —
|
|
- GET `/client-logs` — —
|
|
- PATCH `/client-logs` — —
|
|
- DELETE `/client-logs` — —
|
|
|
|
## Client Tags
|
|
|
|
- GET `/client-tags` — —
|
|
- POST `/client-tags` — —
|
|
- PATCH `/client-tags` — —
|
|
- GET `/client-tags` — —
|
|
- DELETE `/client-tags` — —
|
|
|
|
## Credit Notes
|
|
|
|
- GET `/credit-notes/` — —
|
|
- PATCH `/credit-notes/` — —
|
|
- DELETE `/credit-notes/` — —
|
|
|
|
## Custom Attributes
|
|
|
|
- GET `/custom-attributes` — —
|
|
- POST `/custom-attributes` — —
|
|
- GET `/custom-attributes` — —
|
|
- PATCH `/custom-attributes` — —
|
|
- DELETE `/custom-attributes` — —
|
|
|
|
## Documents
|
|
|
|
- GET `/documents` — —
|
|
- POST `/documents` — —
|
|
- GET `/documents` — —
|
|
- DELETE `/documents` — —
|
|
- GET `/documents` — —
|
|
|
|
## Geocoding
|
|
|
|
- GET `/geocode` — —
|
|
- GET `/geocode/suggest` — —
|
|
|
|
## Fees
|
|
|
|
- GET `/geocode/suggest` — —
|
|
- DELETE `/geocode/suggest` — —
|
|
|
|
## Invoices
|
|
|
|
- GET `/invoices/` — —
|
|
- PATCH `/invoices/` — —
|
|
- DELETE `/invoices/` — —
|
|
|
|
## Invoice Items
|
|
|
|
- GET `/invoices/items/` — —
|
|
- PATCH `/invoices/items/` — —
|
|
- DELETE `/invoices/items/` — —
|
|
- GET `/invoices/` — —
|
|
|
|
## Job Attachments
|
|
|
|
- GET `/scheduling/jobs/attachments/` — —
|
|
- PATCH `/scheduling/jobs/attachments/` — —
|
|
- DELETE `/scheduling/jobs/attachments/` — —
|
|
|
|
## Job Comments
|
|
|
|
- GET `/scheduling/jobs/comments/` — —
|
|
- PATCH `/scheduling/jobs/comments/` — —
|
|
- DELETE `/scheduling/jobs/comments/` — —
|
|
|
|
## Job Tasks
|
|
|
|
- GET `/scheduling/jobs/tasks/` — —
|
|
- PATCH `/scheduling/jobs/tasks/` — —
|
|
- DELETE `/scheduling/jobs/tasks/` — —
|
|
|
|
## Jobs
|
|
|
|
- GET `/scheduling/jobs/` — —
|
|
- PATCH `/scheduling/jobs/` — —
|
|
- DELETE `/scheduling/jobs/` — —
|
|
|
|
## Payment Methods
|
|
|
|
- GET `/payment-methods` — —
|
|
- POST `/payment-methods` — —
|
|
- GET `/payment-methods/` — —
|
|
- PATCH `/payment-methods/` — —
|
|
- DELETE `/payment-methods/` — —
|
|
|
|
## Payment Plans
|
|
|
|
- GET `/payment-plans` — —
|
|
- POST `/payment-plans` — —
|
|
- GET `/payment-plans/` — —
|
|
- PATCH `/payment-plans/` — —
|
|
|
|
## Payments
|
|
|
|
- GET `/payments/` — —
|
|
- DELETE `/payments/` — —
|
|
- PATCH `/payments/` — —
|
|
|
|
## Credit Cards
|
|
|
|
- GET `/payments/` — —
|
|
- DELETE `/payments/` — —
|
|
- PATCH `/payments/` — —
|
|
|
|
## Products
|
|
|
|
- GET `/products` — —
|
|
- POST `/products` — —
|
|
- PATCH `/products/` — —
|
|
- GET `/products/` — —
|
|
- DELETE `/products/` — —
|
|
- GET `/products` — —
|
|
- POST `/products` — —
|
|
- PATCH `/products/` — —
|
|
- GET `/products/` — —
|
|
- DELETE `/products/` — —
|
|
|
|
## Quotes
|
|
|
|
- GET `/quotes/` — —
|
|
- PATCH `/quotes/` — —
|
|
|
|
## Service Plans
|
|
|
|
- GET `/service-plans` — —
|
|
- POST `/service-plans` — —
|
|
- PATCH `/service-plans` — —
|
|
- GET `/service-plans` — —
|
|
- DELETE `/service-plans` — —
|
|
- GET `/service-plans/statistics` — —
|
|
|
|
## Service Plan Groups
|
|
|
|
- PATCH `/service-plans/statistics` — —
|
|
- GET `/service-plans/statistics` — —
|
|
- DELETE `/service-plans/statistics` — —
|
|
|
|
## Service Surcharges
|
|
|
|
- GET `/clients/services/` — —
|
|
- POST `/clients/services/` — —
|
|
- PATCH `/clients/services/service-surcharges/` — —
|
|
- GET `/clients/services/service-surcharges/` — —
|
|
- DELETE `/clients/services/service-surcharges/` — —
|
|
|
|
## Service Suspension
|
|
|
|
- GET `/service-suspension-reasons` — —
|
|
- POST `/service-suspension-reasons` — —
|
|
- PATCH `/service-suspension-reasons/` — —
|
|
- GET `/service-suspension-reasons/` — —
|
|
- DELETE `/service-suspension-reasons/` — —
|
|
|
|
## Service UISP Location
|
|
|
|
- PATCH `/clients/services/` — —
|
|
- PATCH `/clients/services/` — —
|
|
|
|
## Services
|
|
|
|
- GET `/clients/services/` — —
|
|
- PATCH `/clients/services/` — —
|
|
- DELETE `/clients/services/` — —
|
|
- POST `/clients/` — —
|
|
- GET `/clients/services/` — —
|
|
- PATCH `/clients/services/` — —
|
|
- PATCH `/clients/services/` — —
|
|
- PATCH `/clients/services/` — —
|
|
- PATCH `/clients/services/` — —
|
|
- DELETE `/clients/services/` — —
|
|
|
|
## Service Change Requests
|
|
|
|
- GET `/service-change-requests/` — —
|
|
- DELETE `/service-change-requests/` — —
|
|
|
|
## Prepaid Service Periods
|
|
|
|
- GET `/prepaid-service-periods/` — —
|
|
- DELETE `/prepaid-service-periods/` — —
|
|
|
|
## Surcharges
|
|
|
|
- GET `/surcharges` — —
|
|
- POST `/surcharges` — —
|
|
- PATCH `/surcharges/` — —
|
|
- GET `/surcharges/` — —
|
|
- DELETE `/surcharges/` — —
|
|
|
|
## Taxes
|
|
|
|
- GET `/taxes` — —
|
|
- POST `/taxes` — —
|
|
- GET `/taxes` — —
|
|
- DELETE `/taxes` — —
|
|
|
|
## Tickets
|
|
|
|
- GET `/ticketing/tickets/` — —
|
|
- PATCH `/ticketing/tickets/` — —
|
|
- DELETE `/ticketing/tickets/` — —
|
|
|
|
## Ticket Groups
|
|
|
|
- GET `/ticketing/ticket-groups` — —
|
|
- POST `/ticketing/ticket-groups` — —
|
|
- GET `/ticketing/ticket-groups/` — —
|
|
- PATCH `/ticketing/ticket-groups/` — —
|
|
- DELETE `/ticketing/ticket-groups/` — —
|
|
|
|
## Ticket Tags
|
|
|
|
- GET `/ticket-tags` — —
|
|
- POST `/ticket-tags` — —
|
|
- PATCH `/ticket-tags` — —
|
|
- GET `/ticket-tags` — —
|
|
- DELETE `/ticket-tags` — —
|
|
|
|
## Client Zone Credit Cards
|
|
|
|
- GET `/ticket-tags` — —
|
|
- DELETE `/ticket-tags` — —
|
|
- PATCH `/ticket-tags` — —
|
|
|
|
## Client Zone Invoices
|
|
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Payments
|
|
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Quotes
|
|
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Services
|
|
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Service Plans
|
|
|
|
- GET `/ticket-tags` — —
|
|
- GET `/ticket-tags` — —
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Tickets
|
|
|
|
- POST `/ticket-tags` — —
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Tickets Activities
|
|
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Tickets Comments
|
|
|
|
- POST `/ticket-tags` — —
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Tickets Comments Attachments
|
|
|
|
- GET `/ticket-tags` — —
|
|
|
|
## Client Zone Service Change Requests
|
|
|
|
- GET `/client-zone/service-change-requests/` — —
|
|
- DELETE `/client-zone/service-change-requests/` — —
|
|
|
|
## Client Zone Prepaid Service Periods
|
|
|
|
- GET `/client-zone/prepaid-service-periods/` — —
|