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

Search Distributor Invoices

Description

Retrieves marketplace invoices of a specified Distributor organization

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
orgId Required

ID of the partner CSP organization


Query Parameters

Query Parameters

string
documentType Optional

Type of document such as invoice or credit memo


integer
pageLimit Optional

Number of results to be fetched per page


integer
pageStart Optional

Result number to be first on the page


Request Body

Request Body

DistributorInvoiceSearchRequest of mimetype application/json Optional

Distributor invoice summary filters and sorter

{
	"filters": [
		{
			"key": "SUBSCRIPTION_ID",
			"operator": "EQUALS",
			"value": "M727949919"
		}
	],
	"sorter": {
		"key": "DATE_RECEIVED",
		"operator": "ASC"
	}
}
array of object
filters Optional

A list of filters for invoices


sorter Optional

A sorter for sorting invoices e.g. DATE_RECEIVED

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DistributorInvoicesPage of type application/json
{
	"current": 0,
	"next": 0,
	"results": [
		{
			"billingReportFileName": "string",
			"documentType": "CREDITMEMO",
			"fileGenerationDate": "string",
			"invoiceFileName": "string",
			"partnerName": "string",
			"prmId": "string",
			"subscriptionId": "string"
		}
	],
	"totalResultsCount": 0
}
integer as int32
current Optional

First result on the current page


integer as int32
next Optional

First result on the next page


results Optional

Paginated list of invoices for Distributor


integer as int32
totalResultsCount Optional

The total number of results

Errors

Errors

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 '{"filters":[{"key":"SUBSCRIPTION_ID","operator":"EQUALS","value":"M727949919"}],"sorter":{"key":"DATE_RECEIVED","operator":"ASC"}}' https://{api_host}/distributors/{orgId}/invoices/search


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

Was this page helpful?