Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Refunds

Posts an individual refund for a business.

post/refunds

Request body

Example request

{
  "connection": {
    "businessName": "Railz",
    "serviceName": "xero"
  },
  "data": {
    "passThrough": {
      "CustomField": [
        {
          "DefinitionId": "1",
          "StringValue": "my custom value",
          "Name": "Field One"
        }
      ]
    },
    "totalAmount": 150.5,
    "memo": "Services rendered.",
    "customerRef": "145",
    "accountRef": "130",
    "date": "2021-03-09",
    "invoiceRef": "503",
    "currency": "CAD",
    "lines": [
      {
        "inventoryRef": "32",
        "taxRef": "2"
      }
    ]
  }
}

Response

pushCommunicationIdstring required
requestedOnstring date-time required
status'success' | 'failed' | 'pending' required
businessNamestring required
serviceName'xero' | 'quickbooks' | 'freshbooks' required

Example response

{
  "pushCommunicationId": "60473b57f0cdd1683ca71f60",
  "requestedOn": "2021-03-09T08:15:22.035Z",
  "status": "pending",
  "businessName": "Railz",
  "serviceName": "xero",
  "data": {
    "passThrough": {
      "CustomField": [
        {
          "DefinitionId": "1",
          "StringValue": "my custom value",
          "Name": "Field One"
        }
      ]
    },
    "totalAmount": 150.5,
    "memo": "Services rendered.",
    "customerRef": "145",
    "accountRef": "130",
    "date": "2021-03-09",
    "invoiceRef": "503",
    "currency": "CAD",
    "lines": [
      {
        "inventoryRef": "32",
        "taxRef": "2"
      }
    ]
  }
}