Sibill Subcategory API
The Subcategory API from Sibill — 2 operation(s) for subcategory.
OpenAPI Specification
openapi: 3.0.0
info:
title: Sibill Integration Account Subcategory API
version: 1.0.0
x-logo:
altText: Sibill logo
backgroundColor: '#FFFFFF'
url: https://sibill.com/wp-content/uploads/2022/12/logo-sibill.svg
servers:
- url: http://integration.app.svc.cluster.local:4000
variables: {}
security: []
tags:
- name: Subcategory
paths:
/api/v1/companies/{company_id}/subcategories:
get:
callbacks: {}
description: 'The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page.
A cursor is needed to traverse the results.
'
operationId: SibillWeb.Integration.V1.SubcategoriesController.index
parameters:
- description: The company the subcategories belong to
in: path
name: company_id
required: true
schema:
type: string
- description: The page size
in: query
name: page_size
required: false
schema:
type: integer
- description: 'The pagination cursor. A cursor is used to paginate through a large set of data.
It is a unique identifier that represents a specific position in the dataset.
'
in: query
name: cursor
required: false
schema:
type: string
- description: 'List of filters on the resource. Currently the fields that allow to be filtered are: `id`, `category_id`, `name`'
in: query
name: filter
required: false
schema:
type: object
- description: 'Fields for which we can order the results. Sortable fields: `category_id`, `name`'
in: query
name: sort
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubcategoryList'
description: Ok
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Bad request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Forbidden
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Too Many Requests
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Internal Server Error
security:
- authorization: []
summary: List all subcategories for the company
tags:
- Subcategory
x-codeSamples:
- label: ⚡ cURL
lang: Shell
source: "base_url=\"http://example.com\" # Replace with the correct Sibill integration API host\n\ncurl --request GET \\\n --url ${base_url}/api/v1/companies/:company_id/subcategories \\\n --header \"Authorization: Bearer ${authorization_token}\"\n"
- label: 🌐 HTTP
lang: HTTP
source: 'GET /api/v1/companies/:company_id/subcategories HTTP/1.1
Host: example.com # Replace with the correct Sibill integration API host
Authorization: Bearer ${authorization_token}
'
- label: 💜 Elixir
lang: Elixir
source: 'Mix.install([:req])
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url <> "/api/v1/companies/:company_id/subcategories"
headers = [{"Authorization", "Bearer ${authorization_token}"}]
Req.get(url, headers: headers)
'
- label: 🐍 Python
lang: Python
source: 'import requests
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url + "/api/v1/companies/:company_id/subcategories"
headers = {"Authorization": "Bearer ${authorization_token}"}
response = requests.get(url, headers=headers)
print(response.text)
'
- label: ☕ Java
lang: Java
source: "import java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.net.URI;\n\nString base_url = \"http://example.com\"; // Replace with the correct Sibill integration API host\nString url = base_url + \"/api/v1/companies/:company_id/subcategories\";\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(url))\n .header(\"Authorization\", \"Bearer ${authorization_token}\")\n .GET()\n .build();\n\nHttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());\n"
- label: 🐘 PHP
lang: PHP
source: "<?php\n\n$url = \"http://example.com/api/v1/companies/:company_id/subcategories\"; // Replace with the correct Sibill integration API host\n\n$ch = curl_init($url);\n\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"GET\");\n\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n \"Authorization: Bearer ${authorization_token}\"\n]);\n\n$response = curl_exec($ch);\n\nif (curl_errno($ch)) {\n echo 'Curl error: ' . curl_error($ch);\n} else {\n echo 'Response:' . PHP_EOL;\n echo $response;\n}\n\ncurl_close($ch);\n"
post:
callbacks: {}
description: 'Creates a new subcategory under a parent category. The parent category must
belong to the same company; otherwise the request returns `404 Not Found`.
'
operationId: SibillWeb.Integration.V1.SubcategoriesController.create
parameters:
- description: The company the subcategory belongs to
in: path
name: company_id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubcategoryCreate'
description: Subcategory
required: false
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SubcategoryData'
description: Subcategory created
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Bad request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Not found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Unprocessable Entity
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Too Many Requests
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Internal Server Error
security:
- authorization: []
summary: Create a new subcategory
tags:
- Subcategory
x-codeSamples:
- label: ⚡ cURL
lang: Shell
source: "base_url=\"http://example.com\" # Replace with the correct Sibill integration API host\n\ncurl --request POST \\\n --url ${base_url}/api/v1/companies/:company_id/subcategories \\\n --header \"Authorization: Bearer ${authorization_token}\" \\\n --header \"Content-Type: application/json\" \\\n --data '${your payload here}'\n"
- label: 🌐 HTTP
lang: HTTP
source: 'POST /api/v1/companies/:company_id/subcategories HTTP/1.1
Host: example.com # Replace with the correct Sibill integration API host
Authorization: Bearer ${authorization_token}
Content-Type: application/json
${your payload here}
'
- label: 💜 Elixir
lang: Elixir
source: 'Mix.install([:req])
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url <> "/api/v1/companies/:company_id/subcategories"
headers = [{"Authorization", "Bearer ${authorization_token}"}, {"Content-Type", "application/json"}]
payload = ${your payload here}
Req.post(url, headers: headers, body: payload)
'
- label: 🐍 Python
lang: Python
source: 'import requests
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url + "/api/v1/companies/:company_id/subcategories"
headers = {"Authorization": "Bearer ${authorization_token}", "Content-Type": "application/json"}
payload = ${your payload here}
response = requests.post(url, headers=headers, json=payload)
print(response.text)
'
- label: ☕ Java
lang: Java
source: "import java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.net.URI;\n\nString base_url = \"http://example.com\"; // Replace with the correct Sibill integration API host\nString url = base_url + \"/api/v1/companies/:company_id/subcategories\";\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(url))\n .header(\"Authorization\", \"Bearer ${authorization_token}\")\n .header(\"Content-Type\", \"application/json\")\n .POST(HttpRequest.BodyPublishers.ofString(${your payload here}))\n .build();\n\nHttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());\n"
- label: 🐘 PHP
lang: PHP
source: "<?php\n\n$url = \"http://example.com/api/v1/companies/:company_id/subcategories\"; // Replace with the correct Sibill integration API host\n\n$ch = curl_init($url);\n\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"POST\");\n\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n \"Authorization: Bearer ${authorization_token}\",\n \"Content-Type: application/json\"\n]);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, <<<BODY\n${your payload here}\nBODY\n);\n\n$response = curl_exec($ch);\n\nif (curl_errno($ch)) {\n echo 'Curl error: ' . curl_error($ch);\n} else {\n echo 'Response:' . PHP_EOL;\n echo $response;\n}\n\ncurl_close($ch);\n"
/api/v1/companies/{company_id}/subcategories/{id}:
delete:
callbacks: {}
description: 'Deletes the subcategory and clears its reference from associated transactions.
'
operationId: SibillWeb.Integration.V1.SubcategoriesController.delete
parameters:
- description: The company the subcategory belongs to
in: path
name: company_id
required: true
schema:
type: string
- description: The subcategory identifier
in: path
name: id
required: true
schema:
type: string
responses:
'204':
content:
application/json: {}
description: Subcategory deleted
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Not found
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Too Many Requests
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Internal Server Error
security:
- authorization: []
summary: Delete a subcategory
tags:
- Subcategory
x-codeSamples:
- label: ⚡ cURL
lang: Shell
source: "base_url=\"http://example.com\" # Replace with the correct Sibill integration API host\n\ncurl --request DELETE \\\n --url ${base_url}/api/v1/companies/:company_id/subcategories/:subcategory_id \\\n --header \"Authorization: Bearer ${authorization_token}\"\n"
- label: 🌐 HTTP
lang: HTTP
source: 'DELETE /api/v1/companies/:company_id/subcategories/:subcategory_id HTTP/1.1
Host: example.com # Replace with the correct Sibill integration API host
Authorization: Bearer ${authorization_token}
'
- label: 💜 Elixir
lang: Elixir
source: 'Mix.install([:req])
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url <> "/api/v1/companies/:company_id/subcategories/:subcategory_id"
headers = [{"Authorization", "Bearer ${authorization_token}"}]
Req.delete(url, headers: headers)
'
- label: 🐍 Python
lang: Python
source: 'import requests
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url + "/api/v1/companies/:company_id/subcategories/:subcategory_id"
headers = {"Authorization": "Bearer ${authorization_token}"}
response = requests.delete(url, headers=headers)
print(response.text)
'
- label: ☕ Java
lang: Java
source: "import java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.net.URI;\n\nString base_url = \"http://example.com\"; // Replace with the correct Sibill integration API host\nString url = base_url + \"/api/v1/companies/:company_id/subcategories/:subcategory_id\";\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(url))\n .header(\"Authorization\", \"Bearer ${authorization_token}\")\n .DELETE()\n .build();\n\nHttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());\n"
- label: 🐘 PHP
lang: PHP
source: "<?php\n\n$url = \"http://example.com/api/v1/companies/:company_id/subcategories/:subcategory_id\"; // Replace with the correct Sibill integration API host\n\n$ch = curl_init($url);\n\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"DELETE\");\n\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n \"Authorization: Bearer ${authorization_token}\"\n]);\n\n$response = curl_exec($ch);\n\nif (curl_errno($ch)) {\n echo 'Curl error: ' . curl_error($ch);\n} else {\n echo 'Response:' . PHP_EOL;\n echo $response;\n}\n\ncurl_close($ch);\n"
get:
callbacks: {}
description: Returns all the information for a specific subcategory from its identifier
operationId: SibillWeb.Integration.V1.SubcategoriesController.show
parameters:
- description: The company the subcategory belongs to
in: path
name: company_id
required: true
schema:
type: string
- description: The subcategory identifier
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubcategoryData'
description: Ok
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Not found
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Too Many Requests
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Internal Server Error
security:
- authorization: []
summary: Get a subcategory
tags:
- Subcategory
x-codeSamples:
- label: ⚡ cURL
lang: Shell
source: "base_url=\"http://example.com\" # Replace with the correct Sibill integration API host\n\ncurl --request GET \\\n --url ${base_url}/api/v1/companies/:company_id/subcategories/:subcategory_id \\\n --header \"Authorization: Bearer ${authorization_token}\"\n"
- label: 🌐 HTTP
lang: HTTP
source: 'GET /api/v1/companies/:company_id/subcategories/:subcategory_id HTTP/1.1
Host: example.com # Replace with the correct Sibill integration API host
Authorization: Bearer ${authorization_token}
'
- label: 💜 Elixir
lang: Elixir
source: 'Mix.install([:req])
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url <> "/api/v1/companies/:company_id/subcategories/:subcategory_id"
headers = [{"Authorization", "Bearer ${authorization_token}"}]
Req.get(url, headers: headers)
'
- label: 🐍 Python
lang: Python
source: 'import requests
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url + "/api/v1/companies/:company_id/subcategories/:subcategory_id"
headers = {"Authorization": "Bearer ${authorization_token}"}
response = requests.get(url, headers=headers)
print(response.text)
'
- label: ☕ Java
lang: Java
source: "import java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.net.URI;\n\nString base_url = \"http://example.com\"; // Replace with the correct Sibill integration API host\nString url = base_url + \"/api/v1/companies/:company_id/subcategories/:subcategory_id\";\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(url))\n .header(\"Authorization\", \"Bearer ${authorization_token}\")\n .GET()\n .build();\n\nHttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());\n"
- label: 🐘 PHP
lang: PHP
source: "<?php\n\n$url = \"http://example.com/api/v1/companies/:company_id/subcategories/:subcategory_id\"; // Replace with the correct Sibill integration API host\n\n$ch = curl_init($url);\n\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"GET\");\n\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n \"Authorization: Bearer ${authorization_token}\"\n]);\n\n$response = curl_exec($ch);\n\nif (curl_errno($ch)) {\n echo 'Curl error: ' . curl_error($ch);\n} else {\n echo 'Response:' . PHP_EOL;\n echo $response;\n}\n\ncurl_close($ch);\n"
patch:
callbacks: {}
operationId: SibillWeb.Integration.V1.SubcategoriesController.update
parameters:
- description: The company the subcategory belongs to
in: path
name: company_id
required: true
schema:
type: string
- description: The subcategory identifier
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubcategoryUpdate'
description: Subcategory
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubcategoryData'
description: Subcategory updated
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Bad request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Not found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Unprocessable Entity
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Too Many Requests
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationError'
description: Internal Server Error
security:
- authorization: []
summary: Update an existing subcategory
tags:
- Subcategory
x-codeSamples:
- label: ⚡ cURL
lang: Shell
source: "base_url=\"http://example.com\" # Replace with the correct Sibill integration API host\n\ncurl --request PATCH \\\n --url ${base_url}/api/v1/companies/:company_id/subcategories/:subcategory_id \\\n --header \"Authorization: Bearer ${authorization_token}\" \\\n --header \"Content-Type: application/json\" \\\n --data '${your payload here}'\n"
- label: 🌐 HTTP
lang: HTTP
source: 'PATCH /api/v1/companies/:company_id/subcategories/:subcategory_id HTTP/1.1
Host: example.com # Replace with the correct Sibill integration API host
Authorization: Bearer ${authorization_token}
Content-Type: application/json
${your payload here}
'
- label: 💜 Elixir
lang: Elixir
source: 'Mix.install([:req])
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url <> "/api/v1/companies/:company_id/subcategories/:subcategory_id"
headers = [{"Authorization", "Bearer ${authorization_token}"}, {"Content-Type", "application/json"}]
payload = ${your payload here}
Req.patch(url, headers: headers, body: payload)
'
- label: 🐍 Python
lang: Python
source: 'import requests
base_url = "http://example.com" # Replace with the correct Sibill integration API host
url = base_url + "/api/v1/companies/:company_id/subcategories/:subcategory_id"
headers = {"Authorization": "Bearer ${authorization_token}", "Content-Type": "application/json"}
payload = ${your payload here}
response = requests.patch(url, headers=headers, json=payload)
print(response.text)
'
- label: ☕ Java
lang: Java
source: "import java.net.http.HttpClient;\nimport java.net.http.HttpRequest;\nimport java.net.http.HttpResponse;\nimport java.net.URI;\n\nString base_url = \"http://example.com\"; // Replace with the correct Sibill integration API host\nString url = base_url + \"/api/v1/companies/:company_id/subcategories/:subcategory_id\";\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(url))\n .header(\"Authorization\", \"Bearer ${authorization_token}\")\n .header(\"Content-Type\", \"application/json\")\n .PATCH(HttpRequest.BodyPublishers.ofString(${your payload here}))\n .build();\n\nHttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.body());\n"
- label: 🐘 PHP
lang: PHP
source: "<?php\n\n$url = \"http://example.com/api/v1/companies/:company_id/subcategories/:subcategory_id\"; // Replace with the correct Sibill integration API host\n\n$ch = curl_init($url);\n\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"PATCH\");\n\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n \"Authorization: Bearer ${authorization_token}\",\n \"Content-Type: application/json\"\n]);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, <<<BODY\n${your payload here}\nBODY\n);\n\n$response = curl_exec($ch);\n\nif (curl_errno($ch)) {\n echo 'Curl error: ' . curl_error($ch);\n} else {\n echo 'Response:' . PHP_EOL;\n echo $response;\n}\n\ncurl_close($ch);\n"
components:
schemas:
Page:
properties:
cursor:
description: A cursor that can be used to fetch the next page of results
nullable: true
type: string
size:
description: The current page size
type: integer
title: Page
type: object
SubcategoryCreate:
description: Create subcategory data object
properties:
category_id:
description: The id of the parent category
format: uuid
type: string
name:
description: The name of the subcategory
type: string
required:
- name
- category_id
title: SubcategoryCreate
type: object
SubcategoryUpdate:
description: Update subcategory data object
properties:
name:
description: The name of the subcategory
type: string
title: SubcategoryUpdate
type: object
SubcategoryList:
description: List of subcategory representations
properties:
data:
items:
$ref: '#/components/schemas/SubcategorySchema'
type: array
page:
$ref: '#/components/schemas/Page'
title: SubcategoryList
type: object
IntegrationError:
properties:
errors:
description: The list of errors encountered during the operation with detailed information
items:
properties:
code:
description: Short code identifying an error type
example: bad_request
type: string
detail:
description: The message detail that describes the error
example: null value where string expected
nullable: true
type: string
source:
nullable: true
properties:
pointer:
description: The exact position in the request where the error occurred
example: /data/attributes/name
type: string
type: object
title:
description: The message title that describes the error. It is a short, human-readable summary of the problem
example: Invalid value
type: string
type: object
type: array
required:
- errors
title: IntegrationError
type: object
SubcategorySchema:
description: Subcategory data representation
properties:
category_id:
description: The id of the parent category
format: uuid
readOnly: true
type: string
id:
description: The id of the subcategory
example: 019f8035-9d6e-7d95-90b6-482e17112302
format: uuid
readOnly: true
type: string
name:
description: The name of the subcategory
readOnly: true
type: string
title: SubcategorySchema
type: object
SubcategoryData:
description: Subcategory data object
properties:
data:
$ref: '#/components/schemas/SubcategorySchema'
title: SubcategoryData
type: object
securitySchemes:
authorization:
description: Sibill Integration API scheme documentation
scheme: bearer
type: https