Saltar al contenido principal

kobana billing service-items

Comandos de kobana billing service-items. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
service-items listGET /v1/service_itemsListar ítems de servicio
service-items createPOST /v1/service_itemsCrear ítem de servicio
service-items updatePUT /v1/service_itemsCrear o actualizar ítem de servicio
service-items getGET /v1/service_items/{id}Obtener ítem de servicio
service-items deleteDELETE /v1/service_items/{id}Eliminar ítem de servicio

service-items list​

Listar ítems de servicio

kobana billing service-items list [OPCIONES]

GET /v1/service_items

Devuelve una lista paginada de los ítems de servicio (catálogo LC 116/2003) de la organización actual. Usa los filtros para restringir por empresa, código LC 116, NBS, clasificación tributaria, indicador de operación o anexo del Simples.

Parámetros de consulta

NombreTipoObligatorioDescripción
pageintegernoPágina (comienza en 1). Por defecto: 1.
per_pageintegernoÍtems por página. Por defecto: 20. Máximo: 100.
sort_bystringnoCampo de ordenación. El valor por defecto depende del recurso.
sort_orderstringnoDirección de ordenación. Por defecto: desc. Valores: asc, desc.
company_idstringnoFiltra por UUID de la empresa emisora asociada al ítem.
searchstringnoBúsqueda textual libre en name, internal_code y description.
is_activestringnoFiltra por estado: true devuelve solo ítems activos; false, solo inactivos. Valores: true, false.
lc116_codestringnoFiltra por el código LC 116/2003 (p. ej. 01.05).
nbs_codestringnoFiltra por el código NBS (Nomenclatura Brasileña de Servicios).
c_class_tribstringnoFiltra por la clasificación tributaria IBS/CBS (c_class_trib).
indop_codestringnoFiltra por el Indicador de Operación (indop_code) usado en la NFS-e SNNFSE.
simples_annexstringnoFiltra por el anexo del Simples Nacional aplicable: annex_iii, annex_iv o annex_v. Valores: annex_iii, annex_iv, annex_v.
cnae_codestringnoFiltra por el código CNAE relacionado con el servicio.
municipal_codestringnoFiltra por el código municipal del servicio.
internal_codestringnoFiltra por el código interno del ítem.
cbs_ibs_categorystringnoFiltra por la categoría CBS/IBS del ítem según la reforma tributaria.
created_afterstringnoInicio del rango de fecha de creación (YYYY-MM-DD).
created_beforestringnoFin del rango de fecha de creación (YYYY-MM-DD).

Respuestas

HTTPDescripción
200Lista paginada de ítems de servicio.
404Recurso no encontrado en la organización actual.

service-items create​

Crear ítem de servicio

kobana billing service-items create [OPCIONES]

POST /v1/service_items

Crea un ítem de servicio en el catálogo LC 116/2003. internal_code es el identificador interno y lc116_code debe seguir el catálogo de la Ley Complementaria 116/2003 (p. ej. 01.05). Cuando se informa company_id, la empresa debe pertenecer a la organización autenticada.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
namestringsíNombre del ítem de servicio.
internal_codestringsíCódigo interno del ítem — inmutable después de la creación.
lc116_codestringsíCódigo LC 116/2003 del servicio (p. ej. 01.05).
external_idstringnoIdentificador en su sistema externo, para idempotencia/sincronización.
company_idstring (uuid)noUUID de la empresa emisora asociada. Omite o envía null para un ítem aplicable a todas las empresas.
descriptionstringnoDescripción opcional.
municipal_codestringnoCódigo municipal del servicio, cuando corresponda.
nbs_codestringnoCódigo NBS.
cnae_codestringnoCódigo CNAE relacionado.
simples_annexstringnoAnexo del Simples Nacional aplicable: annex_iii, annex_iv o annex_v. Valores: annex_iii, annex_iv, annex_v.
default_iss_ratenumbernoAlícuota predeterminada de ISS en puntos porcentuales (p. ej. 2.5).
c_class_tribstringnoClasificación tributaria CST IBS/CBS.
cbs_ibs_categorystringnoCategoría CBS/IBS del ítem.
indop_codestringnoIndicador de Operación (indOp) de la NFS-e SNNFSE.
custom_metadataobjectnoMetadatos arbitrarios definidos por el cliente (clave/valor).

