Class UsageFileResource

Updated: March 10, 2021
Contents

Classes

CategoryUsageFileResourceGenericResource

The CategoryUsageFileResource class provides methods to access the
categor objects for a usage file.

UsageFileResourceGenericResource

The UsageFileResource class provides methods to access the usage file
endpoint of the Cloud Blue Connect API.

CategoryUsageFileResource ⇐ GenericResource

The CategoryUsageFileResource class provides methods to access the
categor objects for a usage file.

Kind: global class
Extends: GenericResource
Category: Resources

UsageFileResource ⇐ GenericResource

The UsageFileResource class provides methods to access the usage file
endpoint of the Cloud Blue Connect API.

Kind: global class
Extends: GenericResource
Category: Resources

new UsageFileResource(client)

Creates a new instance of the UsageFileResource class.

Returns: UsageFileResource – An instance of the UsageFileResource class.

ParamTypeDescription
client ConnectClient An instance of the ConnectClient class.

usageFileResource.categories(id) ⇒ CategoryUsageFileResource

Returns an instance of the CategoryUsageFileResource for a UsageFile.

Kind: instance method of UsageFileResource
Returns: CategoryUsageFileResource – An instance of the CategoryUsageFileResource
for the case.

ParamTypeDescription
id string The unique identifier of the UsageFile.

usageFileResource.accept(id, acceptanceNote) ⇒ UsageFileResource

Accept Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource.

ParamTypeDescription
id string The unique identifier of the Usage File.
acceptanceNote string Acceptance Note

usageFileResource.approveAll(id) ⇒ UsageFileResource

Approve all Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource

ParamTypeDescription
id string The unique identifier of the Usage File.

usageFileResource.close(id) ⇒ UsageFileResource

Close Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource

ParamTypeDescription
id string The unique identifier of the Usage File.

usageFileResource.delete(id) ⇒ UsageFileResource

Delete Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource

ParamTypeDescription
id string The unique identifier of the Usage File.

usageFileResource.reprocess(id) ⇒ UsageFileResource

Reprocess Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource

ParamTypeDescription
id string The unique identifier of the Usage File.

usageFileResource.submit(id) ⇒ UsageFileResource

Submit Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource

ParamTypeDescription
id string The unique identifier of the Usage File.

usageFileResource.reconciliation(id, reconFile) ⇒ UsageFileResource

Reconciliation Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource.

ParamTypeDescription
id string The unique identifier of the Usage File.
reconFile binary Reconciliation binary file

usageFileResource.reject(id, rejectionNote) ⇒ UsageFileResource

Reject Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource.

ParamTypeDescription
id string The unique identifier of the Usage File.
rejectionNote text Rejection note

usageFileResource.upload(id, usageFile) ⇒ UsageFileResource

Upload Usage File.

Kind: instance method of UsageFileResource
Returns: UsageFileResource – An instance of the UsageFileResource.

ParamTypeDescription
id string The unique identifier of the Usage File.
usageFile binary File to upload
Is this page helpful?
Translate with Google
Copied to clipboard