Accounts

Get Account by id.

get

Requires permission Account View.

Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
get
GET /Accounts/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "parentAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNumber": "text",
  "accountType": "Customer",
  "inactive": true,
  "invoiceDeliveryMethod": "Email",
  "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"
    }
  ],
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "onlinePaymentDetails": {
    "created": "2025-04-27T17:04:22.128Z",
    "modified": "2025-04-27T17:04:22.128Z",
    "stripeCustomerId": "text",
    "stripePaymentMethodId": "text"
  },
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-04-27T17:04:22.128Z",
  "modified": "2025-04-27T17:04:22.128Z",
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Edit Account

patch
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Body
namestring | nullableOptional
accountTypeall of | nullableOptional
string · enumOptionalPossible values:
currencyall of | nullableOptional

Allowed as string input: Code, Currency-Id.

Example: SEK
ourReferencestring | nullableOptional
yourReferencestring | nullableOptional
invoiceEmailAddressstring | nullableOptional
reminderEmailAddressstring | nullableOptional
invoiceEmailCcAddressesstring | nullableOptional
invoiceDeliveryMethodall of | nullableOptional
string · enumOptionalPossible values:
defaultPaymentTermall of | nullableOptional

Allowed as string input: Name, PaymentTerm-Id.

Example: NET30
taxRegistrationNumberstring | nullableOptional
organizationNumberstring | nullableOptional
electronicInvoiceAddressstring | nullableOptional
electronicInvoiceAddressSchemestring | nullableOptional

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

Example: 0007
inactivebooleanOptional
taxTemplateall of | nullableOptional

Allowed as string input: Name, TaxTemplate-Id.

Example: Sweden standard
accountsReceivableall of | nullableOptional

Allowed as string input: Code, FinancialAccount-Id.

Example: 1510
imageUrlstring | nullableOptional
domainstring | nullableOptional
invoiceTemplateIdstring · uuid | nullableOptional
invoiceBatchGroupIdstring · uuid | nullableOptionalDeprecated
invoiceBatchGroupall of | nullableOptional
invoiceSettingGroupall of | nullableOptional
defaultInvoiceAddressall of | nullableOptional
defaultDeliveryAddressall of | nullableOptional
externalERPIdstring | nullableOptional
externalCRMIdstring | nullableOptional
Responses
patch
PATCH /Accounts/{id} HTTP/1.1
Host: api.younium.com
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 1102

{
  "name": "text",
  "accountType": "Customer",
  "currency": "SEK",
  "ourReference": "text",
  "yourReference": "text",
  "invoiceEmailAddress": "text",
  "reminderEmailAddress": "text",
  "invoiceEmailCcAddresses": "text",
  "invoiceDeliveryMethod": "Email",
  "defaultPaymentTerm": "NET30",
  "taxRegistrationNumber": "text",
  "organizationNumber": "text",
  "electronicInvoiceAddress": "text",
  "electronicInvoiceAddressScheme": "0007",
  "inactive": true,
  "taxTemplate": "Sweden standard",
  "accountsReceivable": "1510",
  "imageUrl": "text",
  "domain": "text",
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceBatchGroup": {
    "key": "text",
    "value": "text"
  },
  "invoiceSettingGroup": {
    "key": "text",
    "value": "text"
  },
  "defaultInvoiceAddress": {
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "Sweden"
  },
  "defaultDeliveryAddress": {
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "Sweden"
  },
  "externalERPId": "text",
  "externalCRMId": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
No content

Get Accounts.

get

Requires permission Account View.

Authorizations
Query parameters
FilterstringOptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20
OrderBystringOptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 03/01/2025 00:00:00
ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'customFields' and 'addresses'

Example: 03/01/2025 00:00:00
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
get
GET /Accounts HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "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": "Customer",
      "inactive": true,
      "invoiceDeliveryMethod": "Email",
      "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"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "onlinePaymentDetails": {
        "created": "2025-04-27T17:04:22.128Z",
        "modified": "2025-04-27T17:04:22.128Z",
        "stripeCustomerId": "text",
        "stripePaymentMethodId": "text"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-04-27T17:04:22.128Z",
      "modified": "2025-04-27T17:04:22.128Z",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ]
}

Create Account

