List Detailed Settlement Reports

Use this request to return a list of Detailed Settlement reports.

To retrieve a list of the Detailed Settlement reports for a specified time period, use a GET method and the following URL:

{service_uri}/api/v2/reports/object-storage?report_type=settlement-detailed&month_from={month_from}&month_to={month_to}&status={status}&limit={limit}&offset={offset}

where:

{service_uri} is the service's URI.
{month_from} is the first month.
{month_to} is the final month.
{status} is the status of Done, Processing or Error.
{limit} the maximum number of reports that will be retrieved.
{offset} specifies an offset value that can be used for things like pagination.

For example:

https://{service_uri}/api/v2/reports/object-storage/TH.2024-09-01.2024-09-01.gtimAqA9kS6nEXT3uMP2hj0hOI0Kn0pbuUNWZef720o.1725889941743.csv?report_type=settlement-detailed",

Details

Detail	Value
Endpoint	`/api/v2/reports/object-storage/`
Method	GET

Query Parameters

Parameter	Description
`report_type`	This is always `settlement-detailed`.
`month_from`	The first month in the selection in the `yyyy-MM` format.
`month_to`	The last month in the selection in the yyyy-MM format.
`status`	This can be Done, Processing or Error.
`limit`	The number of reports that will be retrieved. This can be any number up to 1000.
`offset`	This value specifies the point where the report will begin. For example, if there are 11 reports and the offset is 10, the report will begin on the 10th report.

Example Response

{
    "merchant_id": 12345,
    "reports": [
        {
            "creation_time": "2024-07-19T09:34:25.044Z",
            "status_description": "The report is ready.",
            "reporting_period": "2024-07",
            "tax_region": "US",
            "report_id": "US.2024-07-01.2024-07-01.123456789123456789.csv",
            "report_start_date": "2024-07-01",
            "status": "done",
            "url": "https://dashboard.taxamo.com/api/v1/reports/object-storage/US.2024-07-01.2024-07-01.01.123456789123456789.csv?report_type=settlement-detailed",
            "creation_timestamp": "1721381665044",
            "report_end_date": "2024-07-01"
        },
        {
            "creation_time": "2024-07-19T09:34:12.165Z",
            "status_description": "The report is ready.",
            "reporting_period": "2024-07",
            "tax_region": "US",
            "report_id": "US.2024-07-01.2024-07-01.123456789.csv",
            "report_start_date": "2024-07-01",
            "status": "done",
            "url": "https://dashboard.taxamo.com/api/v1/reports/object-storage/US.2024-07-01.2024-07-01.123456789.csv?report_type=settlement-detailed",
            "creation_timestamp": "1721381652165",
            "report_end_date": "2024-07-01"
        }
      ]
}

Post Processing

This request will return a list of reports. You can use the Download Link for Detailed Settlement Report request to retrieve a link from which you can download the report.

Updated about 1 month ago