Skip to content

Latest commit

 

History

History
118 lines (79 loc) · 8.78 KB

README.md

File metadata and controls

118 lines (79 loc) · 8.78 KB

Statements

Overview

Available Operations

  • list - Retrieve all statements associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

  • get - Retrieve a statement by its ID.

Use the Accept header to specify the format of the response. Supported formats are application/json and application/pdf.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

list

Retrieve all statements associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    x_moov_version="v2024.01.00",
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.statements.list(account_id="b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f", skip=60, count=20)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
account_id str ✔️ N/A
billing_period_start_date_time date ➖ Optional date-time which inclusively filters all statements where billing period is on or after this date-time.
billing_period_end_date_time date ➖ Optional date-time which exclusively filters all statements where billing period is before this date-time.
skip Optional[int] ➖ N/A 60
count Optional[int] ➖ N/A 20
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListStatementsResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400 application/json
errors.APIError 4XX, 5XX */*

get

Retrieve a statement by its ID.

Use the Accept header to specify the format of the response. Supported formats are application/json and application/pdf.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    x_moov_version="v2024.01.00",
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.statements.get(account_id="5623ff52-0b05-41ea-b7b3-655835064007", statement_id="9d45acbf-c4fe-4843-846c-eaa43c9ca17f")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
statement_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetStatementResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*