Skip to content

Provider Invoice Items

Operations Summary

Method Endpoint Description
GET /api/provider-invoice-items/ List Provider Invoice Items
GET /api/provider-invoice-items/{id}/ Retrieve

List Provider Invoice Items

1
2
3
4
http \
  GET \
  https://api.example.com/api/provider-invoice-items/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.provider_invoice_items import provider_invoice_items_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = provider_invoice_items_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: provider_invoice_items_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { providerInvoiceItemsList } from 'waldur-js-client';

try {
  const response = await providerInvoiceItemsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid) Customer UUID
invoice_month integer Invoice month
invoice_year integer Invoice year
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
name string
price number (double)
tax string (decimal)
total string (decimal)
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
factor integer
measured_unit string
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.
article_code string
project_name string
project_uuid string (uuid)
quantity string (decimal)
details object
details.resource_name string Name of the marketplace resource
details.resource_uuid string (uuid) UUID of the marketplace resource
details.plan_name string Name of the pricing plan
details.plan_uuid string (uuid) UUID of the pricing plan
details.offering_type string Type of the offering
details.offering_name string Name of the offering
details.offering_uuid string (uuid) UUID of the offering
details.service_provider_name string Name of the service provider
details.service_provider_uuid string (uuid) UUID of the service provider
details.plan_component_id integer ID of the plan component
details.offering_component_type string Type of the offering component
details.offering_component_name string Name of the offering component
details.resource_limit_periods array of objects List of resource limit periods for this invoice item
details.resource_limit_periods.start string Start date of the resource limit period
details.resource_limit_periods.end string End date of the resource limit period
details.resource_limit_periods.quantity integer Quantity of resources consumed during this period
details.resource_limit_periods.billing_periods integer Number of billing periods
details.resource_limit_periods.total string Total amount for this period
resource string (uri)
resource_uuid string (uuid)
resource_name string
billing_type string
backend_uuid string (uuid)
credit boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/provider-invoice-items/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.provider_invoice_items import provider_invoice_items_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = provider_invoice_items_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: provider_invoice_items_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { providerInvoiceItemsRetrieve } from 'waldur-js-client';

try {
  const response = await providerInvoiceItemsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this invoice item.

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
price number (double)
tax string (decimal)
total string (decimal)
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
factor integer
measured_unit string
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.
article_code string
project_name string
project_uuid string (uuid)
quantity string (decimal)
details object
details.resource_name string Name of the marketplace resource
details.resource_uuid string (uuid) UUID of the marketplace resource
details.plan_name string Name of the pricing plan
details.plan_uuid string (uuid) UUID of the pricing plan
details.offering_type string Type of the offering
details.offering_name string Name of the offering
details.offering_uuid string (uuid) UUID of the offering
details.service_provider_name string Name of the service provider
details.service_provider_uuid string (uuid) UUID of the service provider
details.plan_component_id integer ID of the plan component
details.offering_component_type string Type of the offering component
details.offering_component_name string Name of the offering component
details.resource_limit_periods array of objects List of resource limit periods for this invoice item
details.resource_limit_periods.start string Start date of the resource limit period
details.resource_limit_periods.end string End date of the resource limit period
details.resource_limit_periods.quantity integer Quantity of resources consumed during this period
details.resource_limit_periods.billing_periods integer Number of billing periods
details.resource_limit_periods.total string Total amount for this period
resource string (uri)
resource_uuid string (uuid)
resource_name string
billing_type string
backend_uuid string (uuid)
credit boolean