Accounts

Get Account by id.

Requires permission Account View.

GEThttps://api.sandbox.younium.com/Accounts/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

parentAccountIdnullable string (uuid)

accountNumbernullable string

accountTypeall of

inactiveboolean

invoiceDeliveryMethodall of

accountsReceivablenullable string

currencyCodenullable string

defaultPaymentTermnullable string

domainnullable string

electronicInvoiceAddressnullable string

electronicInvoiceAddressSchemenullable string

Electronic invoice scheme (EAS) code list. Read more on: https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/

Example: "0007"

imageUrlnullable string

invoiceEmailAddressnullable string

invoiceEmailCcAddressesnullable string

reminderEmailAddressnullable string

namenullable string

organizationNumbernullable string

ourReferencenullable string

taxRegistrationNumbernullable string

taxTemplatenullable string

yourReferencenullable string

invoiceTemplateIdnullable string (uuid)

invoiceBatchGroupIdnullable string (uuid)

invoiceSettingGroupIdnullable string (uuid)

defaultInvoiceAddressnullable all of

defaultDeliveryAddressnullable all of

addressesnullable array of AddressResponse (object)

customFieldsnullable object

onlinePaymentDetailsnullable all of

externalERPIdnullable string

externalCRMIdnullable string

createdstring (date-time)

modifiedstring (date-time)

cmrrnullable all of

acvnullable all of

emrrnullable all of

oneTimeFeesnullable all of

tcvnullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "parentAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNumber": "text",
  "accountType": {},
  "inactive": false,
  "invoiceDeliveryMethod": {},
  "accountsReceivable": "text",
  "currencyCode": "text",
  "defaultPaymentTerm": "text",
  "domain": "text",
  "electronicInvoiceAddress": "text",
  "electronicInvoiceAddressScheme": "0007",
  "imageUrl": "text",
  "invoiceEmailAddress": "text",
  "invoiceEmailCcAddresses": "text",
  "reminderEmailAddress": "text",
  "name": "text",
  "organizationNumber": "text",
  "ourReference": "text",
  "taxRegistrationNumber": "text",
  "taxTemplate": "text",
  "yourReference": "text",
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "defaultInvoiceAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "defaultDeliveryAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "addresses": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "name": "text",
      "street": "text",
      "street2": "text",
      "city": "text",
      "county": "text",
      "state": "text",
      "zip": "text",
      "country": "text"
    }
  ],
  "onlinePaymentDetails": {
    "created": "2024-12-22T11:24:06.095Z",
    "modified": "2024-12-22T11:24:06.095Z",
    "stripeCustomerId": "text",
    "stripePaymentMethodId": "text"
  },
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2024-12-22T11:24:06.095Z",
  "modified": "2024-12-22T11:24:06.095Z",
  "cmrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  }
}

Edit Account

PATCHhttps://api.sandbox.younium.com/Accounts/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

namenullable string

accountTypenullable all of

currencynullable all of

Allowed as string input: Code, Currency-Id.

Example: "SEK"

ourReferencenullable string

yourReferencenullable string

invoiceEmailAddressnullable string

reminderEmailAddressnullable string

invoiceEmailCcAddressesnullable string

invoiceDeliveryMethodnullable all of

defaultPaymentTermnullable all of

Allowed as string input: Name, PaymentTerm-Id.

Example: "NET30"

taxRegistrationNumbernullable string

organizationNumbernullable string

electronicInvoiceAddressnullable string

electronicInvoiceAddressSchemenullable string

Electronic invoice scheme (EAS) code list. Read more on: https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/

Example: "0007"

inactiveboolean

taxTemplatenullable all of

Allowed as string input: Name, TaxTemplate-Id.

Example: "Sweden standard"

accountsReceivablenullable all of

Allowed as string input: Code, FinancialAccount-Id.

Example: "1510"

imageUrlnullable string

domainnullable string

invoiceTemplateIdnullable string (uuid)

invoiceBatchGroupnullable all of

invoiceSettingGroupnullable all of

defaultInvoiceAddressnullable all of

defaultDeliveryAddressnullable all of

externalERPIdnullable string

externalCRMIdnullable string

customFieldsnullable object

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Accounts.

Requires permission Account View.

