Green Invoice API

https://greeninvoice.docs.apiary.io/
Admin
Green Invoice API is a comprehensive REST API for managing invoicing, expenses, clients, suppliers,...
Tokens:50,449
Snippets:699
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Supplier by ID (PHP)

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/get-supplier

Example of how to retrieve a specific supplier's information using their ID in PHP. This snippet demonstrates making a GET request using cURL.

```php
<?php

$supplierId = '17b3a103-cb47-b124-3d2b-ec9838cf35ad'; // Replace with actual supplier ID
$token = 'YOUR_JWT_TOKEN'; // Replace with your JWT token

$url = "https://api.greeninvoice.co.il/api/v1/suppliers/{$supplierId}";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");

$headers = array();
$headers[] = "Authorization: Bearer {$token}";
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $result;
}

c_l_close($ch);
?>
```

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

### Get Supplier by ID (Java)

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/get-supplier

Example of how to retrieve a specific supplier's information using their ID in Java. This snippet uses the Apache HttpClient library.

```java
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class GetSupplier {

    public static void main(String[] args) {
        String supplierId = "17b3a103-cb47-b124-3d2b-ec9838cf35ad"; // Replace with actual supplier ID
        String token = "YOUR_JWT_TOKEN"; // Replace with your JWT token
        String url = "https://api.greeninvoice.co.il/api/v1/suppliers/" + supplierId;

        try (CloseableHttpClient client = HttpClients.createDefault()) {
            HttpGet request = new HttpGet(url);
            request.addHeader("Authorization", "Bearer " + token);

            try (CloseableHttpResponse response = client.execute(request)) {
                System.out.println(EntityUtils.toString(response.getEntity()));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

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

### Get Supplier by ID (Node.js)

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/get-supplier

Example of how to retrieve a specific supplier's information using their ID in Node.js. This snippet demonstrates making a GET request to the supplier endpoint.

```javascript
const fetch = require('node-fetch');

const supplierId = '17b3a103-cb47-b124-3d2b-ec9838cf35ad'; // Replace with actual supplier ID
const token = 'YOUR_JWT_TOKEN'; // Replace with your JWT token

