API Reference

Click any endpoint to see parameters, try it, and view response examples.

Sales

GET /api/v1/clients Search clients +
GET /api/v1/clients/{id} Get client detail +
POST /api/v1/clients Create client +
PUT /api/v1/clients/{id} Update client +
DELETE /api/v1/clients/{id} Delete client +
GET /api/v1/contracts Search contracts +
GET /api/v1/contracts/{id} Get contract detail +
POST /api/v1/contracts Create contract +
DELETE /api/v1/contracts/{id} Delete contract +
GET /api/v1/contracts/{id}/projects List contract projects +
GET /api/v1/projects Search projects +
GET /api/v1/projects/{id} Get project detail +
POST /api/v1/projects Create project +
DELETE /api/v1/projects/{id} Delete project +
GET /api/v1/projects/{id}/budgets List project budgets +
GET /api/v1/opportunities Search opportunities +
GET /api/v1/opportunities/{id} Get opportunity detail +
POST /api/v1/opportunities Create opportunity +
DELETE /api/v1/opportunities/{id} Delete opportunity +
GET /api/v1/requests Search requests +
POST /api/v1/requests Create request +
PUT /api/v1/requests/{id} Update request +
DELETE /api/v1/requests/{id} Delete request +

Operations

GET /api/v1/budgets Search budgets +
GET /api/v1/budgets/{id} Get budget detail +
GET /api/v1/budgets/{id}/items List budget items +
POST /api/v1/budgets Create budget +
PUT /api/v1/budgets/{id} Update budget +
DELETE /api/v1/budgets/{id} Delete budget +
GET /api/v1/purchase-orders Search purchase orders +
GET /api/v1/purchase-orders/{id}/items List PO items +
POST /api/v1/purchase-orders Create purchase order +
DELETE /api/v1/purchase-orders/{id} Delete purchase order +
GET /api/v1/production-orders Search production orders +
GET /api/v1/production-orders/{id}/items List production order items +
POST /api/v1/production-orders Create production order +
DELETE /api/v1/production-orders/{id} Delete production order +
GET /api/v1/advances Search advances +
POST /api/v1/advances Create advance +
DELETE /api/v1/advances/{id} Delete advance +
GET /api/v1/legalizations Search legalizations +
POST /api/v1/legalizations Create legalization +
DELETE /api/v1/legalizations/{id} Delete legalization +

Billing

GET /api/v1/invoices Search invoices +
GET /api/v1/invoices/{id} Get invoice detail +
GET /api/v1/invoices/{id}/lines List invoice lines +
POST /api/v1/invoices Create invoice +
PUT /api/v1/invoices/{id} Update invoice +
DELETE /api/v1/invoices/{id} Delete invoice +
GET /api/v1/credit-notes Search credit notes +
POST /api/v1/credit-notes Create credit note +
DELETE /api/v1/credit-notes/{id} Delete credit note +
GET /api/v1/debit-notes Search debit notes +
POST /api/v1/debit-notes Create debit note +
DELETE /api/v1/debit-notes/{id} Delete debit note +

People

GET /api/v1/employees Search employees +
GET /api/v1/employees/{id} Get employee detail +
POST /api/v1/employees Create employee +
PUT /api/v1/employees/{id} Update employee +
DELETE /api/v1/employees/{id} Delete employee +
GET /api/v1/novelties Search novelties +
POST /api/v1/novelties Create novelty +
DELETE /api/v1/novelties/{id} Delete novelty +
GET /api/v1/payroll Get payroll summary +
POST /api/v1/payroll/liquidate Liquidate payroll period +
GET /api/v1/labor-contracts Search labor contracts +
POST /api/v1/labor-contracts Create labor contract +
DELETE /api/v1/labor-contracts/{id} Delete labor contract +
GET /api/v1/candidates Search candidates +
POST /api/v1/candidates Create candidate +
DELETE /api/v1/candidates/{id} Delete candidate +
GET /api/v1/vacancies Search vacancies +
POST /api/v1/vacancies Create vacancy +
DELETE /api/v1/vacancies/{id} Delete vacancy +

Tasks

GET /api/v1/tasks Search tasks +
GET /api/v1/tasks/{id} Get task detail +
POST /api/v1/tasks Create task +
PUT /api/v1/tasks/{id} Update task +
DELETE /api/v1/tasks/{id} Delete task +

Catalog

GET /api/v1/products Search products +
GET /api/v1/products/{id} Get product detail +
POST /api/v1/products Create product +
PUT /api/v1/products/{id} Update product +
DELETE /api/v1/products/{id} Delete product +
GET /api/v1/suppliers Search suppliers +
GET /api/v1/suppliers/{id} Get supplier detail +
POST /api/v1/suppliers Create supplier +
PUT /api/v1/suppliers/{id} Update supplier +
DELETE /api/v1/suppliers/{id} Delete supplier +

Config

GET /api/v1/companies List companies +
GET /api/v1/states List states +

State Changes

POST /api/v1/{entity}/{id}/change-state Change entity state +