Sibill Integration API

https://docs.sibill.com/api-reference/
Admin
The Sibill API is organized around REST, providing predictable resource-oriented URLs, accepting...
Tokens:28,428
Snippets:76
Trust Score:8.3
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Counterparts Request Samples (curl, http, elixir, python, java, php)

Source: https://docs.sibill.com/api-reference/index

Provides examples for requesting a list of counterparts, supporting pagination and filtering. The samples cover curl, http, elixir, python, java, and php, requiring a base URL and authorization.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/counterparts \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Get Document Request Sample

Source: https://docs.sibill.com/api-reference/index

This section provides request samples for retrieving a specific document using its identifier. It includes examples for cURL, HTTP, Elixir, Python, Java, and PHP, demonstrating how to make the GET request to the Sibill API.

```shell
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id \
     --header "Authorization: Bearer ${authorization_token}"
```

```python
import requests

base_url = "http://example.com" # Replace with the correct Sibill integration API host
company_id = "your_company_id"
document_id = "your_document_id"
authorization_token = "your_authorization_token"

headers = {
    "Authorization": f"Bearer {authorization_token}"
}

url = f"{base_url}/api/v1/companies/{company_id}/documents/{document_id}"

response = requests.get(url, headers=headers)

print(response.status_code)
print(response.json())
```

```java
import okhttp3.*;
import java.io.IOException;

public class GetDocument {
    public static void main(String[] args) throws IOException {
        String baseUrl = "http://example.com"; // Replace with the correct Sibill integration API host
        String companyId = "your_company_id";
        String documentId = "your_document_id";
        String authorizationToken = "your_authorization_token";

        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url(baseUrl + "/api/v1/companies/" + companyId + "/documents/" + documentId)
            .header("Authorization", "Bearer " + authorizationToken)
            .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println(response.code());
            if (response.body() != null) {
                System.out.println(response.body().string());
            }
        }
    }
}
```

```php
<?php

$baseUrl = "http://example.com"; // Replace with the correct Sibill integration API host
$companyId = "your_company_id";
$documentId = "your_document_id";
$authorizationToken = "your_authorization_token";

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "{$baseUrl}/api/v1/companies/{$companyId}/documents/{$documentId}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "Authorization: Bearer {$authorizationToken}"
));

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo "HTTP Code: {$httpCode}" . PHP_EOL;
    echo $response;
}

curl_close($ch);

?>
```

```elixir
base_url = "http://example.com" # Replace with the correct Sibill integration API host
company_id = "your_company_id"
document_id = "your_document_id"
authorization_token = "your_authorization_token"

url = "#{base_url}/api/v1/companies/#{company_id}/documents/#{document_id}"

headers = [{"Authorization", "Bearer #{authorization_token}"}]

{:ok, response} = HTTPoison.get(url, headers)

IO.puts response.status_code
IO.puts response.body
```

--------------------------------

### Request Sample: Get Account (curl)

Source: https://docs.sibill.com/api-reference/index

This snippet demonstrates how to retrieve information for a specific account using a GET request with curl. It requires the company ID, account ID, base URL, and authorization token.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/accounts/:account_id \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Get Categories Request Samples (curl, http, elixir, python, java, php)

Source: https://docs.sibill.com/api-reference/index

Demonstrates how to make a GET request to retrieve a list of categories. Supports various request methods including curl, http, elixir, python, java, and php. Requires a base URL and authorization token.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/categories \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Get List of Flows Request Sample (curl)

Source: https://docs.sibill.com/api-reference/index

This code snippet demonstrates how to make a GET request to retrieve a list of flows for a given document using curl. It requires the company ID and document ID as path parameters and an authorization token.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id/flows \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Get Specific Flow Request Sample (curl)

Source: https://docs.sibill.com/api-reference/index

This code snippet shows how to make a GET request to retrieve a specific flow for a given document using curl. It requires the company ID, document ID, and flow ID as path parameters and an authorization token.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id/flows/:flow_id \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Request Sample: List Companies (curl)

Source: https://docs.sibill.com/api-reference/index

This snippet demonstrates how to list companies using a GET request with curl. It requires a base URL and an authorization token.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Update Document Request Samples

Source: https://docs.sibill.com/api-reference/index