GEThttps://api.sandbox.younium.com/Accounts

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of AccountResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "parentAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "accountNumber": "text",
      "accountType": {},
      "inactive": false,
      "invoiceDeliveryMethod": {},
      "accountsReceivable": "text",
      "currencyCode": "text",
      "defaultPaymentTerm": "text",
      "domain": "text",
      "electronicInvoiceAddress": "text",
      "electronicInvoiceAddressScheme": "0007",
      "imageUrl": "text",
      "invoiceEmailAddress": "text",
      "invoiceEmailCcAddresses": "text",
      "reminderEmailAddress": "text",
      "name": "text",
      "organizationNumber": "text",
      "ourReference": "text",
      "taxRegistrationNumber": "text",
      "taxTemplate": "text",
      "yourReference": "text",
      "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
      "defaultInvoiceAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "defaultDeliveryAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "addresses": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "description": "text",
          "name": "text",
          "street": "text",
          "street2": "text",
          "city": "text",
          "county": "text",
          "state": "text",
          "zip": "text",
          "country": "text"
        }
      ],
      "onlinePaymentDetails": {
        "created": "2024-12-22T11:24:06.095Z",
        "modified": "2024-12-22T11:24:06.095Z",
        "stripeCustomerId": "text",
        "stripePaymentMethodId": "text"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:24:06.095Z",
      "modified": "2024-12-22T11:24:06.095Z",
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      }
    }
  ]
}

Create Account

POSThttps://api.sandbox.younium.com/Accounts

Authorization

oauth2

Header parameters

Body

application/json

name*string

accountTypenullable all of

currency*all of

Allowed as string input: Code, Currency-Id.

Example: "SEK"

ourReferencenullable string

yourReferencenullable string

invoiceEmailAddressnullable string

invoiceEmailCcAddressesnullable string

invoiceDeliveryMethodnullable all of

defaultPaymentTermnullable all of

Allowed as string input: Name, PaymentTerm-Id.

Example: "NET30"

taxRegistrationNumbernullable string

organizationNumbernullable string

electronicInvoiceAddressnullable string

electronicInvoiceAddressSchemenullable string

Electronic invoice scheme (EAS) code list. Read more on: https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/

Example: "0007"

inactiveboolean

taxTemplatenullable all of

Allowed as string input: Name, TaxTemplate-Id.

Example: "Sweden standard"

accountsReceivablenullable all of

Allowed as string input: Code, FinancialAccount-Id.

Example: "1510"

imageUrlnullable string

domainnullable string

invoiceTemplateIdnullable string (uuid)

invoiceBatchGroupnullable all of

invoiceSettingGroupnullable all of

reminderEmailAddressnullable string

defaultInvoiceAddressnullable all of

defaultDeliveryAddressnullable all of

externalERPIdnullable string

externalCRMIdnullable string

customFieldsnullable object

Response

201400401403

Created

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "currency": "SEK",
      "name": "text"
    }),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Create OnlinePaymentDetails for Account

POSThttps://api.sandbox.younium.com/Accounts/OnlinePaymentDetails/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/json

stripeCustomerIdnullable string

stripePaymentMethodIdnullable string

Response

201400401403

The OnlineDetailsPayment for the request.

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/OnlinePaymentDetails/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Edit OnlinePaymentDetails on Account

PATCHhttps://api.sandbox.younium.com/Accounts/OnlinePaymentDetails/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

stripeCustomerIdnullable string

stripePaymentMethodIdnullable string

Response

204400401403404

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/OnlinePaymentDetails/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete OnlinePaymentDetails on Account

DELETEhttps://api.sandbox.younium.com/Accounts/OnlinePaymentDetails/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/OnlinePaymentDetails/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete Account

DELETEhttps://api.sandbox.younium.com/Accounts/{accountId}

Authorization

oauth2

Path parameters

accountId*string (uuid)

