Skip to content

InvoicingClient#

Index > Invoicing > InvoicingClient

Auto-generated documentation for Invoicing type annotations stubs module mypy-boto3-invoicing.

InvoicingClient#

Type annotations and code completion for boto3.client("invoicing"). boto3 documentation

# InvoicingClient usage example

from boto3.session import Session
from mypy_boto3_invoicing.client import InvoicingClient

def get_invoicing_client() -> InvoicingClient:
    return Session().client("invoicing")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("invoicing").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("invoicing")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_invoicing.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("invoicing").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("invoicing").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

batch_get_invoice_profile#

This gets the invoice profile associated with a set of accounts.

Type annotations and code completion for boto3.client("invoicing").batch_get_invoice_profile method. boto3 documentation

# batch_get_invoice_profile method definition

def batch_get_invoice_profile(
    self,
    *,
    AccountIds: Sequence[str],
) -> BatchGetInvoiceProfileResponseTypeDef:  # (1)
    ...
  1. See BatchGetInvoiceProfileResponseTypeDef
# batch_get_invoice_profile method usage example with argument unpacking

kwargs: BatchGetInvoiceProfileRequestTypeDef = {  # (1)
    "AccountIds": ...,
}

parent.batch_get_invoice_profile(**kwargs)
  1. See BatchGetInvoiceProfileRequestTypeDef

create_invoice_unit#

This creates a new invoice unit with the provided definition.

Type annotations and code completion for boto3.client("invoicing").create_invoice_unit method. boto3 documentation

# create_invoice_unit method definition

def create_invoice_unit(
    self,
    *,
    Name: str,
    InvoiceReceiver: str,
    Rule: InvoiceUnitRuleUnionTypeDef,  # (1)
    Description: str = ...,
    TaxInheritanceDisabled: bool = ...,
    ResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (2)
) -> CreateInvoiceUnitResponseTypeDef:  # (3)
    ...
  1. See InvoiceUnitRuleUnionTypeDef
  2. See Sequence[ResourceTagTypeDef]
  3. See CreateInvoiceUnitResponseTypeDef
# create_invoice_unit method usage example with argument unpacking

kwargs: CreateInvoiceUnitRequestTypeDef = {  # (1)
    "Name": ...,
    "InvoiceReceiver": ...,
    "Rule": ...,
}

parent.create_invoice_unit(**kwargs)
  1. See CreateInvoiceUnitRequestTypeDef

create_procurement_portal_preference#

Creates a procurement portal preference configuration for e-invoice delivery and purchase order retrieval.

Type annotations and code completion for boto3.client("invoicing").create_procurement_portal_preference method. boto3 documentation

# create_procurement_portal_preference method definition

def create_procurement_portal_preference(
    self,
    *,
    ProcurementPortalName: ProcurementPortalNameType,  # (1)
    BuyerDomain: BuyerDomainType,  # (2)
    BuyerIdentifier: str,
    SupplierDomain: SupplierDomainType,  # (3)
    SupplierIdentifier: str,
    EinvoiceDeliveryEnabled: bool,
    PurchaseOrderRetrievalEnabled: bool,
    Contacts: Sequence[ContactTypeDef],  # (4)
    Selector: ProcurementPortalPreferenceSelectorUnionTypeDef = ...,  # (5)
    ProcurementPortalSharedSecret: str = ...,
    ProcurementPortalInstanceEndpoint: str = ...,
    TestEnvPreference: TestEnvPreferenceInputTypeDef = ...,  # (6)
    EinvoiceDeliveryPreference: EinvoiceDeliveryPreferenceUnionTypeDef = ...,  # (7)
    ResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (8)
    ClientToken: str = ...,
) -> CreateProcurementPortalPreferenceResponseTypeDef:  # (9)
    ...
  1. See ProcurementPortalNameType
  2. See BuyerDomainType
  3. See SupplierDomainType
  4. See Sequence[ContactTypeDef]
  5. See ProcurementPortalPreferenceSelectorUnionTypeDef
  6. See TestEnvPreferenceInputTypeDef
  7. See EinvoiceDeliveryPreferenceUnionTypeDef
  8. See Sequence[ResourceTagTypeDef]
  9. See CreateProcurementPortalPreferenceResponseTypeDef
