Commerce

Read posted Business Central payment history for an assessment

GET
/v1/commerce/payments/history

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.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

An organization API key. Its scopes decide what it may call; decision:shadow is the narrowest: SHADOW evaluations through POST /v1/authority/grants or its alias POST /v1/authority/enforce-and-bind only (DECISION_SHADOW_MODE_DENIED in any other mode; DECISION_SHADOW_FIELD_DENIED for a body carrying context.decionis_policy, evidence or escalation), with no integration dispatch. A key whose only scope is decision:shadow (an AgentSafe hosted gateway's) reaches exactly those two, POST /v1/auth/credential-context, POST /v1/hosted-gateway/keys/confirm and POST /v1/hosted-gateway/keys/revoke-self; every other route answers 403 HOSTED_GATEWAY_KEY_PATH_DENIED. decision:enforce is an enforced hosted gateway's key: evaluations in SHADOW or ENFORCEMENT through POST /v1/authority/grants or its alias (400 DECISION_ENFORCE_FIELD_DENIED for a body carrying context.decionis_policy; it never holds policy:write), and the grants and managed escalations they bind. A key whose scopes are decision:enforce (with or without decision:shadow) reaches exactly POST /v1/authority/enforce-and-bind, POST /v1/authority/grants, GET /v1/authority/grants/{grant_id}, POST /v1/authority/grants/{grant_id}/claims, POST /v1/authority/grants/{grant_id}/receipts, POST /v1/authority/grants/{grant_id}/reconciliations, POST /v1/execution/verify-token, POST /v1/execution/claim-token, POST /v1/execution/consume-token, POST /v1/execution/finalize-token, GET /v1/authority/escalations/{escalation_id}, DELETE /v1/authority/escalations/{escalation_id}, POST /v1/auth/credential-context, POST /v1/hosted-gateway/keys/confirm and POST /v1/hosted-gateway/keys/revoke-self, each id a UUID; every other route answers 403 HOSTED_GATEWAY_KEY_PATH_DENIED.

In: header

Query Parameters

connection_id*string
Formatuuid
revision*integer

The connection revision the caller expects.

Range1 <= value
from*string
Formatdate
to*string

Exclusive.

Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/commerce/payments/history?connection_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&revision=1&from=2019-08-24&to=2019-08-24"
{  "version": "commerce-payment-history-v1",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",  "connection_revision": 1,  "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",  "observed_at": "2019-08-24T14:15:22Z",  "window": {    "from": "string",    "to": "string"  },  "payments": [    {      "payment_digest": "string",      "vendor_digest": "string",      "document_digest": "string",      "posting_date": "string",      "currency": "string",      "scale": 0,      "amount_minor": 0,      "recipient_account_digest": "string"    }  ],  "invoices": [    {      "invoice_digest": "string",      "vendor_digest": "string",      "external_document_digest": "string",      "posting_date": "string",      "due_date": "string",      "currency": "string",      "scale": 0,      "amount_minor": 0,      "discount_date": "string",      "discount_possible_minor": 0,      "discount_taken_minor": 0,      "closed_at": "string"    }  ],  "applications": [    {      "payment_digest": "string",      "invoice_digest": "string",      "applied_on": "string",      "amount_minor": 0    }  ],  "bank_changes": {    "available": true,    "reason": "CHANGE_LOG_DISABLED",    "logged_from": "2019-08-24T14:15:22Z",    "entries": [      {        "vendor_digest": "string",        "account_digest": "string",        "changed_at": "2019-08-24T14:15:22Z",        "change": "INSERTED"      }    ]  },  "coverage": {    "complete": true,    "truncated": true,    "reasons": [      "string"    ]  },  "execution_available": false}