This section provides request samples for updating an existing document. It includes examples for cURL, HTTP, Elixir, Python, Java, and PHP, demonstrating how to send a PATCH request with the updated document information.

```shell
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request PATCH \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id \
     --header "Authorization: Bearer ${authorization_token}" \
     --header "Content-Type: application/json" \
     --data "{
  \"category_id\": \"8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2\",
  \"notes\": \"string\"
}"
```

```python
import requests
import json

base_url = "http://example.com" # Replace with the correct Sibill integration API host
company_id = "your_company_id"
document_id = "your_document_id"
authorization_token = "your_authorization_token"

headers = {
    "Authorization": f"Bearer {authorization_token}",
    "Content-Type": "application/json"
}

payload = {
    "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
    "notes": "string"
}

url = f"{base_url}/api/v1/companies/{company_id}/documents/{document_id}"

response = requests.patch(url, headers=headers, data=json.dumps(payload))

print(response.status_code)
print(response.json())
```

```java
import okhttp3.*;
import java.io.IOException;

public class UpdateDocument {
    public static void main(String[] args) throws IOException {
        String baseUrl = "http://example.com"; // Replace with the correct Sibill integration API host
        String companyId = "your_company_id";
        String documentId = "your_document_id";
        String authorizationToken = "your_authorization_token";

        OkHttpClient client = new OkHttpClient();

        MediaType JSON = MediaType.get("application/json; charset=utf-8");
        String jsonPayload = "{\"category_id\": \"8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2\", \"notes\": \"string\"}";

        RequestBody body = RequestBody.create(jsonPayload, JSON);

        Request request = new Request.Builder()
            .url(baseUrl + "/api/v1/companies/" + companyId + "/documents/" + documentId)
            .patch(body)
            .header("Authorization", "Bearer " + authorizationToken)
            .header("Content-Type", "application/json")
            .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println(response.code());
            if (response.body() != null) {
                System.out.println(response.body().string());
            }
        }
    }
}
```

```php
<?php

$baseUrl = "http://example.com"; // Replace with the correct Sibill integration API host
$companyId = "your_company_id";
$documentId = "your_document_id";
$authorizationToken = "your_authorization_token";

$data = [
    "category_id" => "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
    "notes" => "string"
];

$payload = json_encode($data);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "{$baseUrl}/api/v1/companies/{$companyId}/documents/{$documentId}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "Authorization: Bearer {$authorizationToken}",
    "Content-Type: application/json"
));

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo "HTTP Code: {$httpCode}" . PHP_EOL;
    echo $response;
}

curl_close($ch);

?>
```

```elixir
base_url = "http://example.com" # Replace with the correct Sibill integration API host
company_id = "your_company_id"
document_id = "your_document_id"
authorization_token = "your_authorization_token"

url = "#{base_url}/api/v1/companies/#{company_id}/documents/#{document_id}"

headers = [{"Authorization", "Bearer #{authorization_token}"}, {"Content-Type", "application/json"}]

payload = %{
  "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
  "notes": "string"
}

{:ok, response} = HTTPoison.patch(url, Jason.encode!(payload), headers)

IO.puts response.status_code
IO.puts response.body
```

--------------------------------

### Request Sample: List Accounts (curl)

Source: https://docs.sibill.com/api-reference/index

This snippet shows how to list accounts for a specific company using a GET request with curl. It requires the company ID, base URL, and authorization token.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/accounts \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### GET /api/v1/counterparts/search

Source: https://docs.sibill.com/api-reference/index

Searches for counterpart information from a third-party system using the VAT number.

```APIDOC
## GET /api/v1/counterparts/search

### Description
Search for counterpart information from a third-party system using the VAT number.

### Method
GET

### Endpoint
`/api/v1/counterparts/search`

### Parameters
#### Query Parameters
- **vat_number** (string) - Required - The VAT number of the counterpart to search.

### Request Example
```bash
curl --request GET \
     --url ${base_url}/api/v1/counterparts/search \
     --header "Authorization: Bearer ${authorization_token}"