The identifier of the account

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/{accountId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Account subscriptions.

GEThttps://api.sandbox.younium.com/Accounts/{id}/Subscriptions

Authorization

oauth2

Path parameters

id*string (uuid)

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of SubscriptionResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/{id}/Subscriptions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderNumber": "text",
      "version": 0,
      "isLastVersion": false,
      "status": {},
      "description": "text",
      "remarks": "text",
      "effectiveStartDate": "2024-12-22T11:24:06.095Z",
      "effectiveEndDate": "2024-12-22T11:24:06.095Z",
      "cancellationDate": "2024-12-22T11:24:06.095Z",
      "effectiveChangeDate": "2024-12-22T11:24:06.095Z",
      "orderDate": "2024-12-22T11:24:06.095Z",
      "noticePeriodDate": "2024-12-22T11:24:06.095Z",
      "lastRenewalDate": "2024-12-22T11:24:06.095Z",
      "created": "2024-12-22T11:24:06.095Z",
      "modified": "2024-12-22T11:24:06.095Z",
      "lastUpdated": "2024-07-01",
      "noticePeriod": 0,
      "term": 0,
      "renewalTerm": 0,
      "isAutoRenewed": false,
      "orderType": {},
      "termType": {},
      "orderPaymentMethod": {},
      "invoiceSeparatly": false,
      "yourReference": "text",
      "ourReference": "text",
      "yourOrderNumber": "text",
      "buyerReference": "text",
      "invoiceAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "deliveryAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "orderBillingPeriod": {},
      "setOrderBillingPeriod": false,
      "invoiceBatchGroup": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "description": "text"
      },
      "paymentTerm": "text",
      "useAccountInvoiceBatchGroup": false,
      "account": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "invoiceAccount": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "products": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "productNumber": "text",
          "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
          "chargePlanName": "text",
          "chargePlanNumber": "text",
          "productLineNumber": 0,
          "name": "text",
          "charges": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "chargeNumber": "OPC-000001",
              "version": 0,
              "isLastVersion": false,
              "name": "text",
              "chargeType": {},
              "priceModel": {},
              "effectiveStartDate": "2024-12-22T11:24:06.095Z",
              "effectiveEndDate": "2024-12-22T11:24:06.095Z",
              "quantity": 0,
              "unitCode": "text",
              "startOn": {},
              "endOn": {},
              "chargedThroughDate": "2024-12-22T11:24:06.095Z",
              "lastRenewalDate": "2024-12-22T11:24:06.095Z",
              "lastPriceAdjustmentDate": "2024-12-22T11:24:06.095Z",
              "pricePeriod": {},
              "usageRating": {},
              "revenueRecognitionRule": "text",
              "billingDay": {},
              "specificBillingDay": 0,
              "billingPeriod": {},
              "billingTiming": {},
              "periodAlignment": {},
              "alignmentDate": "2024-12-22T11:24:06.095Z",
              "taxTemplate": "text",
              "taxIncluded": false,
              "createInvoiceLinesPerTier": false,
              "estimatedUsage": 0,
              "estimatedQuantity": 0,
              "remainingQuantity": 0,
              "orderedQuantity": 0,
              "remarks": "text",
              "accountsReceivableAccount": "text",
              "deferredRevenueAccount": "text",
              "recognizedRevenueAccount": "text",
              "changeState": {},
              "displayPrice": 0,
              "priceDetails": [
                {
                  "tier": 0,
                  "price": 0,
                  "listPrice": 0,
                  "description": "text",
                  "fromQuantity": 0,
                  "toQuantity": 0,
                  "priceBase": {},
                  "lineDiscountPercent": 0,
                  "lineDiscountAmount": 0
                }
              ],
              "recurringMonthlyAmount": 0,
              "recurringMonthlyAmountBase": 0,
              "features": [
                {
                  "code": "text",
                  "description": "text"
                }
              ],
              "orderDiscounts": [
                {
                  "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                  "chargeId": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "externalERPId": "text",
              "externalCRMId": "text",
              "cmrr": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "acv": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "tcv": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "emrr": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "oneTimeFees": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
              "orderId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000",
              "created": "2024-12-22T11:24:06.095Z",
              "modified": "2024-12-22T11:24:06.095Z"
            }
          ],
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "created": "2024-12-22T11:24:06.095Z",
          "modified": "2024-12-22T11:24:06.095Z"
        }
      ],
      "milestones": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "milestoneDate": "2024-12-22T11:24:06.095Z",
          "plannedDate": "2024-12-22T11:24:06.095Z"
        }
      ],
      "orderDiscounts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "startOn": {},
          "endOn": {},
          "startDate": "2024-12-22T11:24:06.095Z",
          "endDate": "2024-12-22T11:24:06.095Z",
          "percent": 0,
          "discountType": {},
          "orderProductCharges": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "onSpecificCharges": false
        }
      ],
      "currency": "text",
      "externalERPId": "text",
      "externalCRMId": "text",
      "currencyCodeToUseWhenInvoice": "text",
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:24:06.095Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      }
    }
  ]
}

