API Reference

Wrapper around the python requests module for ease of interaction with all CloudCIX services

Basic usage: cloudcix.api.<application>.<service>.<method>

More detailed usage information will be available under each of the above terms

To see even more details about the API you can visit our HTTP API Reference

To see more information about the various methods (list, read, etc.), see the Client page

For examples of a call for each of these methods, see the Examples page

Note

Any service that implements the update method also implements the partial_update method, which does the same thing without needing to pass a full representation of the object, only the fields that need updating

App Manager

The App Manager Application is a software system that manages CloudCIX Apps

It allows Users to select and use apps, and allows Administrators to select which apps to deploy and give permissions to other Users.

Basic Usage: cloudcix.api.AppManager.<service>.<method>

Services

App

An App is a web Application available through CloudCIX website

Basic Usage: cloudcix.api.AppManager.app.<method>

Available Methods

cloudcix.api.AppManager.app.list
- Return a list of all Apps available.
cloudcix.api.AppManager.app.read
- Returns an App and its details if the Member invoking this method has the App associated

App Member Link

An App Member Link is an association between a Member and an App they are allowed to use

Basic Usage: cloudcix.api.AppManager.app_member.<method>

Available Methods

cloudcix.api.AppManager.app_member.create
- Create a link between the Member calling the method and the selected App
- This method can only be run be an Administrator
cloudcix.api.AppManager.app_member.delete
- Delete a link between the Member calling the method and the selected App
- This method can only be run be an Administrator

Menu Item User Link

An App Menu Item User Link is an association between a User and a Menu Item they’re allowed to use/see

Basic Usage: cloudcix.api.AppManager.menu_item_user.<method>

Available Methods:

cloudcix.api.AppManager.menu_item_user.list
- Returns a list of Menu Item IDs that the given User has associated.
- These items define the front end permissions for the given User
cloudcix.api.AppManager.menu_item_user.update
- Updates the front end permissions for a given User
- Only Administrators from the same Member are able to run this me
- This method can only be run be an Administrator

Asset

The Asset Application enables the management of Assets owned by a Member.

Examples of Assets are buildings, machinery, furniture, vehicles, etc.

Basic Usage: cloudcix.api.Asset.<service>.<method>

Services

Asset

This service handles the Assets of a Member

Basic Usage: cloudcix.api.Asset.asset.<method>

Available Methods

cloudcix.api.Asset.asset.list
- Returns a list of Assets owned by the acting Address of the User who makes the request
cloudcix.api.Asset.asset.create
- Allows a User to create a new Asset for its acting Address
cloudcix.api.Asset.asset.read
- Returns a given asset with all its details
cloudcix.api.Asset.asset.update
- Allows a User to update an Asset for its acting Address

Asset Transaction

This service allows the User to create relationships between Assets and Financial Transactions

An Asset Transaction describes an operation or transaction on an Asset, which can be a purchase, a sale, or a depreciation

Depreciation Type

This service allows the User to generate Depreciation Types for their Assets

A Depreciation Type is the percentage of value an Asset will lose for a period of time expressed in years until a certain date

Basic Usage: cloudcix.api.Asset.depreciation_type.<method>

Available Methods

cloudcix.api.Asset.depreciation_type.list
- Returns a list of all Depreciation Types associated with the Member of the User making the request
cloudcix.api.Asset.depreciation_type.create
- Allows the User to create a new Depreciation Type
cloudcix.api.Asset.depreciation_type.read
- Returns a given Depreciation Type with all its details
cloudcix.api.Asset.depreciation_type.update
- Allows a User to update a given Depreciation Type
cloudcix.api.Asset.depreciation_type.delete
- Allows a User to delete a Depreciation Type
- A Depcreciation Type can only be deleted if it is no longer associated with any Asset

Off Rent

This service allows the User to manage rentable Assets and return them from customers

The Asset must be set up as rentable in order to use this method.

The Asset must also be available and already on rent.

Every returned Asset will enter into the “for test” status

Basic Usage: cloudcix.api.Asset.off_rent.<method>

Available Methods

cloudcix.api.Asset.off_rent.list
- Returns a list of Off Rent transactions
cloudcix.api.Asset.off_rent.create
- Allows the User to create a record of an Asset being returned from a customer.
- These assets will automatically be entered into the “for test” state
cloudcix.api.Asset.off_rent.read
- Allows the User to get details about an Off Rent transaction
cloudcix.api.Asset.off_rent.update
- Allows the User to update some details about an Off Rent transaction

Off Test

This service allows the Users to manage their returned rentable Assets and take them out of the “for test” status

Basic Usage: cloudcix.api.Asset.off_test.<method>

Available Methods

cloudcix.api.Asset.off_test.list
- Returns a list of Off Test transactions
cloudcix.api.Asset.off_test.create
- Allows the User to create a record of an Asset that have finished testing and can be made rentable again
cloudcix.api.Asset.off_test.read
- Allows the User to get details about an Off Test transaction

Rent

This service allows the Users to manage rentable Assets and assign them to customers

The Asset must be set up as rentable in order to use this method

The Asset must also be available for rent, and not being tested or rented to another customer

Basic Usage: cloudcix.api.Asset.rent.<method>

Available Methods

cloudcix.api.Asset.rent.list
- Returns a list of Rent transactions
cloudcix.api.Asset.rent.create
- Allows the User to create a record of an Asset being rented to a customer
cloudcix.api.Asset.rent.read
- Allows the User to get details about a Rent transaction
cloudcix.api.Asset.rent.update
- Allows the User to update some details about a Rent transaction
- The details can only be changed if at least one of the associated Assets is still on rent.

Circuit

The Circuit Application allows for the management of circuits and devices. This Applicaton will be deprecated for DCIM.

Basic Usage: cloudcix.api.Circuit.<service>.<method>

Services

Circuit

This service allows Users to manage their Circuits

A Circuit is a device installed in your active Address

Basic Usage: cloudcix.api.Circuit.circuit.<method>

Available Methods

cloudcix.api.Circuit.circuit.list
- Returns a list of Circuits by owner, customer and supplier based on the User’s Address
cloudcix.api.Circuit.circuit.create
- This method allows the User to add a Circuit to a Circuit Class
cloudcix.api.Circuit.circuit.read
- This method allows the User to get the details of a given Circuit
- Only owners, customers and suppliers are allowed to read a Circuit
cloudcix.api.Circuit.circuit.update
- Allows the User to update a Circuit
cloudcix.api.Circuit.circuit.delete
- Allows the User to delete a Circuit
- If a Circuit has been removed but the User wants to maintain it in the list, it should be updated with a decommission date

Circuit Class

This service allows for the management of Circuit Classes

A Circuit Class is a classification for the Circuits

Basic Usage: cloudcix.api.Circuit.circuit_class.<method>

Available Methods

cloudcix.api.Circuit.circuit_class.list
- Returns a list of Circuit Classes and their supported Properties
cloudcix.api.Circuit.circuit_class.create
- Allows the User to create a new Circuit Class for its Member
cloudcix.api.Circuit.circuit_class.read
- Allows the User to get the details of a given Circuit Class
cloudcix.api.Circuit.circuit_class.update
- Allows the User to update a Circuit Class.
- If there are Circuits under the Circuit Class, new properties cannot be required and old properties cannot be removed or renamed

Property Type

This service is in place to offer a list of the supported Property Types

A Property Type is an identification of the expected input value for a given property.

Basic Usage: cloudcix.api.Circuit.property_type.<method>

Available Methods

cloudcix.api.Circuit.property_type.list
- Returns a list of Property Types

Property Value

This service allows to search Circuit objects properties dictionaries by the value sent in the request.

Basic Usage: cloudcix.api.Circuit.property_value.<method>

Available Methods

cloudcix.api.Circuit.property_value.list - Allows the User to list all properties of their Circuits where the queries search_term is included. - It will return a list of objects for each property value the term was included in, with reference keys to identify the Circuit. - This list will be alphabetical based on the value of the property.

Contact

The Contact Application is a CRM application that exposes a REST API to manage a shared address book between Users in the same Member

contact can be used as a sales and marketing tool or just as a general purpose address book.

It is also a management system for the management of your CloudCIX Chatbots

Basic Usage: cloudcix.api.Contact.<service>.<method>

Services

Auth

This service allows a User to authenticate a Contact in their Member to login to their Chatbots.

Basic Usage: cloudcix.api.contact.auth.<method>

Available Methods

cloudcix.api.contact.auth.create
- Returns a 200 if sent email and password are valid, otherwise a 400 status code is returned.

Campaign

This service allows for management of Campaigns

Campaigns are a many to many classification of contact

Basic Usage: cloudcix.api.contact.campaign.<method>

Available Methods

cloudcix.api.contact.campaign.list
- Returns a list of all Campaigns associated with the Member of the User calling this method
cloudcix.api.contact.campaign.create
- Allows the User to create a new Campaign record
cloudcix.api.contact.campaign.read
- Returns the details of one Campaign, including a list of contact belonging to that Campaign
cloudcix.api.contact.campaign.update
- Allows the User to update a Campaign record
cloudcix.api.contact.campaign.delete
- Allows the User to delete one Campaign record, which includes the links between the Campaign and any contact.

Campaign Contact

This service manages the many to many links between Campaigns and contact

Basic Usage: cloudcix.api.contact.campaign_contact.<method>

Available Methods

cloudcix.api.contact.campaign_contact.create
- Allows the User to create a relation between a Campaign and a Contact
cloudcix.api.contact.campaign_contact.update
- Allows the User to update the details of a relation between a Campaign and a Contact
cloudcix.api.contact.campaign_contact.delete
- Allows the User to delete a relation between a Campaign and a Contact

Chatbot

This service allows for the management of your Members CloudCIX Chatbots

Basic Usage: cloudcix.api.contact.chatbot.<method>

Available Methods

cloudcix.api.contact.chatbot.list
- Returns a list of all Chatbots associated with the Member of the User calling the method
cloudcix.api.contact.chatbot.create
- Allows the User to create a new Chatbot record
cloudcix.api.contact.chatbot.read
- Returns the details of a given Chatbot record
cloudcix.api.contact.chatbot.update
- Allows the User to update a Chatbot record

Contact

This service allows for management of contact

contact are people that are potential customers

Basic Usage: cloudcix.api.contact.contact.<method>

Available Methods

cloudcix.api.contact.contact.list
- Returns a list of all contact associated with the Member of the User calling the method
cloudcix.api.contact.contact.create
- Allows the User to create a new Contact record
cloudcix.api.contact.contact.read
- Returns the details of a given Contact record including a list of Campaigns and Groups to which that Contact belongs
cloudcix.api.contact.contact.update
- Allows the User to update a Contact record
cloudcix.api.contact.contact.delete
- Allows the User to delete a Contact record, including any links between that Contact and any Campaigns or Groups

Conversation

This service allows for the review of conversations the User’s Member Contacts have had with their Chatbot

Basic Usage: cloudcix.api.contact.conversation.<method>

Available Methods

cloudcix.api.contact.conversation.list
- Returns a list of all Converstaions that the User’s Member’s Contact has had with their Chatbot
cloudcix.api.contact.conversation.create
- Allows the Chatbot Agent User to create a new Conversation record the Contact started with their Chatbot
cloudcix.api.contact.conversation.read
- Returns the details of a given Conversation record

Corpus

This service represents a URL pointing to a public resource for a Corpus record in a Chatbot.

The Corpora of a Chatbot will be be converted to vector embeddings before being used by the Chatbot.

The Chatbot will draw information from the Corpora embeddings when generating answers for Contacts.

Basic Usage: cloudcix.api.contact.corpus.<method>

Available Methods

cloudcix.api.contact.corpus.list
- Returns a list of all Corpora belonging to a Chatbot in a Users Member.
cloudcix.api.contact.corpus.create
- Allows the User to create a new Corpus record for the specified Chatbot.
cloudcix.api.contact.corpus.read
- Returns a Corpus record with all its details
cloudcix.api.contact.corpus.update
- Allows the User to update the details of a Corpus record
cloudcix.api.contact.corpus.delete
- Allows the User to delete a Corpus record

Group

This service allows for management of Groups

Groups are many to many classifications of contact

Basic Usage: cloudcix.api.contact.group.<method>

Available Methods

cloudcix.api.contact.group.list
- Returns a list of all Groups belonging to the Member of the User calling the method
cloudcix.api.contact.group.create
- Allows the User to create a new Group record
cloudcix.api.contact.group.read
- Returns a Group record with all its details
cloudcix.api.contact.group.update
- Allows the User to update the details of a Group record
cloudcix.api.contact.group.delete
- Allows the User to delete a Group record, including any links between that Group and any Contact

Group Contact

This service lets a User assign Contacts to any number of Groups

Basic Usage: cloudcix.api.contact.group_contact.<method>

Available Methods

cloudcix.api.contact.group_contact.create
- Allows the User to create a relation between a Group and a Contact
cloudcix.api.contact.group_contact.delete
- Allows the User to delete a relation between a Group and a Contact

Opportunity

This service allows for the management of Opportunity records

Opportunities are the estimated chances of getting into business with one more contact with its possible marketing value

Basic Usage: cloudcix.api.contact.opportunity.<method>

Available Methods

cloudcix.api.contact.opportunity.list
- Return a list of all Opportunity records associated with the User calling the method
cloudcix.api.contact.opportunity.create
- Allows the User to create a new Opportunity record
cloudcix.api.contact.opportunity.read
- Returns an Opportunity record along with all its details
cloudcix.api.contact.opportunity.update
- Allows the User to update the details of an Opportunity record
cloudcix.api.contact.opportunity.delete
- Allows the User to delete an Opportunity record

Opportunity Contact

This service allows Users to manage links between Opportunities and Contacts

There is a many-to-many relation between Opportunities and Contacts

Basic Usage: cloudcix.api.contact.opportunity_contact.<method>

Available Methods

cloudcix.api.contact.opportunity_contact.create
- Allows the User to create a relation between an Opportunity and a Contact
cloudcix.api.contact.opportunity_contact.delete
- Allows the User to delete a relation between an Opportunity and a Contact

Opportunity History

This service allows Users to log updates on an Opportunity, as well as sending emails to the associated contact

Basic Usage: cloudcix.api.contact.opportunity_history.<method>

Available Methods

cloudcix.api.contact.opportunity_history.list
- Returns a list of history log entries for an Opportunity
cloudcix.api.contact.opportunity_history.create
- Allows the User to create a new history log for an Opportunity

Q and A

A q_and_a record contains one question asked by a Contact and the response generated by a Chatbot as the answer in a Conversation.

An ordered collection of q_and_a records form a Conversation the Contact had with a specific Chatbot.

Basic Usage: cloudcix.api.contact.q_and_a.<method>

Available Methods

cloudcix.api.contact.q_and_a.list
- Returns a list of all Question and Answers that a Contact had in the speciified Conversation with a Chatbot
cloudcix.api.contact.q_and_a.create
- Allows the Chatbot Agent User to create a new QandA record to record the question asked and the answer given, including references if any
cloudcix.api.contact.q_and_a.read
- Returns the details of a given QandA record including the references

Question

A question record contains question_set record as a foreign key in order to know the question_set it belongs to.

An ordered collection of question records from Contact with in a question_set.

Basic Usage: cloudcix.api.contact.question.<method>

Available Methods

cloudcix.api.contact.question.list
- Returns a list of all Questions that a Contact had in a speciified Question Set
cloudcix.api.contact.question.create
- Allows the User to create a new Question record in a Question Set
cloudcix.api.contact.question.read
- Returns the details of a given Question record including the ground_truth, question asked and language of the question asked in.

Question Set

A question_set record used to group the questions

An ordered collection of question_set records from Contact

Basic Usage: cloudcix.api.contact.question_set.<method>

Available Methods

cloudcix.api.contact.question_set.list
- Returns a list of all Question Sets that a Contact had in requesting users member along with global question sets
cloudcix.api.contact.question.create
- Allows the User to create a new Question Set record
cloudcix.api.contact.question.read
- Returns the details of a given Question Set record including the questions it contains

Contacts

The Contacts Application is a CRM application that exposes a REST API to manage a shared address book between Users in the same Member

Contacts can be used as a sales and marketing tool or just as a general purpose address book.

Basic Usage: cloudcix.api.Contacts.<service>.<method>

Services

Activity

This service allows the user to manage the various Activities

An Activity is a sub category of an Activity Type

Each Activity has only one ActivityType but an ActivityType may have many Activities

Basic Usage: cloudcix.api.Contacts.activity.<method>

Available Methods

cloudcix.api.Contacts.activity.list
- Returns a list of all Activities in your Member
- If no Activities exist, a default list will be created and returned
cloudcix.api.Contacts.activity.create
- Creates one new Activity record for the selected Activity Type
cloudcix.api.Contacts.activity.read
- Returns an Activity with all its details
cloudcix.api.Contacts.activity.update
- Updates an Activity record for the selected Activity Type
- The properties can only be updated if there are no Campaign records associated with the Activity
cloudcix.api.Contacts.activity.delete
- Deletes an Activity record for the selected Activity Type
- An Activity can only be deleted if there are no Campaigns associated with it

Activity Type

This service allows the User to manage Activity Types

Basic Usage: cloudcix.api.Contacts.activity_type.<method>

Available Methods

cloudcix.api.Contacts.activity_type.list
- Returns a list of supported Activity Types
cloudcix.api.Contacts.activity_type.create
- Allows the User to create a new Activity Type record
cloudcix.api.Contacts.activity_type.read
- Returns the selected Activity Type with all its details
cloudcix.api.Contacts.activity_type.update
- Allows the User to update the details of an Activity Type record
cloudcix.api.Contacts.activity_type.delete
- Allows the User to delete one Activity Type record.
- An Activity Type can only be deleted if there are no Activities linked to the Activity Type

Campaign

This service allows for management of Campaigns

Campaigns are a many to many classification of Contacts

Basic Usage: cloudcix.api.Contacts.campaign.<method>

Available Methods

cloudcix.api.Contacts.campaign.list
- Returns a list of all Campaigns associated with the Member of the User calling this method
cloudcix.api.Contacts.campaign.create
- Allows the User to create a new Campaign record
cloudcix.api.Contacts.campaign.read
- Returns the details of one Campaign, including a list of Contacts belonging to that Campaign
cloudcix.api.Contacts.campaign.update
- Allows the User to update a Campaign record
cloudcix.api.Contacts.campaign.delete
- Allows the User to delete one Campaign record, which includes the links between the Campaign and any Contacts.

Campaign Activity

This service manages Campaign Activities related to a Campaign and an Activity

The Campaign Activity allows Users to organize Activities into further subcategories

Basic Usage: cloudcix.api.Contacts.campaign_activity.<method>

Available Methods

cloudcix.api.Contacts.campaign_activity.list
- Return a list of Activities associated with a Campaign
cloudcix.api.Contacts.campaign_activity.create
- Allows the User to create an Activity related to a Campaign and an Activity Type.
cloudcix.api.Contacts.campaign_activity.read
- Returns the details of a relation between a Campaign and an Activity
cloudcix.api.Contacts.campaign_activity.update
- Allows the User to update the relation between one Campaign and one Activity
cloudcix.api.Contacts.campaign_activity.delete
- Allows the User to delete an Activity related to a Campaign

Campaign Contact

This service manages the many to many links between Campaigns and Contacts

Basic Usage: cloudcix.api.Contacts.campaign_contact.<method>

Available Methods

cloudcix.api.Contacts.campaign_contact.create
- Allows the User to create a relation between a Campaign and a Contact
cloudcix.api.Contacts.campaign_contact.update
- Allows the User to update the details of a relation between a Campaign and a Contact
cloudcix.api.Contacts.campaign_contact.delete
- Allows the User to delete a relation between a Campaign and a Contact

Contact

This service allows for management of Contacts

Contacts are people that are potential customers

Basic Usage: cloudcix.api.Contacts.contact.<method>

Available Methods

cloudcix.api.Contacts.contact.list
- Returns a list of all Contacts associated with the Member of the User calling the method
cloudcix.api.Contacts.contact.create
- Allows the User to create a new Contact record
cloudcix.api.Contacts.contact.read
- Returns the details of a given Contact record including a list of Campaigns and Groups to which that Contact belongs
cloudcix.api.Contacts.contact.update
- Allows the User to update a Contact record
cloudcix.api.Contacts.contact.delete
- Allows the User to delete a Contact record, including any links between that Contact and any Campaigns or Groups

Group

This service allows for management of Groups

Groups are many to many classifications of Contacts

Basic Usage: cloudcix.api.Contacts.group.<method>

Available Methods

cloudcix.api.Contacts.group.list
- Returns a list of all Groups belonging to the Member of the User calling the method
cloudcix.api.Contacts.group.create
- Allows the User to create a new Group record
cloudcix.api.Contacts.group.read
- Returns a Group record with all its details
cloudcix.api.Contacts.group.update
- Allows the User to update the details of a Group record
cloudcix.api.Contacts.group.delete
- Allows the User to delete a Group record, including any links between that Group and any Contact

Group Contact

This service manages the many to many links between Groups and Contacts

Basic Usage: cloudcix.api.Contacts.group_contact.<method>

Available Methods

