Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateInvoiceUnit

This creates a new invoice unit with the provided definition.

Request Syntax


{
   "Description": "string",
   "InvoiceReceiver": "string",
   "Name": "string",
   "ResourceTags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Rule": { 
      "LinkedAccounts": [ "string" ]
   },
   "TaxInheritanceDisabled": boolean
}

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.

Description

The invoice unit's description. This can be changed at a later time.

Type: String

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

Pattern: [\S\s]*

Required: No

InvoiceReceiver

The AWS account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.

Type: String

Pattern: \d{12}

Required: Yes

Name

The unique name of the invoice unit that is shown on the generated invoice. This can't be changed once it is set. To change this name, you must delete the invoice unit recreate.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: (?! )[\p{L}\p{N}\p{Z}-_]*(?<! )

Required: Yes

ResourceTags

The tag structure that contains a tag key and value.

Type: Array of ResourceTag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Rule

The InvoiceUnitRule object used to create invoice units.

Type: InvoiceUnitRule object

Required: Yes

TaxInheritanceDisabled

Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

Type: Boolean

Required: No

Response Syntax


{
   "InvoiceUnitArn": "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.

InvoiceUnitArn

The ARN to identify an invoice unit. This information can't be modified or deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+

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.

HTTP Status Code: 400

InternalServerException

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 AWS service.

HTTP Status Code: 400