# Welcome

All you need to know about the Younium Developer Portal!

Access our **documentation**, get the latest on **API updates and webhooks**, and reach out for **support**. **Developer-Friendly!** Younium offers the essential tools to seamlessly integrate your solutions with the Younium platform.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><strong>Get started</strong></td><td>Properly setup API token and credentials.</td><td></td><td><a href="/pages/RsByLDdf4Vy2DBOxL62z">/pages/RsByLDdf4Vy2DBOxL62z</a></td><td><a href="/files/4f1r9IafNldEr8jbGwZy">/files/4f1r9IafNldEr8jbGwZy</a></td></tr><tr><td><strong>API</strong></td><td>Discover our extensive APIs and how to use them.</td><td></td><td><a href="/pages/uSr2hsiAgmWEmBNLVZET">/pages/uSr2hsiAgmWEmBNLVZET</a></td><td><a href="/files/QffdJ6okRRJdVFmSa8RI">/files/QffdJ6okRRJdVFmSa8RI</a></td></tr><tr><td><strong>Webhooks</strong></td><td>Build integrations with API's and Saas services.</td><td></td><td><a href="/pages/nHMAfUsXazMxKWDXMZg9">/pages/nHMAfUsXazMxKWDXMZg9</a></td><td><a href="/files/w1KL5f4sISrDVNE2e41K">/files/w1KL5f4sISrDVNE2e41K</a></td></tr><tr><td><strong>Documentation</strong></td><td>Guides and documentations</td><td></td><td><a href="/pages/YDps8hkl9hNDOOT9Ouan">/pages/YDps8hkl9hNDOOT9Ouan</a></td><td><a href="/files/C862bYnEWsqpcpQaTgwd">/files/C862bYnEWsqpcpQaTgwd</a></td></tr></tbody></table>


# Get started

Discover how to authenticate to Youniums APIs

All requests to the Younium API must be authenticated using a **JWT access token**. This guide explains how to generate the required credentials, acquire a JWT token, and use it to make authenticated API calls.

## Step 1: Generate an API Token and Client Credentials

<br>

1. Open the **User Profile Menu** in the top-right corner (click your user name).
2. Go to **Privacy & Security**.\ <br>

   <div align="left"><figure><img src="/files/FW4GWN9YaI3t233k9yJo" alt=""><figcaption></figcaption></figure></div>

   \ <br>
3. Select **Personal Tokens** in the left-hand panel.
4. Click **Generate Token**.\
   \ <br>

   <div align="left"><figure><img src="/files/fiKbi78Rl3A2nHk8EoRw" alt=""><figcaption></figcaption></figure></div>

   <br>
5. Enter a descriptive name for the token and click **Create**.
6. The **Client ID** and **Secret Key** will now be displayed.
   * ⚠️ **Important**: Copy these values immediately. They will not be visible again.
   * You will use them to generate the JWT token.\ <br>

<div align="left"><img src="https://younium.gitbook.io/~gitbook/image?url=https%3A%2F%2F940708998-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FMV73ftGLs1NaypiZYzZB%252Fuploads%252FfXHKaqA8o7bEJ3l5Uk5u%252FCredentials%2520%281%29.png%3Falt%3Dmedia%26token%3Dc0361a08-2e62-4130-926a-81c2cbeabc61&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=a51723c7&#x26;sv=1" alt=""></div>

## Step 2: Generate a JWT Token <a href="#generating-a-jwt-token" id="generating-a-jwt-token"></a>

Make a `POST` request to the `/auth/v2/token` endpoint with your client credentials.\
This guide uses the latest auth endpoint version (v2). Guide to v1 can be found [here](/get-started-1).

#### Endpoints

* Production: `https://api.younium.com/auth/v2/token`
* Sandbox: `https://api.sandbox.younium.com/auth/v2/token`
* US Production: `https://api.us.younium.com/auth/v2/token`
* US Sandbox: `https://api.sandbox.us.younium.com/auth/v2/token`

#### Request Header

```http
Content-Type: application/json
```

#### Request Body

```json
{ 
  "clientId": "<Client ID>", 
  "secret": "<Secret Key>" 
}
```

#### Successful Response

```json
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cC...",
  "refresh_token": "4baf4774-5ef9-4983-a8d8-f4fdae7f7000",
  "expires_in": 86400,
  "expires": "Thu, 27 Sep 2025 11:12:01 GMT" 
}
```

* The **access token** is valid for **24 hours**.
* Once expired, you must request a new token.

#### Error Response

In case of authentication failure , you may receive an error response:

```json
{
    errors: ["<Error message>"]
}
```

* `400` or `401`: Invalid credentials or other authentication issues.

## Step 3: Making Authenticated API Calls

Include the access token in the request headers:

```http
Authorization: Bearer <JWT Token>
Content-Type: application/json
api-version: <version>   // optional but recommended
legal-entity: <Entity ID or Name>
```

#### Notes

* **`legal-entity`**:
  * Required if your tenant has multiple legal entities.
  * If invalid, the request returns `403 Forbidden`.
* **`api-version`**:
  * Default is **2.1**.
  * Explicitly setting the version is recommended.

***

### Common Authentication Errors

* **401 Unauthorized**
  * Token missing, expired, or invalid.
* **403 Forbidden**
  * The request is authenticated, but access is blocked. Possible reasons:
    * Invalid or missing `legal-entity` header.
    * Insufficient user permissions.
    * Restricted access to integrations or services.


# Get started (using auth v1)

Discover how to authenticate to Youniums APIs

All requests to the Younium API must be authenticated using a **JWT access token**. This guide explains how to generate the required credentials, acquire a JWT token, and use it to make authenticated API calls.

### Step 1: Generate an API Token and Client Credentials

1. Open the **User Profile Menu** in the top-right corner (click your user name).
2. Go to **Privacy & Security**.\\

   <div align="left"><figure><img src="/files/FW4GWN9YaI3t233k9yJo" alt="" width="292"><figcaption></figcaption></figure></div>
3. Select **Personal Tokens** in the left-hand panel.
4. Click **Generate Token**.\\

   <div align="left"><figure><img src="/files/fiKbi78Rl3A2nHk8EoRw" alt="" width="375"><figcaption></figcaption></figure></div>
5. Enter a descriptive name for the token and click **Create**.
6. The **Client ID** and **Secret Key** will now be displayed and will be used to generate the JWT token.

<div align="left"><img src="https://younium.gitbook.io/~gitbook/image?url=https%3A%2F%2F940708998-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FMV73ftGLs1NaypiZYzZB%252Fuploads%252FfXHKaqA8o7bEJ3l5Uk5u%252FCredentials%2520%281%29.png%3Falt%3Dmedia%26token%3Dc0361a08-2e62-4130-926a-81c2cbeabc61&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=a51723c7&#x26;sv=1" alt="" width="375"></div>

### Step 2: Generate a JWT Token <a href="#generating-a-jwt-token" id="generating-a-jwt-token"></a>

Make a `POST` request to the `/auth/token` endpoint with your client credentials.

#### Endpoints

* Production: `https://api.younium.com/auth/token`
* Sandbox: `https://api.sandbox.younium.com/auth/token`
* US Production: `https://api.us.younium.com/auth/token`
* US Sandbox: `https://api.us.sandbox.younium.com/auth/token`

#### Request Header

```http
Content-Type: application/json
```

#### Request Body

```json
{ 
  "clientId": "<Client Id>", 
  "secret": "<Secret Key>" 
}
```

#### Successful Response

```json
{
  "expires": "Thu, 21 Sep 2025 11:12:01 GMT",
  "expiresIn": 86400,
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cC...",
  "refreshToken": "4baf4774-5ef9-4983-a8d8-f4fdae7f7000"
}
```

* The **access token** is valid for **24 hours**.
* Once expired, you must request a new token.

#### Error Response

If authentication fails, you may receivean error response:

```json
{
    errors: ["<Error message>"]
}
```

* `400` or `401`: Invalid credentials or other authentication issues.

### Step 3: Making Authenticated API Calls

Request headers:

```http
Authorization: Bearer <JWT Token>
Content-Type: application/json
legal-entity: <Legal Entity Id or Name>
```

**`legal-entity`** is required if your tenant has multiple legal entities.

### Common Authentication Errors

* **401 Unauthorized**
  * Token is missing, has expired, or is invalid.
* **403 Forbidden**
  * The request is authenticated, but access is blocked. Possible reasons include :
    * Invalid or missing **`legal-entity`** header.
    * Insufficient user permissions.
    * Restricted access to integrations or services.


# API:s


# API 2.0