cloudcix.api.Contacts.group_contact.create
- Allows the User to create a relation between a Group and a Contact
cloudcix.api.Contacts.group_contact.delete
- Allows the User to delete a relation between a Group and a Contact

Opportunity

This service allows for the management of Opportunity records

Opportunities are the estimated chances of getting into business with one more Contacts with its possible marketing value

Basic Usage: cloudcix.api.Contacts.opportunity.<method>

Available Methods

cloudcix.api.Contacts.opportunity.list
- Return a list of all Opportunity records associated with the User calling the method
cloudcix.api.Contacts.opportunity.create
- Allows the User to create a new Opportunity record
cloudcix.api.Contacts.opportunity.read
- Returns an Opportunity record along with all its details
cloudcix.api.Contacts.opportunity.update
- Allows the User to update the details of an Opportunity record
cloudcix.api.Contacts.opportunity.delete
- Allows the User to delete an Opportunity record

Opportunity Contact

This service manages the many to many links between Opportunities and Contacts

Basic Usage: cloudcix.api.Contacts.opportunity_contact.<method>

Available Methods

cloudcix.api.Contacts.opportunity_contact.create
- Allows the User to create a relation between an Opportunity and a Contact
cloudcix.api.Contacts.opportunity_contact.delete
- Allows the User to delete a relation between an Opportunity and a Contact

Opportunity History

This service allows Users to log updates on an Opportunity, as well as sending emails to the associated Contacts

Basic Usage: cloudcix.api.Contacts.opportunity_history.<method>

Available Methods

cloudcix.api.Contacts.opportunity_history.list
- Returns a list of history log entries for an Opportunity
cloudcix.api.Contacts.opportunity_history.create
- Allows the User to create a new history log for an Opportunity

DCIM

The DCIM (Data Centre Infrastructure Management) Application allows for the management data centre infrastructure.

Basic Usage: cloudcix.api.DCIM.<service>.<method>

Services

Circuit

This service allows Users to manage their Circuits

A Circuit is a device installed in your active Address

Basic Usage: cloudcix.api.DCIM.circuit.<method>

Available Methods

cloudcix.api.DCIM.circuit.list
- Returns a list of Circuits by owner, customer and supplier based on the User’s Address
cloudcix.api.DCIM.circuit.create
- This method allows the User to add a Circuit to a Circuit Class
cloudcix.api.DCIM.circuit.read
- This method allows the User to get the details of a given Circuit
- Only owners, customers and suppliers are allowed to read a Circuit
cloudcix.api.DCIM.circuit.update
- Allows the User to update a Circuit
cloudcix.api.DCIM.circuit.delete
- Allows the User to delete a Circuit
- If a Circuit has been removed but the User wants to maintain it in the list, it should be updated with a decommission date

Circuit Class

This service allows for the management of Circuit Classes

A Circuit Class is a classification for the Circuits

Basic Usage: cloudcix.api.DCIM.circuit_class.<method>

Available Methods

cloudcix.api.DCIM.circuit_class.list
- Returns a list of Circuit Classes and their supported Properties
cloudcix.api.DCIM.circuit_class.create
- Allows the User to create a new Circuit Class for its Member
cloudcix.api.DCIM.circuit_class.read
- Allows the User to get the details of a given Circuit Class
cloudcix.api.DCIM.circuit_class.update
- Allows the User to update a Circuit Class.
- If there are Circuits under the Circuit Class, new properties cannot be required and old properties cannot be removed or renamed

Property Type

This service is in place to offer a list of the supported Property Types

A Property Type is an identification of the expected input value for a given property.

Basic Usage: cloudcix.api.DCIM.property_type.<method>

Available Methods

cloudcix.api.DCIM.property_type.list
- Returns a list of Property Types

Property Value

This service allows to search Circuit objects properties dictionaries by the value sent in the request.

Basic Usage: cloudcix.api.DCIM.property_value.<method>

Available Methods

cloudcix.api.DCIM.property_value.list - Allows the User to list all properties of their Circuits where the queries search_term is included. - It will return a list of objects for each property value the term was included in, with reference keys to identify the Circuit. - This list will be alphabetical based on the value of the property.

Financial

The Financial Application exposes a suite of services that together implement a full accounting system based on double entry bookkeeping

Services

Account Purchase Adjustment

This service allows the User to create and read Account Purchase Adjustments

An Account Purchase Adjustment (10005) is a transaction with the purpose of adjusting and conciliating nominal accounts

A set of nominal accounts will be debited and credited

The balance of debits and credits must be equal

The adjustment has an unallocated balance until it has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_purchase_adjustment.<method>

Available Methods

cloudcix.api.Financial.account_purchase_adjustment.create
- This method allows the User to create a new Account Purchase Adjustment transaction
cloudcix.api.Financial.account_purchase_adjustment.read
- This method allows the User to get an Account Purchase Adjustment transaction and its details

Account Purchase Adjustment Contra

This service allows the User to create and read an Account Purchase Adjustment from an Account Sale Adjustment created by the target Address

The adjustment has an unallocated balance until it has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_purchase_adjustment_contra.<method>

Available Methods

cloudcix.api.Financial.account_purchase_adjustment_contra.create
- This method allows the User to create an Account Purchase Adjustment from an Account Sale Adjustment created by the target Address
- The lines of the Account Purchase Adjustment must match the lines of the Account Sale Adjustment, with the exception of the Nominal Account Number
- This number must be a valid Purchases Nominal Account belonging to the User’s acting Address.
cloudcix.api.Financial.account_purchase_adjustment_contra.read
- This method allows the User to get an Account Purchase Adjustment transaction created by the target Address for the User’s acting Address

Note

The Account Purchase Adjustment Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Account Purchase Debit Note

This service allows the User to create and manage Account Purchase Debit Notes

An Account Purchase Debit Note (10003) is a transaction in which a purchase has not been immediately debited

The debit note has an unallocated balance until it has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_purchase_debit_note.<method>

Available Methods

cloudcix.api.Financial.account_purchase_debit_note.create
- This method allows the User to create a new Account Purchase Debit Note transaction
cloudcix.api.Financial.account_purchase_debit_note.read
- This method allows the User to get an Account Purchase Debit Note transaction and its details
cloudcix.api.Financial.account_purchase_debit_note.update
- This method allows the User to update the external reference of an Account Purchase Debit Note transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Account Purchase Debit Note Contra

This service allows the User to create and read an Account Purchase Debit Note from an Account Sale Credit Note created by the target Address

The debit note has an unallocated balance until it has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_purchase_debit_note_contra.<method>

Available Methods

cloudcix.api.Financial.account_purchase_debit_note_contra.create
- This method allows the User to create an Account Purchase Debit Note from an Account Sale Credit Note created by the target Address
- The lines of the Account Purchase Debit Note must match the lines of the Account Sale Credit Note, with the exception of the Nominal Account Number
- This number must be a valid Purchases Nominal Account belonging to the User’s acting Address
cloudcix.api.Financial.account_purchase_debit_note_contra.read
- This method allows the User to get an Account Purchase Debit Note transaction created by the target Address for the User’s acting Address

Note

The Account Purchase Debit Note Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Account Purchase Invoice

This service allows the User to create and manage Account Purchase Invoices

An Account Purchase Invoice (10002) is a transaction in which a purchase has not been paid immediately

The invoice has an unallocated balance until the invoice has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_purchase_invoice.<method>

Available Methods

cloudcix.api.Financial.account_purchase_invoice.create
- This method allows the User to create a new Account Purchase Invoice transaction
cloudcix.api.Financial.account_purchase_invoice.read
- This method allows the User to get an Account Purchase Invoice transaction and its details
cloudcix.api.Financial.account_purchase_invoice.update
- This method allows the User to update an external reference of an Account Purchase Invoice transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Account Purchase Invoice Contra

This service allows the User to create and read an Account Purchase Invoice from an Account Sale Invoice created by the target Address

The invoice has an unallocated balance until the invoice has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_purchase_invoice_contra.<method>

Available Methods

cloudcix.api.Financial.account_purchase_invoice_contra.create
- This method allows the User to create an Account Purchase Invoice from an Account Sale Invoice created by the target Address
- The lines of the Account Purchase Invoice must match the lines of the Account Sale Invoice, with the exception of the Nominal Account Number
- This number must be a valid Purchases Nominal Account belonging to the User’s acting Address
cloudcix.api.Financial.account_purchase_invoice_contra.read
- This method allows the User to get an Account Purchase Invoice transaction created by the target Address for the User’s acting Address

Note

The Account Purchase Invoice Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Account Purchase Payment

This service allows the User to create and read Account Purchase Payments

An Account Purchase Payment (10004) is a transaction in which a purchase is being paid

The payment has an unallocated balance until the payment has been fully allocated through the Allocation service

Note

A Nominal Contra must be associated with the selected Payment Method and this transaction type in order to get the Nominal Account which will be credited

Basic Usage: cloudcix.api.Financial.account_purchase_payment.<method>

Available Methods

cloudcix.api.Financial.account_purchase_payment.create
- This method allows the User to create a new Account Purchase Payment transaction
cloudcix.api.Financial.account_purchase_payment.read
- This method allows the User to get an Account Purchase Payment transaction and its details

Account Purchase Payment Contra

This service allows the User to create and read an Account Purchase Payment from an Account Sale Payment created by the target Address

The payment has an unallocated balance until the payment has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_purchase_payment_contra.<method>

Available Methods

cloudcix.api.Financial.account_purchase_payment_contra.create
- This method allows the User to create an Account Purchase Payment from an Account Sale Payment created by the target Address
cloudcix.api.Financial.account_purchase_payment_contra.read
- This method allows the User to get an Account Purchase Payment transaction created by the target Address for the User’s acting Address

Note

The Account Purchase Payment Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Account Sale Adjustment

This service allows the User to create and read Account Sale Adjustments

An Account Sale Adjustment (11005) is a transaction with the purpose of adjusting and conciliating nominal accounts

A set of nominal accounts will be debited and credited

The balance of debits and credits must be the same amount

The adjustment has an unallocated balance until it has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_sale_adjustment.<method>

Available Methods

cloudcix.api.Financial.account_sale_adjustment.create
- This method allows the User to create a new Account Sale Adjustment transaction
cloudcix.api.Financial.account_sale_adjustment.read
- This method allows the User to get an Account Sale Adjustment transaction and its details

Account Sale Adjustment Contra

This service allows the User to create and read an Account Sale Adjustment from an Account Purchase Adjustment created by the target Address

The adjustment has an unallocated balance until it has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_sale_adjustment_contra.<method>

Available Methods

cloudcix.api.Financial.account_sale_adjustment_contra.create
- This method allows the User to create an Account Sale Adjustment from an Account Purchase Adjustment created by the target Address
- The lines of the Account Sale Adjustment must match the lines of the Account Purchase Adjustment, with the exception of the Nominal Account Number
- This must be a valid Sales Nominal Account belonging to the User’s acting Address
cloudcix.api.Financial.account_sale_adjustment_contra.read
- This method allows the User to get an Account Sale Adjustment transaction created by the target Address for the User’s acting Address

Note

The Account Sale Adjustment Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Account Sale Credit Note

This service allows the User to create and manage Account Sale Credit Notes

An Account Sale Credit Note (11003) is a transaction in which a sale has not been credited immediately

The credit note has an unallocated balance until it has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_sale_credit_note.<method>

Available Methods

cloudcix.api.Financial.account_sale_credit_note.create
- This method allows the User to create a new Account Sale Credit Note transaction
cloudcix.api.Financial.account_sale_credit_note.read
- This method allows the User to get an Account Sale Credit Note transaction and its details
cloudcix.api.Financial.account_sale_credit_note.update
- This method allows the User to update the external reference of an Account Sale Credit Note transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Account Sale Credit Note Contra

This service allows the User to create or read an Account Sale Credit Note transaction from an Account Purchase Debit Note created by the target Address

Basic Usage: cloudcix.api.Financial.account_sale_credit_note_contra.<method>

Available Methods

cloudcix.api.Financial.account_sale_credit_note_contra.create
- This method allows the User to create an Account Sale Credit Note from an Account Purchase Debit Note created by the target Address
- The lines of the Account Sale Credit Note must match the lines of the Account Purchase Debit Note, with the exception of the Nominal Account Number
- This must be a valid Sales Nominal Account belonging to the User’s acting Address
cloudcix.api.Financial.account_sale_credit_note_contra.read
- This method allows the User to get an Account Sale Credit Note transaction created by the target Address for the User’s acting Address

Note

The Account Sale Credit Note Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Account Sale Invoice

This service allows the User to create and manage Account Sale Invoices

An Account Sale Invoice (11002) is a transaction in which a sale has not been paid immediately

The invoice has an unallocated balance until the invoice has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_sale_invoice.<method>

Available Methods

cloudcix.api.Financial.account_sale_invoice.create
- This method allows the User to create a new Account Sale Invoice transaction
cloudcix.api.Financial.account_sale_invoice.read
- This method allows the User to get an Account sale Invoice transaction and its details
cloudcix.api.Financial.account_sale_invoice.update
- This method allows the User to update an external reference of an Account Sale Invoice transaction
- A transaction can only be updated if there’ no Period End after the effective Transaction Date

Account Sale Invoice Contra

This service allows the User to create or read an Account Sale Invoice from an Account Purchase Invoice created by the target Address

The invoice has an unallocated balance until the invoice has been fully allocated through the Allocation service

Basic Usage: cloudcix.api.Financial.account_sale_invoice_contra.<method>

Available Methods

cloudcix.api.Financial.account_sale_invoice_contra.create
- This method allows the User to create an Account Sale Invoice from an Account Purchase Invoice created by the target Address
- The lines of the Account Sale Invoice must match the lines of the Account Purchase Invoice, with the exception of the Nominal Account Number
- This must be a valid Sales Nominal Account belonging to the User’s acting Address
cloudcix.api.Financial.account_sale_invoice_contra.read
- This method allows the User to get an Account Sale Invoice transaction created by the target Address for the User’s acting Address

Note

The Account Sale Invoice Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Account Sale Payment

This service allows the User to create and read Account Sale Payments

An Account Sale Payment (11004) is a transaction in which a sale is being paid

The payment has an unallocated balance until the payment has been fully allocated through the Allocation service

Note

A Nominal Contra must be associated to the selected Payment Method and this Transaction Type in order to get the Nominal Account which will be debited

Basic Usage: cloudcix.api.Financial.account_sale_payment.<method>

Available Methods

cloudcix.api.Financial.account_sale_payment.create
- This method allows the User to create a new Account Sale Payment transaction
cloudcix.api.Financial.account_sale_payment.read
- This method allows the User to get an Account Sale Payment transaction and its details

Account Sale Payment Contra

This service allows the User to create and read an Account Sale Payment from an Account Purchase Payment transaction created by the target Address

Basic Usage: cloudcix.api.Financial.account_sale_payment_contra.<method>

Available Methods

cloudcix.api.Financial.account_sale_payment_contra.create
- This method allows the User to create an Account Sale Payment from an Account Purchase Payment created by the target Address
cloudcix.api.Financial.account_sale_payment_contra.read
- This method allows the User to get an Account Sale Payment created by the target Address for the User’s acting Address

Note

The Account Sale Payment Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Allocation

This service allows the User to manage its Allocations

An Allocation is a set of Transactions allocating a certain amount of Debits and Credits against each other

Basic Usage: cloudcix.api.Financial.allocation.<method>

Available Methods

cloudcix.api.Financial.allocation.list
- This method allows the User to get a list of Allocations for its acting Address
cloudcix.api.Financial.allocation.create
- This method allows the User to create a new Allocation
- The total amount of Debits and Credits must balance to 0
- The allocated Transactions must belong to the same Contra Address, and the allocated amount cannot be greater than the Unallocated Balance of the Transaction
- Finally, the allocated Transactions must be compatible i.e. an invoice can be allocated against a payment, adjustment or a credit/debit note
cloudcix.api.Financial.allocation.delete
- This method allows the User to delete an Allocation
- When an Allocation is deleted the Transactions involved in the Allocation will automatically have their Unallocated Balances restored by the allocated amount

Balance Sheet

This service allows the User to generate a Balance Sheet

The Balance Sheet presents a company’s Financial position at the end of a specified date Therefore, it is a list of Nominal Accounts with their total Debits, Credits and balance at a given date

Basic Usage: cloudcix.api.Financial.balance_sheet.<method>

Available Methods

cloudcix.api.Financial.nominal_ledger_balance_sheet.list
- This method allows the User to get the Balance Sheet at a certain date
- If the User is acting Global and no address_id is specified, the Balance Sheet is calculated for all Addresses in its Member
- Otherwise, the Balance Sheet is calculated for its acting Address

Cash Purchase Debit Note

This service allows the User to create and manage Cash Purchase Debit Notes.

A Cash Purchase Debit Note (10001) is a transaction in which a purchase has been debited in cash

Note

A Nominal Contra must be associated with the selected Payment Method and this Transaction Type in order to get the Nominal Account which will be debited

Basic Usage: cloudcix.api.Financial.cash_purchase_debit_note.<method>

Available Methods

cloudcix.api.Financial.cash_purchase_debit_note.create
- This method allows the User to create a new Cash Purchase Debit Note transaction
cloudcix.api.Financial.cash_purchase_debit_note.read
- This method allows the User to get a Cash Purchase Debit Note transaction and its details
cloudcix.api.Financial.cash_purchase_debit_note.update
- This method allows the User to update the external reference of a Cash Purchase Debit Note transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Cash Purchase Debit Note Contra

This service allows the User to create or read a Cash Purchase Debit Note from a Cash Sale Credit Note created by the target Address

Basic Usage: cloudcix.api.Financial.cash_purchase_debit_note_contra.<method>

Available Methods

cloudcix.api.Financial.cash_purchase_debit_note_contra.create
- This method allows the User to create a Cash Purchase Debit Note from a Cash Sale Credit Note created by the target Address
- The lines of the Cash Purchase Debit Note must match the lines of the Cash Sale Credit Note, with the exception of the Nominal Account Number
- This must be a valid Purchases Nominal Account belonging to the User’s acting Address.
cloudcix.api.Financial.cash_purchase_debit_note_contra.read
- This method allows the User to get a Cash Purchase Debit Note transaction created by the target Address for the User’s acting Address

Note

The Cash Purchase Debit Note Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Cash Purchase Invoice

This service allows the User to create and manage Cash Purchase Inovoices

A Cash Purchase Invoice (10000) is a transaction in which a purchase has been paid in cash

Note

A Nominal Contra must be associated with the selected Payment Method and this Transaction Type in order to get the Nominal Account which will be credited

Basic Usage: cloudcix.api.Financial.cash_purchase_invoice.<method>

Available Methods

cloudcix.api.Financial.cash_purchase_invoice.create
- This method allows the User to create a new Cash Purchase Invoice transaction
cloudcix.api.Financial.cash_purchase_invoice.read
- This method allows the User to get a Cash Purchase Invoice transaction and its details
cloudcix.api.Financial.cash_purchase_invoice.update
- This method allows the User to update an external reference of a Cash Purchase Invoice transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Cash Purchase Invoice Contra

This service allows the User to create or read a Cash Purchase Invoice from a Cash Sale Invoice created by the target Address

Basic Usage: cloudcix.api.Financial.cash_purchase_invoice_contra.<method>

Available Methods

cloudcix.api.Financial.cash_purchase_invoice_contra.create
- This method allows the User to create a Cash Purchase Invoice from a Cash Sale Invoice created by the target Address
- The lines of the Cash Purchase Invoice must match the lines of the Cash Sale Invoice, with the exception of the Nominal Account Number
- This must be a valid Purchases Nominal Account belonging to the User’s acting Address
cloudcix.api.Financial.cash_purchase_invoice_contra.read
- This method allows the User to get a Cash Purchase Invoice transaction created by the target Address for the User’s acting Address

Note

The Cash Purchase Invoice Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Cash Purchase Receipts

This service allows the User to create and manage Cash Purchase Receipts

A Cash Purchase Receipt (10006) is a transaction in which a purchase has been credited in cash and does not take a contra address

Basic Usage: cloudcix.api.Financial.cash_purchase_receipt.<method>

Available Methods

cloudcix.api.Financial.cash_purchase_receipt.create
- This method allows the User to create a new Cash Purchase Receipt transaction
cloudcix.api.Financial.cash_purchase_receipt.read
- This method allows the User to get an Cash Purchase Receipt transaction and its details
cloudcix.api.Financial.cash_purchase_receipt.update
- This method allows the User to update the details of a Cash Purchase Receipt transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Cash Purchase Refund

This service allows the User to create and manage Cash Purchase Refunds

A Cash Purchase Refund (10007) is a transaction in which a purchase has been debited in cash and does not take a contra address

Basic Usage: cloudcix.api.Financial.cash_purchase_refund.<method>

Available Methods

cloudcix.api.Financial.cash_purchase_refund.create
- This method allows the User to create a new Cash Purchase Refund transaction
cloudcix.api.Financial.cash_purchase_refund.read
- This method allows the User to get an Cash Purchase Refund transaction and its details
cloudcix.api.Financial.cash_purchase_refund.update
- This method allows the User to update the details of a Cash Purchase Refund transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Cash Sale Credit Note