post
Authorizations
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
post
POST /Accounts HTTP/1.1
Host: api.younium.com
Content-Type: application/json
Accept: */*
Content-Length: 1102

{
  "name": "text",
  "accountType": "Customer",
  "currency": "SEK",
  "ourReference": "text",
  "yourReference": "text",
  "invoiceEmailAddress": "text",
  "invoiceEmailCcAddresses": "text",
  "invoiceDeliveryMethod": "Email",
  "defaultPaymentTerm": "NET30",
  "taxRegistrationNumber": "text",
  "organizationNumber": "text",
  "electronicInvoiceAddress": "text",
  "electronicInvoiceAddressScheme": "0007",
  "inactive": true,
  "taxTemplate": "Sweden standard",
  "accountsReceivable": "1510",
  "imageUrl": "text",
  "domain": "text",
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceBatchGroup": {
    "key": "text",
    "value": "text"
  },
  "invoiceSettingGroup": {
    "key": "text",
    "value": "text"
  },
  "reminderEmailAddress": "text",
  "defaultInvoiceAddress": {
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "Sweden"
  },
  "defaultDeliveryAddress": {
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "Sweden"
  },
  "externalERPId": "text",
  "externalCRMId": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
No content

Create OnlinePaymentDetails for Account

post
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
post
POST /Accounts/OnlinePaymentDetails/{id} HTTP/1.1
Host: api.younium.com
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "stripeCustomerId": "text",
  "stripePaymentMethodId": "text"
}
No content

Edit OnlinePaymentDetails on Account

patch
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Body
stripeCustomerIdstring | nullableOptional
stripePaymentMethodIdstring | nullableOptional
Responses
patch
PATCH /Accounts/OnlinePaymentDetails/{id} HTTP/1.1
Host: api.younium.com
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 58

{
  "stripeCustomerId": "text",
  "stripePaymentMethodId": "text"
}
No content

Delete OnlinePaymentDetails on Account

delete
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
delete
DELETE /Accounts/OnlinePaymentDetails/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

No content

Delete Account

delete
Authorizations
Path parameters
accountIdstring · uuidRequired

The identifier of the account

Header parameters
api-versionstringOptional
Responses
delete
DELETE /Accounts/{accountId} HTTP/1.1
Host: api.younium.com
Accept: */*

No content

Get Account subscriptions.

get
Authorizations
Path parameters
idstring · uuidRequired
Query parameters
FilterstringOptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20
OrderBystringOptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 03/01/2025 00:00:00
ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'orderProducts', 'orderCharges', 'chargeDetails', 'orderDiscounts', 'milestones' and 'customFields' on these entities

Example: 03/01/2025 00:00:00
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
get
GET /Accounts/{id}/Subscriptions HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "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": 1,
      "isLastVersion": true,
      "status": "Draft",
      "description": "text",
      "remarks": "text",
      "effectiveStartDate": "2025-04-27T17:04:22.128Z",
      "effectiveEndDate": "2025-04-27T17:04:22.128Z",
      "cancellationDate": "2025-04-27T17:04:22.128Z",
      "effectiveChangeDate": "2025-04-27T17:04:22.128Z",
      "orderDate": "2025-04-27T17:04:22.128Z",
      "noticePeriodDate": "2025-04-27T17:04:22.128Z",
      "lastRenewalDate": "2025-04-27T17:04:22.128Z",
      "created": "2025-04-27T17:04:22.128Z",
      "modified": "2025-04-27T17:04:22.128Z",
      "lastUpdated": "2024-07-01",
      "noticePeriod": 1,
      "term": 1,
      "renewalTerm": 1,
      "isAutoRenewed": true,
      "orderType": "Subscription",
      "termType": "Termed",
      "orderPaymentMethod": "Invoice",
      "invoiceSeparatly": true,
      "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": "Monthly",
      "setOrderBillingPeriod": true,
      "invoiceBatchGroup": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "description": "text"
      },
      "paymentTerm": "text",
      "useAccountInvoiceBatchGroup": true,
      "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": 1,
          "name": "text",
          "charges": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "chargeNumber": "OPC-000001",
              "version": 1,
              "isLastVersion": true,
              "name": "text",
              "chargeType": "OneOff",
              "priceModel": "Flat",
              "effectiveStartDate": "2025-04-27T17:04:22.128Z",
              "effectiveEndDate": "2025-04-27T17:04:22.128Z",
              "quantity": 1,
              "unitCode": "text",
              "startOn": "AlignToSubscription",
              "endOn": "AlignToSubscription",
              "chargedThroughDate": "2025-04-27T17:04:22.128Z",
              "lastRenewalDate": "2025-04-27T17:04:22.128Z",
              "lastPriceAdjustmentDate": "2025-04-27T17:04:22.128Z",
              "pricePeriod": "Monthly",
              "usageRating": "Sum",
              "revenueRecognitionRule": "text",
              "billingDay": "None",
              "specificBillingDay": 1,
              "billingPeriod": "Monthly",
              "billingTiming": "InAdvance",
              "periodAlignment": "None",
              "alignmentDate": "2025-04-27T17:04:22.128Z",
              "taxTemplate": "text",
              "taxIncluded": true,
              "createInvoiceLinesPerTier": true,
              "estimatedUsage": 1,
              "estimatedQuantity": 1,
              "remainingQuantity": 1,
              "orderedQuantity": 1,
              "remarks": "text",
              "accountsReceivableAccount": "text",
              "deferredRevenueAccount": "text",
              "recognizedRevenueAccount": "text",
              "changeState": "NotChanged",
              "displayPrice": 1,
              "customFields": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "priceDetails": [
                {
                  "tier": 1,
                  "price": 1,
                  "listPrice": 1,
                  "description": "text",
                  "fromQuantity": 1,
                  "toQuantity": 1,
                  "priceBase": "Flat",
                  "lineDiscountPercent": 1,
                  "lineDiscountAmount": 1
                }
              ],
              "recurringMonthlyAmount": 1,
              "recurringMonthlyAmountBase": 1,
              "features": [
                {
                  "code": "text",
                  "description": "text"
                }
              ],
              "orderDiscounts": [
                {
                  "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                  "chargeId": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "externalERPId": "text",
              "externalCRMId": "text",
              "cmrr": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "acv": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "tcv": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "emrr": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "oneTimeFees": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
              "orderId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000",
              "created": "2025-04-27T17:04:22.128Z",
              "modified": "2025-04-27T17:04:22.128Z"
            }
          ],
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "created": "2025-04-27T17:04:22.128Z",
          "modified": "2025-04-27T17:04:22.128Z"
        }
      ],
      "milestones": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "milestoneDate": "2025-04-27T17:04:22.128Z",
          "plannedDate": "2025-04-27T17:04:22.128Z"
        }
      ],
      "orderDiscounts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "startOn": "AlignToOrder",
          "endOn": "AlignToOrder",
          "startDate": "2025-04-27T17:04:22.128Z",
          "endDate": "2025-04-27T17:04:22.128Z",
          "percent": 1,
          "discountType": "Percent",
          "orderProductCharges": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "onSpecificCharges": true
        }
      ],
      "currency": "text",
      "externalERPId": "text",
      "externalCRMId": "text",
      "currencyCodeToUseWhenInvoice": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-04-27T17:04:22.128Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ]
}