```

### Response
#### Success Response (200)
- **data** (object) - Contains the counterpart details.
  - **address** (string) - The address of the counterpart.
  - **city** (string) - The city of the counterpart.
  - **company_name** (string) - The name of the counterpart company.
  - **country** (string) - The country of the counterpart.
  - **postal_code** (string) - The postal code of the counterpart.
  - **province_code** (string) - The province code of the counterpart.
  - **tax_number** (string) - The tax number of the counterpart.
  - **vat_number** (string) - The VAT number of the counterpart.

#### Response Example
```json
{
  "data": {
    "address": "string",
    "city": "string",
    "company_name": "string",
    "country": "string",
    "postal_code": "string",
    "province_code": "string",
    "tax_number": "string",
    "vat_number": "string"
  }
}
```
```

--------------------------------

### GET /api/v1/companies/{company_id}/documents

Source: https://docs.sibill.com/api-reference/index

Lists all documents for a given company, with pagination and filtering options.

```APIDOC
## GET /api/v1/companies/{company_id}/documents

### Description
List all the company's documents. 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.

### Method
GET

### Endpoint
`/api/v1/companies/{company_id}/documents`

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The company the documents belong to.

#### Query Parameters
- **page_size** (integer) - Optional - The number of elements per page.
- **cursor** (string) - Optional - 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.
- **expand** (string) - Optional - Fields that will be expanded. Expandable fields: `category`, `counterpart`, `flows`, `subcategory`.
- **filter** (object) - Optional - List of filters on the resource. Currently the fields that allow to be filtered are: `creation_date`, `delivery_date`, `direction`, `status`, `type`, `number`,`counterpart_company_name`, `notes`, `source_id`.
- **sort** (string) - Optional - Fields for which we can order the results. Sortable fields: `created_at`, `creation_date`, `delivery_date`, `number`.

### Request Example
```bash
curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents \
     --header "Authorization: Bearer ${authorization_token}"
```

### Response
#### Success Response (200)
- **Ok** - Indicates a successful request.

#### Response Example
(Response structure for 200 OK is not fully detailed in the provided text, but would typically include a list of documents and pagination information.)
```

--------------------------------

### Get Specific Counterpart Request Samples (curl, http, elixir, python, java, php)

Source: https://docs.sibill.com/api-reference/index

Shows how to retrieve information for a single counterpart by its ID. This endpoint is accessible through curl, http, elixir, python, java, and php, and requires authentication.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/counterparts/:category_id \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Retrieve Document Invoice (cURL Example)

Source: https://docs.sibill.com/api-reference/index

This code snippet demonstrates how to retrieve a specific document invoice using cURL. It requires the company ID, document ID, and an authorization token. The request fetches the invoice details and a signed URL for the XML representation.

```shell
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/documents/:document_id/invoice \
     --header "Authorization: Bearer ${authorization_token}" \
     --header "Content-Type: application/json"
```

--------------------------------

### GET /api/v1/companies

Source: https://docs.sibill.com/api-reference/index

Retrieves a list of companies associated with the integration. The response is paginated and can be customized by page size.

```APIDOC
## GET /api/v1/companies

### Description
Retrieves a list of companies. The response is paginated, with a default of 25 elements per page. A cursor is required for traversing results.

### Method
GET

### Endpoint
/api/v1/companies

### Parameters
#### Query Parameters
- **page_size** (integer) - Optional - The number of elements to return per page.
- **cursor** (string) - Optional - A unique identifier to paginate through the results.

### Request Example
```bash
curl --request GET \
     --url ${base_url}/api/v1/companies \
     --header "Authorization: Bearer ${authorization_token}"
```

### Response
#### Success Response (200)
- **data** (array) - A list of company objects.
  - **country** (string) - The country of the company.
  - **fiscal_regime** (string) - The fiscal regime of the company.
  - **id** (string) - The unique identifier of the company.
  - **name** (string) - The name of the company.
  - **subscriptions** (array) - A list of subscription objects for the company.
    - **created_at** (string) - The creation timestamp of the subscription.
    - **status** (string) - The status of the subscription.
  - **vat_number** (string) - The VAT number of the company.

#### Response Example
```json
{
  "data": [
    {
      "country": "string",
      "fiscal_regime": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "subscriptions": [
        {
          "created_at": "2019-08-24T14:15:22Z",
          "status": "PRE_TRIAL"
        }
      ],
      "vat_number": "string"
    }
  ]
}
```
```

--------------------------------

### Get Specific Category Request Samples (curl, http, elixir, python, java, php)