This service allows the User to create and manage Cash Sale Credit Notes

A Cash Sale Credit Note (11001) is a transaction in which a sale has been credited in cash

Note

A Nominal Contra must be associated with the selected Payment Type and this Transaction Type in order to get the Nominal Account which will be credited

Basic Usage: cloudcix.api.Financial.cash_sale_credit_note.<method>

Available Methods

cloudcix.api.Financial.cash_sale_credit_note.create
- This method allows the User to create a new Cash Sale Credit Note
cloudcix.api.Financial.cash_sale_credit_note.read
- This method allows the User to get a Cash Sale Credit Note transaction and its details
cloudcix.api.Financial.cash_sale_credit_note.update
- This method allows the User to update the external reference of a Cash Sale Credit Note transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Cash Sale Credit Note Contra

This service allows the User to create or read a Cash Sale Credit Note from a Cash Purchase Debit Note created by the target Address

Basic Usage: cloudcix.api.Financial.cash_sale_credit_note_contra.<method>

Available Methods

cloudcix.api.Financial.cash_sale_credit_note_contra.create
- This method allows the User to create a Cash Sale Credit Note from a Cash Purchase Debit Note create by the target Address
- The lines of the Cash Sale Credit Note must match the lines of the Cash Purchase Debit Note, with the exception of the Nominal Account Number
- This must be a valid Sales Nominal Account belonging to the User’s acting Address
cloudcix.api.Financial.cash_sale_credit_note_contra.read
- This method allows the User to get a Cash Sale Credit Note transaction created by the target Address for the User’s acting Address

Note

The Cash Sale Credit Note Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Cash Sale Invoice

This service allows the User to create and manage Cash Sale Invoices

A Cash Sale Invoice (11000) is a transaction in which a sale has been paid in cash

Note

A Nominal Contra must be associated with the selected Payment Method and this Transaction Type in order to get the Nominal Account which will be debited

Basic Usage: cloudcix.api.Financial.cash_sale_invoice.<method>

Available Methods

cloudcix.api.Financial.cash_sale_invoice.create
- This method allows the User to create a new Cash Sale Invoice transaction
cloudcix.api.Financial.cash_sale_invoice.read
- This method allows the User to get a Cash Sale Invoice transaction and its details
cloudcix.api.Financial.cash_sale_invoice.update
- This method allows the User to update an external reference of a Cash Sale Invoice transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Cash Sale Invoice Contra

This service allows the User to create or read a Cash Sale Invoice from a Cash Purchase Invoice created by the target Address

Basic Usage: cloudcix.api.Financial.cash_sale_invoice_contra.<method>

Available Methods

cloudcix.api.Financial.cash_sale_invoice_contra.create
- This method allows the User to create a Cash Sale Invoice from a Cash Purchase Invoice created by the target Address
- The lines of the Cash Sale Invoice must match the lines of the Cash Purchase Invoice, with the exception of the Nominal Account Number
- This must be a valid Sales Nominal Account belonging to the User’s acting Address
cloudcix.api.Financial.cash_sale_invoice_contra.read
- This method allows the User to get a Cash Sale Invoice transaction created by the target Address for the User’s acting Address

Note

The Cash Sale Invoice Contra service requires the user to specify a transaction from a linked Address for both the create and read methods. The User is required to pass a source_id kwarg to these methods specifying the id of the Address where the transaction should be read from.

Cash Sale Receipts

This service allows the User to create and manage Cash Sale Receipts

A Cash Sale Receipt (11006) is a transaction in which a sale has been debited in cash and does not take a contra address

Basic Usage: cloudcix.api.Financial.cash_sale_receipt.<method>

Available Methods

cloudcix.api.Financial.cash_sale_receipt.create
- This method allows the User to create a new Cash Sale Receipt transaction
cloudcix.api.Financial.cash_sale_receipt.read
- This method allows the User to get an Cash Sale Receipt transaction and its details
cloudcix.api.Financial.cash_sale_receipt.update
- This method allows the User to update the details of a Cash Sale Receipt transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Cash Sale Refund

This service allows the User to create and manage Cash Sale Refunds

A Cash sale Refund (11007) is a transaction in which a sale has been credited in cash and does not take a contra address

Basic Usage: cloudcix.api.Financial.cash_sale_refund.<method>

Available Methods

cloudcix.api.Financial.cash_sale_refund.create
- This method allows the User to create a new Cash Sale Refund transaction
cloudcix.api.Financial.cash_sale_refund.read
- This method allows the User to get an Cash Sale Refund transaction and its details
cloudcix.api.Financial.cash_sale_refund.update
- This method allows the User to update the details of a Cash Sale Refund transaction
- A transaction can only be updated if there’s no Period End after the effective Transaction Date

Credit Limit

This service allows a User to read or list Credit Limits for their customers

Basic Usage: cloudcix.api.Financial.credit_limit.<method>

Available Methods

cloudcix.api.Financial.credit_limit.list
- This method allows the User to retrieve a list of Credit Limit details set by their Address for Addresses they are linked to
cloudcix.api.Financial.credit_limit.read
- This method allows the User to get the Credit Limit set for the target Address

Creditor Account History

This service allows the User to get a list of Transactions for a given Creditor

It also returns the Creditor’s current balance

Basic Usage: cloudcix.api.Financial.creditor_account_history.<method>

Available Methods

cloudcix.api.Financial.creditor_account_history.list
- This method returns the User to get a list of transactions for a given Creditor

Creditor Account Statement

This service allows the User to see a Statement for a given Address

A Statement is a list of unallocated transactions

Basic Usage: cloudcix.api.Financial.creditor_account_statement.<method>

Available Methods

cloudcix.api.Financial.creditor_account_statement.list
- This method returns a list of unallocated Transactions for the target Address
- This method returns Transactions whose idTransactionType values are in the range 10000-10005 inclusive

Creditor Ledger

This service allows the User to get a list of Creditors who are owed money by the User’s Address

Basic Usage: cloudcix.api.Financial.creditor_ledger.<method>

Available Methods

cloudcix.api.Financial.creditor_ledger.list
- This method allows the User to get a list of Creditors and their balances
- Only Creditors whose balance is not 0 will be returned

Creditor Ledger Aged

This service allows the User to get a list of Creditors with their current balance, as well as their balances at 30, 60, 90, 120 days and older

Basic Usage: cloudcix.api.Financial.creditor_ledger_aged.<method>

Available Methods

cloudcix.api.Financial.creditor_ledger_aged.list
- This method allows the User to get a list of Creditors with their current and aged balances

Creditor Ledger Contra Transaction

This service allows the User to get a list of Creditor Contra Transactions

A Contra Transaction is a Transaction created by the Creditor for the User’s Address

Basic Usage: cloudcix.api.Financial.creditor_ledger_contra_transaction.<method>

Available Methods

cloudcix.api.Financial.creditor_ledger_contra_transaction.list
- This method allows the User to get a list of Creditor Contra Transactions for the User’s Address

Creditor Ledger Transaction

This service allows the User to get a list of Creditor Transactions for their acting Address

Basic Usage: cloudcix.api.Financial.creditor_ledger_transaction.<method>

Available Methods

cloudcix.api.Financial.creditor_ledger_transaction.list
- This method allows the User to get a list of Creditor Transactions
- The method also returns the current total amount of Debits and Credits

Debtor Account History

This service allows the User to get a list of Transactions for a given Debtor

It also returns the Debtor’s current balance

Basic Usage: cloudcix.api.Financial.debtor_account_history.<method>

Available Methods

cloudcix.api.Financial.debtor_account_history.list
- This method allows the User to get the list of transactions for a given Debtor

Debtor Account Statement

This service allows the User to see a Statement for a given Address

A Statement is a list of unallocated Transactions

Basic Usage: cloudcix.api.Financial.debtor_account_statement.<method>

Available Methods

cloudcix.api.Financial.debtor_account_statement.list
- This method returns a list of unallocated Transactions for the target Address
- This method returns Transactions whose idTransactionType values are in the range 11000-11005 inclusive

Debtor Ledger

This service allows the User to get a list of Debtors who owe money to the User’s Address

Basic Usage: cloudcix.api.Financial.debtor_ledger.<method>

Available Methods

cloudcix.api.Financial.debtor_ledger.list
- This method allows the User to get a list of Debtors and their balances
- Only Debtors whose balance is not 0 will be returned

Debtor Ledger Aged

This service allows the User to get a list of Debtors with their current balance, as well as their balances at 30, 60, 90, 120 days and older

Basic Usage: cloudcix.api.Financial.debtor_ledger_aged.<method>

Available Methods

cloudcix.api.Financial.debtor_ledger_aged.list
- This method allows the User to get a list of Debtors with their current and aged balances

Debtor Ledger Contra Transaction

This service allows the User to get a list of Debtor Contra Transactions

A Contra Transaction is a Transaction created by the Debtor for the User’s Address

Basic Usage: cloudcix.api.Financial.debtor_ledger_transaction_contra.<method>

Available Methods

cloudcix.api.Financial.debtor_ledger_transaction_contra.list
- This method allows the User to get a list of Debtor Contra Transactions for the User’s Address

Debtor Ledger Transaction

This service allows the User to get a list of Debtor Transactions for their acting Address

Basic Usage: cloudcix.api.Financial.debtor_ledger_transaction.<method>

Available Methods

cloudcix.api.Financial.debtor_ledger_transaction.list
- This method allows the User to get a list of Debtor Transactions
- It also returns the current total amount of Debits and Credits

Global Nominal Account

This service allows the User to manage its Global Nominal Accounts.

A Nominal Account stores accounting Transactions for a fiscal year.

A Member can have a set of Global Nominal Accounts.

Basic Usage: cloudcix.api.Financial.global_nominal_account.<method>

Available Methods

cloudcix.api.Financial.global_nominal_account.list
- This method allows the User to get a list of Nominal Accounts.
- If the User is acting Local, the method will return the list of Nominal Accounts for the User’s acting Address
- If the User is acting Global, the method will return the list of Global Nominal Accounts in the User’s Member
cloudcix.api.Financial.global_nominal_account.create
- This method allows the User to create a new Nominal Account for its Member and/or Address
- If the address_id is specified the Global Nominal Account will be created for the Member if it does not exist, and created for the specified Address
- Note
  
  Pay attention to the valid_purchases_account and valid_sales_account:
  
  Both will be required if the selected nominal_account_type_id is 1
  
  valid_sales_account will be True and valid_purchases_account will be False if the selected nominal_account_type_id is 4000. Sent values will be ignored
  
  valid_purchases_account will be True and valid_sales_account will be False if the selected nominal_account_type_id is 5000. Sent values will be ignored
  
  Both parameters will be False for any other nominal_account_type_id, sent values will be ignored
cloudcix.api.Financial.global_nominal_account.read
- This method allows the User to get a Nominal Account for its Member and/or Address
- If the address_id is not specified, the Global Nominal Account for the Member will be returned
cloudcix.api.Financial.global_nominal_account.update
- This method allows the User to update a Nominal Account
- If the address_id is not specified, the Global Nominal Account for the Member will be updated
- Note
  
  The same note about valid_sales_account and valid_purchases_account as in the create method must be taken into account for update
  
  Also note that any change in these values will affect the Member’s Global Nominal Account as well as all Addresses who have that Nominal Account set up
cloudcix.api.Financial.global_nominal_account.delete
- This method allows the User to delete a Nominal Account for its Member and/or Address
- If the address_id is not specified, the Nominal Account will be deleted for the Member and all Addresses within the Member.
- A Nominal Account can only be deleted if it has not been used in a Transaction

Journal Entry

This service allows the User to manage its Nominal Ledger’s Journal Entries

A Journal Entry (12000) is an internal transaction with the purpose of adjusting Nominal Accounts

Basic Usage: cloudcix.api.Financial.journal_entry.<method>

Available Methods

cloudcix.api.Financial.journal_entry.list
- This method allows the User to get a list of Journal Entry Transactions
- It also returns the current total amount of Debits and Credits
cloudcix.api.Financial.journal_entry.create
- This method allows the User to create a new Journal Entry transaction
cloudcix.api.Financial.journal_entry.read
- This method allows the User to get the details of a Journal Entry Transaction
cloudcix.api.Financial.journal_entry.update
- This method allows the User to update some details of the Journal Entry

Nominal Account History

This service allows the User to get a Nominal Account balance in a given period of time, as well as the list of transactions in which the Account has been used

Basic Usage: cloudcix.api.Financial.nominal_account_history.<method>

Available Methods

cloudcix.api.Financial.nominal_account_history.list
- This method allows the User to list the transaction History of a given Nominal Account

Nominal Account Type

This service allows the User to get a list of supported Nominal Account Types

Nominal Accounts are classified within different Types

Basic Usage: cloudcix.api.Financial.nominal_account_type.<method>

Available Methods

cloudcix.api.Financial.nominal_account_type.list
- This method returns the list of supported Nominal Account Types

Nominal Contra

This service allows the User to manage its Nominal Contra Accounts

A Nominal Contra Account is an association between a Transaction Type, a Payment Method and a Nominal Account

The Nominal Contra is used in conjunction with the Payment Method and Transaction Type to determine with Nominal Account the lines of Debits or Credits will be matched with

Payment Method

This service allows the User to manage its Payment Methods

A Payment Method is one of the ways to pay for a Transaction

Basic Usage: cloudcix.api.Financial.payment_method.<method>

Available Methods

cloudcix.api.Financial.payment_method.list
- This method allows the User to get a list of Payment Methods
- Only Payment Methods belonging to the User will be returned
cloudcix.api.Financial.payment_method.create
- This method allows the User to create a new Payment Method
cloudcix.api.Financial.payment_method.read
- This method allows the User to get a Payment Method and its details
- Only owners of a Payment Method can read it
cloudcix.api.Financial.payment_method.update
- This method allows the User to update details of a Payment Method
- Only owners of the Payment Method can update it
cloudcix.api.Financial.payment_method.delete
- This method allows the User to delete a Payment Method
- Only owners of the Payment Method can delete it

Period End

This service allows the User to manage its Period End Transactions

A Period End Transaction (12001) calculates the balance from the previous Period End (or the oldest Transaction if none exists) and the given transaction date

Creating a Period End will disallow any modification or creation of Transactions with a date before the Period End’s transaction date

Basic Usage: cloudcix.api.Financial.period_end.<method>

Available Methods

cloudcix.api.Financial.period_end.list
- This method allows the User to get a list of Period End Transactions
cloudcix.api.Financial.period_end.create
- This method allows the User to create a new Period End Transaction
- The Period End’s transactionDate cannot be set to be in any time the future
cloudcix.api.Financial.period_end.read
- This method allows the User to get the details of a Period End Transaction
cloudcix.api.Financial.period_end.delete
- This method allows the User to delete a Period End Transaction
- Only the latest Period End can be deleted

Profit & Loss

This service allows the User to generate a Profit & Loss account

The Profit & Loss shows the company’s revenues and expenses during a particular period

Basic Usage: cloudcix.api.Financial.profit_loss.<method>

Available Methods

cloudcix.api.Financial.profit_loss.list
- This method allows the User to get the Profit & Loss in a range of dates
- If the User is acting Global and no address_id is specified, the Profit & Loss will be calculated for all its Addresses
- Otherwise, the Profit & Loss will be calculated for its Local Address

Purchases Analysis

This service allows the User to view the total Purchased from their partner Addresses

For each Address the service will calculate the total amount Purchased through Invoices less Debit Notes.

Basic Usage: cloudcix.api.Financial.purchases_analysis.<method>

Available Methods

cloudcix.api.Financial.purchases_analysis.list
- This method allows the User to get a list of total Purchases with their Addresses

Purchases By Country

This service allows the User to get a list of Countries along with the amounts spent in Purchases for each in a period of time

Each Country will have the total amount excluding VAT, and the total amount of VAT spent

Basic Usage: cloudcix.api.Financial.purchases_by_country.<method>

Available Methods

cloudcix.api.Financial.purchases_by_country.list
- This method allows the User to get a list of Purchases broken down by Country

Purchases By Territory

This service allows the User to get a list of Addresses in the given Territory

Each Address will have the total value of goods purchased from them

Basic Usage: cloudcix.api.Financial.purchases_by_territory.<method>

Available Methods

cloudcix.api.Financial.purchases_by_territory.list
- This method allows the User to get a list of Purchases broken down by Territory

RTD (Return of Trading Details)

This service aggregates all the transactions in an Address for a year and calculates the total Sales, Purchases from the EU (excluding Ireland), Purchases for Resale, and Purchases not for Resale. Each of these totals are broken down according to the percentage tax that were applied to the transactions.

Basic Usage: cloudcix.api.Financial.rtd.<method>

Available Methods

cloudcix.api.Financial.rtd.list
- This method allows the User to see their sales and purchases for the year, grouped by the tax rates in use by their Address
- A year parameter is required for this method

Sales Analysis

This service allows the User to view the total Sales made to their Addresses

For each Address the service will calculate the total amount sold through Invoices less Credit Notes.

Basic Usage: cloudcix.api.Financial.sales_analysis.<method>

Available Methods

cloudcix.api.Financial.sales_analysis.list
- This method allows the User to get a list of total Sales with their Addresses

Sales By Country

This service allows the User to get a list of Countries along with the amounts spent in Sales for each in a period of time

Each Country will have the total amount excluding VAT, and the total amount of VAT spent

Basic Usage: cloudcix.api.Financial.sales_by_country.<method>

Available Methods

cloudcix.api.Financial.sales_by_country.list
- This method allows the User to get a list of Sales broken down by Country

Sales By Territory

This service allows the User to get a list of Addresses in the given Territory

Each Address will have the total value of goods sold to them

Basic Usage: cloudcix.api.Financial.sales_by_territory.<method>

Available Methods

cloudcix.api.Financial.sales_by_territory.list
- This method allows the User to get a list of Sales broken down by Territory

Statement

This service allows the User to issue Statements to each of their debtors.

Basic Usage: cloudcix.api.Financial.statement.<method>

Available Methods

cloudcix.api.Financial.statement.create
- This method generates and emails a Statement to each of the requesting User’s debtors
- A User can specify an address_id in the post data to only send statements to one debtor

Statement Log

This service allows the User to see a list of Statement Logs.

A Statement Log is a record that gets generated every time a statement is requested to be sent automatically by the system

Basic Usage: cloudcix.api.Financial.statement_log.<method>

Available Methods

cloudcix.api.Financial.statement_log.list
- This method allows the User to get a list of Statement Logs

Statement Settings

This service allows the User to manage its Statement Settings

The Statement Settings define the paramaters for if and when a Statement will be sent to an Address’s Debtors

Basic Usage: cloudcix.api.Financial.statement_settings.<method>

Available Methods

cloudcix.api.Financial.statement_settings.read
- This method allows the User to get the current Statement Settings for its active Address
cloudcix.api.Financial.statement_settings.update
- This method allows the User to update the current Statement Settings for its active Address

Tax Rate

This service allows the User to manage its Tax Rates

In a tax system, the Tax Rate describes a ratio (usually expressed as a percentage) at which a business or person is taxed

Basic Usage: cloudcix.api.Financial.tax_rate.<method>

Available Methods

cloudcix.api.Financial.tax_rate.list
- This method allows the User to get a list of Tax Rates
- Only Tax Rates belonging to the User will be returned
cloudcix.api.Financial.tax_rate.create
- This method allows the User to create a new Tax Rate for its Address
cloudcix.api.Financial.tax_rate.read
- This method allows the User to get a Tax Rate, and its details
- Only the owners of the Tax Rate can read it
cloudcix.api.Financial.tax_rate.update
- This method allows the User to update details of a Tax Rate
- Only the owners of the Tax Rate can read it
cloudcix.api.Financial.tax_rate.delete
- This method allows the User to delete a Tax Rate
- Only the owners of the Tax Rate can delete it

Trial Balance

This service allows the User to generate a Trial Balance

A Trial Balance is a list of all the general ledger accounts (both revenue and capital) contained in the ledger of a business

This list will contain the name of each Nominal Ledger account, and the value of that Nominal Ledger balance

Each Nominal Ledger account will hold either a Debit or Credit balance

Basic Usage: cloudcix.api.Financial.trial_balance.<method>

Available Methods

cloudcix.api.Financial.trial_balance.list
- This method allows the User to get the Trial Balance on a certain date
- If the User is acting as Global no address_id is specified, the Trial Balance will be calculated for all Addresses in its Member
- Otherwise, the Trial Balance will be calculated for its local Address

VAT3

This service allows the User to generate the data for a VAT3 report

A VAT3 report is a summary of all VAT incurred by an Address on all Sales and Purchases for a given date range

Basic Usage: cloudcix.api.Financial.vat3.<method>

Available Methods:

cloudcix.api.Financial.vat3.list
- This method allows the User to view the sum total VAT incurred by their Address for Sale, Purchases, EU Sales, and EU Purchases

VIES Purchases

This service allows the User to get a list of VIES Purchases

The VAT Information Exchange System (VIES) is an electronic means of transmitting information relating to VAT registration of companies registered in the EU

EU law requires that, where goods or services are procured with the EU, VAT must only be paid in the member state where the purchaser resides

