GetInvoiceCorrection
Provides visibility into the correction process and resulting artifacts for a specific invoice correction.
Request Syntax
{
"CorrectionId": "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.
- CorrectionId
-
Identifier of the triggered correction of invoice.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
\S+Required: Yes
Response Syntax
{
"Cause": "string",
"CorrectionId": "string",
"CorrectionType": "string",
"EndedAt": number,
"Error": "string",
"InvoiceId": "string",
"Reasons": [ "string" ],
"Results": [
{
"InvoiceId": "string",
"InvoiceType": "string"
}
],
"StartedAt": number,
"Status": "string",
"SupportCaseId": "string",
"UpdatedAt": number,
"VatInvoiceIds": [ "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.
- Cause
-
Cause of error or issue relating to the invoice correction process.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\s\S]* - CorrectionId
-
Identifier of the triggered correction of invoice.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
\S+ - CorrectionType
-
Type of invoice correction.
Type: String
Valid Values:
REGENERATION | REBILL | SUPPORT - EndedAt
-
Completion time of the invoice correction.
Type: Timestamp
- Error
-
Error code if an error arises during the invoice correction process.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
\S+ - InvoiceId
-
The ID of the invoice being corrected.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\s\S]* - Reasons
-
List of original reason codes provided for the invoice correction.
Type: Array of strings
Valid Values:
PURCHASE_ORDER | BUSINESS_LEGAL_NAME | BUSINESS_LEGAL_ADDRESS | TAX_REGISTRATION_NUMBER | TAXATION - Results
-
Correction results for the original invoice.
Type: Array of CorrectionResult objects
- StartedAt
-
Start time of the invoice correction.
Type: Timestamp
- Status
-
Status of the invoice correction.
Type: String
Valid Values:
COMPLETED | VALIDATING | PENDING_APPROVAL | RUNNING | FAILED - SupportCaseId
-
Support case ID if applicable.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\s\S]* - UpdatedAt
-
Time at which an update was present for the invoice correction.
Type: Timestamp
- VatInvoiceIds
-
List of VAT invoice IDs for the original invoice.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 1024.
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
- 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
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: