{ "operationId": "getOverpayment", "method": "GET", "path": "/Overpayments/{OverpaymentID}", "summary": "Xero Retrieves a specific overpayment using a unique overpayment Id", "requestExamples": [], "responseExamples": [ { "status": "200", "contentType": "application/json", "example": { "Id": "46c9e8e2-9410-4e75-9297-f0ca8fa76c32", "Status": "OK", "ProviderName": "Provider Name Example", "DateTimeUTC": "/Date(1553278835158)/", "Overpayments": [ { "OverpaymentID": "ed7f6041-c915-4667-bd1d-54c48e92161e", "ID": "ed7f6041-c915-4667-bd1d-54c48e92161e", "CurrencyRate": 1.0, "Type": "SPEND-OVERPAYMENT", "Reference": "Reference for payment", "RemainingCredit": 2999.0, "Allocations": [ { "Amount": 1.0, "Date": "/Date(1552348800000+0000)/", "Invoice": { "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841", "InvoiceNumber": "", "Payments": [], "CreditNotes": [], "Prepayments": [], "Overpayments": [], "HasErrors": false, "IsDiscounted": false, "LineItems": [] } } ], "Payments": [], "HasAttachments": true, "Attachments": [ { "AttachmentID": "247dd942-5245-47a7-adb1-4d9ea075b431", "FileName": "giphy.gif", "Url": "https://api.xero.com/api.xro/2.0/banktransaction/ed7f6041-c915-4667-bd1d-54c48e92161e/Attachments/giphy.gif", "MimeType": "image/gif", "ContentLength": 495727 } ], "Contact": { "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8", "ContactStatus": "ACTIVE", "Name": "Liam Gallagher", "FirstName": "Liam", "LastName": "Gallagher", "EmailAddress": "liam@rockstar.com", "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "", "AttentionTo": "" }, { "AddressType": "POBOX", "City": "Anytown", "Region": "NY", "PostalCode": "10101", "Country": "USA", "AttentionTo": "" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "222-2222", "PhoneAreaCode": "212", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "333-2233", "PhoneAreaCode": "212", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "444-3433", "PhoneAreaCode": "212", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "/Date(1551747281053+0000)/", "ContactGroups": [], "ContactPersons": [], "HasValidationErrors": false }, "DateString": "2019-03-12 00:00:00", "Date": "/Date(1552348800000+0000)/", "Status": "AUTHORISED", "LineAmountTypes": "NoTax", "LineItems": [ { "Description": "Broken TV deposit", "UnitAmount": 3000.0, "TaxType": "NONE", "TaxAmount": 0.0, "LineAmount": 3000.0, "AccountCode": "800", "Tracking": [], "Quantity": 1.0, "DiscountEnteredAsPercent": true, "ValidationErrors": [] } ], "SubTotal": 3000.0, "TotalTax": 0.0, "Total": 3000.0, "UpdatedDateUTC": "/Date(1552428952890+0000)/", "CurrencyCode": "NZD" } ] } } ] }