For this reason, suppliers need an easy way to validate the VAT numbers presented by purchasers. This validation is performed through VIES

Basic Usage: cloudcix.api.Financial.vies_purchases.<method>

Available Methods

cloudcix.api.Financial.vies_purchases.list
- This method allows the User to get a list of Addresses from within the EU where the Tax Rate on transactions was zero and return the total amount spent in Purchases.

VIES Sales

This service allows the User to get a list of VIES Sales

The VAT Information Exchange System (VIES) is an electronic means of transmitting information relating to VAT registration of companies registered in the EU

EU law requires that, where goods or services are procured with the EU, VAT must only be paid in the member state where the purchaser resides

For this reason, suppliers need an easy way to validate the VAT numbers presented by purchasers. This validation is performed through VIES

Basic Usage: cloudcix.api.Financial.vies_sales.<method>

Available Methods

cloudcix.api.Financial.vies_sales.list
- This method allows the User to get a list of Addresses from within the EU where the Tax Rate on transactions was zero and return the total amount spent in Sales

Year End

This service allows the User to manage its Year End transactions

A Year End Transaction (12002) is a transaction which will calculate the balance between the previous Year End (or the oldest transaction if none exists) and the given transaction date

A Year End Transaction is always associated with a Period End Transaction

Basic Usage: cloudcix.api.Financial.year_end.<method>

Available Methods

cloudcix.api.Financial.year_end.list
- This method allows the User to get a list of Year End transactions
cloudcix.api.Financial.year_end.create
- This method allows the User to create a new Year End Transaction.
- If there is no Period End Transaction at the given transaction_date, one will be created
- The Year End’s transaction_date can not be set to be any time in the future
cloudcix.api.Financial.year_end.read
- This method allows the User to get a Year End Transaction and its details
cloudcix.api.Financial.year_end.delete
- This method allows the User to delete a Year End Transaction, and its associated Period End Transaction
- The Year End Transaction can only be deleted if the associated Period End transaction is the latest one

IAAS

The IaaS application provides services that allow for management of IP Addresses, Subnets, and DNS records, along with accessing black and whitelists generated by CloudCIX. It also provides services that allow for interaction with the CloudCIX system to deploy Projects and Virtual Machines.

Basic Usage: cloudcix.api.IAAS.<service>.<method>

Services

Allocation

An Allocation is an IP address range that was assigned to an ASN by an RIR such as RIPE.

Allocations can be freely managed by the Member that owns a particular ASN.

Note

Only Users in the CIX Member are able to create new Allocations.

Basic Usage: cloudcix.api.IAAS.allocation.<method>

Available Methods

cloudcix.api.IAAS.allocation.list
- This method lists all Allocations that are associated with the Member of the User calling the method.
cloudcix.api.IAAS.allocation.create
- This method creates a new Allocation for a specified Member.
- This method can only be run by an Administrator.
cloudcix.api.IAAS.allocation.read
- This method allows the User to get the information of a given Allocation that belongs to their Member.
cloudcix.api.IAAS.allocation.update
- This method allows the User to update the details of a given Allocation that belongs to their Member.
- This method can only be run by an Administrator.
cloudcix.api.IAAS.allocation.delete
- This method allows the User to delete a given Allocation that belongs to their Member.
- An Allocation can only be deleted when it is empty.
- This method can only be run by an Administrator.

ASN

Autonomous System Numbers (ASNs) are assigned in blocks by the Internet Assigned Numbers Authority (IANA) to Regional Internet Registries (RIRs).

The appropriate RIR then assigns ASNs to entities within its designated area from the block assigned to them by the IANA.

ASNs can be assigned to a CloudCIX Member who then becomes the owner of the ASN and is granted the ability to manage its contents.

Note

While the ASN service provides a full set of CRUDL methods, Create, Update and Delete can only be used by Users within the CIX Member. Please contact support if you need to run one of these methods.

Basic Usage: cloudcix.api.IAAS.asn.<method>

Available Methods

cloudcix.api.IAAS.asn.list
- This method returns a list of all ASNs that belong to the User’s Member.
cloudcix.api.IAAS.asn.create
- This method allows a User to create an ASN belonging to a specified Member.
- This method can only be run by CIX Users
cloudcix.api.IAAS.asn.read
- This method allows a User to read the details of a particular ASN belonging to their Member.
cloudcix.api.IAAS.asn.update
- This method allows the User to update the details of a specified ASN.
- This method can only be run by CIX Users.
cloudcix.api.IAAS.asn.delete
- This method allows the User to delete a specified ASN.
- ASNs can only be deleted when they are empty.
- This method can only be run by CIX Users.

Attach

This service lets a user link two Resources that they own

Basic Usage: cloudcix.api.IAAS.attach.<method>

Available Methods

cloudcix.api.IAAS.attach.update
- The User must supply the IDs of two Resources that will be linked. The virtual infrastructure will then be visible to each other.

Backup

This service provides methods used to manage a Backup of a VM.

Basic Usage: cloudcix.api.IAAS.backup.<method>

Available Methods

cloudcix.api.IAAS.backup.list
- This method allows the User to list all the Backups that they own.
cloudcix.api.IAAS.backup.create
- This method allows the User to create a new Backup of a VM in a Project that they own.
cloudcix.api.IAAS.backup.read
- This method allows the User to retrieve the information of a given Backup.
cloudcix.api.IAAS.backup.update
- This method allows the User to update the details of a given Backup.

Backup History

This service allows the User to retrieve the History for their Backup.

Backup History records are created whenever there are state changes. These records have a user attached to them, so that all changes can be traced back to the User that made them.

Basic Usage: cloudcix.api.IAAS.backup_history.<method>

Available Methods

cloudcix.api.IAAS.backup_history.list
- This method retrieves a list of History records for a user’s address Backups.

Capacity

This service lets a User list the VMs with the largest capacity that they can build in a region, grouped by Server type (KVM, HyperV), and Storage Type (HDD, SSD). The user must be a customer of a region to list the specs of VMs they can build.

Basic Usage: cloudcix.api.IAAS.capacity.<method>

Available Methods

cloudcix.api.IAAS.capacity.list
- This method lists the VMs with the largest combination of compute resources in the region

Ceph

This service lets a User manage Ceph Drives for network-attached storage.

Basic Usage: cloudcix.api.IAAS.ceph.<method>

Available Methods

cloudcix.api.IAAS.ceph.list
- This method allows the User to list all the Ceph Drives that they own.
cloudcix.api.IAAS.ceph.create
- This method allows the User to create a new Ceph Drive in a Project that they own.
cloudcix.api.IAAS.ceph.read
- This method allows the User to retrieve the information of a given Ceph Drive.
cloudcix.api.IAAS.ceph.update
- This method allows the User to update the details of a given Ceph Drive.

CIX Blacklist

CIX Blacklist is a storage for CIDRs that are recognised by CIX as malicious.

Basic Usage: cloudcix.api.IAAS.blacklist.<method>

Available Methods

cloudcix.api.IAAS.blacklist.list
- This method allows the User to retrieve a list of CIX Blacklist records.
cloudcix.api.IAAS.blacklist.read
- This method allows the User to read the details of a specific CIX Blacklist record.

CIX Whitelist

CIX Whitelist is a storage for CIDRs that are recognised by CIX as trustworthy.

Basic Usage: cloudcix.api.IAAS.whitelist.<method>

Available Methods

cloudcix.api.IAAS.whitelist.list
- This method allows the User to retrieve a list of CIX Whitelist records.
cloudcix.api.IAAS.whitelist.read
- This method allows the User to read the details of a specific CIX Whitelist record.

Cloud

The Cloud Service is a one stop endpoint to safely create an entire cloud Project in a single request, instead of interacting with the various other services individually.

The biggest benefit of this approach is that nothing will be created in hardware unless the entire request is successful, which would not be possible via the individual services themselves.

Basic Usage: cloudcix.api.IAAS.cloud.<method>

Available Methods

cloudcix.api.IAAS.cloud.create
- This method allows the User to safely create all of the infrastructure for a Project in a single request.
cloudcix.api.IAAS.cloud.read
- This method returns all of the details for a Project, including all of the infrastructure available.
cloudcix.api.IAAS.cloud.update
- This method allows the User to update a Cloud Project, simultaneously updating existing infrastructure as well as adding new infrastructure to an existing Project, all in a single request.

Detach

This service lets a user un-link two Resources that they own

Basic Usage: cloudcix.api.IAAS.detach.<method>

Available Methods

cloudcix.api.IAAS.detach.update
- The User must supply the ID of the Resources to detach

Device

This service provides information regarding Devices.

Basic Usage: cloudcix.api.IAAS.device.<method>

Available Methods

cloudcix.api.IAAS.device.list
- This method allows the User to list Devices for a Server in their region.
- If the requesting user is global active they will able to list all Devices for all Server in their regions.
cloudcix.api.IAAS.device.create
- This method allows the User to create a Device for a Server in their region.
cloudcix.api.IAAS.device.read
- This method allows the User to to retrieve the information of a particular Device for a Server in their region.
- If the requesting user is global active they will able to retrieve the information for a Device for a Server in another region.
cloudcix.api.IAAS.device.update
- This method allows the User to update a Device of a Server in their region.

Device Type

This service provides access to a list of Device Type options that we can currently provide as Devices.

Basic Usage: cloudcix.api.IAAS.device_type.<method>

Available Methods

cloudcix.api.IAAS.device_type.list
- This method allows the User to list Device Types available.

Domain

Any CloudCIX Member is able to create a Domain and manage its DNS records through the API.

CIX uses the Rage4 DNS Service to propogate DNS records to DNS servers.

Note

In order to use DNS records set up through this service, please set your domain’s nameservers to ns1.r4ns.com and ns2.r4ns.com

Basic Usage: cloudcix.api.IAAS.domain.<method>

Available Methods

cloudcix.api.IAAS.domain.list
- This method allows the User to retrieve a list of Domains owned by its Member.
cloudcix.api.IAAS.domain.create
- This method allows the User to create a new Domain record.
- This record is stored locally and also announced to the Rage4 DNS service.
cloudcix.api.IAAS.domain.read
- This method allows the User to read the details of a specific Domain record that is owned by its Member.
cloudcix.api.IAAS.domain.update
- This method allows the User to update the details of a specific Domain record owned by its Member.
- This update is reflected both locally and on the Rage4 service.
cloudcix.api.IAAS.domain.delete
- This method allows the User to delete a specific Domain record from both the IaaS Application and the Rage4 service.

Image

This service provides access to a list of Images or Operating Systems that we can currently provide in deployed VMs.

Basic Usage: cloudcix.api.IAAS.image.<method>

Available Methods

cloudcix.api.IAAS.image.list
- This method allows the User to retrieve a list of supported Images.
cloudcix.api.IAAS.image.read
- This method allows the User to get the details of a specific Image.

Interface

This service provides information regarding physical interfaces on Servers.

Basic Usage: cloudcix.api.IAAS.interface.<method>

Available Methods

cloudcix.api.IAAS.interface.list
- This method allows the User to list Interfaces in their region
- If the requesting user is global active they will able to list all Interfaces for all regions.
cloudcix.api.IAAS.interface.create
- This method allows the User to create an Interface for a Server in their region.
cloudcix.api.IAAS.interface.read
- This method allows the User to retrieve the information of a particular Interface in their region.
- If the requesting user is global active they will able to retrieve the information for an Interface in another region.
cloudcix.api.IAAS.interface.update
- This method allows the User to update an Interface for a Server in their region.
cloudcix.api.IAAS.interface.delete
- This method allows the User to delete an Interface for a Server in their region.

IP Address

CloudCIX allows its Users to organise IP Addresses by creating a clean structure of ASN > Allocation > Subnet > IPAddress.

Additionally, IP Addresses are used to organise Reverse DNS records.

An IP Address can only be managed by the Member who owns the Subnet that contains it.

Basic Usage: cloudcix.api.IAAS.ipaddress.<method>

Available Methods

cloudcix.api.IAAS.ipaddress.list
- This method allows the User to retrieve a list of IP Addresses belonging to their Member.
cloudcix.api.IAAS.ipaddress.create
- This method allows the User to create a new IP Address for their Member.
cloudcix.api.IAAS.ipaddress.read
- This method allows the User to retrieve the details of a specific IP Address record.
cloudcix.api.IAAS.ipaddress.update
- This method allows the User to update the details of a given IP Address record.
cloudcix.api.IAAS.ipaddress.delete
- This method allows the User to delete an IP Address record from the IaaS database.

IP Validator

A utility service that can validate any number of address ranges and/or ip addresses.

It provides various details about the supplied parameters.

Basic Usage: cloudcix.api.IAAS.ip_validator.<method>

Available Methods

cloudcix.api.IAAS.ip_validator.list
- Given addressRanges and/or ipAddresses, this method will validate all of the supplied information.
- Multiple addressRanges and ipAddresses should be comma separated; e.g. ipAddresses=192.168.0.2,192.168.0.3,192.168.0.3
- If both the addressRanges and ipAddresses parameters are passed, this method will also check to make sure that each ipAddress belongs to at least one of the supplied addressRanges.
- If none of the passed parameters are valid, the method will return HTTP 400 - Bad Request.
- If one or more parameters are valid, the method will respond with HTTP 200 - Success.
- Each individual ipAddress and addressRange are returned with a valid flag, stating if they were valid or not.

Metrics

This service provides metric information about a given region.

Available Methods

cloudcix.api.IAAS.metrics.read
- This method allows the User to read the metrics for the given region.
- If no changes have happened since the last time metrics were read, the request will result in a HTTP 204 response.
- This check can be skipped if the force GET parameter is set to true.

Policy Log

Retrieves the logs for a Virtual Router for a specified Project.

Basic Usage: cloudcix.api.IAAS.policy_log.<method>

Available Methods

cloudcix.api.IAAS.policy_log.list
- This method allows the User to retrieve a list of log items from the Router for the specified Project.

Project

This service provides methods used to manage a Project.

This service differs from the Cloud service because this service deals only with Project records, whereas Cloud deals with every other record related to a Project at once.

Basic Usage: cloudcix.api.IAAS.project.<method>

Available Methods

cloudcix.api.IAAS.project.list
- This method allows the User to list all the Projects that they own.
cloudcix.api.IAAS.project.create
- This method allows the User to create a new Project.
cloudcix.api.IAAS.project.read
- This method allows the User to retrieve the information of a given Project.
cloudcix.api.IAAS.project.update
- This method allows the User to update the details of a given Project.

PTR Record

The PTR Record service is used to manage PTR type DNS Records, also known as Reverse DNS records.

The User is required to provide an IPAddress that the Record will target, and the content that should be stored with the Record.

The service will select the correct reverse domain correctly based on the IP Address and will automatically populate the name field of the record which will be the reversed IP Address.

Basic Usage: cloudcix.api.IAAS.ptr_record.<method>

Available Methods

cloudcix.api.IAAS.ptr_record.list
- This method allows the User to retrieve a list of PTR Records belonging to their Member.
cloudcix.api.IAAS.ptr_record.create
- This method allows the User to create a PTR Record.
- The Record will be created both locally and on the Rage4 service.
- The User’s Member must own the supplied IP Address for the method to be successful.
cloudcix.api.IAAS.ptr_record.read
- Thie method allows the User to read the details of a specified PTR Record.
cloudcix.api.IAAS.ptr_record.update
- This method allows the User to update the details of a specified PTR Record.
- The Record will be updated both locally and on the Rage4 service.
cloudcix.api.IAAS.ptr_record.delete
- This method allows the User to delete a specified PTR Record.
- The Record will be deleted both locally and on the Rage4 service.

Record

The Record service is used to manage Forward DNS entries that are tied to Domains.

Records for a particular Domain can only be managed by the Member that owns that Domain.

Record Types

Record Type	ID
NS	1
A	2
AAAA	3
CNAME	4
MX	5
TXT	6
SRV	7
SPF	9
SSHFP	10
LOC	11
NAPTR	12

Basic Usage: cloudcix.api.IAAS.record.<method>

Available Methods

cloudcix.api.IAAS.record.list
- This method allows the User to list all Records belonging to a Domain.
cloudcix.api.IAAS.record.create
- This method allows the User to create a new Record for a Domain.
- This new Record is saved locally and announce to the Rage4 service.
- The name and content of the Record vary depending on type (see Record Types table above).
- Depending on the type, parameters are checked against the Domain name and the IP Addresses owned by the User’s Member.
cloudcix.api.IAAS.record.read
- This method allows the User to retrieve the details of a single Record.
cloudcix.api.IAAS.record.update
- This method allows the User to update the details of a specific Record instance.
- Updates are stored locally and announced to the Rage4 service.
cloudcix.api.IAAS.record.delete
- This method allows the User to delete a Record.
- Records are deleted locally and from the Rage4 service.

Region Image

This service allows a user in a region to add/remove supported images to their region.

Basic Usage: cloudcix.api.IAAS.region_image.<method>

Available Methods

cloudcix.api.IAAS.region_image.create
- This method allows the User to add a supported image to their region.
cloudcix.api.IAAS.region_image.update
- This method allows the User to remove a supported image from their region.

Region Storage Type

This service allows a user in a region to add/remove supported storage types to their region.

Basic Usage: cloudcix.api.IAAS.region_storage_type.<method>

Available Methods

cloudcix.api.IAAS.region_storage_type.create
- This method allows the User to add a supported storage type to their region.
cloudcix.api.IAAS.region_storage_type.update
- This method allows the User to remove a supported storage type from their region.

Router

This service provides information regarding Routers.

Basic Usage: cloudcix.api.IAAS.server.<method>

Available Methods

cloudcix.api.IAAS.router.list
- This method allows the User to list Routers in their region.
- If the requesting user is global active they will able to list all Routers for all regions.
cloudcix.api.IAAS.router.create
- This method allows the User to create a Router in their region.
cloudcix.api.IAAS.router.read
- This method allows the User to to retrieve the information of a particular Router in their region.
- If the requesting user is global active they will able to retrieve the information for a Router for another region.
cloudcix.api.IAAS.router.update
- This method allows the User to update a Router in their region.

Run Robot

This service provides information on wether there has been any changes to a region and infrastructure should be built or updated.

Available Methods

cloudcix.api.IAAS.run_robot.list
- This method allows the User (robot) to retrieve a list of infrastructure for pojects that robot needs to process in their region.
cloudcix.api.IAAS.run_robot.create
- This method allows the User (robot) to turn run_robot off for a list of project_ids it has processed.

Server

This service provides information regarding Servers.

Basic Usage: cloudcix.api.IAAS.server.<method>

Available Methods

cloudcix.api.IAAS.server.list
- This method allows the User to list Servers in their region.
- If the requesting user is global active they will able to list all Servers for all regions.
cloudcix.api.IAAS.server.create
- This method allows the User to create a Server in their region.
cloudcix.api.IAAS.server.read
- This method allows the User to to retrieve the information of a particular Server in their region.
- If the requesting user is global active they will able to retrieve the information for a Server for another region.
cloudcix.api.IAAS.server.update
- This method allows the User to update a Server in their region.

Server Type

This service provides access to a list of Server Type options that we can currently provide as Servers.

Basic Usage: cloudcix.api.IAAS.server_type.<method>

Available Methods

cloudcix.api.IAAS.server_type.list
- This method allows the User to list Server Types available.
cloudcix.api.IAAS.server_type.read
- This method allows the User to retrieve the information of a particular Server Type.

Snapshot

This service provides methods used to manage a Snapshot of a VM.

Basic Usage: cloudcix.api.IAAS.snapshot.<method>

Available Methods

cloudcix.api.IAAS.snapshot.list
- This method allows the User to list all the Snapshots that they own.
cloudcix.api.IAAS.snapshot.create
- This method allows the User to create a new Snapshot of a VM in a Project that they own.
cloudcix.api.IAAS.snapshot.read
- This method allows the User to retrieve the information of a given Snapshot.
cloudcix.api.IAAS.snapshot.update
- This method allows the User to update the details of a given Snapshot.

Snapshot History

This service allows the User to retrieve the History for their Snapshots.

Snapshot History records are created whenever there are state changes. These records have a user attached to them, so that all changes can be traced back to the User that made them.

Basic Usage: cloudcix.api.IAAS.snapshot_history.<method>

Available Methods

cloudcix.api.IAAS.snapshot_history.list
- This method retrieves a list of History records for a user’s address Snapshots.

Snapshot Tree

This service provides methods used to manage a Snapshot Tree of a VM.

Basic Usage: cloudcix.api.IAAS.snapshot_tree.<method>

Available Methods

cloudcix.api.IAAS.snapshot.read
- This method allows the User to retrieve the information of a given Snapshot Tree for a specific VM.

Storage

Provides information regading Storage for a VM.

Storages can be created and managed by the owners of the Project.

Basic Usage: cloudcix.api.IAAS.storage.<method>

Available Methods

cloudcix.api.IAAS.storage.list
- This method allows the User to list all the Storages associated with a particular VM.
cloudcix.api.IAAS.storage.create
- This method allows the User to create a new Storage for a particular VM.
- Only administrators can use this method.
cloudcix.api.IAAS.storage.read
- This method allows the User to retrieve the information of a given Storage.

