RArailz
Customer
Customers

POST /customers

Changed on

Creates an individual customer for a business.

Request

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

Request body

Example request

{
  "connection": {
    "businessName": "Railz",
    "serviceName": "quickbooks"
  },
  "data": {
    "contactFirstName": "Jane",
    "contactLastName": "Smith",
    "emailAddress": "email@acme.com",
    "phone": "8889990000",
    "website": "www.acme.com",
    "customerName": "ACME Inc.",
    "addresses": [
      {
        "type": "billing",
        "line1": "1234 Park Street",
        "line2": "Suite 1000",
        "city": "Toronto",
        "region": "ON",
        "country": "CAN",
        "postalCode": "A0B1C2"
      }
    ],
    "defaultCurrency": "CAD",
    "subsidiaryRefs": [
      "1",
      "3"
    ]
  }
}

Response

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

Example response

{
  "pushCommunicationId": "60473b57f0cdd1683ca71f60",
  "requestedOn": "2021-03-09T08:15:22.035Z",
  "status": "pending",
  "businessName": "Railz",
  "serviceName": "quickbooks",
  "data": {
    "contactFirstName": "Jane",
    "contactLastName": "Smith",
    "emailAddress": "email@acme.com",
    "phone": "8889990000",
    "website": "www.acme.com",
    "customerName": "ACME Inc.",
    "addresses": [
      {
        "type": "billing",
        "line1": "1234 Park Street",
        "line2": "Suite 1000",
        "city": "Toronto",
        "region": "ON",
        "country": "CAN",
        "postalCode": "A0B1C2"
      }
    ],
    "defaultCurrency": "CAD",
    "subsidiaryRefs": [
      "1",
      "3"
    ]
  }
}

Changes

  • 1383b9a47ac9Revision changes
    • info

      api tag Customer added

  • 5cdfae3fa1faRevision changes
    • breaking

      the /// request property's maxLength was decreased to 30

    • breaking

      the response's property format changed from uuid to no format for 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 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 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 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 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 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 zohoBooks enum value to the response property for the response status

    • info

      added the new byod enum value to the request property /

    • info

      added the new dynamics365Finance enum value to the request property /

    • info

      added the new zohoBooks enum value to the request property /

    • info

      the / request property format was generalized from uuid to no format

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status