Xero · Schema

PaymentResponse

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
paymentId string Xero Identifier of payment
batchPaymentId string Xero Identifier of batch payment. Present if the payment was created as part of a batch.
date string Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
amount number The amount of the payment
bankAmount number The bank amount of the payment
currencyRate number Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500
invoice object
creditNote object
prepayment object
overpayment object
View JSON Schema on GitHub

JSON Schema

xero-paymentresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentResponse",
  "title": "PaymentResponse",
  "type": "object",
  "properties": {
    "paymentId": {
      "type": "string",
      "description": "Xero Identifier of payment",
      "format": "uuid"
    },
    "batchPaymentId": {
      "type": "string",
      "description": "Xero Identifier of batch payment. Present if the payment was created as part of a batch.",
      "format": "uuid"
    },
    "date": {
      "type": "string",
      "description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06",
      "format": "date"
    },
    "amount": {
      "type": "number",
      "description": "The amount of the payment",
      "format": "double",
      "x-is-money": true
    },
    "bankAmount": {
      "type": "number",
      "description": "The bank amount of the payment",
      "format": "double",
      "x-is-money": true
    },
    "currencyRate": {
      "type": "number",
      "description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500",
      "format": "double"
    },
    "invoice": {
      "$ref": "#/components/schemas/InvoiceResponse"
    },
    "creditNote": {
      "$ref": "#/components/schemas/CreditNoteResponse"
    },
    "prepayment": {
      "$ref": "#/components/schemas/PrepaymentResponse"
    },
    "overpayment": {
      "$ref": "#/components/schemas/OverpaymentResponse"
    }
  },
  "additionalProperties": false
}