Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartInvoiceCorrection

Initiates the correction process for an invoice. This is considered a mutating operation.

Request Syntax


{
   "ClientToken": "string",
   "InvoiceId": "string",
   "Reasons": [ "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.

ClientToken

A unique identifier that ensures that retries are safe, for as long as the correction that results as a response to this request is stored. To retry after a failure, such as in validations, a new client token must be used.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: \S+

Required: Yes

InvoiceId

The ID of the invoice to be corrected.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\s\S]*

Required: Yes

Reasons

The reason codes for the correction.

Type: Array of strings

Valid Values: PURCHASE_ORDER | BUSINESS_LEGAL_NAME | BUSINESS_LEGAL_ADDRESS | TAX_REGISTRATION_NUMBER | TAXATION

Required: Yes

Response Syntax


{
   "CorrectionId": "string",
   "StartedAt": number
}

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.

CorrectionId

A system generated handle to this correction process.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: \S+

StartedAt

Start time of the correction process.

Type: Timestamp

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

ConflictException

Thrown when a correction is already running or the invoice has already been rebilled or sent to customer support.

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

ResourceNotFoundException

The resource could not be found.

resourceName: The resource could not be found.

HTTP Status Code: 400

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