Elementos de la API: Clientes, Proyectos, Códigos de Cuenta, Proveedores y Eventos

Centro de documentación de API

Consulta los elementos de la cuenta y administra los recursos de proveedores y eventos compatibles con la API pública v1.

11. Elementos (clientes, proyectos, códigos de cuenta, proveedores y eventos)

Endpoints de listado — patrón compartido

GET /items/{type} soporta:

Parámetro	Predeterminado	Notas
Status	Constante de estado activo específica del tipo	e.g. CUSTOMERSTATUS_ACTIVE
OrderBy	READONLY	NAME, DATE, READONLY
FullTextSearch	""
Include{Type}IDList / Exclude{Type}IDList	""	CSV numérico
StartRow / MaxRows	1 / 50

Ruta	Estado predeterminado
/items/customer	CUSTOMERSTATUS_ACTIVE
/items/project	PROJECTSTATUS_ACTIVE
/items/accountcode	ACCTCODESTATUS_ACTIVE
/items/vendor	VENDORSTATUS_ACTIVE
/items/event	EVENTSTATUS_ACTIVE

curl -s "$API_BASE/items/customer?Status=CUSTOMERSTATUS_ACTIVE&OrderBy=NAME&FullTextSearch=acme&MaxRows=25" \
  -H "Authorization: Bearer $TOKEN" \
  -H "apikey: $API_KEY"

curl -s "$API_BASE/items/project?IncludeProjectIDList=200,201" \
  -H "Authorization: Bearer $TOKEN" \
  -H "apikey: $API_KEY"

Forma de respuesta: { errors, data: { items, totalrowsfround, startrow, maxrows } }.

GET de objeto singular

curl -s "$API_BASE/item/customer/10" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

curl -s "$API_BASE/item/project/200" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

curl -s "$API_BASE/item/accountcode/30" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

curl -s "$API_BASE/item/vendor/55" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

curl -s "$API_BASE/item/event/7" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

Proveedores — crear / actualizar / eliminar / archivar

La URI siempre es /item/vendor/{VendorID}. Para crear, el segmento de la ruta es obligatorio debido al enrutamiento; utiliza 0 como marcador de posición (POST no lo utiliza como el nuevo ID).

# Create
curl -s -X POST "$API_BASE/item/vendor/0" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "apikey: $API_KEY" \
  -d '{
    "VendorName": "Acme Supplies",
    "City": "Austin",
    "State": "TX",
    "ContactEmail": "ap@acme.example"
  }'

# Update
curl -s -X PATCH "$API_BASE/item/vendor/55" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "apikey: $API_KEY" \
  -d '{"VendorName": "Acme Supplies LLC"}'

# Archive / restore
curl -s -X PATCH "$API_BASE/item/vendor/55/archive" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

curl -s -X PATCH "$API_BASE/item/vendor/55/restore" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

# Permanent delete
curl -s -X DELETE "$API_BASE/item/vendor/55" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

Los campos del cuerpo para crear/actualizar incluyen la dirección, las partes de los números de teléfono de contacto, empresa y fax (nacionales o internacionales), y Comments. Todos son opcionales a nivel de la API; las reglas de negocio se aplican en VendorService.

Eventos — crear / actualizar / eliminar / archivar

Mismo patrón de marcador de posición para la creación (POST /item/event/0):

curl -s -X POST "$API_BASE/item/event/0" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "apikey: $API_KEY" \
  -d '{"EventName": "Trade Show", "EventDescription": "Q3 booth"}'

curl -s -X PATCH "$API_BASE/item/event/7" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "apikey: $API_KEY" \
  -d '{"EventName": "Trade Show 2026"}'

curl -s -X PATCH "$API_BASE/item/event/7/archive" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

curl -s -X DELETE "$API_BASE/item/event/7" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

Los clientes, proyectos y códigos de cuenta son de solo lectura a través de esta API pública (solo GET para listar y GET por ID).

---