Accounts

PreviousAPI 2.1 NextBookings

Last updated 3 months ago

Was this helpful?

Get Account by id.

Requires permission Account View.

get

/Accounts/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Accounts/{id}'

200

400

401

403

404

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

Success

Edit Account

patch

/Accounts/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

namestring | nullable

ourReferencestring | nullable

yourReferencestring | nullable

invoiceEmailAddressstring | nullable

reminderEmailAddressstring | nullable

invoiceEmailCcAddressesstring | nullable

taxRegistrationNumberstring | nullable

organizationNumberstring | nullable

electronicInvoiceAddressstring | nullable

electronicInvoiceAddressSchemestring | nullable

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

Example: 0007

inactiveboolean

imageUrlstring | nullable

domainstring | nullable

invoiceTemplateIdstring · uuid | nullable

invoiceBatchGroupIdstring · uuid | nullableDeprecated

externalERPIdstring | nullable

externalCRMIdstring | nullable

customFieldsobject | nullable

accountTypeall of | nullable

currencyall of | nullable

Allowed as string input: Code, Currency-Id.

Example: SEK

invoiceDeliveryMethodall of | nullable

defaultPaymentTermall of | nullable

Allowed as string input: Name, PaymentTerm-Id.

Example: NET30

taxTemplateall of | nullable

Allowed as string input: Name, TaxTemplate-Id.

Example: Sweden standard

accountsReceivableall of | nullable

Allowed as string input: Code, FinancialAccount-Id.

Example: 1510

invoiceBatchGroupall of | nullable

invoiceSettingGroupall of | nullable

defaultInvoiceAddressall of | nullable

defaultDeliveryAddressall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Accounts/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"electronicInvoiceAddressScheme":"0007","customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"accountType":"Customer","currency":"SEK","invoiceDeliveryMethod":"Email","defaultPaymentTerm":"NET30","taxTemplate":"Sweden standard","accountsReceivable":"1510","invoiceBatchGroup":{},"invoiceSettingGroup":{},"defaultInvoiceAddress":{"country":"Sweden"},"defaultDeliveryAddress":{"country":"Sweden"}}'

200

400

401

403

No body

Success

Get Accounts.

Requires permission Account View.

get

/Accounts

Authorizations

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

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

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

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

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Accounts'

200

400

401

403

{
  "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",
      "inactive": true,
      "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",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-02-22T08:38:59.725Z",
      "modified": "2025-02-22T08:38:59.725Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "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"
        }
      ],
      "accountType": "Customer",
      "invoiceDeliveryMethod": "Email",
      "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"
      },
      "onlinePaymentDetails": {
        "created": "2025-02-22T08:38:59.725Z",
        "modified": "2025-02-22T08:38:59.725Z",
        "stripeCustomerId": "text",
        "stripePaymentMethodId": "text"
      },
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:38:59.725Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:38:59.725Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:38:59.725Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:38:59.725Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:38:59.725Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ]
}

Success

Create Account

post

/Accounts

Authorizations

Header parameters

api-versionstring

Body

namestring · min: 1required

ourReferencestring | nullable

yourReferencestring | nullable

invoiceEmailAddressstring | nullable

invoiceEmailCcAddressesstring | nullable

taxRegistrationNumberstring | nullable

organizationNumberstring | nullable

electronicInvoiceAddressstring | nullable

electronicInvoiceAddressSchemestring | nullable

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

Example: 0007

inactiveboolean

imageUrlstring | nullable

domainstring | nullable

invoiceTemplateIdstring · uuid | nullable

invoiceBatchGroupIdstring · uuid | nullableDeprecated

reminderEmailAddressstring | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

customFieldsobject | nullable

accountTypeall of | nullable

currencyall ofrequired

Allowed as string input: Code, Currency-Id.

Example: SEK

invoiceDeliveryMethodall of | nullable

defaultPaymentTermall of | nullable

Allowed as string input: Name, PaymentTerm-Id.

Example: NET30

taxTemplateall of | nullable

Allowed as string input: Name, TaxTemplate-Id.

Example: Sweden standard

accountsReceivableall of | nullable

Allowed as string input: Code, FinancialAccount-Id.

Example: 1510

invoiceBatchGroupall of | nullable

invoiceSettingGroupall of | nullable

defaultInvoiceAddressall of | nullable

defaultDeliveryAddressall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Accounts' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","electronicInvoiceAddressScheme":"0007","customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"accountType":"Customer","currency":"SEK","invoiceDeliveryMethod":"Email","defaultPaymentTerm":"NET30","taxTemplate":"Sweden standard","accountsReceivable":"1510","invoiceBatchGroup":{},"invoiceSettingGroup":{},"defaultInvoiceAddress":{"country":"Sweden"},"defaultDeliveryAddress":{"country":"Sweden"}}'

201

400

401

403

No body

Created

Create OnlinePaymentDetails for Account

post

