Documentation updates

As part of an ongoing effort to better align the documentation with the API, we’ve updated several API references. These changes affect the documentation only. The API itself hasn’t changed.

GET /Query/invoices/ endpoint

We’ve updated response schema and examples.

  • Added missing fields to the schema:
    • ParentOrgId
    • pageIdentifier
  • Reordered the fields in the example and schema to accurately reflect what’s returned by the API.

GET /Invoice/{idInvoice} endpoint

We’ve updated response schema and examples.

  • Reordered the fields in the example and schema to accurately reflect what’s returned by the API.
  • Updated field casing to accurately reflect what’s returned by the API:
    • customerCustomer
    • paypointLegalnamePaypointLegalname
    • paypointDbanamePaypointDbaname
    • paypointEntrynamePaypointEntryname
    • parentOrgNameParentOrgName
    • documentsRefDocumentsRef

New discount field for payouts

We’ve added a new discount field to the /MoneyOut/authorize endpoint in the API. This field represents any vendor discounts applied to the payout. This field is optional, and is returned in payout transaction detail and query responses.