Usage

Create Usage

POSThttps://api.younium.com/Usage

Authorization

oauth2

Header parameters

Body

application/json

accountnullable all of

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

Example: "A-000001"

ordernullable all of

Allowed as string input: OrderNumber, Order-Id.

Example: "O-000001"

productnullable all of

Allowed as string input: ProductNumber, OrderProduct-Id.

Example: "OP-000001"

chargenullable all of

Allowed as string input: ChargeNumber, OrderProductCharge-Id.

Example: "OPC-000001"

unitnullable all of

Allowed as string input: Unit.

Example: "pcs"

quantitynumber (double)

descriptionnullable string

fromDate*string (date-time)

toDatenullable string (date-time)

sourcenullable string

ratedPricenullable number (double)

ratedPriceCurrencynullable string

customFieldsnullable object

validateDataboolean

Response

201400401403

Created

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Usage', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fromDate": "2024-12-22T02:13:26.397Z"
    }),
});
const data = await response.json();

Response

400

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

GEThttps://api.younium.com/Usage

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

idstring (uuid)

descriptionnullable string

fromDatestring (date-time)

toDatenullable string (date-time)

quantitynumber (double)

unitnullable string

sourcenullable string

accountnullable all of

ordernullable all of

productnullable all of

chargenullable all of

importDatestring (date-time)

processedboolean

ratedPricenullable number (double)

ratedPriceCurrencyCodenullable string

customFieldsnullable object

createdstring (date-time)

modifiedstring (date-time)

Request

JavaScriptCurlPython

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

Response

200400

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "fromDate": "2024-12-22T02:13:26.397Z",
    "toDate": "2024-12-22T02:13:26.397Z",
    "quantity": 0,
    "unit": "text",
    "source": "text",
    "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"
    },
    "importDate": "2024-12-22T02:13:26.397Z",
    "processed": false,
    "ratedPrice": 0,
    "ratedPriceCurrencyCode": "text",
    "created": "2024-12-22T02:13:26.397Z",
    "modified": "2024-12-22T02:13:26.397Z"
  }
]

Update Usage

PATCHhttps://api.younium.com/Usage/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

unitnullable all of

Allowed as string input: Unit.

Example: "pcs"

quantitynullable number (double)

descriptionnullable string

fromDatenullable string (date-time)

ratedPricenullable number (double)

ratedPriceCurrencynullable string

customFieldsnullable object

Response

204400401403404

No Content

Request

JavaScriptCurlPython

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

Response

400404

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

Delete Usage

DELETEhttps://api.younium.com/Usage/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

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

Response

400404

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

Get Usage by Id

GEThttps://api.younium.com/Usage/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

descriptionnullable string

fromDatestring (date-time)

toDatenullable string (date-time)

quantitynumber (double)

unitnullable string

sourcenullable string

accountnullable all of

ordernullable all of

productnullable all of

chargenullable all of

importDatestring (date-time)

processedboolean

ratedPricenullable number (double)

ratedPriceCurrencyCodenullable string

customFieldsnullable object

createdstring (date-time)

modifiedstring (date-time)

Request

JavaScriptCurlPython

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

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "fromDate": "2024-12-22T02:13:26.397Z",
  "toDate": "2024-12-22T02:13:26.397Z",
  "quantity": 0,
  "unit": "text",
  "source": "text",
  "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"
  },
  "importDate": "2024-12-22T02:13:26.397Z",
  "processed": false,
  "ratedPrice": 0,
  "ratedPriceCurrencyCode": "text",
  "created": "2024-12-22T02:13:26.397Z",
  "modified": "2024-12-22T02:13:26.397Z"
}

Import Usage

Import Usage Data in csv or json format.

POSThttps://api.younium.com/Usage/import

Authorization

oauth2

Header parameters

Body

application/json

mappingTemplateName*string

dateFormatnullable string

decimalSeparatornullable string

dataFormatnullable string

batchNamenullable string

data*any

usePreprocessingRulesboolean

allowDuplicateEntriesboolean

breakOnValidationErrorboolean

Response

200400401403

Success

Body

application/json

importDataTypenullable string

batchIdnullable string (uuid)

hasErrorsboolean

errorsnullable array of any

Request

JavaScriptCurlPython

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

Response

200400

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

---