GET /refunds
Changed onGets the latest refunds for a business.
Request
- Base URLhttps://api.railz.ai
- AuthHTTP bearer
Query parameters
Transaction date greater than or equal to parameter in the format: YYYY-MM-DD.
Transaction date less than or equal to parameter in the format: YYYY-MM-DD.
The offset is the position in the dataset of a particular record.
This is the size of the results set you would like (default: 100).
Response
Example response
{
"count": 1,
"meta": {
"reportId": [
"5fad8a342a88364234392fb5"
],
"serviceName": "xero",
"businessName": "Railz",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z",
"startDate": "2020-11-25T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z"
},
"data": [
{
"id": "1",
"customerRef": {
"id": "1",
"name": "Railz Financial"
},
"accountRef": {
"id": "145",
"name": "Example account"
},
"currencyRate": 1.13,
"totalDiscount": 322,
"discountPercentage": 322,
"subTotal": 301.5,
"taxAmount": 20.5,
"totalAmount": 322,
"memo": "Example bill memo.",
"sourceModifiedDate": "2021-03-09T10:18:29.985Z",
"date": "2021-03-09T10:18:29.985Z",
"shippingAddress": {
"line1": "1234 Park Street",
"line2": "Suite 1000",
"city": "Toronto",
"region": "ON",
"country": "CAN",
"postalCode": "A0B1C2"
},
"currencyRef": {
"id": "CAD",
"name": "Canadian Dollar",
"symbol": "USD,CAD"
},
"lines": [
{
"description": "Services rendered.",
"unitAmount": 100.5,
"quantity": 3,
"taxAmount": 20.5,
"taxRateRef": {
"id": "1",
"name": "HST",
"effectiveTaxRate": 13
},
"inventoryRef": {
"id": "1",
"name": "Digital Services"
},
"discountPercentage": 10.5,
"totalAmount": 10.5,
"subTotal": 301.5,
"trackingCategoryRef": {
"id": "4040",
"name": "Region",
"option": "East",
"optionId": "40401"
}
}
]
}
]
}Changes
- breaking
removed the enum value
dynamicsBusinessCentralfrom thequeryrequest parameterserviceName - breaking
removed the enum value
freshbooksfrom thequeryrequest parameterserviceName - breaking
removed the enum value
plaidfrom thequeryrequest parameterserviceName - breaking
removed the enum value
quickbooksDesktopfrom thequeryrequest parameterserviceName - breaking
removed the enum value
sageBusinessCloudfrom thequeryrequest parameterserviceName - breaking
removed the enum value
sageIntacctfrom thequeryrequest parameterserviceName - breaking
removed the enum value
shopifyfrom thequeryrequest parameterserviceName - breaking
removed the enum value
squarefrom thequeryrequest parameterserviceName - breaking
removed the enum value
wavefrom thequeryrequest parameterserviceName - breaking
the response property
////became optional for the status - breaking
the response property
////became optional for the status - breaking
the
////response's property format changed fromintegertofloatfor status - breaking
the
////response's property format changed fromintegertofloatfor status - breaking
the
////response's property type changed fromobjectto no type for status - breaking
the
////response's property type changed fromobjectto no type for status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
added the new
byodenum value to the/response property for the response status - warning
added the new
byodenum value to the/response property for the response status - warning
added the new
dynamics365Financeenum value to the/response property for the response status - warning
added the new
dynamics365Financeenum value to the/response property for the response status - warning
added the new
dynamicsBusinessCentralenum value to the/response property for the response status - warning
added the new
dynamicsBusinessCentralenum value to the/response property for the response status - warning
added the new
freshbooksenum value to the/response property for the response status - warning
added the new
freshbooksenum value to the/response property for the response status - warning
added the new
myobenum value to the/response property for the response status - warning
added the new
myobenum value to the/response property for the response status - warning
added the new
oracleNetsuiteenum value to the/response property for the response status - warning
added the new
oracleNetsuiteenum value to the/response property for the response status - warning
added the new
quickbooksenum value to the/response property for the response status - warning
added the new
quickbooksenum value to the/response property for the response status - warning
added the new
quickbooksDesktopenum value to the/response property for the response status - warning
added the new
quickbooksDesktopenum value to the/response property for the response status - warning
added the new
sageBusinessCloudenum value to the/response property for the response status - warning
added the new
sageBusinessCloudenum value to the/response property for the response status - warning
added the new
sageIntacctenum value to the/response property for the response status - warning
added the new
sageIntacctenum value to the/response property for the response status - warning
added the new
waveenum value to the/response property for the response status - warning
added the new
waveenum value to the/response property for the response status - warning
added the new
xeroenum value to the/response property for the response status - warning
added the new
xeroenum value to the/response property for the response status - warning
added the new
zohoBooksenum value to the/response property for the response status - warning
added the new
zohoBooksenum value to the/response property for the response status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added to the
////response propertyallOflist for the response status - info
added to the
////response propertyallOflist for the response status - info
response property
data/items/lines/items/subTotaldeprecated - info
response property
data/items/lines/items/subTotaldeprecated - info
response property
data/items/lines/items/totalAmountdeprecated - info
response property
data/items/lines/items/totalAmountdeprecated - info
response property
data/items/lines/items/trackingCategoryRefdeprecated - info
response property
data/items/lines/items/trackingCategoryRefdeprecated
- breaking