{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"6"},"include":{"value":""},"outline":{"value":"false"},"indent":{"value":""},"style":{"value":"default"},"exclude":{"value":""},"type":{"value":"list"},"class":{"value":""},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"3f49675d-c12f-472a-b753-db2d77117e59"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"610e15a6-764c-43ab-b99d-0f7748c788c2"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"/customers","type":"text","marks":[{"type":"code"}]},{"text":"endpoint allows you to perform Create, Read, Update, and Delete queries for a Customer Record by providing relevant information. This endpoint is accessible through either a GET, POST, PATCH, or DELETE request and requires the use of a valid ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" for authentication purposes. TaskSuite will provide the appropriate key for Giggle Finance.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"To access this endpoint, you need to include the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" in the header payload. The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" serves as an authentication mechanism to ensure only authorized users can manipulate Customer Records.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Create a Customer Record","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"End Point URL","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www.giggle.tasksuite.com/webhook/json/v1/customers","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Method","type":"text"}]},{"type":"paragraph","content":[{"text":"POST","type":"text"},{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request body must be a JSON payload with the following fields","type":"text"}]},{"type":"table","attrs":{"layout":"center","isNumberColumnEnabled":true,"width":1278.0,"localId":"a7acd14b-9fcc-41cc-bd49-42f32bfd63cb"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"Field","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"Sub-Field","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"Data Type/Format","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph","content":[{"text":"Recommended","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"active","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Either “true” or “false” indicating whether the customer is active or not.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"Boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"customerType","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Either “person” or “company” indicating the type of customer record.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"ssn","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The Social Security Number of the contact person.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"dob","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The Date of Birth of the customer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String (YYYY-MM-DD)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The first name of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"surname","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The last name of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"accessUserName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The first and last name of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String (firstname_lastname) ","type":"text"}]},{"type":"paragraph","content":[{"text":"E.G: john_doe","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"email","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Email address of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]},{"type":"paragraph","content":[{"text":"(johndoe@email.com)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"companyName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the company the customer is affiliated with.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"ein","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Employer identification number provided by the employer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Must be nine digits in length","type":"text"}]}]}]},{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Only required if CompanyType is “company”.","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"giggleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The unique identifier provided by Giggle for this Customer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"Integer","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PK","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"address","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The address of the Customer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"Object","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"street1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Street address of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"street2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Additional address details (e.g. suite number)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"country","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Country Code where the Customer’s address resides.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Must be three characters (e.g. USA)","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"state","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"State of the customer’s address.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"city","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"City of the customer’s address. ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"zip","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Zip Code of the customer’s address.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph","content":[{"text":"phone","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"Object","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"number","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"Phone number of the user","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"(e.g. XXX-XXX-XXXX)","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"type","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The type of phone the user has.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"(office, mobile) ","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"carrierVerified","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"This is true if the carrier associated with this phone number is verified.","type":"text"}]},{"type":"paragraph","content":[{"text":"true or false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"Boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[232.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph","content":[{"text":"carrierName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[369.0]},"content":[{"type":"paragraph","content":[{"text":"The name of the carrier for this phone number","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffebe6","rowspan":1,"colwidth":[174.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#e3fcef","rowspan":1,"colwidth":[131.0]},"content":[{"type":"paragraph","content":[{"text":"X","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"The response will indicate the success or failure of the request to the Contact endpoint. The details of the response may vary based on the implementation of the API. A typical response will be a JSON object containing a success message or an error message.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example POST Request","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example is how one would create a customer record in the TaskSuite system.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Body","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"active\": true,\n \"customerType\": \"person\",\n \"ssn\": 123456789,\n \"dob\": \"2000-01-30\",\n \"name\": \"John\",\n \"surname\": \"Doe\",\n \"accessUserName\": \"john_doe\",\n \"email\": \"john.doe@email.com\",\n \"companyName\": \"ABC Company L.L.C\",\n \"ein\": 123456789,\n \"giggleId\": 89043762,\n \"address\": {\n \"street1\": \"123 Main St.\",\n \"street2\": \"Suite 5.\",\n \"country\": \"USA\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"22222\"\n },\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"mobile\",\n \"carrierVerified\": true,\n \"carrierName\": \"AT&T\"\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example (Python)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"import requests\nimport json\n\nurl = \"https://www.giggle.tasksuite.com/webhook/json/v1/customers\"\n\nheaders = {\n 'Content-Type': 'application/json',\n 'Authorization': 'Bearer '\n}\n\npayload = json.dumps({\n \"active\": true,\n \"customerType\": \"person\",\n \"ssn\": 123456789,\n \"dob\": \"2000-01-30\",\n \"name\": \"John\",\n \"surname\": \"Doe\",\n \"accessUserName\": \"john_doe\",\n \"email\": \"john.doe@email.com\",\n \"companyName\": \"ABC Company L.L.C\",\n \"ein\": 123456789,\n \"giggleId\": 89043762,\n \"address\": {\n \"street1\": \"123 Main St.\",\n \"street2\": \"Suite 5.\",\n \"country\": \"USA\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"22222\"\n },\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"mobile\",\n \"carrierVerified\": true,\n \"carrierName\": \"AT&T\"\n }\n})\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Response (Success)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"statusCode\": 200,\n \"status\": \"OK\",\n \"message\": \"Customer Successfully Created\",\n \"error\": false,\n \"giggleId\": 123456\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Response (Failure)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"statusCode\": 400,\n \"description\": \"Did not provide 'ssn'\",\n \"name\": \"Bad Request\"\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error Handling","type":"text"}]},{"type":"paragraph","content":[{"text":"In case of errors, the response will contain an appropriate error message with details on what caused the error. Make sure to handle these errors.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure that the required fields are provided in the request body; otherwise, the API will return an error indicating the missing fields.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" in the headers must be valid and active for the Customer creation to be successful.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Read a Customer Record","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"End Point URL","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www.giggle.tasksuite.com/webhook/json/v1/customers/","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Method","type":"text"}]},{"type":"paragraph","content":[{"text":"GET","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Body","type":"text"}]},{"type":"paragraph","content":[{"text":"None","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"The response will indicate the success or failure of the request to the Contact endpoint. The details of the response may vary based on the implementation of the API. A typical response will be a JSON object containing a success message with the details of the Customer or an error message. This request will include the customer data as well as any loan data associated with the customer.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example GET Request","type":"text"}]},{"type":"paragraph","content":[{"text":"The following is an example of how one would perform a GET request in the TaskSuite system.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example (Python)","type":"text"}]},{"type":"codeBlock","content":[{"text":"import requests\nimport json\n\nurl = \"https://www.giggle.tasksuite.com/webhook/json/v1/customers/\"\n\nheaders = {\n 'Content-Type': 'application/json',\n 'Authorization': 'Bearer '\n}\n\nresponse = requests.request(\"GET\", url, headers=headers)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Response (Success)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"customerData\": {\n \"giggleId\": 123456,\n \"active\": true,\n \"customerType\": \"person\",\n \"name\": \"John\",\n \"surname\": \"Doe\",\n \"age\": 21,\n \"city\": \"Austin\",\n \"companyName\": \"ABC Company L.L.C\",\n \"address\": {\n \"street1\": \"123 Main St.\",\n \"street2\": \"Suite 5.\",\n \"city\": \"Austin\",\n \"State\": \"TX\",\n \"zip\": \"22222\",\n \"country\": \"US\"\n },\n \"phone\": {\n \"number\": \"1234567890\",\n \"type\": \"mobile\",\n \"carrierVerified\": true,\n \"carrierName\": \"AT&T\"\n },\n \"dob\": \"2000-01-30\",\n \"ein\": \"123456789\"\n },\n \"loanData\": [\n {\n \"id\": 768943,\n \"state\": \"draft\",\n \"loanAmount\": 1000000.11,\n \"loanTerm\": 52,\n \"contractDate\": \"2024-05-22\",\n \"firstPaymentDate\": \"2024-06-22\",\n \"loanClass\": \"gold\",\n \"loanType\": \"instalment\",\n \"oFee\": 200.55,\n \"disbursementAmount\": 800000.88,\n \"discountSavings\": \"0.00\",\n \"discountDate\": \"2024-05-27\",\n \"renewalIncrement\": 8,\n \"applicationId\": 79834,\n \"disbursementFee\": \"25.99\",\n \"fundedDate\": \"2024-06-13\",\n \"partnerId\": 75475,\n \"leadId\": 456312,\n \"ccrScore\": 800,\n \"clarityScore\": 788,\n \"daysOverDue\": 12,\n \"amountOverdue\": 1987.32,\n \"contractBalance\": 421123.33 \n },\n {\n \"id\": 768944,\n \"state\": \"active\",\n \"loanAmount\": 1000000.11,\n \"loanTerm\": 52,\n \"contractDate\": \"2024-05-22\",\n \"firstPaymentDate\": \"2024-06-22\",\n \"loanClass\": \"gold\",\n \"loanType\": \"instalment\",\n \"oFee\": 200.55,\n \"disbursementAmount\": 800000.88,\n \"discountSavings\": \"0.00\",\n \"discountDate\": \"2024-05-27\",\n \"renewalIncrement\": 8,\n \"applicationId\": 79834,\n \"disbursementFee\": \"25.99\",\n \"fundedDate\": \"2024-06-13\",\n \"partnerId\": 75475,\n \"leadId\": 456313,\n \"ccrScore\": 800,\n \"clarityScore\": 788,\n \"daysOverDue\": 12,\n \"amountOverdue\": 1987.32,\n \"contractBalance\": 421123.33\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Response (Failure)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"statusCode\": 400,\n \"description\": \"Giggle ID not found.\",\n \"name\": \"Bad Request\"\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error Handling","type":"text"}]},{"type":"paragraph","content":[{"text":"In case of errors, the response will contain an appropriate error message with details on what caused the error. Make sure to handle these errors.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure that the required fields are provided in the request body; otherwise, the API will return an error indicating the missing fields.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" in the headers must be valid and active for the access to the Customer record to be successful.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Update a Customer Record","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"End Point URL","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www.giggle.tasksuite.com/webhook/json/v1/customers/","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Method","type":"text"}]},{"type":"paragraph","content":[{"text":"PATCH","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request body must be a JSON payload with the following fields. Please keep in mind that all fields are optional.","type":"text"}]},{"type":"table","attrs":{"layout":"center","isNumberColumnEnabled":true,"width":1278.0,"localId":"adcb0676-16ea-479f-8468-0803910cbf07"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"Field","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"Sub-Field","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"Data Type/Format","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"active","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Either “true” or “false” indicating whether the customer is active or not.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"Boolean","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"customerType","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Either “person” or “company” indicating the type of customer record.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"ssn","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"The Social Security Number of the contact person.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"Integer","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"dob","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"The Date of Birth of the customer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String (YYYY-MM-DD)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"The first name of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"surname","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"The last name of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"accessUserName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"The first and last name of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String (firstname_lastname) ","type":"text"}]},{"type":"paragraph","content":[{"text":"E.G: john_doe","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"email","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Email address of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]},{"type":"paragraph","content":[{"text":"(","type":"text"},{"text":"johndoe@email.com","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:johndoe@email.com"}}]},{"text":")","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"companyName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the company the customer is affiliated with.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"ein","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Employer identification number provided by the employer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Must be nine digits in length","type":"text"}]}]}]},{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"address","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"The address of the Customer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"Object","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"street1","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Street address of the customer.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"street2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Additional address details (e.g. suite number)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"country","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Country Code where the Customer’s address resides.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Must be three characters (e.g. USA)","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"state","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"State of the customer’s address.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"city","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"City of the customer’s address. ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#c0b6f2","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"zip","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Zip Code of the customer’s address.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph","content":[{"text":"phone","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#b3bac5","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"Object","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"number","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"Phone number of the user","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"Integer","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"(e.g. XXX-XXX-XXXX)","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"type","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"The type of phone the user has.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"(office, mobile) ","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"carrierVerified","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"This is true if the carrier associated with this phone number is verified.","type":"text"}]},{"type":"paragraph","content":[{"text":"true or false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"Boolean","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[309.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ff8f73","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"carrierName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#deebff","rowspan":1,"colwidth":[484.0]},"content":[{"type":"paragraph","content":[{"text":"The name of the carrier for this phone number","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[258.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"The response will indicate the success or failure of the request to the Contact endpoint. The details of the response may vary based on the implementation of the API. A typical response will be a JSON object containing a success message or an error message.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example PATCH Request","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example is how one would update a customer record in the TaskSuite system.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Body","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"active\": true,\n \"customerType\": \"person\",\n \"ssn\": \"123456789\",\n \"dob\": \"2000-01-30\",\n \"name\": \"John\",\n \"surname\": \"Doe\",\n \"accessUserName\": \"john_doe\",\n \"email\": \"john.doe@email.com\",\n \"companyName\": \"ABC Company L.L.C\",\n \"ein\": \"123456789\",\n \"address\": {\n \"street1\": \"123 Main St.\",\n \"street2\": \"Suite 5.\",\n \"country\": \"USA\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"22222\"\n },\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"mobile\",\n \"carrierVerified\": true,\n \"carrierName\": \"AT&T\"\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example (Python)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"import requests\nimport json\n\nurl = \"https://www.giggle.tasksuite.com/webhook/json/v1/customers/\"\n\nheaders = {\n 'Content-Type': 'application/json',\n 'Authorization': 'Bearer '\n}\n\npayload = json.dumps({\n \"active\": true,\n \"customerType\": \"person\",\n \"ssn\": 123456789,\n \"dob\": \"2000-01-30\",\n \"name\": \"John\",\n \"surname\": \"Doe\",\n \"accessUserName\": \"john_doe\",\n \"email\": \"john.doe@email.com\",\n \"companyName\": \"ABC Company L.L.C\",\n \"ein\": 123456789,\n \"address\": {\n \"street1\": \"123 Main St.\",\n \"street2\": \"Suite 5.\",\n \"country\": \"USA\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"22222\",\n },\n \"phone\": {\n \"number\": \"123-456-7890\",\n \"type\": \"mobile\",\n \"carrierVerified\": true,\n \"carrierName\": \"AT&T\",\n }\n})\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Response (Success)","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"statusCode\": 200,\n \"status\": \"OK\",\n \"message\": \"Customer Successfully Updated\",\n \"error\": false,\n \"giggleId\": 123456\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Response (Failure)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"statusCode\": 400,\n \"description\": \"Giggle ID not found.\",\n \"name\": \"Bad Request\"\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error Handling","type":"text"}]},{"type":"paragraph","content":[{"text":"In case of errors, the response will contain an appropriate error message with details on what caused the error. Make sure to handle these errors.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure that the required fields are provided in the request body; otherwise, the API will return an error indicating the missing fields.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" in the headers must be valid and active for the access to the Customer record to be successful.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Delete a Customer Record","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"End Point URL","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www.giggle.tasksuite.com/webhook/json/v1/customers/","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Method","type":"text"}]},{"type":"paragraph","content":[{"text":"DELETE","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Body","type":"text"}]},{"type":"paragraph","content":[{"text":"None","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"The response will indicate the success or failure of the request to the Contact endpoint. The details of the response may vary based on the implementation of the API. A typical response will be a JSON object containing a success message with the details of the Customer or an error message.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example DELETE Request","type":"text"}]},{"type":"paragraph","content":[{"text":"The following is an example of how one would perform a GET request in the TaskSuite system.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example (Python)","type":"text"}]},{"type":"codeBlock","content":[{"text":"import requests\nimport json\n\nurl = \"https://www.giggle.tasksuite.com/webhook/json/v1/customers/\"\n\nheaders = {\n 'Content-Type': 'application/json',\n 'Authorization': 'Bearer '\n}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Response (Success)","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"statusCode\": 200,\n \"status\": \"OK\",\n \"message\": \"Customer Successfully Deleted\",\n \"error\": false,\n \"giggleId\": 123456\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example Response (Failure)","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"statusCode\": 400,\n \"description\": \"Giggle ID not found.\",\n \"name\": \"Bad Request\"\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error Handling","type":"text"}]},{"type":"paragraph","content":[{"text":"In case of errors, the response will contain an appropriate error message with details on what caused the error. Make sure to handle these errors.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure that the required fields are provided in the request body; otherwise, the API will return an error indicating the missing fields.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" in the headers must be valid and active for the access to the Customer record to be successful.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Support","type":"text"}]},{"type":"paragraph","content":[{"text":"If there are any errors or discrepancies with this document or the related API endpoints. Please reach out to ","type":"text"},{"text":"support@tasksuite.com","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:support@tasksuite.com"}}]},{"text":" and a support engineer with handle your query.","type":"text"}]}],"version":1}

Browser not supported