Qodex.ai

Allows you to retrieve a specific credit note

GET {{baseUrl}}/CreditNotes/:CreditNoteID?unitdp=<integer>

Request Params

KeyDatatypeRequiredDescription
unitdpstringe.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

HEADERS

KeyDatatypeRequiredDescription
xero-tenant-idstring(Required) Xero identifier for Tenant

RESPONSES

status: OK

{&quot;Id&quot;:&quot;dd5c5da7-08ab-486a-ac34-aea295f1614b&quot;,&quot;Status&quot;:&quot;OK&quot;,&quot;ProviderName&quot;:&quot;Provider Name Example&quot;,&quot;DateTimeUTC&quot;:&quot;/Date(1551812703811)/&quot;,&quot;CreditNotes&quot;:[{&quot;CreditNoteID&quot;:&quot;249f15fa-f2a7-4acc-8769-0984103f2225&quot;,&quot;CreditNoteNumber&quot;:&quot;CN-0005&quot;,&quot;Payments&quot;:[{&quot;PaymentID&quot;:&quot;6b037c9b-2e5d-4905-84d3-eabfb3438242&quot;,&quot;Date&quot;:&quot;/Date(1552521600000+0000)/&quot;,&quot;Amount&quot;:2.0,&quot;Reference&quot;:&quot;Too much&quot;,&quot;CurrencyRate&quot;:1.0,&quot;HasAccount&quot;:false,&quot;HasValidationErrors&quot;:false}],&quot;ID&quot;:&quot;249f15fa-f2a7-4acc-8769-0984103f2225&quot;,&quot;CurrencyRate&quot;:1.0,&quot;Type&quot;:&quot;ACCRECCREDIT&quot;,&quot;Reference&quot;:&quot;US Tour&quot;,&quot;RemainingCredit&quot;:32.5,&quot;Allocations&quot;:[],&quot;HasAttachments&quot;:true,&quot;Attachments&quot;:[{&quot;AttachmentID&quot;:&quot;9b9c9b62-069e-4f5a-a172-183195f084bb&quot;,&quot;FileName&quot;:&quot;Screen Shot 2019-03-04 at 9.00.06 AM.png&quot;,&quot;Url&quot;:&quot;https://api.xero.com/api.xro/2.0/creditnotes/249f15fa-f2a7-4acc-8769-0984103f2225/Attachments/Screen%20Shot%202019-03-04%20at%209.00.06%20AM.png&quot;,&quot;MimeType&quot;:&quot;image/png&quot;,&quot;ContentLength&quot;:82334}],&quot;Contact&quot;:{&quot;ContactID&quot;:&quot;430fa14a-f945-44d3-9f97-5df5e28441b8&quot;,&quot;ContactStatus&quot;:&quot;ACTIVE&quot;,&quot;Name&quot;:&quot;Liam Gallagher&quot;,&quot;FirstName&quot;:&quot;Liam&quot;,&quot;LastName&quot;:&quot;Gallagher&quot;,&quot;EmailAddress&quot;:&quot;liam@rockstar.com&quot;,&quot;BankAccountDetails&quot;:&quot;&quot;,&quot;Addresses&quot;:[{&quot;AddressType&quot;:&quot;STREET&quot;,&quot;City&quot;:&quot;&quot;,&quot;Region&quot;:&quot;&quot;,&quot;PostalCode&quot;:&quot;&quot;,&quot;Country&quot;:&quot;&quot;,&quot;AttentionTo&quot;:&quot;&quot;},{&quot;AddressType&quot;:&quot;POBOX&quot;,&quot;City&quot;:&quot;Anytown&quot;,&quot;Region&quot;:&quot;NY&quot;,&quot;PostalCode&quot;:&quot;10101&quot;,&quot;Country&quot;:&quot;USA&quot;,&quot;AttentionTo&quot;:&quot;&quot;}],&quot;Phones&quot;:[{&quot;PhoneType&quot;:&quot;DEFAULT&quot;,&quot;PhoneNumber&quot;:&quot;222-2222&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},{&quot;PhoneType&quot;:&quot;DDI&quot;,&quot;PhoneNumber&quot;:&quot;&quot;,&quot;PhoneAreaCode&quot;:&quot;&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},{&quot;PhoneType&quot;:&quot;FAX&quot;,&quot;PhoneNumber&quot;:&quot;333-2233&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},{&quot;PhoneType&quot;:&quot;MOBILE&quot;,&quot;PhoneNumber&quot;:&quot;444-3433&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;}],&quot;UpdatedDateUTC&quot;:&quot;/Date(1551747281053+0000)/&quot;,&quot;ContactGroups&quot;:[],&quot;ContactPersons&quot;:[],&quot;HasValidationErrors&quot;:false},&quot;DateString&quot;:&quot;2019-03-05T00:00:00&quot;,&quot;Date&quot;:&quot;/Date(1551744000000+0000)/&quot;,&quot;Status&quot;:&quot;AUTHORISED&quot;,&quot;LineAmountTypes&quot;:&quot;Exclusive&quot;,&quot;LineItems&quot;:[{&quot;Description&quot;:&quot;Mic Stand&quot;,&quot;UnitAmount&quot;:30.0,&quot;TaxType&quot;:&quot;OUTPUT2&quot;,&quot;TaxAmount&quot;:4.5,&quot;LineAmount&quot;:30.0,&quot;AccountCode&quot;:&quot;200&quot;,&quot;Tracking&quot;:[],&quot;Quantity&quot;:1.0,&quot;ValidationErrors&quot;:[]}],&quot;SubTotal&quot;:30.0,&quot;TotalTax&quot;:4.5,&quot;Total&quot;:34.5,&quot;UpdatedDateUTC&quot;:&quot;/Date(1551812346157+0000)/&quot;,&quot;CurrencyCode&quot;:&quot;NZD&quot;}]}