Finance

Reconciliation

1 endpoints · https://pos.pages.fm/api/v1

View Markdown

List of reconciliation sessions

GET/shops/{SHOP_ID}/reconciliations

Get list of reconciliation sessions. Each session includes its orders in the orders array

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Query parameters

pageinteger

Page number

Default: 1 · Example: 1
page_sizeinteger

Page size. Default 10, maximum 50 (larger values are clamped to 50)

Default: 10 · Example: 10
sort_bystring

Sort by updated_at ascending (then system_id) for incremental sync. If omitted, sessions are sorted by creation time descending

Values"updated_at"
Example: "updated_at"
startDateUpdatedAtinteger · int64

Only sessions with updated_at >= this time (unix timestamp in seconds). Can be sent alone without endDateUpdatedAt

Example: 1758182400
endDateUpdatedAtinteger · int64

Only sessions with updated_at <= this time (unix timestamp in seconds)

Example: 1758268800
include_removedboolean

Include removed sessions (is_removed: true). Send true to enable

Default: false · Example: true
system_id[]array<integer>

Filter by internal session ID. Also accepts a single value as system_id=123

display_idinteger

Filter by session code shown on the shop

Example: 92
searchstring

Search by display_id or custom_id of the session. Multiple codes can be separated by space or comma; matches any of them

Example: "92 94"
partner_id[]array<string>

Shipping partner ID on Pancake system (see Partner list). Also accepts a single value as partner_id=1

creator_idstring · uuid

Filter by creator user ID

Example: "d6e6a545-f102-439e-9943-8ac8369f9735"
order_idinteger

Only sessions containing this order (internal order ID, system_id of the order)

Example: 1418
startDateinteger · int64

Start of the session creation time range (unix timestamp in seconds). Applied only when both startDate and endDate are sent

Example: 1756684800
endDateinteger · int64

End of the session creation time range (unix timestamp in seconds)

Example: 1759276800
startDatePaidAtinteger · int64

Start of the payment time range (unix timestamp in seconds). Applied only when both startDatePaidAt and endDatePaidAt are sent; sessions without paid_at are excluded

Example: 1756684800
endDatePaidAtinteger · int64

End of the payment time range (unix timestamp in seconds)

Example: 1759276800

Responses

object
successboolean

Success status

dataarray<Reconciliation>

List of reconciliation sessions

page_numberinteger

Page number

page_sizeinteger

Page size

total_entriesinteger

Total entries

total_pagesinteger

Total pages

Request
curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/reconciliations?api_key=API_KEY"
Response 200
{
  "success": true,
  "page_number": 1,
  "page_size": 10,
  "total_entries": 1,
  "total_pages": 1,
  "data": [
    {
      "system_id": 123,
      "display_id": 92,
      "custom_id": "7358901234567890123",
      "partner_id": "1",
      "control_type": "control_cod",
      "note": "Đối soát COD tuần 38",
      "excel_cod": 1250000,
      "excel_fee": 65000,
      "pos_cod": 1250000,
      "paid_at": "2026-09-18T08:06:55",
      "payment_status": "paid",
      "creator": {
        "id": "d6e6a545-f102-439e-9943-8ac8369f9735",
        "name": "vudzung12"
      },
      "updater": {
        "id": "d6e6a545-f102-439e-9943-8ac8369f9735",
        "name": "vudzung12"
      },
      "inserted_at": "2026-09-17T03:12:40.512345",
      "updated_at": "2026-09-18T08:06:55.000000",
      "is_removed": false,
      "orders": [
        {
          "order_id": 1418,
          "display_id": 1418,
          "custom_id": null,
          "extend_code": "S58824.MB25.C3.500020713",
          "order_number_vtp": null,
          "order_status": 4,
          "result": "succeed",
          "message": null,
          "cod_amount": 750000,
          "partner_fee": 35000,
          "pos_cod": 750000,
          "currency": "VND",
          "reconciliation_at": "2026-09-17T03:12:40"
        },
        {
          "order_id": 1419,
          "display_id": 1419,
          "custom_id": null,
          "extend_code": "S58824.MB25.C3.500020714",
          "order_number_vtp": null,
          "order_status": 4,
          "result": "mismatch",
          "message": null,
          "cod_amount": 500000,
          "partner_fee": 30000,
          "pos_cod": 520000,
          "currency": "VND",
          "reconciliation_at": "2026-09-17T03:12:40"
        }
      ]
    }
  ]
}