Storage Type

This service provides access to a list of Storage options that we can currently provide for VMs to be built in.

Basic Usage: cloudcix.api.IAAS.storage_type.<method>

Available Methods

cloudcix.api.IAAS.storage_type.list
- This method allows the User to list all the Storage Types available to build a VM.
cloudcix.api.IAAS.storage_type.read
- This method allows the User to retrieve the information of a particular Storage Type.

Subnet

The IaaS Application allows for the modelling of a one level network setup, and for the storage of information about subnets and machines located at specific IP Addresses.

Subnets can be created by ASN owners and managed by either ASN owners or their clients.

Once a Subnet is created for a customer of the ASN owner, both the Customer and the ASN Owner can manage it.

Basic Usage: cloudcix.api.IAAS.subnet.<method>

Available Methods

cloudcix.api.IAAS.subnet.list
- This method allows the User to list all the Subnets associated with a particular Member.
cloudcix.api.IAAS.subnet.create
- This method allows the User to create a new Subnet for a particular Member.
- Only administrators can use this method.
cloudcix.api.IAAS.subnet.read
- This method allows the User to retrieve the information of a particular Subnet.
cloudcix.api.IAAS.subnet.update
- This method allows the User to update the details of a given Subnet.
cloudcix.api.IAAS.subnet.delete
- This method allows the User to delete a Subnet from the list of a Member’s Subnets.
- A Subnet can only be deleted if all its IP Addresses have already been deleted.

Subnet Space

This service will return a list of existing and free subnets avialable for a particular Allocation.

Basic Usage: cloudcix.api.IAAS.subnet_space.<method>

Available Methods

cloudcix.api.IAAS.subnet.list
- This method allows the User to list the existing and free subnet space for a given Allocation.

Virtual Router

This service provides methods used to manage a Virtual Router.

A Virtual Router is a software based Router built specifically for a Cloud Project.

Basic Usage: cloudcix.api.IAAS.virtual_router.<method>

Available Methods

cloudcix.api.IAAS.virtual_router.list
- This method allows the User to list all the Virtual Routers that they own.
cloudcix.api.IAAS.virtual_router.read
- This method allows the User to retrieve the information of a given Virtual Router.
cloudcix.api.IAAS.virtual_router.update
- This method allows the User to update the details of a given Virtual Router.

VM

This service provides methods used to manage a VM.

Basic Usage: cloudcix.api.IAAS.vm.<method>

Available Methods

cloudcix.api.IAAS.vm.list
- This method allows the User to list all the VMs that they own.
cloudcix.api.IAAS.vm.create
- This method allows the User to create a new VM in a Project that they own.
cloudcix.api.IAAS.vm.read
- This method allows the User to retrieve the information of a given VM.
cloudcix.api.IAAS.vm.update
- This method allows the User to update the details of a given VM.

VM History

This service allows the User to retrieve the History for their VMs.

VM History records are created whenever important details about the VM are changed, like the VM’s state for example. These records have a user attached to them, so that all changes can be traced back to the User that made them.

Basic Usage: cloudcix.api.IAAS.vm_history.<method>

Available Methods

cloudcix.api.IAAS.vm_history.list
- This method retrieves a list of History records for a user’s address VMs.

VPN

This service provides methods used to manage a VPN.

A VPN record is used to create a VPN between the User’s local network(s) and a local network in a Project.

Basic Usage: cloudcix.api.IAAS.vpn.<method>

Available Methods

cloudcix.api.IAAS.vpn.list
- This method allows the User to list all the VPNs that they own.
cloudcix.api.IAAS.vpn.create
- This method allows the User to create a new VPN in a Virtual Router that they own.
cloudcix.api.IAAS.vpn.read
- This method allows the User to retrieve the information of a given VPN.
cloudcix.api.IAAS.vpn.update
- This method allows the User to update the details of a given VPN.
cloudcix.api.IAAS.vpn.delete
- This method allows the User to delete a VPN.

VPN History

This service allows the User to retrieve the History for their VPNs.

VPN History records are created whenever important details about the VPN are changed, like when the VPN is built for example. These records have a user attached to them, so that all changes can be traced back to the User that made them.

Basic Usage: cloudcix.api.IAAS.vpn_history.<method>

Available Methods

cloudcix.api.IAAS.vpn_history.list
- This method retrieves a list of History records for a user’s address VPNs.

VPN Status

Retrieves the vpn status for a specified VPN.

Basic Usage: cloudcix.api.IAAS.vpn_status.<method>

Available Methods

cloudcix.api.IAAS.vpn_status.read
- This method allows the User to retrieve vpn status information from the Router for the specified VPN.

Membership

Membership is a CloudCIX Application that exposes a REST API capable of managing CloudCIX Members and relationships between those Members

It is the cornerstone of CloudCIX

It controls Membership, and manages both secure login and granular access

The Membership Application also gives CloudCIX true multi-tenanted capability to allow you to transact, and securely share information, with your partner Members

For more information on the key aspects of this Application, see Member, Address, and User

Basic Usage: cloudcix.api.Membership.<service>.<method>

Services

Address

An Address points to a physical location where an organisation conducts their business

Each Member can have one or more Addresses

Trading transactions occur between a Supplier and Customer Address, while some other transactions occur at a single Address, e.g. depreciation

This service allows the User to manage their Addresses

Basic Usage: cloudcix.api.Membership.address.<method>

Available Methods

cloudcix.api.Membership.address.list
- Allows the User to get a list of Addresses associated with a Member
- Addresses returned belong to either the User’s Member, or a Member linked with the User’s Member
cloudcix.api.Membership.address.create
- Allows the User to create a new Address
- The Address can be created for either the User’s own Member, or one that is linked to the User’s Member
- In order to create an Address for a linked Member, the linked Member must not be self managed
- The Address created will automatically be linked to the Address of the User creating it
cloudcix.api.Membership.address.read
- Allows the User to get the details of an Address
cloudcix.api.Membership.address.update
- Allows the User to update the details of an Address

The Address list can also be accessed through a verbose endpoint. This endpoint will return more data than the regular Address list method but will take more time to return a response.

Basic Usage: cloudcix.api.Membership.verbose_address.list

Address Link

An Address Link object represents a link between two Addresses, which allows transactions to be performed between them

Addresses must be linked in order to conduct business between them

The link allows each Address to have particular details about the Contra Address (the Address to which the Link is to)

Basic Usage: cloudcix.api.Membership.address_link.<method>

Available Methods

cloudcix.api.Membership.address_link.create
- Allows the User to create a Link between two Addresses
- A Link can only be created between Addresses in Members that are already linked, or Addresses in the same Member
cloudcix.api.Membership.address_link.read
- Allows the User to get the details of an Address Link
cloudcix.api.Membership.address_link.update
- Allows the User to update the details of an Address Link record

Note

Based on how the URLs for read and update are structured, it is required you pass pk=None to both of these methods

API Key

The API Key service allows for an Address to store multiple API Keys in CloudCIX Membership.

Basic Usage: cloudcix.api.Membership.api_key.<method>

Available Methods

cloudcix.api.Membership.api_key.list
- Allows the User to get a list of API Keys.
- Local Users can list Public Keys for their own Address.
- A Global User can list API Keys for Addresses in their Member.
cloudcix.api.Membership.api_key.create
- Allows the User to create a new API Key record for their Address.
cloudcix.api.Membership.api_key.read
- Allows the User to get the details of a given API Key.
cloudcix.api.Membership.api_key.update
- Allows the User to update the details of a given API Key in their Address.
cloudcix.api.Membership.api_key.delete
- Allows the User to delete a given API Key in their address.

Country

This service allows the User to get Country information in accordance with ISO 3166-1

Basic Usage: cloudcix.api.Membership.country.<method>

Available Methods

cloudcix.api.Membership.country.list
- Allows the User to get a full list of Countries in ISO 3166-1 format
cloudcix.api.Membership.country.read
- Allows the User to get the details of a specific Country

Currency

This service allows the User to get information about the different Currencies supported by CloudCIX

Basic Usage: cloudcix.api.Membership.currency.<method>

Available Methods

cloudcix.api.Membership.currency.list
- Allows the User to get the full list of Currencies supported by CloudCIX
cloudcix.api.Membership.currency.read
- Allows the User to get the details of a specific Currency

Department

A Department is a specialized division of a large organisation that groups Users together

Example Departments can include: - Design - IT - Software Development - Sales

This service provides methods to manage the Departments in an organisation

Basic Usage: cloudcix.api.Membership.department.<method>

Available Methods

cloudcix.api.Membership.department.list
- Allows the User to get a list of Departments available for the User’s Member
cloudcix.api.Membership.department.create
- Allows the User to create a new Department for their Member
- This method can only be run by an Administrator
cloudcix.api.Membership.department.read
- Allows the User to get the details of a specific Department
cloudcix.api.Membership.department.update
- Allows the User to update the details of a specific Department
- This method can only be run by an Administrator
cloudcix.api.Membership.department.delete
- Allows the User to delete a specific Department record
- A Department can only be deleted if there are no Users assigned to it
- This method can only be run by an Administrator

Email Confirmation

Email Confirmation allows the user to verify their email

This service provides methods to verify a users email

Basic Usage: cloudcix.api.Membership.email_confirmation.<method>

Available Methods

cloudcix.api.Membership.email_confirmation.read
- Allows the User to verify their email confirmation using the URL sent by email

Franchise Logic

This service returns the franchise logic between for sent builder_address_id, distributor_address_id and CloudCIX.

Basic Usage: cloudcix.api.Membership.franchise_logic.<method>

Available Methods

cloudcix.api.Membership.franchise_logic.read
- Allows the User to get the franchise logic details set up between builder_address_id, distributor_address_id and CloudCIX.
- This method is only available to administrators in Member 1

Language

This service allows the User to get information about the languages that are available for use in CloudCIX

Basic Usage: cloudcix.api.Membership.language.<method>

Available Methods

cloudcix.api.Membership.language.list
- Allows the User to get the full list of Languages supported by CloudCIX
cloudcix.api.Membership.language.read
- Allows the User to get the details of specific Language

Member

A Member can be a company, brand, multinational corporation or a sole trader, but a Member is always a business

A Member may be Self Managed or not

A Self Managed Member is run by an Administrator inside the Member and is responsible for themselves

If a Member is not Self Managed, that means there is another Member which is responsible for managing it

This service provides methods to manage Member records

Basic Usage: cloudcix.api.Membership.member.<method>

Available Methods

cloudcix.api.Membership.member.list
- Allows the User to get a list of Members that are linked to the given Member
cloudcix.api.Membership.member.create
- Allows the User to create a new Member
- The created Member will automatically be linked to the Member of the User
- If the Member is Self Managed, it will also be linked to CloudCIX
cloudcix.api.Membership.member.read
- Allows the User to get the details of a given Member
cloudcix.api.Membership.member.update
- Allows the User to update the details of a given Member
- If the Member becomes Self Managed, then it will automatically be linked to CloudCIX

Member Link

A Member Link represents a Link between two Members

This service provides a method to see if the User’s Member is linked to another Member

Basic Usage: cloudcix.api.Membership.member_link.<method>

Available Methods

cloudcix.api.Membership.member_link.read
- Allows the User to check if their Member is linked to a given Member
- Returns HTTP 204 is a Link between the Members exists

Notification

A Notification record takes account of all the Users in an Address who should be notified about transactions

Basic Usage: cloudcix.api.Membership.notification.<method>

Available Methods

cloudcix.api.Membership.notification.read
- Allows the User to get a list of User records within an Address who have Notifications active for the given Transaction Type

Profile

A Profile can be a group of nurses (Users) in a hospital (Member).

Profiles are a custom or default classification for a User for a particular Member

Basic Usage: cloudcix.api.Membership.profile.<method>

Available Methods

cloudcix.api.Membership.profile.list
- Allows the User to get a list of Profiles belonging to the specified Member
cloudcix.api.Membership.profile.create
- Allows the User to create a new Profile record for the given Member
- Members can create Profiles for other Linked Members if the Linked Member is not Self Managed
- This method can only be run by an Administrator
cloudcix.api.Membership.profile.read
- Allows the User to get the details of a given Profile, including the Users that are in that Profile
cloudcix.api.Membership.profile.update
- Allows the User to update the details of a given Profile
- Members can update Profiles for other Linked Members if the Linked Member is not Self Managed
- This method can only be run by an Administrator
cloudcix.api.Membership.profile.delete
- Allows the User to delete a given Profile
- Members can update Profiles for other Linked Members if the Linked Member is not Self Managed
- Profiles can only be deleted when they are not assigned to any User
- This method can only be run by an Administrator

Public Key

The Public Key service allows for a user to store multiple Public Keys in CloudCIX Membership.

Basic Usage: cloudcix.api.Membership.public_key.<method>

Available Methods

cloudcix.api.Membership.public_key.list
- Allows the User to get a list of Public Keys.
- An Administrator can list Public Keys for users in their Member.
- Non Administrator Users can list Public Keys for their own User.
cloudcix.api.Membership.public_key.create
- Allows the User to create a new Public Key record for a User.
- An Administrator can create a Public Key record for another User in their Member.
- Non Administrator Users can create a Public Key record for their own User.
cloudcix.api.Membership.public_key.read
- Allows the User to get the details of a given Public Key.
cloudcix.api.Membership.public_key.update
- Allows the User to update the details of a given Public Key.
- An Administrator can update a Public Key record for another User in their Member.
- Non Administrator Users can update a Public Key record for their own User.
cloudcix.api.Membership.public_key.delete
- Allows the User to delete a given Public Key.
- An Administrator can delete a Public Key record for another User in their Member.
- Non Administrator Users can delete a Public Key record for their own User.

Subdivision

The Subdivision service contains methods to get data about Subdivisions in accordance with ISO 3166-2

An example of a Subdivision is a County in Ireland

Basic Usage: cloudcix.api.Membership.subdivision.<method>

Available Methods

cloudcix.api.Membership.subdivision.list
- Allows the User to get a list of all Subdivisions for a given Country
cloudcix.api.Membership.subdivision.read
- Allows the User to read the details of a given Subdivision

Team

A Team is a tag describing a group of Users in a Member

For example, a Team can be a group of Users working on a particular project

Basic Usage: cloudcix.api.Membership.team.<method>

Available Methods

cloudcix.api.Membership.team.list
- Allows the User to get a list of all Teams in the User’s own Member
cloudcix.api.Membership.team.create
- Allows the User to create a new Team for their Member
- This method can only be run by an Administrator
cloudcix.api.Membership.team.read
- Allows the User to get the details of a given Team, including the Users who belong to it
cloudcix.api.Membership.team.update
- Allows the User to update the details of a given Team record
- This method can only be run by an Administrator
cloudcix.api.Membership.team.delete
- Allows the User to delete a Team record
- Warning
  
  A Team will be deleted even if there are Users assigned to it
- This method can only be run by an Administrator

Territory

A Territory is a classification or tag that a Member can use for grouping their business partners

For example, a Member can group partners be location or by what product they sell/purchase

Basic Usage: cloudcix.api.Membership.territory.<method>

Available Methods

cloudcix.api.Membership.territory.list
- Allows the User to get a list of Territories available for the given Member
cloudcix.api.Membership.territory.create
- Allows the User to create a new Territory record
- Members can create a Territory for Linked Members provided the Linked Member is not Self Managed
cloudcix.api.Membership.territory.read
- Allows the User to read the details of a given Territory
cloudcix.api.Membership.territory.update
- Allows the User to update the details of a given Territory
- Members can update a Territory for Linked Members provided the Linked Member is not Self Managed
cloudcix.api.Membership.territory.delete
- Allows the User to delete a given Territory
- A Territory can only be deleted if there are no Addresses assigned to it

Token

This service allows the User to validate credentials, or generate a token used to access the rest of the API.

If just an email and password are supplied, the credentials will simply be validated, and return either a status 200 if they are valid, or a 400 if not. If an api_key is supplied alongside the email and password, if the email and password are valid, the service will attempt to generate a token for the user in the scope of the Member that owns the supplied api_key

Usage: cloudcix.api.Membership.token.<method>

Available Methods

cloudcix.api.Membership.token.create
- Allows the user to create an authentication token
- Necessary Data
  
  email
  
  The email of the user
  
  Required
  
  password
  
  The password of the user
  
  Required
  
  api_key
  
  The api_key of the member the user wants a token for
  
  Required to generate a token, not to validate auth

Note

The usual token parameter is not required for these methods.

Transaction Type

The TransactionType service contains methods that give information about the types of transactions supported by CloudCIX

Most services in CloudCIX work using transactions; - Financial.account_sale_invoice - Financial.cash_sale_invoice - Support.ticket

are all examples of Transaction based services, and each of these services has their own transaction_type_id

Transaction Types identify each one in a unique way, and along with the Transaction Sequence Number (TSN) it makes a transaction unique for each Address of a Member

Basic Usage: cloudcix.api.Membership.transaction_type.<method>

Available Methods

cloudcix.api.Membership.transaction_type.list
- Allows the User to get the full list of Transaction Types available in CloudCIX
cloudcix.api.Membership.transaction_type.read
- Allows the User to read the details of a given Transaction Type

User

A User record represents a person located at an Address of a Member that can log in to the CloudCIX system

A User can either be Local to one Address, or Global within a Member, and Global Users can choose to act as a Local or Global at any time - When acting as a Global User, they see all data from each Address in the Member simultaneously - When acting as a Local User, they only see information relating to their current Address

A User can also be an Administrator, which is a special User account that has privileges that enable it to manage other User accounts, change system configuration and perform critical actions

Administrators also set the permissions for other Users in the Member

In order to create additional Administrators for your Member, it is necessary to contact CloudCIX support directly

Basic Usage: cloudcix.api.Membership.user.<method>

Available Methods

cloudcix.api.Membership.user.list
- Allows the User to get a list of Users linked to their Member
cloudcix.api.Membership.user.create
- Allows the User to create a new User record for the specified Member and Address that is either an Administrator or a normal User
- The first User in a Member automatically becomes an Administrator
- The User can create Users in other Members if the Members are linked, the requesting User’s Address is linked to the target Address, and the target Member is not Self Managed
cloudcix.api.Membership.user.read
- Allows the User to read the details of a given User
cloudcix.api.Membership.user.update
- Allows the User to update the details of a given User
- Only Global Users who are acting Global are able to change their idAddress
- Warning
  
  A User cannot update the following fields: idProfile, idDepartment, jobTitle, startDate, expiryDate, notifications. These fields can only be updated by an Administrator

NLP

Basic Usage: cloudcix.api.NLP.<service>.<method>

Services

Embedding USE

This service is used in the NLP application to contact a NN Model and return the embeddings for the sent text. Basic Usage: cloudcix.api.NLP.embedding_use.<method>

Available Methods

cloudcix.api.NLP.embedding_use.create
-This method creates a list of embeddings from the sent list of text in request.data

OTP

Basic Usage: cloudcix.api.OTP.<service>.<method>

Services

OTP

This service is used in the OTP authentication to save the OTP details and validate them Basic Usage: cloudcix.api.OTP.otp.<method>

Available Methods

cloudcix.api.OTP.otp.create
-This method creates or updates the users secret that is used in the OTP login

OTPAuth

This service is used in the OTP authentication to save the OTP details and validate them Basic Usage: cloudcix.api.OTP.otp_auth.<method>

Available Methods

cloudcix.api.OTP.otp_auth.read

This method validates a users OTP of a specific email

PAT

The PAT Application exposes a REST API capable of managing Pod records

Basic Usage: cloudcix.api.PAT.<service>.<method>

Services

Galaxy

This services allows for the management of Galaxy records.

A Galaxy represents the PAT properties to support Pods it supports.

Basic Usage: cloudcix.api.PAT.galaxy.<method>

Available Methods

cloudcix.api.PAT.galaxy.create
- Create a galaxy.
cloudcix.api.PAT.galaxy.read
- Returns the selected galaxy.
cloudcix.api.PAT.galaxy.update
- Update the specified galaxy.

Main Firewall Rules

This services allows for the management the Main Firewall Rules for a Pod.

Basic Usage: cloudcix.api.PAT.main_firewall_rules.<method>

Available Methods

cloudcix.api.PAT.main_firewall_rules.create
- pod_id is required in the method. This represents the POD the rules are for.
- Sending a List of rules in this request will remove the current rules if they exist and save the rules in the request
cloudcix.api.PAT.main_firewall_rules.list
- Returns the current list of the Main Firewall Rules for the specified pod_id

Pod

This services allows for the management of Pod records.

A Pod represents a logical unit of hardware and functionality in a cloud. A Pod is fully defined by a config.json file, which can be read using this Pod endpoint.

Basic Usage: cloudcix.api.PAT.pod.<method>

Available Methods

cloudcix.api.PAT.pod.list
- Return a list of all pods
cloudcix.api.PAT.pod.create
- Create a Pod.
cloudcix.api.PAT.pod.read
- Returns the selected pod

PLOT

The Plot Application exposes a REST API capable of managing historical measurement data.

Basic Usage: cloudcix.api.PAT.<service>.<method>

Services

Alert

This service helps to get alerts based on the Reading records