Get Account invoices.

GEThttps://api.sandbox.younium.com/Accounts/{id}/Invoices

Authorization

oauth2

Path parameters

id*string (uuid)

Account id

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of InvoiceResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/{id}/Invoices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceNumber": "text",
      "status": {},
      "account": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "notes": "text",
      "invoiceDate": "2024-12-22T11:24:06.095Z",
      "dueDate": "2024-12-22T11:24:06.095Z",
      "paymentDate": "2024-12-22T11:24:06.095Z",
      "lastPaymentDate": "2024-12-22T11:24:06.095Z",
      "daysPastDue": 0,
      "nrOfReminders": 0,
      "paymentTerm": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "days": 0,
        "name": "text"
      },
      "currency": "text",
      "subtotal": 0,
      "tax": 0,
      "totalAmount": 0,
      "totalRoundingAmount": 0,
      "settledAmount": 0,
      "balancedAmount": 0,
      "taxIncluded": false,
      "invoiceAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "deliveryAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceLines": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "invoiceLineNumber": 0,
          "productNumber": "text",
          "productName": "text",
          "chargeDescription": "text",
          "chargeNumber": "text",
          "charge": {
            "name": "text",
            "chargeNumber": "OPC-000001",
            "description": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "quantity": 0,
          "unitOfMeasure": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "unitCode": "text",
            "name": "text",
            "displayName": "text"
          },
          "price": 0,
          "subtotal": 0,
          "total": 0,
          "tax": 0,
          "subtotalPreDiscount": 0,
          "totalPreDiscount": 0,
          "taxPreDiscount": 0,
          "servicePeriodStartDate": "2024-12-22T11:24:06.095Z",
          "servicePeriodEndDate": "2024-12-22T11:24:06.095Z",
          "notes": "text",
          "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "accountsReceivable": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "deferredRevenue": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "recognizedRevenue": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2024-12-22T11:24:06.095Z",
          "modified": "2024-12-22T11:24:06.095Z",
          "taxCategoryName": "text",
          "taxRate": 0
        }
      ],
      "latestOnlinePaymentLogs": [
        {
          "failedPayment": false,
          "paymentDescription": "text",
          "timeStamp": "2024-12-22T11:24:06.095Z",
          "payoutId": "text",
          "isPayout": false,
          "paymentIntentId": "text"
        }
      ],
      "onlinePaymentStatus": {},
      "yourReference": "text",
      "ourReference": "text",
      "yourOrderNumber": "text",
      "buyerReference": "text",
      "invoiceType": {},
      "ocrNumber": "text",
      "sendMethod": "text",
      "exchangeRate": 0,
      "settledNotes": "text",
      "invoiceDeliveryMethod": {},
      "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "disableAutomaticInvoiceReminder": false,
      "onlinePaymentLink": "text",
      "accountsReceivable": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:24:06.095Z",
      "modified": "2024-12-22T11:24:06.095Z"
    }
  ]
}

Get Account SalesOrders.

GEThttps://api.sandbox.younium.com/Accounts/{id}/SalesOrders

Authorization

oauth2

Path parameters

