[ aws . payments ]

list-financial-records

Description

Lists the financial records on your account, with the newest first by default. A financial record is an invoice or a credit memo. You must specify at least one record type in types . You can narrow the results further by settlement status and issue date. This operation returns summaries. To get the details that are specific to a record’s type, use GetFinancialRecord or BatchGetFinancialRecord . Results are paginated. Use nextToken to retrieve more results.

To use this operation, you must have Amazon Web Services Identity and Access Management (IAM) permission for both payments:ListFinancialRecords and payments:GetPaymentStatus .

See also: AWS API Documentation

list-financial-records is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: financialRecordSummaries

Synopsis

  list-financial-records
--types <value>
[--settlement-statuses <value>]
[--issued-after <value>]
[--issued-before <value>]
[--sort-by <value>]
[--sort-order <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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]

Options

--types (list) [required]

The financial record types to return. 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.

Constraints:

  • min: 1
  • max: 20

(string)

Possible values:

  • INVOICE
  • CREDIT_MEMO

Syntax:

"string" "string" ...

--settlement-statuses (list)

The settlement statuses to filter by. OPEN returns records whose status is OUTSTANDING or PROCESSING . CLOSED returns records whose status is SETTLED or CANCELED . When you omit this member, the operation returns records with both settlement statuses.

Constraints:

  • min: 1
  • max: 2

(string)

Possible values:

  • OPEN
  • CLOSED

Syntax:

"string" "string" ...

--issued-after (timestamp)

The earliest date and time to return records for, inclusive. The operation returns the records that were issued at or after this time.

--issued-before (timestamp)

The latest date and time to return records for, exclusive. The operation returns the records that were issued before this time. When you specify both issuedAfter and issuedBefore , issuedBefore must be later than issuedAfter .

--sort-by (string)

The field to sort the results by. The default is ISSUED_AT , the date and time when the record was issued.

Possible values:

  • ISSUED_AT

--sort-order (string)

The order to sort the results in. The default is DESCENDING , which returns the newest records first. ASCENDING returns the oldest records first.

Possible values:

  • ASCENDING
  • DESCENDING

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

Global Options

--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.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--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.

  • on
  • off
  • auto

--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.

  • base64
  • raw-in-base64-out

--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.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

financialRecordSummaries -> (list)

The financial record summaries that match your filters, in the requested order. This list is empty when no record matches.

(structure)

A financial record as ListFinancialRecords returns it, without the details that are specific to its type. To get the full record, use GetFinancialRecord or BatchGetFinancialRecord .

id -> (string) [required]

The ID that Amazon Web Services Payments issued for the record. To retrieve the full record, pass this value to GetFinancialRecord or BatchGetFinancialRecord as identifier .

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. On the full record, the populated member of details matches 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:

  • INVOICE
  • CREDIT_MEMO

businessUnit -> (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. or Amazon 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: 256

lineOfBusiness -> (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_SERVICES
  • PROSERVE_MARKETING_AND_TRAINING
  • AWS_MARKETPLACE

amount -> (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. balances shows 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 example 0.0 and 1000.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 amount is 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 example 0.0 and 1000.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 settled when the settlement completes, and back to outstanding when the settlement fails. This balance is more than 0 only when the status is PROCESSING .

value -> (string) [required]

The amount, as a decimal string, such as 10.99 . The number of decimal places can differ between amounts, for example 0.0 and 1000.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 example 0.0 and 1000.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 settled balance, and the rest of the amount moves to canceled . This balance is more than 0 only when the status is CANCELED .

value -> (string) [required]

The amount, as a decimal string, such as 10.99 . The number of decimal places can differ between amounts, for example 0.0 and 1000.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 status value 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. The status is OUTSTANDING or PROCESSING .
  • CLOSED – The whole amount is settled or canceled. The status is SETTLED or CANCELED .

A CLOSED record becomes OPEN again if a payment or credit applied to it is reversed. Its closedAt is then absent until the record closes again.

Possible values:

  • OPEN
  • CLOSED

status -> (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, dueStatus shows whether it’s due or past due. The settlementStatus is OPEN .
  • PROCESSING – A settlement of part or all of the amount is in progress, for example a payment that’s submitted but not yet confirmed. PROCESSING takes precedence over OUTSTANDING : while any part of the amount is processing, the status is PROCESSING , even if another part is still outstanding. The settlementStatus is OPEN .
  • SETTLED – The whole amount is settled. The settlementStatus is CLOSED .
  • CANCELED – The record is canceled. The part of the amount that wasn’t settled isn’t collected or applied. The settlementStatus is CLOSED .

Possible values:

  • OUTSTANDING
  • PROCESSING
  • SETTLED
  • CANCELED

issuedAt -> (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 its status last became SETTLED or CANCELED . This member is absent while the settlementStatus is OPEN , including after a closed record reopens.

nextToken -> (string)

The pagination token that indicates the next set of results to retrieve. This value is absent when there are no more results.

Constraints:

  • min: 1
  • max: 2048