Usage

PreviousUnitofmeasurements NextWebhooks

Last updated 3 months ago

Was this helpful?

Create Usage

post

/Usage

Authorizations

Header parameters

api-versionstring

Body

quantitynumber · double

descriptionstring | nullable

fromDatestring · date-timerequired

toDatestring · date-time | nullable

sourcestring | nullable

ratedPricenumber · double | nullable

ratedPriceCurrencystring | nullable

validateDataboolean

customFieldsobject | nullable

accountall of | nullable

Allowed as string input: AccountNumber, Account-Id, Name.

Example: A-000001

orderall of | nullable

Allowed as string input: OrderNumber, Order-Id.

Example: O-000001

productall of | nullable

Allowed as string input: ProductNumber, OrderProduct-Id.

Example: OP-000001

chargeall of | nullable

Allowed as string input: ChargeNumber, OrderProductCharge-Id.

Example: OPC-000001

unitall of | nullable

Allowed as string input: Unit.

Example: pcs

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Usage' \
  --header 'Content-Type: application/json' \
  --data '{"fromDate":"2025-02-22T08:41:49.334Z","customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"account":"A-000001","order":"O-000001","product":"OP-000001","charge":"OPC-000001","unit":"pcs"}'

201

400

401

403

No body

Created

get

/Usage

Authorizations

Query parameters

Skipinteger · int32

Skip number of records

Example: 10

Takeinteger · int32

Take number of records

Example: 5

Filterstring

Filter the resulsts. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

Sortstring

Sorting the results. See ODATA specificaion for more information

Example: name

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "fromDate": "2025-02-22T08:41:49.334Z",
    "toDate": "2025-02-22T08:41:49.334Z",
    "quantity": 1,
    "unit": "text",
    "source": "text",
    "importDate": "2025-02-22T08:41:49.334Z",
    "processed": true,
    "ratedPrice": 1,
    "ratedPriceCurrencyCode": "text",
    "created": "2025-02-22T08:41:49.334Z",
    "modified": "2025-02-22T08:41:49.334Z",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "account": {
      "name": "text",
      "accountNumber": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text"
    },
    "order": {
      "orderNumber": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text"
    },
    "product": {
      "description": "text",
      "productNumber": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text"
    },
    "charge": {
      "name": "text",
      "chargeNumber": "OPC-000001",
      "description": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text"
    }
  }
]

Success

Update Usage

patch

/Usage/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

quantitynumber · double | nullable

descriptionstring | nullable

fromDatestring · date-time | nullable

ratedPricenumber · double | nullable

ratedPriceCurrencystring | nullable

customFieldsobject | nullable

unitall of | nullable

Allowed as string input: Unit.

Example: pcs

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Usage/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"unit":"pcs"}'

204

400

401

403

404

No body

No Content

Delete Usage

delete

/Usage/{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/Usage/{id}'

200

400

401

403

404

No body

Success

Get Usage by Id

get

/Usage/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "fromDate": "2025-02-22T08:41:49.334Z",
  "toDate": "2025-02-22T08:41:49.334Z",
  "quantity": 1,
  "unit": "text",
  "source": "text",
  "importDate": "2025-02-22T08:41:49.334Z",
  "processed": true,
  "ratedPrice": 1,
  "ratedPriceCurrencyCode": "text",
  "created": "2025-02-22T08:41:49.334Z",
  "modified": "2025-02-22T08:41:49.334Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "account": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "order": {
    "orderNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "product": {
    "description": "text",
    "productNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "charge": {
    "name": "text",
    "chargeNumber": "OPC-000001",
    "description": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  }
}

Success

Import Usage

Import Usage Data in csv or json format.

post

/Usage/import

Authorizations

Header parameters

api-versionstring

Body

dataanyrequired

mappingTemplateNamestring · min: 1required

dateFormatstring | nullable

decimalSeparatorstring | nullable

dataFormatstring | nullable

batchNamestring | nullable

usePreprocessingRulesboolean

allowDuplicateEntriesboolean

breakOnValidationErrorboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Usage/import' \
  --header 'Content-Type: application/json' \
  --data '{"data":null,"mappingTemplateName":"text"}'

200

400

401

403

{
  "importDataType": "text",
  "batchId": "123e4567-e89b-12d3-a456-426614174000",
  "hasErrors": true,
  "errors": []
}

Success