Core APISettlementReports

Get Adyen settlement report list

gethttps://core-api.ancon.io/api/v1/Outlets/{outletId}/SettlementReports
View .mdOpenAPI

Filtering

Filter the list with filter[field]=operator:value; see how filtering works.

Show all 10 filter fields
  • reporttype (enum)
  • reportdate (datetime)
  • startdate (datetime)
  • enddate (datetime)
  • batchno (string)
  • sum (decimal)
  • sumincludingfee (decimal)
  • transactionfee (decimal)
  • otherfees (decimal)
  • total (decimal)

Try filters

Build a filter for this endpoint and copy the request. How filtering works

Filters

Documented filter fields

Reads asNo filters: the endpoint returns everything (paged).

Request
(no filters)

No sample data for this endpoint; the request above is what you would send.

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • outletIdstring (uuid)required

Query parameters

  • Offsetinteger (int32)

    Offset the result, defaults to 0

  • Limitinteger (int32)

    Limits how many items to get, defaults to 100 min 0, max 1000.

  • Orderstring

    Order the result.

  • Searchstring
  • Filtermap<string, array<string>>

    Filter the result. Filter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00

Filter takes filter[field]=operator:value on 10 fields. Build a filter

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • itemsarray<object> | null
    15 fields in items
    • idstring (uuid)
    • reportTypeinteger (int32)

      Allowed values: 1, 2.

    • integrationIdstring (uuid) | null
    • outletIdstring (uuid)
    • reportDatestring (date-time)
    • batchNostring | null
    • dateRangeobject | null
      2 fields in dateRange
      • startDatestring (date-time)
      • endDatestring (date-time)
    • voucherNumbersarray<string> | null
    • sumobject | null
      2 fields in sum
      • amountnumber (double)
      • currencystring | null
    • sumIncludingFeeobject | null
      2 fields in sumIncludingFee
      • amountnumber (double)
      • currencystring | null
    • transactionFeeobject | null
      2 fields in transactionFee
      • amountnumber (double)
      • currencystring | null
    • otherFeesobject | null
      2 fields in otherFees
      • amountnumber (double)
      • currencystring | null
    • invoiceDeductionsobject | null
      2 fields in invoiceDeductions
      • amountnumber (double)
      • currencystring | null
    • balancetransfersobject | null
      2 fields in balancetransfers
      • amountnumber (double)
      • currencystring | null
    • totalobject | null
      2 fields in total
      • amountnumber (double)
      • currencystring | null
  • metaobject | null
    2 fields in meta
    • countinteger (int32)
    • offsetinteger (int32)
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)