results

List retained results, V1 and V2 together

A page of the organisation's retained results, newest first: validations and generations made through V1 and validations made through V2, each saying which API made it (api_version), the schema of its retained document (result_schema) and its family. total counts every matching record, expired and deleted ones included; names are hidden after expiry or deletion and cannot match q. Pass next_cursor as cursor for the next page.

V1's own result list shows only V1 results: a V2 result is not a document its schema describes.

get/v2/einvoices/results

Request

  • Base URL: https://api.ironfang.com/finance
  • URL: https://api.ironfang.com/finance/v2/einvoices/results
  • Auth: HTTP bearer

Query parameters

cursorstring
limitinteger
kind'validate' | 'generate'
outcome'valid' | 'invalid'
family'peppol-bis-billing-3' | 'xrechnung' | 'zugferd-facturx'

An invoice family. zugferd-facturx is one family: ZUGFeRD and Factur-X are corresponding release names of the same standard.

api_version'v1' | 'v2'

The API a result was made through.

rulesetstring
qstring

Case-insensitive literal substring of the operation id or an available document name.

operation_idstring

Response

The page. Cache-Control is no-store.

next_cursorstring
retention_days30 required
schema'ironfang/finance/einvoice/result-list/v2' required
totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.