# Accounts

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/OnlinePaymentDetails/{id}" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/OnlinePaymentDetails/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/OnlinePaymentDetails/{id}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/{id}/RequestPaymentDetails/GoCardless" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/{accountId}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/{id}/Subscriptions" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/{id}/Invoices" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/{id}/SalesOrders" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Accounts/{id}/Summary" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Bookings

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Bookings/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Bookings/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Bookings" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Chartofaccounts

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/ChartOfAccounts" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/ChartOfAccounts/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Countries

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Countries" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Countries/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Currency

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Currency" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Currency" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Currency/BaseCurrency" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Currency/{id}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Currency/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Documenttemplate

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/DocumentTemplate" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/DocumentTemplate/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Exchangerate

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/ExchangeRate" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/ExchangeRate" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/ExchangeRate/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Invoices

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/invoiceDownloadAttachment/{invoiceId}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/generateAttachmentURL/{invoiceId}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/{id}/Attachments" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/PostedInvoiceDocumentAttachments" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/DownloadAttachment/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/paid" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/onAccountInvoice" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/{id}/cancel" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/{id}/credit" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/{id}/post" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/orders/{id}" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/{id}/ProcessStripePayment" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Invoices/{id}/OnlinePaymentLogs" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Journals

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Journals/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Journals/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Journals" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Measurements

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Measurements" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Measurements" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Measurements/import" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Measurements/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Orders

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Orders/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Orders/Charges/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Orders/Charges/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Orders/Charges/{id}/InvoicedTo" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Paymentterms

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/PaymentTerms" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/PaymentTerms" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/PaymentTerms/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Products

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Products" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Products" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Products/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Products/{id}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Products/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Products/charges/{chargeId}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Products/chargePlans/{id}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Products/charges/{id}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Quotes

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Quotes/convertToOrder" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Quotes" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Quotes/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Salesorders

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SalesOrders" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SalesOrders" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SalesOrders/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SalesOrders/{id}/version" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SalesOrders/{orderNumber}/versions" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SalesOrders/{orderNumber}/versions/{version}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SalesOrders/activate/{id}" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Simpleproducts

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SimpleProducts" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/SimpleProducts/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Subscriptions

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{id}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{orderNumber}/versions" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{id}/version" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{orderNumber}/versions/{version}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{id}/change" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{id}/RenewAndChange" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/cancel/{id}" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/renew/{id}" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/revert/{id}" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/activate/{id}" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{id}/milestones" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/milestones/set/{id}" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Subscriptions/{id}/OrderDiscounts" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Taxtemplates

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/TaxTemplates" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/TaxTemplates/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Unitofmeasurements

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/UnitOfMeasurements" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/UnitOfMeasurements/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Usage

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Usage" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Usage" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Usage/{id}" method="patch" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Usage/{id}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Usage/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Usage/import" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# Webhooks

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Webhooks" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Webhooks" method="post" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Webhooks/{id}" method="get" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/G0qvxFx3HRb6U2lLyNS6" path="/Webhooks/{id}" method="delete" expanded="true" %}
[younium-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-9bf062ec1d7effa882067890fa812d659954ef8e%2Fyounium-prod.json?alt=media)
{% endopenapi %}

***


# API data\_export


# Subscriptionproductcharges

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscription-product-charges/{id}/metrics" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscription-product-charges" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscription-product-charges/{id}/details" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

***


# Subscriptionproducts

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscription-products/{id}/metrics" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscription-products" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscription-products/{id}/subscription-product-charges" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

***


# Subscriptions

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscriptions/{id}" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscriptions/{orderNumber}" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscriptions/{id}/metrics" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscriptions" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscriptions/{id}/subscription-products" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscriptions/{id}/milestones" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/aPYpe4PcFzp3yRZUPLsE" path="/subscriptions/{id}/discounts" method="get" expanded="true" %}
[younium\_dataExport-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-31190da0c8734f6e1aa9bb88c7b8c5d2a9bbd934%2Fyounium_dataExport-prod.json?alt=media)
{% endopenapi %}

***


# API 2.1


# Accounts

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/OnlinePaymentDetails/{id}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/OnlinePaymentDetails/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/OnlinePaymentDetails/{id}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/{id}/RequestPaymentDetails/GoCardless" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/{accountId}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/{id}/Subscriptions" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/{id}/Invoices" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/{id}/SalesOrders" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Accounts/{id}/Summary" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Bookings

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Bookings/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Bookings/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Bookings" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Chartofaccounts

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/ChartOfAccounts/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/ChartOfAccounts" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Countries

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Countries" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Countries/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Currency

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Currency/BaseCurrency" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Currency" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Currency" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Currency/{id}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Currency/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Customfieldconfigurations

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/CustomFieldConfigurations" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/CustomFieldConfigurations" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/CustomFieldConfigurations/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/CustomFieldConfigurations/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/CustomFieldConfigurations/{entity}/{key}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/CustomFieldConfigurations/{entity}/{key}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Documenttemplate

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/DocumentTemplate/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/DocumentTemplate" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Exchangerate

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/ExchangeRate" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/ExchangeRate" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/ExchangeRate/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Invoicebatches

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatches/{batchIdentifier}/BatchLog" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatches/BatchJobStatus/{batchReference}/Generated" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatches/BatchJobStatus/{batchReference}/Posted" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatches" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatches" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatches/{id}/Post" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatches/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Invoicebatchgroups

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatchGroups" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/InvoiceBatchGroups/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Invoices

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}/RelatedInvoices" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/invoiceLines/ChargeType/{type}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/Usage/{usageId}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/invoiceLines/Usage/{usageId}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/invoiceDownloadAttachment/{invoiceId}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/generateAttachmentURL/{invoiceId}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}/Attachments" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/PostedInvoiceDocumentAttachments" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/DownloadAttachment/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/paid" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/onAccountInvoice" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}/cancel" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}/credit" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}/post" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/orders/{id}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}/ProcessStripePayment" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Invoices/{id}/OnlinePaymentLogs" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Journals

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/JournalDetails" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/{id}/JournalSummary" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/AccountingTransactions/{year}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/AccountingTransactions/{year}/FiscalPeriod/{period}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/AccountingTransactions/{year}/FiscalQuarter/{quarter}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/AccountingTransactions/{year}/FinancialAccounts/{financialAccount}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Journals/{id}/AccountingTransactions" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Measurements

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Measurements" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Measurements" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Measurements/import" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Measurements/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Metrics

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Metrics/CalculateMetrics/Order" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Metrics/CalculateMetrics/Charge" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Orders

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Orders/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Orders/Charges/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Orders/Charges/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Orders/{id}/charges" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Orders/Products/{id}/charges" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Orders/Charges/{id}/InvoicedTo" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Payments

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Payments" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Payments" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Payments/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Payments/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Payments/CreateAndPost" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Paymentterms

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/PaymentTerms" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/PaymentTerms" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/PaymentTerms/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Products

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/FromChargePlan/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/FromCharge/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/productFeatures" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/{id}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/charges/{chargeId}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/chargePlans/{id}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Products/charges/{id}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Quotes

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Quotes/convertToOrder" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Quotes" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Quotes/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Reports

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Reports/{id}/Data" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Reports" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Reports/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Revenueschedule

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/RevenueSchedule/Charge/{chargeNumber}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/RevenueSchedule/InvoiceLine/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Salesorders

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SalesOrders" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SalesOrders" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SalesOrders/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SalesOrders/{id}/version" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SalesOrders/{orderNumber}/versions" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SalesOrders/{orderNumber}/versions/{version}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SalesOrders/activate/{id}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Simpleproducts

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SimpleProducts" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/SimpleProducts/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Subscriptions

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{id}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{orderNumber}/versions" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{id}/version" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{orderNumber}/versions/{version}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{id}/change" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{id}/RenewAndChange" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/cancel/{id}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/renew/{id}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/revert/{id}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/activate/{id}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{id}/milestones" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/milestones/set/{id}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Subscriptions/{id}/OrderDiscounts" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Taxtemplates

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/TaxTemplates" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/TaxTemplates/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Unitofmeasurements

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/UnitOfMeasurements" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/UnitOfMeasurements/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Usage

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Usage" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Usage" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Usage/{id}" method="patch" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Usage/{id}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Usage/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Usage/import" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Users

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Users" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Users/ByRole/{roleId}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Users/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Users/roles" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Users/roles/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Users/{userId}/roles/{role}" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Users/{userId}/roles/{role}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Webhooks

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Webhooks" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Webhooks" method="post" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Webhooks/{id}" method="get" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

