---
title: "Read posted Business Central payment history for an assessment"
method: GET
path: "/v1/commerce/payments/history"
---

# Read posted Business Central payment history for an assessment

`GET /v1/commerce/payments/history`

## Request

- Base URL: `https://api.decionis.com`
- URL: `https://api.decionis.com/v1/commerce/payments/history`
- Auth: HTTP bearer

Default off with the native Business Central reader. Ordinary workspace key with decision:read and decision:write and current native READ authority. Reads the fixed read-only pages for posted vendor payments, vendor invoices and their applications, and the Change Log's vendor bank-account entries, for a window of at most 92 days. Identifiers are company-scoped SHA-256 digests; bank numbers and business identifiers never leave Core. When the Change Log is off or does not log vendor bank accounts, bank_changes.available is false and coverage is incomplete; no change history is inferred. Nothing is written.

## Query parameters

- `connection_id` string, uuid, required
- `revision` integer, required
- `from` string, date, required
- `to` string, date, required

## Response `200`

Posted history and its coverage.

- CommercePaymentHistory
  - `version` 'commerce-payment-history-v1', required
  - `org_id` string, uuid, required
  - `connection_id` string, uuid, required
  - `connection_revision` integer, required
  - `company_id` string, uuid, required
  - `observed_at` string, date-time, required
  - `window` object, required
    - `from` string, required
    - `to` string, required
  - `payments` object[], required
    - `payment_digest` string, required
    - `vendor_digest` string, required
    - `document_digest` string, required
    - `posting_date` string, required
    - `currency` string, required
    - `scale` integer, required
    - `amount_minor` integer, required
    - `recipient_account_digest` string, nullable, required
  - `invoices` object[], required
    - `invoice_digest` string, required
    - `vendor_digest` string, required
    - `external_document_digest` string, nullable, required
    - `posting_date` string, required
    - `due_date` string, nullable, required
    - `currency` string, required
    - `scale` integer, required
    - `amount_minor` integer, required
    - `discount_date` string, nullable, required
    - `discount_possible_minor` integer, required
    - `discount_taken_minor` integer, required
    - `closed_at` string, nullable, required
  - `applications` object[], required
    - `payment_digest` string, required
    - `invoice_digest` string, required
    - `applied_on` string, required
    - `amount_minor` integer, required
  - `bank_changes` object, required
    - `available` boolean, required
    - `reason` 'CHANGE_LOG_DISABLED' | 'VENDOR_BANK_ACCOUNTS_NOT_LOGGED' | 'CHANGE_LOG_UNREADABLE', nullable, required
    - `logged_from` string, date-time, nullable, required
    - `entries` object[], required
      - `vendor_digest` string, required
      - `account_digest` string, required
      - `changed_at` string, date-time, required
      - `change` 'INSERTED' | 'MODIFIED', required
  - `coverage` object, required
    - `complete` boolean, required
    - `truncated` boolean, required
    - `reasons` string[], required
  - `execution_available` false, required

## Other responses

- `400`: Structured API error
- `403`: Structured API error
- `404`: Structured API error
- `409`: Structured API error
- `503`: Structured API error

---

[API](https://skmtc.dev/decionis/apis/decionis-policy-evaluation-api.md) · [All operations](https://skmtc.dev/decionis/apis/decionis-policy-evaluation-api/llms.txt) · [OpenAPI document](https://skmtc.dev/decionis/apis/decionis-policy-evaluation-api/revisions/357f5e459d0c?raw)