fetch(`https://api.greeninvoice.co.il/api/v1/suppliers/${supplierId}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

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

### Get Supplier by ID (cURL)

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/get-supplier

Example of how to retrieve a specific supplier's information using their ID via cURL. Ensure you replace the placeholder ID with the actual supplier ID.

```bash
curl -X GET https://api.greeninvoice.co.il/api/v1/suppliers/id \
     -H "Authorization: Bearer YOUR_JWT_TOKEN"
```

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

### Get Supplier by ID (Python)

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/get-supplier

Example of how to retrieve a specific supplier's information using their ID in Python. This snippet uses the 'requests' library to make the GET request.

```python
import requests

supplier_id = '17b3a103-cb47-b124-3d2b-ec9838cf35ad' # Replace with actual supplier ID
token = 'YOUR_JWT_TOKEN' # Replace with your JWT token

url = f'https://api.greeninvoice.co.il/api/v1/suppliers/{supplier_id}'
headers = {
    'Authorization': f'Bearer {token}'
}

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

if response.status_code == 200:
    print(response.json())
else:
    print(f'Error: {response.status_code}, {response.text}')
```

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

### Tools - Get Supported Currencies

Source: https://greeninvoice.docs.apiary.io

Retrieves a list of supported currencies.

```APIDOC
## Tools - Get Supported Currencies

### Description
Returns a list of all currencies supported by the system.

### Method
GET

### Endpoint
`/tools/currencies`

### Parameters
(Details not provided in the source text)
```

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

### Get Supported Cities

Source: https://greeninvoice.docs.apiary.io/reference/payments/get-payment-form

Get all cities supported ordered by alphabetical order. The locale and country parameters are required.

```APIDOC
## Get Supported Cities

### Description
Get all cities supported ordered by alphabetical order.

### Endpoint
https://cache.greeninvoice.co.il/geo-location/v1/cities?locale={locale}&country=IL

### Query Parameters
- **locale** (string) - Required - The locale for the cities (e.g., en_US).
- **country** (string) - Required - The country code (e.g., IL).
```

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

### Get Supplier by ID (JavaScript)

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/get-supplier

Example of how to retrieve a specific supplier's information using their ID in JavaScript using the Fetch API. This is a common method for making HTTP requests in modern web development.

```javascript
async function getSupplier(supplierId, token) {
  const url = `https://api.greeninvoice.co.il/api/v1/suppliers/${supplierId}`;
  try {
    const response = await fetch(url, {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${token}`
      }
    });
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    const data = await response.json();
    console.log(data);
  } catch (error) {
    console.error('Error fetching supplier:', error);
  }
}

// Example usage:
// const supplierId = '17b3a103-cb47-b124-3d2b-ec9838cf35ad'; // Replace with actual supplier ID
// const token = 'YOUR_JWT_TOKEN'; // Replace with your JWT token
// getSupplier(supplierId, token);
```

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

### Get a Preview Document

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Previews a document before actual generation. Returns a file in Base64 format.

```APIDOC
## Get a Preview Document

### Description
Previews a document before the actual generation. This endpoint returns a file in Base64 format.

### Method
GET

### Endpoint
/preview-document
```

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

### Get Business Types

Source: https://greeninvoice.docs.apiary.io/reference/tools/get-supported-business-categories/create-api

Retrieves a list of supported business types.

```APIDOC
## Get Business Types

### Description
Retrieves a list of supported business types.

### Method
GET

### Endpoint
/business-types
```

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

### Get Supported Countries

Source: https://greeninvoice.docs.apiary.io/reference/payments/get-payment-form

Get all countries supported ordered by alphabetical order. The locale parameter is required.

```APIDOC
## Get Supported Countries

### Description
Get all countries supported ordered by alphabetical order.

### Endpoint
https://cache.greeninvoice.co.il/geo-location/v1/countries?locale={locale}

### Query Parameters
- **locale** (string) - Required - The locale for the countries (e.g., en_US).
```

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

### Tools - Get Supported Cities

Source: https://greeninvoice.docs.apiary.io

Retrieves a list of supported cities.

```APIDOC
## Tools - Get Supported Cities

### Description
Returns a list of all cities supported by the system.

### Method
GET

### Endpoint
`/tools/cities`

### Parameters
(Details not provided in the source text)
```

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

### Documents - Get a Preview Document

Source: https://greeninvoice.docs.apiary.io

Generates and retrieves a preview of a document.

```APIDOC
## Documents - Get a Preview Document

### Description
Generates a preview of a document, typically for display or review purposes.

### Method
GET

### Endpoint
`/documents/{id}/preview`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the document to preview.
```

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

### Get Supported Currencies

Source: https://greeninvoice.docs.apiary.io

Retrieves supported currencies and their exchange rates against a specified base currency.

```APIDOC
## Get Supported Currencies

### Description
Get the supported currencies. Retrieves the latest currency and the previous day exchange rates by specified base currency.

### Method
GET

### Endpoint
`/currency-exchange/v1/latest`

### Parameters
#### Query Parameters
- **base** (string) - Required - The base currency code (e.g., `USD`).

### Response
#### Success Response (200)
- **rates** (object) - An object containing currency exchange rates.
```

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

### Tools - Get Supported Countries

Source: https://greeninvoice.docs.apiary.io

Retrieves a list of supported countries.

```APIDOC
## Tools - Get Supported Countries

### Description
Returns a list of all countries supported by the system.

### Method
GET

### Endpoint
`/tools/countries`

### Parameters
(Details not provided in the source text)
```

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

### Get Document Templates

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Retrieves information regarding available templates and their corresponding colors/skins.

```APIDOC
## Get Document Templates

### Description
Retrieves information regarding the available templates and their corresponding colors / skins in the system.

### Method
GET

### Endpoint
/document-templates
```

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

### Get Current Business

Source: https://greeninvoice.docs.apiary.io/reference/tools/get-supported-business-categories/create-api

Retrieves the details of the currently active business context.

```APIDOC
## Get Current Business

### Description
Retrieves the details of the currently active business context.

### Method
GET

### Endpoint
/businesses/current
```

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

### Get Current Business

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/create-api

Retrieves the details of the currently active business.

```APIDOC
## Get Current Business

### Description
Retrieves the details of the currently active business.

### Method
GET

### Endpoint
/business/current
```

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

### Partners - Get Partner Users

Source: https://greeninvoice.docs.apiary.io

Retrieves a list of users associated with a partner.

```APIDOC
## Partners - Get Partner Users

### Description
Fetches a list of users who are connected as partners.

### Method
GET

### Endpoint
`/partners/users`

### Parameters
(Details not provided in the source text)

### Request Example
(Details not provided in the source text)

### Response
(Details not provided in the source text)
```

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

### Get Business Types

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/create-api

Retrieves a list of business types available in the system.

```APIDOC
## Get Business Types

### Description
Retrieves a list of business types available in the system.

### Method
GET

### Endpoint
/business/types
```

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

### Get Supported Countries

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier

Fetches all supported countries, ordered alphabetically. The `locale` parameter is required.

```APIDOC
## Get Supported Countries

### Description
Get all countries supported ordered by alphabetical order.

### Endpoint
`https://cache.greeninvoice.co.il/geo-location/v1/countries?locale={locale}`

### Parameters
#### Query Parameters
- **locale** (string) - Required - The locale for the country list (e.g., `en_US`).
```

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

### Tools - Get Supported Business Categories

Source: https://greeninvoice.docs.apiary.io

Retrieves a list of supported business categories.

```APIDOC
## Tools - Get Supported Business Categories

### Description
Returns a list of all business categories that are supported by the system.

### Method
GET

### Endpoint
`/tools/business-categories`

### Parameters
(Details not provided in the source text)
```

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

### Get Supported Countries

Source: https://greeninvoice.docs.apiary.io

Retrieves a list of all supported countries, ordered alphabetically, with localization support.

```APIDOC
## Get Supported Countries

### Description
Get all countries supported ordered by alphabetical order.

### Method
GET

### Endpoint
`/geo-location/v1/countries`

### Parameters
#### Query Parameters
- **locale** (string) - Required - The locale for the country names (e.g., `en_US`, `he_IL`).

### Response
#### Success Response (200)
- **countries** (array) - A list of supported countries.
```

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

### Clients - Add Client

Source: https://greeninvoice.docs.apiary.io

Adds a new client to the system.

```APIDOC
## Clients - Add Client

### Description
Creates a new client record in the system.

### Method
POST

### Endpoint
`/clients`

### Parameters
#### Request Body
(Details not provided in the source text)

### Request Example
(Details not provided in the source text)

### Response
(Details not provided in the source text)
```

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

### Get File Upload URL (Production)

Source: https://greeninvoice.docs.apiary.io/reference/tools/get-supported-business-categories/create-api

Requests a pre-signed URL for file uploads in the production environment.

```bash
https://apigw.greeninvoice.co.il/file-upload/v1/url
```

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

### Get File Upload URL (Sandbox)

Source: https://greeninvoice.docs.apiary.io/reference/tools/get-supported-business-categories/create-api

Requests a pre-signed URL for file uploads in the sandbox environment.

```bash
https://api.sandbox.d.greeninvoice.co.il/file-upload/v1/url
```

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

### Get a Preview Document

Source: https://greeninvoice.docs.apiary.io/reference/payments/get-payment-form

Previews a document before the actual generation. This endpoint returns a file in Base64 format. It also provides guidance on how to display the file using plugins or libraries like PDF.js, and how to add a download button.

```APIDOC
## Get a Preview Document

### Description
Previews a document before the actual generation. This endpoint returns a file in Base64 format. It also provides guidance on how to display the file using plugins or libraries like PDF.js, and how to add a download button.

### Method
GET

### Endpoint
/preview-document

### Parameters
#### Query Parameters
- **file** (string) - Required - The file to preview.

### Response
#### Success Response (200)
- **base64string** (string) - The Base64 encoded file content.

### Response Example
```json
{
  "base64string": "JVBERi0xLjQKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PgplbmRvYmoKCjIgMCBvYmoKPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbMyAwIFJdPj4KZW5kb2JqCgozIDAgb2JqCjw8L1R5cGUvUGFnZS9QYXJlbnQgMiAwIFIvUmVzb3VyY2VzPDwvRm9udCA8PC9GMSAxMCAwIFI+Pj4+L01lZGlhQm94WzAgMCA1OTUuMjQgODQxLjldL0NvbnRlbnRzIDQgMCBSPj4KZW5kb2JqCgo0IDAgb2JqCjw8L0xlbmd0aCA1NT4+CnN0cmVhbQpCVSBUeXBlIGEgYmFzZTY0IGVuY29kZWQgcHJldmlldy4KZW5k c3RyZWFtCgplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxNSAwMDAwMCBuIAowMDAwMDAwMDY1IDAwMDAwIG4gCjAwMDAwMDAxMTkgMDAwMDAgbiAKMDAwMDAwMDI1OSAwMDAwMCBuIAp0cmFpbGVyCjw8L1NpemUgNS9Sb290IDEgMCBSPj4Kc3RhcnR4cmVmCjQ1NQolJUVPRgo="
}
```
```

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

### Get Document Information

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Gets information about a specific document type.

```APIDOC
## Get Document Information

### Description
Get information about specific document type.

### Method
GET

### Endpoint
/document-types/{document_type_id}
```

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

### Get Partner Users

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/create-api

Get all connected and approved users associated with a partner account. To retrieve user API keys, use the `Get Connected User` endpoint with the user's email.

```APIDOC
## Get Partner Users

### Description
Get all connected and approved users associated with a partner account. To retrieve user API keys, use the `Get Connected User` endpoint with the user's email.

### Method
GET

### Endpoint
/partners/users
```

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

### Get Linked Documents

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Gets information about linked or related documents to a specific document.

```APIDOC
## Get Linked Documents

### Description
Get information about linked / related documents to a specific document.

### Method
GET

### Endpoint
/document/{document_id}/linked
```

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

### Step 1: Get File Upload URL

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Requests a pre-signed URL and necessary authentication fields for file uploads, which is the first step in a two-step process for enhanced security.

```APIDOC
## Step 1: Get File Upload URL

### Description
Request a Upload URL to initiate a two-step file upload process for enhanced security. This step obtains a pre-signed URL and necessary authentication fields.

### Method
GET

### Endpoint
/file-upload/v1/url

### Environment
* **PRODUCTION:** `https://apigw.greeninvoice.co.il/file-upload/v1/url`
* **SANDBOX:** `https://api.sandbox.d.greeninvoice.co.il/file-upload/v1/url`
```

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

### Get Document Download Links

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Gets information about linked or related documents to a specific document.

```APIDOC
## Get Document Download Links

### Description
Get information about linked / related documents to a specific document.

### Method
GET

### Endpoint
/document/{document_id}/download-links
```

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

### Partners - Request User Approval

Source: https://greeninvoice.docs.apiary.io

Requests approval for a user to become a partner.

```APIDOC
## Partners - Request User Approval

### Description
Initiates a request for a user to approve a partnership connection.

### Method
POST

### Endpoint
`/partners/request-approval`

### Parameters
#### Request Body
(Details not provided in the source text)

### Request Example
(Details not provided in the source text)

### Response
(Details not provided in the source text)
```

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

### Get Supported Business Categories

Source: https://greeninvoice.docs.apiary.io/reference/payments/get-payment-form

Get the supported business categories and their sub categories. The locale parameter is required.

```APIDOC
## Get Supported Business Categories

### Description
Get the supported business categories and their sub categories.

### Endpoint
https://cache.greeninvoice.co.il/businesses/v1/occupations?locale=he_IL

### Query Parameters
- **locale** (string) - Required - The locale for the categories (e.g., he_IL).
```

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

### Clients - Interacting with Existing Clients

Source: https://greeninvoice.docs.apiary.io

Provides methods for interacting with existing client records.

```APIDOC
## Clients - Interacting with Existing Clients

### Description
This section covers various operations for managing existing clients, such as updating or retrieving their details.

### Method
(Details not provided in the source text)

### Endpoint
(Details not provided in the source text)

### Parameters
(Details not provided in the source text)

### Request Example
(Details not provided in the source text)

### Response
(Details not provided in the source text)
```

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

### Get Payment Form

Source: https://greeninvoice.docs.apiary.io/reference/payments/get-payment-form

This endpoint allows you to retrieve a payment form for a specific document. You need to provide the document ID to get the payment form URL.

```APIDOC
## GET /api/v1/payments/form/{documentId}

### Description
Retrieves the payment form for a given document.

### Method
GET

### Endpoint
`/api/v1/payments/form/{documentId}`

### Parameters
#### Path Parameters
- **documentId** (string) - Required - The ID of the document for which to retrieve the payment form.

### Response
#### Success Response (200)
- **paymentFormUrl** (string) - The URL of the payment form.

#### Response Example
{
  "paymentFormUrl": "https://example.com/payment/form/12345"
}
```

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

### Get Supported Currencies

Source: https://greeninvoice.docs.apiary.io/reference/payments/get-payment-form

Get the supported currencies. Retrieves the latest currency and the previous day's exchange rates by specified base currency. The base parameter is required.

```APIDOC
## Get Supported Currencies

### Description
Get the supported currencies. Retrieves the latest currency and the previous day's exchange rates by specified base currency.

### Endpoint
https://cache.greeninvoice.co.il/currency-exchange/v1/latest?base={base}

### Query Parameters
- **base** (string) - Required - The base currency for exchange rates (e.g., USD).
```

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

### Get Payment Form

Source: https://greeninvoice.docs.apiary.io/reference/payments/get-payment-form

Get a payment form. This form can be used in an IFrame in your website to provide payment request abilities for invoices within websites. After the payment was made - the system will automatically generate a document for you.

```APIDOC
## Get Payment Form

### Description
Get a payment form. This form can be used in an IFrame in your website to provide payment request abilities for invoices within websites. After the payment was made - the system will automatically generate a document for you.

### Method
GET

### Endpoint
/payments/form

### Parameters
#### Query Parameters
- **invoice_id** (string) - Required - The ID of the invoice for which the payment form is requested.

### Response
#### Success Response (200)
- **payment_form_url** (string) - The URL of the payment form that can be embedded in an iframe.

#### Response Example
{
  "payment_form_url": "https://your-payment-gateway.com/form?id=invoice123"
}
```

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

### Download Preview Document

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier

Use this HTML snippet to create a download link for a PDF preview document. Replace {base64string} with the actual Base64 encoded file content.

```html
<a download="preview-document.pdf" href="data:application/pdf;base64,{base64string}">Download Preview</a>

```

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

### Get Supported Currencies

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/create-api

Fetches supported currencies, including the latest and previous day's exchange rates based on a specified base currency. The `base` parameter is required.

```APIDOC
## Get Supported Currencies

### Description
Get the supported currencies. Retrieves the latest currency and the preivious day exchange rates by specified base currency.

### Endpoint
https://cache.greeninvoice.co.il/currency-exchange/v1/latest?base={base}

### Parameters
#### Query Parameters
- **base** (string) - Required - The base currency for exchange rates, e.g., USD.
```

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

### Get Expense

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Retrieves information about an existing expense.

```APIDOC
## Get Expense

### Description
Retrieves information about an existing expense.

### Method
GET

### Endpoint
/expense/{expense_id}
```

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

### Get Document

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Retrieves information about an existing document.

```APIDOC
## Get Document

### Description
Retrieves information about an existing document.

### Method
GET

### Endpoint
/document/{document_id}
```

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

### Create Expense Draft via File

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/create-api

Add an expense draft to the current business by uploading a file. This action creates an expense draft that may require further approval to become an actual expense.

```APIDOC
## Create Expense Draft via File

### Description
Add an expense draft to the current business by uploading a file. This action creates an expense draft that may require further approval to become an actual expense.

### Method
POST

### Endpoint
/expenses/drafts

### Parameters
#### Request Body
- **file** (File) - Required - The file to upload.
- **fields** (object) - Required - All fields received from the `GET` File Upload URL request.
```

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

### Tools

Source: https://greeninvoice.docs.apiary.io/reference/payments/create-api

Utility endpoints for retrieving lists of supported categories, countries, cities, and currencies.

```APIDOC
## Get Supported Business Categories

### Description
Retrieves a list of business categories supported by the system.

### Method
GET

### Endpoint
`/tools/categories/business`

### Response
#### Success Response (200)
- A list of supported business category objects.

#### Response Example
```json
[
  {"id": 1, "name": "Technology"},
  {"id": 2, "name": "Retail"}
]
```

## Get Supported Countries

### Description
Retrieves a list of countries supported by the system.

### Method
GET

### Endpoint
`/tools/countries`

### Response
#### Success Response (200)
- A list of supported country objects.

#### Response Example
```json
[
  {"code": "US", "name": "United States"},
  {"code": "IL", "name": "Israel"}
]
```

## Get Supported Cities

### Description
Retrieves a list of cities supported by the system.

### Method
GET

### Endpoint
`/tools/cities`

### Parameters
#### Query Parameters
- **countryCode** (string) - Required - Filter cities by country code.

### Response
#### Success Response (200)
- A list of supported city objects.

#### Response Example
```json
[
  {"id": 1, "name": "New York", "countryCode": "US"},
  {"id": 2, "name": "Tel Aviv", "countryCode": "IL"}
]
```

## Get Supported Currencies

### Description
Retrieves a list of currencies supported by the system.

### Method
GET

### Endpoint
`/tools/currencies`

### Response
#### Success Response (200)
- A list of supported currency objects.

#### Response Example
```json
[
  {"code": "USD", "name": "US Dollar"},
  {"code": "ILS", "name": "Israeli New Shekel"}
]
```
```

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

### Documents - Get Document Templates

Source: https://greeninvoice.docs.apiary.io

Retrieves available document templates.

```APIDOC
## Documents - Get Document Templates

### Description
Returns a list of all available templates that can be used for creating documents.

### Method
GET

### Endpoint
`/documents/templates`

### Parameters
(Details not provided in the source text)
```

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

### Get File Upload URL (Sandbox)

Source: https://greeninvoice.docs.apiary.io

Requests a pre-signed URL for file uploads in the sandbox environment. This is the first step in a two-step process for secure file handling.

```http
GET https://api.sandbox.d.greeninvoice.co.il/file-upload/v1/url

```

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

### Get Supported Currencies

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier

Fetches supported currencies along with the latest and previous day's exchange rates based on a specified base currency. The `base` parameter is required.

```APIDOC
## Get Supported Currencies

### Description
Get the supported currencies. Retrieves the latest currency and the preivious day exchange rates by specified base currency.

### Endpoint
`https://cache.greeninvoice.co.il/currency-exchange/v1/latest?base={base}`

### Parameters
#### Query Parameters
- **base** (string) - Required - The base currency for exchange rates (e.g., `USD`).
```

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

### Get Accounting Classifications

Source: https://greeninvoice.docs.apiary.io/reference/partners/request-user-approval/create-api

Shows the accounting classifications that were defined for this business.

```APIDOC
## Get Accounting Classifications

### Description
Shows the accounting classifications that were defined for this business. The classification can be specified in the accountingClassification field when adding or updating an expense.

### Method
GET

### Endpoint
/accounting-classifications
```

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

### Get File Upload URL (Production)

Source: https://greeninvoice.docs.apiary.io

Requests a pre-signed URL for file uploads in the production environment. This is the first step in a two-step process for secure file handling.

```http
GET https://apigw.greeninvoice.co.il/file-upload/v1/url

```

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

### Partners - Get Connected User

Source: https://greeninvoice.docs.apiary.io

Retrieves information about a connected partner user.

```APIDOC
## Partners - Get Connected User

### Description
Fetches details about a specific user who is connected as a partner.

### Method
GET

### Endpoint
`/partners/users/{userId}`

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the connected partner user.
```

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

### Create Supplier

Source: https://greeninvoice.docs.apiary.io/reference/suppliers/interacting-with-existing-supplier/create-api

This endpoint allows you to create a new supplier in the system. You need to provide the supplier's details to add them.

```APIDOC
## POST /suppliers

### Description
Creates a new supplier in the system.

### Method
POST

### Endpoint
/suppliers

### Parameters
#### Request Body
- **name** (string) - Required - The name of the supplier.
- **contact_person** (string) - Optional - The name of the contact person at the supplier.
- **email** (string) - Optional - The email address of the supplier.
- **phone** (string) - Optional - The phone number of the supplier.
- **address** (string) - Optional - The address of the supplier.

### Request Example
{
  "name": "Example Supplier",
  "contact_person": "John Doe",
  "email": "john.doe@example.com",
  "phone": "123-456-7890",
  "address": "123 Main St, Anytown, USA"
}

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier of the created supplier.
- **name** (string) - The name of the supplier.
- **contact_person** (string) - The name of the contact person at the supplier.
- **email** (string) - The email address of the supplier.
- **phone** (string) - The phone number of the supplier.
- **address** (string) - The address of the supplier.

#### Response Example
{
  "id": "supplier-12345",
  "name": "Example Supplier",
  "contact_person": "John Doe",
  "email": "john.doe@example.com",
  "phone": "123-456-7890",
  "address": "123 Main St, Anytown, USA"
}
```

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

### Expenses - Get Accounting Classifications

Source: https://greeninvoice.docs.apiary.io

Retrieves a list of accounting classifications for expenses.

```APIDOC
## Expenses - Get Accounting Classifications

### Description
Returns a list of accounting categories that can be applied to expenses.

### Method
GET

### Endpoint
`/expenses/accounting-classifications`

### Parameters
(Details not provided in the source text)
```

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

### Documents - Get Document Types

Source: https://greeninvoice.docs.apiary.io

Retrieves a list of all supported document types.

```APIDOC
## Documents - Get Document Types

### Description
Returns a list of all document types supported by the system.

### Method
GET

### Endpoint
`/documents/types`

### Parameters
(Details not provided in the source text)
```
Tokens:
Raw