{% openapi src="/files/fX5FMpSfTSyb2hsvmuxC" path="/Webhooks/{id}" method="delete" expanded="true" %}
[youniumv2-prod.json](https://940708998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMV73ftGLs1NaypiZYzZB%2Fuploads%2Fgit-blob-d558bf52769e4a8cb5b48f46f6420256fde8a2c9%2Fyouniumv2-prod.json?alt=media)
{% endopenapi %}

***


# Documentation

The technical documentation you need to get going and a growing library of best-practices and patterns.

[**Developer resources**](/documentation/developer-resources)

[**Product guide**](/documentation/product-guide)

[**Webhooks**](/documentation/webhooks)

[**Invoice operations**](/documentation/invoice-operations)

[**Idempotent requests**](/documentation/idempotent-requests)


# Environments

Details about the Younium environments

### Environment URLs <a href="#o4cp8" id="o4cp8"></a>

Sandbox: [https://api.sandbox.younium.com](https://developer.younium.com/developer-resources)

Production: [https://api.younium.com](https://developer.younium.com/developer-resources)

US-Sandbox. [api.sandbox.us.younium.com](https://developer.younium.com/developer-resources)

US-Production: [api.us.younium.com](https://developer.younium.com/developer-resources)


# Developer resources

API summaries

## API v2

API V2 is a RESTful API designed for transactional integrations and automation, well suited for CRUD‑style integrations where clients need to create, read, update or delete data in Younium. Common use cases involve managing accounts, products, subscription lifecycles and invoice flows.

[API references](/api-s/api-2.1)

[Resources](/documentation/developer-resources/developer-resources)

## Data Export API

Designed for exporting and syncing Younium data into data warehouses, BI platforms, and reporting systems. It is optimized for high-volume data retrieval, fetching records entity by entity and ensures speed and reliability.

[API references](/api-s/api-data_export)

[Resources](/documentation/developer-resources/api-v3-name)

## **Insights API**

**Insights API** provides external access to the structured data available in the Insights view of the Younium application. It exposes these data entities through a standard OData v4 interface, making it possible to query and filter the information using familiar OData syntax.

[Resources](/documentation/developer-resources/insights-api)


# API V2

Details and resources for using the API v2.1

#### NULL values <a href="#zlqpf" id="zlqpf"></a>

Each endpoint has a schema with fields that will populate the response if there is a value. However, when the response data is created, there may be fields that have no value, which are null. These Fields are excluded from the JSON response. In other words, only fields containing values are present in the response.

### No records found <a href="#jjk1f" id="jjk1f"></a>

If no records are found for a GET request, a 400 Bad Request response is returned.

### Versioning

To specify the version in your API request header:

```
api-version: 2.1
```

Available versions

* [v2.1](https://github.com/Younium/infra-dev-portal-gitbook/blob/production/docs/api-s/api-2.1) - The official and recommended version to use. Default if no version header is provided.
* [v2.0](https://github.com/Younium/infra-dev-portal-gitbook/blob/production/docs/APIs/api-2.0)

### Pagination

Pagination can be controlled with the query parameters `pageNumber` and `pageSize` (number of records on each page). There's a current limit of 100 records per page.

Example:

```
https://api.sandbox.younium.com/Subscriptions?pageSize=25&pageNumber=2
```

#### OrderBy <a href="#uikdr" id="uikdr"></a>

The request can be ordered by ascending or descending, and by one or more field names.

Example of ordering a GET subscriptions request by descending order number:

```
https://api.sandbox.younium.com/Subscriptions?orderby=orderNumber desc
```

Example of the same request but ordering first by ascending effective start date, and then by descending order number:

```
https://api.sandbox.younium.com/Subscriptions?orderby=effectiveStartDate asc, orderNumber desc
```

#### Filter <a href="#nktqd" id="nktqd"></a>

A filter can be added to a request, returning only records that pass certain tests.

```
?filter=[fieldName] [operator] [value]
```

The following operators can be used to test records.

Equality operators:

* `eq:` ( == ) Test if a field is equal to a value.
* `ne:` ( != ) Test if a field is not equal to a value.

Range operators:

* `gt`: ( > ) Test if a field is greater than a value.
* `lt:` ( < ) Test if a field is less than a value.
* `ge:` ( >= ) Test if a field is greater than or equal to a value.
* `le:` ( <= ) Test if a field is less than or equal to a value.

Logical operators

* `and`: Test if two statements are true.
* `or:` Test if one of the two statements is true.

String value

Single quotation marks ( `'string'` ) must be used when passing a string as a constant

Example:

```
https://api.sandbox.younium.com/Subscriptions?filter=status eq 'Active'
```

Datetime and guid values

Fields that are of type guids/uuid or datetime will need to be specified by type in the following way. Important to note the lower casing on the type.

Example for date:

```
https://api.sandbox.younium.com/Subscriptions?filter=modified gt datetime'2023-04-01'
```

Example for guid/uuid:

```
https://api.sandbox.younium.com/Accounts?filter=invoiceBatchGroupId eq guid'f68a9sa3-ff43-4f95-44b4-08f84be1dda4'
```

Nested objects

It is possible to filter on nested fields by using {`fieldName}/{nested fieldName}`. Important to note is that this will not work for a calculated field, If the field name is null, and for filtering lists. Custom fields cannot be filtered this way either — instead use the dedicated custom-field functions described below.

Example of only returning subscriptions with a CMRR amount between 100 and 1000:

```
https://api.sandbox.younium.com/Subscriptions?filter=cmrr/amount ge 100 and cmrr/amount le 1000
```

Multiple conditions

Logical operators can be used to chain multiple conditions in a query, like in the example above. Parentheses "( )" are used to nest conditions to ensure the logic is applied in the correct order.

Example:

```
https://api.sandbox.younium.com/Accounts?filter=inactive eq false and (defaultDeliveryAddress/country eq 'Norway' or defaultDeliveryAddress/country eq 'Sweden') 
```

String Functions

For string values it is possible to use some extended functionality to filter on strings that start with, end with, or contain (substringof) a string segment. These functions replace the condition pattern \[fieldName] \[operator] \[value]. Important to use lower casing on the function names.

Examples:

```
https://api.sandbox.younium.com/ChartOfAccounts?filter=startswith(code, '3')

https://api.sandbox.younium.com/Accounts?filter=endswith(invoiceEmailAddress, 'company.com')

//Filter for products include 'service' in its name. Note the value is the first argument and the field name the second 
https://api.sandbox.younium.com/Products??filter=substringof('service', name)
```

Custom fields

Custom fields are not regular columns, so they cannot be filtered with the standard \[fieldName] \[operator] \[value] pattern or the nested-object syntax above. Instead, two dedicated functions are available on endpoints whose records support custom fields. As with the standard pattern, both the field name and the value must be passed as quoted string literals.

* `customFieldEq('fieldName', 'value')` — returns records where the custom field equals the given value.
* `customFieldExist('fieldName')` — returns records where the custom field is set to a non-empty value.

Examples:

```
https://api.sandbox.younium.com/Subscriptions?filter=customFieldEq('region', 'EU')

https://api.sandbox.younium.com/Subscriptions?filter=customFieldExist('region')
```

Custom-field functions can only be combined with other conditions using `and`; they cannot be placed inside an `or` or be negated. They can be freely combined with regular filters:

```
https://api.sandbox.younium.com/Subscriptions?filter=status eq 'Active' and customFieldEq('region', 'EU')
```

When several custom-field conditions are supplied, each is evaluated independently, so every condition must be satisfied for a record to be returned.

#### Modified after and modified before <a href="#id-5cfru" id="id-5cfru"></a>

As the filter is only applied to the top level of the entity structure, querying entities that have been modified before or after a specific date may not always be accurate. Eg a subscription may have a charge or a custom field which have been modified after the subscription. In these cases, the `modifiedAfter` and `modifiedBefore` parameters can be used as they apply the modified filter on all sub-levels of the entity. Each filter is applied as a `or` statement returning any entity where a modified match is found, returning only results where at least one of the entity or sub entities has been modified within the specified date and time.

Which sub-entities that are affected by these filters will be specified in the parameter description on the API reference. Worth noting that even though the filter is applied on all specified objects, some entities, like custom fields and price details, don’t have the modified field mapped.

Examples:

```
https://api.sandbox.younium.com/Subscriptions?modifiedAfter=2023-11-01

https://api.sandbox.younium.com/Subscriptions?modifiedBefore=2023-01-01

https://api.sandbox.younium.com/Subscriptions?modifiedAfter=2023-06-01&modifiedBefore=2023-12-01
```

### LookupKey Identifier <a href="#vq4um" id="vq4um"></a>

In the request body of POST and PATCH there is sometimes a need to identify or reference related entities, eg. when creating a Subscription, we want to define what Account it belongs to or what Currency to use. Fields like this are of the type `LookupKey`and can accept both a `uuid/Guid, a String and a key-value-pair-object`.

Examples of lookupKey-value as a string to set the field account:

```
{
  "account": "A-000001", //using a string to identify by accountNumber
//or
  "account": "8621d3c5-473e-41f1-f394-08d9dfc48d99" //identifying by uuid/guid
  "description": "New Subscription",
  "effectiveStartDate": "2022-07-15", 
  ...
}
```

By setting the field with `key-value-pair-object`and in the`key`Specifying what property to identify against makes it possible to match with a wider range of properties.\
The following example is using key-value-pair matching with the name of the Account:

```
{
  "account": {
    "key": "name",
    "value": "ExampleAccount"
  }
  "description": "New Subscription",
  "effectiveStartDate": "2022-07-15", 
  ...
}
```

The LookupKey will try to match the values that are set against the field entity. If no matches are found or if there are multiple matches found, a Bad Request will be returned.

If a custom field is used as a key, it is simply specified by its key property.

```
{
  "account": {
    "key": "customFieldKey",
    "value": "custom value 1"
  }
  ...
}
```


# Data export API

Details and resources for using the the data export API

### Fetching Nested Records

V3 is designed for retrieving larger datasets but limits the nested entities in the response. Related entities with a 1-to-1 relationship are generally included with basic details, while 1-to-many relationships are excluded and require separate fetches.

**Nested Query URLs**\
To obtain related entities, use the nested URL paths in the response. For example, a subscription response provides paths to fetch metrics, products, discounts and milestones for the subscription in separate requests. This is useful when records related to a specific entity are needed, such as:

```json
{
    "id": "af2d33b1-a614-556a-9cd3-08dd4760a5c7",
    "created": "2025-02-08T17:00:14",
    ...
    "products": "/subscriptions/af2d33b1-a614-556a-9cd3-08dd4760a5c7/subscription-products",
    "discounts": "/subscriptions/af2d33b1-a614-556a-9cd3-08dd4760a5c7/discounts",
    "milestones": "/subscriptions/af2d33b1-a614-556a-9cd3-08dd4760a5c7/milestones",
    "metrics": "/subscriptions/af2d33b1-a614-556a-9cd3-08dd4760a5c7/metrics"
}
```

**Fetching Entities in Separate Queries**\
When syncing data to a data warehouse or BI systems, it can be more effective to fetch data in bulk, entity by entity. For example, use the /subscription endpoint to fetch all subscriptions, then a separate call to /Subscription-product-charges to fetch subscription charges. The relationship in this case is defined by the `orderId` In the subscription-charge response, a reference to the subscription's `id`.

### Pagination

Pagination can be managed using the `pageNumber` and `pageSize` query parameters.

* Some endpoints may have a maximum `pageSize` limit of 5000 records per request.
* If not specified, the default `pageSize` is 100.

```
https://api.younium.com/v3/Subscriptions?pageSize=5000&pageNumber=2
```

When retrieving multiple records, the response includes an `items` property with the records and a `nextPage` property indicating if more records are available. If the `nextPage` is absent, there are no more records to fetch. If no records exist, an empty list of items will be returned.

```json
{
    "items": [ {...} ],
    "nextPage": "/subscriptions?pageNumber=2&pagesize=200"
}
```

### Filters

#### Filter Application in API Queries

Filters are applied as query parameters. The API reference documentation lists the available filters for each endpoint.

#### **Modified After and Before Filters**

Some endpoints support `modifiedAfter` and `modifiedBefore` filters to fetch records from a specific time span. The `modifiedAfter` filter defaults to the previous month if not specified.

### NULL values <a href="#zlqpf" id="zlqpf"></a>

In the response schema, only fields with values are included in the JSON response body. Fields with null values are omitted.


# Insights API

The **Younium Insights API** provides access to Insights data entities using a standard **OData v4 interface**. This guide describes how to interact with the API and query KPI data.

> ⚠️ **Note**: This is a pre-release version of the API. Adjustments may be introduced in the future. We welcome feedback from our users.

### Current Endpoints

The following endpoints are available and returns KPI data per month, including all standard and custom fields. See [environments](/documentation/environments) for base urls.

* **Recurring Revenue:**\
  **GET** `{evironment-base-url}/insights/Odata/recurringrevenue`
* **All Metrics:**\
  **GET** `{evironment-base-url}/insights/Odata/allmetrics`
* **Revenue Changes:**\
  **GET** `{evironment-base-url}/insights/Odata/revenueChanges`

### Authentication

Steps to authenticate can be found on [Get started](/get-started)

> ⚠️ **Important**: Legacy/classic authentication methods are **not supported** for the Insights API.

### Query Parameters

Because responses can be very large, queries should be filtered using OData parameters:

* **`$format`**\
  Defines the response format.
  * Recommended:

    ```
    $format=application/json;odata.metadata=none
    ```
* **`$top`**\
  Limits the number of records returned.
  * Example:

    ```
    $top=1000
    ```
* **`$skip`**\
  Skips a defined number of records (useful for pagination).
  * Example:

    ```
    $skip=5000
    ```
* **`$orderby`**\
  Sorts results by a specific field.
  * Example:

    ```
    $orderby=AccountName desc
    ```
* **`$apply`**\
  Used for **filtering and grouping**.
  * Example:

    ```
    $apply=filter(YearMonth ge 202510 AND YearMonth le 202510)/
           groupby((AccountName,ChargeNumber,YearMonth), aggregate(ARR with sum as ARR))
    ```

***

### Example Request

A full query combining parameters:

```http
GET https://api.younium.com/insights/Odata/recurringrevenue
?$count=true
&$format=application/json;odata.metadata=none
&$orderby=AccountName desc
&$skip=0
&$top=1000
&$apply=filter(YearMonth ge 202501 AND YearMonth le 202501 AND ARR ne 0)/
        groupby((AccountName,ChargeNumber,YearMonth), aggregate(ARR with sum as ARR))
```

This query:

* Counts the records (`$count=true`)
* Returns JSON without OData metadata
* Orders results by account name (descending)
* Returns 1000 records starting from offset 0
* Filters data to January 2025 (`YearMonth ge 202501 AND YearMonth le 202501`)
* Excludes records where ARR = 0
* Groups results by `AccountName`, `ChargeNumber`, and `YearMonth`
* Aggregates ARR as a sum


# Webhooks

Resources on Younium webhooks.

#### Understanding Webhooks in Younium

Webhooks enable real-time integrations with APIs and other SaaS services. When a business event occurs in Younium, a webhook event is queued, which, upon execution, sends an HTTP POST request to notify subscribers. This request includes details about the business event for the subscriber to process in their system or platform.

While alternatives like scheduled API requests exist, webhooks are generally more efficient and enhance the user experience. Events that trigger a webhook can originate from various sources, including API calls, user actions in the UI, and other integrations.

### Subscribing to webhook events

Subscribing to webhook events can be done in the Younium app in settings>webhooks or using the [API webhook endpoint](/api-s/api-2.1/webhooks). The endpoint takes two parameters in the body: URL and Events. Events is a list of Event Tags, see Event tags in the table above.

Example (Sandbox):

```
POST <https://api.sandbox.younium.com/Webhooks> 
```

Headers:

```
Authorization: Bearer [JWT token] Content-Type: application/json
```

Body:

```
{ 
  "url": "<https://your-service-url.com>", 
  "events": [ "AccountChanged" ] 
}
```

Response:

```
{ 
   "id": "49d5c950-925c-4863-f731-08dabe4f3d15", 
   "url": "<https://your-service-url.com>", 
   "events": [ 
      "AccountChanged", 
      ... //List of events that the webhook will listen to. 
   ], 
   "token": "g67g5fd7-s7d0-32a5-bd7e-df0dwas67c6", //All triggered webhook requests will contain this token. 
   "webhookStatus": "Enabled" 
}
```

### Webhook request body

Example of a webhook request body:

```
{ 
  "Token": "a97b4e0c-1b34-4c85-ae2f-3b14d4e4d8c1", 
  "EventId": "evt_sRzF5t6yO5DUdaDTM7da7s8EA", 
  "EventType": "AccountChanged", 
  "LegalEntityName": "Legal-Entity-Name", 
  "LegalEntityId": "57fc6a9f-5c4b-41d3-9b1b-2e1e62f4e3b8", 
  "Timestamp": "2022-11-03T14:00:55Z", 
  "TriggeredBy": "2e1cb02b-054f-4716-b924-8d7a32cbd8ce",
  "CorrelationId": "e1b69c34-5f6f-4e78-b412-9f9d71e2d531",
  "Source": "source" 
  "Data": {...} 
}
```

* **Token**: Token to verify the request.
* **CorrelationId:** When specified, provides an uuid that can be used to connect webhook events to a common transaction.
* **Source:** specify the source of the triggered event when set.
* **Data:** Entity-specific data, see request body references in the webhook list.

### Webhook request attempts and delivery

#### Webhook Event Execution

When a webhook event is executed, a webhook attempt is created, and a POST request is sent to the subscribing endpoint. For an attempt to succeed, the request must receive a successful response (status code 2xx). Any other response will be treated as a failed attempt.

**Failed Webhook Attempt Statuses**

* **Client Error 4xx**: This indicates a client-side error. It can result from access restrictions (401, 403), validation errors, bad requests (400), or an unfound URL (404).
* **Client Server Error 5xx**: Errors occur on the client's server, e.g., internal server error (500) or service unavailable (503). This might suggest an error within Younium causing the failure, indicated in the error message if applicable.
* **Request Timeout 500**: This happens if the client takes too long to respond, causing request cancellation after 60 seconds. Ensure a successful response is returned before executing any complex logic triggered by the webhook request.

Logs of webhook attempts are available under `Settings > Webhooks` in the Younium UI, showing all attempts from the past 15 days.

## Automatic and manual retries

For failed webhook requests, retries occur automatically every three hours, up to 10 attempts. After that, webhooks can be retried manually via the UI.

## Error notifications

Notifications can be enabled under `Settings > Notifications` to allow a user to be notified via the app notifications, if a webhook request fails.

## Webhook events using Paywall

The paywall allows Younium customers to automate online subscription sales. This functionality uses webhooks and will require a specific setup.&#x20;

1. Create a new webhook with the desired URL
2. Add the following events:
   * AccountCreated
   * InvoicePosted
   * PaymentPosted
   * SubscriptionActivated

The webhook request body for events triggered by the paywall will always include the `Source: "Paywall"`  and the `CorrelationId` connecting the different events to the common transaction. The data provided for each event is listed below.\
For a full guide to the Paywall, can be found  [here](https://support.younium.com/hc/en-us/articles/29924033585298-Paywall#h_01K6JHXTEZPGR5SNM8GXTAP77J)&#x20;

## Available webhook events

**Subscriptions:**

1. **SubscriptionActivated -** Triggered when a new subscription is activated.
2. **SubscriptionChanged -** Triggered when a new subscription change has been activated. Equivalent to the change Subscription endpoint.
3. **SubscriptionUpdated** - Triggered when information is edited or when a stock product delivery is made, which doesn't require a change subscription. Equivalent to patch subscription.
4. **SubscriptionCancelled** - Triggered when a subscription is cancelled.
5. **SubscriptionRenewed** - Triggered when a subscription is renewed.
6. **SubscriptionReverted** - Triggered when a subscription is reverted.
7. **SubscriptionDeleted** - Triggered when a subscription is deleted.

See [Subscriptions](/api-s/api-2.1/subscriptions#subscriptions-id) for request body

#### SalesOrders:

1. **SalesOrderActivated** - Triggered when a new sales order is activated.
2. **SalesOrderUpdated** - Triggered when information is edited or when a stock product delivery is made.
3. **SalesOrderDeleted** - Triggered when a sales order is deleted.

See [Salesorders](/api-s/api-2.1/salesorders#salesorders-id) for request body

#### Invoices:

1. **InvoicePosted** - Triggered when an Invoice is posted.
2. **InvoiceUpdated** - Triggered when an Invoice is updated.

See [Invoices](/api-s/api-2.1/invoices#invoices-id) for request body

#### Journals:

1. **JournalPosted** - Triggered when a Journal is posted.

See [Journals](/api-s/api-2.1/journals#journals-id) for request body

#### Accounts:

1. **AccountsCreated** - Triggered when an Account is created.
2. **AccountsChanged** - Triggered when an Account is edited.

See [Accounts](/api-s/api-2.1/accounts#accounts-id)for request body

#### Quotes:

1. **QuoteCreated** - Triggered when a Quote is created.
2. **QuoteEdited** - Triggered when a Quote is edited.
3. **QuoteConverted** - Triggered when a Quote is converted to an Order.

See [Quotes](/api-s/api-2.1/quotes#quotes-id) for request body

#### Payments:

1. **PaymentsCreated** - Triggered when a payment is created.
2. **PaymentsPosted** - Triggered when a payment is posted.

See [Payments](/api-s/api-2.1/payments#payments-id)for request body

#### InvoiceBatches:

1. **InvoiceBatchCreated** - Triggered when an invoice batch is created.
2. **InvoiceBatchPosted** - Triggered when an invoice batch is posted.
3. **InvoiceBatchCancelled** - Triggered when an invoice batch is cancelled.

See [Invoicebatches](/api-s/api-2.1/invoicebatches#invoicebatches-id) for request body

#### Products:

1. **ProductsCreated** - Triggered when a product is created.
2. **ProductsUpdated** - Triggered when a product is updated (Currently via API only).
3. **ProductsDeleted -** Triggered when a Product is deleted. Body: Id and confirmation message.

See [Products](/api-s/api-2.1/products#products-id) for request body for created and updated event.

ProductDeleted requestbody

```json
{
    message = "product was deleted",
    id = [uuid] //uuid of the deleted product 
}
```


# Subscription guide

Guide to creating and changing subscriptions

Orders are intricate structures with various levels and fields that behave differently based on use cases. This section outlines the fundamentals for creating and modifying subscriptions via the API.

This guide uses endpoints found in [API v2 Subscriptions](/api-s/api-2.1/subscriptions)

## Creating a Subscription

To create a minimal subscription, reference an existing account. This generates a draft subscription without products, starting on the first of the next month.

* `Account`: Reference to an existing account
* `Status`: Specify if it’s a draft or if it should be activated. If Activate, a product is required
* `EffectiveStartDate`: Date of when the subscription starts. The first of next month is set by default
* `Currency`: Specified currency for the order. If not set, the account currency will be used by default.
* `Products`: List of order products to create.

**Request example for creating an active order with an order product based on P-000001:**

```json
{
    "account": "A-000002",
    "status": "active",
    "effectiveStartDate": "2025-07-01",
    "currency": "SEK",
    "products": [
        {
            "product": "P-000001"
        }
    ]
}
```

Fields that reference related entities like `product` and `account` In this case are called lookup keys and provide functionality to reference an entity in different ways eg. using an entity number. The [developer resources](/documentation/developer-resources/developer-resources) describe these in more detail.

### Adding order products and order charges

An active subscription must include at least one order product, listed in the request with the required `product` field from the product catalog. By default, the order product inherits values from the product and its initial charge plan. These can be modified, and the order charges can be explicitly defined as shown below, referencing the `charge` field. For products of type `MultipleChargePlans` or `Full` it's recommended to specify the charge plan in the request.

* `Product`: Reference to an existing product from the product catalog
* `ChargePlan`: Reference to a charge plan on the referenced product

```json
{
    "account": "A-000002",
    "status": "active",
    "effectiveStartDate": "2025-07-01",
    "currency": "SEK",
    "products": [
        {
            "product": "P-000001",
            "chargePlan": "CP-000001",
            "charges": [
                {
                   "charge": "C-000001",
                   "quantity": 20
                }
            ]
        }
    ]
}
```

The order product is created using charges from the charge plan and the order's currency details (or the account's currency). In this case `quantity` is set explicitly overwritten from the charge's default values, and therefore, both a reference to the charge plan and the charge are required.

* The referenced charge must exist on the referenced charge plan, and product. else, a validation error will be thrown.

### Defining price details on the order charge

In certain situations, you need to set new price details, overwriting the default from the charge. This is done using the `priceDetails` field.

When setting new price details, no default values from the existing charge will be applied. Therefore, if a charge includes a tiered pricing structure, every tier must be explicitly specified in the request. The charge model and type logic will apply to the new price details. The following example demonstrates how to define price details and what fields can be set.

```json
{
    "account": "A-000002",
    "status": "active",
    "effectiveStartDate": "2025-07-01",
    "currency": "SEK",
    "products": [
        {
            "product": "P-000001",
            "chargePlan": "CP-000001",
            "charges": [
                {
                    "charge": "C-000002",
                    "quantity": 20,
                    "priceDetails": [
                        {
		                    "price": 700,
                            "listPrice": 700,
                        
                            "toQuantity": 0,
                            "tier": 0,
                            "description": "Price description",
                            "priceBase": "flat",
                        }
                    ]
                }
            ]
        }
    ]
}
```

#### **Price details and Discount**

In the price detail request, only one of the following fields should be set as they are interrelated and managed automatically: `price`, `linediscountAmount`, or `lineDiscountPercent`. If none are specified, the default `ListPrice` will be used.

* `ListPrice`: The list price and the basis for the price and discounts
* `price`: The actual price used and calculated after discounts.
* `LineDiscountPercent`: Discount in percent
* `LineDiscountAmount`: Discount amount

#### **Tiered price details**

In a `flat` or `quantity` charge model, only one price detail is allowed. The fields `tier` or `toQuantity` do not affect these models.

For `volume` or `tiered` models, consider the following rules when adding multiple price detail tiers:

* The `tier` field, indicating the order of price details, is crucial.
* The tier index must start at 0 and increase by 1 for each successive tier. Skipping an index will return a validation error.
* Each `toQuantity` must exceed that of the previous tier. The `fromQuantity` (not directly settable) is calculated accordingly.
* Set `toQuantity` for each tier, except if the last one has `isInfinite` set to true.
* If `toQuantity` is 0 or less, or not set, it defaults to the `fromQuantity` value or 0 if the tier is 0.
* `isInfinite`, when true, only applies to the last tier and overrides `toQuantity`.

### Adding Order Discounts

Discounts can be applied when setting up an order. You can specify the discount percentage, start and end dates, and select which charges will be affected.

If `OnSpecificCharges` is true, the discount applies only to the specified charges in the order. The `orderProductCharges` list must be provided in this case. If false, the discount applies to all charges in the order.

```json
{
    "account": "A-000002",
    "status": "active",
    "effectiveStartDate": "2025-07-01",
    "currency": "SEK",
    "products": [...],
    "orderDiscounts": [{
        "operation": "create",
				"percent": 10,
        "onSpecificCharges": false,
        "startOn": "alignToOrder",
        "endOn": "alignToOrder",
    }],
}
```

In the `orderProductCharges` list, specific charges should correspond to those in the added order products in the request. If the order discount references charges not present in the order, a validation error will occur. The example below illustrates setting order discounts on the charge for “C-000002” only.

```json
{
    "account": "A-000002",
    "status": "active",
    "effectiveStartDate": "2025-07-01",
    "currency": "SEK",
    "products": [
        {
            "product": "P-000001",
            "chargePlan": "CP-000001",
            "charges": [
                {
                    "charge": "C-000002",
                    "quantity": 20,
                }
            ]
        },
        {
            "product": "P-000002",
            "chargePlan": "CP-000004",
            "charges": [
                {
                    "charge": "C-000010",
                    "quantity": 20,
                }
            ]
        }
    ],
    "orderDiscounts": [
	    {
        "operation": "Create",
        "percent": 5,
        "onSpecificCharges": true,
        "orderProductCharges": [{
            "charge": "C-000002"
        }],
	    }
    ],
}
```

## Change Subscription

When you [change a subscription](/api-s/api-2.1/subscriptions#post-subscriptions-id-change), a new version is created. This change acts as a patch, updating only the components specified in the request payload, while existing elements like order products, order charges, and order discounts that aren't specified will be retained in the new version. However, note that charges on order products may be changed based on changes to the subscription itself.\\

Below is an example in which a new order product is added to the subscription, effective from the first of September.

```json
{
    "effectiveChangeDate": "2025-09-01",
    "products": [
        {
            "operation": "Create",
            "product": "P-000001",
            "chargePlan": "CP-000003"
        }
    ]
}
```

### Changing, adding, and canceling order products

Order products can be affected by three types of operations: `change`, `create` and `cancel`.

Just like when creating subscriptions, the `product` and `charge` fields need to be set and referenced correctly. However, depending on the operation, the source of the reference differs.

* When the operation is `create`: the source reference will be products and charges from the product catalog.
* When the operation is `change` , `cancel` or `remove`: The reference source will be the order products and order charges on existing orders

#### Create

A new product is added to the subscription. In this case, the product will always reference a product from the product catalog and will follow the same logic as for order products added when [creating a subscription](#adding-order-products-and-order-charges).

```json
{
    "effectiveChangeDate": "2024-09-01",
    "products": [
        {
            "operation": "Create",
            "product": "P-000001",
            "chargePlan": "CP-000003"
        }
    ]
}
```

#### Cancel

Canceling a product requires a reference to the existing order product. Order products cannot be removed, only cancelled.

```json
{
    "effectiveChangeDate": "2024-09-01",
    "products": [
        {
            "operation": "Cancel",
            "product": "OP-000237",
            "CancelProductOn": "specificDate",
	        "CancelationDate": "2024-09-01"
        }
    ]
}
```

#### Change

Changing a product requires a reference to the existing order product as well as any reference to the order product charges that will be changed.

```json
{
    "effectiveChangeDate": "2024-09-01",
    "products": [
        {
            "operation": "Change",
            "product": "OP-000237",
            "charges": [ 
                {
                    "charge": "OPC-000301",
                    "quantity": 12,
                    "priceDetails": [
                        {
                        "tier": 0,
                        "price": 89,
                        "listPrice": 89
                        }
                    ]
                }
            ]
       	}
    ]
}

```

### Price details

Price details on a change follow one of two behaviors:

#### **On a created order charge.**

If a new order product with charges is added (operation: `create`) and price details are defined. The price details will be overwritten and display the same behavior when specified in a [create subscription request](#defining-price-details-on-the-order-charge).

#### On a changed order charge

When an order charge is being changed (operation: `change`) price details will be modified using the `operation` field and can be changed, created, or removed. Price details not specified in the request should be unaffected with the exception of having `Tier` and `fromQuantity` automatically adjusted to account for added, changed, or removed price details.\
The following example shows a request where a tiered price detail is being changed.

```json
{
    "effectiveChangeDate": "2024-09-01",
    "products": [
        {
            "operation": "Change",
            "product": "OP-000237",
            "charges": [
	            {
		            "charge": "OPC-000301",
		            "priceDetails": [
			            {
			                "toQuantity": 100,
			                "operation": "Change",
			                "tier": 1,
			                "price": 100,
			                "listPrice": 100,
			            },
			            {
			                "toQuantity": 400,
			                "operation": "Create",
			                "tier": 4,
			                "price": 120,
			                "listPrice": 120,
			            },
			            {
			                "isInfinite": true,
			                "operation": "Create",
			                "tier": 5,
			                "price": 150,
			                "listPrice": 150,
			            }
		            ]
	           }
            ]
        }
    ]
}
```

### Changes to order discounts

Order discounts can be added, removed, or modified when a subscription is changed.

* **`Operation`**: Specify the operation as `create`, `remove`, or `change`. By default, it's `change` or `create`.
* **`OnSpecificCharges`**: Determine if the discount should apply to all charges (`false`) or specific ones (`true`).
* **`OrderProductCharges`**: Provide a list of order product charges for discounts if `OnSpecificCharges` is `true`.

Example of adding an order discount for all charges with start and end dates.

```json
{
    "effectiveChangeDate": "2025-07-01",
    "products": [...],
    "orderDiscounts": [
        {
            "operation": "create",
            "percent": 12,
            "onSpecificCharges": false,
            "startOn": "specificDate",
            "endOn": "specificDate",
            "startDate": "2024-07-01",
            "endDate": "2024-09-01"
        }
    ],
}
```

Example of a change where a new product is incorporated, and an order discount applies to both the new and existing charges.

```json
{
    "account": "A-000002",
    "status": "active",
    "effectiveStartDate": "2025-07-01",
    "currency": "SEK",
    "products": [
        {
            "product": "P-000001",
            "chargePlan": "CP-000001",
            "operation": "create",
            "charges": [
                {
                    "charge": "C-000002",
                    "quantity": 20,
                }
            ]
        },
        {
            "product": "OP-000267",
            "operation": "change",
            "charges": [
                {
                    "charge": "OPC-000322",
                    "quantity": 18,
                }
            ]
        },
        
    ],
    "orderDiscounts": [{
        "operation": "create",
        "percent": 8,
        "onSpecificCharges": true,
        "orderProductCharges": [
	        {
	            "charge": "C-000002",
	            "operation": "Add"
	        },
	        {
	            "charge": "OPC-000322",
	            "operation": "Add"
	        },
        ],
    }],
}
```

Example of removing an existing order discount

```json
{
    "effectiveChangeDate": "2025-07-01",
    "products": [...],
    "orderDiscounts": [
        {
            "operation": "remove",
            "orderDiscountId": "1b80a3a9-e171-40ed-fd1b-08dca02399df"
        }
    ],
}
```

Example of changing an existing order discount.

{% hint style="info" %}
The `products` and `charges` are added for clearer illustration and would yield the same result if omitted.
{% endhint %}

```json
{
    "effectiveChangeDate": "2025-07-01",
    "products": [
        {
            "operation": "change",
            "product": "OP-002591",
            "charges": [
                {
                    "charge": "OPC-002038"
                }
            ]
        },
        {
            "operation": "change",
            "product": "OP-002590",
            "charges": [
                {
                    "charge": "OPC-002037"
                }
            ]
        }
    ],
    "orderDiscounts": [
        {
            "operation": "change",
            "orderDiscountId": "1b80a3a9-e171-40ed-fd1b-08dca02399df", 
            "percent": 12,
            "onSpecificCharges": true,
            "orderProductCharges": [
                {
                    "charge": "OPC-002038",
                    "operation": "remove"
                },
                {
                    "charge": "OPC-002037",
                    "operation": "add"
                }
            ],
        }
    ],
}

```


# Product guide

Guide to creating and updating Products

## Product Guide <a href="#dexkj" id="dexkj"></a>

This guide provides a foundation on how to work with the [products API](/api-s/api-2.1/products). To get a foundation for how products are structured and their different features the [product structure user guide](https://support.younium.com/hc/en-us/articles/360038782551-Product-Structure) is a good place to start.

### Product type and object structure <a href="#hm9nb" id="hm9nb"></a>

The **product type** defines how many charge plans and charges a product can have. Every product must contain at least one charge plan, and every charge plan must contain at least one charge.

There are four product types:

* **Simple** – One charge plan with one charge.
* **MultipleCharges** – One charge plan with multiple charges.
* **MultipleChargePlans** – Multiple charge plans, each with one charge.
* **Full** – Multiple charge plans with multiple charges.

**Example: Simple product response**

```json
"product": {
    "productNumber": "P-000001",
    "chargePlans": [
        {
            "chargePlanNumber": "CP-000001",
            "charges": [
                {
                     "chargeNumber": "C-000001",
                     "priceDetails": [...]
                }
            ]
        }
    ]
}
```

**Example: Full Product Response**

```json
"product": {
    "productNumber": "P-000001",
    "chargePlans": [
        {
            "chargePlanNumber": "CP-000001",
            "charges": [
                {
                     "chargeNumber": "C-000001",
                     "priceDetails": [...]
                },
                {
                     "chargeNumber": "C-000002",
                     "priceDetails": [...]
                }
            ]
        },
        {
            "chargePlanNumber": "CP-000002",
            "charges": [
                {
                     "chargeNumber": "C-000003",
                     "priceDetails": [...]
                },
                {
                     "chargeNumber": "C-000004",
                     "priceDetails": [...]
                },
                {
                     "chargeNumber": "C-000005",
                     "priceDetails": [...]
                }
            ]
        },
    ]
}
```

### Charge Plans

A charge plan is primarily a **container** for charges. While it contains only general fields, it plays an important role by linking **order products** (products on an order) to their originating product and charges.

#### Charges <a href="#ufmqp" id="ufmqp"></a>

Charges are the most important part of the product and hold the most important information, which makes them more complex with a number of important fields.\
The fields on the charge object can be separated into different categories.

“General fields”, “charge configuration fields”, and “financial fields”

In the following JSON example, the fields are sorted by each category.

### Charges

Charges are the **core element** of a product. They contain the most critical information and are therefore more complex, with fields that can be organized into three categories:

1. **General fields**
2. **Charge configuration fields**
3. **Financial properties**

#### Example: Charge Object

```json
{ 
    //"General fields" 
    "name": "string", 
    "customFields": {
        "customFieldKey": "string"
    }, 
    "externalCRMId": "string", 
    "externalERPId": "string", 
     
    //charge configuration fields 
    "chargeType": "Recurring", 
    "model": "Quantity", 
    "unit": "units", 
    "pricePeriod": "Monthly, 
    "defaultQuantity": 0, 
    "usageRating": "Sum", 
    "measurementsRule": 0, 
    "PriceDetails": [ 
        { 
            "tier": 0, 
            "currency": "EUR", 
            "price": 10, 
            "customFields": {}, 
            "description": "string", 
            "isInfinite": false, 
            "priceBase": "Flat", 
            "toQuantity": 0 
        } 
    ], 
 
    //Financial properties 
    "billingPeriod": "Monthly", 
    "periodAlignment": "None", 
    "billingDay": "None", 
    "billingTiming" "InAdvance" 
    "specificBillingDay": 0, 
    "taxIncluded": false, 
    "revenueRecognition": "Recognized monthly over time", 
    "taxTemplate": "Sweden standard", 
    "deferredRevenueAccount": "2970", 
    "recognizedRevenueAccount": "3000" 
}
```

#### General fields <a href="#tpelm" id="tpelm"></a>

General identifiers for a charge and other detail fields. Read more about custom fields and external ids in the [developer resources section](/documentation/developer-resources/developer-resources)

#### Charge configuration fields <a href="#pgpep" id="pgpep"></a>

These fields define the **type** and **pricing model** of a charge and the **charge type** determines which pricing models are valid. The relevance of the other fields are dictated by the Type and model combination. The matrices below show the relationship between the fields and the type and model a charge has.

<table data-header-hidden data-full-width="true"><thead><tr><th width="167"></th><th width="87"></th><th width="99"></th><th width="92"></th><th width="98"></th><th width="103"></th><th width="96"></th><th width="88"></th><th width="92"></th><th></th><th></th><th></th><th></th><th></th><th></th><th></th></tr></thead><tbody><tr><td><code>chargeType</code></td><td>One-off</td><td></td><td></td><td></td><td>Usage</td><td></td><td></td><td></td><td>Measured</td><td></td><td></td><td>Recurring</td><td></td><td></td><td></td></tr><tr><td><code>model</code></td><td>Flat</td><td>Quantity</td><td>Volume</td><td>Tiered</td><td>Quantity</td><td>Volume</td><td>Tiered</td><td>Rated</td><td>Quantity</td><td>Volume</td><td>Tiered</td><td>Flat</td><td>Quantity</td><td>Volume</td><td>Tiered</td></tr><tr><td><code>PriceDetails</code></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td></tr><tr><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td><code>unit</code></td><td></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td></tr><tr><td><code>defaultQuantity</code></td><td></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td></tr><tr><td><code>pricePeriod</code></td><td></td><td></td><td></td><td></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td></tr><tr><td><code>usageRating</code></td><td></td><td></td><td></td><td></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td><code>measurementRules</code></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td><strong>x</strong></td><td><strong>x</strong></td><td><strong>x</strong></td><td></td><td></td><td></td><td></td></tr></tbody></table>

Most values can be set even if they have no relevance for the type and model and will be ignored when the charge is used. If a value is required or invalid in a specific use case, this will be stated in the documentation or throw a validation error on the request.

#### Financial fields <a href="#id-9gvjv" id="id-9gvjv"></a>

These fields are connected to how the charge will be billed on an order and act as default values for the order product charge (the charge of an order) when it’s created.

#### Default charge values <a href="#rh9j4" id="rh9j4"></a>

Default values for charges can be set in the **Younium UI** under: `Settings > Products > Product settings`.

* If a field is not included or set to `null` in the request, it will fall back to the defined default (if available).
* Some fields (e.g., `revenueRecognition`, `taxTemplate`, `deferredRevenueAccount`, `recognizedRevenueAccount`) may remain null if no default exists.

In certain cases, this behavior is preferred, as these values can instead be set when a Subscription or Sales order is created.

#### Price details <a href="#u4cbn" id="u4cbn"></a>

Every charge (except rated usage charges) requires at least one **price detail**. Price details define the pricing rules and depend on the charge’s pricing model.

Key rules:

* The **tier index** starts at 0 and increments by 1.
* Each `toQuantity` must be greater than the previous tier’s `toQuantity`.
* The last tier may omit `toQuantity` if `isInfinite = true`.
* If no currency is set, the legal entity’s base currency is applied.
* For **flat** or **quantity** models, there is only one price detail per currency (tier = 0).
* For **volume** or **tiered** models, multiple tiers per `currency` are supported.

#### Product category <a href="#yefnc" id="yefnc"></a>

The **product category** helps organize products (e.g., for reporting). Categories are defined under:\
`Settings > Products > Product categories`.

## Creating a product <a href="#id-0vuiu" id="id-0vuiu"></a>

The POST `/products` endpoint is used for creating products.

Example request for a **simple subscription** of a monthly recurring flat fee:

```json
{
    "name": "SaaS",
    "productType": "Simple",
    "category": "Core service",
    "isFrameworkProduct": false,
    "chargePlans": [
        {
            "name": "SaaS charge plan",
            "charges": [
                {
                    "name": "SaaS monthly fee",
                    "model": "Flat",
                    "chargeType": "Recurring",
                    "pricePeriod": "Monthly",
                    "billingDay": "FromOrder",
                    "specificBillingDay": 0,
                    "billingPeriod": "Annual",
                    "periodAlignment": "AlignToOrder",
                    "billingTiming": "InAdvance",
                    "taxTemplate": "Sweden Standard",
                    "taxIncluded": false,
                    "deferredRevenueAccount": "24xx",
                    "recognizedRevenueAccount": "30xx",
                    "customFields": {
                        "customChargeField": "string"
                    },
                    "priceDetails": [
                        {
                            "currency": "SEK",
                            "price": 1099.00
                        },
                        {
                            "currency": "EUR",
                            "price": 99.00
                        },
                        {
                            "currency": "DKK",
                            "price": 749.00
                        },
                        {
                            "currency": "USD",
                            "price": 99.00
                        },
                        {
                            "currency": "NOK",
                            "price": 1099.00
                        }
                    ]
                }
            ]
        }
    ],
    "customFields": {
        "customProductField": "string"
    }
}
```

Remarks about the request:

* Note that the `tier` doesn’t have to be set on the `price details` in this case as there can be only one per currency. Tier will get the value 0 as default.

#### Creating a full product example <a href="#s0suk" id="s0suk"></a>

Say we are offering a SaaS in which there are 3 plans: starter, professional. In each plan, there is a recurring base fee for 99, 400 and including 5, 15, and 30 seats, respectively, and above those included seats, there’s a volume-based discounted price tier.

For example, for the starter plan

| 0-5    | 0 (included) |
| ------ | ------------ |
| 6-20   | 30 per seat  |
| 21-*∞* | 20 per seat  |

```json
{
    "name": "SaaS",
    "productType": "Full",
    "category": "Core service",
    "isFrameworkProduct": false,
    "chargePlans": [
        {
            "name": "Starter",
            "charges": [
                {
                    "name": "Starter base fee",
                    "model": "Flat",
                    "chargeType": "Recurring",
                    "priceDetails": [
                        {
                            "currency": "EUR",
                            "price": 99
                        },
                        {
                            "currency": "USD",
                            "price": 99
                        }
                    ]
                },
                {
                    "name": "Starter seats fee",
                    "model": "Tiered",
                    "chargeType": "Recurring",
                    "defaultQuantity": 5,
                    "unit": {
                        "key": "unit",
                        "value": "seats"
                    },
                    "priceDetails": [
                        {
                            "tier": 0,
                            "currency": "EUR",
                            "toQuantity": 5,
                            "priceBase": "perUnit",
                            "price": 0
                        },
                        {
                            "tier": 1,
                            "currency": "EUR",
                            "toQuantity": 20,
                            "priceBase": "perUnit",
                            "price": 30
                        },
                        {
                            "tier": 2,
                            "currency": "EUR",
                            "isInfinite": true,
                            "priceBase": "perUnit",
                            "price": 20
                        },
                        {
                            "tier": 0,
                            "currency": "USD",
                            "toQuantity": 5,
                            "priceBase": "perUnit",
                            "price": 0
                        },
                        {
                            "tier": 1,
                            "currency": "USD",
                            "toQuantity": 20,
                            "priceBase": "perUnit",
                            "price": 30
                        },
                        {
                            "tier": 2,
                            "currency": "USD",
                            "isInfinite": true,
                            "priceBase": "perUnit",
                            "price": 20
                        }
                    ]
                }
            ]
        },
        {
            "name": "Professional",
            "charges": [
                {
                    "name": "Professional base fee",
                    "model": "Flat",
                    "chargeType": "Recurring",
                    "priceDetails": [
                        {
                            "currency": "EUR",
                            "price": 400
                        },
                        {
                            "currency": "USD",
                            "price": 400
                        }
                    ]
                },
                {
                    "name": "Professional seats fee",
                    "model": "Tiered",
                    "chargeType": "Recurring",
                    "defaultQuantity": 15,
                    "unit": {
                        "key": "unit",
                        "value": "seats"
                    },
                    "priceDetails": [
                        {
                            "tier": 0,
                            "currency": "EUR",
                            "toQuantity": 5,
                            "priceBase": "perUnit",
                            "price": 0
                        },
                        {
                            "tier": 1,
                            "currency": "EUR",
                            "toQuantity": 20,
                            "priceBase": "perUnit",
                            "price": 30
                        },
                        {
                            "tier": 2,
                            "currency": "EUR",
                            "isInfinite": true,
                            "priceBase": "perUnit",
                            "price": 20
                        },
                        {
                            "tier": 0,
                            "currency": "USD",
                            "toQuantity": 5,
                            "priceBase": "perUnit",
                            "price": 0
                        },
                        {
                            "tier": 1,
                            "currency": "USD",
                            "toQuantity": 20,
                            "priceBase": "perUnit",
                            "price": 30
                        },
                        {
                            "tier": 2,
                            "currency": "USD",
                            "isInfinite": true,
                            "priceBase": "perUnit",
                            "price": 20
                        }
                    ]
                }
            ]
        }
    ]
}
```

## Patching a product <a href="#blujk" id="blujk"></a>

The `PATCH /products/{id}` endpoint updates existing products and can add, modify, or remove charge plans, charges, and price details.

#### Operation Field

Entities can include an `operation` field with values:

* **Create** – Ignores lookup key; all child entities inherit `Create`.
* **Remove** – Requires lookup key; child entities inherit `Remove`.
* **Change** (default) – Requires lookup key; affects only that entity.

Price details do not use lookup keys. They are identified by the combination of `tier` and `currencyCode`.

#### Rules and Limitations

* Removing entities may fail if they are already used in a subscription or sales order.
* Changing product type may require explicit removal of charges/charge plans.
* Changing the model may automatically alter or remove price details.
* New entities receive default values unless otherwise specified.
* Framework products currently support patching only at the product level (not charges or charge plans).

> ⚠️ **Caution:** Updates are **irreversible**. Deleted entities cannot be recovered.

#### Patching a full product endpoint <a href="#m9koe" id="m9koe"></a>

Taking the above example request of creating a full product and updating it with:

* Adding an enterprise charge plan
* Removing the middle tiers on the Starter tiered charge.
* Updating the price on the flat recurring fee on the Professional charge plan

```json
{
    "name": "SaaS-updated",
    "chargePlans": [
        {
            "chargePLan": "CP-000001",
            "name": "Starter-updated",
            "charges": [
                {
                    "charge": "C-000002",
                    "defaultQuantity": 10,
                    "priceDetails": [
                        {
                            "tier": 0,
                            "currency": "EUR",
                            "toQuantity": 10,
                            "price": 5
                        },
                        {
                            "operation": "Remove",
                            "tier": 1,
                            "currency": "EUR"
                        },
                        {
                            "tier": 0,
                            "currency": "USD",
                            "toQuantity": 10,
                            "price": 5
                        },
                        {
                            "operation": "Remove",
                            "tier": 1,
                            "currency": "USD"
                        }
                    ]
                }
            ]
        },
        {
            "chargePLan": "CP-000001",
            "name": "Professional-updated",
            "charges": [
                {
                    "charge": "C-000003",
                    "priceDetails": [
                        {
                            "tier": 0,
                            "currency": "EUR",
                            "price": 500
                        },
                        {
                            "tier": 0,
                            "currency": "USD",
                            "price": 500
                        }
                    ]
                },
                {
                    "charge": "C-000004",
                    "priceDetails": [
                        {
                            "tier": 1,
                            "currency": "EUR",
                            "price": 35
                        },
                        {
                            "tier": 2,
                            "currency": "EUR",
                            "price": 25
                        },
                        {
                            "tier": 1,
                            "currency": "USD",
                            "price": 35
                        },
                        {
                            "tier": 2,
                            "currency": "USD",
                            "price": 25
                        }
                    ]
                }
            ]
        },
        {
            "operation": "create",
            "name": "Enterprise",
            "charges": [
                {
                    "name": "Enterprise base fee",
                    "model": "Flat",
                    "chargeType": "Recurring",
                    "priceDetails": [
                        {
                            "currency": "EUR",
                            "price": 1000
                        },
                        {
                            "currency": "USD",
                            "price": 1000
                        }
                    ]
                },
                {
                    "name": "Enterprise pcs fee",
                    "model": "Tiered",
                    "chargeType": "Recurring",
                    "defaultQuantity": 30,
                    "unit": {
                        "key": "name",
                        "value": "pcs"
                    },
                    "priceDetails": [
                        {
                            "tier": 0,
                            "currency": "EUR",
                            "toQuantity": 5,
                            "priceBase": "perUnit",
                            "price": 0
                        },
                        {
                            "tier": 1,
                            "currency": "EUR",
                            "toQuantity": 20,
                            "priceBase": "perUnit",
                            "price": 30
                        },
                        {
                            "tier": 2,
                            "currency": "EUR",
                            "isInfinite": true,
                            "priceBase": "perUnit",
                            "price": 20
                        },
                        {
                            "tier": 0,
                            "currency": "USD",
                            "toQuantity": 5,
                            "priceBase": "perUnit",
                            "price": 0
                        },
                        {
                            "tier": 1,
                            "currency": "USD",
                            "toQuantity": 20,
                            "priceBase": "perUnit",
                            "price": 30
                        },
                        {
                            "tier": 2,
                            "currency": "USD",
                            "isInfinite": true,
                            "priceBase": "perUnit",
                            "price": 20
                        }
                    ]
                }
            ]
        }
    ]
}
```

## Deleting a product <a href="#ow6mr" id="ow6mr"></a>

Products or their child entities can be deleted using the relevant API endpoints.

* Entities in use on an order cannot be deleted.
* Price details should be removed by updating the charge via `PATCH`.


# Idempotent requests

All POST endpoints in the API support idempotency. This mechanism ensures that requests are treated identically when retried and return the same response as the initial request. This prevents duplicate operations and unintentional actions in case of network failures or other disruptions.

### How Idempotency Works

Idempotency is implemented by storing the response of a request linked to a unique idempotency key and its endpoint. Any subsequent request with the same idempotency key to the same endpoint will receive the stored response instead of re-executing the operation.

### Using the Idempotency Key

To utilize idempotency, include the `younium-idempotency-key` in the request header:

```
younium-idempotency-key: [string]
younium-idempotency-durationinhours: [int]
```

* All **POST** requests support idempotency keys.
* If an idempotency key is provided in other HTTP methods, it will be ignored.
* The idempotency key is a string for flexibility, but using a **UUID or a unique key** is recommended to prevent collisions.
* The same idempotency key can be used across different endpoints, as uniqueness is determined in combination with the endpoint.
* include the `younium-idempotency-durationinhours` in the request header to specify how long the response should be stored in hours.

### Response Headers

The response of an idempotent request includes the following headers:

```
younium-idempotency-key: [string]
younium-idempotency-durationinhours: 24
younium-idempotency-expires: [UTC date string]
```

* `younium-idempotency-key`: The same key that was provided in the request.
* `younium-idempotency-durationinhours`: storage duration in hours,
* `younium-idempotency-expires`: The UTC timestamp when the stored response will expire.

### Expiry and Storage

* The result of an idempotent request is stored for 24 **hours** if no specified duration is provided.
* maximum duration is one week, 168 hours.
* When the duration expires, a request with the same idempotency key will be treated as a new request.
* Responses for **both successful and unsuccessful requests** are stored and will contain the corresponding `younium-idempotency` headers.

### Benefits of Idempotency

* Prevents **duplicate entries or actions** due to network retries.
* Ensures **safe request repetition** without unintended side effects.
* Improves **system reliability** by reducing inconsistencies caused by transient failures.

### Potential Errors Related to Idempotency

#### Failing Request

Requests that fail before reaching the endpoint will not be treated as idempotent and will never include the idempotency headers. This is generally the case for:

* Failed authentications or authorizations (**401**, **403**)
* Not found endpoints (**404**)
* Errors caused by factors outside the application (e.g., infrastructure-related failures)

#### Ongoing and Concurrent Requests

If two or more requests with the same key are sent at the same time, the first request must resolve before a response can be returned. The second request will therefore wait for the first request to resolve and return the stored response once available. If the second request fails to wait for a result, it will return a **409 Conflict** error with no `younium-idempotency` headers.

**Example Response:**

```
{
    "errors": {
        "message": [
            "Ongoing Request with younium-Idempotency-key: [string]. Wait for initial request to resolve"
        ]
    },
    "title": "An error connected to request idempotency occurred",
    "status": 409,
    "extensions": {
        "traceId": "0HNA5Q8MGHSRR:00000003"
    }
}
```

#### Altered Request Body

If the request body is modified from the initial request, a **400 Bad Request** error response will be returned with no `younium-idempotency` headers.

**Example Response:**

```
{
    "errors": {
        "message": [
            "Request body doesn't match for request with younium-Idempotency-key:[string]"
        ]
    },
    "title": "An error connected to request idempotency occurred",
    "status": 400,
    "extensions": {
        "traceId": "0HNA5Q8MGHSRR:00000003"
    }
}
```


# Invoice operations

## Invoice operations <a href="#dy1q4" id="dy1q4"></a>

Some Invoice endpoints return an operation response that deals with the outcome in a different manner. Where most endpoints return a status code of 400 “Bad Request” if the call was not successful, the operation response returns a successful 2xx with a `message` or `successful` field indicating the result of the operation. Validation errors or similar errors in the request will still return a 400 bad request.

The operation response contains the following fields in its basic form

```
{ 
  id: "3078377a-f369-4176-acf9-08d751485f0b", 
  message: "Invoice was successfully cancelled",  
  successful: true 
}
```

The `id` contains the affected entity eg. a generated invoice. The field may be null and excluded if no id is present to return. The `successful` field whether the operation was successful and the `message` should always be included with further details on the outcome of the operation.

## Generation invoices <a href="#cijes" id="cijes"></a>

Generating invoices provides the possibility to both generate a draft and post the invoice in a single call. This is defined in the request field `invoiceAction` with some different option values:

* `CreateDraft` (default value) will generate a draft invoice.
* `CreateDraftAndPostInvoice` will generate a draft and then try to post the invoice. A draft is created even if the invoice fails to be posted. The response field `successful` is only true if the invoice is posted successfully.
* `CancelDraftIfPostFail` will generate a draft and then try to post the invoice. If the invoice fails to be posted the draft will be cancelled. The response field `successful` is only true if the invoice is posted successfully. The message will indicate that the draft was successfully canceled and why posting the invoice failed.


# Stock products

Guide on how to work with stock products using the AP v2

#### Stock Product Charges Overview

A stock product is defined by a set of charges, characterized by:

* **Charge Type:** OneOff
* **Price Model:** Quantity

Each product has one or more charges, especially if it is partially delivered. The delivery status is defined by certain fields:

* **`ChangeState`:** Reflects the delivery status in the UI with values such as:
  * `New`
  * `PartialDelivery`
  * `ClosedPartialDelivery`
* **`orderedQuantity`:** Set only with the first charge, indicating the total quantity ordered.
* **`Quantity`:** Shows the delivered quantity. An undelivered charge will have no specified quantity.
* **`RemainingQuantity`:** Indicates the quantity yet to be delivered.
* **`Modified`** and **`Created`**

#### **Delivery and Partial Deliveries**

When a delivery is made, it affects the charge currently open for delivery. In cases of partial delivery, a new charge is created to reflect the remaining quantity pending delivery. The example below illustrates how charges are impacted by delivery events and their grouped results after each delivery event. null is the UI will be represented as an empty field.

<table><thead><tr><th width="157">Delivery events</th><th width="114">chargeNumber</th><th width="140">orderedQuantity</th><th width="125">remainingQuantity</th><th width="95">quantity</th><th>chargeState</th></tr></thead><tbody><tr><td><strong>An order is registered</strong></td><td>C-000001</td><td>30</td><td>30</td><td>null</td><td><code>new</code></td></tr><tr><td>Partial <strong>delivery of 4 on C-000001</strong></td><td>C-000001</td><td>30</td><td>26</td><td>4</td><td><code>partialDelivery</code></td></tr><tr><td></td><td>C-000002</td><td>null</td><td>26</td><td>null</td><td><code>partialDelivery</code></td></tr><tr><td><strong>A new partial delivery of 10 on C-000002</strong></td><td>C-000001</td><td>30</td><td>26</td><td>4</td><td><code>partialDelivery</code></td></tr><tr><td></td><td>C-000002</td><td>null</td><td>16</td><td>10</td><td><code>partialDelivery</code></td></tr><tr><td></td><td>C-000003</td><td>null</td><td>16</td><td>null</td><td><code>partialDelivery</code></td></tr><tr><td><strong>A last closing delivery of the remaining amount of 16 is made on C-000003</strong></td><td>C-000001</td><td>30</td><td>26</td><td>4</td><td><code>partialDelivery</code></td></tr><tr><td></td><td>C-000002</td><td>null</td><td>16</td><td>10</td><td><code>partialDelivery</code></td></tr><tr><td></td><td>C-000003</td><td>null</td><td>0</td><td>16</td><td><code>ClosedPartalDelivery</code></td></tr></tbody></table>

#### **Order version and status**

#### Fetching Sales Orders and Subscriptions

The API endpoints used for fetching sales orders and subscriptions always retrieve the latest version. The handling of stock products is consistent across both; the distinction lies in how order statuses are managed.

* **Sales Orders:** A sales order with a delivered stock product, whether open or closed, will have a status of `partiallyDelivered`.
* **Subscriptions:** A subscription containing a stock product remains unchanged by deliveries.

To obtain detailed information about deliveries and their status, refer to the related order charges.

#### **Cases to help parse information from the API.**

**Identify if a partial delivery is closed?**

* If any of the charges have `changeState` `ClosedPartalDelivery`
* This charge will also have a `remainingQuantity` value of 0 and the `quantity` equal to the amount that was last delivered.

**Identify if a charge is open for delivery?**

* If any of the charges have no `quantity`, meaning the `quantity` is null. Tt’s open to being delivered and the `remainingQuantity` will be the remaining amount that can be delivered.

**Identify if no deliveries have been made?**

* There will be only one charge with `changeState` `new` and with no `quantity`.
* `orderedQuantity` also equals `remainingQuantity`

**Identify how many deliveries were made?**

* The number of deliveries will be the same as the number of charges, with a `quantity` that’s not null

**Identify the total quantity that’s been delivered?**

* It is the same as the sum of all charges `quantity`.
* If this sum equals `orderedQuantity`. This means all have been delivered


# Changelog