Source: https://docs.sibill.com/api-reference/index

Illustrates how to fetch details for a specific category using its ID. This functionality is accessible via multiple request methods like curl, http, elixir, python, java, and php. Authentication is required.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/categories/:category_id \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Get Reconciliation Request Sample (curl)

Source: https://docs.sibill.com/api-reference/index

This snippet shows how to retrieve a specific reconciliation using a curl command. It requires the base URL, authorization token, company ID, and reconciliation ID. The response includes details of the reconciliation if successful.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/reconciliations/:id \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### Get Transaction by ID - cURL Request Sample

Source: https://docs.sibill.com/api-reference/index

This cURL command demonstrates how to retrieve a specific transaction using its unique identifier. It requires the company ID and transaction ID as path parameters, and an authorization token for authentication. The base URL should be replaced with the correct Sibill integration API host.

```bash
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/transactions/:transaction_id \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### List Transactions Request Sample (curl)

Source: https://docs.sibill.com/api-reference/index

This snippet demonstrates how to list all transactions for a company using a curl command. It requires the base URL, authorization token, and company ID. The response is paginated and can include various query parameters for filtering, sorting, and expanding data.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/transactions \
     --header "Authorization: Bearer ${authorization_token}"
```

--------------------------------

### GET /api/v1/companies/{company_id}/categories/{id}

Source: https://docs.sibill.com/api-reference/index

Retrieves detailed information for a specific category by its ID.

```APIDOC
## GET /api/v1/companies/{company_id}/categories/{id}

### Description
Retrieves all the information for a specific category using its unique identifier.

### Method
GET

### Endpoint
`/api/v1/companies/{company_id}/categories/{id}`

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The unique identifier of the company the category belongs to.
- **id** (string) - Required - The unique identifier of the category.

### Request Example
```bash
curl --request GET \
     --url https://integration.sibill.com/api/v1/companies/YOUR_COMPANY_ID/categories/YOUR_CATEGORY_ID \
     --header "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

### Response
#### Success Response (200)
- **data** (object) - The category object.
  - **id** (string) - The unique identifier of the category.
  - **name** (string) - The name of the category.

#### Response Example
```json
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Specific Category Name"
  }
}
```

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
```

--------------------------------

### List Reconciliations Request Sample (curl)

Source: https://docs.sibill.com/api-reference/index

This `curl` command demonstrates how to list all reconciliations for a given company. It includes placeholders for the base URL and authorization token.

```curl
base_url="http://example.com" # Replace with the correct Sibill integration API host

curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/reconciliations \
     --header "Authorization: Bearer ${authorization_token}"


```

--------------------------------

### GET /api/v1/companies/{company_id}/categories

Source: https://docs.sibill.com/api-reference/index

Retrieves a list of categories for a specific company. The response is paginated.

```APIDOC
## GET /api/v1/companies/{company_id}/categories

### Description
Retrieves a list of categories for a specific company. 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.

### Method
GET

### Endpoint
/api/v1/companies/{company_id}/categories

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The company the categories belong to.

#### Query Parameters
- **page_size** (integer) - Optional - The number of elements to return per page.
- **cursor** (string) - Optional - A unique identifier to paginate through the results.

### Response
#### Success Response (200)
Ok

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **500** Internal Server Error
```

--------------------------------

### JSON Response Sample for Document Flows

Source: https://docs.sibill.com/api-reference/index

This is a sample JSON response for a successful retrieval (200 OK) of a list of flows associated with a document. It includes pagination information and details for each flow.

```json
{
  "data": [
    {
      "amount": {
        "amount": "12.3",
        "currency": "EUR"
},
      "created_at": "2019-08-24T14:15:22Z",
      "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
      "expected_payment_date": "2019-08-24",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "payment_date": "2019-08-24",
      "payment_method": "CARD",
      "payment_status": "PAID"
}
],
  "page": {
    "cursor": "string",
    "size": 0
}

}
```

--------------------------------

### GET /api/v1/companies/{company_id}/counterparts/{id}

Source: https://docs.sibill.com/api-reference/index

Retrieves detailed information for a specific counterpart by its ID.

```APIDOC
## GET /api/v1/companies/{company_id}/counterparts/{id}

### Description
Retrieves all the information for a specific counterpart using its unique identifier.

