Refunds

Gets the latest refunds for a business.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
serviceName'quickbooks' | 'xero' | 'oracleNetsuite' | 'myob' required
startDatestring

Transaction date greater than or equal to parameter in the format: YYYY-MM-DD.

endDatestring

Transaction date less than or equal to parameter in the format: YYYY-MM-DD.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber
Example:100

This is the size of the results set you would like (default: 100).

orderBystring
totalAmountnumber float

Response

countnumber required

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 dynamicsBusinessCentral from the query request parameter serviceName

    • breaking

      removed the enum value freshbooks from the query request parameter serviceName

    • breaking

      removed the enum value plaid from the query request parameter serviceName

    • breaking

      removed the enum value quickbooksDesktop from the query request parameter serviceName

    • breaking

      removed the enum value sageBusinessCloud from the query request parameter serviceName

    • breaking

      removed the enum value sageIntacct from the query request parameter serviceName

    • breaking

      removed the enum value shopify from the query request parameter serviceName

    • breaking

      removed the enum value square from the query request parameter serviceName

    • breaking

      removed the enum value wave from the query request parameter serviceName

    • 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 from integer to float for status

    • breaking

      the //// response's property format changed from integer to float for status

    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      the //// response's property type changed from object to 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 byod enum value to the / response property for the response status

    • warning

      added the new byod enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum 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 property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      response property data/items/lines/items/subTotal deprecated

    • info

      response property data/items/lines/items/subTotal deprecated

    • info

      response property data/items/lines/items/totalAmount deprecated

    • info

      response property data/items/lines/items/totalAmount deprecated

    • info

      response property data/items/lines/items/trackingCategoryRef deprecated

    • info

      response property data/items/lines/items/trackingCategoryRef deprecated