Get Account invoices.

get
Authorizations
Path parameters
idstring · uuidRequired

Account id

Query parameters
FilterstringOptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20
OrderBystringOptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 03/01/2025 00:00:00
ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'invoiceLines' and 'customFields' on these entities

Example: 03/01/2025 00:00:00
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
mappedResponseFlagbooleanOptionalDefault: false
Header parameters
api-versionstringOptional
Responses
get
GET /Accounts/{id}/Invoices HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "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": "Draft",
      "account": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "notes": "text",
      "invoiceDate": "2025-04-27T17:04:22.128Z",
      "dueDate": "2025-04-27T17:04:22.128Z",
      "paymentDate": "2025-04-27T17:04:22.128Z",
      "lastPaymentDate": "2025-04-27T17:04:22.128Z",
      "daysPastDue": 1,
      "nrOfReminders": 1,
      "paymentTerm": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "days": 1,
        "name": "text"
      },
      "currency": "text",
      "subtotal": 1,
      "tax": 1,
      "totalAmount": 1,
      "totalRoundingAmount": 1,
      "settledAmount": 1,
      "balancedAmount": 1,
      "taxIncluded": true,
      "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": 1,
          "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": 1,
          "unitOfMeasure": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "unitCode": "text",
            "name": "text",
            "displayName": "text"
          },
          "price": 1,
          "subtotal": 1,
          "total": 1,
          "tax": 1,
          "subtotalPreDiscount": 1,
          "totalPreDiscount": 1,
          "taxPreDiscount": 1,
          "servicePeriodStartDate": "2025-04-27T17:04:22.128Z",
          "servicePeriodEndDate": "2025-04-27T17:04:22.128Z",
          "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",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "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": "2025-04-27T17:04:22.128Z",
          "modified": "2025-04-27T17:04:22.128Z",
          "taxCategoryName": "text",
          "taxRate": 1
        }
      ],
      "latestOnlinePaymentLogs": [
        {
          "failedPayment": true,
          "paymentDescription": "text",
          "timeStamp": "2025-04-27T17:04:22.128Z",
          "payoutId": "text",
          "isPayout": true,
          "paymentIntentId": "text"
        }
      ],
      "onlinePaymentStatus": "None",
      "yourReference": "text",
      "ourReference": "text",
      "yourOrderNumber": "text",
      "buyerReference": "text",
      "invoiceType": "Invoice",
      "ocrNumber": "text",
      "sendMethod": "text",
      "exchangeRate": 1,
      "settledNotes": "text",
      "invoiceDeliveryMethod": "Email",
      "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "disableAutomaticInvoiceReminder": true,
      "onlinePaymentLink": "text",
      "accountsReceivable": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-04-27T17:04:22.128Z",
      "modified": "2025-04-27T17:04:22.128Z"
    }
  ]
}

