Get settlement

Example Request

curl -X GET \
  -H 'authorization: Bearer v4.public.eyJpc3MiOiJs...' \
  https://api.sandbox.ledyer.com/v1/settlements/:settlementId \

Path parameters

settlementId

The settlement ID

Example Response

{
  "captureDateMax": "2024-01-16T00:00:00Z",
  "captureDateMin": "2023-12-18T00:00:00Z",
  "creditAmount": {
    "amount": "-1198.00",
    "currency": "SEK",
    "formatted": "-1,198.00",
    "formattedWithCurrency": "-SEK 1,198.00",
    "minorUnits": -119800
  },
  "creditVatAmount": {
    "amount": "-239.60",
    "currency": "SEK",
    "formatted": "-239.60",
    "formattedWithCurrency": "-SEK 239.60",
    "minorUnits": -23960
  },
  "creditVatBreakdown": [
    {
      "vat": 600,
      "amount": {
        "amount": "-33.79",
        "currency": "SEK",
        "formatted": "-33.79",
        "formattedWithCurrency": "-SEK 33.79",
        "minorUnits": -3379
      }
    },
    {
      "vat": 1200,
      "amount": {
        "amount": "-28.29",
        "currency": "SEK",
        "formatted": "-28.29",
        "formattedWithCurrency": "-SEK 28.29",
        "minorUnits": -2829
      }
    },
    {
      "vat": 2500,
      "amount": {
        "amount": "-359.40",
        "currency": "SEK",
        "formatted": "-359.40",
        "formattedWithCurrency": "-SEK 359.40",
        "minorUnits": -35940
      }
    }
  ],
  "currency": "SEK",
  "feeVatAmount": {
    "amount": "7.46",
    "currency": "SEK",
    "formatted": "7.46",
    "formattedWithCurrency": "SEK 7.46",
    "minorUnits": 746
  },
  "id": "sl_2b2GlS47knY4x66fCRXuAf2zCbm",
  "invoiceServicePayoutAmount": {
    "amount": "4871.25",
    "currency": "SEK",
    "formatted": "4,871.25",
    "formattedWithCurrency": "SEK 4,871.25",
    "minorUnits": 487125
  },
  "merchantId": "ac_1xWqkkS5aIbxCJsoseRhSd0OJyD",
  "netAmount": {
    "amount": "6031.94",
    "currency": "SEK",
    "formatted": "6,031.94",
    "formattedWithCurrency": "SEK 6,031.94",
    "minorUnits": 603194
  },
  "noOfCredits": 1,
  "noOfInvoiceServicePayouts": 3,
  "noOfPurchaseFixedFee": 3,
  "noOfPurchaseVariableFee": 0,
  "noOfReversals": 0,
  "noOfSales": 5,
  "payoutAmount": {
    "amount": "6031.94",
    "currency": "SEK",
    "formatted": "6,031.94",
    "formattedWithCurrency": "SEK 6,031.94",
    "minorUnits": 603194
  },
  "payoutDate": "2024-01-16T00:00:00Z",
  "purchaseFixedFeeAmount": {
    "amount": "29.85",
    "currency": "SEK",
    "formatted": "29.85",
    "formattedWithCurrency": "SEK 29.85",
    "minorUnits": 2985
  },
  "purchaseVariableFeeAmount": {
    "amount": "0.00",
    "currency": "SEK",
    "formatted": "0.00",
    "formattedWithCurrency": "SEK 0.00",
    "minorUnits": 0
  },
  "reference": "370751",
  "reversalAmount": {
    "amount": "0.00",
    "currency": "SEK",
    "formatted": "0.00",
    "formattedWithCurrency": "SEK 0.00",
    "minorUnits": 0
  },
  "reversalVatAmount": {
    "amount": "0.00",
    "currency": "SEK",
    "formatted": "0.00",
    "formattedWithCurrency": "SEK 0.00",
    "minorUnits": 0
  },
  "reversalVatBreakdown": [],
  "saleAmount": {
    "amount": "7267.25",
    "currency": "SEK",
    "formatted": "7,267.25",
    "formattedWithCurrency": "SEK 7,267.25",
    "minorUnits": 726725
  },
  "saleVatAmount": {
    "amount": "1453.45",
    "currency": "SEK",
    "formatted": "1,453.45",
    "formattedWithCurrency": "SEK 1,453.45",
    "minorUnits": 145345
  },
  "saleVatBreakdown": [
    {
      "vat": 600,
      "amount": {
        "amount": "67.59",
        "currency": "SEK",
        "formatted": "67.59",
        "formattedWithCurrency": "SEK 67.59",
        "minorUnits": 6759
      }
    },
    {
      "vat": 1200,
      "amount": {
        "amount": "56.58",
        "currency": "SEK",
        "formatted": "56.58",
        "formattedWithCurrency": "SEK 56.58",
        "minorUnits": 5658
      }
    },
    {
      "vat": 2500,
      "amount": {
        "amount": "958.40",
        "currency": "SEK",
        "formatted": "958.40",
        "formattedWithCurrency": "SEK 958.40",
        "minorUnits": 95840
      }
    }
  ],
  "storeId": "681575494",
  "subtotalAmount": {
    "amount": "6069.25",
    "currency": "SEK",
    "formatted": "6,069.25",
    "formattedWithCurrency": "SEK 6,069.25",
    "minorUnits": 606925
  },
  "subtotalVatAmount": {
    "amount": "1213.85",
    "currency": "SEK",
    "formatted": "1,213.85",
    "formattedWithCurrency": "SEK 1,213.85",
    "minorUnits": 121385
  },
  "totalCostsAmount": {
    "amount": "37.31",
    "currency": "SEK",
    "formatted": "37.31",
    "formattedWithCurrency": "SEK 37.31",
    "minorUnits": 3731
  },
  "totalOtherChargeAmount": {
    "amount": "0.00",
    "currency": "SEK",
    "formatted": "0.00",
    "formattedWithCurrency": "SEK 0.00",
    "minorUnits": 0
  },
  "urls": {
    "pdf": "https://report.sandbox.ledyer.com/settlement...",
    "csv": "https://report.sandbox.ledyer.com/settlement..."
  }
}

