Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Refunds

Create a Refund

Supported for:

quickbooks xero oracleNetsuite myob

post/v2/accounting/refunds

Request body

connectionUuidstring required

Unique connection identifier.

Example request

{
  "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
  "data": {
    "passThrough": {
      "CustomField": [
        {
          "DefinitionId": "1",
          "StringValue": "my custom value",
          "Name": "Field One"
        }
      ]
    },
    "totalAmount": 150.5,
    "memo": "Services rendered.",
    "postedDate": "2021-03-09",
    "customerRef": {
      "id": "124"
    },
    "accountRef": {
      "id": "200"
    },
    "currency": "CAD",
    "lines": [
      {
        "description": "Refund description",
        "inventoryRef": {
          "id": "32"
        },
        "taxRateRef": {
          "id": "12"
        },
        "quantity": 3,
        "discountPercentage": 100.5,
        "accountRef": {
          "id": "200"
        },
        "trackingCategoryRefs": [
          {
            "id": "4040",
            "type": "class"
          }
        ],
        "links": [
          {
            "id": "125"
          }
        ]
      }
    ]
  }
}

Response

connectionUuidstring required
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod' required
pushCommunicationIdstring required
requestedOnstring date-time required
status'success' | 'failed' | 'pending' required

Example response

{
  "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
  "businessName": "Railz",
  "serviceName": "xero",
  "pushCommunicationId": "60473b57f0cdd1683ca71f60",
  "requestedOn": "2021-03-09T08:15:22.035Z",
  "status": "pending",
  "data": {
    "passThrough": {
      "CustomField": [
        {
          "DefinitionId": "1",
          "StringValue": "my custom value",
          "Name": "Field One"
        }
      ]
    },
    "totalAmount": 150.5,
    "memo": "Services rendered.",
    "postedDate": "2021-03-09",
    "customerRef": {
      "id": "124"
    },
    "accountRef": {
      "id": "200"
    },
    "currency": "CAD",
    "lines": [
      {
        "description": "Refund description",
        "inventoryRef": {
          "id": "32"
        },
        "taxRateRef": {
          "id": "12"
        },
        "quantity": 3,
        "discountPercentage": 100.5,
        "accountRef": {
          "id": "200"
        },
        "trackingCategoryRefs": [
          {
            "id": "4040",
            "type": "class"
          }
        ],
        "links": [
          {
            "id": "125"
          }
        ]
      }
    ]
  }
}