Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListInvoiceUnits

This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.

Request Syntax


{
   "AsOf": number,
   "Filters": { 
      "Accounts": [ "string" ],
      "InvoiceReceivers": [ "string" ],
      "Names": [ "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.

AsOf

The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the current time.

Type: Timestamp

Required: No

Filters

An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers, Names, and Accounts.

Type: Filters object

Required: No

MaxResults

The maximum number of invoice units that can be returned.

Type: Integer

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

Required: No

NextToken

The next token used to indicate where the returned list should start from.

Type: String

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

Pattern: [\S\s]*

Required: No

Response Syntax


{
   "InvoiceUnits": [ 
      { 
         "Description": "string",
         "InvoiceReceiver": "string",
         "InvoiceUnitArn": "string",
         "LastModified": number,
         "Name": "string",
         "Rule": { 
            "LinkedAccounts": [ "string" ]
         },
         "TaxInheritanceDisabled": boolean
      }
   ],
   "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.

InvoiceUnits

An invoice unit is a set of mutually exclusive accounts that correspond to your business entity.

Type: Array of InvoiceUnit objects

NextToken

The next token used to indicate where the returned list should start from.

Type: String

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

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.

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