id*string (uuid)

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of SalesOrderResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/{id}/SalesOrders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderNumber": "text",
      "version": 0,
      "isLastVersion": false,
      "status": {},
      "description": "text",
      "remarks": "text",
      "orderDate": "2024-12-22T11:24:06.095Z",
      "created": "2024-12-22T11:24:06.095Z",
      "modified": "2024-12-22T11:24:06.095Z",
      "lastUpdated": "2024-12-22T11:24:06.095Z",
      "orderType": {},
      "invoiceSeparatly": false,
      "yourReference": "text",
      "ourReference": "text",
      "yourOrderNumber": "text",
      "buyerReference": "text",
      "invoiceAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "deliveryAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "paymentTerm": "text",
      "orderPaymentMethod": {},
      "invoiceBatchGroup": "text",
      "useAccountInvoiceBatchGroup": false,
      "account": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "invoiceAccount": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "currency": "text",
      "accountsReceivableAccount": "text",
      "externalERPId": "text",
      "externalCRMId": "text",
      "products": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "productNumber": "text",
          "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
          "chargePlanName": "text",
          "chargePlanNumber": "text",
          "productLineNumber": 0,
          "name": "text",
          "charges": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "chargeNumber": "OPC-000001",
              "version": 0,
              "isLastVersion": false,
              "name": "text",
              "chargeType": {},
              "priceModel": {},
              "effectiveStartDate": "2024-12-22T11:24:06.095Z",
              "effectiveEndDate": "2024-12-22T11:24:06.095Z",
              "quantity": 0,
              "unitCode": "text",
              "startOn": {},
              "endOn": {},
              "chargedThroughDate": "2024-12-22T11:24:06.095Z",
              "lastRenewalDate": "2024-12-22T11:24:06.095Z",
              "lastPriceAdjustmentDate": "2024-12-22T11:24:06.095Z",
              "pricePeriod": {},
              "usageRating": {},
              "revenueRecognitionRule": "text",
              "billingDay": {},
              "specificBillingDay": 0,
              "billingPeriod": {},
              "billingTiming": {},
              "periodAlignment": {},
              "alignmentDate": "2024-12-22T11:24:06.095Z",
              "taxTemplate": "text",
              "taxIncluded": false,
              "createInvoiceLinesPerTier": false,
              "estimatedUsage": 0,
              "estimatedQuantity": 0,
              "remainingQuantity": 0,
              "orderedQuantity": 0,
              "remarks": "text",
              "accountsReceivableAccount": "text",
              "deferredRevenueAccount": "text",
              "recognizedRevenueAccount": "text",
              "changeState": {},
              "displayPrice": 0,
              "priceDetails": [
                {
                  "tier": 0,
                  "price": 0,
                  "listPrice": 0,
                  "description": "text",
                  "fromQuantity": 0,
                  "toQuantity": 0,
                  "priceBase": {},
                  "lineDiscountPercent": 0,
                  "lineDiscountAmount": 0
                }
              ],
              "recurringMonthlyAmount": 0,
              "recurringMonthlyAmountBase": 0,
              "features": [
                {
                  "code": "text",
                  "description": "text"
                }
              ],
              "orderDiscounts": [
                {
                  "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                  "chargeId": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "externalERPId": "text",
              "externalCRMId": "text",
              "cmrr": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "acv": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "tcv": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "emrr": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "oneTimeFees": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:24:06.095Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
              "orderId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000",
              "created": "2024-12-22T11:24:06.095Z",
              "modified": "2024-12-22T11:24:06.095Z"
            }
          ],
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:24:06.095Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "created": "2024-12-22T11:24:06.095Z",
          "modified": "2024-12-22T11:24:06.095Z"
        }
      ],
      "milestones": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "milestoneDate": "2024-12-22T11:24:06.095Z",
          "plannedDate": "2024-12-22T11:24:06.095Z"
        }
      ],
      "orderDiscounts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "startOn": {},
          "endOn": {},
          "startDate": "2024-12-22T11:24:06.095Z",
          "endDate": "2024-12-22T11:24:06.095Z",
          "percent": 0,
          "discountType": {},
          "orderProductCharges": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "onSpecificCharges": false
        }
      ],
      "invoicingCurrency": "text"
    }
  ]
}

Get Account summery.

GEThttps://api.sandbox.younium.com/Accounts/{id}/Summary

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

cmrrnullable all of

acvnullable all of

emrrnullable all of

oneTimeFeesnullable all of

tcvnullable all of

accountBalancenullable all of

lastInvoicednullable string (date-time)

namenullable string

accountNumbernullable string

idstring (uuid)

externalERPIdnullable string

externalCRMIdnullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Accounts/{id}/Summary', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "cmrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "accountBalance": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:24:06.095Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "lastInvoiced": "2024-12-22T11:24:06.095Z",
  "name": "text",
  "accountNumber": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalERPId": "text",
  "externalCRMId": "text"
}

---