captureDateMax

string

The last capture date in the settlement. ISO 8601 format, ex: 2011-10-05T14:48:00.000Z.

captureDateMin

string

The first capture date in the settlement. ISO 8601 format, ex: 2011-10-05T14:48:00.000Z.

creditAmount

object

The total credit amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

creditVatAmount

object

The total credit vat amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

creditVatBreakdown

array of objects

A list of credit VAT amount breakdown objects. Each object contains:

• vat: The VAT rate as minor units (e.g., 600 for 6%, 2500 for 25%)
• amount: An object with properties:
  • amount: The VAT amount as a string
  • currency: The currency code
  • formatted: The formatted amount without currency
  • formattedWithCurrency: The formatted amount with currency
  • minorUnits: The amount in minor units (e.g., cents) as an integer

currency

string

The settlement currency.

feeVatAmount

object

The fee vat amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

id

string

A unique identifier for the settlement.

invoiceServicePayoutAmount

object

The invoice service payout amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

merchantId

string

A unique identifier for the merchant.

netAmount

object

The net amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

noOfCredits

integer

The number of credit transactions in the settlement.

noOfInvoiceServicePayouts

integer

The number of invoice service payout transactions in the settlement.

noOfPurchaseFixedFee

integer

The number of purchase transactions with fixed fee in the settlement.

noOfPurchaseVariableFee

integer

The number of purchase transactions with variable fee in the settlement.

noOfReversals

integer

The number of reversal transactions in the settlement.

noOfSales

integer

The number of sale transactions in the settlement.

payoutAmount

object

The payout amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

payoutDate

string

The settlement payout date. ISO 8601 format, ex: 2011-10-05T14:48:00.000Z.

purchaseFixedFeeAmount

object

The purchase fixed fee amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

purchaseVariableFeeAmount

object

The purchase variable fee amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

reference

string

The settlement reference.

reversalAmount

object

The total reversal amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

reversalVatAmount

object

The total reversal vat amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

reversalVatBreakdown

array of objects

A list of reversal VAT amount breakdown objects. Each object contains:

• vat: The VAT rate as minor units (e.g., 600 for 6%, 2500 for 25%)
• amount: An object with properties:
  • amount: The VAT amount as a string
  • currency: The currency code
  • formatted: The formatted amount without currency
  • formattedWithCurrency: The formatted amount with currency
  • minorUnits: The amount in minor units (e.g., cents) as an integer

saleVatAmount

object

The total sale vat amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

saleVatBreakdown

array of objects

A list of sale VAT amount breakdown objects. Each object contains:

• vat: The VAT rate as minor units (e.g., 600 for 6%, 2500 for 25%)
• amount: An object with properties:
  • amount: The VAT amount as a string
  • currency: The currency code
  • formatted: The formatted amount without currency
  • formattedWithCurrency: The formatted amount with currency
  • minorUnits: The amount in minor units (e.g., cents) as an integer

storeId

stringOptional

A unique identifier for the particular store where the settlement was created.

subtotalAmount

object

The subtotal amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

subtotalVatAmount

object

The vat amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

totalCostsAmount

object

The total costs amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

totalOtherChargeAmount

object

The total other charge amount for this settlement. An object containing strings amount, currency, formatted, formattedWithCurrency and integer minorUnits.

urls

object

An object consisting of the properties pdf and csv. Each property contains an URL to the corresponding settlement file.