### Method
GET

### Endpoint
`/api/v1/companies/{company_id}/counterparts/{id}`

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The unique identifier of the company the counterpart belongs to.
- **id** (string) - Required - The unique identifier of the counterpart.

### Request Example
```bash
curl --request GET \
     --url https://integration.sibill.com/api/v1/companies/YOUR_COMPANY_ID/counterparts/YOUR_COUNTERPART_ID \
     --header "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

### Response
#### Success Response (200)
- **data** (object) - The counterpart object. (Structure is the same as in the list response for a single counterpart).

#### Response Example
```json
{
  "data": {
    "address": "123 Main St",
    "city": "Anytown",
    "company_name": "Example Corp",
    "country": "USA",
    "destination_code": "DEST1",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "postal_code": "12345",
    "province_code": "CA",
    "tax_number": "TAX123",
    "vat_number": "VAT456"
  }
}
```

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
```

--------------------------------

### Response Sample for Flow Update (JSON)

Source: https://docs.sibill.com/api-reference/index

This is a sample JSON response for a successful flow update operation. It includes details about the flow's amount, currency, creation date, and payment status.

```json
{
  "data": {
    "amount": {
      "amount": "12.3",
      "currency": "EUR"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
    "expected_payment_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "payment_date": "2019-08-24",
    "payment_method": "CARD",
    "payment_status": "PAID"
}

}
```

--------------------------------

### GET /api/v1/companies/{company_id}/accounts

Source: https://docs.sibill.com/api-reference/index

Retrieves a list of accounts for a specific company. Supports pagination and filtering.

```APIDOC
## GET /api/v1/companies/{company_id}/accounts

### Description
Retrieves a list of accounts for a specific company. 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.

### Method
GET

### Endpoint
/api/v1/companies/{company_id}/accounts

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The company the accounts belong to.

#### Query Parameters
- **page_size** (integer) - Optional - The number of elements to return per page.
- **cursor** (string) - Optional - A unique identifier to paginate through the results.
- **filter** (object) - Optional - List of filters on the resource. Currently, the fields that allow filtering are: `id`.
- **sort** (string) - Optional - Fields for which we can order the results. Sortable fields: `created_at`.

### Request Example
```bash
curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/accounts \
     --header "Authorization: Bearer ${authorization_token}"
