Skip to content

Latest commit

 

History

History
112 lines (75 loc) · 4.85 KB

README.md

File metadata and controls

112 lines (75 loc) · 4.85 KB

Receipts

(receipts)

Overview

Available Operations

  • create - Create receipts for transfers and scheduled transfers.

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

  • list - List receipts by trasnferID, scheduleID, or occurrenceID.

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

create

Create receipts for transfers and scheduled transfers.

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

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.receipts.create(request=[
        {
            "kind": components.ReceiptKind.SALE_CUSTOMER_V1,
            "email": "[email protected]",
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request List[components.ReceiptRequest] ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateReceiptsResponse

Errors

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

list

List receipts by trasnferID, scheduleID, or occurrenceID.

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

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.receipts.list()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id Optional[str] ➖ The unique identifier to filter receipts by.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListReceiptsResponse

Errors

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