Invoicing / Client / batch_get_invoice_profile

batch_get_invoice_profile

Invoicing.Client.batch_get_invoice_profile(**kwargs)

This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_invoice_profile(
    AccountIds=[
        'string',
    ]
)
Parameters:

AccountIds (list) –

[REQUIRED]

Retrieves the corresponding invoice profile data for these account IDs.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Profiles': [
        {
            'AccountId': 'string',
            'ReceiverName': 'string',
            'ReceiverAddress': {
                'AddressLine1': 'string',
                'AddressLine2': 'string',
                'AddressLine3': 'string',
                'DistrictOrCounty': 'string',
                'City': 'string',
                'StateOrRegion': 'string',
                'CountryCode': 'string',
                'CompanyName': 'string',
                'PostalCode': 'string'
            },
            'ReceiverEmail': 'string',
            'Issuer': 'string',
            'TaxRegistrationNumber': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Profiles (list) –

      A list of invoice profiles corresponding to the requested accounts.

      • (dict) –

        Contains high-level information about the invoice receiver.

        • AccountId (string) –

          The account ID the invoice profile is generated for.

        • ReceiverName (string) –

          The name of the person receiving the invoice profile.

        • ReceiverAddress (dict) –

          The address of the receiver that will be printed on the invoice.

          • AddressLine1 (string) –

            The first line of the address.

          • AddressLine2 (string) –

            The second line of the address, if applicable.

          • AddressLine3 (string) –

            The third line of the address, if applicable.

          • DistrictOrCounty (string) –

            The district or country the address is located in.

          • City (string) –

            The city that the address is in.

          • StateOrRegion (string) –

            The state, region, or province the address is located.

          • CountryCode (string) –

            The country code for the country the address is in.

          • CompanyName (string) –

            A unique company name.

          • PostalCode (string) –

            The postal code associated with the address.

        • ReceiverEmail (string) –

          The email address for the invoice profile receiver.

        • Issuer (string) –

          This specifies the issuing entity of the invoice.

        • TaxRegistrationNumber (string) –

          Your Tax Registration Number (TRN) information.

Exceptions