Skip to content

Financial Reports

Operations Summary

Method Endpoint Description
GET /api/financial-reports/ List Financial Reports
GET /api/financial-reports/{uuid}/ Retrieve

List Financial Reports

1
2
3
4
http \
  GET \
  https://api.example.com/api/financial-reports/ \
  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.financial_reports import financial_reports_list # (1)

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

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

try {
  const response = await financialReportsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
abbreviation string
agreement_number string
archived boolean
backend_id string
contact_details string
name string
name_exact string
native_name string
o string Which field to use when ordering the results.
organization_group_name string
organization_group_uuid array organization_group_uuid
owned_by_current_user boolean Return a list of customers where current user is owner.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
registration_code string

200 -

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

Field Type
name string
uuid string (uuid)
abbreviation string
created string (date-time)
accounting_start_date string (date-time)
registration_code string
agreement_number string
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
billing_price_estimate any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/financial-reports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  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.financial_reports import financial_reports_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = financial_reports_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

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

try {
  const response = await financialReportsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
name string
uuid string (uuid)
abbreviation string
created string (date-time)
accounting_start_date string (date-time)
registration_code string
agreement_number string
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
billing_price_estimate any