API for AWS Invoicing¶
ABAP Package | /AWS1/API_BII_IMPL |
---|---|
ABAP SDK "TLA" | BII |
ABAP Interface | /AWS1/IF_BII |
The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary
objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for AWS Invoicing is BII
.
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
Installation¶
To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the Invoicing module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.
About The Service¶
Amazon Web Services Invoice Configuration
You can use Amazon Web Services Invoice Configuration APIs to programmatically create, update, delete, get, and list invoice units. You can also programmatically fetch the information of the invoice receiver. For example, business legal name, address, and invoicing contacts.
You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
Service endpoint
You can use the following endpoints for Amazon Web Services Invoice Configuration:
-
https://invoicing.us-east-1.api.aws
Using the SDK¶
In your code, create a client using the SDK module for AWS Invoicing, which is created with
factory method /AWS1/CL_BII_FACTORY
=>create()
.
In this example we will assume you have configured
an SDK profile in transaction /AWS1/IMG
called ZFINANCE
.
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_bii) = /aws1/cl_bii_factory=>create( go_session ).
Your variable go_bii
is an instance of /AWS1/IF_BII
,
and all of the operations
in the AWS Invoicing service are accessed by calling methods in /AWS1/IF_BII
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS Invoicing, see the Operation List.
Factory Method¶
/AWS1/CL_BII_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_BII
.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL
TYPE /AWS1/RT_PROTOCOL
/AWS1/RT_PROTOCOL
¶
IO_SESSION
TYPE REF TO /AWS1/CL_RT_SESSION_BASE
/AWS1/CL_RT_SESSION_BASE
¶
IV_REGION
TYPE /AWS1/RT_REGION_ID
/AWS1/RT_REGION_ID
¶
IV_CUSTOM_ENDPOINT
TYPE /AWS1/RT_ENDPOINT
/AWS1/RT_ENDPOINT
¶
RETURNING¶
OO_CLIENT
TYPE REF TO /AWS1/IF_BII
/AWS1/IF_BII
¶
/AWS1/IF_BII
represents the ABAP client for the Invoicing service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_bii)->get_config( ).
lo_config
is a variable of type /AWS1/CL_BII_CONFIG
. See the documentation for /AWS1/CL_BII_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for AWS Invoicing can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_BII_PAGINATOR
. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using has_next()
and get_next()
methods.
Details about the paginator methods available for service AWS Invoicing can be found in interface /AWS1/IF_BII_PAGINATOR
.