--- title: "Get Saved Commission Summary Report" method: GET path: "/v4/commission_reports/summary/{reportId}" tags: ["Gateway Features", "Billing & Commission"] --- # Get Saved Commission Summary Report `GET /v4/commission_reports/summary/{reportId}` ## Request - Base URL: `https://sandbox.nmi.com/api` - URL: `https://sandbox.nmi.com/api/v4/commission_reports/summary/{reportId}` - Auth: API key in header `Authorization` > 📘 Commission summary > > Your API key must belong to a partner user with the commission permission.
Usage Page through a large commission summary without rebuilding it. This endpoint gets a page of a report you created with `POST /v4/commission_reports/summary`. Use `offset` and `maxResults` to choose the page. The response returns those two fields as strings, exactly as you sent them. A report is saved for **24 hours**, and only the user who created it can get it. If the report has expired, does not exist, or belongs to another user, the endpoint returns `404`. Create a new report to continue. Use `hasMore` to decide whether to request another page. To get another page, call this endpoint with `reportId`, `offset`, and `maxResults`. An `offset` past the end of the report returns `422`.
## Path parameters - `reportId` integer, required ## Query parameters - `offset` integer - `maxResults` integer, required ## Headers - `Authorization` string, required ## Response `200` A page of the report. - CommissionSummaryResponse: One page of a saved commission summary report. - `objectType` 'report', required: Always `report`. - `reportId` integer, required: ID of the saved report. Use it with Get Saved Commission Summary Report for 24 hours. - `offset` union, required: `offset` from the request. Null when the request did not set it. A number from Create Commission Summary Report. A string from Get Saved Commission Summary Report, which echoes the query parameter. - integer - string - `maxResults` union, required: `maxResults` from the request. A number from Create Commission Summary Report. A string from Get Saved Commission Summary Report, which echoes the query parameter. - integer - string - `totalResults` integer, required: Number of results in the whole report. - `hasMore` boolean, required: `true` when more results follow this page. - `links` object, required: Page links. Use `hasMore` to decide whether to request another page, and get pages with Get Saved Commission Summary Report. - `first` string, nullable: Link to the first page. - `last` string, nullable: Link to the last page. - `next` string, nullable: Link to the next page. - `previous` string, nullable: Link to the previous page. - `results` CommissionSummaryItem[], required: Results on this page. - `objectType` 'commissionSummary', required: Always `commissionSummary`. - `merchant_id` string, required: Gateway ID of the merchant. - `merchant_name` string, required: Merchant company name. - `statement_id` string, required: ID of the merchant billing statement (invoice) that billed the fee. This is not a commission statement ID. - `gross_revenue` CommissionAmount, required: A monetary amount. - `objectType` 'amount', required: Always `amount`. - `amount` string, required: The amount as a decimal string. - `currency` string, required: ISO 4217 currency code. - `cost` CommissionAmount, required: A monetary amount. - `objectType` 'amount', required: Always `amount`. - `amount` string, required: The amount as a decimal string. - `currency` string, required: ISO 4217 currency code. - `sell_rate` union, required: Resale price per unit. A percent for percentage fees, otherwise an amount. - Percent: A percentage rate. - `objectType` 'percent', required: Always `percent`. - `percent` string, required: The rate in percent, as a decimal string with two decimal places. `2.50` means 2.50%. - CommissionAmount: A monetary amount. - `objectType` 'amount', required: Always `amount`. - `amount` string, required: The amount as a decimal string. - `currency` string, required: ISO 4217 currency code. - `buy_rate` union, required: The partner's cost per unit. A percent for percentage fees, otherwise an amount. - Percent: A percentage rate. - `objectType` 'percent', required: Always `percent`. - `percent` string, required: The rate in percent, as a decimal string with two decimal places. `2.50` means 2.50%. - CommissionAmount: A monetary amount. - `objectType` 'amount', required: Always `amount`. - `amount` string, required: The amount as a decimal string. - `currency` string, required: ISO 4217 currency code. - `net_revenue` CommissionAmount, required: A monetary amount. - `objectType` 'amount', required: Always `amount`. - `amount` string, required: The amount as a decimal string. - `currency` string, required: ISO 4217 currency code. - `merchant_processor_id` string, required: ID of the merchant processor configuration. - `merchant_processor_name` string, required: Name of the merchant processor configuration, or the processor name when the configuration has no name. - `processor_id` string, required: Processor ID. - `fee_type_id` string, required: ID of the fee. - `billed_quantity` string, required: Billed quantity as a decimal string. - `pay_commission_to_affiliate` '0' | '1', required: `1` when the commission is paid to the partner. `0` when the commission is reported but not paid. ## Other responses - `401`: The API key is missing or not valid. - `403`: The key does not belong to a partner user with the commission permission. - `404`: The report does not exist, has expired, or was created by another user. - `422`: A parameter is not valid, or `offset` is past the end of the report. - `500`: The request could not be completed. --- [API](https://skmtc.dev/nmi/apis/payments-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-api/revisions/c03727f27e27?raw)