An Alert represents either a red or an amber alert of a Source’s Latest Reading

Basic Usage: cloudcix.api.Plot.alert.<method>

Available Methods

cloudcix.api.Plot.alert.list
- Return a list of all red or amber alerts of sources based on source’s latest readings

Catogory

This services allows for the management of Category records.

A Category represents a logical group name for Sources.

Basic Usage: cloudcix.api.Plot.category.<method>

Available Methods

cloudcix.api.Plot.category.list
- Return a list of all Categories.
cloudcix.api.Plot.category.read
- Returns the selected Category.

Reading

This services allows for the management of Reading records.

A Reading represents the measurement of a source at a specic point in time.

Basic Usage: cloudcix.api.Plot.reading.<method>

Available Methods

cloudcix.api.Plot.reading.list
- This method allows the User to list Readings.
- A User can list Readings for:
  
  Sources whose Category is owned by their Address
  
  If they are global, Sources whose Category is owned by Addresses in their Member
  
  Sources that have a Source Share record with their Address
  
  If they are global, Sources who have a Source Share record with Addresses in their Member
cloudcix.api.Plot.reading.create
- This method allows the User to create a Reading for a Source.

Source

This services allows for the management of Source records.

A Source represents an item to group readings together for.

Basic Usage: cloudcix.api.Plot.source.<method>

Available Methods

cloudcix.api.Plot.source.list
- Return a list of Sources.
cloudcix.api.Plot.source.create
- Create a Source.
cloudcix.api.PAT.source.read
- Returns the selected Source.
cloudcix.api.Plot.source.update
- Update a Source whose Category is owned by their Address.
cloudcix.api.Plot.source.delete
- Delete a Source whose Category is owned by their Address.
- Deleting a Source will delete all Readings and Source Shares of the Source.

SourceShare

This services allows for the management of Source Share records.

A Source Share represents an Address with who the Readings of a Source you own will be shared with.

Basic Usage: cloudcix.api.Plot.source_share.<method>

Available Methods

cloudcix.api.Plot.source_share.list
- Return a list of Source Shares.
cloudcix.api.Plot.source_share.create
- Create a Source Share.
cloudcix.api.PAT.source_share.read
- Returns the selected Source Share.
cloudcix.api.Plot.source_share.delete
- Delete a Source Share.

Unit

This services allows for the management of Unit records.

A Unit represents the measurement of the Readings of the Source instance it is assigned to.

Basic Usage: cloudcix.api.Plot.unit.<method>

Available Methods

cloudcix.api.Plot.unit.list
- Return a list of all Units.
cloudcix.api.Plot.unit.read
- Returns the selected Unit.

Report Engine

The Reporting Engine is a powerful service allowing users to generate HTML and PDF documents from templates

Basic Usage: cloudcix.api.Reporting.<service>.<method>

Services

Export

This service is used to create a file in the desired format by passing in data that should be used to collect the data being exported

Basic Usage: cloudcix.api.Reporting.export.<method>

Available Methods

cloudcix.api.Reporting.export.list
- This method allows the User to get a list of all files that have been exported that are either pending generation or ready to download
cloudcix.api.Reporting.export.create
- This method allows the User to request that a file be exported
- This method collects a bunch of data to export into a file
- The request is put into a queue, and a global id will be returned in the response
- This global id can then be used to download the exported file
cloudcix.api.Reporting.export.read
- This method allows the User to get the details of a file being exported
- The details will include the status of the export, the date when the file will expire, and a path to the generated document
cloudcix.api.Reporting.export.delete
- Allows the User to remove an Export and exported documents

Package

This service allows Users to create Packages of Reports and download a single file instead of a large number of files

The workflow for this method is as follows: 1. Create a Package 2. Create Report(s), passing in the idPackage each time 3. Update the Package and set its status to closed 4. When the status becomes closed, the report generation will begin 5. When the Package is ready, download your reports

Basic Usage: cloudcix.api.Reporting.package.<method>

Available Methods

cloudcix.api.Reporting.package.list
- This method allows the User to get a list of all Packages that are either being created or are ready to download
cloudcix.api.Reporting.package.create
- This method allows the User to create a new Package
- The response should contain an idPackage which can be used to put requested reports into a Package
cloudcix.api.Reporting.package.read
- This method allows the User to read the details of a Package, including its status, any error messages and the date when it will expire
cloudcix.api.Reporting.package.update
- This method allows the User to set the Package status to closed
- This will start a background process of gathering and packaging documents for download
cloudcix.api.Reporting.package.delete
- This method allows the User to delete a Package and all its associated documents

Report

This service is used to create PDF or HTML documents from existing Templates by passing in the data to populate the Template

Basic Usage: cloudcix.api.Reporting.report.<method>

Available Methods

cloudcix.api.Reporting.report.list
- This method allows the User to get a list of all Reports that are either pending generation or are ready for download
cloudcix.api.Reporting.report.create
- This method allows the User to request a new Report to be generated using a specified idReportTemplate and the given data
- This request will be put into a Queue and the response will contain an idReport
- If idPackage is passed as part of the request, the report will be removed only after the Package’s status has been updated to “closed”
cloudcix.api.Reporting.report.read
- This method allows the User to get the details of a Report
- This includes the status, the date at which the Report will expire and a path to the generated document
cloudcix.api.Reporting.report.delete
- This method allows the User to delete a Report and its generated documents

Report Template

This service allows Users to manage the Templates that they can use to generate HTML or PDF documents

Basic Usage: cloudcix.api.Reporting.report_template.<method>

Available Methods

cloudcix.api.Reporting.report_template.list
- This method allows the User to get a list of the Report Templates available to their Address
cloudcix.api.Reporting.report_template.create
- This method allows the User to create a new Report Template for their Address
cloudcix.api.Reporting.report_template.read
- This method allows the User to get the details of a Report Template
cloudcix.api.Reporting.report_template.update
- This method allows the User to update an existing Report Template with new content
cloudcix.api.Reporting.report_template.delete
- This method allows the User to delete an existing Report Template

Repository

Warning

This application is private and can only be used by Users within the CloudCIX company

The Repository Application is a software system that manages CloudCIX Software Projects

Projects in the Repository are grouped by the owning Member

Basic Usage: cloudcix.api.Repository.<service>.<method>

Services

Application

Every Member can have their own set of Applications

An Application contains one or more Services

This service allows the User to manage Applications

Basic Usage: cloudcix.api.Repository.application.<method>

Available Methods

cloudcix.api.Repository.application.list
- Allows the User to get a list of all Applications belonging to a given Member
cloudcix.api.Repository.application.create
- Allows the User to create new documentation for an Application for a given Member
cloudcix.api.Repository.application.read
- Allows the User to get all documentation for a given Application
cloudcix.api.Repository.application.update
- Allows the User to update the details of an Application’s documentation
cloudcix.api.Repository.application.delete
- Allows the User to delete an Application

DTO

A DTO, or Data Transfer Object, can be used as both Request and Response objects

DTOs are used to build complex objects

This service allows the User to manage DTO instances

Basic Usage: cloudcix.api.Repository.dto.<method>

Available Methods

cloudcix.api.Repository.dto.list
- Allows the User to get a list of all DTOs
cloudcix.api.Repository.dto.create
- Allows the User to create a new DTO
cloudcix.api.Repository.dto.read
- Allows the User to get the details of a DTO
cloudcix.api.Repository.dto.update
- Allows the User to update the details of a DTO
cloudcix.api.Repository.dto.delete
- Allows the User to delete a DTO

DTO Parameter

A DTO has one or more parameters

This service allows the User to manage parameters belonging to different DTOs

Basic Usage: cloudcix.api.Repository.dto_parameter.<method>

Available Methods

cloudcix.api.Repository.dto_parameter.list
- Allows the User to get a list of DTO Parameters for a DTO
cloudcix.api.Repository.dto_parameter.create
- Allows the User to add a new Parameter to a DTO
cloudcix.api.Repository.dto_parameter.read
- Allows the User to get the details of a DTO Parameter
cloudcix.api.Repository.dto_parameter.update
- Allows the User to update the details of a DTO Parameter
cloudcix.api.Repository.dto_parameter.delete
- Allows the User to delete a DTO Parameter for a given DTO

Exception Code

An Exception Code is a mapping of an error code to an error message

Error codes are returned by a Method when an error occurs, and this service provides a mapping of an error code to its message

This service allows the User to manage Exception Codes

Basic Usage: cloudcix.api.Repository.exception_code.<method>

Available Methods

cloudcix.api.Repository.exception_code.list
- Allows the User to get a list of Exception Codes for a given Method
cloudcix.api.Repository.exception_code.create
- Allows the User to create a new Exception Code in a default language
- idLanguage 1 == English
cloudcix.api.Repository.exception_code.read
- Allows the User to read an Exception Code in a specified language, if it is defined
- If the Exception Code is not defined in the specified language, the method will try to get the Code in the User’s default language
- If no Code exists for that language either, this method will return the English language version
cloudcix.api.Repository.exception_code.delete
- Allows the User to delete a given Exception Code

Language Exception Code

This service allows the User to manage translations for existing Exception Codes

Basic Usage: cloudcix.api.Repository.language_exception_code.<method>

Available Methods

cloudcix.api.Repository.language_exception_code.list
- Allows the User to get a list of translations for the given Exception Code
cloudcix.api.Repository.language_exception_code.create
- Allows the User to add a new translation to an existing Exception Code
cloudcix.api.Repository.language_exception_code.read
- Allows the User to get the details of a translation of an Exception Code
cloudcix.api.Repository.language_exception_code.update
- Allows the User to update the details of a translation
cloudcix.api.Repository.language_exception_code.delete
- Allows the User to delete a translation
- Note
  
  The English translation of an Exception Code cannot be deleted. Exception Codes are required to have an English translation as a default if a translation is not found for a User’s language. If you wish to delete all translations, use exception_code.delete instead.

Member

Every Member can have their own set of Applications

Only one Repository.Application should exist for every membership.Member

Note

The Repository.Member object is different from the membership.Member, but they should represent the same Member. Repository.Member is a representation of a membership.Member for use within the Repository application to group Applications.

Basic Usage: cloudcix.api.Repository.member.<method>

Available Methods

cloudcix.api.Repository.member.list
- Allows the User to return the list of Members that have entries in the Repository application
cloudcix.api.Repository.member.read
- Allows the User to get the details of a Member in the Repository application

Method

Every Service has one or more methods

This methods are an HTTP verb mapped to CRUDL:

CRUDL Method	HTTP Verb(s)
Create	POST
Read	GET
Update	PUT / PATCH
Delete	DELETE
List	GET

Note

Read requires an id
PUT requires the full object is sent in the request, PATCH only requires the fields to be updated

Basic Usage: cloudcix.api.Repository.method.<method>

Available Methods

cloudcix.api.Repository.method.list
- Allows the User to list all methods in a given Service
cloudcix.api.Repository.method.create
- Allows the User to create a new method under the given Service
cloudcix.api.Repository.method.read
- Allows the User to get the details of a given Method
cloudcix.api.Repository.method.update
- Allows the User to update the details of a given Method
cloudcix.api.Repository.method.delete
- Allows the User to delete a given Method

Method Parameter

Every Method has a set of parameters which conform the Request and Response objects

This service allows the User to manage the Parameters for a Method

Basic Usage: cloudcix.api.Repository.method_parameter.<method>

Available Methods

cloudcix.api.Repository.method_parameter.list
- Allows the User to get a list of Parameters for a given Method
cloudcix.api.Repository.method_parameter.create
- Allows the User to create a new Parameter for a given Method
cloudcix.api.Repository.method_parameter.read
- Allows the User to read the details of a given Parameter
cloudcix.api.Repository.method_parameter.update
- Allows the User to update the details of a given Parameter
cloudcix.api.Repository.method_parameter.delete
- Allows the User to delete a given Parameter

Service

An Application has one or more Services

A Service has an endpoint which is defined to tell other developers the path to consume it

This service allows the User to manage Service records

Basic Usage: cloudcix.api.Repository.service.<method>

Available Methods

cloudcix.api.Repository.service.list
- Allows the User to get a list of Services in a given Application
cloudcix.api.Repository.service.create
- Allows the User to create a new Service under a given Application
cloudcix.api.Repository.service.read
- Allows the User to read the details of a given Service
cloudcix.api.Repository.service.update
- Allows the User to update the details of a given Service
cloudcix.api.Repository.service.delete
- Allows the User to delete the record of a given Service

Scheduler

The Scheduler application allows the User to define tasks for duplicating existing transactions. A task contains information regarding when and how often it should be repeated. This can be used for monthly invoicing for example. Scheduler on its own does not create the new transactions and needs other software to read and execute the tasks from the Scheduler API. CloudCIX uses its own software for this called Routine which relies on Celery for creating transactions on a schedule.

Basic Usage: cloudcix.api.Scheduler.<service>.<method>

Services

Task

The Task service allows Users to manage their recurring transactions.

A Task is a recurring transaction that will run from time to time according to a set of rules defined by the User.

Basic Usage: cloudcix.api.Scheduler.task.<method>

Available Methods

cloudcix.api.Scheduler.task.list
- This method returns a list of Tasks and their details
cloudcix.api.Scheduler.task.create
- This method allows the User to create a new Task
cloudcix.api.Scheduler.task.read
- This method returns a Task and its details
cloudcix.api.Scheduler.task.update
- This method allows the User to update a Task

Supported Transactions

Account Sale Invoices
- cloudcix.api.Financial.account_sale_invoice
Warrantor Tickets
- cloudcix.api.Support.ticket
- transaction_type_id=40000

Task Log

The TaskLog service allows the User to get all the details about processed recurring transactions

Every time a recurring task is processed, a log is created.

The Log contains if the transaction was successful or failed, along with details of why it failed

Basic Usage: cloudcix.api.Scheduler.task_log.<method>

Available Methods

cloudcix.api.Scheduler.task_log.list
- This method allows the User to get a list of logs for a specific Task.

SCM

SCM is an Application to manage the planning, procurement, storage, distribution, service and return of inventory

Basic Usage: cloudcix.api.SCM.<service>.<method>

Services

Agreed Price

This service allows the User to manage the agreed prices for SKUs between addresses they are linked to

Basic Usage: cloudcix.api.SCM.agreed_price.<method>

Available Methods

cloudcix.api.SCM.agreed_price.list
- This method allows a User to get a list of Agreed Prices.
- Users acting as Global can get any Agreed Price under any of their Addresses.
- Users acting as Local can only get Agreed Prices under their active Address
cloudcix.api.SCM.agreed_price.create
- This method allows the User to create a new Agreed Price between its active Address and an address they are linked to for a SKU.
- The Agreed Price must be unique for a SKU betwwen the two addresses
cloudcix.api.SCM.agreed_price.read
- This method allows a User to get the details of a specific Agreed Price for their active address
cloudcix.api.SCM.agreed_price.update
- This method allows the User to update the details of an Agreed Price
- Only Agreed Prices under the User’s active Address can be updated
- The name must be unique per Address
cloudcix.api.SCM.agreed_price.delete
- This method allows the User to delete an Agreed Price
- Only Agreed Prices under the User’s active Address can be deleted.

Bin

This service allows the Users to manage their Bins. A Bin is a classification for SKUs used to manage their inventory

Basic Usage: cloudcix.api.SCM.bin.<method>

Available Methods

cloudcix.api.SCM.bin.list
- This method allows a User to get a list of Bins.
- Users acting as Global can get any Bin under any of their Addresses.
- Users acting as Local can only get Bins under their active Address
cloudcix.api.SCM.bin.create
- This method allows the User to create a new Bin for its active Address.
- The name must be unique per Address
cloudcix.api.SCM.bin.read
- This method allows a User to get the details of a specific Bin
- Users acting as Global can read any Bin under any of their Addresses
- Users acting as Local can only read any Bin under their active Address
cloudcix.api.SCM.bin.update
- This method allows the User to update the details of a Bin
- Only Bins under the User’s active Address can be updated
- The name must be unique per Address
cloudcix.api.SCM.bin.delete
- This method allows the User to delete a Bin
- Only Bins under the User’s active Address can be deleted.
- Every SKU associated with this Bin will no longer be associated

Bin SKU

This service allows the User to associate their SKUs with their Bins

Basic Usage: cloudcix.api.SCM.bin_sku.<method>

Available Methods

cloudcix.api.SCM.bin_sku.create
- This method allows the User to associate one or several SKUs with a Bin
cloudcix.api.SCM.bin_sku.delete
- This method allows the User to delete the associations between one or several SKUs with a Bin

Brand

A Brand is an optional classification for a SKU

Basic Usage: cloudcix.api.SCM.brand.<method>

Available Methods

cloudcix.api.SCM.brand.list
- This method allows the User to get a list of Brand records
cloudcix.api.SCM.brand.create
- This method allows the User to create a new Brand for its Member
cloudcix.api.SCM.brand.read
- This method allows the User to read a Brand belonging to its Member
cloudcix.api.SCM.brand.update
- This method allows the User to update a Brand belonging to its Member
cloudcix.api.SCM.brand.delete
- This method allows the User to delete a Brand belonging to its Member
- A Brand cannot be deleted it is has been used in an SKU

Critical BOM

This service allows the User to manage an SKU’s Bill of Materials (BOM)

A BOM is a list of the raw materials, sub-assemblies, intermediate assemblies, sub-components, parts, and the quantities of each needed to manufacture an end product

This service requires an idSKU for each method

Basic Usage: cloudcix.api.SCM.critical_bom.<method>

Available Methods

cloudcix.api.SCM.critical_bom.list
- This method allows the User to get a list of associations between an SKU and sub-components.
- Only owners or linked Members can list BOMs
cloudcix.api.SCM.critical_bom.create
- This method allows the User to create an association between an SKU and a sub-component
- A sub-component can never be any parent or even the selected SKU.
- Sub-components must be unique
cloudcix.api.SCM.critical_bom.read
- This method allows the User to read an association between an SKU and a sub-component
- Only owners or linked Members can list BOMs
cloudcix.api.SCM.critical_bom.update
- This method allows the User to update an association between an SKU and a sub-component
- A sub-component can never be any parent or even the selected SKU
- Sub-components must be unique
- Only owners of the SKUs can update the BOM
cloudcix.api.SCM.critical_bom.delete
- This method allows the User to delete an association between an SKU and sub-components.
- Only owners can delete the BOM

Critical BOM (For Member)

This service provides a method to list all BOM records belonging to the Member of the User making the request

Basic Usage: cloudcix.api.SCM.critical_bom_for_member.<method>

Available Methods

cloudcix.api.SCM.critical_bom_for_member.list
- Returns a list of all BOM records belonging to the Member of the User making the request

Manufactured Item

This service allows the User to manage Manufactured Items

A Manufactured Item is an SKU with a serial number

Basic Usage: cloudcix.api.SCM.manufactured_item.<method>

Available Methods

cloudcix.api.SCM.manufactured_item.list
- This method allows the User to get a list of Manufactured Items for the SKUs it owns.
cloudcix.api.SCM.manufactured_item.create
- This method allows the User to create a Manufactured Item.
- If the SKU Type is set to No Identifier (0), the User can’t create a Manufactured Item.
- Only the owners of an SKU can create Manufactured Items.
cloudcix.api.SCM.manufactured_item.read
- This method allows the User to read details of a Manufactured Item
- Only owners and linked Members can read a Manufactured Item
cloudcix.api.SCM.manufactured_item.update
- This method allows the User to create a Manufactured Item.
- If the SKU Type is set to No Identifier (0), the User can’t create a Manufactured Item.
- Only the owners of an SKU can create Manufactured Items.
cloudcix.api.SCM.manufactured_item.delete
- This method allows a User to delete a Manufactured Item.
- A Manufactured Item can only be deleted under the following conditions:
  
  The User’s Member is the owner of the associated SKU
  
  The Manufactured Item hasn’t been used in any transaction

Purchase Order

This is a record of a request made to another Address for stock elements.

Purchase Orders can be used to maintain records of stock quantities of SKUs that were ordered.

Basic Usage: cloudcix.api.SCM.purchase_order.<method>

Available methods

cloudcix.api.SCM.purchase_order.list
- This method allows the User to get a list of Purchase Orders belonging to their acting Address
cloudcix.api.SCM.purchase_order.create
- This method allows the User to create a new Purchase Order for a specified Address
cloudcix.api.SCM.purchase_order.read
- This method allows the User to read the details and the lines of a specified Purchase Order
cloudcix.api.SCM.purchase_order.update
- This method allows the User to update the details and the lines of a specified Purchase Order

Return Question

Every SKU Category can have a set of questions defined by default and used for certain transactions

This service allows the Users to handle these questions

Basic Usage: cloudcix.api.SCM.return_question.<method>

Available Methods

cloudcix.api.SCM.return_question.list
- This method allows the User to get a list of Return Questions
cloudcix.api.SCM.return_question.create
- This method allows the User to create a Return Question
cloudcix.api.SCM.return_question.read
- This method returns a Return Question and its details
- The Return Question must belong to the User’s Member for it to be read
cloudcix.api.SCM.return_question.update
- This method allows the User to update a Return Question
cloudcix.api.SCM.return_question.delete
- This method allows the User to delete a Return Question

