Retrieves up to 100 financial records in one request, including the details that are specific to each record’s type. Identify each record by its ID or by its invoice ID. Results can be partial: each key that you request appears once in the response, either as a record in financialRecords or as an error in errors . A key that matches no record on your account is returned in errors and doesn’t fail the request. This operation provides strongly consistent reads.
To use this operation, you must have Amazon Web Services Identity and Access Management (IAM) permission for both payments:BatchGetFinancialRecord and payments:GetPaymentStatus .
See also: AWS API Documentation
batch-get-financial-record
--keys <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
--keys (list) [required]
The keys of the financial records to retrieve. Each key is either the record’s ID or its invoice ID.
Constraints:
- min:
1- max:
100(tagged union structure)
A way to identify a financial record. Specify exactly one member: the ID that Amazon Web Services Payments issued, in
identifier, or the invoice ID that Amazon Web Services Invoicing issued, ininvoiceIdentifier. If you specify both or neither, the request fails withValidationException.Note
This is a Tagged Union structure. Only one of the following top level keys can be set:identifier,invoiceIdentifier.identifier -> (string)
The ID that Amazon Web Services Payments issued for the record.
Constraints:
- min:
17- max:
23- pattern:
[A-Z]{2,3}-[0-9]{4}-[0-9]{4}-[0-9]{4}(-[0-9]{4})?invoiceIdentifier -> (string)
The invoice ID that Amazon Web Services Invoicing issued for an invoice or a credit memo.
Constraints:
- min:
1- max:
1024- pattern:
\S(.*\S)?
Shorthand Syntax:
identifier=string,invoiceIdentifier=string ...
JSON Syntax:
[
{
"identifier": "string",
"invoiceIdentifier": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
--help (boolean)
Display help for the command/subcommand.
financialRecords -> (list)
The financial records that the operation retrieved, in no particular order. This list contains fewer records than you requested when
errorsnames one or more keys.(structure)
An invoice or a credit memo on your account, with the details that are specific to its type.
id -> (string) [required]
The ID that Amazon Web Services Payments issued for the record, such as
INV-5364-6253-7364-1342. To retrieve the record again, pass this value toGetFinancialRecordorBatchGetFinancialRecordasidentifier.Constraints:
- min:
17- max:
23- pattern:
[A-Z]{2,3}-[0-9]{4}-[0-9]{4}-[0-9]{4}(-[0-9]{4})?type -> (string) [required]
The type of the financial record. The populated member of
detailsmatches this type. The following values are valid:
INVOICE– An invoice: a bill from Amazon Web Services. Payments and credit memos applied to the invoice settle it.CREDIT_MEMO– A credit memo: a credit issued to your account, for example for a billing correction or a service credit. Applying it to one or more invoices settles it.Possible values:
INVOICECREDIT_MEMObusinessUnit -> (structure) [required]
The Amazon Web Services business unit that issued the record: its merchant of record and its line of business.
merchantOfRecord -> (string) [required]
The Amazon Web Services entity that issued the invoice and collects payment for it, such as
Amazon Web Services, Inc.orAmazon Web Services EMEA SARL. This is the invoicing entity shown in the Amazon Web Services Billing and Cost Management console. For Amazon Web Services Marketplace purchases, it can differ from the seller of record.Constraints:
- min:
1- max:
256lineOfBusiness -> (string)
The line of business within the merchant of record that issued the record. This member is absent when the line of business isn’t known for the record. The following values are valid:
AWS_CLOUD_SERVICES– Your usage of Amazon Web Services services.PROSERVE_MARKETING_AND_TRAINING– Amazon Web Services Professional Services, marketing, and training: consulting, events, and training that Amazon Web Services sells.AWS_MARKETPLACE– Products that you bought from sellers in Amazon Web Services Marketplace.Possible values:
AWS_CLOUD_SERVICESPROSERVE_MARKETING_AND_TRAININGAWS_MARKETPLACEamount -> (structure) [required]
The total amount of the financial record, in the currency that the record was issued in. The amount doesn’t change as the record is settled.
balancesshows how much of it is in each settlement state.value -> (string) [required]
The amount, as a decimal string, such as
10.99. The number of decimal places can differ between amounts, for example0.0and1000.24.Constraints:
- min:
1- max:
30- pattern:
-?((0|[1-9]\d*)(\.\d+)?)currency -> (string) [required]
The ISO 4217 currency code for the amount (for example,
USD).Constraints:
- min:
3- max:
3- pattern:
[A-Z]{3}balances -> (structure) [required]
How much of
amountis outstanding, processing, settled, and canceled.outstanding -> (structure) [required]
The part of the amount that isn’t settled and has no settlement in progress. For an invoice, this is what remains to pay. For a credit memo, this is the credit that isn’t yet applied. This balance doesn’t include
processing.value -> (string) [required]
The amount, as a decimal string, such as
10.99. The number of decimal places can differ between amounts, for example0.0and1000.24.Constraints:
- min:
1- max:
30- pattern:
-?((0|[1-9]\d*)(\.\d+)?)currency -> (string) [required]
The ISO 4217 currency code for the amount (for example,
USD).Constraints:
- min:
3- max:
3- pattern:
[A-Z]{3}processing -> (structure) [required]
The part of the amount with a settlement in progress, for example a payment that’s submitted but not yet confirmed. It moves to
settledwhen the settlement completes, and back tooutstandingwhen the settlement fails. This balance is more than 0 only when thestatusisPROCESSING.value -> (string) [required]
The amount, as a decimal string, such as
10.99. The number of decimal places can differ between amounts, for example0.0and1000.24.Constraints:
- min:
1- max:
30- pattern:
-?((0|[1-9]\d*)(\.\d+)?)currency -> (string) [required]
The ISO 4217 currency code for the amount (for example,
USD).Constraints:
- min:
3- max:
3- pattern:
[A-Z]{3}settled -> (structure) [required]
The part of the amount that is settled. For an invoice, this is the amount paid or covered by credit memos. For a credit memo, this is the amount applied to invoices. This balance is 0 when nothing is settled yet.
value -> (string) [required]
The amount, as a decimal string, such as
10.99. The number of decimal places can differ between amounts, for example0.0and1000.24.Constraints:
- min:
1- max:
30- pattern:
-?((0|[1-9]\d*)(\.\d+)?)currency -> (string) [required]
The ISO 4217 currency code for the amount (for example,
USD).Constraints:
- min:
3- max:
3- pattern:
[A-Z]{3}canceled -> (structure) [required]
The part of the amount that was canceled and isn’t settled, for example when an invoice is voided. When a partly settled record is canceled, it keeps its
settledbalance, and the rest of the amount moves tocanceled. This balance is more than 0 only when thestatusisCANCELED.value -> (string) [required]
The amount, as a decimal string, such as
10.99. The number of decimal places can differ between amounts, for example0.0and1000.24.Constraints:
- min:
1- max:
30- pattern:
-?((0|[1-9]\d*)(\.\d+)?)currency -> (string) [required]
The ISO 4217 currency code for the amount (for example,
USD).Constraints:
- min:
3- max:
3- pattern:
[A-Z]{3}settlementStatus -> (string) [required]
Whether the record is open or closed. If you receive a
statusvalue that you don’t recognize, use this member to tell open records from closed ones. The following values are valid:
OPEN– Part of the amount is outstanding or processing. ThestatusisOUTSTANDINGorPROCESSING.CLOSED– The whole amount is settled or canceled. ThestatusisSETTLEDorCANCELED.A
CLOSEDrecord becomesOPENagain if a payment or credit applied to it is reversed. ItsclosedAtis then absent until the record closes again.Possible values:
OPENCLOSEDstatus -> (string) [required]
The settlement stage of the record. The following values are valid:
OUTSTANDING– Part of the amount isn’t settled, and no settlement is in progress on the record. For an invoice,dueStatusshows whether it’s due or past due. ThesettlementStatusisOPEN.PROCESSING– A settlement of part or all of the amount is in progress, for example a payment that’s submitted but not yet confirmed.PROCESSINGtakes precedence overOUTSTANDING: while any part of the amount is processing, the status isPROCESSING, even if another part is still outstanding. ThesettlementStatusisOPEN.SETTLED– The whole amount is settled. ThesettlementStatusisCLOSED.CANCELED– The record is canceled. The part of the amount that wasn’t settled isn’t collected or applied. ThesettlementStatusisCLOSED.Possible values:
OUTSTANDINGPROCESSINGSETTLEDCANCELEDissuedAt -> (timestamp) [required]
The date and time, in UTC, when this record was issued.closedAt -> (timestamp)
The date and time, in UTC, when the record was last closed, that is, when itsstatuslast becameSETTLEDorCANCELED. This member is absent while thesettlementStatusisOPEN, including after a closed record reopens.details -> (tagged union structure) [required]
The attributes that exist only for the record’s type. The populated member matches
type:invoiceDetailsfor anINVOICE,creditMemoDetailsfor aCREDIT_MEMO.Note
This is a Tagged Union structure. Only one of the following top level keys can be set:invoiceDetails,creditMemoDetails.invoiceDetails -> (structure)
The details of an invoice. Populated when
typeisINVOICE.invoiceId -> (string) [required]
The invoice ID that Amazon Web Services Invoicing issued for the invoice: the document number printed on it, shown in the Amazon Web Services Billing and Cost Management console and returned by the Amazon Web Services Invoicing API as
InvoiceId.GetFinancialRecordandBatchGetFinancialRecordalso accept it, asinvoiceIdentifier.Constraints:
- min:
1- max:
1024- pattern:
\S(.*\S)?dueStatus -> (string)
Whether the invoice is due or past its due date. This member is present only while the invoice’s
statusisOUTSTANDING. It’s absent when thestatusisPROCESSING,SETTLED, orCANCELED. The following values are valid:
DUE– The due date hasn’t passed.PAST_DUE– The due date has passed, and the invoice is still outstanding.Possible values:
DUEPAST_DUEbillingPeriod -> (structure) [required]
The billing period the invoice covers: the period of the usage it bills.
startDate -> (timestamp) [required]
The first day of the billing period, inclusive, as the timestamp of 00:00:00 UTC on that day.endDate -> (timestamp) [required]
The day after the last day of the billing period, exclusive, as the timestamp of 00:00:00 UTC on that day. A calendar month runs from the first of the month to the first of the next month.dueDate -> (timestamp) [required]
The calendar date by which the invoice must be paid, as the timestamp of 00:00:00 UTC on that day. The invoice is past due from the following day.paymentTerms -> (string)
The payment terms for the invoice, as Amazon Web Services Invoicing issued them, such as
Net30. The due date follows from these terms. This member is absent when Amazon Web Services Invoicing didn’t issue payment terms for the invoice.Constraints:
- min:
1- max:
20- pattern:
[-a-zA-Z0-9]+invoiceFrequency -> (string) [required]
Whether the invoice was issued once or as part of a billing cycle. The following values are valid:
ONE_TIME– A single invoice that isn’t part of a billing cycle.RECURRING– One invoice of a billing cycle, such as your monthly invoice.Possible values:
ONE_TIMERECURRINGcreditMemoDetails -> (structure)
The details of a credit memo. Populated when
typeisCREDIT_MEMO.invoiceId -> (string) [required]
The invoice ID that Amazon Web Services Invoicing issued for the credit memo: the document number printed on it, shown in the Amazon Web Services Billing and Cost Management console and returned by the Amazon Web Services Invoicing API as
InvoiceId.GetFinancialRecordandBatchGetFinancialRecordalso accept it, asinvoiceIdentifier.Constraints:
- min:
1- max:
1024- pattern:
\S(.*\S)?billingPeriod -> (structure) [required]
The billing period the credit memo applies to: the period of the usage it credits.
startDate -> (timestamp) [required]
The first day of the billing period, inclusive, as the timestamp of 00:00:00 UTC on that day.endDate -> (timestamp) [required]
The day after the last day of the billing period, exclusive, as the timestamp of 00:00:00 UTC on that day. A calendar month runs from the first of the month to the first of the next month.
errors -> (list)
The errors for the records that the operation couldn’t retrieve, one for each record, with the key as you requested it and the reason. This list is empty when the operation retrieved every record.
(structure)
The reason that one of the records requested from
BatchGetFinancialRecordcouldn’t be returned. The other records in the request are unaffected.key -> (tagged union structure) [required]
The key of the record that couldn’t be retrieved, as you requested it.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:identifier,invoiceIdentifier.identifier -> (string)
The ID that Amazon Web Services Payments issued for the record.
Constraints:
- min:
17- max:
23- pattern:
[A-Z]{2,3}-[0-9]{4}-[0-9]{4}-[0-9]{4}(-[0-9]{4})?invoiceIdentifier -> (string)
The invoice ID that Amazon Web Services Invoicing issued for an invoice or a credit memo.
Constraints:
- min:
1- max:
1024- pattern:
\S(.*\S)?code -> (string) [required]
The error code that indicates why the retrieval failed. The following values are valid:
NOT_FOUND– No financial record on your account matches the key.INTERNAL_ERROR– An internal error occurred while processing this record. The other records in the request are unaffected. You can retry this record.Possible values:
NOT_FOUNDINTERNAL_ERRORmessage -> (string) [required]
A description of why the operation couldn’t retrieve this record. The wording can change at any time and isn’t localized, so don’t parse this value. To handle the error in your code, usecodeinstead.