Australia Post · Schema

SettlementReport

Address ValidationClick and CollectDeliveryE-CommerceLabelsLocationLogisticsParcel LockerPostalPostageShippingTrackingAustralia

Properties

Name Type Description
Settlement object
View JSON Schema on GitHub

JSON Schema

australia-post-settlement-report-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/australia-post/main/json-schema/australia-post-settlement-report-schema.json",
  "title": "SettlementReport",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/australia-post-agency-data-delivery-openapi.yml#/components/schemas/SettlementReport",
  "type": "object",
  "properties": {
    "Settlement": {
      "$ref": "#/$defs/Settlement"
    }
  },
  "$defs": {
    "ChannelDetail": {
      "type": "object",
      "properties": {
        "Channel": {
          "type": "string"
        },
        "ChannelPaymentTransactionsCount": {
          "type": "string"
        },
        "ChannelPaymentTransactionsValue": {
          "type": "string"
        },
        "ChannelNegativeCorrectionsCount": {
          "type": "string"
        },
        "ChannelNegativeCorrectionsValue": {
          "type": "string"
        },
        "ChannelDishonoredChequesCount": {
          "type": "string"
        },
        "ChannelDishonoredChequesValue": {
          "type": "string"
        },
        "ChannelDishonoredChequeFeesCount": {
          "type": "string"
        },
        "ChannelDishonoredChequeFeesValue": {
          "type": "string"
        },
        "ChannelTotalCount": {
          "type": "string"
        },
        "ChannelTotalValue": {
          "type": "string"
        },
        "PaymentMethods": {
          "$ref": "#/$defs/PaymentMethods"
        }
      }
    },
    "Channels": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ChannelDetail"
      }
    },
    "PaymentMethod": {
      "type": "object",
      "properties": {
        "PaymentMethod": {
          "type": "string"
        },
        "PaymentTransactionsCount": {
          "type": "string"
        },
        "NegativeCorrectionsCount": {
          "type": "string"
        },
        "NegativeCorrectionsValue": {
          "type": "string"
        },
        "DishonoredChequeCount": {
          "type": "string"
        },
        "DishonoredChequeValue": {
          "type": "string"
        },
        "DishonoredChequeFeesCount": {
          "type": "string"
        },
        "DishonoredChequeFeesValue": {
          "type": "string"
        },
        "TotalCount": {
          "type": "string"
        },
        "TotalValue": {
          "type": "string"
        }
      }
    },
    "PaymentMethods": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PaymentMethod"
      }
    },
    "Settlement": {
      "type": "object",
      "properties": {
        "Header": {
          "type": "string"
        },
        "IssuedBy": {
          "type": "string"
        },
        "SettlementDate": {
          "type": "string"
        },
        "AgencyNumber": {
          "type": "string"
        },
        "Transactions": {
          "$ref": "#/$defs/SettlementTransactions"
        },
        "TotalPaymentTransactionsCount": {
          "type": "string"
        },
        "TotalPaymentTransactionsValue": {
          "type": "string"
        },
        "TotalNegativeCorrectionsCount": {
          "type": "string"
        },
        "TotalNegativeCorrectionsValue": {
          "type": "string"
        },
        "TotalDishonoredChequesCount": {
          "type": "string"
        },
        "TotalDishonoredChequesValue": {
          "type": "string"
        },
        "TotalDishonoredChequeFeesCount": {
          "type": "string"
        },
        "TotalDishonoredChequeFeesValue": {
          "type": "string"
        },
        "DishonoredChequeFeesNote": {
          "type": "string"
        },
        "InvoiceTotal": {
          "type": "string"
        },
        "TaxInvoiceNote": {
          "type": "string"
        },
        "TotalCount": {
          "type": "string"
        },
        "TotalValue": {
          "type": "string"
        }
      }
    },
    "SettlementTransactionDetail": {
      "type": "object",
      "properties": {
        "TransactionCode": {
          "type": "string"
        },
        "Channels": {
          "$ref": "#/$defs/Channels"
        },
        "TransactionPaymentTransactionsCount": {
          "type": "string"
        },
        "TransactionPaymentTransactionsValue": {
          "type": "string"
        },
        "TransactionNegativeCorrectionsCount": {
          "type": "string"
        },
        "TransactionNegativeCorrectionsValue": {
          "type": "string"
        },
        "TransactionDishonoredChequesCount": {
          "type": "string"
        },
        "TransactionDishonoredChequesValue": {
          "type": "string"
        },
        "TransactionDishonoredChequeFeesCount": {
          "type": "string"
        },
        "TransactionDishonoredChequeFeesValue": {
          "type": "string"
        },
        "TransactionTotalCount": {
          "type": "string"
        },
        "TransactionTotalValue": {
          "type": "string"
        }
      }
    },
    "SettlementTransactions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SettlementTransactionDetail"
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/australia-post-settlement-report"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.