Return Question Field Type

A Return Question supports several types for its answer

This service will have a list method to return all supported types

Note

The types are natural types supported by Python

Basic Usage: cloudcix.api.SCM.return_question_field_type.<method>

Available Methods

cloudcix.api.SCM.return_question_field_type.list
- This method allows the User to get a list of the supported field types for the Return Question answers

Sales Order

A Sales Order is a record of an order of stock elements by a certain Address.

Sales Orders can be used to create Invoices, and maintain records of price and quantities of SKUs that were ordered.

Basic Usage: cloudcix.api.SCM.sales_order.<method>

Available Methods

cloudcix.api.SCM.sales_order.list
- This method allows the User to get a list of Sales Orders belonging to their acting Address
cloudcix.api.SCM.sales_order.create
- This method allows the User to create a new Sales Order for a specified address
cloudcix.api.SCM.sales_order.read
- This method allows the User to read the details of specified Sales Order
cloudcix.api.SCM.sales_order.update
- This method allows the User to update the details of the lines of a Sales Order

Service Group

Service Groups are used to put Model Numbers into groups with the same repair complexity and therefore cost

Service Groups facilitate the simplification of contracts between Warrantors and Service Centers by basing contracts on a small list of Service Groups rather than the complete list of Model Numbers

Basic Usage: cloudcix.api.SCM.service_group.<method>

Available Methods

cloudcix.api.SCM.service_group.list
- This method returns a list of Service Groups belonging to the Member of the User making the request
cloudcix.api.SCM.service_group.create
- This method allows the User to create a Service Group for their Member
cloudcix.api.SCM.service_group.read
- This method returns details of the selected Service Group for its Member
- If the Service Group belongs to a different Member, a link between the current User’s Address and one of the selected Member’s Addresses must exist, with the required permissions
cloudcix.api.SCM.service_group.update
- This method allows the User to update a Service Group for their Member
cloudcix.api.SCM.service_group.delete
- This method allows the User to delete a Service Group for their Member
- All SKUs assigned to the Service Group being deleted will have no assigned Service Group after the deletion

SKU

A Stock Keeping Unit (SKU) is the unit by which stock is managed.

Two manufactured items of the same SKU are identical in every way (with the possible exception of a label containing a unique serial number)

Basic Usage: cloudcix.api.SCM.sku.<method>

Available Methods

cloudcix.api.SCM.sku.list
- This method returns a list of SKU records for a particular Member
cloudcix.api.SCM.sku.create
- This method allows the User to create an SKU belonging to its Member
cloudcix.api.SCM.sku.read
- This method allows the User to read an SKU for a particular Member
cloudcix.api.SCM.sku.update
- This method allows the User to update an SKU belonging to its Member
cloudcix.api.SCM.sku.delete
- This method allows the User to delete an SKU belonging to its Member
- An SKU cannot be deleted under the following conditions
  
  The SKU is a property of a Manufactured Item
  
  The SKU has been used in a transaction

SKU Category

An SKU Category is a classification for an SKU

Basic Usage: cloudcix.api.SCM.sku_category.<method>

Available Methods

cloudcix.api.SCM.sku_category.list
- This method returns a list of Categories
- Only addresses acting as Service Centres can read other Member’s categories if they have the User’s Address as a Service Centre
cloudcix.api.SCM.sku_category.create
- This method allows Users to create a Category for his Member
- Each SKU belongs to a Category
cloudcix.api.SCM.sku_category.read
- This method will read an SKU Category for the Member of the User who made the request
cloudcix.api.SCM.sku_category.update
- This method allows Users to update a Category for their Member
- Category names must be unique for Categories with no Master Category or within the same Master Category
cloudcix.api.SCM.sku_category.delete
- This method will delete a Category for his member
- All associations with Return Questions will be deleted

SKU Category Return Question

This service allows the User to associate Return Questions with SKU Categories

Basic Usage: cloudcix.api.SCM.sku_category_return_question.<method>

Available Methods

cloudcix.api.SCM.sku_category_return_question.create
- Allows the User to create a relationship between an SKU Category and a Return Question
cloudcix.api.SCM.sku_category_return_question.delete
- Allows the User to delete a relationship between an SKU Category and a Return Question

SKU Stock

This service allows the User to see SKU Stock values

Basic Usage: cloudcix.api.SCM.sku_stock.<method>

Available Methods

cloudcix.api.SCM.sku_stock.list
- This method allows the User to get the full Stock of the SKU in the different Addresses it is in.
- If the Stock belongs to a different Address than the requesting User, a Link between them must exist.
- If the User is acting as Local and the SKU belongs to their Member, only the Stock at the User’s Address will be shown
cloudcix.api.SCM.sku_stock.read
- This method allows the User to read the Stock of an SKU in a given Address
- If the SKU belongs to an Address in a different Member than the requesting User, a link between the Members must exist

SKU Stock Adjustment

This service allows Users to manage their SKU Stock by making adjustments to it

A SKU Stock Adjustment Transaction allows Users to adjust the SKU inventory by increasing or decreasing the amount of items or volume in stock

Basic Usage: cloudcix.api.SCM.sku_stock_adjustment.<method>

Available Methods

cloudcix.api.SCM.sku_stock_adjustment.list
- This method allows the User to get a list of SKU Stock Adjustment Transactions
cloudcix.api.SCM.sku_stock_adjustment.create
- This method allows the User to create a new SKU Stock Adjustment Transaction
cloudcix.api.SCM.sku_stock_adjustment.read
- This method allows the User to get an SKU Stock Adjustment Transaction and its details
cloudcix.api.SCM.sku_stock_adjustment.update
- This method allows the User to update some details of an SKU Stock Adjustment Transaction

SKU Value

This service allows Users to manage the values for an SKU on each class

Basic Usage: cloudcix.api.SCM.sku_value.<method>

Available Methods

cloudcix.api.SCM.sku_value.list
- This method allows the User to get all the values for an SKU in all their Addresses.
- If the User is acting Local, it will only return the values in their own Address
cloudcix.api.SCM.sku_value.create
- This method allows the User to create the values for an SKU in a given Address
- If no Address is specified, the Address of the requesting User will be used
- If the given Address is not the User’s Address, then the following conditions must be met in order to continue:
  
  The given Address belongs to the User’s Member
  
  The User is acting Global
cloudcix.api.SCM.sku_value.read
- This method allows the User to read the values for an SKU in a given Address.
- If the specified Address is not the requesting User’s Address, the following conditions must be met:
  
  The specified Address belongs to the requesting User’s Member
  
  The User is acting Global
cloudcix.api.SCM.sku_value.update
- This method allows the User to update the values for an SKU in a given Address
- If the User has permission to Read the SKU, the User can also Update it

Validate Purchase Order

This service allows Users to validate data before submitting it to modify a Purchase Order

Basic Usage: cloudcix.api.SCM.validate_purchase_order.<method>

Available Methods

cloudcix.api.SCM.validate_purchase_order.update
- This method allows the User to validate data for updating a Purchase Order

Validate Sale Order

This service allows Users to validate data before submitting it to modify a Sales Order

Basic Usage: cloudcix.api.SCM.validate_sales_order.<method>

Available Methods

cloudcix.api.SCM.validate_sales_order.update
- This method allows the User to validate data for updating a Sales Order

Security

Security is a service whose main function is to manage visitors and staff entering and exiting a building.

Users will be able to see where they went and when.

Administrators will be able to see where their Users went and when, as well as visitors to their own Addresses

Basic Usage: cloudcix.api.Security.<service>.<method>

Services

Security Event

A Security Event is a transaction that occurs when a person enters or exits a building.

This service is used to track Users arriving at an Address

Basic Usage: cloudcix.api.Security.security_event.<method>

Available Methods

cloudcix.api.Security.security_event.list
- This method allows the User to get a list of Security Events happening in their Address, or the visited Address by any of their Membership Users
cloudcix.api.Security.security_event.create
- This method allows a User to create a Security Event of its arrival to an Address

Security Event Logout

A Security Event is a transaction that occurs when a person enters or exits a building.

This service is used to track Users leaving an Address

A Security Event for leaving cannot be created unless the User has first logged their arrival to an Address

Basic Usage: cloudcix.api.Security.security_event.<method>

Available Methods

cloudcix.api.Security.security_event.create
- This method has two possible uses
- The first is to allow a User to log their own departure from an Address
- The second is to allow an Administrator of an Address to force log out a User currently visiting the Address

Support

The Support application is both a ticketing system, and a returns management system

Note

Ticketing System

A Ticketing System has two parties, each with a different role.

A Warrantor offers support, and a Client requires support

Note

Returns Management

If a ticket requires that a product is returned for repair, exchange, or credit, then a Service Centre also becomes involved

Basic Usage: cloudcix.api.Support.<service>.<method>

Services

IRIS Condition

This service allows the User to handle its IRIS Condition codes

Basic Usage: cloudcix.api.Support.iris_condition.<method>

Available Methods

cloudcix.api.Support.iris_condition.list
- This method allows the User to get a list of IRIS Condition codes for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_condition.create
- This method allows the User to create an IRIS Condition code for its Member
- The description parameter must be in the English language
- To add translations, you must use the IRIS Condition Translation service
cloudcix.api.Support.iris_condition.read
- This method returns an IRIS Condition Code
- Codes can be read by the owner and by linked Members
cloudcix.api.Support.iris_condition.update
- This method allows the User to update some details of an IRIS Condition code
- To add translations, you must use the IRIS Condition Translation service
cloudcix.api.Support.iris_condition.delete
- This method allows the User to delete an IRIS Condition code and all its translations
- The IRIS Condition code cannot be deleted if it is used (i.e. assigned to an item)

IRIS Condition Translation

This service allows the User to handle the Translations for IRIS Condition codes

Basic Usage: cloudcix.api.Support.iris_condition_translation.<method>

Available Methods

cloudcix.api.Support.iris_condition_translation.list
- This method allows the User to get a list of translations for an IRIS Condition code for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_condition_translation.create
- This method allows the User to create a translation for an IRIS Condition code for its Member
cloudcix.api.Support.iris_condition_translation.read
- This method returns the translation for an IRIS Condition Code in the requested language
- Translations can be read by the owner and by linked Members of the Codes
cloudcix.api.Support.iris_condition_translation.update
- This method allows the User to update some details for an IRIS Condition Translation
cloudcix.api.Support.iris_condition_translation.delete
- This method allows the User to delete an IRIS Condition Translation record.

IRIS Defect

This service allows the User to handle its IRIS Defect Codes

Basic Usage: cloudcix.api.Support.iris_defect.<method>

Available Methods

cloudcix.api.Support.iris_defect.list
- This method allows the User to get a list of IRIS Defect codes for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_defect.create
- This method allows the User to create an IRIS Defect code for its Member
- The description parameter must be in the English language
- To add translations, you must use the IRIS Defect Translation service
cloudcix.api.Support.iris_defect.read
- This method returns an IRIS Defect Code
- Codes can be read by the owner and by linked Members
cloudcix.api.Support.iris_defect.update
- This method allows the User to update some details of an IRIS Defect code
- To add translations, you must use the IRIS Defect Translation service
cloudcix.api.Support.iris_defect.delete
- This method allows the User to delete an IRIS Defect code and all its translations
- The IRIS Defect code cannot be deleted if it is used (i.e. assigned to an item)

IRIS Defect Translation

This service allows the User to handle the Translations for IRIS Defect codes

Basic Usage: cloudcix.api.Support.iris_defect_translation.<method>

Available Methods

cloudcix.api.Support.iris_defect_translation.list
- This method allows the User to get a list of translations for an IRIS Defect code for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_defect_translation.create
- This method allows the User to create an IRIS Defect code for its Member
cloudcix.api.Support.iris_defect_translation.read
- This method returns the translation for an IRIS Defect Code in the requested language
– Translations can be read by the owner and by linked Members of the Code.
cloudcix.api.Support.iris_defect_translation.update
- This method allows the User to update some details for an IRIS Defect Translation
cloudcix.api.Support.iris_defect_translation.delete
- This method allows the User to delete an IRIS Defect Translation record.

IRIS Extended Condition

This service allows the User to handle its IRIS Extended Condition codes

Basic Usage: cloudcix.api.Support.iris_extended_condition.<method>

Available Methods

cloudcix.api.Support.iris_extended_condition.list
- This method allows the User to get a list of IRIS Extended Condition codes for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_extended_condition.create
- This method allows the User to create an IRIS Extended Condition code for its Member
- The description parameter must be in the English language
- To add translations, you must use the IRIS Extended Condition Translation service
cloudcix.api.Support.iris_extended_condition.read
- This method returns an IRIS Extended Condition Code
- Codes can be read by the owner and by linked Members
cloudcix.api.Support.iris_extended_condition.update
- This method allows the User to update some details of an IRIS Extended Condition code
- To add translations, you must use the IRIS Extended Condition Translation service
cloudcix.api.Support.iris_extended_condition.delete
- This method allows the User to delete an IRIS Extended Condition code and all its translations
- The IRIS Extended Condition code cannot be deleted if it is used (i.e. assigned to an item)

IRIS Extended Condition Translation

This service allows the User to handle the Translations for IRIS Extended Condition codes

Basic Usage: cloudcix.api.Support.iris_extended_condition_translation.<method>

Available Methods

cloudcix.api.Support.iris_extended_condition_translation.list
- This method allows the User to get a list of translations for an IRIS Extended Condition code for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_extended_condition_translation.create
- This method allows the User to create an IRIS Extended Condition code for its Member
cloudcix.api.Support.iris_extended_condition_translation.read
- This method returns the translation for an IRIS Extended Condition Code in the requested language
- Translations can be read by the owner and by linked Members of the Code.
cloudcix.api.Support.iris_extended_condition_translation.update
- This method allows the User to update some details for an IRIS Extended Condition Translation
cloudcix.api.Support.iris_extended_condition_translation.delete
- This method allows the User to delete an IRIS Extended Condition Translation record.

IRIS NTF

This service allows the User to handle its IRIS NTF codes

Basic Usage: cloudcix.api.Support.iris_ntf.<method>

Available Methods

cloudcix.api.Support.iris_ntf.list
- This method allows the User to get a list of IRIS NTF codes for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_ntf.create
- This method allows the User to create an IRIS NTF code for its Member
- The description parameter must be in the English language
- To add translations, you must use the IRIS NTF Translation service
cloudcix.api.Support.iris_ntf.read
- This method returns an IRIS NTF Code
- Codes can be read by the owner and by linked Members
cloudcix.api.Support.iris_ntf.update
- This method allows the User to update some details of an IRIS NTF code
- To add translations, you must use the IRIS NTF Translation service
cloudcix.api.Support.iris_ntf.delete
- This method allows the User to delete an IRIS NTF code and all its translations
- The IRIS NTF code cannot be deleted if it is used (i.e. assigned to an item)

IRIS NTF Translation

This service allows the User to handle the Translations for IRIS NTF codes

Basic Usage: cloudcix.api.Support.iris_ntf_translation.<method>

Available Methods

cloudcix.api.Support.iris_ntf_translation.list
- This method allows the User to get a list of translations for an IRIS NTF code for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_ntf_translation.create
- This method allows the User to create an IRIS NTF code for its Member
cloudcix.api.Support.iris_ntf_translation.read
- This method returns the translation for an IRIS NTF Code in the requested language
- Translations can be read by the owner and by linked Members of the Code.
cloudcix.api.Support.iris_ntf_translation.update
- This method allows the User to update some details for an IRIS NTF Translation
cloudcix.api.Support.iris_ntf_translation.delete
- This method allows the User to delete an IRIS NTF Translation record.

IRIS Repair

This service allows the User to handle its IRIS NTF codes

Basic Usage: cloudcix.api.Support.iris_repair.<method>

Available Methods

cloudcix.api.Support.iris_repair.list
- This method allows the User to get a list of IRIS Repair codes for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_repair.create
- This method allows the User to create an IRIS Repair code for its Member
- The description parameter must be in the English language
- To add translations, you must use the IRIS Repair Translation service
cloudcix.api.Support.iris_repair.read
- This method returns an IRIS Repair Code
- Codes can be read by the owner and by linked Members
cloudcix.api.Support.iris_repair.update
- This method allows the User to update some details of an IRIS Repair code
- To add translations, you must use the IRIS Repair Translation service
cloudcix.api.Support.iris_repair.delete
- This method allows the User to delete an IRIS Repair code and all its translations
- The IRIS Repair code cannot be deleted if it is used (i.e. assigned to an item)

IRIS Repair Translation

This service allows the User to handle the Translations for IRIS Repair codes

Basic Usage: cloudcix.api.Support.iris_repair_translation.<method>

Available Methods

cloudcix.api.Support.iris_repair_translation.list
- This method allows the User to get a list of translations for an IRIS Repair code for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_repair_translation.create
- This method allows the User to create an IRIS Repair code for its Member
cloudcix.api.Support.iris_repair_translation.read
- This method returns the translation for an IRIS Repair Code in the requested language
- Translations can be read by the owner and by linked Members of the Code.
cloudcix.api.Support.iris_repair_translation.update
- This method allows the User to update some details for an IRIS Repair Translation
cloudcix.api.Support.iris_repair_translation.delete
- This method allows the User to delete an IRIS Repair Translation record

IRIS Section

This service allows the User to handle its IRIS Section codes

Basic Usage: cloudcix.api.Support.iris_section.<method>

Available Methods

cloudcix.api.Support.iris_section.list
- This method allows the User to get a list of IRIS Section codes for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_section.create
- This method allows the User to create an IRIS Section code for its Member
- The description parameter must be in the English language
- To add translations, you must use the IRIS Section Translation service
cloudcix.api.Support.iris_section.read
- This method returns an IRIS Section Code
- Codes can be read by the owner and by linked Members
cloudcix.api.Support.iris_section.update
- This method allows the User to update some details of an IRIS Section code
- To add translations, you must use the IRIS Section Translation service
cloudcix.api.Support.iris_section.delete
- This method allows the User to delete an IRIS Section code and all its translations
- The IRIS Section code cannot be deleted if it is used (i.e. assigned to an item)

IRIS Section Translation

This service allows the User to handle the Translations for IRIS Section codes

Basic Usage: cloudcix.api.Support.iris_section_translation.<method>

Available Methods

cloudcix.api.Support.iris_section_translation.list
- This method allows the User to get a list of translations for an IRIS Section code for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_section_translation.create
- This method allows the User to create an IRIS Section code for its Member
cloudcix.api.Support.iris_section_translation.read
- This method returns the translation for an IRIS Section Code in the requested language
- Translations can be read by the owner and by linked Members of the Code.
cloudcix.api.Support.iris_section_translation.update
- This method allows the User to update some details for an IRIS Section Translation
cloudcix.api.Support.iris_section_translation.delete
- This method allows the User to delete an IRIS Section Translation record

IRIS Symptom

This service allows the User to handle its IRIS Symptom codes

Basic Usage: cloudcix.api.Support.iris_symptom.<method>

Available Methods

cloudcix.api.Support.iris_symptom.list
- This method allows the User to get a list of IRIS Symptom codes for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_symptom.create
- This method allows the User to create an IRIS Symptom code for its Member
- The description parameter must be in the English language
- To add translations, you must use the IRIS Symptom Translation service
cloudcix.api.Support.iris_symptom.read
- This method returns an IRIS Symptom Code
- Codes can be read by the owner and by linked Members
cloudcix.api.Support.iris_symptom.update
- This method allows the User to update some details of an IRIS Symptom code
- To add translations, you must use the IRIS Symptom Translation service
cloudcix.api.Support.iris_symptom.delete
- This method allows the User to delete an IRIS Symptom code and all its translations
- The IRIS Symptom code cannot be deleted if it is used (i.e. assigned to an item)

IRIS Symptom Translation

This service allows the User to handle the Translations for IRIS Symptom codes

Basic Usage: cloudcix.api.Support.iris_symptom_translation.<method>

Available Methods

cloudcix.api.Support.iris_symptom_translation.list
- This method allows the User to get a list of translations for an IRIS Symptom code for the selected linked Member, or the User’s own Member by default
cloudcix.api.Support.iris_symptom_translation.create
- This method allows the User to create an IRIS Symptom code for its Member
cloudcix.api.Support.iris_symptom_translation.read
- This method returns the translation for an IRIS Symptom Code in the requested language
- Translations can be read by the owner and by linked Members of the Code.
cloudcix.api.Support.iris_symptom_translation.update
- This method allows the User to update some details for an IRIS Symptom Translation
cloudcix.api.Support.iris_symptom_translation.delete
- This method allows the User to delete an IRIS Symptom Translation record

Item

Every Ticket can have a set of Items

This service allows the User to manage those Items

Basic Usage: cloudcix.api.Support.item.<method>

Available Methods