Get Account SalesOrders.

get
Authorizations
Path parameters
idstring · uuidRequired
Query parameters
FilterstringOptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20
OrderBystringOptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 03/01/2025 00:00:00
ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'orderProducts', 'orderCharges', 'chargeDetails', 'orderDiscounts', 'milestones' and 'customFields' on these entities

Example: 03/01/2025 00:00:00
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
get
GET /Accounts/{id}/SalesOrders HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "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": 1,
      "isLastVersion": true,
      "status": "Draft",
      "description": "text",
      "remarks": "text",
      "orderDate": "2025-04-27T17:04:22.128Z",
      "created": "2025-04-27T17:04:22.128Z",
      "modified": "2025-04-27T17:04:22.128Z",
      "lastUpdated": "2025-04-27T17:04:22.128Z",
      "orderType": "Subscription",
      "invoiceSeparatly": true,
      "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": "Invoice",
      "invoiceBatchGroup": "text",
      "useAccountInvoiceBatchGroup": true,
      "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": 1,
          "name": "text",
          "charges": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "chargeNumber": "OPC-000001",
              "version": 1,
              "isLastVersion": true,
              "name": "text",
              "chargeType": "OneOff",
              "priceModel": "Flat",
              "effectiveStartDate": "2025-04-27T17:04:22.128Z",
              "effectiveEndDate": "2025-04-27T17:04:22.128Z",
              "quantity": 1,
              "unitCode": "text",
              "startOn": "AlignToSubscription",
              "endOn": "AlignToSubscription",
              "chargedThroughDate": "2025-04-27T17:04:22.128Z",
              "lastRenewalDate": "2025-04-27T17:04:22.128Z",
              "lastPriceAdjustmentDate": "2025-04-27T17:04:22.128Z",
              "pricePeriod": "Monthly",
              "usageRating": "Sum",
              "revenueRecognitionRule": "text",
              "billingDay": "None",
              "specificBillingDay": 1,
              "billingPeriod": "Monthly",
              "billingTiming": "InAdvance",
              "periodAlignment": "None",
              "alignmentDate": "2025-04-27T17:04:22.128Z",
              "taxTemplate": "text",
              "taxIncluded": true,
              "createInvoiceLinesPerTier": true,
              "estimatedUsage": 1,
              "estimatedQuantity": 1,
              "remainingQuantity": 1,
              "orderedQuantity": 1,
              "remarks": "text",
              "accountsReceivableAccount": "text",
              "deferredRevenueAccount": "text",
              "recognizedRevenueAccount": "text",
              "changeState": "NotChanged",
              "displayPrice": 1,
              "customFields": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "priceDetails": [
                {
                  "tier": 1,
                  "price": 1,
                  "listPrice": 1,
                  "description": "text",
                  "fromQuantity": 1,
                  "toQuantity": 1,
                  "priceBase": "Flat",
                  "lineDiscountPercent": 1,
                  "lineDiscountAmount": 1
                }
              ],
              "recurringMonthlyAmount": 1,
              "recurringMonthlyAmountBase": 1,
              "features": [
                {
                  "code": "text",
                  "description": "text"
                }
              ],
              "orderDiscounts": [
                {
                  "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                  "chargeId": "123e4567-e89b-12d3-a456-426614174000"
                }
              ],
              "externalERPId": "text",
              "externalCRMId": "text",
              "cmrr": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "acv": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "tcv": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "emrr": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "oneTimeFees": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-04-27T17:04:22.128Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
              "orderId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000",
              "created": "2025-04-27T17:04:22.128Z",
              "modified": "2025-04-27T17:04:22.128Z"
            }
          ],
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-04-27T17:04:22.128Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "created": "2025-04-27T17:04:22.128Z",
          "modified": "2025-04-27T17:04:22.128Z"
        }
      ],
      "milestones": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "milestoneDate": "2025-04-27T17:04:22.128Z",
          "plannedDate": "2025-04-27T17:04:22.128Z"
        }
      ],
      "orderDiscounts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "startOn": "AlignToOrder",
          "endOn": "AlignToOrder",
          "startDate": "2025-04-27T17:04:22.128Z",
          "endDate": "2025-04-27T17:04:22.128Z",
          "percent": 1,
          "discountType": "Percent",
          "orderProductCharges": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "onSpecificCharges": true
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "invoicingCurrency": "text"
    }
  ]
}

Get Summery and invoicing metrics for account.

get
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
get
GET /Accounts/{id}/Summary HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "accountBalance": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-04-27T17:04:22.128Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "lastInvoiced": "2025-04-27T17:04:22.128Z",
  "name": "text",
  "accountNumber": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalERPId": "text",
  "externalCRMId": "text"
}
PreviousAPI 2.1NextBookings

Last updated

Was this helpful?