Skip to main content

Service items

The municipal service list entries used to describe what an invoice (NFS-e) is charging for.

CommandHTTPDescription
service-items listGET /v1/service_itemsList service items
service-items createPOST /v1/service_itemsCreate a service item
service-items getGET /v1/service_items/{id}Get a service item
service-items updatePATCH /v1/service_items/{id}Update a service item
service-items deleteDELETE /v1/service_items/{id}Delete a service item

Examples​

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List service items
kobana billing service-items list \
--fields "id,public_id,external_id,organization_id,company_id"

# Get a service item
kobana billing service-items get --params '{"id": "SERVICE_ITEM_ID"}'

# Create a service item
kobana billing service-items create \
--json '{"name": "NAME", "internal_code": "INTERNAL_CODE", "lc116_code": "01.05"}'

# Update a service item
kobana billing service-items update \
--params '{"id": "SERVICE_ITEM_ID"}' \
--json '{"external_id": "EXTERNAL_ID", "company_id": "COMPANY_ID", "name": "NAME"}'

# Delete a service item
kobana billing service-items delete \
--params '{"id": "SERVICE_ITEM_ID"}' \
--dry-run

Next steps​