{"_id":"5a7b53ac770d5e0012198730","category":{"_id":"5a7b53ab770d5e00121986ef","version":"5a7b53ab770d5e00121986e2","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5a7b53ab770d5e00121986e2","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-02-07T19:29:47.431Z","releaseDate":"2018-02-07T19:29:47.431Z","categories":["5a7b53ab770d5e00121986e3","5a7b53ab770d5e00121986e4","5a7b53ab770d5e00121986e5","5a7b53ab770d5e00121986e6","5a7b53ab770d5e00121986e7","5a7b53ab770d5e00121986e8","5a7b53ab770d5e00121986e9","5a7b53ab770d5e00121986ea","5a7b53ab770d5e00121986eb","5a7b53ab770d5e00121986ec","5a7b53ab770d5e00121986ed","5a7b53ab770d5e00121986ee","5a7b53ab770d5e00121986ef","5a7b53ab770d5e00121986f0","5a7b53ab770d5e00121986f1","5a7b53ab770d5e00121986f2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.24.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-21T18:18:12.294Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":34,"body":"###Request\nN/A\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`amount`\",\n    \"0-1\": \"*decimal*\",\n    \"0-2\": \"Refund amount, positive value\",\n    \"1-0\": \"`currency`\",\n    \"2-0\": \"`date`\",\n    \"1-1\": \"*string*\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Refund date\",\n    \"1-2\": \"Currency of refund amount\",\n    \"3-0\": \"`vendor-amount`\",\n    \"3-1\": \"*decimal*\",\n    \"3-2\": \"The total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction.\",\n    \"4-0\": \"`vendors-refund-info`\",\n    \"4-1\": \"container\",\n    \"4-2\": \"Container of [vendors-refund-info](doc:vendors-refund-info) properties.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Contains refund details","slug":"refund-1","type":"basic","title":"refund"}

refund

Contains refund details

Request

N/A

Response

Property Name
Type
Description

amount

decimal

Refund amount, positive value

currency

string

Currency of refund amount

date

string

Refund date

vendor-amount

decimal

The total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction.

vendors-refund-info

container

Container of vendors-refund-info properties.