Cloud storage

Use cloud storage to define targets for delivery of report output. See Cloud Storage for reports in the Sage Intacct Help Center for details.

List cloud storage

get/objects/company-config/cloud-storage

Returns a collection with a key, ID, and link for each cloud storage. This operation is mostly for use in testing; use the query service to find employee groups that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "AWS cloud Storage A1",
      • "href": "/objects/company-config/cloud-storage/1"
      },
    • {
      • "key": "2",
      • "id": "AWS cloud Storage A2",
      • "href": "/objects/company-config/cloud-storage/2"
      },
    • {
      • "key": "3",
      • "id": "AWS cloud Storage A3",
      • "href": "/objects/company-config/cloud-storage/3"
      },
    • {
      • "key": "4",
      • "id": "AWS cloud Storage A4",
      • "href": "/objects/company-config/cloud-storage/4"
      },
    • {
      • "key": "5",
      • "id": "AWS cloud Storage A5",
      • "href": "/objects/company-config/cloud-storage/5"
      }
    ],
  • "ia::meta": {
    • "totalCount": 5,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a cloud storage
post/objects/company-config/cloud-storage
Creates a new cloud storage object.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Creates a new cloud storage object.


storageType
required
string
Cloud storage targets supported for Intacct report delivery.


 Enum: "aws" "azureStorage" "box" "dropbox" "googleDrive" "http" "oneDrive"  
 Example:  "box"
id
required
string
Name for the cloud storage.


 
 Example:  "Amazon Storage Plan"
required
object
The user who owns the cloud storage target.


 
key
string
Sysstem-assigned key for the user.


 
 Example:  "1"
id
string
Unique identifier for the user.


 
 Example:  "Admin"
errorNotificationEmail
string
The email address where any error reports for the cloud storage target are sent.


 
 Example:  "[email protected]"
object
For report output delivered to another application using an HTTP POST request.


 
addressOrURL
string
Complete address where the report output is sent starting with http or https.


 
 Example:  "https://intacctdev1.blob.core.windows.net/?sv=2022-11-02&ss=bfqt&srt=co&sp=rwdlacupiytfx&se=2023-12-05T14:22:30Z&st=2023-12-05T06:22:30Z&spr=https,http&sig=lxcTbphsbi3Gj5hhzBeO1mQ55yHIyVue9IUmZVl13s8%3D"
username
string
User name for the HTTP storage service.


 
 Example:  "Admin"
password
string
Password for the HTTP storage service.


 
 Example:  "ExmPass!123"
isPrivate
boolean
 Default:  true
Private targets can be used only by the owner of the target and any administrators.


 
 Example:  true
path
string
The location relative to the top level of the cloud storage target, where reports are to be delivered.


 
 Example:  "/"
lastDeliveryStatus
string
The status of the most recent delivery.


 
 Example:  "Delivery error"
object
Storage details for report output delivered to Amazon.


 
s3Bucket
string
Bucket for your company in your Amazon S3 account.


 
 Example:  "S3"
enableEncryption
boolean
 Default:  false
Indicates whether to enable encryption for Amazon cloud storage.


 
 Example:  false
restrictFileAccess
string
 Default:  "bucketOwnerOnly"
Restrict file access to one of the following:


    

  • bucketOwnersOnly - restricts file access to the Amazon S3 bucket owner and the account owner
    • 

  • authenticatedUsers -  allows any Amazon Web Services user access to the file with the Amazon S3 file URL
    • 

  • public - unrestricted
    • 



 Enum: "authenticatedUsers" "bucketOwnerOnly" "public"  
 Example:  "bucketOwnerOnly"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Amazon Storage Plan",
  • "storageType": "aws",
  • "status": "active",
  • "errorNotificationEmail": "[email protected]",
  • "path": "/",
  • "awsStorage": {
    • "s3Bucket": "S3",
    • "restrictFileAccess": "bucketOwnerOnly"
    },
  • "owner": {
    • "id": "Admin"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "44",
    • "id": "AWS Cloud Storage1",
    • "href": "/objects/company-config/cloud-storage/44"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a cloud storage
get/objects/company-config/cloud-storage/{key}
Returns detailed information for a specified cloud storage.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the cloud storage.


 
 Example:  34
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "44",
    • "id": "Amazon Storage Plan",
    • "status": "active",
    • "storageType": "aws",
    • "state": "active",
    • "audit": {
      • "createdDateTime": "2023-11-30T10:19:22Z",
      • "modifiedDateTime": "2023-11-30T10:19:22Z",
      • "createdBy": "34",
      • "modifiedBy": "1",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "errorNotificationEmail": "[email protected]",
    • "queuedCount": 2,
    • "isPrivate": true,
    • "path": "/",
    • "lastDeliveryDateTime": "2023-01-12T18:08:58Z",
    • "lastDeliveryStatus": "Delivery error",
    • "owner": {
      • "key": "1",
      • "id": "Admin",
      • "userName": "ADMIN",
      • "href": "/objects/company-config/user/1"
      },
    • "awsStorage": {
      • "s3Bucket": "S3",
      • "enableEncryption": false,
      • "restrictFileAccess": "bucketOwnerOnly"
      },
    • "href": "/objects/company-config/cloud-storage/44"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a cloud storage
patch/objects/company-config/cloud-storage/{key}
Updates an existing cloud storage by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the cloud storage.


 
 Example:  34
Request Body schema: application/json
errorNotificationEmail
string
The email address where any error reports for the cloud storage target are sent.


 
 Example:  "[email protected]"
object
For report output delivered to another application using an HTTP POST request.


 
addressOrURL
string
Complete address where the report output is sent starting with http or https.


 
 Example:  "https://intacctdev1.blob.core.windows.net/?sv=2022-11-02&ss=bfqt&srt=co&sp=rwdlacupiytfx&se=2023-12-05T14:22:30Z&st=2023-12-05T06:22:30Z&spr=https,http&sig=lxcTbphsbi3Gj5hhzBeO1mQ55yHIyVue9IUmZVl13s8%3D"
username
string
User name for the HTTP storage service.


 
 Example:  "Admin"
password
string
Password for the HTTP storage service.


 
 Example:  "ExmPass!123"
isPrivate
boolean
 Default:  true
Private targets can be used only by the owner of the target and any administrators.


 
 Example:  true
path
string
The location relative to the top level of the cloud storage target, where reports are to be delivered.


 
 Example:  "/"
lastDeliveryStatus
string
The status of the most recent delivery.


 
 Example:  "Delivery error"
object
Storage details for report output delivered to Amazon.


 
s3Bucket
string
Bucket for your company in your Amazon S3 account.


 
 Example:  "S3"
enableEncryption
boolean
 Default:  false
Indicates whether to enable encryption for Amazon cloud storage.


 
 Example:  false
restrictFileAccess
string
 Default:  "bucketOwnerOnly"
Restrict file access to one of the following:


    

  • bucketOwnersOnly - restricts file access to the Amazon S3 bucket owner and the account owner
    • 

  • authenticatedUsers -  allows any Amazon Web Services user access to the file with the Amazon S3 file URL
    • 

  • public - unrestricted
    • 



 Enum: "authenticatedUsers" "bucketOwnerOnly" "public"  
 Example:  "bucketOwnerOnly"
object
The user who owns the cloud storage target.


 
key
string
Sysstem-assigned key for the user.


 
 Example:  "1"
id
string
Unique identifier for the user.


 
 Example:  "Admin"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "44",
    • "id": "Amazon Storage Plan",
    • "href": "/objects/company-config/cloud-storage/44"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a cloud storage
delete/objects/company-config/cloud-storage/{key}
Delete a cloud storage object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the cloud storage.


 
 Example:  34
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}