Younium Developer Portal
  • Welcome
  • Get started
  • API:s
    • API 2.0
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Documenttemplate
      • Exchangerate
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Paymentterms
      • Products
      • Quotes
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
    • API 2.1
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Customfieldconfigurations
      • Documenttemplate
      • Exchangerate
      • Invoicebatches
      • Invoicebatchgroups
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Payments
      • Paymentterms
      • Products
      • Quotes
      • Reports
      • Revenueschedule
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
  • Documentation
    • Developer resources
    • Invoice operations
    • Product guide
    • Webhooks
    • Idempotent requests
  • Sandbox
Powered by GitBook
On this page

Was this helpful?

  1. API:s
  2. API 2.0

Usage

PreviousUnitofmeasurementsNextWebhooks

Last updated 5 months ago

Was this helpful?

Delete Usage

delete
Authorizations
Path parameters
idstring · uuidrequired
Header parameters
api-versionstringoptional
Responses
application/json
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
Authorizations
Path parameters
idstring · uuidrequired
Header parameters
api-versionstringoptional
Responses
application/json
application/json
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-03-24T23:19:24.482Z",
  "toDate": "2025-03-24T23:19:24.482Z",
  "quantity": 1,
  "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": "2025-03-24T23:19:24.482Z",
  "processed": true,
  "ratedPrice": 1,
  "ratedPriceCurrencyCode": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created": "2025-03-24T23:19:24.482Z",
  "modified": "2025-03-24T23:19:24.482Z"
}

Success

  • POSTCreate Usage
  • GET/Usage
  • PATCHUpdate Usage
  • DELETEDelete Usage
  • GETGet Usage by Id
  • POSTImport Usage
get
Authorizations
Query parameters
Skipinteger · int32optional

Skip number of records

Example: 10
Takeinteger · int32optional

Take number of records

Example: 5
Filterstringoptional

Filter the resulsts. See ODATA documentation for more information

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

Sorting the results. See ODATA specificaion for more information

Example: name
Header parameters
api-versionstringoptional
Responses
application/json
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-03-24T23:19:24.482Z",
    "toDate": "2025-03-24T23:19:24.482Z",
    "quantity": 1,
    "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": "2025-03-24T23:19:24.482Z",
    "processed": true,
    "ratedPrice": 1,
    "ratedPriceCurrencyCode": "text",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created": "2025-03-24T23:19:24.482Z",
    "modified": "2025-03-24T23:19:24.482Z"
  }
]

Success

Create Usage

post
Authorizations
Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Body
all ofoptional

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.younium.com/Usage' \
  --header 'Content-Type: application/json' \
  --data '{
    "account": "A-000001",
    "order": "O-000001",
    "product": "OP-000001",
    "charge": "OPC-000001",
    "unit": "pcs",
    "quantity": 1,
    "description": "text",
    "fromDate": "2025-03-24T23:19:24.482Z",
    "toDate": "2025-03-24T23:19:24.482Z",
    "source": "text",
    "ratedPrice": 1,
    "ratedPriceCurrency": "text",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "validateData": true
  }'
201
400
401
403
No body

Created

Update Usage

patch
Authorizations
Path parameters
idstring · uuidrequired
Header parameters
api-versionstringoptional
Body
all ofoptional

Responses
application/json
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 '{
    "unit": "pcs",
    "quantity": 1,
    "description": "text",
    "fromDate": "2025-03-24T23:19:24.482Z",
    "ratedPrice": 1,
    "ratedPriceCurrency": "text",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }'
204
400
401
403
404
No body

No Content

Import Usage

post

Import Usage Data in csv or json format.

Authorizations
Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Body
all ofoptional

Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.younium.com/Usage/import' \
  --header 'Content-Type: application/json' \
  --data '{
    "mappingTemplateName": "text",
    "dateFormat": "text",
    "decimalSeparator": "text",
    "dataFormat": "text",
    "batchName": "text",
    "data": null,
    "usePreprocessingRules": true,
    "allowDuplicateEntries": true,
    "breakOnValidationError": true
  }'
200
400
401
403
{
  "importDataType": "text",
  "batchId": "123e4567-e89b-12d3-a456-426614174000",
  "hasErrors": true,
  "errors": []
}

Success