Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
settlements.configuration

aid_settlement_report_config_create

Create settlement report configurations

scopes:

  • admin:billing
  • admin:reports
  • admin:settlements
  • write:settlements
post/accounts/{aid}/settlements/reports/configuration

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Request body

send_everynumber

Deprecated report configuration is not used for controlling when to create and send report

Value in milliseconds describing how often reports should be sent.

filetypesstring[] required

The filetypes that should be sent

providersstring[] required

List of providers to send report for. If empty, send for all.

idstring
last_send_atnumber

Deprecated report configuration is not used for controlling when to create and send report

Value in milliseconds (Unix epoch) describing when last time reports was sent.

last_modified_atnumber

Deprecated report configuration is not used for controlling when to create and send report

Value in milliseconds (Unix epoch) describing when last time reports was modified.

created_atstring date-time

The date-time when the resource was created

updated_atstring date-time

The date-time when the resource was last updated

account_idstring

Example request

{
  "send_every": 86400000
}

Response

Settlement report configuration

send_everynumber

Deprecated report configuration is not used for controlling when to create and send report

Value in milliseconds describing how often reports should be sent.

filetypesstring[] required

The filetypes that should be sent

providersstring[] required

List of providers to send report for. If empty, send for all.

idstring
last_send_atnumber

Deprecated report configuration is not used for controlling when to create and send report

Value in milliseconds (Unix epoch) describing when last time reports was sent.

last_modified_atnumber

Deprecated report configuration is not used for controlling when to create and send report

Value in milliseconds (Unix epoch) describing when last time reports was modified.

created_atstring date-time

The date-time when the resource was created

updated_atstring date-time

The date-time when the resource was last updated

account_idstring

Example response

{
  "send_every": 86400000
}