class UsageFile

Returns:

Lists all UsageFiles that match the given filters. Supported filters are:

• product_id
• distribution_contract_id
• status
• created_at

Returns:

Note provided by the provider in case of acceptance of the usage file.

Reference to Contract object.

Currency of the amount included in UsageFile.

Vendor can provide a description value in this field to describe the file content.

Environment of the UsageFile.

In case of invalid file, this field will contain errors related to the file.

Reference to Events ocurred on the UsageFile.

External id of the UsageFile.

Reference to Marketplace object.

Name of the UsageFile object.

Vendor can put a note which can be referred to later for some extra information.

Period covered by this UsageFile.

Google Storage shared location of the generated file after processing uploaded file. Only available in GET API and not included in list API (sharing timeout 30 sec).

Reference to Product object.

Reference to Provider Account.

Note provider by the provider in case of rejection of the usage file.

Usage scheme used for the usage file. One of: QT, TR, CR, PR.

Reference to UsageStats object.

One of:

• draft
• uploading
• uploaded
• processing
• invalid
• ready
• rejected
• pending
• accepted
• closed

Google Storage shared location of the upload file. Only available in GET API and not included in list API (sharing timeout 600 sec).

Reference to Vendor Account.

Accepts this UsageFile.

Returns:

Cancels this UsageFile.

Returns:

Deletes this UsageFile in the server.

Gets the contents of the product specific file template for this UsageFile.

Gets the product specific file template URL for this UsageFile.

Registers a new UsageFile on Connect, based on the data of this UsageFile, which should have a value at least in the following fields:

• name
• product.id
• contract.id

Returns:

Rejects this UsageFile.

Returns:

Reprocesses a processed file. This is called by the provider after the provider closes some usage records manually.

Returns:

Submits this UsageFile.

Returns:

Updates this UsageFile in the server with the data changed in this model.

You should reassign your file with the object returned by this method, so the next time you call update on the object, the SDK knows the fields that already got updated in a previous call, like this:

file = file.update();

Returns:

Uploads the specified contents to this UsageFile in Connect.

Parameters:

Returns:

Uploads the contents of a reconciliation file to this UsageFile.

Parameters:

Returns:

Uploads the Collection of UsageRecord objects to this UsageFile in Connect. The SDK automatically generates a Microsoft Excel XLSX file with the records and uploads it, so this is a more convenient version of the UsageFile.upload() method, which requires you to generate the Excel file contents yourself.

Uploads the Collection of UsageRecord objects and UsageCategory objects to this UsageFile in Connect. The SDK automatically generates a Microsoft Excel XLSX file with the records and uploads it, so this is a more convenient version of the UsageFile.upload() method, which requires you to generate the Excel file contents yourself.