# create_procurement_portal_preference method usage example with argument unpacking

kwargs: CreateProcurementPortalPreferenceRequestTypeDef = {  # (1)
    "ProcurementPortalName": ...,
    "BuyerDomain": ...,
    "BuyerIdentifier": ...,
    "SupplierDomain": ...,
    "SupplierIdentifier": ...,
    "EinvoiceDeliveryEnabled": ...,
    "PurchaseOrderRetrievalEnabled": ...,
    "Contacts": ...,
}

parent.create_procurement_portal_preference(**kwargs)
  1. See CreateProcurementPortalPreferenceRequestTypeDef

delete_invoice_unit#

This deletes an invoice unit with the provided invoice unit ARN.

Type annotations and code completion for boto3.client("invoicing").delete_invoice_unit method. boto3 documentation

# delete_invoice_unit method definition

def delete_invoice_unit(
    self,
    *,
    InvoiceUnitArn: str,
) -> DeleteInvoiceUnitResponseTypeDef:  # (1)
    ...
  1. See DeleteInvoiceUnitResponseTypeDef
# delete_invoice_unit method usage example with argument unpacking

kwargs: DeleteInvoiceUnitRequestTypeDef = {  # (1)
    "InvoiceUnitArn": ...,
}

parent.delete_invoice_unit(**kwargs)
  1. See DeleteInvoiceUnitRequestTypeDef

delete_procurement_portal_preference#

Deletes an existing procurement portal preference.

Type annotations and code completion for boto3.client("invoicing").delete_procurement_portal_preference method. boto3 documentation

# delete_procurement_portal_preference method definition

def delete_procurement_portal_preference(
    self,
    *,
    ProcurementPortalPreferenceArn: str,
) -> DeleteProcurementPortalPreferenceResponseTypeDef:  # (1)
    ...
  1. See DeleteProcurementPortalPreferenceResponseTypeDef
# delete_procurement_portal_preference method usage example with argument unpacking

kwargs: DeleteProcurementPortalPreferenceRequestTypeDef = {  # (1)
    "ProcurementPortalPreferenceArn": ...,
}

parent.delete_procurement_portal_preference(**kwargs)
  1. See DeleteProcurementPortalPreferenceRequestTypeDef

get_invoice_pdf#

Returns a URL to download the invoice document and supplemental documents associated with an invoice.

Type annotations and code completion for boto3.client("invoicing").get_invoice_pdf method. boto3 documentation

# get_invoice_pdf method definition

def get_invoice_pdf(
    self,
    *,
    InvoiceId: str,
) -> GetInvoicePDFResponseTypeDef:  # (1)
    ...
  1. See GetInvoicePDFResponseTypeDef
# get_invoice_pdf method usage example with argument unpacking

kwargs: GetInvoicePDFRequestTypeDef = {  # (1)
    "InvoiceId": ...,
}

parent.get_invoice_pdf(**kwargs)
  1. See GetInvoicePDFRequestTypeDef

get_invoice_unit#

This retrieves the invoice unit definition.

Type annotations and code completion for boto3.client("invoicing").get_invoice_unit method. boto3 documentation

# get_invoice_unit method definition

def get_invoice_unit(
    self,
    *,
    InvoiceUnitArn: str,
    AsOf: TimestampTypeDef = ...,
) -> GetInvoiceUnitResponseTypeDef:  # (1)
    ...
  1. See GetInvoiceUnitResponseTypeDef
# get_invoice_unit method usage example with argument unpacking

kwargs: GetInvoiceUnitRequestTypeDef = {  # (1)
    "InvoiceUnitArn": ...,
}

parent.get_invoice_unit(**kwargs)
  1. See GetInvoiceUnitRequestTypeDef