cloudcix.api.Support.item.list
- This method allows the User to get a list of Items associated with a Ticket
- Items can only be read by the Warrantor, Client or Service Centre associated with the Ticket
cloudcix.api.Support.item.create
- This method allows the User to add an Item to a Ticket
- Depending on the SKU Type, the serial number, batch number, date of manufacture and date of purchase may be required
- Items can only be added by the Warrantor, Client or Service Centre associated with the Ticket
- When an Item is added, the fields with “Initial” are automatically taken from the initial values in the passed in fields, including the questions’ initial answers
- An Item History is automatically created by the system to reflect who added the Item, along with the current and initial values
- A Warrantor can set up any of the Users associated with the Ticket
- A Client can only manage its associated Users
cloudcix.api.Support.item.read
- This method allows the User to read an Item associated with a Ticket
- Items can only be read by the Warrantor, Client or Service Centre associated with the Ticket
cloudcix.api.Support.item.update
- This method allows the User to update an Item associated with a Ticket
- Depending on the SKU Type, the serial number, batch number, date of manufacture and date of purchase may be required
- Items can only be added by the Warrantor, Client or Service Centre associated with the Ticket
- When an Item is added, the fields with “Initial” are automatically taken from the initial values in the passed in fields, including the questions’ initial answers
- An Item History is automatically created by the system to reflect who added the Item, along with the current and initial values
- A Warrantor can set up any of the Users associated with the Ticket
- A Client can only manage its associated Users

Item History

Every Ticket can have a set of Items, and every Item has its own History log

This service allows the Users to handle the History log for their Items

Basic Usage: cloudcix.api.Support.item_history.<method>

Available Methods

cloudcix.api.Support.item_history.list
- This method allows the User to get a list of History logs for the given Item in the selected Transaction
cloudcix.api.Support.item_history.create
- This method allows the User to create a new History log for the given Item in a Ticket
- Only Users under the addresses involved in the Ticket can create these logs
- There are two log types;
  
  Note: A standard history log is generated
  
  Email: A standard history log is generated and is sent by email to these specified in the to and cc fields. Emails will always be sent by CloudCIX Notifications, and the sender will be specified in the body of the email. Reply-To will be the User’s email unless it is set.

Item Status

This service allows the Users to determine the at what stage of the customer service process an Item is

Basic Usage: cloudcix.api.Support.item_status.<method>

Available Methods

cloudcix.api.Support.item_status.list
- This method allows the User to get a list of Item Statuses in the selected language for any Items it has
- If there’s no translation for an Item, the English version will be returned instead

Part Used

Every Ticket can have a set of Items, and every Item can have a set of Parts Used to fix an issue

This service allows the Users to handle the Parts Used for their Items

Basic Usage: cloudcix.api.Support.part_used.<method>

Available Methods

cloudcix.api.Support.part_used.list
- This method allows the User to get a list of the Parts Used to fix an Item
- Only Users belonging to the Addresses involved in the Ticket can list these objects
cloudcix.api.Support.part_used.read
- This method returns a Part Used to fix an Item, along with its details
- Only Users belonging to the Addresses involved in the Ticket can read this object

Reason For Return

This service allows the User to handle the different Reasons For Return that can be associated with Items in a Ticket

Basic Usage: cloudcix.api.Support.reason_for_return.<method>

Available Methods

cloudcix.api.Support.reason_for_return.list
- This method allows the User to get a list of Reasons For Return.
cloudcix.api.Support.reason_for_return.create
- This method allows the User to create a new Reason For Return
- This method creates the default English Reason For Return
- To create a Reason For Return in a different language, use the Reason For Return Translation service
cloudcix.api.Support.reason_for_return.read
- This method allows the User to get a Reason For Return.
cloudcix.api.Support.reason_for_return.update
- This method allows the User to update some of the details of a Reason For Return
cloudcix.api.Support.reason_for_return.delete
- This method allows the User to delete a Reason For Return and all its translations
- If a Reason For Returns is currently in use (i.e. assigned to an Item) then it cannot be deleted

Reason For Return Translation

This service allows the User to handle translations for Reason For Return descriptions

Basic Usage: cloudcix.api.Support.reason_for_return_translation.<method>

Available Methods

cloudcix.api.Support.reason_for_return_translation.list
- This method allows the User to get a list of translations for a Reason For Return
cloudcix.api.Support.reason_for_return_translation.create
- This method allows the User to add a translation for a Reason For Return
cloudcix.api.Support.reason_for_return_translation.read
- This method allows the User to get a Reason For Return in a particular language
cloudcix.api.Support.reason_for_return_translation.update
- This method allows the User to update a Reason For Return translation
cloudcix.api.Support.reason_for_return_translation.delete
- This method allows the User to delete a translation for a Reason For Return

Service Centre Logic

This service allows the Service Centre to specify the Business Logic for one of its Addresses

Only Administrators can create or modify the Business Logic

If the User is acting as Global, the address_id can be specified in the request

Otherwise, the local Address will be used

Basic Usage: cloudcix.api.Support.service_centre_logic.<method>

Available Methods

cloudcix.api.Support.service_centre_logic.create
- This method allows the User to create a default Business Logic for a specific Address
- This method can only be run by an Administrator
- Only Addresses belonging to the User’s Member can be managed
cloudcix.api.Support.service_centre_logic.read
- This method returns the default Business Logic for a Service Centre Address
- Users can only read the default Business Logic for Addresses in their Member
cloudcix.api.Support.service_centre_logic.update
- This method allows the User to update the default Business Logic for a given Address
- This method can only be run by an Administrator
- Only Addresses belonging to the User’s Member can be managed
cloudcix.api.Support.service_centre_logic.delete
- This method allows the User to delete the default Business Logic for a given Address
- This method can only be run by an Administrator
- Only Addresses belonging to the User’s Member can be managed

Service Centre Warrantor

This service allows the User to specify the Business Logic between a Service Centre’s Address and a Warrantor’s Address

Only Administrators can create or modify the Business Logic

If the User is acting as Global, the address_id can be specified in the request

Otherwise, the local Address will be used

Only Addresses belonging to the User’s Member can be managed

Basic Usage: cloudcix.api.Support.service_centre_warrantor.<method>

Available Methods

cloudcix.api.Support.service_centre_warrantor.list
- This method allows the User to get a list of associations between a Service Centre’s Address and many Warrantor Addresses
cloudcix.api.Support.service_centre_warrantor.create
- This method allows the User to create an association between a Service Centre’s Address and a Warrantor’s Address
- Even if the Warrantor created the link in the first place, this method must be used to store the Service Centre’s values in the link
- If there are already values in the Service Centre’s side, an exception will be raised and update will need to be used instead
cloudcix.api.Support.service_centre_warrantor.read
- This method allows the User to get the details of an association between a Service Centre’s Address and a Warrantor’s Address
cloudcix.api.Support.service_centre_warrantor.update
- This method allows the User to update an association between a Service Centre’s Address and a Warrantor’s Address
cloudcix.api.Support.service_centre_warrantor.delete
- This method allows the User to delete an association between a Service Centre’s Address and a Warrantor’s Address
- The Service Centre values will be set to null
- If both the Warrantor and Service Centre values are null, the link will be marked for deletion

Status

The Status service denotes at what stage of the customer service process a ticket is

Basic Usage: cloudcix.api.Support.status.<method>

Available Methods

cloudcix.api.Support.status.list
- This method allows the User to get a list of available Statuses in the selected language, or in English if there’s no translation available

Ticket

A Ticket is a set of instructions from a Customer

A Ticket has a Transaction Type, that can have one of the following values depending on who created it

transaction_type_id	Created By
40000	Warrantor
41000	Client
42000	Service Centre

When reading a Ticket, the User must specify if they are a Client, Warrantor, or Service Centre, and the corresponding address_id

Basic Usage: cloudcix.api.Support.ticket.<method>

Available Methods

cloudcix.api.Support.ticket.list
- This method allows the User to get a list of Tickets
cloudcix.api.Support.ticket.create
- This method allows the User to create a Ticket
- A Warrantor can set up any of the Users associated with a Ticket
- A Client and a Service Centre can only managed their associated Users
cloudcix.api.Support.ticket.read
- This method allows the User to get a Ticket
cloudcix.api.Support.ticket.update
- This method allows the User to update some details of a Ticket
- A Warrantor can set up any of the Users associated with a Ticket
- A Client and a Service Centre can only managed their associated Users

Ticket History

The Ticket History service allows the User to create separate snippets of information on a ticket relating to the customer query/issue

Basic Usage: cloudcix.api.Support.ticket_history.<method>

Available Methods

cloudcix.api.Support.ticket_history.list
- Thie method allows the User to get a list of history logs for a given Transaction
cloudcix.api.Support.ticket_history.create
- This method allows the User to create a new history log for the given Ticket
- Only Users under the Addresses involved in the Ticket can create these logs
- There are two log types;
  
  Note: A standard history log is generated
  
  Email: A standard history log is generated and is sent by email to these specified in the to and cc fields. Emails will always be sent by CloudCIX Notifications, and the sender will be specified in the body of the email. Reply-To will be the User’s email unless it is set.

Ticket Question

Every Ticket can have a set of questions defined by default

This service allows the users to handle these questions

Basic Usage: cloudcix.api.Support.ticket_question.<method>

Available Methods

cloudcix.api.Support.ticket_question.list
- This method allows the User to get a list of Ticket Questions for a given Ticket
cloudcix.api.Support.ticket_question.create
- This method allows the User to create a Ticket Question
cloudcix.api.Support.ticket_question.read
- This method allows the User to get a Ticket Question and its details
cloudcix.api.Support.ticket_question.update
- This method allows the User to update some details of a Ticket Question
- Note
  
  When a Question is updated, Questions that are already associated to Tickets won’t change
cloudcix.api.Support.ticket_question.delete
- This method allows the User to delete a Ticket Question
- Associations with Ticket Types will be deleted
- Note
  
  If this Question was already associated with a Ticket, this won’t be deleted in the Ticket

Ticket Type

Every Ticket can have a type defined by default

If a Ticket Type has questions associated with it at the time a Ticket with that Type is created, those questions will be associated with the Ticket

This service allows the User to manage the different Ticket Types

Basic Usage: cloudcix.api.Support.ticket_type.<method>

Available Methods

cloudcix.api.Support.ticket_type.list
- This method allows the User to get a list of Ticket Types available for the Warrantor
cloudcix.api.Support.ticket_type.create
- This method allows the User to create a new Ticket Type
cloudcix.api.Support.ticket_type.read
- This method allows the User to get a Ticket Type and its details
cloudcix.api.Support.ticket_type.update
- This method allows the User to update some of the details of a Ticket Type
cloudcix.api.Support.ticket_type.delete
- This method allows the User to delete a Ticket Type
- A Ticket Type can only be deleted if there are no Tickets associated with it

Warrantor Logic

This service allows the Warrantor to specify the Business Logic for one of its Addresses

Only Administrators can create or modify the Business Logic

If the User is acting as Global, the address_id can be specified in the request

Otherwise, the local Address will be used

Only Addresses belonging to the User’s Member can be managed

Basic Usage: cloudcix.api.Support.warrantor_logic.<method>

Available Methods

cloudcix.api.Support.warrantor_logic.create
- This method allows the User to create a default Business Logic for a specified Address
- This method can only be run by an Administrator
cloudcix.api.Support.warrantor_logic.read
- This method allows the User to get a default Business Logic for a Warrantor Address
- Users can only read the default Business Logic for Addresses belonging to their Member
cloudcix.api.Support.warrantor_logic.update
- This method allows the User to update some of the details of a default Business Logic for a given Address
- This method can only be run by an Administrator
cloudcix.api.Support.warrantor_logic.delete
- This method allows the User to delete a default Business Logic for a given Address
- This method can only be run by an Administrator

Warrantor Service Centre

This service allows the User to specify the Business Logic between a Warrantor’s Address and a Service Centre’s Address

Only Administrators can create or modify the Business Logic

If the User is acting as Global, the address_id can be specified in the request

Otherwise, the local Address will be used

Only Addresses belonging to the User’s Member can be managed

Basic Usage: cloudcix.api.Support.warrantor_service_centre.<method>

Available Methods

cloudcix.api.Support.warrantor_service_centre.list
- This method allows the User to get a list of associations between a Warrantor’s Address and many Service Centre Addresses
cloudcix.api.Support.warrantor_service_centre.create
- This method allows the User to create an association between a Warrantor’s Address and a Service Centre’s Address
- Even if the Service Centre created the link in the first place, this method must be used to store the Warrantor’s values in the link
- If there are already values in the Warrantor’s side, an exception will be raised and update must be used instead
cloudcix.api.Support.warrantor_service_centre.read
- This method allows the User to get the details between a Warrantor’s Address and a Service Centre’s Address
cloudcix.api.Support.warrantor_service_centre.update
- This method allows the User to update an association between a Warrantor’s Address and a Service Centre’s Address
cloudcix.api.Support.warrantor_service_centre.delete
- This method allows the User to delete an association between a Warrantor’s Address and a Service Centre’s Address
- The Warrantor values will be set to null
- If both the Warrantor and Service Centre values are null, the link will be marked for deletion

Training

The Training Application exposes a REST API capable of managing Training records

Basic Usage: cloudcix.api.Training.<service>.<method>

Services

Class

This services allows for the management of Class records.

A Class record represents a Class in a Syllabus, and each one has a trainer assigned, as well as both a start and end date

Basic Usage: cloudcix.api.Training.cls.<method>

Available Methods

cloudcix.api.Training.cls.list
- Return a list of all classes in a selected Syllabus
cloudcix.api.Training.cls.create
- Allows the Use to create a new Class record
cloudcix.api.Training.cls.read
- Returns the selected Class, along with its details
cloudcix.api.Training.cls.update
- Allows the User to update the details of a Class record
cloudcix.api.Training.cls.delete
- Allows the User to delete a Class record

Student

This service allows for the management of Student records.

Students are Users that are enrolled for one or more Classes

Basic Usage: cloudcix.api.Training.student.<method>

Available Methods

cloudcix.api.Training.student.list
- Returns a list of Students in a selected Class
cloudcix.api.Training.student.create
- Allows a User to create a Student record by adding a User to a Class
cloudcix.api.Training.student.read
- Returns the selected Student record with all its details
cloudcix.api.Training.student.update
- Allows a User to update a Student’s records.
- Students can become Self Managed which means they can manage themselves
cloudcix.api.Training.student.delete
- Allows a User to delete a Student record

Syllabus

This service allows for the management of Syllabus records.

Basic Usage: cloudcix.api.Training.syllabus.<method>

Available Methods

cloudcix.api.Training.syllabus.list
- Returns a list of all Syllabus records available for a Student
cloudcix.api.Training.syllabus.create
- Allows a User to create a new Syllabus
cloudcix.api.Training.syllabus.read
- Returns the details of the selected Syllabus
cloudcix.api.Training.syllabus.update
- Allows a User to update the details of a given Syllabus
cloudcix.api.Training.syllabus.delete
- Allows a User to delete a given Syllabus

Vault

The Vault Application exposes a REST API capable of managing objects in MinIO and the ability to share. Vault is available to addresses linked to a Vault Cloud Region where a MinIO instance has been set up.

Basic Usage: cloudcix.api.Vault.<service>.<method>

Services

Bucket

This services allows for the management of Buckets in the MinIO object store.

For each method request the following paramaters must be sent: - region_name

This paramater is used to create the MinIO client for the region.

path
- This paramater is used to specify the location of a Bucket in the region’s MinIO.

Basic Usage: cloudcix.api.Vault.bucket.<method>

Available Methods

cloudcix.api.Vault.bucket.head
- Allows the user to verify if a Bucket exists on the sent path in the Minio on the sent region_name.
- A 200 will be returned if the Bucket exists.
cloudcix.api.Vault.bucket.read
- Allows the user to retrieve a list of Objects in the Bucket on the sent path in the Minio on the sent region_name.
cloudcix.api.Vault.bucket.create
- Allows the user to create a Bucket on the sent path in the Minio on the sent region_name.
cloudcix.api.Vault.bucket.delete
- Allows the user to delete a Bucket on the sent path in the Minio on the sent region_name.

Note

Based on how the URLs for are structured, it is required you pass region_name='name_of_region' and path='mybucket' to these methods

Object

This services allows for the management of Objects in the MinIO object store.

For each method request the following paramaters must be sent: - region_name

This paramater is used to create the MinIO client for the region.

path
- This paramater is used to specify the location of an Object in the region’s MinIO.

Returned with the head and read method requests will be the following metadata in _headers:

content_length
- The size of the Object.
content_type
- The Content-Type of the Object.
etag
- The ETag of the Object.
last_modified
- The time in UTC of when the Object was last modified.

Basic Usage: cloudcix.api.Vault.object.<method>

Available Methods

cloudcix.api.Vault.object.head
- Allows the user to verify if an Object exists on the sent path in the Minio on the sent region_name.
- A 200 will be returned if the Object exists.
- Also returned in the response will be _headers where the metadata for each Object will be recorded
cloudcix.api.Vault.object.read
- Allows the user to retrive an Object from the sent path and in the Minio on the sent region_name.
cloudcix.api.Vault.object.create
- Allows the user to upload (create or update) an Object into MinIO on the sent path and in the sent region_name.
cloudcix.api.Vault.object.delete
- Allows the user to delete an Object from MinIO.

Note

Based on how the URLs for are structured, it is required you pass region_name='name_of_region' and path='mybucket' to these methods

Region

This services allows for the management of Regions in the Vault Application.

A Region is a public cloud address that has a MinIO instance set up for linked addresses to utilize.

Basic Usage: cloudcix.api.Vault.region.<method>

Available Methods

cloudcix.api.Vault.region.list
- This method returns a list of Regions

Shared Bucket

This services allows for the management of Shared Buckets in the MinIO object store.

A user can read and delete a linked addresses MinIO’s Bucket based on the Share record the owner of the MinIO bucket has given them.

For each method request the following paramaters must be sent: - region_name

This paramater is used to create the MinIO client for the region.

path
- This paramater is used to specify the location of a Shared Bucket in the region’s MinIO.

Basic Usage: cloudcix.api.Vault.shared_bucket.<method>

Available Methods

cloudcix.api.Vault.shared_bucket.head
- Allows the user to verify if a Shared Bucket exists on the sent path in the Minio on the sent region_name.
- A 200 will be returned if the Bucket exists.
cloudcix.api.Vault.shared_bucket.read
- This method will return a list of Objects in the Shared Bucket on the sent path in the Minio on the sent region_name.
cloudcix.api.Vault.shared_bucket.delete
- Allows the user to delete the Shared Bucket on the sent path in the Minio on the sent region_name.

Note

Based on how the URLs for are structured, it is required you pass region_name='name_of_region' and path='mybucket' to these methods

Shared Object

This services allows for the management of Shared Objects in the MinIO object store.

A user can read, upload or delete a linked addresses MinIO’s Bucket based on the Share record the owner of the MinIO Object has given them.

For each method request the following paramaters must be sent: - region_name

This paramater is used to create the MinIO client for the region.

path
- This paramater is used to specify the location of a Shared Object in the region’s MinIO.

Returned with the head and read method requests will be the following metadata in _headers:

content_length
- The size of the Object.
content_type
- The Content-Type of the Object.
etag
- The ETag of the Object.
last_modified
- The time in UTC of when the Object was last modified.

Basic Usage: cloudcix.api.Vault.shared_object.<method>

Available Methods

cloudcix.api.Vault.shared_object.head
- Allows the user to verify if a Shared Object exists on the sent path in the Minio on the sent region_name.
- A 200 will be returned if the Object exists.
- Also returned in the response will be _headers where the metadata for each Shared Object will be recorded
cloudcix.api.Vault.shared_object.read
- Allows the user to retrive a Shared Object from the sent path and in the Minio on the sent region_name.
cloudcix.api.Vault.shared_object.create
- Allows the user to upload (create or update) a Shared Object into MinIO on the sent path and in the sent region_name.
cloudcix.api.Vault.shared_object.delete
- Allows the user to delete the Shared Bucket on the sent path in the Minio on the sent region_name.

Note

Based on how the URLs for are structured, it is required you pass region_name='name_of_region' and path='mybucket' to these methods

API Reference

App Manager

Services

App

App Member Link

Menu Item

Menu Item User Link

Asset

Services

Asset

Asset Transaction

Depreciation Type

Off Rent

Off Test

Rent

Circuit

Services

Circuit

Circuit Class

Property Type

Property Value

Contact

Services

Auth

Campaign

Campaign Contact

Chatbot

Contact

Conversation

Corpus

Group

Group Contact

Opportunity

Opportunity Contact

Opportunity History

Q and A

Question

Question Set

Contacts

Services

Activity

Activity Type

Campaign

Campaign Activity

Campaign Contact

Contact

Group

Group Contact

Opportunity

Opportunity Contact

Opportunity History

DCIM

Services

Circuit

Circuit Class

Property Type

Property Value

Financial

Services

Account Purchase Adjustment

Account Purchase Adjustment Contra

Account Purchase Debit Note

Account Purchase Debit Note Contra

Account Purchase Invoice

Account Purchase Invoice Contra

Account Purchase Payment

Account Purchase Payment Contra

Account Sale Adjustment

Account Sale Adjustment Contra

Account Sale Credit Note

Account Sale Credit Note Contra

Account Sale Invoice

Account Sale Invoice Contra

Account Sale Payment

Account Sale Payment Contra

Allocation

Balance Sheet

Cash Purchase Debit Note

Cash Purchase Debit Note Contra

Cash Purchase Invoice