Otros campos y objetos anidados: kobana schema billing.service-items.create.

Respuestas

HTTPDescripción
201Ítem de servicio creado.
400El cuerpo de la solicitud falló en la validación.
404Recurso no encontrado en la organización actual.
422El cuerpo de la solicitud falló en la validación.

service-items update​

Crear o actualizar ítem de servicio

kobana billing service-items update [OPCIONES]

PUT /v1/service_items

Recibe el mismo cuerpo del POST, más id y public_id, y deduplica por id, public_id, external_id y las claves naturales del recurso, en ese orden, deteniéndose en la primera que encuentre un registro. Si lo encuentra, lo actualiza y responde 200; si no, lo crea y responde 201. Los campos obligatorios del POST solo se exigen cuando no se encuentra ningún registro, y la actualización es parcial.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
external_idstringnoIdentificador en su sistema externo, para idempotencia/sincronización.
company_idstring (uuid)noUUID de la empresa emisora asociada. Omite o envía null para un ítem aplicable a todas las empresas.
namestringnoNombre del ítem de servicio.
descriptionstringnoDescripción opcional.
internal_codestringnoCódigo interno del ítem — inmutable después de la creación.
lc116_codestringnoCódigo LC 116/2003 del servicio (p. ej. 01.05).
municipal_codestringnoCódigo municipal del servicio, cuando corresponda.
nbs_codestringnoCódigo NBS.
cnae_codestringnoCódigo CNAE relacionado.
simples_annexstringnoAnexo del Simples Nacional aplicable: annex_iii, annex_iv o annex_v. Valores: annex_iii, annex_iv, annex_v.
default_iss_ratenumbernoAlícuota predeterminada de ISS en puntos porcentuales (p. ej. 2.5).
c_class_tribstringnoClasificación tributaria CST IBS/CBS.
cbs_ibs_categorystringnoCategoría CBS/IBS del ítem.
indop_codestringnoIndicador de Operación (indOp) de la NFS-e SNNFSE.
custom_metadataobjectnoMetadatos arbitrarios definidos por el cliente (clave/valor).
idstring (uuid)noUUID del registro. Se usa solo para localizarlo — nunca se guarda.
public_idstring (uuid)noUUID público del registro, usado para localizarlo.

Otros campos y objetos anidados: kobana schema billing.service-items.update.

Respuestas

HTTPDescripción
200Registro actualizado.
201Registro creado.
400El cuerpo de la solicitud falló en la validación.
404Recurso no encontrado en la organización actual.
422El cuerpo de la solicitud falló en la validación.

service-items get​

Obtener ítem de servicio

kobana billing service-items get [ID] [OPCIONES]

GET /v1/service_items/{id}

Argumentos de la ruta: id

Respuestas

HTTPDescripción
200Detalle del ítem de servicio.
404Recurso no encontrado en la organización actual.

service-items delete​

Eliminar ítem de servicio

kobana billing service-items delete [ID] [OPCIONES]

DELETE /v1/service_items/{id}

Elimina el ítem de servicio (soft delete: deleted_at — desaparece de toda lectura; las reglas tributarias, productos y NFS-e emitidas que lo citan guardan la referencia). Exige el nivel de acceso delete. Para solo dejar de usarlo, desactívalo (PATCH con is_active=false). Hasta octubre de 2026 esta ruta eliminaba el ítem definitivamente, o solo lo desactivaba cuando una regla tributaria lo usaba.

Argumentos de la ruta: id

Respuestas

HTTPDescripción
200Ítem de servicio eliminado.
404Recurso no encontrado en la organización actual.
422El cuerpo de la solicitud falló en la validación.