get_procurement_portal_preference#

Retrieves the details of a specific procurement portal preference configuration.

Type annotations and code completion for boto3.client("invoicing").get_procurement_portal_preference method. boto3 documentation

# get_procurement_portal_preference method definition

def get_procurement_portal_preference(
    self,
    *,
    ProcurementPortalPreferenceArn: str,
) -> GetProcurementPortalPreferenceResponseTypeDef:  # (1)
    ...
  1. See GetProcurementPortalPreferenceResponseTypeDef
# get_procurement_portal_preference method usage example with argument unpacking

kwargs: GetProcurementPortalPreferenceRequestTypeDef = {  # (1)
    "ProcurementPortalPreferenceArn": ...,
}

parent.get_procurement_portal_preference(**kwargs)
  1. See GetProcurementPortalPreferenceRequestTypeDef

list_invoice_summaries#

Retrieves your invoice details programmatically, without line item details.

Type annotations and code completion for boto3.client("invoicing").list_invoice_summaries method. boto3 documentation

# list_invoice_summaries method definition

def list_invoice_summaries(
    self,
    *,
    Selector: InvoiceSummariesSelectorTypeDef,  # (1)
    Filter: InvoiceSummariesFilterTypeDef = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInvoiceSummariesResponseTypeDef:  # (3)
    ...
  1. See InvoiceSummariesSelectorTypeDef
  2. See InvoiceSummariesFilterTypeDef
  3. See ListInvoiceSummariesResponseTypeDef
# list_invoice_summaries method usage example with argument unpacking

kwargs: ListInvoiceSummariesRequestTypeDef = {  # (1)
    "Selector": ...,
}

parent.list_invoice_summaries(**kwargs)
  1. See ListInvoiceSummariesRequestTypeDef

list_invoice_units#

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

Type annotations and code completion for boto3.client("invoicing").list_invoice_units method. boto3 documentation

# list_invoice_units method definition

def list_invoice_units(
    self,
    *,
    Filters: FiltersTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    AsOf: TimestampTypeDef = ...,
) -> ListInvoiceUnitsResponseTypeDef:  # (2)
    ...
  1. See FiltersTypeDef
  2. See ListInvoiceUnitsResponseTypeDef
# list_invoice_units method usage example with argument unpacking

kwargs: ListInvoiceUnitsRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_invoice_units(**kwargs)
  1. See ListInvoiceUnitsRequestTypeDef

list_procurement_portal_preferences#

Retrieves a list of procurement portal preferences associated with the Amazon Web Services account.

Type annotations and code completion for boto3.client("invoicing").list_procurement_portal_preferences method. boto3 documentation

# list_procurement_portal_preferences method definition

def list_procurement_portal_preferences(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProcurementPortalPreferencesResponseTypeDef:  # (1)
    ...
  1. See ListProcurementPortalPreferencesResponseTypeDef
# list_procurement_portal_preferences method usage example with argument unpacking

kwargs: ListProcurementPortalPreferencesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_procurement_portal_preferences(**kwargs)
  1. See ListProcurementPortalPreferencesRequestTypeDef

list_tags_for_resource#

Lists the tags for a resource.

Type annotations and code completion for boto3.client("invoicing").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

put_procurement_portal_preference#

Updates an existing procurement portal preference configuration.

Type annotations and code completion for boto3.client("invoicing").put_procurement_portal_preference method. boto3 documentation

# put_procurement_portal_preference method definition

def put_procurement_portal_preference(
    self,
    *,
    ProcurementPortalPreferenceArn: str,
    EinvoiceDeliveryEnabled: bool,
    PurchaseOrderRetrievalEnabled: bool,
    Contacts: Sequence[ContactTypeDef],  # (1)
    Selector: ProcurementPortalPreferenceSelectorUnionTypeDef = ...,  # (2)
    ProcurementPortalSharedSecret: str = ...,
    ProcurementPortalInstanceEndpoint: str = ...,
    TestEnvPreference: TestEnvPreferenceInputTypeDef = ...,  # (3)
    EinvoiceDeliveryPreference: EinvoiceDeliveryPreferenceUnionTypeDef = ...,  # (4)
) -> PutProcurementPortalPreferenceResponseTypeDef:  # (5)
    ...
  1. See Sequence[ContactTypeDef]
  2. See ProcurementPortalPreferenceSelectorUnionTypeDef
  3. See TestEnvPreferenceInputTypeDef
  4. See EinvoiceDeliveryPreferenceUnionTypeDef
  5. See PutProcurementPortalPreferenceResponseTypeDef
# put_procurement_portal_preference method usage example with argument unpacking

kwargs: PutProcurementPortalPreferenceRequestTypeDef = {  # (1)
    "ProcurementPortalPreferenceArn": ...,
    "EinvoiceDeliveryEnabled": ...,
    "PurchaseOrderRetrievalEnabled": ...,
    "Contacts": ...,
}

parent.put_procurement_portal_preference(**kwargs)
  1. See PutProcurementPortalPreferenceRequestTypeDef

tag_resource#

Adds a tag to a resource.

Type annotations and code completion for boto3.client("invoicing").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    ResourceTags: Sequence[ResourceTagTypeDef],  # (1)
) -> dict[str, Any]:
    ...
  1. See Sequence[ResourceTagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "ResourceTags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes a tag from a resource.

Type annotations and code completion for boto3.client("invoicing").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    ResourceTagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "ResourceTagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_invoice_unit#

You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.

Type annotations and code completion for boto3.client("invoicing").update_invoice_unit method. boto3 documentation

# update_invoice_unit method definition

def update_invoice_unit(
    self,
    *,
    InvoiceUnitArn: str,
    Description: str = ...,
    TaxInheritanceDisabled: bool = ...,
    Rule: InvoiceUnitRuleUnionTypeDef = ...,  # (1)
) -> UpdateInvoiceUnitResponseTypeDef:  # (2)
    ...
  1. See InvoiceUnitRuleUnionTypeDef
  2. See UpdateInvoiceUnitResponseTypeDef
# update_invoice_unit method usage example with argument unpacking

kwargs: UpdateInvoiceUnitRequestTypeDef = {  # (1)
    "InvoiceUnitArn": ...,
}

parent.update_invoice_unit(**kwargs)
  1. See UpdateInvoiceUnitRequestTypeDef

update_procurement_portal_preference_status#

Updates the status of a procurement portal preference, including the activation state of e-invoice delivery and purchase order retrieval features.

Type annotations and code completion for boto3.client("invoicing").update_procurement_portal_preference_status method. boto3 documentation

# update_procurement_portal_preference_status method definition

def update_procurement_portal_preference_status(
    self,
    *,
    ProcurementPortalPreferenceArn: str,
    EinvoiceDeliveryPreferenceStatus: ProcurementPortalPreferenceStatusType = ...,  # (1)
    EinvoiceDeliveryPreferenceStatusReason: str = ...,
    PurchaseOrderRetrievalPreferenceStatus: ProcurementPortalPreferenceStatusType = ...,  # (1)
    PurchaseOrderRetrievalPreferenceStatusReason: str = ...,
) -> UpdateProcurementPortalPreferenceStatusResponseTypeDef:  # (3)
    ...
  1. See ProcurementPortalPreferenceStatusType
  2. See ProcurementPortalPreferenceStatusType
  3. See UpdateProcurementPortalPreferenceStatusResponseTypeDef
# update_procurement_portal_preference_status method usage example with argument unpacking

kwargs: UpdateProcurementPortalPreferenceStatusRequestTypeDef = {  # (1)
    "ProcurementPortalPreferenceArn": ...,
}

parent.update_procurement_portal_preference_status(**kwargs)
  1. See UpdateProcurementPortalPreferenceStatusRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("invoicing").get_paginator method with overloads.