```

### Response
#### Success Response (200)
- **data** (array) - A list of account objects.
  - **available_balance** (object) - The available balance of the account.
    - **amount** (string) - The amount.
    - **currency** (string) - The currency.
  - **balance_date** (string) - The date of the balance.
  - **created_at** (string) - The creation timestamp of the account.
  - **credit_limit** (object) - The credit limit of the account.
    - **amount** (string) - The amount.
    - **currency** (string) - The currency.
  - **currency** (string) - The currency of the account.
  - **current_balance** (object) - The current balance of the account.
    - **amount** (string) - The amount.
    - **currency** (string) - The currency.
  - **id** (string) - The unique identifier of the account.
  - **nickname** (string) - The nickname of the account.
- **page** (object) - Pagination information.
  - **cursor** (string) - The pagination cursor.
  - **size** (integer) - The number of elements per page.

#### Response Example
```json
{
  "data": [
    {
      "available_balance": {
        "amount": "12.3",
        "currency": "EUR"
      },
      "balance_date": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "credit_limit": {
        "amount": "12.3",
        "currency": "EUR"
      },
      "currency": "AED",
      "current_balance": {
        "amount": "12.3",
        "currency": "EUR"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "nickname": "string"
    }
  ],
  "page": {
    "cursor": "string",
    "size": 0
  }
}
```
```

--------------------------------

### GET /api/v1/companies/:company_id/counterparts/:counterpart_id

Source: https://docs.sibill.com/api-reference/index

Retrieves specific counterpart information for a given company and counterpart ID.

```APIDOC
## GET /api/v1/companies/:company_id/counterparts/:counterpart_id

### Description
Retrieves specific counterpart information for a given company and counterpart ID.

### Method
GET

### Endpoint
`/api/v1/companies/:company_id/counterparts/:counterpart_id`

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The ID of the company.
- **counterpart_id** (string) - Required - The ID of the counterpart.

### Request Example
```bash
curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/counterparts/:counterpart_id \
     --header "Authorization: Bearer ${authorization_token}"
```

### Response
#### Success Response (200)
- **data** (object) - Contains the counterpart details.
  - **address** (string) - The address of the counterpart.
  - **city** (string) - The city of the counterpart.
  - **company_name** (string) - The name of the counterpart company.
  - **country** (string) - The country of the counterpart.
  - **destination_code** (string) - The destination code.
  - **id** (string) - The unique identifier of the counterpart.
  - **postal_code** (string) - The postal code of the counterpart.
  - **province_code** (string) - The province code of the counterpart.
  - **tax_number** (string) - The tax number of the counterpart.
  - **vat_number** (string) - The VAT number of the counterpart.

#### Response Example
```json
{
  "data": {
    "address": "string",
    "city": "string",
    "company_name": "string",
    "country": "string",
    "destination_code": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "postal_code": "string",
    "province_code": "string",
    "tax_number": "string",
    "vat_number": "string"
  }
}
```
```

--------------------------------

### JSON Response Sample for a Single Document Flow

Source: https://docs.sibill.com/api-reference/index

This is a sample JSON response for a successful retrieval (200 OK) of a specific flow for a document. It details the flow's amount, dates, and payment status.

```json
{
  "data": {
    "amount": {
      "amount": "12.3",
      "currency": "EUR"
},
    "created_at": "2019-08-24T14:15:22Z",
    "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
    "expected_payment_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "payment_date": "2019-08-24",
    "payment_method": "CARD",
    "payment_status": "PAID"
}

}
```

--------------------------------

### GET /api/v1/companies/{company_id}/categories

Source: https://docs.sibill.com/api-reference/index

Retrieves a list of categories for a given company. Supports pagination and filtering.

```APIDOC
## GET /api/v1/companies/{company_id}/categories

### Description
Retrieves a list of categories associated with a specific company. This endpoint supports pagination and filtering to manage large datasets.

### Method
GET

### Endpoint
`/api/v1/companies/{company_id}/categories`

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The unique identifier of the company.

#### Query Parameters
- **page_size** (integer) - Optional - The number of results to return per page.
- **cursor** (string) - Optional - A cursor for paginating through the results. Use this to retrieve subsequent pages of data.
- **filter** (object) - Optional - An object containing fields to filter the results. Supported fields: `id`, `name`.
- **sort** (string) - Optional - Fields by which to sort the results. Supported field: `name`.

### Request Example
```bash
curl --request GET \
     --url https://integration.sibill.com/api/v1/companies/YOUR_COMPANY_ID/categories?page_size=25 \
     --header "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

### Response
#### Success Response (200)
- **data** (array) - A list of category objects.
  - **id** (string) - The unique identifier of the category.
  - **name** (string) - The name of the category.
- **page** (object) - Pagination information.
  - **cursor** (string) - The cursor for the next page of results.
  - **size** (integer) - The number of items returned in this page.

#### Response Example
```json
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Example Category"
    }
  ],
  "page": {
    "cursor": "next_cursor_string",
    "size": 25
  }
}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden
- **500** Internal Server Error
```

--------------------------------

### List Transactions Response Sample (200 OK)

Source: https://docs.sibill.com/api-reference/index

This JSON object represents a successful response (HTTP 200 OK) when listing transactions. It contains a 'data' array with transaction objects and a 'page' object for pagination information. Each transaction object includes details like account ID, amount, dates, and reconciliation information.

```json
{
  "data": [
    {
      "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
      "amount": {
        "amount": "12.3",
        "currency": "EUR"
},
      "booking_date_time": "2019-08-24T14:15:22Z",
      "category": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
},
      "clean_description": "string",
      "counterpart_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "reconciliations": [
        {
          "created_at": "2019-08-24T14:15:22Z",
          "flow": {
            "amount": {
              "amount": "12.3",
              "currency": "EUR"
},
            "created_at": "2019-08-24T14:15:22Z",
            "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
            "expected_payment_date": "2019-08-24",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "payment_date": "2019-08-24",
            "payment_method": "CARD",
            "payment_status": "PAID"
},
          "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "transaction": { },
          "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482"
}
],
      "subcategory": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
},
      "value_date": "2019-08-24T14:15:22Z"
}
],
  "page": {
    "cursor": "string",
    "size": 0
}

}
```

--------------------------------

### GET /api/v1/companies/{company_id}/accounts/{id}

Source: https://docs.sibill.com/api-reference/index

Retrieves detailed information for a specific account identified by its ID.

```APIDOC
## GET /api/v1/companies/{company_id}/accounts/{id}

### Description
Returns all the information for a specific account from its identifier.

### Method
GET

### Endpoint
/api/v1/companies/{company_id}/accounts/{id}

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The company the account belongs to.
- **id** (string) - Required - The account identifier.

### Request Example
```bash
curl --request GET \
     --url ${base_url}/api/v1/companies/:company_id/accounts/:account_id \
     --header "Authorization: Bearer ${authorization_token}"
```

### Response
#### Success Response (200)
- **data** (object) - The account object.
  - **available_balance** (object) - The available balance of the account.
    - **amount** (string) - The amount.
    - **currency** (string) - The currency.
  - **balance_date** (string) - The date of the balance.
  - **created_at** (string) - The creation timestamp of the account.
  - **credit_limit** (object) - The credit limit of the account.
    - **amount** (string) - The amount.
    - **currency** (string) - The currency.
  - **currency** (string) - The currency of the account.
  - **current_balance** (object) - The current balance of the account.
    - **amount** (string) - The amount.
    - **currency** (string) - The currency.
  - **id** (string) - The unique identifier of the account.
  - **nickname** (string) - The nickname of the account.

#### Response Example
```json
{
  "data": {
    "available_balance": {
      "amount": "12.3",
      "currency": "EUR"
    },
    "balance_date": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "credit_limit": {
      "amount": "12.3",
      "currency": "EUR"
    },
    "currency": "AED",
    "current_balance": {
      "amount": "12.3",
      "currency": "EUR"
    },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "nickname": "string"
  }
}
```
```

--------------------------------

### GET /api/v1/companies/{company_id}/counterparts

Source: https://docs.sibill.com/api-reference/index

Retrieves a list of counterparts for a given company. Supports pagination, filtering, and sorting.

```APIDOC
## GET /api/v1/companies/{company_id}/counterparts

### Description
Retrieves a paginated list of counterparts for a specified company. You can control the page size and use a cursor for navigation. Filtering and sorting options are available.

### Method
GET

### Endpoint
`/api/v1/companies/{company_id}/counterparts`

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The unique identifier of the company.

#### Query Parameters
- **page_size** (integer) - Optional - The number of results to return per page. Defaults to 25.
- **cursor** (string) - Optional - A cursor for paginating through the results. Required for subsequent pages.
- **filter** (object) - Optional - An object containing fields to filter the results. Supported fields: `vat_number`, `tax_number`, `company_name`.
- **sort** (string) - Optional - Fields by which to sort the results. Supported field: `company_name`.

### Request Example
```bash
curl --request GET \
     --url https://integration.sibill.com/api/v1/companies/YOUR_COMPANY_ID/counterparts?page_size=50 \
     --header "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

### Response
#### Success Response (200)
- **data** (array) - A list of counterpart objects.
  - **address** (string) - The address of the counterpart.
  - **city** (string) - The city of the counterpart.
  - **company_name** (string) - The name of the counterpart company.
  - **country** (string) - The country of the counterpart.
  - **destination_code** (string) - The destination code.
  - **id** (string) - The unique identifier of the counterpart.
  - **postal_code** (string) - The postal code of the counterpart.
  - **province_code** (string) - The province code.
  - **tax_number** (string) - The tax number of the counterpart.
  - **vat_number** (string) - The VAT number of the counterpart.
- **page** (object) - Pagination information.
  - **cursor** (string) - The cursor for the next page of results.
  - **size** (integer) - The number of items returned in this page.

#### Response Example
```json
{
  "data": [
    {
      "address": "123 Main St",
      "city": "Anytown",
      "company_name": "Example Corp",
      "country": "USA",
      "destination_code": "DEST1",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "postal_code": "12345",
      "province_code": "CA",
      "tax_number": "TAX123",
      "vat_number": "VAT456"
    }
  ],
  "page": {
    "cursor": "next_cursor_string",
    "size": 50
  }
}
```

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
```
Tokens:
Raw