Xero · Example Payload

Xero Createoverpaymentallocations Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Createoverpaymentallocations Example is an example object payload from Xero, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "createOverpaymentAllocations",
  "method": "PUT",
  "path": "/Overpayments/{OverpaymentID}/Allocations",
  "summary": "Xero Creates a single allocation for a specific overpayment",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "Allocations": [
          {
            "Invoice": {
              "InvoiceID": "00000000-0000-0000-0000-000000000000",
              "LineItems": [],
              "Contact": {},
              "Type": "ACCPAY"
            },
            "Amount": 10.0,
            "Date": "2019-03-12"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "3b7f7be2-384a-4703-bcfb-c56e9116c914",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1552428952968)/",
        "Allocations": [
          {
            "Amount": 1.0,
            "Date": "/Date(1552348800000+0000)/",
            "Invoice": {
              "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841",
              "Payments": [],
              "CreditNotes": [],
              "Prepayments": [],
              "Overpayments": [],
              "HasErrors": false,
              "IsDiscounted": false,
              "LineItems": [],
              "ValidationErrors": []
            },
            "Overpayment": {
              "OverpaymentID": "ed7f6041-c915-4667-bd1d-54c48e92161e",
              "ID": "ed7f6041-c915-4667-bd1d-54c48e92161e",
              "LineItems": []
            },
            "ValidationErrors": []
          }
        ]
      }
    }
  ]
}