Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListInvoiceCorrections

Provides a listing of correction processes and basic details. Allows filtering by invoices to only retrieve corrections of specific invoices.

Request Syntax


{
   "Filter": { 
      "BillingPeriod": { 
         "Month": number,
         "Year": number
      },
      "InvoiceId": "string"
   },
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filter

Filters to target invoice corrections (i.e. by invoice ID, billing period, etc.).

Type: CorrectionsFilter object

Required: No

MaxResults

Maximum number of results returned per page of responses. Default is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

Next paginated page token.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\S\s]*

Required: No

Response Syntax


{
   "Corrections": [ 
      { 
         "CorrectionId": "string",
         "CorrectionType": "string",
         "EndedAt": number,
         "InvoiceId": "string",
         "StartedAt": number,
         "Status": "string",
         "UpdatedAt": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Corrections

List of invoice corrections for a given account.

Type: Array of Correction objects

NextToken

Next paginated page token.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\S\s]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action.

resourceName: You don't have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The processing request failed because of an unknown error, exception, or failure.

retryAfterSeconds: The processing request failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an Amazon Web Services service.

fieldList: The input fails to satisfy the constraints specified by an Amazon Web Services service.
reason: You don't have sufficient access to perform this action.
resourceName: You don't have sufficient access to perform this action.

HTTP Status Code: 400