[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Download Distributor Invoices

Description

Downloads a list of invoices for a specified distributor organization. The list of files to be downloaded are included in the request body. A maximum of 10 files can be downloaded at a time. The response contains a single compressed file of the downloaded invoices.

Request

Request

URL

URL


post
https://{api_host}/distributors/{orgId}/invoices/download
Copy

Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP


Request Body

Request Body

InvoiceDownloadFiles of mimetype application/json Optional

Distributor invoice file names for download

{
	"fileNames": [
		"filename1.csv",
		"filename2.pdf"
	]
}
array of string
fileNames Optional

List of invoice file names to be downloaded

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns string formatted as binary of type application/octet-stream
Errors

Errors

ErrorResponse
400

Bad Request - The request is either incomplete or incorrect


ErrorResponse
401

Unauthorized - The request requires user authentication


ErrorResponse
403

Forbidden - User does not have permission for this operation


ErrorResponse
404

Not Found - The requested resource does not exist


ErrorResponse
500

Internal Server Error - Please contact support

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"fileNames":["filename1.csv","filename2.pdf"]}' https://{api_host}/distributors/{orgId}/invoices/download


[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Feedback

Was this page helpful?