/Accounts/OnlinePaymentDetails/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

stripeCustomerIdstring | nullable

stripePaymentMethodIdstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Accounts/OnlinePaymentDetails/{id}' \
  --header 'Content-Type: application/json'

201

400

401

403

No body

The OnlineDetailsPayment for the request.

Edit OnlinePaymentDetails on Account

patch

/Accounts/OnlinePaymentDetails/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

stripeCustomerIdstring | nullable

stripePaymentMethodIdstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Accounts/OnlinePaymentDetails/{id}' \
  --header 'Content-Type: application/merge-patch+json'

204

400

401

403

404

No body

No Content

Delete OnlinePaymentDetails on Account

delete

/Accounts/OnlinePaymentDetails/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.younium.com/Accounts/OnlinePaymentDetails/{id}'

200

400

401

403

404

No body

Success

Delete Account

delete

/Accounts/{accountId}

Authorizations

Path parameters

accountIdstring · uuidrequired

The identifier of the account

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.younium.com/Accounts/{accountId}'

200

400

401

403

404

No body

Success

Get Account subscriptions.

get

/Accounts/{id}/Subscriptions

Authorizations

Path parameters

idstring · uuidrequired

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

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

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

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

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Accounts/{id}/Subscriptions'

200

400

401

403

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

Success

Get Account invoices.

get

/Accounts/{id}/Invoices

Authorizations

Path parameters

idstring · uuidrequired

Account id

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

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

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

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

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

mappedResponseFlagboolean

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Accounts/{id}/Invoices'

200

400

401

403

{
  "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",
      "notes": "text",
      "invoiceDate": "2025-02-22T08:38:59.725Z",
      "dueDate": "2025-02-22T08:38:59.725Z",
      "paymentDate": "2025-02-22T08:38:59.725Z",
      "lastPaymentDate": "2025-02-22T08:38:59.725Z",
      "daysPastDue": 1,
      "nrOfReminders": 1,
      "currency": "text",
      "subtotal": 1,
      "tax": 1,
      "totalAmount": 1,
      "totalRoundingAmount": 1,
      "settledAmount": 1,
      "balancedAmount": 1,
      "taxIncluded": true,
      "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
      "yourReference": "text",
      "ourReference": "text",
      "yourOrderNumber": "text",
      "buyerReference": "text",
      "ocrNumber": "text",
      "sendMethod": "text",
      "exchangeRate": 1,
      "settledNotes": "text",
      "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "disableAutomaticInvoiceReminder": true,
      "onlinePaymentLink": "text",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-02-22T08:38:59.725Z",
      "modified": "2025-02-22T08:38:59.725Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "invoiceLines": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "invoiceLineNumber": 1,
          "productNumber": "text",
          "productName": "text",
          "chargeDescription": "text",
          "chargeNumber": "text",
          "quantity": 1,
          "price": 1,
          "subtotal": 1,
          "total": 1,
          "tax": 1,
          "subtotalPreDiscount": 1,
          "totalPreDiscount": 1,
          "taxPreDiscount": 1,
          "servicePeriodStartDate": "2025-02-22T08:38:59.725Z",
          "servicePeriodEndDate": "2025-02-22T08:38:59.725Z",
          "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",
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2025-02-22T08:38:59.725Z",
          "modified": "2025-02-22T08:38:59.725Z",
          "taxCategoryName": "text",
          "taxRate": 1,
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "charge": {
            "name": "text",
            "chargeNumber": "OPC-000001",
            "description": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "unitOfMeasure": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "unitCode": "text",
            "name": "text",
            "displayName": "text"
          },
          "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"
          }
        }
      ],
      "latestOnlinePaymentLogs": [
        {
          "failedPayment": true,
          "paymentDescription": "text",
          "timeStamp": "2025-02-22T08:38:59.725Z",
          "payoutId": "text",
          "isPayout": true,
          "paymentIntentId": "text"
        }
      ],
      "status": "Draft",
      "account": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "paymentTerm": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "days": 1,
        "name": "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"
      },
      "onlinePaymentStatus": "None",
      "invoiceType": "Invoice",
      "invoiceDeliveryMethod": "Email",
      "accountsReceivable": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      }
    }
  ]
}

Success

Get Account SalesOrders.

get

/Accounts/{id}/SalesOrders

Authorizations

Path parameters

idstring · uuidrequired

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

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

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

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

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Accounts/{id}/SalesOrders'

200

400

401

403

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

Success

Get Summery and invoicing metrics for account.

get

/Accounts/{id}/Summary

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Accounts/{id}/Summary'

200

400

401

403

404

{
  "lastInvoiced": "2025-02-22T08:38:59.725Z",
  "name": "text",
  "accountNumber": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalERPId": "text",
  "externalCRMId": "text",
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:38:59.725Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:38:59.725Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:38:59.725Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:38:59.725Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:38:59.725Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "accountBalance": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:38:59.725Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Success