Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Customers

Update a Customer

Supported for:

freshbooks quickbooks xero oracleNetsuite sageBusinessCloud sageIntacct dynamicsBusinessCentral wave myob zohoBooks

put/v2/accounting/customers/{id}

Path parameters

idstring required

Request body

connectionUuidstring required

Unique connection identifier.

Example request

{
  "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
  "data": {
    "contactFirstName": "Jane",
    "contactLastName": "Smith",
    "emailAddress": "email@acme.com",
    "phone": "8889990000",
    "website": "www.acme.com",
    "customerName": "ACME Inc.",
    "contactName": "Jane Smith",
    "taxNumber": "987654321",
    "parentRef": {
      "id": "32"
    },
    "billingAddress": {
      "line1": "1234 Park Street",
      "line2": "Suite 1000",
      "city": "Toronto",
      "region": "ON",
      "country": "CAN",
      "postalCode": "A0B1C2"
    },
    "currency": "CAD",
    "shippingAddress": {
      "line1": "1234 Park Street",
      "line2": "Suite 1000",
      "city": "Toronto",
      "region": "ON",
      "country": "CAN",
      "postalCode": "A0B1C2"
    },
    "subsidiaryRefs": [
      {
        "id": "4"
      }
    ],
    "contacts": [
      {
        "name": "John Smith",
        "email": "jsmith@company.com",
        "phone": "8887779999",
        "address": {
          "line1": "1234 Park Street",
          "line2": "Suite 1000",
          "city": "Toronto",
          "region": "ON",
          "country": "CAN",
          "postalCode": "A0B1C2",
          "type": "billing"
        }
      }
    ],
    "passThrough": {
      "CustomField": [
        {
          "DefinitionId": "1",
          "StringValue": "my custom value",
          "Name": "Field One"
        }
      ]
    },
    "paymentMethodRef": {
      "id": "1",
      "name": "Harmonized sales tax",
      "type": "creditCard"
    }
  }
}

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": {
    "contactFirstName": "Jane",
    "contactLastName": "Smith",
    "emailAddress": "email@acme.com",
    "phone": "8889990000",
    "website": "www.acme.com",
    "customerName": "ACME Inc.",
    "contactName": "Jane Smith",
    "taxNumber": "987654321",
    "parentRef": {
      "id": "32"
    },
    "billingAddress": {
      "line1": "1234 Park Street",
      "line2": "Suite 1000",
      "city": "Toronto",
      "region": "ON",
      "country": "CAN",
      "postalCode": "A0B1C2"
    },
    "currency": "CAD",
    "shippingAddress": {
      "line1": "1234 Park Street",
      "line2": "Suite 1000",
      "city": "Toronto",
      "region": "ON",
      "country": "CAN",
      "postalCode": "A0B1C2"
    },
    "subsidiaryRefs": [
      {
        "id": "4"
      }
    ],
    "contacts": [
      {
        "name": "John Smith",
        "email": "jsmith@company.com",
        "phone": "8887779999",
        "address": {
          "line1": "1234 Park Street",
          "line2": "Suite 1000",
          "city": "Toronto",
          "region": "ON",
          "country": "CAN",
          "postalCode": "A0B1C2",
          "type": "billing"
        }
      }
    ],
    "passThrough": {
      "CustomField": [
        {
          "DefinitionId": "1",
          "StringValue": "my custom value",
          "Name": "Field One"
        }
      ]
    },
    "paymentMethodRef": {
      "id": "1",
      "name": "Harmonized sales tax",
      "type": "creditCard"
    }
  }
}