{ "openapi": "3.1.0", "servers": [ { "description": "Production", "url": "https://api.codat.io" } ], "info": { "title": "Sync for Payroll", "description": "The API for Sync for Payroll. \n\nSync for Payroll is an API and a set of supporting tools built to help integrate your customers' payroll data from their HR and payroll platforms into their accounting software and to support its reconciliation.\n\n[Explore product](https://docs.codat.io/payroll/overview) | [See OpenAPI spec](https://github.com/codatio/oas)\n\n---\n\n\n## Endpoints\n\n| Endpoints | Description |\n| :- |:- |\n| Companies | Create and manage your SMB users' companies. |\n| Connections | Create new and manage existing data connections for a company. |\n| Accounts | Get, create, and update Accounts. |\n| Journal entries | Get, create, and update Journal entries. |\n| Journals | Get, create, and update Journals. |\n| Tracking categories | Get, create, and update Tracking Categories for additional categorization of payroll components. |\n| Company info | View company profile from the source platform. |\n| Manage data | Control how data is retrieved from an integration. |\n", "version": "3.0.0", "contact": { "name": "Codat", "email": "support@codat.io" }, "termsOfService": "https://www.codat.io/legals/" }, "security": [ { "auth_header": [] } ], "x-speakeasy-retries": { "strategy": "backoff", "backoff": { "initialInterval": 500, "maxInterval": 60000, "maxElapsedTime": 3600000, "exponent": 1.5 }, "statusCodes": [ 408, 429, "5XX" ], "retryConnectionErrors": true }, "x-speakeasy-name-override": [ { "operationId": "^list-.*?", "methodNameOverride": "list" }, { "operationId": "^list-.*?-attachments", "methodNameOverride": "list-attachments" }, { "operationId": "^get-.*?", "methodNameOverride": "get" }, { "operationId": "^get-create-.*?-model", "methodNameOverride": "get-create-model" }, { "operationId": "^get-create-update.*?-model", "methodNameOverride": "get-create-update-model" }, { "operationId": "^get-.*?-attachment", "methodNameOverride": "get-attachment" }, { "operationId": "^update-.*?", "methodNameOverride": "update" }, { "operationId": "^create-.*?", "methodNameOverride": "create" }, { "operationId": "^delete-.*?", "methodNameOverride": "delete" }, { "operationId": "^delete-.*?-attachment", "methodNameOverride": "delete-attachment" }, { "operationId": "^download-.*?-attachment", "methodNameOverride": "download-attachment" }, { "operationId": "^upload-.*?-attachment", "methodNameOverride": "upload-attachment" } ], "x-codat-docs-path": "sync-for-payroll-api", "x-codat-keep-docs-paths-local": true, "x-codat-speakeasy-pagination": { "type": "offsetLimit", "inputs": [ { "name": "page", "in": "parameters", "type": "page" } ], "outputs": { "results": "$.results" } }, "tags": [ { "name": "Companies", "description": "Create and manage your SMB users' companies." }, { "name": "Connections", "description": "Create new and manage existing data connections for a company." }, { "name": "Accounts", "description": "Get, create, and update Accounts." }, { "name": "Journal entries", "description": "Get, create, and update Journal entries." }, { "name": "Journals", "description": "Get, create, and update Journals." }, { "name": "Tracking categories", "description": "Get, create, and update Tracking Categories for additional categorization of payroll components." }, { "name": "Company info", "description": "View company profile from the source platform." }, { "name": "Manage data", "description": "Control how data is retrieved from an integration." } ], "paths": { "/companies": { "get": { "summary": "List companies", "tags": [ "Companies" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Companies" }, "examples": { "One company": { "value": { "results": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "My Test Company", "description": "My Test Company make testing software", "platform": "", "redirect": "https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastSync": "2022-01-01T12:30:00.000Z", "dataConnections": [ { "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "sourceType": "Accounting" } ], "created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 1, "_links": { "current": { "href": "/companies?page=1&pageSize=100" }, "self": { "href": "/companies" } } } }, "List of Companies": { "value": { "results": [ { "id": "d1568dde-adf6-11ed-afa1-0242ac120002", "name": "Technicalium", "description": "Technology services, including web and app design and development", "platform": "", "redirect": "https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002", "lastSync": "2022-01-01T12:30:00.000Z", "dataConnections": [ { "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "sourceType": "Accounting" } ], "created": "2022-01-01T11:30:00Z", "createdByUserName": "Joe Bloggs" }, { "id": "096db70b-78de-4ff0-aa98-299cb5fe17a0", "name": "Godata", "description": "A new digital agency with a passion for creating amazing digital experiences", "platform": "", "redirect": "https://link.codat.io/company/096db70b-78de-4ff0-aa98-299cb5fe17a0", "lastSync": "2022-01-01T12:30:00.000Z", "dataConnections": [ { "id": "a70bc148-dc21-46b2-a257-d9c58ac15cbb", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/096db70b-78de-4ff0-aa98-299cb5fe17a0/connections/a70bc148-dc21-46b2-a257-d9c58ac15cbb/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "sourceType": "Accounting" } ], "created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 2, "_links": { "current": { "href": "/companies?page=1&pageSize=100" }, "self": { "href": "/companies" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "list-companies", "description": "The *List companies* endpoint returns a list of [companies] associated to your instances.\n\nA [company](https://docs.codat.io/sync-for-payroll-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ] }, "post": { "summary": "Create company", "tags": [ "Companies" ], "operationId": "create-company", "responses": { "200": { "description": "OK", "content": { "application/json": { "x-speakeasy-usage-example": true, "schema": { "$ref": "#/components/schemas/Company" }, "examples": { "With no description": { "value": { "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "platform": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "dataConnections": [], "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar" } }, "With a description": { "value": { "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "Technology services, including web and app design and development", "platform": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "dataConnections": [], "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar" } }, "With a tag": { "value": { "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "platform": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "dataConnections": [], "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "tags": { "region": "us" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "Use the *Create company* endpoint to create a new [company](https://docs.codat.io/sync-for-payroll-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/sync-for-payroll-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n\nIf forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRequestBody" }, "examples": { "With no description": { "value": { "name": "Technicalium" } }, "With a description": { "value": { "name": "Technicalium", "description": "Technology services, including web and app design and development" } } } } } } } }, "/companies/{companyId}": { "put": { "summary": "Update company", "description": "Use the *Update company* endpoint to update both the name and description of the company. \n\nA [company](https://docs.codat.io/sync-for-payroll-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.", "operationId": "update-company", "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "tags": [ "Companies" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRequestBody" }, "examples": { "Update name": { "value": { "name": "New Name" } }, "Update description": { "value": { "name": "Same name", "description": "Additional documents required" } } } } } } }, "delete": { "summary": "Delete a company", "operationId": "delete-company", "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "description": "The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/sync-for-payroll-api#/schemas/Company), its [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/sync-for-payroll-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n", "tags": [ "Companies" ], "responses": { "204": { "description": "No Content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } }, "get": { "summary": "Get company", "operationId": "get-company", "description": "The *Get company* endpoint returns a single company for a given `companyId`.\n\nA [company](https://docs.codat.io/sync-for-payroll-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n", "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "tags": [ "Companies" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" }, "examples": { "Simple company": { "value": { "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "My First Company", "description": "", "platform": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "dataConnections": [], "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/connections": { "get": { "summary": "List connections", "description": "List the connections for a company.", "operationId": "list-connections", "tags": [ "Connections" ], "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connections" }, "examples": { "Connections": { "value": { "results": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z", "sourceType": "Banking" } ], "pageNumber": 0, "pageSize": 0, "totalResults": 0, "_links": { "self": { "href": "string" }, "current": { "href": "string" }, "next": { "href": "string" }, "previous": { "href": "string" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } }, "post": { "summary": "Create connection", "description": "Creates a connection for the company by providing a valid `platformKey`. \n\nUse the [List Integrations](https://docs.codat.io/sync-for-payroll-api#/operations/list-integrations) endpoint to access valid platform keys. ", "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "tags": [ "Connections" ], "operationId": "create-connection", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "platformKey": { "type": "string", "minLength": 4, "maxLength": 4, "pattern": "[a-z]{4}", "example": "gbol", "description": "A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" }, "examples": { "Connection": { "value": { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z", "sourceType": "Banking" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/connections/{connectionId}": { "get": { "summary": "Get connection", "operationId": "get-connection", "description": "Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.", "tags": [ "Connections" ], "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" }, "examples": { "Connection": { "value": { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z", "sourceType": "Banking" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } }, "delete": { "summary": "Delete connection", "operationId": "delete-connection", "description": "Revoke and remove a connection from a company.\nThis operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.", "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "tags": [ "Connections" ], "responses": { "200": { "description": "OK" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } }, "patch": { "summary": "Unlink connection", "description": "This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.", "operationId": "unlink-connection", "x-speakeasy-name-override": "unlink", "tags": [ "Connections" ], "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "requestBody": { "content": { "application/json": { "schema": { "title": "Update connection", "x-internal": true, "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Connection/definitions/dataConnectionStatus", "description": "The current authorization status of the data connection.", "nullable": true } }, "additionalProperties": false }, "examples": { "Example": { "value": { "status": "Unlinked" } } } } }, "description": "" } } }, "/companies/{companyId}/data/all": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "post": { "summary": "Refresh all data", "operationId": "refresh-all-data-types", "responses": { "204": { "description": "No Content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "Refreshes all data types with `fetch on first link` set to `true` for a given company.\n\nThis is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.\n\n[Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`.", "tags": [ "Manage data" ] } }, "/companies/{companyId}/dataStatus": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "summary": "Get data status", "operationId": "get-data-status", "x-speakeasy-name-override": "get-data-status", "description": "Get the state of each data type for a company", "tags": [ "Manage data" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Data statuses", "x-internal": true, "type": "object", "properties": { "accountTransactions": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "balanceSheet": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "bankAccounts": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "bankTransactions": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "billCreditNotes": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "billPayments": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "bills": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "cashFlowStatement": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "chartOfAccounts": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "company": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "creditNotes": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "customers": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "directCosts": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "directIncomes": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "invoices": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "itemReceipts": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "items": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "journalEntries": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "journals": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "paymentMethods": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "payments": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "profitAndLoss": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "purchaseOrders": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "salesOrders": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "suppliers": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "taxRates": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "trackingCategories": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "transfers": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "banking-accountBalances": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "banking-accounts": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "banking-transactionCategories": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "banking-transactions": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-companyInfo": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-customers": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-disputes": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-locations": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-orders": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-paymentMethods": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-payments": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-productCategories": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-products": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-taxComponents": { "$ref": "#/components/schemas/DataStatus", "nullable": true }, "commerce-transactions": { "$ref": "#/components/schemas/DataStatus", "nullable": true } } }, "examples": { "Example": { "value": { "accountTransactions": { "dataType": "accountTransactions", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "balanceSheet": { "dataType": "balanceSheet", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "bankAccounts": { "dataType": "bankAccounts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "bankTransactions": { "dataType": "bankTransactions", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "billCreditNotes": { "dataType": "billCreditNotes", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "billPayments": { "dataType": "billPayments", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "bills": { "dataType": "bills", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "cashFlowStatement": { "dataType": "cashFlowStatement", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "chartOfAccounts": { "dataType": "chartOfAccounts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "company": { "dataType": "company", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "creditNotes": { "dataType": "creditNotes", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "customers": { "dataType": "customers", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "directCosts": { "dataType": "directCosts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "directIncomes": { "dataType": "directIncomes", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "invoices": { "dataType": "invoices", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "itemReceipts": { "dataType": "itemReceipts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "items": { "dataType": "items", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "journalEntries": { "dataType": "journalEntries", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "journals": { "dataType": "journals", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "paymentMethods": { "dataType": "paymentMethods", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "payments": { "dataType": "payments", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "profitAndLoss": { "dataType": "profitAndLoss", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "purchaseOrders": { "dataType": "purchaseOrders", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "salesOrders": { "dataType": "salesOrders", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "suppliers": { "dataType": "suppliers", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "taxRates": { "dataType": "taxRates", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "trackingCategories": { "dataType": "trackingCategories", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "transfers": { "dataType": "transfers", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "banking-accountBalances": { "dataType": "banking-accountBalances", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "banking-accounts": { "dataType": "banking-accounts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "banking-transactionCategories": { "dataType": "banking-transactionCategories", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "banking-transactions": { "dataType": "banking-transactions", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-companyInfo": { "dataType": "commerce-companyInfo", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-customers": { "dataType": "commerce-customers", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-disputes": { "dataType": "commerce-disputes", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-locations": { "dataType": "commerce-locations", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-orders": { "dataType": "commerce-orders", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-paymentMethods": { "dataType": "commerce-paymentMethods", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-payments": { "dataType": "commerce-payments", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-productCategories": { "dataType": "commerce-productCategories", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-products": { "dataType": "commerce-products", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-taxComponents": { "dataType": "commerce-taxComponents", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" }, "commerce-transactions": { "dataType": "commerce-transactions", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f" } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/queue/{dataType}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/dataType" } ], "post": { "summary": "Refresh data type", "operationId": "refresh-data-type", "description": "Refreshes a given data type for a given company.\n\nThis is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.", "tags": [ "Manage data" ], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "connectionId", "description": "Optionally, provide a data connection id to only queue pull operations on that connection." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullOperation" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/history": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "summary": "List pull operations", "tags": [ "Manage data" ], "operationId": "list-pull-operations", "x-speakeasy-name-override": "list-pull-operations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullOperations" }, "examples": { "Example": { "value": { "results": [ { "id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "requested": "2022-11-14T11:18:37.2798351Z", "progress": 10, "isCompleted": false, "isErrored": false } ], "_links": { "current": { "href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2" }, "self": { "href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history" }, "next": { "href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2" } }, "pageNumber": 0, "pageSize": 0, "totalResults": 0 } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "Gets the pull operation history (datasets) for a given company.", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ] } }, "/companies/{companyId}/push": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "summary": "List push operations", "tags": [ "Manage data" ], "operationId": "list-push-operations", "description": "List push operation records.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOperations" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/history/{datasetId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/datasetId" } ], "get": { "summary": "Get pull operation", "operationId": "get-pull-operation", "x-speakeasy-name-override": "get-pull-operation", "tags": [ "Manage data" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullOperation" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "Retrieve information about a single dataset or pull operation." } }, "/companies/{companyId}/push/{pushOperationKey}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "schema": { "type": "string", "format": "uuid" }, "name": "pushOperationKey", "in": "path", "required": true, "description": "Push operation key." } ], "get": { "summary": "Get push operation", "tags": [ "Manage data" ], "operationId": "get-push-operation", "x-speakeasy-name-override": "get-push-operation", "description": "Retrieve push operation.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOperation" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/accounts": { "get": { "tags": [ "Accounts" ], "summary": "List accounts", "description": "The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).", "operationId": "list-accounts", "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "x-speakeasy-usage-example": true, "schema": { "$ref": "#/components/schemas/Accounts" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e", "nominalCode": "610", "name": "Accounts Receivable", "description": "Invoices the business has issued but has not yet collected payment on.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Asset.Current.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T12:38:15Z", "sourceModifiedDate": "2022-12-10T16:39:00", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "76d5f23b-9623-4e3b-89cd-da57228764d3", "nominalCode": "611", "name": "Accounts Receivable", "description": "A provision anticipating that a portion of accounts receivable will never be collected.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Asset.Current.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T12:38:15Z", "sourceModifiedDate": "2022-10-19T05:49:00", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 98, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "8eaed16d-c69f-ec11-80f1-0022481b4546", "nominalCode": "45422026-68CA-4EF2-9", "name": "", "fullyQualifiedCategory": " .", "fullyQualifiedName": "..", "currency": "GBP", "currentBalance": 0, "type": "Unknown", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-03-09T16:31:54Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectCost.LineItems.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } }, { "id": "c0861a65-c69f-ec11-80f1-0022481b4546", "nominalCode": "10", "name": "Account no cat Balance Sheet", "fullyQualifiedCategory": " .", "fullyQualifiedName": "..Account no cat Balance Sheet", "currency": "GBP", "currentBalance": 27.34, "type": "Unknown", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-09-13T14:45:01Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectCost.LineItems.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 122, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "ef2fde36-4416-4bc5-b239-315b2929348c", "nominalCode": "1300", "name": "Debiteuren", "description": "Debiteuren", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled", "currency": "EUR", "currentBalance": 864435.44, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:36:17Z", "sourceModifiedDate": "2020-01-08T09:42:54Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] }, { "id": "2052b65b-20e9-4da1-85d8-fd5ca0ea3d38", "nominalCode": "888777888", "name": "One more AR account", "description": "One more AR account", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.One more AR account.PaymentsEnabled", "currency": "EUR", "currentBalance": 2174.82, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:36:17Z", "sourceModifiedDate": "2021-06-10T11:00:20Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 230, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40", "nominalCode": "THING", "name": "Some thing account", "description": "Some thing account", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:35:15Z", "sourceModifiedDate": "2017-08-01T17:31:12Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] }, { "id": "cf9572e7-8afa-4339-9113-af32a66d9df9", "nominalCode": "15400", "name": "Trade Debtors", "description": "Trade Debtors", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Trade Debtors.PaymentsEnabled", "currency": "GBP", "currentBalance": 4484655.39, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:35:15Z", "sourceModifiedDate": "2020-01-08T13:48:38Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 121, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "601", "nominalCode": "601", "name": "Capital Asset Brought Forward", "fullyQualifiedCategory": "Asset.Capital", "fullyQualifiedName": "Asset.Capital.Capital Asset Brought Forward", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-25T14:19:12Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "605", "nominalCode": "605", "name": "Capital Asset Depreciation Brought Forward", "fullyQualifiedCategory": "Asset.Capital", "fullyQualifiedName": "Asset.Capital.Capital Asset Depreciation Brought Forward", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-25T14:19:12Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 292, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "67357", "nominalCode": "1200", "name": "Accounts Receivable", "fullyQualifiedCategory": "Asset", "fullyQualifiedName": "Asset.Accounts Receivable", "currency": "GBP", "currentBalance": 51445.53, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-24T16:07:24Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "128611", "nominalCode": "1200-1", "name": "Accounts Receivable", "fullyQualifiedCategory": "Asset.Accounts Receivable", "fullyQualifiedName": "Asset.Accounts Receivable.Accounts Receivable", "currency": "GBP", "currentBalance": 51445.53, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-24T16:07:24Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 96, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "27840056", "nominalCode": "70700", "name": "16th Account", "fullyQualifiedCategory": "Asset.BankAccount", "fullyQualifiedName": "Asset.BankAccount.16th Account", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-09-30T10:29:16Z", "validDatatypeLinks": [] }, { "id": "27840049", "nominalCode": "70600", "name": "1a1a", "fullyQualifiedCategory": "Asset.BankAccount", "fullyQualifiedName": "Asset.BankAccount.1a1a", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-09-30T10:29:16Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 157, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "111", "name": "Accounts Payable", "fullyQualifiedCategory": "AcctPay.AcctPay", "fullyQualifiedName": "AcctPay.AcctPay.Accounts Payable", "currentBalance": -635.55, "type": "Liability", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-30T14:48:33Z", "sourceModifiedDate": "2021-08-11T12:51:21", "validDatatypeLinks": [] }, { "id": "119", "name": "Accounts Receivable", "fullyQualifiedCategory": "AcctRec.AcctRec", "fullyQualifiedName": "AcctRec.AcctRec.Accounts Receivable", "currentBalance": -565, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-30T14:48:33Z", "sourceModifiedDate": "2021-09-08T15:23:31", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 44, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "40000-933270541", "nominalCode": "11000", "name": "Accounts Receivable", "description": "Accounts Receivable", "fullyQualifiedCategory": "Asset.CurrentAsset.AccountsReceivable", "fullyQualifiedName": "Asset.CurrentAsset.AccountsReceivable.Accounts Receivable", "currency": "GBP", "currentBalance": 93007.93, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:06:23Z", "sourceModifiedDate": "2023-12-16T05:06:45", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "20000-933270541", "nominalCode": "10100", "name": "Checking", "description": "Cash", "fullyQualifiedCategory": "Asset.CurrentAsset.Bank", "fullyQualifiedName": "Asset.CurrentAsset.Bank.Checking", "currency": "GBP", "currentBalance": 46954.1, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2023-04-26T09:06:23Z", "sourceModifiedDate": "2023-12-16T05:06:45", "validDatatypeLinks": [ { "property": "Id", "links": [ "BillLineItem.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 116, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "62", "nominalCode": "246", "name": "Debtors", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors", "currency": "GBP", "currentBalance": 41289.37, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-18T11:02:34Z", "sourceModifiedDate": "2022-12-08T15:42:59Z", "validDatatypeLinks": [] }, { "id": "92", "nominalCode": "247", "name": "Debtors - AED", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors - AED", "currency": "AED", "currentBalance": -1533.44, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-18T11:02:34Z", "sourceModifiedDate": "2021-02-19T14:04:45Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 234, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "70", "name": "Debtors", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors", "currency": "GBP", "currentBalance": 3041173.77, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-26T01:18:15Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "80", "name": "Debtors - USD", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors - USD", "currency": "USD", "currentBalance": 54822.37, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-12T15:10:38Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 186, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "2864", "nominalCode": "1200", "name": "Bank Account", "description": "Bank Account", "fullyQualifiedCategory": "Asset.Bank Account", "fullyQualifiedName": "Asset.Bank Account.Bank Account", "type": "Asset", "status": "Archived", "isBankAccount": false, "modifiedDate": "2022-10-14T09:35:52Z", "validDatatypeLinks": [], "metadata": { "isDeleted": true } }, { "id": "2368", "nominalCode": "1200", "name": "Bank Current Account", "description": "Bank Current Account", "fullyQualifiedCategory": "Asset.Bank Account", "fullyQualifiedName": "Asset.Bank Account.Bank Current Account", "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-09-11T13:53:12Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 344, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "1100", "nominalCode": "1100", "name": "Debtors Control Account", "fullyQualifiedCategory": "Asset.CurrentAssets.Debtors", "fullyQualifiedName": "Asset.CurrentAssets.Debtors.Debtors Control Account", "currency": "GBP", "currentBalance": 90640.61, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "1102", "nominalCode": "1102", "name": "Other Debtors", "fullyQualifiedCategory": "Asset.CurrentAssets.Debtors", "fullyQualifiedName": "Asset.CurrentAssets.Debtors.Other Debtors", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 155, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "e5889b459f544926ac5b8e6756df2ad4", "nominalCode": "1560", "name": "Abdi Internet Bank", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Abdi Internet Bank", "currency": "GBP", "currentBalance": 49.61, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-24T14:52:53Z", "sourceModifiedDate": "2020-01-27T10:53:26Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] }, { "id": "b17083bc9b2748b4ab321b024e260eda", "nominalCode": "147852", "name": "Abdi Live Test", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Abdi Live Test", "currency": "GBP", "currentBalance": 225830.75, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-24T14:52:53Z", "sourceModifiedDate": "2020-01-28T14:00:20Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 283, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "2", "nominalCode": "12100", "name": "Accounts Receivable", "fullyQualifiedCategory": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable", "fullyQualifiedName": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-04T16:31:51Z", "sourceModifiedDate": "2020-01-29T01:42:43", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "155", "nominalCode": "12710", "name": "AR - Retainage", "fullyQualifiedCategory": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable", "fullyQualifiedName": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.AR - Retainage", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-04T16:31:51Z", "sourceModifiedDate": "2020-10-15T15:33:15", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 181, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=2&pageSize=2" } } } }, "Wave": { "value": { "results": [ { "id": "QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Abdi Bank", "description": "Test Balance Sheet", "fullyQualifiedCategory": "Asset.CashAndBank", "fullyQualifiedName": "Asset.CashAndBank.Abdi Bank", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-11-16T18:15:17Z", "validDatatypeLinks": [] }, { "id": "QWNjb3VudDo3OTE3NTA1OTcwOTQxNzQ3MTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Cash on Hand", "description": "Cash you haven�t deposited in the bank. Add your bank and credit card accounts to accurately categorize transactions that aren't cash.", "fullyQualifiedCategory": "Asset.CashAndBank", "fullyQualifiedName": "Asset.CashAndBank.Cash on Hand", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-11-16T18:15:17Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 85, "_links": { "current": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts" }, "next": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "nominalCode": "A090", "name": "Business Bank Account", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Business Bank Account", "currency": "GBP", "currentBalance": 924.25, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2023-03-15T20:35:08Z", "sourceModifiedDate": "2023-02-17T11:10:49", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id", "DirectIncome.LineItems.AccountRef.Id", "DirectCost.LineItems.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } }, { "id": "a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba", "nominalCode": "A091", "name": "Business Savings Account", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Business Savings Account", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2023-03-15T20:35:08Z", "sourceModifiedDate": "2023-02-17T11:10:49", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id", "DirectIncome.LineItems.AccountRef.Id", "DirectCost.LineItems.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 90, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/accounts" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000000352", "nominalCode": "", "name": "Accounts Receivable", "description": "The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer.", "fullyQualifiedCategory": "Asset.accounts_receivable", "fullyQualifiedName": "Asset.accounts_receivable.Accounts Receivable", "currency": "GBP", "currentBalance": -959.64, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-02-05T14:58:44", "validDatatypeLinks": [] }, { "id": "104957000000060010", "nominalCode": "", "name": "Abdi Test", "description": "", "fullyQualifiedCategory": "Asset.bank", "fullyQualifiedName": "Asset.bank.Abdi Test", "currency": "GBP", "currentBalance": 69858.44, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-02-17T12:19:47", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 68, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/accounts/{accountId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/accountId" } ], "get": { "tags": [ "Accounts" ], "summary": "Get account", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "Clear Books": { "value": { "id": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e", "nominalCode": "610", "name": "Accounts Receivable", "description": "Invoices the business has issued but has not yet collected payment on.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Asset.Current.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T12:38:15Z", "sourceModifiedDate": "2022-12-10T16:39:00", "validDatatypeLinks": [] } }, "Dynamics 365 Business Central": { "value": { "id": "8eaed16d-c69f-ec11-80f1-0022481b4546", "nominalCode": "45422026-68CA-4EF2-9", "name": "", "fullyQualifiedCategory": " .", "fullyQualifiedName": "..", "currency": "GBP", "currentBalance": 0, "type": "Unknown", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-03-09T16:31:54Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectCost.LineItems.AccountRef.Id" ] } ] } }, "Exact (Netherlands)": { "value": { "id": "ef2fde36-4416-4bc5-b239-315b2929348c", "nominalCode": "1300", "name": "Debiteuren", "description": "Debiteuren", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled", "currency": "EUR", "currentBalance": 864435.44, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:36:17Z", "sourceModifiedDate": "2020-01-08T09:42:54Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } }, "Exact (UK)": { "value": { "id": "ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40", "nominalCode": "THING", "name": "Some thing account", "description": "Some thing account", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:35:15Z", "sourceModifiedDate": "2017-08-01T17:31:12Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } }, "FreeAgent": { "value": { "id": "601", "nominalCode": "601", "name": "Capital Asset Brought Forward", "fullyQualifiedCategory": "Asset.Capital", "fullyQualifiedName": "Asset.Capital.Capital Asset Brought Forward", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-25T14:19:12Z", "validDatatypeLinks": [] } }, "FreshBooks": { "value": { "id": "67357", "nominalCode": "1200", "name": "Accounts Receivable", "fullyQualifiedCategory": "Asset", "fullyQualifiedName": "Asset.Accounts Receivable", "currency": "GBP", "currentBalance": 51445.53, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-24T16:07:24Z", "validDatatypeLinks": [] } }, "KashFlow": { "value": { "id": "27840056", "nominalCode": "70700", "name": "16th Account", "fullyQualifiedCategory": "Asset.BankAccount", "fullyQualifiedName": "Asset.BankAccount.16th Account", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-09-30T10:29:16Z", "validDatatypeLinks": [] } }, "Oracle NetSuite": { "value": { "id": "111", "name": "Accounts Payable", "fullyQualifiedCategory": "AcctPay.AcctPay", "fullyQualifiedName": "AcctPay.AcctPay.Accounts Payable", "currentBalance": -635.55, "type": "Liability", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-30T14:48:33Z", "sourceModifiedDate": "2021-08-11T12:51:21", "validDatatypeLinks": [] } }, "QuickBooks Desktop": { "value": { "id": "40000-933270541", "nominalCode": "11000", "name": "Accounts Receivable", "description": "Accounts Receivable", "fullyQualifiedCategory": "Asset.CurrentAsset.AccountsReceivable", "fullyQualifiedName": "Asset.CurrentAsset.AccountsReceivable.Accounts Receivable", "currency": "GBP", "currentBalance": 93007.93, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:06:23Z", "sourceModifiedDate": "2023-12-16T05:06:45", "validDatatypeLinks": [] } }, "QuickBooks Online": { "value": { "id": "62", "nominalCode": "246", "name": "Debtors", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors", "currency": "GBP", "currentBalance": 41289.37, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-18T11:02:34Z", "sourceModifiedDate": "2022-12-08T15:42:59Z", "validDatatypeLinks": [] } }, "QuickBooks Online Sandbox": { "value": { "id": "70", "name": "Debtors", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors", "currency": "GBP", "currentBalance": 3041173.77, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-26T01:18:15Z", "validDatatypeLinks": [] } }, "Sage 200cloud": { "value": { "id": "2864", "nominalCode": "1200", "name": "Bank Account", "description": "Bank Account", "fullyQualifiedCategory": "Asset.Bank Account", "fullyQualifiedName": "Asset.Bank Account.Bank Account", "type": "Asset", "status": "Archived", "isBankAccount": false, "modifiedDate": "2022-10-14T09:35:52Z", "validDatatypeLinks": [] } }, "Sage 50 (UK)": { "value": { "id": "1100", "nominalCode": "1100", "name": "Debtors Control Account", "fullyQualifiedCategory": "Asset.CurrentAssets.Debtors", "fullyQualifiedName": "Asset.CurrentAssets.Debtors.Debtors Control Account", "currency": "GBP", "currentBalance": 90640.61, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "validDatatypeLinks": [] } }, "Sage Business Cloud Accounting": { "value": { "id": "e5889b459f544926ac5b8e6756df2ad4", "nominalCode": "1560", "name": "Abdi Internet Bank", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Abdi Internet Bank", "currency": "GBP", "currentBalance": 49.61, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-24T14:52:53Z", "sourceModifiedDate": "2020-01-27T10:53:26Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } }, "Sage Intacct": { "value": { "id": "2", "nominalCode": "12100", "name": "Accounts Receivable", "fullyQualifiedCategory": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable", "fullyQualifiedName": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-04T16:31:51Z", "sourceModifiedDate": "2020-01-29T01:42:43", "validDatatypeLinks": [] } }, "Wave": { "value": { "id": "QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Abdi Bank", "description": "Test Balance Sheet", "fullyQualifiedCategory": "Asset.CashAndBank", "fullyQualifiedName": "Asset.CashAndBank.Abdi Bank", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-11-16T18:15:17Z", "validDatatypeLinks": [] } }, "Xero": { "value": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "nominalCode": "A090", "name": "Business Bank Account", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Business Bank Account", "currency": "GBP", "currentBalance": 924.25, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2023-03-15T20:35:08Z", "sourceModifiedDate": "2023-02-17T11:10:49", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id", "DirectIncome.LineItems.AccountRef.Id", "DirectCost.LineItems.AccountRef.Id" ] } ] } }, "Zoho Books": { "value": { "id": "104957000000000352", "nominalCode": "", "name": "Accounts Receivable", "description": "The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer.", "fullyQualifiedCategory": "Asset.accounts_receivable", "fullyQualifiedName": "Asset.accounts_receivable.Accounts Receivable", "currency": "GBP", "currentBalance": -959.64, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-02-05T14:58:44", "validDatatypeLinks": [] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get account* endpoint returns a single account for a given `accountId`.\n\n[Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).\n", "operationId": "get-account" } }, "/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create account model", "tags": [ "Accounts" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Exact (Netherlands)": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "Must be provided." } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "Name", "details": "Must be provided." } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Assets.Cash", "type": "String", "displayName": "Asset.Assets.Cash", "required": false }, { "value": "Asset.Assets.Bank", "type": "String", "displayName": "Asset.Assets.Bank", "required": false }, { "value": "Asset.Assets.PaymentServices", "type": "String", "displayName": "Asset.Assets.PaymentServices", "required": false }, { "value": "Asset.Assets.AccountsReceivable", "type": "String", "displayName": "Asset.Assets.AccountsReceivable", "required": false }, { "value": "Liability.EquityAndLiabilities.AccountsPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.AccountsPayable", "required": false }, { "value": "Asset.Assets.VAT", "type": "String", "displayName": "Asset.Assets.VAT", "required": false }, { "value": "Liability.EquityAndLiabilities.EmployeesPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.EmployeesPayable", "required": false }, { "value": "Asset.Assets.PrepaidExpenses", "type": "String", "displayName": "Asset.Assets.PrepaidExpenses", "required": false }, { "value": "Liability.EquityAndLiabilities.AccruedExpenses", "type": "String", "displayName": "Liability.EquityAndLiabilities.AccruedExpenses", "required": false }, { "value": "Liability.EquityAndLiabilities.IncomeTaxesPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.IncomeTaxesPayable", "required": false }, { "value": "Asset.Assets.FixedAssets", "type": "String", "displayName": "Asset.Assets.FixedAssets", "required": false }, { "value": "Asset.Assets.OtherAssets", "type": "String", "displayName": "Asset.Assets.OtherAssets", "required": false }, { "value": "Asset.Assets.AccumulatedDeprecation", "type": "String", "displayName": "Asset.Assets.AccumulatedDeprecation", "required": false }, { "value": "Asset.Assets.Inventory", "type": "String", "displayName": "Asset.Assets.Inventory", "required": false }, { "value": "Equity.EquityAndLiabilities.CapitalStock", "type": "String", "displayName": "Equity.EquityAndLiabilities.CapitalStock", "required": false }, { "value": "Equity.EquityAndLiabilities.RetainedEarnings", "type": "String", "displayName": "Equity.EquityAndLiabilities.RetainedEarnings", "required": false }, { "value": "Liability.EquityAndLiabilities.LongTermDebt", "type": "String", "displayName": "Liability.EquityAndLiabilities.LongTermDebt", "required": false }, { "value": "Liability.EquityAndLiabilities.CurrentPortionOfDebt", "type": "String", "displayName": "Liability.EquityAndLiabilities.CurrentPortionOfDebt", "required": false }, { "value": "Unknown.EquityAndLiabilities.Intercompany", "type": "String", "displayName": "Unknown.EquityAndLiabilities.Intercompany", "required": false }, { "value": "Unknown.General.General", "type": "String", "displayName": "Unknown.General.General", "required": false }, { "value": "Income.NetIncome.Revenue", "type": "String", "displayName": "Income.NetIncome.Revenue", "required": false }, { "value": "Expense.NetIncome.CostOfGoods", "type": "String", "displayName": "Expense.NetIncome.CostOfGoods", "required": false }, { "value": "Expense.NetIncome.OtherCosts", "type": "String", "displayName": "Expense.NetIncome.OtherCosts", "required": false }, { "value": "Expense.NetIncome.SalesGeneralAdministrativeExpenses", "type": "String", "displayName": "Expense.NetIncome.SalesGeneralAdministrativeExpenses", "required": false }, { "value": "Expense.NetIncome.DeprecationCosts", "type": "String", "displayName": "Expense.NetIncome.DeprecationCosts", "required": false }, { "value": "Expense.NetIncome.ResearchAndDevelopment", "type": "String", "displayName": "Expense.NetIncome.ResearchAndDevelopment", "required": false }, { "value": "Expense.NetIncome.EmployeeCosts", "type": "String", "displayName": "Expense.NetIncome.EmployeeCosts", "required": false }, { "value": "Expense.NetIncome.EmploymentCosts", "type": "String", "displayName": "Expense.NetIncome.EmploymentCosts", "required": false }, { "value": "Expense.ExceptionalIncome.ExceptionalCosts", "type": "String", "displayName": "Expense.ExceptionalIncome.ExceptionalCosts", "required": false }, { "value": "Income.ExceptionalIncome.ExceptionalIncome", "type": "String", "displayName": "Income.ExceptionalIncome.ExceptionalIncome", "required": false }, { "value": "Expense.ExceptionalIncome.IncomeTaxes", "type": "String", "displayName": "Expense.ExceptionalIncome.IncomeTaxes", "required": false }, { "value": "Income.ExceptionalIncome.InterestIncome", "type": "String", "displayName": "Income.ExceptionalIncome.InterestIncome", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "FullyQualifiedCategory", "details": "Must be provided." } ] } }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Pending", "type": "String", "displayName": "Pending", "required": false }, { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } } }, "required": true } }, "Exact (UK)": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "Must be provided." } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "Name", "details": "Must be provided." } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Assets.Cash", "type": "String", "displayName": "Asset.Assets.Cash", "required": false }, { "value": "Asset.Assets.Bank", "type": "String", "displayName": "Asset.Assets.Bank", "required": false }, { "value": "Asset.Assets.PaymentServices", "type": "String", "displayName": "Asset.Assets.PaymentServices", "required": false }, { "value": "Asset.Assets.AccountsReceivable", "type": "String", "displayName": "Asset.Assets.AccountsReceivable", "required": false }, { "value": "Liability.EquityAndLiabilities.AccountsPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.AccountsPayable", "required": false }, { "value": "Asset.Assets.VAT", "type": "String", "displayName": "Asset.Assets.VAT", "required": false }, { "value": "Liability.EquityAndLiabilities.EmployeesPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.EmployeesPayable", "required": false }, { "value": "Asset.Assets.PrepaidExpenses", "type": "String", "displayName": "Asset.Assets.PrepaidExpenses", "required": false }, { "value": "Liability.EquityAndLiabilities.AccruedExpenses", "type": "String", "displayName": "Liability.EquityAndLiabilities.AccruedExpenses", "required": false }, { "value": "Liability.EquityAndLiabilities.IncomeTaxesPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.IncomeTaxesPayable", "required": false }, { "value": "Asset.Assets.FixedAssets", "type": "String", "displayName": "Asset.Assets.FixedAssets", "required": false }, { "value": "Asset.Assets.OtherAssets", "type": "String", "displayName": "Asset.Assets.OtherAssets", "required": false }, { "value": "Asset.Assets.AccumulatedDeprecation", "type": "String", "displayName": "Asset.Assets.AccumulatedDeprecation", "required": false }, { "value": "Asset.Assets.Inventory", "type": "String", "displayName": "Asset.Assets.Inventory", "required": false }, { "value": "Equity.EquityAndLiabilities.CapitalStock", "type": "String", "displayName": "Equity.EquityAndLiabilities.CapitalStock", "required": false }, { "value": "Equity.EquityAndLiabilities.RetainedEarnings", "type": "String", "displayName": "Equity.EquityAndLiabilities.RetainedEarnings", "required": false }, { "value": "Liability.EquityAndLiabilities.LongTermDebt", "type": "String", "displayName": "Liability.EquityAndLiabilities.LongTermDebt", "required": false }, { "value": "Liability.EquityAndLiabilities.CurrentPortionOfDebt", "type": "String", "displayName": "Liability.EquityAndLiabilities.CurrentPortionOfDebt", "required": false }, { "value": "Unknown.EquityAndLiabilities.Intercompany", "type": "String", "displayName": "Unknown.EquityAndLiabilities.Intercompany", "required": false }, { "value": "Unknown.General.General", "type": "String", "displayName": "Unknown.General.General", "required": false }, { "value": "Income.NetIncome.Revenue", "type": "String", "displayName": "Income.NetIncome.Revenue", "required": false }, { "value": "Expense.NetIncome.CostOfGoods", "type": "String", "displayName": "Expense.NetIncome.CostOfGoods", "required": false }, { "value": "Expense.NetIncome.OtherCosts", "type": "String", "displayName": "Expense.NetIncome.OtherCosts", "required": false }, { "value": "Expense.NetIncome.SalesGeneralAdministrativeExpenses", "type": "String", "displayName": "Expense.NetIncome.SalesGeneralAdministrativeExpenses", "required": false }, { "value": "Expense.NetIncome.DeprecationCosts", "type": "String", "displayName": "Expense.NetIncome.DeprecationCosts", "required": false }, { "value": "Expense.NetIncome.ResearchAndDevelopment", "type": "String", "displayName": "Expense.NetIncome.ResearchAndDevelopment", "required": false }, { "value": "Expense.NetIncome.EmployeeCosts", "type": "String", "displayName": "Expense.NetIncome.EmployeeCosts", "required": false }, { "value": "Expense.NetIncome.EmploymentCosts", "type": "String", "displayName": "Expense.NetIncome.EmploymentCosts", "required": false }, { "value": "Expense.ExceptionalIncome.ExceptionalCosts", "type": "String", "displayName": "Expense.ExceptionalIncome.ExceptionalCosts", "required": false }, { "value": "Income.ExceptionalIncome.ExceptionalIncome", "type": "String", "displayName": "Income.ExceptionalIncome.ExceptionalIncome", "required": false }, { "value": "Expense.ExceptionalIncome.IncomeTaxes", "type": "String", "displayName": "Expense.ExceptionalIncome.IncomeTaxes", "required": false }, { "value": "Income.ExceptionalIncome.InterestIncome", "type": "String", "displayName": "Income.ExceptionalIncome.InterestIncome", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "FullyQualifiedCategory", "details": "Must be provided." } ] } }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Pending", "type": "String", "displayName": "Pending", "required": false }, { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx" } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false, "validation": { "warnings": [ { "field": "Name", "details": "Must have a length between 1 and 60 characters" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Description of the account", "required": false, "validation": { "warnings": [ { "field": "Description", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Bank", "type": "String", "displayName": "Bank", "required": false }, { "value": "Asset.AccountReceivable", "type": "String", "displayName": "Accounts Receivable", "required": false }, { "value": "Asset.OtherCurrentAsset", "type": "String", "displayName": "Other Current Asset", "required": false }, { "value": "Asset.FixedAsset", "type": "String", "displayName": "Fixed Asset", "required": false }, { "value": "Asset.OtherAsset", "type": "String", "displayName": "Other Asset", "required": false }, { "value": "Asset.CashAndBank", "type": "String", "displayName": "Cash", "required": false }, { "value": "Asset.Property Plant and Equipment", "type": "String", "displayName": "Equipment Machinery", "required": false }, { "value": "Liability.CreditCard", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "Liability.AccountsPayable", "type": "String", "displayName": "Accounts Payable", "required": false }, { "value": "Liability.OtherCurrentLiability", "type": "String", "displayName": "Other Current Liability", "required": false }, { "value": "Liability.LongTermLiability", "type": "String", "displayName": "Long Term Liability", "required": false }, { "value": "Liability.OtherLiability", "type": "String", "displayName": "Other Liability", "required": false }, { "value": "Equity", "type": "String", "displayName": "Equity", "required": false }, { "value": "Equity.Equity", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Equity.Equity.RetainedEarnings", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Equity.Owner's Equity", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Income", "type": "String", "displayName": "Income", "required": false }, { "value": "OtherIncome", "type": "String", "displayName": "Other Income", "required": false }, { "value": "Expense", "type": "String", "displayName": "Expense", "required": false }, { "value": "Expense.Expense", "type": "String", "displayName": "Sales Marketing", "required": false }, { "value": "Expense.Expense.Insurance", "type": "String", "displayName": "General Administrative", "required": false }, { "value": "Expense.Overhead", "type": "String", "displayName": "General Administrative", "required": false }, { "value": "Expense.Expense.RepairMaintenance", "type": "String", "displayName": "Repairs Maintenance", "required": false }, { "value": "OtherExpense", "type": "String", "displayName": "Other Expense", "required": false }, { "value": "CostOfSales", "type": "String", "displayName": "Cost of Sales", "required": false }, { "value": "Cost Of Goods Sold.Cost of Sales", "type": "String", "displayName": "Other", "required": false } ], "required": true }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "Max length of 7 characters." } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Max length of 31 characters." } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Description of the account", "required": false, "validation": { "warnings": [ { "field": "Description", "details": "Max length of 200 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the account", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is 'Asset.AccountsReceivable','Liability.AccountsPayable' or 'Liability.CreditCard'" }, { "field": "Currency", "details": "Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the base currency of the QuickBooks Desktop company" } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.AccountsReceivable", "type": "String", "displayName": "Account Receivable", "required": false }, { "value": "Asset.FixedAsset", "type": "String", "displayName": "Fixed Asset", "required": false }, { "value": "Asset.OtherCurrentAsset", "type": "String", "displayName": "Other Current Asset", "required": false }, { "value": "Asset.OtherAsset", "type": "String", "displayName": "Other Asset", "required": false }, { "value": "Income.Income", "type": "String", "displayName": "Income", "required": false }, { "value": "Income.OtherIncome", "type": "String", "displayName": "Other Income", "required": false }, { "value": "Liability.AccountsPayable", "type": "String", "displayName": "Accounts Payable", "required": false }, { "value": "Liability.CreditCard", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "Liability.LongTermLiability", "type": "String", "displayName": "Long Term Liability", "required": false }, { "value": "Liability.OtherCurrentLiability", "type": "String", "displayName": "Other Current Liability", "required": false }, { "value": "Liability.CostOfGoodsSold", "type": "String", "displayName": "Cost Of Goods Sold", "required": false }, { "value": "Equity.Equity", "type": "String", "displayName": "Equity", "required": false }, { "value": "Expense.Expense", "type": "String", "displayName": "Expense", "required": false }, { "value": "Expense.OtherExpense", "type": "String", "displayName": "Other Expense", "required": false } ], "required": true }, "currentBalance": { "type": "Number", "displayName": "Current Balance", "description": "The current balance in the account", "required": false } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": false, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "If included must have a length between 1 and 7 characters" } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Must have a length between 1 and 100 characters" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "When not specified company base currency will be used" } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Bank.CashOnHand", "type": "String", "displayName": "Cash On Hand", "required": false }, { "value": "Asset.Bank.Checking", "type": "String", "displayName": "Checking", "required": false }, { "value": "Asset.Bank.MoneyMarket", "type": "String", "displayName": "Money Market", "required": false }, { "value": "Asset.Bank.RentsHeldInTrust", "type": "String", "displayName": "Rents Held In Trust", "required": false }, { "value": "Asset.Bank.Savings", "type": "String", "displayName": "Savings", "required": false }, { "value": "Asset.Bank.TrustAccounts", "type": "String", "displayName": "Trust Accounts", "required": false }, { "value": "Asset.Bank.CashAndCashEquivalents", "type": "String", "displayName": "Cash And Cash Equivalents", "required": false }, { "value": "Asset.Bank.OtherEarmarkedBankAccounts", "type": "String", "displayName": "Other Earmarked Bank Accounts", "required": false }, { "value": "Asset.Other Current Asset.AllowanceForBadDebts", "type": "String", "displayName": "Allowance For Bad Debts", "required": false }, { "value": "Asset.Other Current Asset.DevelopmentCosts", "type": "String", "displayName": "Development Costs", "required": false }, { "value": "Asset.Other Current Asset.EmployeeCashAdvances", "type": "String", "displayName": "Employee Cash Advances", "required": false }, { "value": "Asset.Other Current Asset.OtherCurrentAssets", "type": "String", "displayName": "Other Current Assets", "required": false }, { "value": "Asset.Other Current Asset.Inventory", "type": "String", "displayName": "Inventory", "required": false }, { "value": "Asset.Other Current Asset.Investment_MortgageRealEstateLoans", "type": "String", "displayName": "Investment Mortgage Real Estate Loans", "required": false }, { "value": "Asset.Other Current Asset.Investment_Other", "type": "String", "displayName": "Investment Other", "required": false }, { "value": "Asset.Other Current Asset.Investment_TaxExemptSecurities", "type": "String", "displayName": "Investment Tax Exempt Securities", "required": false }, { "value": "Asset.Other Current Asset.Investment_USGovernmentObligations", "type": "String", "displayName": "Investment US Government Obligations", "required": false }, { "value": "Asset.Other Current Asset.LoansToOfficers", "type": "String", "displayName": "Loans To Officers", "required": false }, { "value": "Asset.Other Current Asset.LoansToOthers", "type": "String", "displayName": "Loans To Others", "required": false }, { "value": "Asset.Other Current Asset.LoansToStockholders", "type": "String", "displayName": "Loans To Stockholders", "required": false }, { "value": "Asset.Other Current Asset.PrepaidExpenses", "type": "String", "displayName": "Prepaid Expenses", "required": false }, { "value": "Asset.Other Current Asset.Retainage", "type": "String", "displayName": "Retainage", "required": false }, { "value": "Asset.Other Current Asset.UndepositedFunds", "type": "String", "displayName": "Undeposited Funds", "required": false }, { "value": "Asset.Other Current Asset.AssetsAvailableForSale", "type": "String", "displayName": "Assets Available For Sale", "required": false }, { "value": "Asset.Other Current Asset.BalWithGovtAuthorities", "type": "String", "displayName": "Balance With Govt Authorities", "required": false }, { "value": "Asset.Other Current Asset.CalledUpShareCapitalNotPaid", "type": "String", "displayName": "Called Up Share Capital Not Paid", "required": false }, { "value": "Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit", "type": "String", "displayName": "Expenditure Authorisations And Letters Of Credit", "required": false }, { "value": "Asset.Other Current Asset.GlobalTaxDeferred", "type": "String", "displayName": "Global Tax Deferred", "required": false }, { "value": "Asset.Other Current Asset.GlobalTaxRefund", "type": "String", "displayName": "Global Tax Refund", "required": false }, { "value": "Asset.Other Current Asset.InternalTransfers", "type": "String", "displayName": "Internal Transfers", "required": false }, { "value": "Asset.Other Current Asset.OtherConsumables", "type": "String", "displayName": "Other Consumables", "required": false }, { "value": "Asset.Other Current Asset.ProvisionsCurrentAssets", "type": "String", "displayName": "Provisions Current Assets", "required": false }, { "value": "Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties", "type": "String", "displayName": "Short Term Investments In Related Parties", "required": false }, { "value": "Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties", "type": "String", "displayName": "Short Term Loans And Advances To Related Parties", "required": false }, { "value": "Asset.Other Current Asset.TradeAndOtherReceivables", "type": "String", "displayName": "Trade And Other Receivables", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedDepletion", "type": "String", "displayName": "Accumulated Depletion", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedDepreciation", "type": "String", "displayName": "Accumulated Depreciation", "required": false }, { "value": "Asset.Fixed Asset.DepletableAssets", "type": "String", "displayName": "Depletable Assets", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetComputers", "type": "String", "displayName": "Fixed Asset Computers", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetCopiers", "type": "String", "displayName": "Fixed Asset Copiers", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetFurniture", "type": "String", "displayName": "Fixed Asset Furniture", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetPhone", "type": "String", "displayName": "Fixed Asset Phone", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetPhotoVideo", "type": "String", "displayName": "Fixed Asset Photo Video", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetSoftware", "type": "String", "displayName": "Fixed Asset Software", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetOtherToolsEquipment", "type": "String", "displayName": "Fixed Asset Other Tools Equipment", "required": false }, { "value": "Asset.Fixed Asset.FurnitureAndFixtures", "type": "String", "displayName": "Furniture And Fixtures", "required": false }, { "value": "Asset.Fixed Asset.Land", "type": "String", "displayName": "Land", "required": false }, { "value": "Asset.Fixed Asset.LeaseholdImprovements", "type": "String", "displayName": "Leasehold Improvements", "required": false }, { "value": "Asset.Fixed Asset.OtherFixedAssets", "type": "String", "displayName": "Other Fixed Assets", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedAmortization", "type": "String", "displayName": "Accumulated Amortization", "required": false }, { "value": "Asset.Fixed Asset.Buildings", "type": "String", "displayName": "Buildings", "required": false }, { "value": "Asset.Fixed Asset.IntangibleAssets", "type": "String", "displayName": "Intangible Assets", "required": false }, { "value": "Asset.Fixed Asset.MachineryAndEquipment", "type": "String", "displayName": "Machinery And Equipment", "required": false }, { "value": "Asset.Fixed Asset.Vehicles", "type": "String", "displayName": "Vehicles", "required": false }, { "value": "Asset.Fixed Asset.AssetsInCourseOfConstruction", "type": "String", "displayName": "Assets In Course Of Construction", "required": false }, { "value": "Asset.Fixed Asset.CapitalWip", "type": "String", "displayName": "Capital Wip", "required": false }, { "value": "Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets", "type": "String", "displayName": "Cumulative Depreciation On Intangible Assets", "required": false }, { "value": "Asset.Fixed Asset.IntangibleAssetsUnderDevelopment", "type": "String", "displayName": "Intangible Assets Under Development", "required": false }, { "value": "Asset.Fixed Asset.LandAsset", "type": "String", "displayName": "Land Asset", "required": false }, { "value": "Asset.Fixed Asset.NonCurrentAssets", "type": "String", "displayName": "Non Current Assets", "required": false }, { "value": "Asset.Fixed Asset.ParticipatingInterests", "type": "String", "displayName": "Participating Interests", "required": false }, { "value": "Asset.Fixed Asset.ProvisionsFixedAssets", "type": "String", "displayName": "Provisions Fixed Assets", "required": false }, { "value": "Asset.Other Asset.LeaseBuyout", "type": "String", "displayName": "Lease Buyout", "required": false }, { "value": "Asset.Other Asset.OtherLongTermAssets", "type": "String", "displayName": "Other Long Term Assets", "required": false }, { "value": "Asset.Other Asset.SecurityDeposits", "type": "String", "displayName": "Security Deposits", "required": false }, { "value": "Asset.Other Asset.AccumulatedAmortizationOfOtherAssets", "type": "String", "displayName": "Accumulated Amortization Of Other Assets", "required": false }, { "value": "Asset.Other Asset.Goodwill", "type": "String", "displayName": "Goodwill", "required": false }, { "value": "Asset.Other Asset.Licenses", "type": "String", "displayName": "Licenses", "required": false }, { "value": "Asset.Other Asset.OrganizationalCosts", "type": "String", "displayName": "Organizational Costs", "required": false }, { "value": "Asset.Other Asset.AssetsHeldForSale", "type": "String", "displayName": "Assets Held For Sale", "required": false }, { "value": "Asset.Other Asset.AvailableForSaleFinancialAssets", "type": "String", "displayName": "Available For Sale Financial Assets", "required": false }, { "value": "Asset.Other Asset.DeferredTax", "type": "String", "displayName": "Deferred Tax", "required": false }, { "value": "Asset.Other Asset.Investments", "type": "String", "displayName": "Investments", "required": false }, { "value": "Asset.Other Asset.LongTermInvestments", "type": "String", "displayName": "Long Term Investments", "required": false }, { "value": "Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties", "type": "String", "displayName": "Long Term Loans And Advances To Related Parties", "required": false }, { "value": "Asset.Other Asset.OtherIntangibleAssets", "type": "String", "displayName": "Other Intangible Assets", "required": false }, { "value": "Asset.Other Asset.OtherLongTermInvestments", "type": "String", "displayName": "Other Long Term Investments", "required": false }, { "value": "Asset.Other Asset.OtherLongTermLoansAndAdvances", "type": "String", "displayName": "Other Long Term Loans And Advances", "required": false }, { "value": "Asset.Other Asset.PrepaymentsAndAccruedIncome", "type": "String", "displayName": "Prepayments And Accrued Income", "required": false }, { "value": "Asset.Other Asset.ProvisionsNonCurrentAssets", "type": "String", "displayName": "Provisions Non-Current Assets", "required": false }, { "value": "Asset.Accounts Receivable.AccountsReceivable", "type": "String", "displayName": "Accounts Receivable", "required": false }, { "value": "Expense.Expense.AdvertisingPromotional", "type": "String", "displayName": "Advertising/Promotional", "required": false }, { "value": "Expense.Expense.BadDebts", "type": "String", "displayName": "Bad Debts", "required": false }, { "value": "Expense.Expense.BankCharges", "type": "String", "displayName": "Bank Charges", "required": false }, { "value": "Expense.Expense.CharitableContributions", "type": "String", "displayName": "Charitable Contributions", "required": false }, { "value": "Expense.Expense.CommissionsAndFees", "type": "String", "displayName": "Commissions And Fees", "required": false }, { "value": "Expense.Expense.Entertainment", "type": "String", "displayName": "Entertainment", "required": false }, { "value": "Expense.Expense.EntertainmentMeals", "type": "String", "displayName": "Entertainment Meals", "required": false }, { "value": "Expense.Expense.EquipmentRental", "type": "String", "displayName": "Equipment Rental", "required": false }, { "value": "Expense.Expense.FinanceCosts", "type": "String", "displayName": "Finance Costs", "required": false }, { "value": "Expense.Expense.GlobalTaxExpense", "type": "String", "displayName": "Global Tax Expense", "required": false }, { "value": "Expense.Expense.Insurance", "type": "String", "displayName": "Insurance", "required": false }, { "value": "Expense.Expense.InterestPaid", "type": "String", "displayName": "Interest Paid", "required": false }, { "value": "Expense.Expense.LegalProfessionalFees", "type": "String", "displayName": "Legal And Professional Fees", "required": false }, { "value": "Expense.Expense.OfficeExpenses", "type": "String", "displayName": "Office Expenses", "required": false }, { "value": "Expense.Expense.OfficeGeneralAdministrativeExpenses", "type": "String", "displayName": "Office/General Administrative Expenses", "required": false }, { "value": "Expense.Expense.OtherBusinessExpenses", "type": "String", "displayName": "Other Business Expenses", "required": false }, { "value": "Expense.Expense.OtherMiscellaneousServiceCost", "type": "String", "displayName": "Other Miscellaneous Service Cost", "required": false }, { "value": "Expense.Expense.PromotionalMeals", "type": "String", "displayName": "Promotional Meals", "required": false }, { "value": "Expense.Expense.RentOrLeaseOfBuildings", "type": "String", "displayName": "Rent Or Lease Of Buildings", "required": false }, { "value": "Expense.Expense.RepairMaintenance", "type": "String", "displayName": "Repair And Maintenance", "required": false }, { "value": "Expense.Expense.ShippingFreightDelivery", "type": "String", "displayName": "Shipping, Freight And Delivery", "required": false }, { "value": "Expense.Expense.SuppliesMaterials", "type": "String", "displayName": "Supplies And Materials", "required": false }, { "value": "Expense.Expense.Travel", "type": "String", "displayName": "Travel", "required": false }, { "value": "Expense.Expense.TravelMeals", "type": "String", "displayName": "Travel Meals", "required": false }, { "value": "Expense.Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Expense.Auto", "type": "String", "displayName": "Auto", "required": false }, { "value": "Expense.Expense.CostOfLabor", "type": "String", "displayName": "Cost Of Labor", "required": false }, { "value": "Expense.Expense.DuesSubscriptions", "type": "String", "displayName": "Dues And Subscriptions", "required": false }, { "value": "Expense.Expense.PayrollExpenses", "type": "String", "displayName": "Payroll Expenses", "required": false }, { "value": "Expense.Expense.TaxesPaid", "type": "String", "displayName": "Taxes Paid", "required": false }, { "value": "Expense.Expense.UnappliedCashBillPaymentExpense", "type": "String", "displayName": "Unapplied Cash Bill Payment Expense", "required": false }, { "value": "Expense.Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Expense.AmortizationExpense", "type": "String", "displayName": "Amortization Expense", "required": false }, { "value": "Expense.Expense.AppropriationsToDepreciation", "type": "String", "displayName": "Appropriations To Depreciation", "required": false }, { "value": "Expense.Expense.BorrowingCost", "type": "String", "displayName": "Borrowing Cost", "required": false }, { "value": "Expense.Expense.CommissionsAndFees", "type": "String", "displayName": "Commissions And Fees", "required": false }, { "value": "Expense.Expense.DistributionCosts", "type": "String", "displayName": "Distribution Costs", "required": false }, { "value": "Expense.Expense.ExternalServices", "type": "String", "displayName": "External Services", "required": false }, { "value": "Expense.Expense.ExtraordinaryCharges", "type": "String", "displayName": "Extraordinary Charges", "required": false }, { "value": "Expense.Expense.IncomeTaxExpense", "type": "String", "displayName": "Income Tax Expense", "required": false }, { "value": "Expense.Expense.LossOnDiscontinuedOperationsNetOfTax", "type": "String", "displayName": "Loss On Discontinued Operations Net Of Tax", "required": false }, { "value": "Expense.Expense.ManagementCompensation", "type": "String", "displayName": "Management Compensation", "required": false }, { "value": "Expense.Expense.OtherCurrentOperatingCharges", "type": "String", "displayName": "Other Current Operating Charges", "required": false }, { "value": "Expense.Expense.OtherExternalServices", "type": "String", "displayName": "Other External Services", "required": false }, { "value": "Expense.Expense.OtherRentalCosts", "type": "String", "displayName": "Other Rental Costs", "required": false }, { "value": "Expense.Expense.OtherSellingExpenses", "type": "String", "displayName": "Other Selling Expenses", "required": false }, { "value": "Expense.Expense.ProjectStudiesSurveysAssessments", "type": "String", "displayName": "Project Studies Surveys Assessments", "required": false }, { "value": "Expense.Expense.PurchasesRebates", "type": "String", "displayName": "Purchases Rebates", "required": false }, { "value": "Expense.Expense.ShippingAndDeliveryExpense", "type": "String", "displayName": "Shipping And Delivery Expense", "required": false }, { "value": "Expense.Expense.StaffCosts", "type": "String", "displayName": "Staff Costs", "required": false }, { "value": "Expense.Expense.Sundry", "type": "String", "displayName": "Sundry", "required": false }, { "value": "Expense.Expense.TravelExpensesGeneralAndAdminExpenses", "type": "String", "displayName": "Travel Expenses General And Admin Expenses", "required": false }, { "value": "Expense.Expense.TravelExpensesSellingExpense", "type": "String", "displayName": "Travel Expenses Selling Expense", "required": false }, { "value": "Expense.Other Expense.Depreciation", "type": "String", "displayName": "Depreciation", "required": false }, { "value": "Expense.Other Expense.ExchangeGainOrLoss", "type": "String", "displayName": "Exchange Gain Or Loss", "required": false }, { "value": "Expense.Other Expense.OtherMiscellaneousExpense", "type": "String", "displayName": "Other Miscellaneous Expense", "required": false }, { "value": "Expense.Other Expense.PenaltiesSettlements", "type": "String", "displayName": "Penalties And Settlements", "required": false }, { "value": "Expense.Other Expense.Amortization", "type": "String", "displayName": "Amortization", "required": false }, { "value": "Expense.Other Expense.GasAndFuel", "type": "String", "displayName": "Gas And Fuel", "required": false }, { "value": "Expense.Other Expense.HomeOffice", "type": "String", "displayName": "Home Office", "required": false }, { "value": "Expense.Other Expense.HomeOwnerRentalInsurance", "type": "String", "displayName": "Home Owner Rental Insurance", "required": false }, { "value": "Expense.Other Expense.OtherHomeOfficeExpenses", "type": "String", "displayName": "Other Home Office Expenses", "required": false }, { "value": "Expense.Other Expense.MortgageInterest", "type": "String", "displayName": "Mortgage Interest", "required": false }, { "value": "Expense.Other Expense.RentAndLease", "type": "String", "displayName": "Rent And Lease", "required": false }, { "value": "Expense.Other Expense.RepairsAndMaintenance", "type": "String", "displayName": "Repairs And Maintenance", "required": false }, { "value": "Expense.Other Expense.ParkingAndTolls", "type": "String", "displayName": "Parking And Tolls", "required": false }, { "value": "Expense.Other Expense.Vehicle", "type": "String", "displayName": "Vehicle", "required": false }, { "value": "Expense.Other Expense.VehicleInsurance", "type": "String", "displayName": "Vehicle Insurance", "required": false }, { "value": "Expense.Other Expense.VehicleLease", "type": "String", "displayName": "Vehicle Lease", "required": false }, { "value": "Expense.Other Expense.VehicleLoanInterest", "type": "String", "displayName": "Vehicle Loan Interest", "required": false }, { "value": "Expense.Other Expense.VehicleLoan", "type": "String", "displayName": "Vehicle Loan", "required": false }, { "value": "Expense.Other Expense.VehicleRegistration", "type": "String", "displayName": "Vehicle Registration", "required": false }, { "value": "Expense.Other Expense.VehicleRepairs", "type": "String", "displayName": "Vehicle Repairs", "required": false }, { "value": "Expense.Other Expense.OtherVehicleExpenses", "type": "String", "displayName": "Other Vehicle Expenses", "required": false }, { "value": "Expense.Other Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Other Expense.WashAndRoadServices", "type": "String", "displayName": "Wash And Road Services", "required": false }, { "value": "Expense.Other Expense.DeferredTaxExpense", "type": "String", "displayName": "Deferred Tax Expense", "required": false }, { "value": "Expense.Other Expense.Depletion", "type": "String", "displayName": "Depletion", "required": false }, { "value": "Expense.Other Expense.ExceptionalItems", "type": "String", "displayName": "Exceptional Items", "required": false }, { "value": "Expense.Other Expense.ExtraordinaryItems", "type": "String", "displayName": "Extraordinary Items", "required": false }, { "value": "Expense.Other Expense.IncomeTaxOtherExpense", "type": "String", "displayName": "Income Tax Other Expense", "required": false }, { "value": "Expense.Other Expense.MatCredit", "type": "String", "displayName": "Mat Credit", "required": false }, { "value": "Expense.Other Expense.PriorPeriodItems", "type": "String", "displayName": "Prior Period Items", "required": false }, { "value": "Expense.Other Expense.TaxRoundoffGainOrLoss", "type": "String", "displayName": "Tax Roundoff Gain Or Loss", "required": false }, { "value": "Expense.Cost of Goods Sold.EquipmentRentalCos", "type": "String", "displayName": "Equipment Rental - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.OtherCostsOfServiceCos", "type": "String", "displayName": "Other Costs Of Sales - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.ShippingFreightDeliveryCos", "type": "String", "displayName": "Shipping, Freight And Delivery - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.SuppliesMaterialsCogs", "type": "String", "displayName": "Supplies And Materials - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.CostOfLaborCos", "type": "String", "displayName": "Cost Of Labor - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.CostOfSales", "type": "String", "displayName": "Cost Of Sales", "required": false }, { "value": "Expense.Cost of Goods Sold.FreightAndDeliveryCost", "type": "String", "displayName": "Freight And Delivery Cost", "required": false }, { "value": "Income.Income.NonProfitIncome", "type": "String", "displayName": "Non Profit Income", "required": false }, { "value": "Income.Income.OtherPrimaryIncome", "type": "String", "displayName": "Other Primary Income", "required": false }, { "value": "Income.Income.SalesOfProductIncome", "type": "String", "displayName": "Sales Of ProductIncome", "required": false }, { "value": "Income.Income.ServiceFeeIncome", "type": "String", "displayName": "Service Fee Income", "required": false }, { "value": "Income.Income.DiscountsRefundsGiven", "type": "String", "displayName": "Discounts Refunds Given", "required": false }, { "value": "Income.Income.UnappliedCashPaymentIncome", "type": "String", "displayName": "Unapplied Cash Payment Income", "required": false }, { "value": "Income.Income.CashReceiptIncome", "type": "String", "displayName": "Cash Receipt Income", "required": false }, { "value": "Income.Income.OperatingGrants", "type": "String", "displayName": "Operating Grants", "required": false }, { "value": "Income.Income.OtherCurrentOperatingIncome", "type": "String", "displayName": "Other Current Operating Income", "required": false }, { "value": "Income.Income.OwnWorkCapitalized", "type": "String", "displayName": "Own Work Capitalized", "required": false }, { "value": "Income.Income.RevenueGeneral", "type": "String", "displayName": "Revenue General", "required": false }, { "value": "Income.Income.SalesRetail", "type": "String", "displayName": "Sales Retail", "required": false }, { "value": "Income.Income.SalesWholesale", "type": "String", "displayName": "Sales Wholesale", "required": false }, { "value": "Income.Income.SavingsByTaxScheme", "type": "String", "displayName": "Savings By Tax Scheme", "required": false }, { "value": "Income.Other Income.DividendIncome", "type": "String", "displayName": "Dividend Income", "required": false }, { "value": "Income.Other Income.InterestEarned", "type": "String", "displayName": "Interest Earned", "required": false }, { "value": "Income.Other Income.OtherInvestmentIncome", "type": "String", "displayName": "Other Investment Income", "required": false }, { "value": "Income.Other Income.OtherMiscellaneousIncome", "type": "String", "displayName": "Other Miscellaneous Income", "required": false }, { "value": "Income.Other Income.TaxExemptInterest", "type": "String", "displayName": "Tax Exempt Interest", "required": false }, { "value": "Income.Other Income.GainLossOnSaleOfFixedAssets", "type": "String", "displayName": "Gain Loss On Sale Of Fixed Assets", "required": false }, { "value": "Income.Other Income.GainLossOnSaleOfInvestments", "type": "String", "displayName": "Gain Loss On Sale Of Investments", "required": false }, { "value": "Income.Other Income.LossOnDisposalOfAssets", "type": "String", "displayName": "Loss On Disposal Of Assets", "required": false }, { "value": "Income.Other Income.OtherOperatingIncome", "type": "String", "displayName": "Other Operating Income", "required": false }, { "value": "Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax", "type": "String", "displayName": "Unrealised Loss On Securities Net Of Tax", "required": false }, { "value": "Liability.Accounts Payable.AccountsPayable", "type": "String", "displayName": "Accounts Payable", "required": false }, { "value": "Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise", "type": "String", "displayName": "Outstanding Dues Micro Small Enterprise", "required": false }, { "value": "Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise", "type": "String", "displayName": "Outstanding Dues Other Than Micro Small Enterprise", "required": false }, { "value": "Liability.Credit Card.CreditCard", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "Liability.Long Term Liability.NotesPayable", "type": "String", "displayName": "Notes Payable", "required": false }, { "value": "Liability.Long Term Liability.OtherLongTermLiabilities", "type": "String", "displayName": "Other Long Term Liabilities", "required": false }, { "value": "Liability.Long Term Liability.ShareholderNotesPayable", "type": "String", "displayName": "Shareholder Notes Payable", "required": false }, { "value": "Liability.Long Term Liability.AccrualsAndDeferredIncome", "type": "String", "displayName": "Accruals And Deferred Income", "required": false }, { "value": "Liability.Long Term Liability.AccruedLongLermLiabilities", "type": "String", "displayName": "Accrued Long Lerm Liabilities", "required": false }, { "value": "Liability.Long Term Liability.AccruedVacationPayable", "type": "String", "displayName": "Accrued Vacation Payable", "required": false }, { "value": "Liability.Long Term Liability.BankLoans", "type": "String", "displayName": "Bank Loans", "required": false }, { "value": "Liability.Long Term Liability.DebtsRelatedToParticipatingInterests", "type": "String", "displayName": "Debts Related To Participating Interests", "required": false }, { "value": "Liability.Long Term Liability.DeferredTaxLiabilities", "type": "String", "displayName": "Deferred Tax Liabilities", "required": false }, { "value": "Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities", "type": "String", "displayName": "Government And Other Public Authorities", "required": false }, { "value": "Liability.Long Term Liability.GroupAndAssociates", "type": "String", "displayName": "Group And Associates", "required": false }, { "value": "Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale", "type": "String", "displayName": "Liabilities Related To Assets Held For Sale", "required": false }, { "value": "Liability.Long Term Liability.LongTermBorrowings", "type": "String", "displayName": "Long Term Borrowings", "required": false }, { "value": "Liability.Long Term Liability.LongTermDebit", "type": "String", "displayName": "Long Term Debit", "required": false }, { "value": "Liability.Long Term Liability.LongTermEmployeeBenefitObligations", "type": "String", "displayName": "Long Term Employee Benefit Obligations", "required": false }, { "value": "Liability.Long Term Liability.ObligationsUnderFinanceLeases", "type": "String", "displayName": "Obligations Under Finance Leases", "required": false }, { "value": "Liability.Long Term Liability.OtherLongTermProvisions", "type": "String", "displayName": "Other Long Term Provisions", "required": false }, { "value": "Liability.Long Term Liability.ProvisionForLiabilities", "type": "String", "displayName": "Provision For Liabilities", "required": false }, { "value": "Liability.Long Term Liability.ProvisionsNonCurrentLiabilities", "type": "String", "displayName": "Provisions Non Current Liabilities", "required": false }, { "value": "Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts", "type": "String", "displayName": "Staff And Related Long Term Liability Accounts", "required": false }, { "value": "Liability.Other Current Liability.DirectDepositPayable", "type": "String", "displayName": "Direct Deposit Payable", "required": false }, { "value": "Liability.Other Current Liability.LineOfCredit", "type": "String", "displayName": "Line Of Credit", "required": false }, { "value": "Liability.Other Current Liability.LoanPayable", "type": "String", "displayName": "Loan Payable", "required": false }, { "value": "Liability.Other Current Liability.GlobalTaxPayable", "type": "String", "displayName": "Global Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.GlobalTaxSuspense", "type": "String", "displayName": "Global Tax Suspense", "required": false }, { "value": "Liability.Other Current Liability.OtherCurrentLiabilities", "type": "String", "displayName": "Other Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.PayrollClearing", "type": "String", "displayName": "Payroll Clearing", "required": false }, { "value": "Liability.Other Current Liability.PayrollTaxPayable", "type": "String", "displayName": "Payroll Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.PrepaidExpensesPayable", "type": "String", "displayName": "Prepaid Expenses Payable", "required": false }, { "value": "Liability.Other Current Liability.RentsInTrustLiability", "type": "String", "displayName": "Rents In Trust Liability", "required": false }, { "value": "Liability.Other Current Liability.TrustAccountsLiabilities", "type": "String", "displayName": "Trust Accounts Liabilities", "required": false }, { "value": "Liability.Other Current Liability.FederalIncomeTaxPayable", "type": "String", "displayName": "Federal Income Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.InsurancePayable", "type": "String", "displayName": "Insurance Payable", "required": false }, { "value": "Liability.Other Current Liability.SalesTaxPayable", "type": "String", "displayName": "Sales Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.StateLocalIncomeTaxPayable", "type": "String", "displayName": "State Local Income Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.AccruedLiabilities", "type": "String", "displayName": "Accrued Liabilities", "required": false }, { "value": "Liability.Other Current Liability.CurrentLiabilities", "type": "String", "displayName": "Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations", "type": "String", "displayName": "Current Portion EmployeeBenefits Obligations", "required": false }, { "value": "Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases", "type": "String", "displayName": "Current Portion Of Obligations Under Finance Leases", "required": false }, { "value": "Liability.Other Current Liability.CurrentTaxLiability", "type": "String", "displayName": "Current Tax Liability", "required": false }, { "value": "Liability.Other Current Liability.DividendsPayable", "type": "String", "displayName": "Dividends Payable", "required": false }, { "value": "Liability.Other Current Liability.DutiesAndTaxes", "type": "String", "displayName": "Duties And Taxes", "required": false }, { "value": "Liability.Other Current Liability.InterestPayables", "type": "String", "displayName": "Interest Payables", "required": false }, { "value": "Liability.Other Current Liability.ProvisionForWarrantyObligations", "type": "String", "displayName": "Provision For Warranty Obligations", "required": false }, { "value": "Liability.Other Current Liability.ProvisionsCurrentLiabilities", "type": "String", "displayName": "Provisions Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.ShortTermBorrowings", "type": "String", "displayName": "Short Term Borrowings", "required": false }, { "value": "Liability.Other Current Liability.SocialSecurityAgencies", "type": "String", "displayName": "Social Security Agencies", "required": false }, { "value": "Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts", "type": "String", "displayName": "Staff And Related Liability Accounts", "required": false }, { "value": "Liability.Other Current Liability.SundryDebtorsAndCreditors", "type": "String", "displayName": "Sundry Debtors And Creditors", "required": false }, { "value": "Liability.Other Current Liability.TradeAndOtherPayables", "type": "String", "displayName": "Trade And Other Payables", "required": false }, { "value": "Equity.Equity.OpeningBalanceEquity", "type": "String", "displayName": "Opening Balance Equity", "required": false }, { "value": "Equity.Equity.PartnersEquity", "type": "String", "displayName": "Partners Equity", "required": false }, { "value": "Equity.Equity.RetainedEarnings", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Equity.Equity.AccumulatedAdjustment", "type": "String", "displayName": "Accumulated Adjustment", "required": false }, { "value": "Equity.Equity.OwnersEquity", "type": "String", "displayName": "Owners Equity", "required": false }, { "value": "Equity.Equity.PaidInCapitalOrSurplus", "type": "String", "displayName": "Paid In Capital Or Surplus", "required": false }, { "value": "Equity.Equity.PartnerContributions", "type": "String", "displayName": "Partner Contributions", "required": false }, { "value": "Equity.Equity.PartnerDistributions", "type": "String", "displayName": "Partner Distributions", "required": false }, { "value": "Equity.Equity.PreferredStock", "type": "String", "displayName": "Preferred Stock", "required": false }, { "value": "Equity.Equity.CommonStock", "type": "String", "displayName": "Common Stock", "required": false }, { "value": "Equity.Equity.TreasuryStock", "type": "String", "displayName": "Treasury Stock", "required": false }, { "value": "Equity.Equity.EstimatedTaxes", "type": "String", "displayName": "Estimated Taxes", "required": false }, { "value": "Equity.Equity.Healthcare", "type": "String", "displayName": "Healthcare", "required": false }, { "value": "Equity.Equity.PersonalIncome", "type": "String", "displayName": "Personal Income", "required": false }, { "value": "Equity.Equity.PersonalExpense", "type": "String", "displayName": "Personal Expense", "required": false }, { "value": "Equity.Equity.AccumulatedOtherComprehensiveIncome", "type": "String", "displayName": "Accumulated Other Comprehensive Income", "required": false }, { "value": "Equity.Equity.CalledUpShareCapital", "type": "String", "displayName": "Called Up Share Capital", "required": false }, { "value": "Equity.Equity.CapitalReserves", "type": "String", "displayName": "Capital Reserves", "required": false }, { "value": "Equity.Equity.DividendDisbursed", "type": "String", "displayName": "Dividend Disbursed", "required": false }, { "value": "Equity.Equity.EquityInEarningsOfSubsiduaries", "type": "String", "displayName": "Equity In Earnings Of Subsiduaries", "required": false }, { "value": "Equity.Equity.InvestmentGrants", "type": "String", "displayName": "Investment Grants", "required": false }, { "value": "Equity.Equity.MoneyReceivedAgainstShareWarrants", "type": "String", "displayName": "Money Received Against Share Warrants", "required": false }, { "value": "Equity.Equity.OtherFreeReserves", "type": "String", "displayName": "Other Free Reserves", "required": false }, { "value": "Equity.Equity.ShareApplicationMoneyPendingAllotment", "type": "String", "displayName": "Share Application Money Pending Allotment", "required": false }, { "value": "Equity.Equity.ShareCapital", "type": "String", "displayName": "Share Capital", "required": false }, { "value": "Equity.Equity.Funds", "type": "String", "displayName": "Funds", "required": false } ], "required": true } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": false, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "If included must have a length between 1 and 7 characters" } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Must have a length between 1 and 100 characters" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "When not specified company base currency will be used" } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Bank.CashOnHand", "type": "String", "displayName": "Cash On Hand", "required": false }, { "value": "Asset.Bank.Checking", "type": "String", "displayName": "Checking", "required": false }, { "value": "Asset.Bank.MoneyMarket", "type": "String", "displayName": "Money Market", "required": false }, { "value": "Asset.Bank.RentsHeldInTrust", "type": "String", "displayName": "Rents Held In Trust", "required": false }, { "value": "Asset.Bank.Savings", "type": "String", "displayName": "Savings", "required": false }, { "value": "Asset.Bank.TrustAccounts", "type": "String", "displayName": "Trust Accounts", "required": false }, { "value": "Asset.Bank.CashAndCashEquivalents", "type": "String", "displayName": "Cash And Cash Equivalents", "required": false }, { "value": "Asset.Bank.OtherEarmarkedBankAccounts", "type": "String", "displayName": "Other Earmarked Bank Accounts", "required": false }, { "value": "Asset.Other Current Asset.AllowanceForBadDebts", "type": "String", "displayName": "Allowance For Bad Debts", "required": false }, { "value": "Asset.Other Current Asset.DevelopmentCosts", "type": "String", "displayName": "Development Costs", "required": false }, { "value": "Asset.Other Current Asset.EmployeeCashAdvances", "type": "String", "displayName": "Employee Cash Advances", "required": false }, { "value": "Asset.Other Current Asset.OtherCurrentAssets", "type": "String", "displayName": "Other Current Assets", "required": false }, { "value": "Asset.Other Current Asset.Inventory", "type": "String", "displayName": "Inventory", "required": false }, { "value": "Asset.Other Current Asset.Investment_MortgageRealEstateLoans", "type": "String", "displayName": "Investment Mortgage Real Estate Loans", "required": false }, { "value": "Asset.Other Current Asset.Investment_Other", "type": "String", "displayName": "Investment Other", "required": false }, { "value": "Asset.Other Current Asset.Investment_TaxExemptSecurities", "type": "String", "displayName": "Investment Tax Exempt Securities", "required": false }, { "value": "Asset.Other Current Asset.Investment_USGovernmentObligations", "type": "String", "displayName": "Investment US Government Obligations", "required": false }, { "value": "Asset.Other Current Asset.LoansToOfficers", "type": "String", "displayName": "Loans To Officers", "required": false }, { "value": "Asset.Other Current Asset.LoansToOthers", "type": "String", "displayName": "Loans To Others", "required": false }, { "value": "Asset.Other Current Asset.LoansToStockholders", "type": "String", "displayName": "Loans To Stockholders", "required": false }, { "value": "Asset.Other Current Asset.PrepaidExpenses", "type": "String", "displayName": "Prepaid Expenses", "required": false }, { "value": "Asset.Other Current Asset.Retainage", "type": "String", "displayName": "Retainage", "required": false }, { "value": "Asset.Other Current Asset.UndepositedFunds", "type": "String", "displayName": "Undeposited Funds", "required": false }, { "value": "Asset.Other Current Asset.AssetsAvailableForSale", "type": "String", "displayName": "Assets Available For Sale", "required": false }, { "value": "Asset.Other Current Asset.BalWithGovtAuthorities", "type": "String", "displayName": "Balance With Govt Authorities", "required": false }, { "value": "Asset.Other Current Asset.CalledUpShareCapitalNotPaid", "type": "String", "displayName": "Called Up Share Capital Not Paid", "required": false }, { "value": "Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit", "type": "String", "displayName": "Expenditure Authorisations And Letters Of Credit", "required": false }, { "value": "Asset.Other Current Asset.GlobalTaxDeferred", "type": "String", "displayName": "Global Tax Deferred", "required": false }, { "value": "Asset.Other Current Asset.GlobalTaxRefund", "type": "String", "displayName": "Global Tax Refund", "required": false }, { "value": "Asset.Other Current Asset.InternalTransfers", "type": "String", "displayName": "Internal Transfers", "required": false }, { "value": "Asset.Other Current Asset.OtherConsumables", "type": "String", "displayName": "Other Consumables", "required": false }, { "value": "Asset.Other Current Asset.ProvisionsCurrentAssets", "type": "String", "displayName": "Provisions Current Assets", "required": false }, { "value": "Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties", "type": "String", "displayName": "Short Term Investments In Related Parties", "required": false }, { "value": "Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties", "type": "String", "displayName": "Short Term Loans And Advances To Related Parties", "required": false }, { "value": "Asset.Other Current Asset.TradeAndOtherReceivables", "type": "String", "displayName": "Trade And Other Receivables", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedDepletion", "type": "String", "displayName": "Accumulated Depletion", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedDepreciation", "type": "String", "displayName": "Accumulated Depreciation", "required": false }, { "value": "Asset.Fixed Asset.DepletableAssets", "type": "String", "displayName": "Depletable Assets", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetComputers", "type": "String", "displayName": "Fixed Asset Computers", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetCopiers", "type": "String", "displayName": "Fixed Asset Copiers", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetFurniture", "type": "String", "displayName": "Fixed Asset Furniture", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetPhone", "type": "String", "displayName": "Fixed Asset Phone", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetPhotoVideo", "type": "String", "displayName": "Fixed Asset Photo Video", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetSoftware", "type": "String", "displayName": "Fixed Asset Software", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetOtherToolsEquipment", "type": "String", "displayName": "Fixed Asset Other Tools Equipment", "required": false }, { "value": "Asset.Fixed Asset.FurnitureAndFixtures", "type": "String", "displayName": "Furniture And Fixtures", "required": false }, { "value": "Asset.Fixed Asset.Land", "type": "String", "displayName": "Land", "required": false }, { "value": "Asset.Fixed Asset.LeaseholdImprovements", "type": "String", "displayName": "Leasehold Improvements", "required": false }, { "value": "Asset.Fixed Asset.OtherFixedAssets", "type": "String", "displayName": "Other Fixed Assets", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedAmortization", "type": "String", "displayName": "Accumulated Amortization", "required": false }, { "value": "Asset.Fixed Asset.Buildings", "type": "String", "displayName": "Buildings", "required": false }, { "value": "Asset.Fixed Asset.IntangibleAssets", "type": "String", "displayName": "Intangible Assets", "required": false }, { "value": "Asset.Fixed Asset.MachineryAndEquipment", "type": "String", "displayName": "Machinery And Equipment", "required": false }, { "value": "Asset.Fixed Asset.Vehicles", "type": "String", "displayName": "Vehicles", "required": false }, { "value": "Asset.Fixed Asset.AssetsInCourseOfConstruction", "type": "String", "displayName": "Assets In Course Of Construction", "required": false }, { "value": "Asset.Fixed Asset.CapitalWip", "type": "String", "displayName": "Capital Wip", "required": false }, { "value": "Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets", "type": "String", "displayName": "Cumulative Depreciation On Intangible Assets", "required": false }, { "value": "Asset.Fixed Asset.IntangibleAssetsUnderDevelopment", "type": "String", "displayName": "Intangible Assets Under Development", "required": false }, { "value": "Asset.Fixed Asset.LandAsset", "type": "String", "displayName": "Land Asset", "required": false }, { "value": "Asset.Fixed Asset.NonCurrentAssets", "type": "String", "displayName": "Non Current Assets", "required": false }, { "value": "Asset.Fixed Asset.ParticipatingInterests", "type": "String", "displayName": "Participating Interests", "required": false }, { "value": "Asset.Fixed Asset.ProvisionsFixedAssets", "type": "String", "displayName": "Provisions Fixed Assets", "required": false }, { "value": "Asset.Other Asset.LeaseBuyout", "type": "String", "displayName": "Lease Buyout", "required": false }, { "value": "Asset.Other Asset.OtherLongTermAssets", "type": "String", "displayName": "Other Long Term Assets", "required": false }, { "value": "Asset.Other Asset.SecurityDeposits", "type": "String", "displayName": "Security Deposits", "required": false }, { "value": "Asset.Other Asset.AccumulatedAmortizationOfOtherAssets", "type": "String", "displayName": "Accumulated Amortization Of Other Assets", "required": false }, { "value": "Asset.Other Asset.Goodwill", "type": "String", "displayName": "Goodwill", "required": false }, { "value": "Asset.Other Asset.Licenses", "type": "String", "displayName": "Licenses", "required": false }, { "value": "Asset.Other Asset.OrganizationalCosts", "type": "String", "displayName": "Organizational Costs", "required": false }, { "value": "Asset.Other Asset.AssetsHeldForSale", "type": "String", "displayName": "Assets Held For Sale", "required": false }, { "value": "Asset.Other Asset.AvailableForSaleFinancialAssets", "type": "String", "displayName": "Available For Sale Financial Assets", "required": false }, { "value": "Asset.Other Asset.DeferredTax", "type": "String", "displayName": "Deferred Tax", "required": false }, { "value": "Asset.Other Asset.Investments", "type": "String", "displayName": "Investments", "required": false }, { "value": "Asset.Other Asset.LongTermInvestments", "type": "String", "displayName": "Long Term Investments", "required": false }, { "value": "Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties", "type": "String", "displayName": "Long Term Loans And Advances To Related Parties", "required": false }, { "value": "Asset.Other Asset.OtherIntangibleAssets", "type": "String", "displayName": "Other Intangible Assets", "required": false }, { "value": "Asset.Other Asset.OtherLongTermInvestments", "type": "String", "displayName": "Other Long Term Investments", "required": false }, { "value": "Asset.Other Asset.OtherLongTermLoansAndAdvances", "type": "String", "displayName": "Other Long Term Loans And Advances", "required": false }, { "value": "Asset.Other Asset.PrepaymentsAndAccruedIncome", "type": "String", "displayName": "Prepayments And Accrued Income", "required": false }, { "value": "Asset.Other Asset.ProvisionsNonCurrentAssets", "type": "String", "displayName": "Provisions Non-Current Assets", "required": false }, { "value": "Asset.Accounts Receivable.AccountsReceivable", "type": "String", "displayName": "Accounts Receivable", "required": false }, { "value": "Expense.Expense.AdvertisingPromotional", "type": "String", "displayName": "Advertising/Promotional", "required": false }, { "value": "Expense.Expense.BadDebts", "type": "String", "displayName": "Bad Debts", "required": false }, { "value": "Expense.Expense.BankCharges", "type": "String", "displayName": "Bank Charges", "required": false }, { "value": "Expense.Expense.CharitableContributions", "type": "String", "displayName": "Charitable Contributions", "required": false }, { "value": "Expense.Expense.CommissionsAndFees", "type": "String", "displayName": "Commissions And Fees", "required": false }, { "value": "Expense.Expense.Entertainment", "type": "String", "displayName": "Entertainment", "required": false }, { "value": "Expense.Expense.EntertainmentMeals", "type": "String", "displayName": "Entertainment Meals", "required": false }, { "value": "Expense.Expense.EquipmentRental", "type": "String", "displayName": "Equipment Rental", "required": false }, { "value": "Expense.Expense.FinanceCosts", "type": "String", "displayName": "Finance Costs", "required": false }, { "value": "Expense.Expense.GlobalTaxExpense", "type": "String", "displayName": "Global Tax Expense", "required": false }, { "value": "Expense.Expense.Insurance", "type": "String", "displayName": "Insurance", "required": false }, { "value": "Expense.Expense.InterestPaid", "type": "String", "displayName": "Interest Paid", "required": false }, { "value": "Expense.Expense.LegalProfessionalFees", "type": "String", "displayName": "Legal And Professional Fees", "required": false }, { "value": "Expense.Expense.OfficeExpenses", "type": "String", "displayName": "Office Expenses", "required": false }, { "value": "Expense.Expense.OfficeGeneralAdministrativeExpenses", "type": "String", "displayName": "Office/General Administrative Expenses", "required": false }, { "value": "Expense.Expense.OtherBusinessExpenses", "type": "String", "displayName": "Other Business Expenses", "required": false }, { "value": "Expense.Expense.OtherMiscellaneousServiceCost", "type": "String", "displayName": "Other Miscellaneous Service Cost", "required": false }, { "value": "Expense.Expense.PromotionalMeals", "type": "String", "displayName": "Promotional Meals", "required": false }, { "value": "Expense.Expense.RentOrLeaseOfBuildings", "type": "String", "displayName": "Rent Or Lease Of Buildings", "required": false }, { "value": "Expense.Expense.RepairMaintenance", "type": "String", "displayName": "Repair And Maintenance", "required": false }, { "value": "Expense.Expense.ShippingFreightDelivery", "type": "String", "displayName": "Shipping, Freight And Delivery", "required": false }, { "value": "Expense.Expense.SuppliesMaterials", "type": "String", "displayName": "Supplies And Materials", "required": false }, { "value": "Expense.Expense.Travel", "type": "String", "displayName": "Travel", "required": false }, { "value": "Expense.Expense.TravelMeals", "type": "String", "displayName": "Travel Meals", "required": false }, { "value": "Expense.Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Expense.Auto", "type": "String", "displayName": "Auto", "required": false }, { "value": "Expense.Expense.CostOfLabor", "type": "String", "displayName": "Cost Of Labor", "required": false }, { "value": "Expense.Expense.DuesSubscriptions", "type": "String", "displayName": "Dues And Subscriptions", "required": false }, { "value": "Expense.Expense.PayrollExpenses", "type": "String", "displayName": "Payroll Expenses", "required": false }, { "value": "Expense.Expense.TaxesPaid", "type": "String", "displayName": "Taxes Paid", "required": false }, { "value": "Expense.Expense.UnappliedCashBillPaymentExpense", "type": "String", "displayName": "Unapplied Cash Bill Payment Expense", "required": false }, { "value": "Expense.Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Expense.AmortizationExpense", "type": "String", "displayName": "Amortization Expense", "required": false }, { "value": "Expense.Expense.AppropriationsToDepreciation", "type": "String", "displayName": "Appropriations To Depreciation", "required": false }, { "value": "Expense.Expense.BorrowingCost", "type": "String", "displayName": "Borrowing Cost", "required": false }, { "value": "Expense.Expense.CommissionsAndFees", "type": "String", "displayName": "Commissions And Fees", "required": false }, { "value": "Expense.Expense.DistributionCosts", "type": "String", "displayName": "Distribution Costs", "required": false }, { "value": "Expense.Expense.ExternalServices", "type": "String", "displayName": "External Services", "required": false }, { "value": "Expense.Expense.ExtraordinaryCharges", "type": "String", "displayName": "Extraordinary Charges", "required": false }, { "value": "Expense.Expense.IncomeTaxExpense", "type": "String", "displayName": "Income Tax Expense", "required": false }, { "value": "Expense.Expense.LossOnDiscontinuedOperationsNetOfTax", "type": "String", "displayName": "Loss On Discontinued Operations Net Of Tax", "required": false }, { "value": "Expense.Expense.ManagementCompensation", "type": "String", "displayName": "Management Compensation", "required": false }, { "value": "Expense.Expense.OtherCurrentOperatingCharges", "type": "String", "displayName": "Other Current Operating Charges", "required": false }, { "value": "Expense.Expense.OtherExternalServices", "type": "String", "displayName": "Other External Services", "required": false }, { "value": "Expense.Expense.OtherRentalCosts", "type": "String", "displayName": "Other Rental Costs", "required": false }, { "value": "Expense.Expense.OtherSellingExpenses", "type": "String", "displayName": "Other Selling Expenses", "required": false }, { "value": "Expense.Expense.ProjectStudiesSurveysAssessments", "type": "String", "displayName": "Project Studies Surveys Assessments", "required": false }, { "value": "Expense.Expense.PurchasesRebates", "type": "String", "displayName": "Purchases Rebates", "required": false }, { "value": "Expense.Expense.ShippingAndDeliveryExpense", "type": "String", "displayName": "Shipping And Delivery Expense", "required": false }, { "value": "Expense.Expense.StaffCosts", "type": "String", "displayName": "Staff Costs", "required": false }, { "value": "Expense.Expense.Sundry", "type": "String", "displayName": "Sundry", "required": false }, { "value": "Expense.Expense.TravelExpensesGeneralAndAdminExpenses", "type": "String", "displayName": "Travel Expenses General And Admin Expenses", "required": false }, { "value": "Expense.Expense.TravelExpensesSellingExpense", "type": "String", "displayName": "Travel Expenses Selling Expense", "required": false }, { "value": "Expense.Other Expense.Depreciation", "type": "String", "displayName": "Depreciation", "required": false }, { "value": "Expense.Other Expense.ExchangeGainOrLoss", "type": "String", "displayName": "Exchange Gain Or Loss", "required": false }, { "value": "Expense.Other Expense.OtherMiscellaneousExpense", "type": "String", "displayName": "Other Miscellaneous Expense", "required": false }, { "value": "Expense.Other Expense.PenaltiesSettlements", "type": "String", "displayName": "Penalties And Settlements", "required": false }, { "value": "Expense.Other Expense.Amortization", "type": "String", "displayName": "Amortization", "required": false }, { "value": "Expense.Other Expense.GasAndFuel", "type": "String", "displayName": "Gas And Fuel", "required": false }, { "value": "Expense.Other Expense.HomeOffice", "type": "String", "displayName": "Home Office", "required": false }, { "value": "Expense.Other Expense.HomeOwnerRentalInsurance", "type": "String", "displayName": "Home Owner Rental Insurance", "required": false }, { "value": "Expense.Other Expense.OtherHomeOfficeExpenses", "type": "String", "displayName": "Other Home Office Expenses", "required": false }, { "value": "Expense.Other Expense.MortgageInterest", "type": "String", "displayName": "Mortgage Interest", "required": false }, { "value": "Expense.Other Expense.RentAndLease", "type": "String", "displayName": "Rent And Lease", "required": false }, { "value": "Expense.Other Expense.RepairsAndMaintenance", "type": "String", "displayName": "Repairs And Maintenance", "required": false }, { "value": "Expense.Other Expense.ParkingAndTolls", "type": "String", "displayName": "Parking And Tolls", "required": false }, { "value": "Expense.Other Expense.Vehicle", "type": "String", "displayName": "Vehicle", "required": false }, { "value": "Expense.Other Expense.VehicleInsurance", "type": "String", "displayName": "Vehicle Insurance", "required": false }, { "value": "Expense.Other Expense.VehicleLease", "type": "String", "displayName": "Vehicle Lease", "required": false }, { "value": "Expense.Other Expense.VehicleLoanInterest", "type": "String", "displayName": "Vehicle Loan Interest", "required": false }, { "value": "Expense.Other Expense.VehicleLoan", "type": "String", "displayName": "Vehicle Loan", "required": false }, { "value": "Expense.Other Expense.VehicleRegistration", "type": "String", "displayName": "Vehicle Registration", "required": false }, { "value": "Expense.Other Expense.VehicleRepairs", "type": "String", "displayName": "Vehicle Repairs", "required": false }, { "value": "Expense.Other Expense.OtherVehicleExpenses", "type": "String", "displayName": "Other Vehicle Expenses", "required": false }, { "value": "Expense.Other Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Other Expense.WashAndRoadServices", "type": "String", "displayName": "Wash And Road Services", "required": false }, { "value": "Expense.Other Expense.DeferredTaxExpense", "type": "String", "displayName": "Deferred Tax Expense", "required": false }, { "value": "Expense.Other Expense.Depletion", "type": "String", "displayName": "Depletion", "required": false }, { "value": "Expense.Other Expense.ExceptionalItems", "type": "String", "displayName": "Exceptional Items", "required": false }, { "value": "Expense.Other Expense.ExtraordinaryItems", "type": "String", "displayName": "Extraordinary Items", "required": false }, { "value": "Expense.Other Expense.IncomeTaxOtherExpense", "type": "String", "displayName": "Income Tax Other Expense", "required": false }, { "value": "Expense.Other Expense.MatCredit", "type": "String", "displayName": "Mat Credit", "required": false }, { "value": "Expense.Other Expense.PriorPeriodItems", "type": "String", "displayName": "Prior Period Items", "required": false }, { "value": "Expense.Other Expense.TaxRoundoffGainOrLoss", "type": "String", "displayName": "Tax Roundoff Gain Or Loss", "required": false }, { "value": "Expense.Cost of Goods Sold.EquipmentRentalCos", "type": "String", "displayName": "Equipment Rental - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.OtherCostsOfServiceCos", "type": "String", "displayName": "Other Costs Of Sales - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.ShippingFreightDeliveryCos", "type": "String", "displayName": "Shipping, Freight And Delivery - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.SuppliesMaterialsCogs", "type": "String", "displayName": "Supplies And Materials - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.CostOfLaborCos", "type": "String", "displayName": "Cost Of Labor - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.CostOfSales", "type": "String", "displayName": "Cost Of Sales", "required": false }, { "value": "Expense.Cost of Goods Sold.FreightAndDeliveryCost", "type": "String", "displayName": "Freight And Delivery Cost", "required": false }, { "value": "Income.Income.NonProfitIncome", "type": "String", "displayName": "Non Profit Income", "required": false }, { "value": "Income.Income.OtherPrimaryIncome", "type": "String", "displayName": "Other Primary Income", "required": false }, { "value": "Income.Income.SalesOfProductIncome", "type": "String", "displayName": "Sales Of ProductIncome", "required": false }, { "value": "Income.Income.ServiceFeeIncome", "type": "String", "displayName": "Service Fee Income", "required": false }, { "value": "Income.Income.DiscountsRefundsGiven", "type": "String", "displayName": "Discounts Refunds Given", "required": false }, { "value": "Income.Income.UnappliedCashPaymentIncome", "type": "String", "displayName": "Unapplied Cash Payment Income", "required": false }, { "value": "Income.Income.CashReceiptIncome", "type": "String", "displayName": "Cash Receipt Income", "required": false }, { "value": "Income.Income.OperatingGrants", "type": "String", "displayName": "Operating Grants", "required": false }, { "value": "Income.Income.OtherCurrentOperatingIncome", "type": "String", "displayName": "Other Current Operating Income", "required": false }, { "value": "Income.Income.OwnWorkCapitalized", "type": "String", "displayName": "Own Work Capitalized", "required": false }, { "value": "Income.Income.RevenueGeneral", "type": "String", "displayName": "Revenue General", "required": false }, { "value": "Income.Income.SalesRetail", "type": "String", "displayName": "Sales Retail", "required": false }, { "value": "Income.Income.SalesWholesale", "type": "String", "displayName": "Sales Wholesale", "required": false }, { "value": "Income.Income.SavingsByTaxScheme", "type": "String", "displayName": "Savings By Tax Scheme", "required": false }, { "value": "Income.Other Income.DividendIncome", "type": "String", "displayName": "Dividend Income", "required": false }, { "value": "Income.Other Income.InterestEarned", "type": "String", "displayName": "Interest Earned", "required": false }, { "value": "Income.Other Income.OtherInvestmentIncome", "type": "String", "displayName": "Other Investment Income", "required": false }, { "value": "Income.Other Income.OtherMiscellaneousIncome", "type": "String", "displayName": "Other Miscellaneous Income", "required": false }, { "value": "Income.Other Income.TaxExemptInterest", "type": "String", "displayName": "Tax Exempt Interest", "required": false }, { "value": "Income.Other Income.GainLossOnSaleOfFixedAssets", "type": "String", "displayName": "Gain Loss On Sale Of Fixed Assets", "required": false }, { "value": "Income.Other Income.GainLossOnSaleOfInvestments", "type": "String", "displayName": "Gain Loss On Sale Of Investments", "required": false }, { "value": "Income.Other Income.LossOnDisposalOfAssets", "type": "String", "displayName": "Loss On Disposal Of Assets", "required": false }, { "value": "Income.Other Income.OtherOperatingIncome", "type": "String", "displayName": "Other Operating Income", "required": false }, { "value": "Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax", "type": "String", "displayName": "Unrealised Loss On Securities Net Of Tax", "required": false }, { "value": "Liability.Accounts Payable.AccountsPayable", "type": "String", "displayName": "Accounts Payable", "required": false }, { "value": "Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise", "type": "String", "displayName": "Outstanding Dues Micro Small Enterprise", "required": false }, { "value": "Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise", "type": "String", "displayName": "Outstanding Dues Other Than Micro Small Enterprise", "required": false }, { "value": "Liability.Credit Card.CreditCard", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "Liability.Long Term Liability.NotesPayable", "type": "String", "displayName": "Notes Payable", "required": false }, { "value": "Liability.Long Term Liability.OtherLongTermLiabilities", "type": "String", "displayName": "Other Long Term Liabilities", "required": false }, { "value": "Liability.Long Term Liability.ShareholderNotesPayable", "type": "String", "displayName": "Shareholder Notes Payable", "required": false }, { "value": "Liability.Long Term Liability.AccrualsAndDeferredIncome", "type": "String", "displayName": "Accruals And Deferred Income", "required": false }, { "value": "Liability.Long Term Liability.AccruedLongLermLiabilities", "type": "String", "displayName": "Accrued Long Lerm Liabilities", "required": false }, { "value": "Liability.Long Term Liability.AccruedVacationPayable", "type": "String", "displayName": "Accrued Vacation Payable", "required": false }, { "value": "Liability.Long Term Liability.BankLoans", "type": "String", "displayName": "Bank Loans", "required": false }, { "value": "Liability.Long Term Liability.DebtsRelatedToParticipatingInterests", "type": "String", "displayName": "Debts Related To Participating Interests", "required": false }, { "value": "Liability.Long Term Liability.DeferredTaxLiabilities", "type": "String", "displayName": "Deferred Tax Liabilities", "required": false }, { "value": "Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities", "type": "String", "displayName": "Government And Other Public Authorities", "required": false }, { "value": "Liability.Long Term Liability.GroupAndAssociates", "type": "String", "displayName": "Group And Associates", "required": false }, { "value": "Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale", "type": "String", "displayName": "Liabilities Related To Assets Held For Sale", "required": false }, { "value": "Liability.Long Term Liability.LongTermBorrowings", "type": "String", "displayName": "Long Term Borrowings", "required": false }, { "value": "Liability.Long Term Liability.LongTermDebit", "type": "String", "displayName": "Long Term Debit", "required": false }, { "value": "Liability.Long Term Liability.LongTermEmployeeBenefitObligations", "type": "String", "displayName": "Long Term Employee Benefit Obligations", "required": false }, { "value": "Liability.Long Term Liability.ObligationsUnderFinanceLeases", "type": "String", "displayName": "Obligations Under Finance Leases", "required": false }, { "value": "Liability.Long Term Liability.OtherLongTermProvisions", "type": "String", "displayName": "Other Long Term Provisions", "required": false }, { "value": "Liability.Long Term Liability.ProvisionForLiabilities", "type": "String", "displayName": "Provision For Liabilities", "required": false }, { "value": "Liability.Long Term Liability.ProvisionsNonCurrentLiabilities", "type": "String", "displayName": "Provisions Non Current Liabilities", "required": false }, { "value": "Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts", "type": "String", "displayName": "Staff And Related Long Term Liability Accounts", "required": false }, { "value": "Liability.Other Current Liability.DirectDepositPayable", "type": "String", "displayName": "Direct Deposit Payable", "required": false }, { "value": "Liability.Other Current Liability.LineOfCredit", "type": "String", "displayName": "Line Of Credit", "required": false }, { "value": "Liability.Other Current Liability.LoanPayable", "type": "String", "displayName": "Loan Payable", "required": false }, { "value": "Liability.Other Current Liability.GlobalTaxPayable", "type": "String", "displayName": "Global Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.GlobalTaxSuspense", "type": "String", "displayName": "Global Tax Suspense", "required": false }, { "value": "Liability.Other Current Liability.OtherCurrentLiabilities", "type": "String", "displayName": "Other Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.PayrollClearing", "type": "String", "displayName": "Payroll Clearing", "required": false }, { "value": "Liability.Other Current Liability.PayrollTaxPayable", "type": "String", "displayName": "Payroll Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.PrepaidExpensesPayable", "type": "String", "displayName": "Prepaid Expenses Payable", "required": false }, { "value": "Liability.Other Current Liability.RentsInTrustLiability", "type": "String", "displayName": "Rents In Trust Liability", "required": false }, { "value": "Liability.Other Current Liability.TrustAccountsLiabilities", "type": "String", "displayName": "Trust Accounts Liabilities", "required": false }, { "value": "Liability.Other Current Liability.FederalIncomeTaxPayable", "type": "String", "displayName": "Federal Income Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.InsurancePayable", "type": "String", "displayName": "Insurance Payable", "required": false }, { "value": "Liability.Other Current Liability.SalesTaxPayable", "type": "String", "displayName": "Sales Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.StateLocalIncomeTaxPayable", "type": "String", "displayName": "State Local Income Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.AccruedLiabilities", "type": "String", "displayName": "Accrued Liabilities", "required": false }, { "value": "Liability.Other Current Liability.CurrentLiabilities", "type": "String", "displayName": "Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations", "type": "String", "displayName": "Current Portion EmployeeBenefits Obligations", "required": false }, { "value": "Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases", "type": "String", "displayName": "Current Portion Of Obligations Under Finance Leases", "required": false }, { "value": "Liability.Other Current Liability.CurrentTaxLiability", "type": "String", "displayName": "Current Tax Liability", "required": false }, { "value": "Liability.Other Current Liability.DividendsPayable", "type": "String", "displayName": "Dividends Payable", "required": false }, { "value": "Liability.Other Current Liability.DutiesAndTaxes", "type": "String", "displayName": "Duties And Taxes", "required": false }, { "value": "Liability.Other Current Liability.InterestPayables", "type": "String", "displayName": "Interest Payables", "required": false }, { "value": "Liability.Other Current Liability.ProvisionForWarrantyObligations", "type": "String", "displayName": "Provision For Warranty Obligations", "required": false }, { "value": "Liability.Other Current Liability.ProvisionsCurrentLiabilities", "type": "String", "displayName": "Provisions Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.ShortTermBorrowings", "type": "String", "displayName": "Short Term Borrowings", "required": false }, { "value": "Liability.Other Current Liability.SocialSecurityAgencies", "type": "String", "displayName": "Social Security Agencies", "required": false }, { "value": "Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts", "type": "String", "displayName": "Staff And Related Liability Accounts", "required": false }, { "value": "Liability.Other Current Liability.SundryDebtorsAndCreditors", "type": "String", "displayName": "Sundry Debtors And Creditors", "required": false }, { "value": "Liability.Other Current Liability.TradeAndOtherPayables", "type": "String", "displayName": "Trade And Other Payables", "required": false }, { "value": "Equity.Equity.OpeningBalanceEquity", "type": "String", "displayName": "Opening Balance Equity", "required": false }, { "value": "Equity.Equity.PartnersEquity", "type": "String", "displayName": "Partners Equity", "required": false }, { "value": "Equity.Equity.RetainedEarnings", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Equity.Equity.AccumulatedAdjustment", "type": "String", "displayName": "Accumulated Adjustment", "required": false }, { "value": "Equity.Equity.OwnersEquity", "type": "String", "displayName": "Owners Equity", "required": false }, { "value": "Equity.Equity.PaidInCapitalOrSurplus", "type": "String", "displayName": "Paid In Capital Or Surplus", "required": false }, { "value": "Equity.Equity.PartnerContributions", "type": "String", "displayName": "Partner Contributions", "required": false }, { "value": "Equity.Equity.PartnerDistributions", "type": "String", "displayName": "Partner Distributions", "required": false }, { "value": "Equity.Equity.PreferredStock", "type": "String", "displayName": "Preferred Stock", "required": false }, { "value": "Equity.Equity.CommonStock", "type": "String", "displayName": "Common Stock", "required": false }, { "value": "Equity.Equity.TreasuryStock", "type": "String", "displayName": "Treasury Stock", "required": false }, { "value": "Equity.Equity.EstimatedTaxes", "type": "String", "displayName": "Estimated Taxes", "required": false }, { "value": "Equity.Equity.Healthcare", "type": "String", "displayName": "Healthcare", "required": false }, { "value": "Equity.Equity.PersonalIncome", "type": "String", "displayName": "Personal Income", "required": false }, { "value": "Equity.Equity.PersonalExpense", "type": "String", "displayName": "Personal Expense", "required": false }, { "value": "Equity.Equity.AccumulatedOtherComprehensiveIncome", "type": "String", "displayName": "Accumulated Other Comprehensive Income", "required": false }, { "value": "Equity.Equity.CalledUpShareCapital", "type": "String", "displayName": "Called Up Share Capital", "required": false }, { "value": "Equity.Equity.CapitalReserves", "type": "String", "displayName": "Capital Reserves", "required": false }, { "value": "Equity.Equity.DividendDisbursed", "type": "String", "displayName": "Dividend Disbursed", "required": false }, { "value": "Equity.Equity.EquityInEarningsOfSubsiduaries", "type": "String", "displayName": "Equity In Earnings Of Subsiduaries", "required": false }, { "value": "Equity.Equity.InvestmentGrants", "type": "String", "displayName": "Investment Grants", "required": false }, { "value": "Equity.Equity.MoneyReceivedAgainstShareWarrants", "type": "String", "displayName": "Money Received Against Share Warrants", "required": false }, { "value": "Equity.Equity.OtherFreeReserves", "type": "String", "displayName": "Other Free Reserves", "required": false }, { "value": "Equity.Equity.ShareApplicationMoneyPendingAllotment", "type": "String", "displayName": "Share Application Money Pending Allotment", "required": false }, { "value": "Equity.Equity.ShareCapital", "type": "String", "displayName": "Share Capital", "required": false }, { "value": "Equity.Equity.Funds", "type": "String", "displayName": "Funds", "required": false } ], "required": true } }, "required": true } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "Name", "details": "Should not be longer than 200 characters." } ] } }, "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "Should be a number between 1 and 99999999." } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "SALES", "type": "String", "displayName": "Sales", "required": false }, { "value": "OTHER_INCOME", "type": "String", "displayName": "Other Income", "required": false }, { "value": "DIRECT_EXPENSES", "type": "String", "displayName": "Direct Expenses", "required": false }, { "value": "OVERHEADS", "type": "String", "displayName": "Overheads", "required": false }, { "value": "DEPRECIATION", "type": "String", "displayName": "Depreciation", "required": false }, { "value": "CURRENT_ASSETS", "type": "String", "displayName": "Current Assets", "required": false }, { "value": "FIXED_ASSETS", "type": "String", "displayName": "Fixed Assets", "required": false }, { "value": "FUTURE_ASSETS", "type": "String", "displayName": "Future Assets", "required": false }, { "value": "BANK", "type": "String", "displayName": "Bank", "required": false }, { "value": "CURRENT_LIABILITY", "type": "String", "displayName": "Current Liability", "required": false }, { "value": "FUTURE_LIABILITY", "type": "String", "displayName": "Future Liability", "required": false }, { "value": "EQUITY", "type": "String", "displayName": "Equity", "required": false }, { "value": "LINE_OF_CREDIT", "type": "String", "displayName": "Credit Card / Loan", "required": false } ], "required": true } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "Must be unique within the entity." }, { "field": "NominalCode", "details": "Must be at most 24 characters in length, although restrictions may vary between entities." } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "type": { "type": "String", "displayName": "Account Type", "description": "The type, or base category, of the account", "options": [ { "value": "Asset", "type": "String", "displayName": "Asset", "required": false }, { "value": "Equity", "type": "String", "displayName": "Equity", "required": false }, { "value": "Expense", "type": "String", "displayName": "Expense", "required": false }, { "value": "Income", "type": "String", "displayName": "Income", "required": false }, { "value": "Liability", "type": "String", "displayName": "Liability", "required": false } ], "required": true }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "required": true, "validation": { "warnings": [], "information": [ { "field": "FullyQualifiedCategory", "details": "Any category that is part of the hierarchy of one of: 'Assets', 'Equity', 'Liabilities', 'Total Expenses' and 'Total Income' is permitted." } ] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true }, "description": { "type": "String", "displayName": "Description", "description": "Description of the account", "required": true }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "required": true }, "fullyQualifiedName": { "type": "String", "displayName": "Fully Qualified Name", "description": "The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the account", "required": true }, "currentBalance": { "type": "Number", "displayName": "Current Balance", "description": "The current balance in the account", "required": true }, "type": { "type": "String", "displayName": "Account Type", "description": "The type, or base category, of the account", "required": true }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "required": true }, "isBankAccount": { "type": "Boolean", "displayName": "Is Bank Account?", "description": "Confirms whether the nominal account represents a bank account or not", "required": true }, "validDatatypeLinks": { "type": "Array", "displayName": "Valid Datatype Links", "description": "Describes which fields on other data types are valid links to this account in the originating system", "properties": { "property": { "type": "String", "displayName": "Property", "description": "The field on the source data type that other data types can link to", "required": true }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id", "required": true } }, "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "Identifier for the nominal account.", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "Max length of 10 characters." } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of account as it appears in the chart of accounts or general ledger.", "required": true, "validation": { "warnings": [], "information": [ { "field": "Name", "details": "Payments are enabled to this account if the name ends in .PaymentsEnabled." } ] } }, "description": { "type": "String", "displayName": "Description", "description": "Description for the nominal account.", "required": false }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "Account type and category for nominal account.", "options": [ { "value": "Asset.Current", "type": "String", "displayName": "Current Asset", "required": false }, { "value": "Asset.Fixed", "type": "String", "displayName": "Fixed Asset", "required": false }, { "value": "Asset.Inventory", "type": "String", "displayName": "Inventory", "required": false }, { "value": "Asset.NonCurrent", "type": "String", "displayName": "Non-current Asset", "required": false }, { "value": "Asset.Prepayment", "type": "String", "displayName": "Prepayment", "required": false }, { "value": "Expense.DirectCosts", "type": "String", "displayName": "Direct Costs", "required": false }, { "value": "Expense.Expense", "type": "String", "displayName": "Expense", "required": false }, { "value": "Expense.Overhead", "type": "String", "displayName": "Overhead", "required": false }, { "value": "Expense.Superannuation", "type": "String", "displayName": "Superannuation", "required": false }, { "value": "Expense.Wages", "type": "String", "displayName": "Wages", "required": false }, { "value": "Income.Sales", "type": "String", "displayName": "Sales", "required": false }, { "value": "Income.Revenue", "type": "String", "displayName": "Revenue", "required": false }, { "value": "Income.Other", "type": "String", "displayName": "Other Income", "required": false }, { "value": "Liability.Current", "type": "String", "displayName": "Current Liability", "required": false }, { "value": "Liability.Depreciation", "type": "String", "displayName": "Depreciation", "required": false }, { "value": "Liability.Liability", "type": "String", "displayName": "Liability", "required": false }, { "value": "Liability.NonCurrent", "type": "String", "displayName": "Non Current Liability", "required": false }, { "value": "Liability.PayAsYouGo", "type": "String", "displayName": "Pay As You Go Liability", "required": false }, { "value": "Liability.Superannuation", "type": "String", "displayName": "Superannuation Liability", "required": false }, { "value": "Liability.WagesPayable", "type": "String", "displayName": "Wages Payable Liability", "required": false }, { "value": "Equity.Equity", "type": "String", "displayName": "Equity", "required": false } ], "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-accounts-model", "description": "The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company and integration.\n \n[Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n \n**Integration-specific behaviour**\n \nSee the *response examples* for integration-specific indicative models.\n \nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/accounts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Accounts" ], "summary": "Create account", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/allowSyncOnPushComplete" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account/definitions/accountPrototype" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create account* endpoint creates a new [account](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-payroll-api#/operations/get-create-chartOfAccounts-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.\n", "operationId": "create-account" } }, "/companies/{companyId}/data/journalEntries": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Journal entries" ], "summary": "List journal entries", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntries" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "770c89bb-3d6a-449a-9243-739378b4cd7d", "postedOn": "2022-04-19T00:00:00", "createdOn": "2022-04-19T00:00:00", "journalRef": { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "name": "General Journal" }, "journalLines": [ { "description": "", "netAmount": 32095.91, "currency": "GBP", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" } }, { "description": "Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "netAmount": -2917.81, "currency": "GBP", "accountRef": { "id": "3a872b81-d1af-4d31-9bfa-a37280b8f68c", "name": "VAT" } }, { "description": "", "netAmount": -29178.09, "currency": "GBP", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" } } ], "modifiedDate": "2023-04-26T12:38:18Z", "recordRef": { "id": "c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "dataType": "directIncomes" }, "metadata": { "isDeleted": false } }, { "id": "9f96606f-6846-40c6-b423-9b1753458e75", "postedOn": "2022-04-19T00:00:00", "createdOn": "2022-04-19T00:00:00", "journalRef": { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "name": "General Journal" }, "journalLines": [ { "description": "", "netAmount": 188.33, "currency": "GBP", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" } }, { "description": "Tax for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197", "netAmount": -17.12, "currency": "GBP", "accountRef": { "id": "3a872b81-d1af-4d31-9bfa-a37280b8f68c", "name": "VAT" } }, { "description": "", "netAmount": -171.21, "currency": "GBP", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" } } ], "modifiedDate": "2023-04-26T12:38:18Z", "recordRef": { "id": "38e8c917-0afc-4583-8ffe-1b53ad601197", "dataType": "directIncomes" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1862, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "START", "postedOn": "2018-12-31T00:00:00", "createdOn": "2018-12-31T00:00:00", "journalRef": { "id": "4caabc3e-3d64-ed11-8c34-000d3a870cba", "name": "DEFAULT" }, "journalLines": [ { "description": "Opening Entry", "netAmount": -69723.14, "currency": "GBP", "accountRef": { "id": "ac1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Retained Earnings" } }, { "description": "Opening Entry", "netAmount": -20000, "currency": "GBP", "accountRef": { "id": "aa1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Share Capital" } }, { "description": "Opening Entry", "netAmount": -2329.42, "currency": "GBP", "accountRef": { "id": "8a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Payable" } }, { "description": "Opening Entry", "netAmount": 3499, "currency": "GBP", "accountRef": { "id": "6e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accumulated Depreciation" } }, { "description": "Opening Entry", "netAmount": 5498, "currency": "GBP", "accountRef": { "id": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Equipment" } }, { "description": "Opening Entry", "netAmount": 28547.16, "currency": "GBP", "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" } }, { "description": "Opening Entry", "netAmount": 31638.4, "currency": "GBP", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" } }, { "description": "Opening Entry", "netAmount": 2870, "currency": "GBP", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" } }, { "description": "Opening Entry", "netAmount": 20000, "currency": "GBP", "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" } } ], "modifiedDate": "2023-03-27T14:21:31Z", "sourceModifiedDate": "2020-07-29T10:56:12Z", "metadata": { "isDeleted": false } }, { "id": "01-2019", "postedOn": "2019-01-01T00:00:00", "createdOn": "2019-01-01T00:00:00", "journalRef": { "id": "4caabc3e-3d64-ed11-8c34-000d3a870cba", "name": "DEFAULT" }, "journalLines": [ { "description": "January 2019", "netAmount": -2000, "currency": "GBP", "accountRef": { "id": "5e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Checking account" } }, { "description": "January 2019", "netAmount": 1000, "currency": "GBP", "accountRef": { "id": "401217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Salaries Expense" } }, { "description": "January 2019", "netAmount": 1000, "currency": "GBP", "accountRef": { "id": "341217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Rent Expense" } } ], "modifiedDate": "2023-03-27T14:21:31Z", "sourceModifiedDate": "2020-07-29T10:56:12Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 825, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "00002c0a-8061-4ad2-84fa-c879eea880a7", "createdOn": "2022-01-11T14:18:54", "updatedOn": "2022-01-11T14:18:54", "journalRef": { "id": "55ff34a3-0857-4202-b7ec-a399cfc26a4e", "name": "Memoriaal" }, "journalLines": [ { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "netAmount": -6.94, "currency": "EUR", "accountRef": { "id": "e0217fbf-8963-4134-80ef-929d5de8612d", "name": "Kosten 13e maand" }, "tracking": { "recordRefs": [] } }, { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "netAmount": 6.94, "currency": "EUR", "accountRef": { "id": "0166c96b-adf2-4667-a755-87e67c741f41", "name": "Resultaat verkoop activa" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:37:10Z", "sourceModifiedDate": "2022-01-11T14:18:54Z" }, { "id": "000154f0-e83a-4012-96a3-7db0b036b96b", "createdOn": "2020-04-22T13:56:46", "updatedOn": "2020-04-22T13:56:46", "journalRef": { "id": "151313ae-55b1-4ba0-b32a-e2ef6a8ce52a", "name": "Nominal Card" }, "journalLines": [ { "description": "Refunds with payment type of Cash", "netAmount": -144.36, "currency": "EUR", "accountRef": { "id": "0741cc89-e33a-4358-bcbd-3acb07b005dc", "name": "Nominal Card" }, "tracking": { "recordRefs": [] } }, { "description": "Refunds with payment type of Cash", "netAmount": 144.36, "currency": "EUR", "accountRef": { "id": "ef2fde36-4416-4bc5-b239-315b2929348c", "name": "Debiteuren" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:37:08Z", "sourceModifiedDate": "2020-04-22T13:56:46Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 35972, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "0008ef00-c5f8-4f97-bce9-5094b2f569dd", "createdOn": "2020-07-03T10:51:46", "updatedOn": "2020-07-03T10:51:46", "journalRef": { "id": "ed5068ff-cb0e-4edd-9777-36ac94a5d6f0", "name": "Sales journal" }, "journalLines": [ { "netAmount": -9.1, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "6 service charges with 0.0% vat", "netAmount": -11.21, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "28.0 items with VatPercentage of 0.0", "netAmount": -308.61, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "Gratuity", "netAmount": -25.87, "currency": "GBP", "accountRef": { "id": "febc52c4-a1ed-4000-b51a-76f9f525445d", "name": "Salary Control Account" }, "tracking": { "recordRefs": [] } }, { "netAmount": -47.14, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "19.0 items with VatPercentage of 20.0", "netAmount": -235.72, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "13.0 items with VatPercentage of 5.0", "netAmount": -182.06, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "1.0 gift cards", "netAmount": -1, "currency": "GBP", "accountRef": { "id": "febc52c4-a1ed-4000-b51a-76f9f525445d", "name": "Salary Control Account" }, "tracking": { "recordRefs": [] } }, { "netAmount": 820.71, "currency": "GBP", "accountRef": { "id": "cf9572e7-8afa-4339-9113-af32a66d9df9", "name": "Trade Debtors" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:35:45Z", "sourceModifiedDate": "2020-07-03T10:51:46Z", "recordRef": { "id": "0008ef00-c5f8-4f97-bce9-5094b2f569dd", "dataType": "invoices" } }, { "id": "001a8d63-2d5b-4b00-b17f-894108b6ce81", "createdOn": "2021-07-30T18:02:23", "updatedOn": "2021-07-30T18:02:23", "journalRef": { "id": "ed5068ff-cb0e-4edd-9777-36ac94a5d6f0", "name": "Sales journal" }, "journalLines": [ { "netAmount": 1038.01, "currency": "GBP", "accountRef": { "id": "cf9572e7-8afa-4339-9113-af32a66d9df9", "name": "Trade Debtors" }, "tracking": { "recordRefs": [] } }, { "description": "1.0 gift cards", "netAmount": -1, "currency": "GBP", "accountRef": { "id": "cc0ab812-d89a-452b-88a8-61666a0f0211", "name": "Accruals" }, "tracking": { "recordRefs": [] } }, { "netAmount": -19.29, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "netAmount": -60.82, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "15.0 items with VatPercentage of 0.0", "netAmount": -248.28, "currency": "GBP", "accountRef": { "id": "ba7d27d1-72cf-411b-8ef3-55ca4b13dac3", "name": "Sundry Non-Operating Expenses" }, "tracking": { "recordRefs": [] } }, { "description": "Gratuity", "netAmount": -8.97, "currency": "GBP", "accountRef": { "id": "8f27a6b8-101d-4613-a059-2b462fb01b2f", "name": "anna_test_prod" }, "tracking": { "recordRefs": [] } }, { "description": "28.0 items with VatPercentage of 5.0", "netAmount": -385.7, "currency": "GBP", "accountRef": { "id": "ba7d27d1-72cf-411b-8ef3-55ca4b13dac3", "name": "Sundry Non-Operating Expenses" }, "tracking": { "recordRefs": [] } }, { "description": "2 service charges with 0.0% vat", "netAmount": -9.85, "currency": "GBP", "accountRef": { "id": "ba7d27d1-72cf-411b-8ef3-55ca4b13dac3", "name": "Sundry Non-Operating Expenses" }, "tracking": { "recordRefs": [] } }, { "description": "27.0 items with VatPercentage of 20.0", "netAmount": -304.1, "currency": "GBP", "accountRef": { "id": "ba7d27d1-72cf-411b-8ef3-55ca4b13dac3", "name": "Sundry Non-Operating Expenses" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:35:45Z", "sourceModifiedDate": "2021-07-30T18:02:23Z", "recordRef": { "id": "001a8d63-2d5b-4b00-b17f-894108b6ce81", "dataType": "invoices" } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6785, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "24389149", "postedOn": "1987-10-01T00:00:00", "createdOn": "1987-10-01T00:00:00", "updatedOn": "1987-10-01T00:00:00", "journalLines": [ { "description": "", "netAmount": 222.88, "currency": "GBP", "accountRef": { "id": "128611", "name": "Accounts Receivable" } }, { "description": "Creative Writing Editorial", "netAmount": -222.88, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } }, { "description": "", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } } ], "modifiedDate": "2023-03-24T16:07:38Z", "sourceModifiedDate": "1987-10-01T00:00:00", "recordRef": { "id": "2596455", "dataType": "invoices" }, "metadata": { "isDeleted": false } }, { "id": "24389396", "postedOn": "1987-10-01T00:00:00", "createdOn": "1987-10-01T00:00:00", "updatedOn": "1987-10-01T00:00:00", "journalLines": [ { "description": "", "netAmount": -222.88, "currency": "GBP", "accountRef": { "id": "128611", "name": "Accounts Receivable" } }, { "description": "Creative Writing Editorial", "netAmount": 222.88, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } }, { "description": "", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } } ], "modifiedDate": "2023-03-24T16:07:38Z", "sourceModifiedDate": "1987-10-01T00:00:00", "recordRef": { "id": "2596455", "dataType": "invoices" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 734, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "112", "postedOn": "2021-03-26T00:00:00", "createdOn": "2021-03-26T10:31:05", "updatedOn": "2021-03-26T10:31:06", "journalLines": [ { "netAmount": -120, "currency": "GBP", "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" }, { "id": "724", "dataType": "suppliers" } ] } }, { "netAmount": 120, "currency": "GBP", "accountRef": { "id": "111", "name": "Accounts Payable" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" }, { "id": "724", "dataType": "suppliers" } ] } } ], "modifiedDate": "2023-01-30T14:49:07Z", "sourceModifiedDate": "2021-03-26T10:31:06", "recordRef": { "id": "112", "dataType": "billPayments" } }, { "id": "7", "postedOn": "2021-03-26T00:00:00", "createdOn": "2021-03-26T10:02:18", "updatedOn": "2022-07-05T13:38:10", "journalLines": [ { "netAmount": -144, "currency": "GBP", "accountRef": { "id": "111", "name": "Accounts Payable" }, "tracking": { "recordRefs": [ { "id": "724", "dataType": "suppliers" } ] } }, { "netAmount": 120, "currency": "GBP", "accountRef": { "id": "716", "name": "Inventory In Transit" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" } ] } }, { "description": "VAT", "netAmount": 24, "currency": "GBP", "accountRef": { "id": "211", "name": "VAT on Purchases" }, "tracking": { "recordRefs": [ { "id": "713", "dataType": "suppliers" } ] } } ], "modifiedDate": "2023-01-30T14:49:07Z", "sourceModifiedDate": "2022-07-05T13:38:10", "recordRef": { "id": "7", "dataType": "bills" } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 11, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "2453-1071526256", "postedOn": "2022-11-28T00:00:00", "createdOn": "2022-11-28T00:00:00", "journalLines": [ { "description": "", "netAmount": 431.95, "currency": "GBP", "accountRef": { "id": "40000-933270541", "name": "Accounts Receivable" } }, { "description": "Foundation slab - prep and pouring", "netAmount": -167.5, "currency": "GBP", "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, { "description": "CA sales tax, San Domingo County", "netAmount": -18.45, "currency": "GBP", "accountRef": { "id": "100000-933270541", "name": "Sales Tax Payable" } }, { "description": "Rough lumber", "netAmount": -48, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Trim lumber", "netAmount": -38, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -50, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Flooring", "netAmount": -50, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -60, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } } ], "modifiedDate": "2023-04-26T09:11:56Z", "sourceModifiedDate": "2023-12-16T05:04:21", "recordRef": { "id": "2453-1071526256", "dataType": "invoices" }, "metadata": { "isDeleted": false } }, { "id": "469E-1071530054", "postedOn": "2022-11-30T00:00:00", "createdOn": "2022-11-30T00:00:00", "journalLines": [ { "description": "", "netAmount": 14488.64, "currency": "GBP", "accountRef": { "id": "40000-933270541", "name": "Accounts Receivable" } }, { "description": "Installation labor", "netAmount": -45.5, "currency": "GBP", "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, { "description": "Install drywall", "netAmount": -1320, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Electrical work", "netAmount": -1650, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Metal Work", "netAmount": -660, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Install insulation", "netAmount": -1100, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Plumbing", "netAmount": -1650, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Painting", "netAmount": -2420, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Install carpeting", "netAmount": -3300, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Custom Bay Window", "netAmount": -1925, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -115.5, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Equipment Rental", "netAmount": -700, "currency": "GBP", "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, { "description": "10% retainage to be billed after job is complete and approved.", "netAmount": 555.5, "currency": "GBP", "accountRef": { "id": "70000-933270541", "name": "Retainage Receivable" } }, { "description": "CA sales tax, San Tomas County", "netAmount": -158.14, "currency": "GBP", "accountRef": { "id": "100000-933270541", "name": "Sales Tax Payable" } } ], "modifiedDate": "2023-04-26T09:11:56Z", "sourceModifiedDate": "2023-12-16T05:05:41", "recordRef": { "id": "469E-1071530054", "dataType": "invoices" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 140, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "1", "postedOn": "2018-09-21T00:00:00", "createdOn": "2018-09-21T00:00:00", "journalLines": [ { "description": "Opening Balance from Bank", "netAmount": 170.23, "currency": "GBP", "accountRef": { "id": "61", "name": "Dave PP Current" }, "tracking": { "recordRefs": [] } }, { "description": "", "netAmount": -170.23, "currency": "GBP", "accountRef": { "id": "53", "name": "Retained profit balance forward account" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-01-18T11:03:25Z", "sourceModifiedDate": "2018-12-17T14:56:20Z" }, { "id": "15", "postedOn": "2018-09-21T00:00:00", "createdOn": "2018-09-21T00:00:00", "journalLines": [ { "description": "Payment to Google", "netAmount": -1.59, "currency": "GBP", "accountRef": { "id": "61", "name": "Dave PP Current" }, "tracking": { "recordRefs": [] } }, { "description": "Payment to Google", "netAmount": 1.59, "currency": "GBP", "accountRef": { "id": "37", "name": "Computer equipment accumulated depreciation brought forward" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-01-18T11:03:25Z", "sourceModifiedDate": "2018-12-17T14:56:44Z", "recordRef": { "id": "PUR-15", "dataType": "directCosts" } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 9405, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "12", "postedOn": "2015-02-23T00:00:00", "createdOn": "2015-02-23T00:00:00", "journalLines": [ { "description": "Opening stock for Guest Book", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": 250, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": -250, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-12T16:02:02Z", "metadata": { "isDeleted": false } }, { "id": "13", "postedOn": "2015-02-23T00:00:00", "createdOn": "2015-02-23T00:00:00", "journalLines": [ { "description": "Opening stock for Name Badges", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Name Badges", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Name Badges", "netAmount": 7500, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Name Badges", "netAmount": -7500, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-12T16:02:04Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 9190, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "88", "description": "Opening Stock", "postedOn": "2021-01-01T00:00:00", "createdOn": "2010-04-27T17:16:57", "journalLines": [ { "description": "Opening Stock", "netAmount": -40710, "currency": "GBP", "accountRef": { "id": "1001", "name": "Stock" } }, { "description": "Opening Stock", "netAmount": 40710, "currency": "GBP", "accountRef": { "id": "5200", "name": "Opening Stock" } } ], "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-11-25T09:43:54", "recordRef": { "id": "88", "dataType": "journalEntries" }, "metadata": { "isDeleted": false } }, { "id": "92", "description": "Goods", "postedOn": "2021-01-01T00:00:00", "createdOn": "2010-04-27T17:16:57", "journalLines": [ { "description": "Goods/Services - Goods", "netAmount": -5875, "currency": "GBP", "accountRef": { "id": "2100", "name": "Creditors Control Account" } }, { "description": "Goods/Services - Goods", "netAmount": 5000, "currency": "GBP", "accountRef": { "id": "5000", "name": "Materials Purchased" } }, { "description": "Goods/Services - Goods", "netAmount": 875, "currency": "GBP", "accountRef": { "id": "2201", "name": "Purchase Tax Control Account" } } ], "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-11-25T09:43:54", "recordRef": { "id": "92", "dataType": "bills" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1119, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "b0489c4b33de11e797950a57719b2edb", "postedOn": "2017-05-08T11:08:39", "createdOn": "2017-05-08T11:08:39", "updatedOn": "2017-05-08T11:08:39", "journalLines": [ { "description": "Consulting services", "netAmount": 1440, "currency": "GBP", "accountRef": { "id": "9a9931b4267a11e797950a57719b2edb", "name": "VAT on Sales - Holding Account" } }, { "description": "Consulting services", "netAmount": 7200, "currency": "GBP", "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" } }, { "netAmount": -8640, "currency": "GBP", "accountRef": { "id": "9a991c56267a11e797950a57719b2edb", "name": "Trade Debtors" } } ], "modifiedDate": "2022-10-24T15:31:26Z", "sourceModifiedDate": "2017-05-08T11:08:39Z" }, { "id": "c23efa4233de11e797950a57719b2edb", "postedOn": "2017-05-08T11:09:09", "createdOn": "2017-05-08T11:09:09", "updatedOn": "2017-05-08T11:09:09", "journalLines": [ { "netAmount": 1080, "currency": "GBP", "accountRef": { "id": "9a991c56267a11e797950a57719b2edb", "name": "Trade Debtors" } }, { "description": "Consulting services", "netAmount": -180, "currency": "GBP", "accountRef": { "id": "9a9931b4267a11e797950a57719b2edb", "name": "VAT on Sales - Holding Account" } }, { "description": "Consulting services", "netAmount": -900, "currency": "GBP", "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" } } ], "modifiedDate": "2022-10-24T15:31:26Z", "sourceModifiedDate": "2017-05-08T11:09:09Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 24386, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "262177", "description": "Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry", "postedOn": "2021-04-22T00:00:00", "createdOn": "2021-04-22T10:44:27", "updatedOn": "2021-04-22T10:44:27", "journalRef": { "id": "1", "name": "Accounts Receivable Journal" }, "journalLines": [ { "description": "", "netAmount": -100, "currency": "GBP", "accountRef": { "id": "176", "name": "Revenue - Services" } }, { "description": "", "netAmount": -20, "currency": "GBP", "accountRef": { "id": "306", "name": "Sales Tax Payable" } }, { "description": "", "netAmount": 120, "currency": "GBP", "accountRef": { "id": "2", "name": "Accounts Receivable" } } ], "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2021-04-22T10:44:27", "metadata": { "isDeleted": false } }, { "id": "262179", "description": "Receipts(Bank-501_CHK) - 1100: April 2021 Batch Summary Entry", "postedOn": "2021-04-30T00:00:00", "createdOn": "2021-04-22T11:01:11", "updatedOn": "2022-04-19T13:38:45", "journalRef": { "id": "7", "name": "Cash Receipts Journal" }, "journalLines": [ { "description": "", "netAmount": -120, "currency": "GBP", "accountRef": { "id": "2", "name": "Accounts Receivable" } }, { "description": "", "netAmount": 120, "currency": "GBP", "accountRef": { "id": "353", "name": "Current Account" } }, { "description": "", "netAmount": 150, "currency": "GBP", "accountRef": { "id": "353", "name": "Current Account" } }, { "description": "", "netAmount": -150, "currency": "GBP", "accountRef": { "id": "179", "name": "Revenue - Other" } } ], "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2022-04-19T13:38:45", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 21, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "033d79c7-565b-419a-9e1b-33ab58efcf3d", "postedOn": "2021-11-19T00:00:00", "createdOn": "2023-02-17T21:07:12", "journalLines": [ { "description": "", "netAmount": -7267.2, "currency": "GBP", "accountRef": { "id": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "name": "Accounts Payable" } }, { "description": "Half day training - Microsoft Office", "netAmount": 1800, "currency": "GBP", "accountRef": { "id": "46f9461e-788b-4906-8b74-d1ea17f6dc10", "name": "Consulting" } }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "netAmount": 4000, "currency": "GBP", "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" } }, { "description": "Stationery charges", "netAmount": 256, "currency": "GBP", "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery" } }, { "description": "", "netAmount": 1211.2, "currency": "GBP", "accountRef": { "id": "b12f79b9-a082-4b8b-971e-d321292943c7", "name": "VAT" } } ], "modifiedDate": "2023-03-15T20:37:09Z", "sourceModifiedDate": "2023-02-17T21:07:12", "recordRef": { "id": "3945273c-cc04-479f-a4b5-1e3dc7a55ed1", "dataType": "bills" }, "metadata": { "isDeleted": false } }, { "id": "98ac5060-c9ed-4359-bcd5-711e649e7899", "postedOn": "2021-12-20T00:00:00", "createdOn": "2023-02-17T21:07:23", "journalLines": [ { "description": "", "netAmount": -7267.2, "currency": "GBP", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" } }, { "description": "", "netAmount": 7267.2, "currency": "GBP", "accountRef": { "id": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "name": "Accounts Payable" } } ], "modifiedDate": "2023-03-15T20:37:09Z", "sourceModifiedDate": "2023-02-17T21:07:23", "recordRef": { "id": "74004690-82a1-4810-aaca-6ce575af94b4", "dataType": "billPayments" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 290, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) for a given company's connection.\n\n[Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).\n ", "operationId": "list-journal-entries" } }, "/companies/{companyId}/data/journalEntries/{journalEntryId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/journalEntryId" } ], "get": { "tags": [ "Journal entries" ], "summary": "Get journal entry", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntry" }, "examples": { "Clear Books": { "value": { "id": "770c89bb-3d6a-449a-9243-739378b4cd7d", "postedOn": "2022-04-19T00:00:00", "createdOn": "2022-04-19T00:00:00", "journalRef": { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "name": "General Journal" }, "journalLines": [ { "description": "", "netAmount": 32095.91, "currency": "GBP", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" } }, { "description": "Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "netAmount": -2917.81, "currency": "GBP", "accountRef": { "id": "3a872b81-d1af-4d31-9bfa-a37280b8f68c", "name": "VAT" } }, { "description": "", "netAmount": -29178.09, "currency": "GBP", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" } } ], "modifiedDate": "2023-04-26T12:38:18Z", "recordRef": { "id": "c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "dataType": "directIncomes" }, "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "START", "postedOn": "2018-12-31T00:00:00", "createdOn": "2018-12-31T00:00:00", "journalRef": { "id": "4caabc3e-3d64-ed11-8c34-000d3a870cba", "name": "DEFAULT" }, "journalLines": [ { "description": "Opening Entry", "netAmount": -69723.14, "currency": "GBP", "accountRef": { "id": "ac1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Retained Earnings" } }, { "description": "Opening Entry", "netAmount": -20000, "currency": "GBP", "accountRef": { "id": "aa1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Share Capital" } }, { "description": "Opening Entry", "netAmount": -2329.42, "currency": "GBP", "accountRef": { "id": "8a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Payable" } }, { "description": "Opening Entry", "netAmount": 3499, "currency": "GBP", "accountRef": { "id": "6e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accumulated Depreciation" } }, { "description": "Opening Entry", "netAmount": 5498, "currency": "GBP", "accountRef": { "id": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Equipment" } }, { "description": "Opening Entry", "netAmount": 28547.16, "currency": "GBP", "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" } }, { "description": "Opening Entry", "netAmount": 31638.4, "currency": "GBP", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" } }, { "description": "Opening Entry", "netAmount": 2870, "currency": "GBP", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" } }, { "description": "Opening Entry", "netAmount": 20000, "currency": "GBP", "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" } } ], "modifiedDate": "2023-03-27T14:21:31Z", "sourceModifiedDate": "2020-07-29T10:56:12Z", "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "00002c0a-8061-4ad2-84fa-c879eea880a7", "createdOn": "2022-01-11T14:18:54", "updatedOn": "2022-01-11T14:18:54", "journalRef": { "id": "55ff34a3-0857-4202-b7ec-a399cfc26a4e", "name": "Memoriaal" }, "journalLines": [ { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "netAmount": -6.94, "currency": "EUR", "accountRef": { "id": "e0217fbf-8963-4134-80ef-929d5de8612d", "name": "Kosten 13e maand" }, "tracking": { "recordRefs": [] } }, { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "netAmount": 6.94, "currency": "EUR", "accountRef": { "id": "0166c96b-adf2-4667-a755-87e67c741f41", "name": "Resultaat verkoop activa" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:37:10Z", "sourceModifiedDate": "2022-01-11T14:18:54Z" } }, "Exact (UK)": { "value": { "id": "0008ef00-c5f8-4f97-bce9-5094b2f569dd", "createdOn": "2020-07-03T10:51:46", "updatedOn": "2020-07-03T10:51:46", "journalRef": { "id": "ed5068ff-cb0e-4edd-9777-36ac94a5d6f0", "name": "Sales journal" }, "journalLines": [ { "netAmount": -9.1, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "6 service charges with 0.0% vat", "netAmount": -11.21, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "28.0 items with VatPercentage of 0.0", "netAmount": -308.61, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "Gratuity", "netAmount": -25.87, "currency": "GBP", "accountRef": { "id": "febc52c4-a1ed-4000-b51a-76f9f525445d", "name": "Salary Control Account" }, "tracking": { "recordRefs": [] } }, { "netAmount": -47.14, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "19.0 items with VatPercentage of 20.0", "netAmount": -235.72, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "13.0 items with VatPercentage of 5.0", "netAmount": -182.06, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "1.0 gift cards", "netAmount": -1, "currency": "GBP", "accountRef": { "id": "febc52c4-a1ed-4000-b51a-76f9f525445d", "name": "Salary Control Account" }, "tracking": { "recordRefs": [] } }, { "netAmount": 820.71, "currency": "GBP", "accountRef": { "id": "cf9572e7-8afa-4339-9113-af32a66d9df9", "name": "Trade Debtors" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:35:45Z", "sourceModifiedDate": "2020-07-03T10:51:46Z", "recordRef": { "id": "0008ef00-c5f8-4f97-bce9-5094b2f569dd", "dataType": "invoices" } } }, "FreshBooks": { "value": { "id": "24389149", "postedOn": "1987-10-01T00:00:00", "createdOn": "1987-10-01T00:00:00", "updatedOn": "1987-10-01T00:00:00", "journalLines": [ { "description": "", "netAmount": 222.88, "currency": "GBP", "accountRef": { "id": "128611", "name": "Accounts Receivable" } }, { "description": "Creative Writing Editorial", "netAmount": -222.88, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } }, { "description": "", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } } ], "modifiedDate": "2023-03-24T16:07:38Z", "sourceModifiedDate": "1987-10-01T00:00:00", "recordRef": { "id": "2596455", "dataType": "invoices" }, "metadata": { "isDeleted": false } } }, "Oracle NetSuite": { "value": { "id": "112", "postedOn": "2021-03-26T00:00:00", "createdOn": "2021-03-26T10:31:05", "updatedOn": "2021-03-26T10:31:06", "journalLines": [ { "netAmount": -120, "currency": "GBP", "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" }, { "id": "724", "dataType": "suppliers" } ] } }, { "netAmount": 120, "currency": "GBP", "accountRef": { "id": "111", "name": "Accounts Payable" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" }, { "id": "724", "dataType": "suppliers" } ] } } ], "modifiedDate": "2023-01-30T14:49:07Z", "sourceModifiedDate": "2021-03-26T10:31:06", "recordRef": { "id": "112", "dataType": "billPayments" } } }, "QuickBooks Desktop": { "value": { "id": "2453-1071526256", "postedOn": "2022-11-28T00:00:00", "createdOn": "2022-11-28T00:00:00", "journalLines": [ { "description": "", "netAmount": 431.95, "currency": "GBP", "accountRef": { "id": "40000-933270541", "name": "Accounts Receivable" } }, { "description": "Foundation slab - prep and pouring", "netAmount": -167.5, "currency": "GBP", "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, { "description": "CA sales tax, San Domingo County", "netAmount": -18.45, "currency": "GBP", "accountRef": { "id": "100000-933270541", "name": "Sales Tax Payable" } }, { "description": "Rough lumber", "netAmount": -48, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Trim lumber", "netAmount": -38, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -50, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Flooring", "netAmount": -50, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -60, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } } ], "modifiedDate": "2023-04-26T09:11:56Z", "sourceModifiedDate": "2023-12-16T05:04:21", "recordRef": { "id": "2453-1071526256", "dataType": "invoices" }, "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "1", "postedOn": "2018-09-21T00:00:00", "createdOn": "2018-09-21T00:00:00", "journalLines": [ { "description": "Opening Balance from Bank", "netAmount": 170.23, "currency": "GBP", "accountRef": { "id": "61", "name": "Dave PP Current" }, "tracking": { "recordRefs": [] } }, { "description": "", "netAmount": -170.23, "currency": "GBP", "accountRef": { "id": "53", "name": "Retained profit balance forward account" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-01-18T11:03:25Z", "sourceModifiedDate": "2018-12-17T14:56:20Z" } }, "QuickBooks Online Sandbox": { "value": { "id": "12", "postedOn": "2015-02-23T00:00:00", "createdOn": "2015-02-23T00:00:00", "journalLines": [ { "description": "Opening stock for Guest Book", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": 250, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": -250, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-12T16:02:02Z", "metadata": { "isDeleted": false } } }, "Sage 50 (UK)": { "value": { "id": "88", "description": "Opening Stock", "postedOn": "2021-01-01T00:00:00", "createdOn": "2010-04-27T17:16:57", "journalLines": [ { "description": "Opening Stock", "netAmount": -40710, "currency": "GBP", "accountRef": { "id": "1001", "name": "Stock" } }, { "description": "Opening Stock", "netAmount": 40710, "currency": "GBP", "accountRef": { "id": "5200", "name": "Opening Stock" } } ], "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-11-25T09:43:54", "recordRef": { "id": "88", "dataType": "journalEntries" }, "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "b0489c4b33de11e797950a57719b2edb", "postedOn": "2017-05-08T11:08:39", "createdOn": "2017-05-08T11:08:39", "updatedOn": "2017-05-08T11:08:39", "journalLines": [ { "description": "Consulting services", "netAmount": 1440, "currency": "GBP", "accountRef": { "id": "9a9931b4267a11e797950a57719b2edb", "name": "VAT on Sales - Holding Account" } }, { "description": "Consulting services", "netAmount": 7200, "currency": "GBP", "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" } }, { "netAmount": -8640, "currency": "GBP", "accountRef": { "id": "9a991c56267a11e797950a57719b2edb", "name": "Trade Debtors" } } ], "modifiedDate": "2022-10-24T15:31:26Z", "sourceModifiedDate": "2017-05-08T11:08:39Z" } }, "Sage Intacct": { "value": { "id": "262177", "description": "Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry", "postedOn": "2021-04-22T00:00:00", "createdOn": "2021-04-22T10:44:27", "updatedOn": "2021-04-22T10:44:27", "journalRef": { "id": "1", "name": "Accounts Receivable Journal" }, "journalLines": [ { "description": "", "netAmount": -100, "currency": "GBP", "accountRef": { "id": "176", "name": "Revenue - Services" } }, { "description": "", "netAmount": -20, "currency": "GBP", "accountRef": { "id": "306", "name": "Sales Tax Payable" } }, { "description": "", "netAmount": 120, "currency": "GBP", "accountRef": { "id": "2", "name": "Accounts Receivable" } } ], "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2021-04-22T10:44:27", "metadata": { "isDeleted": false } } }, "Xero": { "value": { "id": "033d79c7-565b-419a-9e1b-33ab58efcf3d", "postedOn": "2021-11-19T00:00:00", "createdOn": "2023-02-17T21:07:12", "journalLines": [ { "description": "", "netAmount": -7267.2, "currency": "GBP", "accountRef": { "id": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "name": "Accounts Payable" } }, { "description": "Half day training - Microsoft Office", "netAmount": 1800, "currency": "GBP", "accountRef": { "id": "46f9461e-788b-4906-8b74-d1ea17f6dc10", "name": "Consulting" } }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "netAmount": 4000, "currency": "GBP", "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" } }, { "description": "Stationery charges", "netAmount": 256, "currency": "GBP", "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery" } }, { "description": "", "netAmount": 1211.2, "currency": "GBP", "accountRef": { "id": "b12f79b9-a082-4b8b-971e-d321292943c7", "name": "VAT" } } ], "modifiedDate": "2023-03-15T20:37:09Z", "sourceModifiedDate": "2023-02-17T21:07:12", "recordRef": { "id": "3945273c-cc04-479f-a4b5-1e3dc7a55ed1", "dataType": "bills" }, "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get journal entry* endpoint returns a single journal entry for a given `journalEntryId`.\n\n[Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).\n", "operationId": "get-journal-entry" } }, "/companies/{companyId}/connections/{connectionId}/push/journalEntries/{journalEntryId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/journalEntryId" } ], "delete": { "summary": "Delete journal entry", "operationId": "delete-journal-entry", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/allowSyncOnPushComplete" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOperation" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "> **Use with caution**\n>\n>Because journal entries underpin every transaction in an accounting software, deleting a journal entry can affect every transaction for a given company.\n> \n> **Before you proceed, make sure you understand the implications of deleting journal entries from an accounting perspective.**\n\nThe *Delete journal entry* endpoint allows you to delete a specified journal entry from an accounting software.\n\n[Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\n### Process\n1. Pass the `{journalEntryId}` to the *Delete journal entry* endpoint and store the `pushOperationKey` returned.\n2. Check the status of the delete by checking the status of push operation either via\n 1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised),\n 2. [Push operation status endpoint](https://docs.codat.io/sync-for-payroll-api#/operations/get-push-operation). \n \n A `Success` status indicates that the journal entry object was deleted from the accounting software.\n3. (Optional) Check that the journal entry was deleted from the accounting software.\n\n### Effect on related objects\n\nBe aware that deleting a journal entry from an accounting software might cause related objects to be modified. For example, if you delete the journal entry for a paid invoice in QuickBooks Online, the invoice is deleted but the payment against that invoice is not. The payment is converted to a payment on account.\n\n## Integration specifics\nIntegrations that support soft delete do not permanently delete the object in the accounting software.\n\n| Integration | Soft Deleted | \n|-------------|--------------|\n| QuickBooks Online | Yes | \n", "tags": [ "Journal entries" ] } }, "/companies/{companyId}/connections/{connectionId}/options/journalEntries": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create journal entry model", "tags": [ "Journal entries" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Dynamics 365 Business Central": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "journalRef": { "type": "Object", "displayName": "Journal Reference", "description": "Reference to the journal in which this journal entry was created", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the journal", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalRef", "details": "Only General type Journals are allowed" } ] } }, "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "description": { "type": "String", "displayName": "Description", "description": "An optional top level description for the journal entry", "required": false }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true, "validation": { "warnings": [ { "field": "JournalLines.AccountRef", "details": "Bank accounts are not allowed" } ], "information": [] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": true, "validation": { "warnings": [ { "field": "JournalLines.Currency", "details": "Only base currency is allowed" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "JournalLines", "details": "Must contain 2 journal lines" } ], "information": [] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "An optional top level description for the journal entry", "required": false }, "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": false, "validation": { "warnings": [], "information": [ { "field": "PostedOn", "details": "Defaults to today's date if not specified" } ] } }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Currency", "details": "Must be the base currency" } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.AccountRef", "details": "Specified account must be in the same base currency as the subsidiary" } ] } }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "trackingCategories", "type": "String", "displayName": "trackingCategories", "required": false }, { "value": "customers", "type": "String", "displayName": "customers", "required": false }, { "value": "suppliers", "type": "String", "displayName": "suppliers", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "RecordRefs.DataType", "details": "At most one trackingCategory RecordRef of each type (classification/department/location) may be provided, and only one entity (either customers/suppliers) RecordRef may be provided" } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": false }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false, "validation": { "warnings": [ { "field": "JournalLines.Description", "details": "Max length of 4000 characters." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "required": true, "validation": { "warnings": [ { "field": "JournalLines.AccountRef", "details": "The currency of all accounts in the Journal Entry must use the base currency of the QuickBooks Desktop company" } ], "information": [] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.NetAmount", "details": "For debit lines, the net amount should be positive, for credit lines it should be negative" }, { "field": "JournalLines.NetAmount", "details": "The sum of net amounts for all line items must be 0" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [ { "field": "JournalLines.Currency", "details": "Must be a three letter ISO code that matches the currency of the QuickBooks Desktop company" }, { "field": "JournalLines.Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "JournalLines.Currency", "details": "Must match the base currency of the QuickBooks Desktop company" }, { "field": "JournalLines.Currency", "details": "If not set, will default to the default currency of the QuickBooks Desktop company" } ] } } }, "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Description", "details": "Must be no longer than 4000 characters long" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Currency", "details": "Required if multi-currency is enabled for the company" }, { "field": "JournalLines.Currency", "details": "When present, all JournalLine currencies should match" } ] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "RecordRefs.Id", "details": "Must begin with 'CLASS_' or 'DEPARTMENT_'" }, { "field": "RecordRefs.Id", "details": "Must match the ID of an existing tracking category and be of type 'DEPARTMENT' or 'CLASS'." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true, "validation": { "warnings": [ { "field": "RecordRefs.DataType", "details": "Must be 'trackingCategories'" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "Tracking.RecordRefs", "details": "Must not contain multiple 'CLASS_' records or 'DEPARTMENT_' records" } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines", "details": "There must be at least two lines" } ] } } }, "required": true, "validation": { "warnings": [ { "details": "To push a JournalEntry to a French Company in QuickBooks Online, an active JournalCode with type 'Others' or 'Autres' must exist inside the Company" } ], "information": [] } } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Description", "details": "Must be no longer than 4000 characters long" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Currency", "details": "Required if multi-currency is enabled for the company" }, { "field": "JournalLines.Currency", "details": "When present, all JournalLine currencies should match" } ] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "RecordRefs.Id", "details": "Must begin with 'CLASS_' or 'DEPARTMENT_'" }, { "field": "RecordRefs.Id", "details": "Must match the ID of an existing tracking category and be of type 'DEPARTMENT' or 'CLASS'." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true, "validation": { "warnings": [ { "field": "RecordRefs.DataType", "details": "Must be 'trackingCategories'" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "Tracking.RecordRefs", "details": "Must not contain multiple 'CLASS_' records or 'DEPARTMENT_' records" } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines", "details": "There must be at least two lines" } ] } } }, "required": true, "validation": { "warnings": [ { "details": "To push a JournalEntry to a French Company in QuickBooks Online, an active JournalCode with type 'Others' or 'Autres' must exist inside the Company" } ], "information": [] } } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "createdOn": { "type": "DateTime", "displayName": "Created On", "description": "Date on which the journal was created in Sage50.", "required": false, "validation": { "warnings": [], "information": [ { "field": "createdOn", "details": "if empty then Sage 50 will auto generate a created on date" } ] } }, "updatedOn": { "type": "DateTime", "displayName": "Updated On", "description": "Date on which the journal was last updated in Sage50.", "required": true, "validation": { "warnings": [ { "field": "updatedOn", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Optional description of the journal entry.", "required": false, "validation": { "warnings": [ { "field": "description", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "modifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "Date on which the record was last updated via pushes.", "required": true, "validation": { "warnings": [ { "field": "modifiedDate", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "sourceModifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "Date on which the record was last changed in Sage50.", "required": true, "validation": { "warnings": [ { "field": "sourceModifiedDate", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "recordRef": { "type": "Object", "displayName": "Record Reference", "description": "Links a journal entry to the underlying record that created it.", "required": false }, "dataType": { "type": "String", "displayName": "Data Type", "description": "Data type of the underlying record that created the journal entry.", "required": false, "validation": { "warnings": [ { "field": "dataType", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "journalRef": { "type": "Object", "displayName": "Journal Reference", "description": "Links journal entries to the relevant journal", "required": false }, "id": { "type": "String", "displayName": "Id", "description": "The reference journal id", "required": false, "validation": { "warnings": [ { "field": "id", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "The reference journal name", "required": false, "validation": { "warnings": [ { "field": "name", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "Journal line items of the journal entry.", "properties": { "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.", "required": true, "validation": { "warnings": [ { "field": "journalLines.netAmount", "details": "Cannot equal 0" } ], "information": [] } }, "description": { "type": "String", "displayName": "description", "description": "Description of the journal line item.", "required": false }, "currency": { "type": "String", "displayName": "currency", "description": "Currency for the journal line item.", "required": false, "validation": { "warnings": [ { "field": "journalLines.currency", "details": "Journal entries can only be pushed in the base currency of the target company." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "accountRef", "description": "Links a journal entry to any associated accounts.", "properties": { "id": { "type": "String", "displayName": "Id", "description": "The ID of the Account the line is linked to.", "required": false, "validation": { "warnings": [ { "field": "id", "details": "Cannot post journal entries against non-base currency nominal codes" } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "journalRef": { "type": "Object", "displayName": "Journal Reference", "description": "Reference to the journal in which this journal entry was created", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the journal", "required": true } }, "required": true }, "description": { "type": "String", "displayName": "Description", "description": "An optional top level description for the journal entry", "required": true, "validation": { "warnings": [ { "field": "Description", "details": "Must be no greater than 512 characters" } ], "information": [] } }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true, "validation": { "warnings": [ { "field": "JournalLines.NetAmount", "details": "Must not be a 0 amount" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false, "validation": { "warnings": [ { "field": "JournalLines.Description", "details": "Must be no greater than 512 characters" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [ { "field": "JournalLines.Currency", "details": "If provided, must match the base currency for the company" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "JournalLines", "details": "There must be at least two lines" } ], "information": [] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "An optional top level description for the journal entry", "required": true }, "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "createdOn": { "type": "DateTime", "displayName": "Created On", "description": "The date the entry was created in the originating system", "required": true }, "updatedOn": { "type": "DateTime", "displayName": "Updated On", "description": "The date in which the journal was last updated in the originating system", "required": true }, "journalRef": { "type": "Object", "displayName": "Journal Reference", "description": "Reference to the journal in which this journal entry was created", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the journal", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the journal", "required": true } }, "required": true }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": true }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true } }, "required": true } }, "required": true }, "recordRef": { "type": "Object", "displayName": "Record Reference", "description": "Reference to the record for which this journal entry was created", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true, "validation": { "warnings": [], "information": [ { "field": "PostedOn", "details": "If no date is specified, it will default to today's date." } ] } }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Description", "details": "Must not be longer than 4000 characters long and must be the same for all lines." } ] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.NetAmount", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.AccountRef", "details": "Must be provided." } ] } }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [], "information": [ { "field": "RecordRefs.Id", "details": "Must not be a parent tracking category." }, { "field": "RecordRefs.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Tracking.RecordRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "Tracking.RecordRefs", "details": "Maximum of 2 Tracking Categories." } ] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines", "details": "At least 2 must be provided." } ] } } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-journalEntry-model", "description": "The *Get create journal entry model* endpoint returns the expected data for the request payload when creating a [journal entry](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) for a given company and integration.\n\n[Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support creating a journal entry.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/journalEntries": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Journal entries" ], "summary": "Create journal entry", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/allowSyncOnPushComplete" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntry" }, "examples": { "QuickBooks Desktop": { "value": { "description": "record level description", "postedOn": "2023-02-23T19:49:16.052Z", "createdOn": "2023-02-22T19:49:16.052Z", "updatedOn": "2023-02-21T19:49:16.052Z", "journalRef": { "id": "12" }, "journalLines": [ { "description": "journalLines.description debit", "netAmount": 23.02, "currency": "USD", "accountRef": { "id": "80000019-1671793811", "name": "Office Supplies" }, "tracking": { "recordRefs": [ { "id": "80000001-1674553252", "dataType": "customers" } ] } }, { "description": "journalLines.description credit", "netAmount": -23.02, "currency": "USD", "accountRef": { "id": "8000001E-1671793811", "name": "Utilities" }, "tracking": { "recordRefs": [ { "id": "80000002-1674553271", "dataType": "trackingCategories" } ] } } ], "recordRef": { "id": "80000002-6722155312", "dataType": "bills" }, "metadata": { "isDeleted": true } } }, "Sage Intacct": { "value": { "description": "test", "postedOn": "2023-03-29T00:00:00Z", "journalRef": { "id": "207" }, "journalLines": [ { "description": "line desc 1", "netAmount": 9, "currency": "GBP", "accountRef": { "id": "151" } }, { "description": "line desc 2", "netAmount": -9, "currency": "GBP", "accountRef": { "id": "154" } } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJournalEntryResponse" }, "examples": { "Sage Intacct": { "value": { "changes": [ { "type": "Created", "recordRef": { "dataType": "journalEntries" } } ], "data": { "description": "test", "postedOn": "2023-03-29T00:00:00Z", "journalRef": { "id": "207" }, "journalLines": [ { "description": "line desc 1", "netAmount": 9, "currency": "GBP", "accountRef": { "id": "151" } }, { "description": "line desc 2", "netAmount": -9, "currency": "GBP", "accountRef": { "id": "154" } } ] }, "dataType": "journalEntries", "companyId": "d7f743a9-1804-4116-8c8a-e606f7e2f66c", "pushOperationKey": "b9c1381a-8742-4a45-9dc5-528101dbd0e3", "dataConnectionKey": "fa139396-523a-4a58-bf2b-8da82c8a673f", "requestedOnUtc": "2023-03-31T14:53:44.6401039Z", "status": "Pending", "statusCode": 202 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create journal entry* endpoint creates a new [journal entry](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) for a given company's connection.\n\n[Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create journal entry model](https://docs.codat.io/sync-for-payroll-api#/operations/get-create-journalEntries-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support creating a journal entry.\n", "operationId": "create-journal-entry" } }, "/companies/{companyId}/data/journals": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Journals" ], "summary": "List journals", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journals" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "journalCode": "GJ", "name": "General Journal", "type": "General Journal", "hasChildren": true, "createdOn": "2021-12-11T13:04:02", "status": "Active", "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-07-15T20:19:02", "metadata": { "isDeleted": false } }, { "id": "07b94827-c0a5-4cc7-ba58-3f9efec3b4b3", "journalCode": "PAY", "name": "Payroll Journal", "type": "Payroll Journal", "parentId": "90bb7784-083b-4bcb-a534-b30756cee65d", "hasChildren": false, "createdOn": "2021-12-11T13:04:02", "status": "Active", "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-07-24T14:17:02", "metadata": { "isDeleted": false } } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 4 } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "211317b3-89d1-ea11-bbaa-000d3a2b9185", "journalCode": "ASSETS", "name": "ASSETS", "type": "Assets", "hasChildren": true, "status": "Active", "modifiedDate": "2023-03-27T14:21:10Z", "sourceModifiedDate": "2023-02-02T10:26:25Z", "metadata": { "isDeleted": false } }, { "id": "9a94ef78-92ec-ec11-82f9-000d3a8746a9", "journalCode": "BNKDEPOSIT-BNKD", "name": "BNKD", "type": "Bank Deposits", "parentId": "af7d7e6b-e5c8-ec11-8e7e-000d3a86e04a", "hasChildren": false, "createdOn": "2022-06-15T10:03:59", "status": "Active", "modifiedDate": "2023-03-27T14:21:10Z", "sourceModifiedDate": "2022-06-15T22:45:30Z", "metadata": { "isDeleted": false } } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 46 } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "aae31284-e23d-456b-9957-fbf4bcef6c19", "journalCode": "21", "name": "12345678", "type": "Bank", "hasChildren": false, "createdOn": "2019-11-05T14:44:51", "status": "Active", "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2020-01-24T11:41:25Z" }, { "id": "74677165-1bd3-49b4-87d0-32d974674f86", "journalCode": "23", "name": "Abraham's Billion Dollar stuff", "type": "Bank", "hasChildren": false, "createdOn": "2019-11-22T13:35:57", "status": "Active", "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2019-11-22T13:35:57Z" } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 47 } }, "Exact (UK)": { "value": { "results": [ { "id": "05b9febe-34b3-4836-8277-002294b233a9", "journalCode": "25", "name": "annaBankAccount1", "type": "Bank", "hasChildren": false, "createdOn": "2021-04-26T16:44:47", "status": "Active", "modifiedDate": "2022-10-26T13:33:08Z", "sourceModifiedDate": "2021-04-26T16:44:47Z" }, { "id": "b9c3d6a6-4ce2-4714-9ff6-fb15892300f7", "journalCode": "31", "name": "annaBankAccount10", "type": "Bank", "hasChildren": false, "createdOn": "2021-05-18T10:24:18", "status": "Active", "modifiedDate": "2022-10-26T13:33:08Z", "sourceModifiedDate": "2021-05-18T10:24:18Z" } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 21 } }, "Sage Intacct": { "value": { "results": [ { "id": "207", "journalCode": "AJPT", "name": "A Journal Push Test", "type": "", "hasChildren": false, "createdOn": "2022-01-17T10:44:23", "status": "Active", "modifiedDate": "2023-04-04T16:31:30Z", "sourceModifiedDate": "2022-01-17T10:44:23", "metadata": { "isDeleted": false } }, { "id": "223", "journalCode": "AJPT2", "name": "A Journal Push Test 2", "type": "", "hasChildren": false, "createdOn": "2022-01-18T15:39:07", "status": "Active", "modifiedDate": "2023-04-04T16:31:30Z", "sourceModifiedDate": "2022-01-18T15:39:07", "metadata": { "isDeleted": false } } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 1211 } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List journals* endpoint returns a list of [journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) for a given company's connection.\n\n[Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).\n ", "operationId": "list-journals" } }, "/companies/{companyId}/data/journals/{journalId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/journalId" } ], "get": { "tags": [ "Journals" ], "summary": "Get journal", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" }, "examples": { "Clear Books": { "value": { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "journalCode": "GJ", "name": "General Journal", "type": "General Journal", "hasChildren": true, "createdOn": "2021-12-11T13:04:02", "status": "Active", "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-07-15T20:19:02", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "211317b3-89d1-ea11-bbaa-000d3a2b9185", "journalCode": "ASSETS", "name": "ASSETS", "type": "Assets", "hasChildren": true, "status": "Active", "modifiedDate": "2023-03-27T14:21:10Z", "sourceModifiedDate": "2023-02-02T10:26:25Z", "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "aae31284-e23d-456b-9957-fbf4bcef6c19", "journalCode": "21", "name": "12345678", "type": "Bank", "hasChildren": false, "createdOn": "2019-11-05T14:44:51", "status": "Active", "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2020-01-24T11:41:25Z" } }, "Exact (UK)": { "value": { "id": "05b9febe-34b3-4836-8277-002294b233a9", "journalCode": "25", "name": "annaBankAccount1", "type": "Bank", "hasChildren": false, "createdOn": "2021-04-26T16:44:47", "status": "Active", "modifiedDate": "2022-10-26T13:33:08Z", "sourceModifiedDate": "2021-04-26T16:44:47Z" } }, "Sage Intacct": { "value": { "id": "207", "journalCode": "AJPT", "name": "A Journal Push Test", "type": "", "hasChildren": false, "createdOn": "2022-01-17T10:44:23", "status": "Active", "modifiedDate": "2023-04-04T16:31:30Z", "sourceModifiedDate": "2022-01-17T10:44:23", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get journal* endpoint returns a single journal for a given `journalId`.\n\n[Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).\n", "operationId": "get-journal" } }, "/companies/{companyId}/connections/{connectionId}/options/journals": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create journal model", "tags": [ "Journals" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Sage Intacct": { "value": { "type": "Object", "displayName": "Journal", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the journal", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Must be no greater than 40 characters" } ], "information": [] } }, "journalCode": { "type": "String", "displayName": "Journal Number", "description": "The number or code for the journal", "required": true, "validation": { "warnings": [ { "field": "JournalCode", "details": "Must be no greater than 16 characters" } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "The status of the journal", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Journal", "properties": { "journalCode": { "type": "String", "displayName": "Journal Number", "description": "The number or code for the journal", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the journal", "required": true }, "type": { "type": "String", "displayName": "Type", "description": "The type of journal", "required": true }, "parentId": { "type": "String", "displayName": "Parent Id", "description": "Identifier for the parent journal - empty if journal is the parent", "required": true }, "hasChildren": { "type": "Boolean", "displayName": "Has Children", "description": "If a journal has children, the journal is parent of those children journals", "required": true }, "createdOn": { "type": "DateTime", "displayName": "Created On", "description": "The date the journal was created in the originating system", "required": true }, "status": { "type": "String", "displayName": "Status", "description": "The status of the journal", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-journal-model", "description": "The *Get create journal model* endpoint returns the expected data for the request payload when creating a [journal](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) for a given company and integration.\n\n[Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support creating a journal.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/journals": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Journals" ], "summary": "Create journal", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/allowSyncOnPushComplete" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal/definitions/journalPrototype" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJournalResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create journal* endpoint creates a new [journal](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) for a given company's connection.\n\n[Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create journal model](https://docs.codat.io/sync-for-payroll-api#/operations/get-create-journals-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support creating a journal.\n", "operationId": "create-journal" } }, "/companies/{companyId}/data/trackingCategories": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Tracking categories" ], "summary": "List tracking categories", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingCategories" }, "examples": { "Dynamics 365 Business Central": { "value": { "results": [ { "id": "9e1dea89-1e34-ed11-97e8-000d3a872db9", "parentId": "d1391864-77cf-eb11-9f0a-0022481b404b", "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-09-14T11:19:28Z", "name": "A-000-A-Hundreds", "hasChildren": false, "status": "Active" }, { "id": "ffc4c780-77cf-eb11-9f0a-0022481b404b", "parentId": "d1391864-77cf-eb11-9f0a-0022481b404b", "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2021-06-17T14:25:28Z", "name": "A-100-A-100 Name", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 36, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/trackingCategories" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/trackingCategories?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "5389667", "parentId": "4370491", "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2021-05-19T11:09:40", "name": "ABCustomCategory", "hasChildren": false, "status": "Active" }, { "id": "4370499", "parentId": "4370496", "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2021-07-26T09:42:18", "name": "Accident Insurance", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 82, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/trackingCategories" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/trackingCategories?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "CostEstimateType-AVGCOST", "modifiedDate": "2023-01-30T14:46:52Z", "name": "Average Cost", "hasChildren": false, "status": "Active" }, { "id": "classification-1", "modifiedDate": "2023-01-30T14:46:52Z", "sourceModifiedDate": "2022-11-17T11:47:34", "name": "Class 1", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 18, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/trackingCategories" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/trackingCategories?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "80000008-1734278594", "modifiedDate": "2023-04-26T09:12:46Z", "sourceModifiedDate": "2024-12-15T16:03:14", "name": "ClassWithSub", "hasChildren": true, "status": "Active" }, { "id": "8000000A-1734278615", "modifiedDate": "2023-04-26T09:12:46Z", "sourceModifiedDate": "2024-12-15T16:09:02", "name": "Incative", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/trackingCategories" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/trackingCategories?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "CLASS_5100000000000014491", "parentId": "CLASSES", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2022-03-07T08:28:32Z", "name": "A", "hasChildren": false, "status": "Active" }, { "id": "CLASS_200200000000000009374", "parentId": "CLASSES", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2016-11-04T09:28:00Z", "name": "Australia (deleted)", "hasChildren": false, "status": "Archived" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 23, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/trackingCategories" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/trackingCategories?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "__DEPARTMENTS/3", "parentId": "__DEPARTMENTS", "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "name": "Accounts", "hasChildren": false, "status": "Active" }, { "id": "__DEPARTMENTS/4", "parentId": "__DEPARTMENTS", "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "name": "Admin", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 24, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/trackingCategories" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/trackingCategories?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "department_10", "parentId": "DEPARTMENTS", "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "name": "", "hasChildren": false, "status": "Active" }, { "id": "department_100", "parentId": "DEPARTMENTS", "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "name": "", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1022, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/trackingCategories" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/trackingCategories?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "department_0", "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2022-03-22T15:33:21", "name": "BallparkContracting", "hasChildren": false, "status": "Active" }, { "id": "department_1", "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2021-06-23T15:33:21", "name": "BaseMountainConstruction", "hasChildren": true, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 15, "_links": { "current": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/trackingCategories" }, "next": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/trackingCategories?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "WAREHOUSE-2", "parentId": "WAREHOUSE", "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2020-04-26T05:26:46", "name": "200", "hasChildren": false, "status": "Active" }, { "id": "WAREHOUSE-3", "parentId": "WAREHOUSE", "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2021-08-10T13:41:01", "name": "300", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 757, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/trackingCategories" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/trackingCategories?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa", "parentId": "9d8ad8f6-0d0f-41e0-8851-ef47e8b54ae6", "modifiedDate": "2023-03-15T20:37:11Z", "name": "Eastside", "hasChildren": false, "status": "Active" }, { "id": "34b9b859-07a9-451a-b4d3-effc9946634a", "parentId": "9d8ad8f6-0d0f-41e0-8851-ef47e8b54ae6", "modifiedDate": "2023-03-15T20:37:11Z", "name": "North", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 5, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/trackingCategories" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/trackingCategories?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000000323-104957000001510028", "parentId": "104957000000000323", "modifiedDate": "2022-10-03T08:40:39Z", "name": "Down", "hasChildren": false, "status": "Active" }, { "id": "104957000000000323-104957000001510024", "parentId": "104957000000000323", "modifiedDate": "2022-10-03T08:40:39Z", "name": "East", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 11, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/trackingCategories" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/trackingCategories?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List tracking categories* endpoint returns a list of [tracking categories](https://docs.codat.io/sync-for-payroll-api#/schemas/TrackingCategory) for a given company's connection.\n\n[Tracking categories](https://docs.codat.io/sync-for-payroll-api#/schemas/TrackingCategory) are used to monitor cost centres and control budgets that sit outside the standard set of accounts.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).\n ", "operationId": "list-tracking-categories" } }, "/companies/{companyId}/data/trackingCategories/{trackingCategoryId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/trackingCategoryId" } ], "get": { "tags": [ "Tracking categories" ], "summary": "Get tracking categories", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingCategoryTree" }, "examples": { "Dynamics 365 Business Central": { "value": { "subCategories": [], "id": "9e1dea89-1e34-ed11-97e8-000d3a872db9", "parentId": "d1391864-77cf-eb11-9f0a-0022481b404b", "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-09-14T11:19:28Z", "name": "A-000-A-Hundreds", "hasChildren": false, "status": "Active" } }, "FreshBooks": { "value": { "subCategories": [], "id": "5389667", "parentId": "4370491", "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2021-05-19T11:09:40", "name": "ABCustomCategory", "hasChildren": false, "status": "Active" } }, "Oracle NetSuite": { "value": { "subCategories": [], "id": "CostEstimateType-AVGCOST", "modifiedDate": "2023-01-30T14:46:52Z", "name": "Average Cost", "hasChildren": false, "status": "Active" } }, "QuickBooks Desktop": { "value": { "subCategories": [ { "subCategories": [], "id": "80000009-1734278606", "parentId": "80000008-1734278594", "modifiedDate": "2023-04-26T09:12:46", "sourceModifiedDate": "2024-12-15T16:03:26", "name": "Subclass", "hasChildren": false, "status": "Active" } ], "id": "80000008-1734278594", "modifiedDate": "2023-04-26T09:12:46Z", "sourceModifiedDate": "2024-12-15T16:03:14", "name": "ClassWithSub", "hasChildren": true, "status": "Active" } }, "QuickBooks Online Sandbox": { "value": { "subCategories": [], "id": "CLASS_5100000000000014491", "parentId": "CLASSES", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2022-03-07T08:28:32Z", "name": "A", "hasChildren": false, "status": "Active" } }, "Sage 50 (UK)": { "value": { "subCategories": [], "id": "department_10", "parentId": "DEPARTMENTS", "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "name": "", "hasChildren": false, "status": "Active" } }, "Sage Business Cloud Accounting": { "value": { "subCategories": [], "id": "department_0", "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2022-03-22T15:33:21", "name": "BallparkContracting", "hasChildren": false, "status": "Active" } }, "Sage Intacct": { "value": { "subCategories": [], "id": "WAREHOUSE-2", "parentId": "WAREHOUSE", "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2020-04-26T05:26:46", "name": "200", "hasChildren": false, "status": "Active" } }, "Xero": { "value": { "subCategories": [], "id": "dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa", "parentId": "9d8ad8f6-0d0f-41e0-8851-ef47e8b54ae6", "modifiedDate": "2023-03-15T20:37:11Z", "name": "Eastside", "hasChildren": false, "status": "Active" } }, "Zoho Books": { "value": { "subCategories": [], "id": "104957000000000323-104957000001510028", "parentId": "104957000000000323", "modifiedDate": "2022-10-03T08:40:39Z", "name": "Down", "hasChildren": false, "status": "Active" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get tracking category* endpoint returns a single tracking category for a given `trackingCategoryId`.\n\n[Tracking categories](https://docs.codat.io/sync-for-payroll-api#/schemas/TrackingCategory) are used to monitor cost centres and control budgets that sit outside the standard set of accounts.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=trackingCategories) for integrations that support getting a specific tracking category.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).\n", "operationId": "get-tracking-category" } }, "/companies/{companyId}/data/info": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "summary": "Get company accounting profile", "description": "Gets the latest basic info for a company.", "operationId": "get-accounting-profile", "x-speakeasy-name-override": "get-accounting-profile", "tags": [ "Company info" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInfo" }, "examples": { "Example 1": { "value": { "companyName": "Codat", "accountingPlatformRef": "1700060034_ETD", "companyLegalName": "Codat Ltd", "addresses": [ { "type": "Billing", "line1": "301 Ink Rooms", "line2": "28 Easton Street", "city": "London", "region": "England", "country": "United Kingdom", "postalCode": "WC1X 0BE" }, { "type": "Delivery", "line1": "28 Easton Street", "city": "London", "country": "UK", "postalCode": "WC1X 0BE" } ], "phoneNumbers": [ { "number": "02012 345678", "type": "Landline" }, { "number": "07123 456789", "type": "Mobile" }, { "number": "02012 345678", "type": "Fax" } ], "webLinks": [ { "type": "Website", "url": "https://www.codat.io/" }, { "type": "Social", "url": "https://www.linkedin.com/company/codat-limited/" } ], "registrationNumber": "5590111724", "taxNumber": "74111622555799035846", "financialYearStartDate": "2023-04-01T00:00:00", "baseCurrency": "GBP", "sourceUrls": { "Api": "https://api.codat.io" }, "createdDate": "2020-03-09T15:19:26" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } } }, "webhooks": { "client.rateLimit.reached": { "post": { "description": "Called when your client’s request count to Codat's API surpasses the allocated quota.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRateLimitWebhook" }, "examples": { "Reached": { "value": { "id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "eventType": "client.rateLimit.reached", "generatedDate": "2024-09-01T00:00:00Z", "payload": { "dailyQuota": 12000, "quotaRemaining": 0, "expiryDate": "2024-09-01T12:14:14Z" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the webhook was received successfully." } } } }, "client.rateLimit.reset": { "post": { "description": "Called when your client's rate limit quota is reset, allowing additional requests to Codat's API.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRateLimitWebhook" }, "examples": { "Reset": { "value": { "id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "eventType": "client.rateLimit.reset", "generatedDate": "2024-09-01T00:00:00Z", "payload": { "dailyQuota": 12000, "quotaRemaining": 11993, "expiryDate": "2024-09-01T23:59:99Z" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the webhook was received successfully." } } } }, "Client rate limit reached": { "post": { "deprecated": true, "description": "Called when your client’s requests to Codat's API exceed the allocated quota. \n\n**Note: This event type is deprecated. Developers should now use the `client.rateLimit.reached` event for handling rate limit notifications.**", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRateLimitReachedWebhook" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the webhook was received successfully." } } } }, "Client rate limit reset": { "post": { "deprecated": true, "description": "Called when the rate limit quota has reset for the client, and more requests to Codat's API are available.\n\nNote: This event type is deprecated. Developers should now use the `client.rateLimit.reset` event for handling rate limit notifications.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRateLimitResetWebhook" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the webhook was received successfully." } } } } }, "components": { "schemas": { "Account": { "title": "Accounting: Account", "description": "> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.\n\nView the coverage for accounts in the Data coverage explorer.\n\n## Overview\n\nAccounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.\n\nThe categories for an account include:\n* Asset\n* Expense\n* Income\n* Liability\n* Equity.\n\nThe same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.\n\nAt the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.\n\nTo determine the list of allowed categories for a specific integration, you can:\n- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/sync-for-payroll-api#/operations/get-create-chartOfAccounts-model).\n- Refer to the integration's own documentation.\n\n> **Accounts with no category**\n>\n> If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.\n>\n> This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports.", "allOf": [ { "properties": { "id": { "type": "string", "description": "Identifier for the account, unique for the company.", "example": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e" } } }, { "$ref": "#/components/schemas/Account/definitions/accountPrototype" }, { "properties": { "metadata": { "title": "Metadata", "type": "object", "x-internal": true, "properties": { "isDeleted": { "type": "boolean", "description": "Indicates whether the record has been deleted in the third-party system this record originated from.", "nullable": true } } } } }, { "title": "Modified dates", "x-internal": true, "allOf": [ { "title": "ModifiedDate", "x-internal": true, "type": "object", "properties": { "modifiedDate": { "allOf": [ { "$ref": "#/components/schemas/Connection/properties/created" }, { "description": "The date when the record was last fetched from the data source and updated in Codat’s data cache. \n\nUse it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today.\n\nThis date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)).\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." } ] } } }, { "title": "Source Modified Date", "x-internal": true, "type": "object", "nullable": true, "properties": { "sourceModifiedDate": { "allOf": [ { "$ref": "#/components/schemas/Connection/properties/created" }, { "description": "The date when a record was last modified in the source platform, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The integration platform does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." } ] } } } ] } ], "definitions": { "accountPrototype": { "title": "Account prototype", "type": "object", "properties": { "nominalCode": { "type": "string", "nullable": true, "description": "Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system.", "example": "610" }, "name": { "type": "string", "nullable": true, "description": "Name of the account.", "example": "Accounts Receivable" }, "description": { "type": "string", "nullable": true, "description": "Description for the account.", "example": "Invoices the business has issued but has not yet collected payment on." }, "fullyQualifiedCategory": { "type": "string", "nullable": true, "description": "Full category of the account. \r\n\r\nFor example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation.", "example": "Asset.Current" }, "fullyQualifiedName": { "type": "string", "nullable": true, "description": "Full name of the account, for example:\n- `Cash On Hand`\n- `Rents Held In Trust`\n- `Fixed Asset`", "examples": [ "Cash On Hand", "Fixed Asset" ] }, "currency": { "title": "Currency", "x-internal": true, "type": "string", "description": "The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.\n\n## Unknown currencies\n\nIn line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. \n\nThere are only a very small number of edge cases where this currency code is returned by the Codat system.", "format": "ISO4217", "examples": [ "GBP", "USD", "EUR" ] }, "currentBalance": { "type": "number", "format": "decimal", "nullable": true, "description": "Current balance in the account.", "example": 0 }, "type": { "$ref": "#/components/schemas/Account/definitions/accountType" }, "status": { "$ref": "#/components/schemas/Account/definitions/accountStatus" }, "isBankAccount": { "type": "boolean", "description": "Confirms whether the account is a bank account or not." }, "validDatatypeLinks": { "type": "array", "nullable": true, "description": "The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/sync-for-payroll-api#/schemas/ValidDataTypeLinks).", "items": { "title": "Valid data type links", "description": "When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.\n\nFor example, `validDatatypeLinks` might indicate the following references:\n\n- Which tax rates are valid to use on the line item of a bill.\n- Which items can be used when creating an invoice. \n\nYou can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example.\n\n## `validDatatypeLinks` example\n\nThe following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error.\n\n```json validDatatypeLinks for an account\n{\n \"id\": \"bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4\",\n \"nominalCode\": \"090\",\n \"name\": \"Business Bank Account\",\n #...\n \"validDatatypeLinks\": [\n {\n \"property\": \"Id\",\n \"links\": [\n \"Payment.AccountRef.Id\",\n \"BillPayment.AccountRef.Id\",\n \"DirectIncome.LineItems.AccountRef.Id\",\n \"DirectCost.LineItems.AccountRef.Id\"\n ]\n }\n ]\n }\n```\n\n\n\n## Support for `validDatatypeLinks`\n\nCodat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. \n\nIf you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap.", "type": "object", "properties": { "property": { "type": "string", "nullable": true, "description": "The property from the account that can be linked." }, "links": { "type": "array", "nullable": true, "description": "Supported `dataTypes` that the record can be linked to.", "items": { "type": "string" } } } } }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, "accountRef": { "title": "Account reference", "type": "object", "description": "Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.", "properties": { "id": { "type": "string", "description": "'id' from the Accounts data type." }, "name": { "type": "string", "description": "'name' from the Accounts data type." } } }, "accountType": { "title": "Account type", "enum": [ "Unknown", "Asset", "Expense", "Income", "Liability", "Equity" ], "type": "string", "description": "Type of account", "example": "Asset" }, "accountStatus": { "title": "Account status", "enum": [ "Unknown", "Active", "Archived", "Pending" ], "type": "string", "description": "Status of the account", "example": "Active" } }, "type": "object" }, "Accounts": { "title": "Accounting: Accounts", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Address": { "title": "Accounting: Address", "x-internal": true, "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Address/definitions/accountingAddressType" }, "line1": { "type": "string", "nullable": true, "description": "Line 1 of the customer address." }, "line2": { "type": "string", "nullable": true, "description": "Line 2 of the customer address." }, "city": { "type": "string", "nullable": true, "description": "City of the customer address." }, "region": { "type": "string", "nullable": true, "description": "Region of the customer address." }, "country": { "type": "string", "nullable": true, "description": "Country of the customer address." }, "postalCode": { "type": "string", "nullable": true, "description": "Postal code or zip code." } }, "required": [ "type" ], "definitions": { "accountingAddressType": { "description": "The type of the address", "type": "string", "enum": [ "Unknown", "Billing", "Delivery" ] } } }, "ClientRateLimitReachedWebhook": { "title": "Client rate limit reached webhook", "x-internal": true, "description": "Webhook request body for a client that has reached their rate limit.", "type": "object", "properties": { "ClientId": { "$ref": "#/components/schemas/ClientRateLimitResetWebhook/properties/ClientId" }, "ClientName": { "$ref": "#/components/schemas/ClientRateLimitResetWebhook/properties/ClientName" }, "RuleId": { "$ref": "#/components/schemas/ClientRateLimitResetWebhook/properties/RuleId" }, "RuleType": { "$ref": "#/components/schemas/ClientRateLimitResetWebhook/properties/RuleType" }, "AlertId": { "$ref": "#/components/schemas/ClientRateLimitResetWebhook/properties/AlertId" }, "Message": { "$ref": "#/components/schemas/ClientRateLimitResetWebhook/properties/Message" }, "Data": { "$ref": "#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData" } }, "definitions": { "ClientRateLimitReachedWebhookData": { "type": "object", "title": "Client rate limit reached webhook data", "properties": { "DailyQuota": { "type": "integer", "description": "The number of available requests per day." }, "ExpiresUtc": { "$ref": "#/components/schemas/Connection/properties/created", "description": "The date time in UTC when your daily quota is reset." } } } }, "examples": [ { "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "ClientName": "Bank of Dave", "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "RuleType": "Rate Limit Reached", "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e", "Message": "The current daily rate limit quota of 1000 requests for bae71d36-ff47-420a-b4a6-f8c9ddf41140 has been reached.", "Data": { "DailyQuota": 1000, "ExpiresUtc": "2023-05-03T00:00:00Z" } } ] }, "ClientRateLimitResetWebhook": { "title": "Client rate limit reset webhook", "x-internal": true, "description": "Webhook request body for a client that has had their rate limit reset.", "type": "object", "properties": { "ClientId": { "title": "Client ID", "type": "string", "format": "uuid", "description": "Unique identifier for your client in Codat." }, "ClientName": { "type": "string", "description": "Name of your client in Codat." }, "RuleId": { "type": "string", "format": "uuid", "description": "Unique identifier for the rule.", "deprecated": true }, "RuleType": { "type": "string", "x-stoplight": { "id": "34d52a089f08a" }, "description": "The type of rule." }, "AlertId": { "type": "string", "format": "uuid", "description": "Unique identifier of the webhook event." }, "Message": { "type": "string", "description": "A human-readable message about the webhook." }, "Data": { "$ref": "#/components/schemas/ClientRateLimitResetWebhook/definitions/ClientRateLimitResetWebhookData" } }, "definitions": { "ClientRateLimitResetWebhookData": { "type": "object", "title": "Client rate limit reset webhook data", "properties": { "QuotaRemaining": { "type": "integer", "description": "Total number of requests remaining for your client.", "nullable": true }, "ResetReason": { "type": "string", "description": "The reason for your rate limit quota being reset." }, "DailyQuota": { "$ref": "#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData/properties/DailyQuota", "nullable": true }, "ExpiresUtc": { "$ref": "#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData/properties/ExpiresUtc", "nullable": true } } } }, "examples": [ { "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "ClientName": "Bank of Dave", "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "RuleType": "Rate Limit Reset", "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e", "Message": "The current daily rate limit quota for client 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e has been reset to 1000 requests.", "Data": { "QuotaRemaining": 1000, "ResetReason": "The quota was reset because it is a new day.", "DailyQuota": 1000, "ExpiresUtc": "2023-05-03T00:00:00Z" } } ] }, "ClientRateLimitWebhook": { "title": "Client rate limit webhook", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "description": "Unique identifier of the event." }, "eventType": { "type": "string", "description": "The type of event.", "examples": [ "client.rateLimit.reset", "client.rateLimit.reached" ] }, "generatedDate": { "$ref": "#/components/schemas/Connection/properties/created", "description": "The date time in UTC the event was generated in Codat." }, "payload": { "$ref": "#/components/schemas/ClientRateLimitWebhook/definitions/clientRateLimitWebhookPayload" } }, "definitions": { "clientRateLimitWebhookPayload": { "title": "Client rate limit webhook payload", "type": "object", "properties": { "dailyQuota": { "type": "integer", "description": "The number of available requests per day." }, "quotaRemaining": { "type": "integer", "description": "Total number of requests remaining for your client." }, "expiryDate": { "$ref": "#/components/schemas/Connection/properties/created", "description": "The date time in UTC when your daily quota is reset." } } } } }, "Companies": { "title": "Companies", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Company": { "title": "Company", "description": "In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-payroll-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.\n\nTypically each company is one of your customers.\n\nWhen you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Company/definitions/companyDetails" }, { "type": "object", "properties": { "dataConnections": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } } } } ], "definitions": { "companyDetails": { "title": "Company details", "type": "object", "properties": { "id": { "$ref": "#/components/parameters/companyId/schema" }, "name": { "type": "string", "description": "The name of the company", "example": "Codat Ltd." }, "description": { "$ref": "#/components/schemas/CompanyRequestBody/properties/description", "nullable": true }, "redirect": { "type": "string", "format": "uri", "description": "The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company.", "example": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739" }, "lastSync": { "$ref": "#/components/schemas/Connection/properties/created", "nullable": true }, "created": { "$ref": "#/components/schemas/Connection/properties/created" }, "createdByUserName": { "type": "string", "description": "Name of user that created the company in Codat.", "nullable": true }, "products": { "type": "array", "items": { "type": "string" }, "description": "An array of products that are currently enabled for the company." }, "tags": { "type": "object", "maxProperties": 10, "propertyNames": { "pattern": "^.{1,27}$" }, "additional properties": { "type": "string", "maxLength": 100 }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." } }, "required": [ "id", "name", "redirect" ] }, "companyReference": { "title": "Company reference", "type": "object", "properties": { "id": { "$ref": "#/components/parameters/companyId/schema" }, "name": { "$ref": "#/components/schemas/Company/definitions/companyDetails/properties/name" }, "description": { "$ref": "#/components/schemas/Company/definitions/companyDetails/properties/description" }, "links": { "type": "object", "description": "A collection of links for the company.", "properties": { "portal": { "type": "string", "format": "uri", "description": "Link to the company page in the portal." } } }, "tags": { "$ref": "#/components/schemas/Company/definitions/companyDetails/properties/tags" } } } }, "examples": [ { "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "tags": { "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z", "sourceType": "Banking" } ] } ] }, "CompanyInfo": { "title": "Accounting: Company profile", "description": "> View the coverage for company profile in the Data coverage explorer.\n\nCompany info provides standard details about a linked company such as their address, phone number, and company registration.\n\n> **Company information or companies?**\n> \n> Company profile is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.", "type": "object", "properties": { "companyName": { "type": "string", "nullable": true, "description": "Name of the linked company." }, "accountingPlatformRef": { "type": "string", "nullable": true, "description": "Identifier or reference for the company in the accounting software." }, "companyLegalName": { "type": "string", "nullable": true, "description": "Registered legal name of the linked company." }, "addresses": { "type": "array", "nullable": true, "description": "An array of Addresses.", "items": { "$ref": "#/components/schemas/Address" } }, "phoneNumbers": { "type": "array", "nullable": true, "description": "An array of phone numbers.", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, "webLinks": { "type": "array", "nullable": true, "description": "An array of weblinks.", "items": { "$ref": "#/components/schemas/WebLink" } }, "ledgerLockDate": { "$ref": "#/components/schemas/Connection/properties/created", "description": "If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end." }, "registrationNumber": { "type": "string", "nullable": true, "description": "Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House." }, "taxNumber": { "type": "string", "nullable": true, "description": "Company tax number." }, "financialYearStartDate": { "$ref": "#/components/schemas/Connection/properties/created", "description": "Start date of the financial year for the company." }, "baseCurrency": { "type": "string", "nullable": true, "description": "Currency set in the accounting software of the linked company. Used by the currency rate." }, "sourceUrls": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true, "description": "URL addresses for the accounting source.\n\nFor example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero)." }, "createdDate": { "$ref": "#/components/schemas/Connection/properties/created", "description": "Date the linked company was created in the accounting software." }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } }, "examples": [ { "companyName": "ACME Corporation", "accountingPlatformRef": "4444e827-401b-4925-92cb-d79086bf3b6b", "companyLegalName": "ACME Corporation Ltd.", "addresses": [ { "type": "Billing", "line1": "Warner House", "line2": "98 Theobald's Road", "city": "London", "region": "", "country": "United Kingdom", "postalcode": "WC1X 8WB" }, { "type": "Unknown", "line1": "123 Sierra Way", "line2": "", "city": "San Pablo", "region": "CA", "country": "", "postalCode": "87999" } ], "phoneNumbers": [ { "number": "010 1234 5678", "type": "Landline" } ], "webLinks": [ { "type": "Website", "url": "https://www.wbsl.com/" } ], "ledgerLockDate": "2019-03-04T12:08:01.881Z", "registrationNumber": "1234567890", "taxNumber": "GB 123456789", "financialYearStartDate": "2019-04-01T00:00:00Z", "baseCurrency": "USD", "sourceUrls": { "url1": "https://go.xero.com/organisationlogin/default.aspx?shortcode=!rxs0Q", "url2": "https://reporting.xero.com/!rxs0Q" }, "createdDate": "2020-02-03T16:42:02Z" } ] }, "CompanyRequestBody": { "title": "Create company request", "x-internal": true, "type": "object", "properties": { "name": { "type": "string", "description": "Name of company being connected.", "pattern": "^[A-Za-z0-9\\s\\-',&@.,?!\\s]+$", "minLength": 1, "example": "Bank of Dave" }, "description": { "type": "string", "example": "Requested early access to the new financing scheme.", "description": "Additional information about the company. This can be used to store foreign IDs, references, etc." }, "tags": { "$ref": "#/components/schemas/Company/definitions/companyDetails/properties/tags" } }, "required": [ "name" ] }, "Connection": { "title": "Connection", "description": "A connection represents a [company's](https://docs.codat.io/sync-for-payroll-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.\n\nA company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:\n\n- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.\n- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.\n- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.\nAny combination of accounting, banking, and commerce data connections is allowed.\n\nBefore you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview).", "type": "object", "properties": { "id": { "$ref": "#/components/parameters/connectionId/schema" }, "integrationId": { "type": "string", "format": "uuid", "example": "fd321cb6-7963-4506-b873-e99593a45e30", "description": "A Codat ID representing the integration." }, "integrationKey": { "type": "string", "description": "A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future." }, "sourceId": { "type": "string", "format": "uuid", "example": "35b92968-9851-4095-ad60-395c95cbcba4", "description": "A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`." }, "sourceType": { "title": "Source Type", "description": "The type of platform of the connection.", "type": "string", "enum": [ "Accounting", "Banking", "BankFeed", "Commerce", "Expense", "Other", "Unknown" ], "example": "Accounting" }, "platformName": { "type": "string", "description": "Name of integration connected to company." }, "linkUrl": { "type": "string", "format": "uri", "description": "The link URL your customers can use to authorize access to their business application.", "example": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start" }, "status": { "$ref": "#/components/schemas/Connection/definitions/dataConnectionStatus" }, "lastSync": { "$ref": "#/components/schemas/Connection/properties/created", "nullable": true }, "created": { "title": "Date time", "type": "string", "examples": [ "2022-10-23T00:00:00.000Z", "2022-10-23T00:00:00.000Z" ], "description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced." }, "dataConnectionErrors": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Connection/definitions/dataConnectionError" } }, "connectionInfo": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } } }, "additionalProperties": false, "required": [ "id", "integrationId", "integrationKey", "sourceId", "platformName", "linkUrl", "status", "created", "sourceType" ], "definitions": { "dataConnectionStatus": { "title": "Data connection status", "description": "The current authorization status of the data connection.", "type": "string", "enum": [ "PendingAuth", "Linked", "Unlinked", "Deauthorized" ] }, "dataConnectionError": { "title": "Data connection error", "type": "object", "properties": { "statusCode": { "type": "string", "description": "The HTTP status code returned by the source platform when the error occurred." }, "statusText": { "type": "string", "description": "A non-numeric status code/text returned by the source platform when the error occurred." }, "errorMessage": { "type": "string", "description": "A message about a error returned by Codat." }, "erroredOnUtc": { "$ref": "#/components/schemas/Connection/properties/created" }, "status": { "title": "Error status", "description": "The current status of a transient error. Null statuses indicate that the error is not transient.", "type": "string", "nullable": true, "enum": [ "Active", "Resolved" ] }, "resolvedOnUtc": { "description": "The datetime in Utc that the error was resolved.", "nullable": true, "$ref": "#/components/schemas/Connection/properties/created" } } }, "dataConnectionSourceType": { "title": "Source Type", "description": "The type of platform of the connection.", "type": "string", "enum": [ "Accounting", "Banking", "BankFeed", "Commerce", "Expense", "Other", "Unknown" ], "example": "Accounting" } }, "example": { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z", "sourceType": "Banking" } }, "Connections": { "title": "Connections", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "CreateAccountResponse": { "title": "Accounting: Create account response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Account" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperation" } ] }, "CreateJournalEntryResponse": { "title": "Accounting: Create journal entry response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JournalEntry" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperation" } ] }, "CreateJournalResponse": { "title": "Accounting: Create journal response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Journal" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperation" } ] }, "DataStatus": { "title": "Data status", "description": "Describes the state of data in the Codat cache for a company and data type", "type": "object", "required": [ "dataType", "lastSuccessfulSync", "currentStatus" ], "properties": { "dataType": { "title": "Data types", "x-internal": true, "type": "string", "description": "Available data types", "enum": [ "accountTransactions", "balanceSheet", "bankAccounts", "bankTransactions", "billCreditNotes", "billPayments", "bills", "cashFlowStatement", "chartOfAccounts", "company", "creditNotes", "customers", "directCosts", "directIncomes", "invoices", "itemReceipts", "items", "journalEntries", "journals", "paymentMethods", "payments", "profitAndLoss", "purchaseOrders", "salesOrders", "suppliers", "taxRates", "trackingCategories", "transfers", "banking-accountBalances", "banking-accounts", "banking-transactionCategories", "banking-transactions", "commerce-companyInfo", "commerce-customers", "commerce-disputes", "commerce-locations", "commerce-orders", "commerce-paymentMethods", "commerce-payments", "commerce-productCategories", "commerce-products", "commerce-taxComponents", "commerce-transactions" ], "example": "invoices" }, "lastSuccessfulSync": { "$ref": "#/components/schemas/Connection/properties/created" }, "currentStatus": { "$ref": "#/components/schemas/PullOperation/properties/status" }, "latestSyncId": { "type": "string", "description": "Unique identifier for most recent sync of data type.", "format": "uuid", "example": "ad474a37-2003-478e-baee-9af9f1ec2fe3" }, "latestSuccessfulSyncId": { "type": "string", "description": "Unique identifier for the most recent successful sync of data type.", "format": "uuid", "example": "8220fc90-55b6-47bc-9417-48ac6ea93101" } }, "examples": [ { "dataType": "string", "lastSuccessfulSync": "2022-01-01T13:00:00.000Z", "currentStatus": "string", "latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3", "latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101" } ] }, "DataStatusResponse": { "x-internal": true, "title": "Data status response", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataStatus" } }, "DataType": { "x-internal": true, "$ref": "#/components/schemas/DataStatus/properties/dataType" }, "ErrorMessage": { "title": "Error message", "type": "object", "x-internal": true, "properties": { "statusCode": { "type": "integer", "description": "The HTTP status code returned by the error." }, "service": { "type": "string", "description": "Codat's service the returned the error." }, "error": { "type": "string", "description": "A brief description of the error." }, "correlationId": { "type": "string", "description": "Unique identifier used to propagate to all downstream services and determine the source of the error." }, "validation": { "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidation" }, "canBeRetried": { "type": "string", "description": "`True` if the error occurred transiently and can be retried." }, "detailedErrorCode": { "type": "integer", "description": "Machine readable error code used to automate processes based on the code returned." } }, "definitions": { "errorValidation": { "title": "Validation error", "type": "object", "nullable": true, "description": "A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.", "properties": { "errors": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidationItem" } }, "warnings": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidationItem" } } } }, "errorValidationItem": { "title": "Validation error item", "type": "object", "properties": { "itemId": { "type": "string", "nullable": true, "description": "Unique identifier for a validation item." }, "message": { "type": "string", "nullable": true, "description": "A message outlining validation item's issue." }, "validatorName": { "type": "string", "nullable": true, "description": "Name of validator." } } } } }, "Journal": { "title": "Accounting: Journal", "description": "> **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) data type\n\n> View the coverage for journals in the Data coverage explorer.\n\n## Overview\n\nIn accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business.\n\nWhen a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries.\n\nSuch journals can be divided into two categories:\n\n- Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal.\n- General journals: journals used to record transactions that fall outside the scope of the special journals.\n\nMultiple journals or subjournals are used in the following Codat integrations:\n\n- [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory)\n- [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory)\n- [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional)\n\n> When pushing journal entries to an accounting software that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object.\n", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Journal ID." } } }, { "$ref": "#/components/schemas/Journal/definitions/journalPrototype" }, { "properties": { "metadata": { "$ref": "#/components/schemas/Account/allOf/2/properties/metadata" } } }, { "$ref": "#/components/schemas/Account/allOf/3" } ], "definitions": { "journalPrototype": { "type": "object", "properties": { "journalCode": { "type": "string", "nullable": true, "description": "Native journal number or code." }, "name": { "type": "string", "nullable": true, "description": "Journal name.\nThe maximum length for a journal name is 256 characters. All characters above that number will be truncated." }, "type": { "type": "string", "nullable": true, "description": "The type of the journal." }, "parentId": { "type": "string", "nullable": true, "description": "Parent journal ID.\nIf the journal is a parent journal, this value is not present." }, "hasChildren": { "type": "boolean", "description": "If the journal has child journals, this value is true. If it doesn’t, it is false." }, "createdOn": { "$ref": "#/components/schemas/Connection/properties/created", "description": "Journal creation date." }, "status": { "$ref": "#/components/schemas/Journal/definitions/journalStatus" } } }, "journalRef": { "title": "Journal reference", "type": "object", "additionalProperties": false, "description": "Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals).", "properties": { "id": { "minLength": 1, "type": "string", "description": "GUID of the underlying journal." }, "name": { "type": "string", "maxLength": 256, "nullable": true, "description": "Name of journal" } }, "required": [ "id" ] }, "journalStatus": { "type": "string", "description": "Current journal status.", "enum": [ "Unknown", "Active", "Archived" ] } } }, "JournalEntries": { "title": "Accounting: Journal entries", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntry" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "JournalEntry": { "title": "Accounting: Journal entry", "description": "> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/sync-for-payroll-api#/schemas/Journal) data type\n\n> View the coverage for journal entries in the Data coverage explorer.\n\n## Overview\n\nA journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.\n\nA journal entry line item is a single transaction line on the journal entry. For example: \n\n- When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. \n- When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue.\n\nIn Codat a journal entry contains details of:\n\n- The date on which the entry was created and posted.\n- Itemised lines, including amounts and currency.\n- A reference to the associated accounts.\n- A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger. \n\n> **Pushing journal entries** \n> Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the journal entry for the company in the accounting software." }, "description": { "type": "string", "nullable": true, "description": "Optional description of the journal entry." }, "postedOn": { "$ref": "#/components/schemas/Connection/properties/created", "description": "Date on which the journal entry was posted to the accounting software, and had an impact on the general ledger. This may be different from the creation date.\n\nFor example, a user creates a journal entry on Monday and saves it as draft, which has no impact on the general ledger. On Thursday, they return to the entry and post it.\n\nThe **createdOn** date shows as Monday.\nThe **postedOn** date shows as Thursday.\nJournal entries can also be backdated, so the **postedOn** date may be earlier than the **createdOn** date." }, "createdOn": { "$ref": "#/components/schemas/Connection/properties/created", "description": "Date on which the journal was created in the accounting software." }, "updatedOn": { "$ref": "#/components/schemas/Connection/properties/created", "description": "Date on which the journal was last updated in the accounting software." }, "journalRef": { "$ref": "#/components/schemas/Journal/definitions/journalRef" }, "journalLines": { "type": "array", "nullable": true, "description": "An array of journal lines.", "items": { "$ref": "#/components/schemas/JournalEntry/definitions/journalLine" } }, "recordRef": { "$ref": "#/components/schemas/JournalEntry/definitions/journalEntryRecordRef" }, "metadata": { "$ref": "#/components/schemas/Account/allOf/2/properties/metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/Account/allOf/3" } ], "definitions": { "journalLine": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "Description of the journal line item." }, "netAmount": { "type": "number", "format": "decimal", "description": "Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative." }, "currency": { "type": "string", "nullable": true, "description": "Currency for the journal line item." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef" }, "tracking": { "description": "List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)", "title": "Tracking", "type": "object", "properties": { "recordRefs": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef" }, "nullable": true } }, "definitions": { "trackingRecordRef": { "type": "object", "title": "Record reference", "description": "Links to the customer or tracking category.", "properties": { "id": { "type": "string", "description": "'id' of the underlying record or data type." }, "dataType": { "type": "string", "description": "Name of underlying data type.", "enum": [ "customers", "suppliers", "trackingCategories" ], "example": "trackingCategories" } } } } }, "contactRef": { "title": "Contact reference", "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Unique identifier for a customer or supplier." }, "dataType": { "type": "string", "nullable": true, "description": "Allowed name of the 'dataType'.", "enum": [ "customers", "suppliers" ] } }, "required": [ "id" ] } }, "required": [ "netAmount" ] }, "journalEntryRecordRef": { "type": "object", "title": "Record reference", "description": "Links a journal entry to the underlying record that created it.", "properties": { "id": { "type": "string", "description": "'id' of the underlying record or data type." }, "dataType": { "type": "string", "description": "Name of underlying data type.", "enum": [ "bankTransactions", "billCreditNotes", "billPayments", "bills", "creditNotes", "directCosts", "directIncomes", "invoices", "journalEntries", "payments", "transfers" ], "example": "transfers" } } } } }, "Journals": { "title": "Accounting: Journals", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "PagingInfo": { "type": "object", "title": "Pagination information", "x-internal": true, "properties": { "pageNumber": { "type": "integer", "description": "Current page number." }, "pageSize": { "type": "integer", "description": "Number of items to return in results array.", "maximum": 2000 }, "totalResults": { "type": "integer", "description": "Total number of items." }, "_links": { "$ref": "#/components/schemas/PagingInfo/definitions/links" } }, "definitions": { "links": { "title": "Hal Links", "type": "object", "required": [ "self", "current" ], "properties": { "self": { "$ref": "#/components/schemas/PagingInfo/definitions/halRef" }, "current": { "$ref": "#/components/schemas/PagingInfo/definitions/halRef" }, "next": { "$ref": "#/components/schemas/PagingInfo/definitions/halRef" }, "previous": { "$ref": "#/components/schemas/PagingInfo/definitions/halRef" } }, "examples": [ { "self": { "href": "/companies" }, "current": { "href": "/companies?page=1&pageSize=10" } } ] }, "halRef": { "title": "Hypertext reference", "type": "object", "properties": { "href": { "type": "string", "format": "uri-reference", "description": "Uri hypertext reference." } } } }, "required": [ "pageNumber", "pageSize", "totalResults", "_links" ], "examples": [ { "pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": { "self": { "href": "/companies/{id}/data/{dataType}" }, "current": { "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10" } } } ] }, "PhoneNumber": { "title": "Phone", "type": "object", "x-internal": true, "properties": { "number": { "type": "string", "nullable": true, "examples": [ "+44 25691 154789", "(877) 492-8687", "01224 658 999" ], "description": "A phone number." }, "type": { "$ref": "#/components/schemas/PhoneNumber/definitions/phoneNumberType" } }, "required": [ "type" ], "definitions": { "phoneNumberType": { "description": "The type of phone number", "type": "string", "enum": [ "Primary", "Landline", "Mobile", "Fax", "Unknown" ] } } }, "PullOperation": { "title": "Pull operation", "description": "Information about a queued, in progress or completed pull operation.\n*Formally called `dataset`*", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the pull operation.", "example": "943accd0-4247-42d8-865b-363c8629e1da" }, "companyId": { "type": "string", "format": "uuid", "description": "Unique identifier of the company associated to this pull operation.", "example": "22ece347-e5f6-4896-95e0-35a4c7f17023" }, "connectionId": { "type": "string", "format": "uuid", "description": "Unique identifier of the connection associated to this pull operation.", "example": "50830828-7d39-4367-b0eb-5ddb2de5faa5" }, "dataType": { "title": "Data types", "x-internal": true, "type": "string", "description": "The data type you are requesting in a pull operation." }, "status": { "title": "Dataset status", "type": "string", "description": "The current status of the dataset.", "enum": [ "Initial", "Queued", "Fetching", "MapQueued", "Mapping", "Complete", "FetchError", "MapError", "InternalError", "ProcessingQueued", "Processing", "ProcessingError", "ValidationQueued", "Validating", "ValidationError", "AuthError", "Cancelled", "NotSupported", "RateLimitError", "PermissionsError", "PrerequisiteNotMet" ] }, "statusDescription": { "type": "string", "nullable": true, "description": "Additional information about the dataset status.", "example": "Paused until 2022-10-23T00:00:00.000Z" }, "errorMessage": { "type": "string", "nullable": true, "description": "A message about a transient or persistent error returned by Codat or the source platform." }, "requested": { "$ref": "#/components/schemas/Connection/properties/created" }, "completed": { "$ref": "#/components/schemas/Connection/properties/created" }, "progress": { "type": "integer", "description": "An integer signifying the progress of the pull operation." }, "isCompleted": { "type": "boolean", "description": "`True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead." }, "isErrored": { "type": "boolean", "description": "`True` if the pull operation entered an error state." } }, "required": [ "id", "companyId", "connectionId", "dataType", "status", "requested", "progress", "isCompleted", "isErrored" ], "examples": [ { "id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "statusDescription": "Paused until 2022-10-23T00:00:00.000Z", "requested": "2022-11-14T11:18:37.2798351Z", "progress": 10, "isCompleted": false, "isErrored": false } ] }, "PullOperations": { "title": "Pull operations", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/PullOperation" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "PushOperation": { "title": "Push operation", "type": "object", "x-internal": true, "properties": { "changes": { "type": "array", "nullable": true, "description": "Contains a single entry that communicates which record has changed and the manner in which it changed. ", "items": { "$ref": "#/components/schemas/PushOperation/definitions/pushOperationChange" } }, "dataType": { "$ref": "#/components/schemas/DataStatus/properties/dataType", "description": "The type of data being pushed, eg invoices, customers." }, "companyId": { "$ref": "#/components/parameters/companyId/schema" }, "pushOperationKey": { "type": "string", "format": "uuid", "description": "A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted." }, "dataConnectionKey": { "$ref": "#/components/parameters/connectionId/schema" }, "requestedOnUtc": { "$ref": "#/components/schemas/Connection/properties/created", "description": "The datetime when the push was requested." }, "completedOnUtc": { "$ref": "#/components/schemas/Connection/properties/created", "description": "The datetime when the push was completed, null if Pending." }, "timeoutInMinutes": { "type": "integer", "format": "int32", "nullable": true, "description": "Number of minutes the push operation must complete within before it times out." }, "timeoutInSeconds": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true, "description": "Number of seconds the push operation must complete within before it times out." }, "status": { "$ref": "#/components/schemas/PushOperation/definitions/pushOperationStatus" }, "errorMessage": { "type": "string", "nullable": true, "description": "A message about the error." }, "validation": { "$ref": "#/components/schemas/PushOperation/definitions/validation" }, "statusCode": { "type": "integer", "description": "Push status code." } }, "required": [ "companyId", "pushOperationKey", "dataConnectionKey", "requestedOnUtc", "status", "statusCode" ], "definitions": { "validation": { "type": "object", "title": "Validation", "description": "A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.", "properties": { "errors": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PushOperation/definitions/validationItem" } }, "warnings": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PushOperation/definitions/validationItem" } } } }, "validationItem": { "title": "Validation item", "type": "object", "properties": { "itemId": { "type": "string", "nullable": true, "description": "Unique identifier for a validation item." }, "message": { "type": "string", "nullable": true, "description": "A message outlining validation item's issue." }, "validatorName": { "type": "string", "nullable": true, "description": "Name of validator." } }, "additionalProperties": false }, "pushChangeType": { "title": "Push change type", "description": "Type of change being applied to record in third party platform.", "type": "string", "enum": [ "Unknown", "Created", "Modified", "Deleted", "AttachmentUploaded" ] }, "pushOperationRef": { "title": "Push operation reference", "x-internal": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for a push operation." }, "dataType": { "$ref": "#/components/schemas/DataStatus/properties/dataType", "nullable": true } }, "additionalProperties": false }, "pushOperationStatus": { "title": "Push operation status", "type": "string", "enum": [ "Pending", "Failed", "Success", "TimedOut" ], "description": "The current status of the push operation." }, "pushOperationChange": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PushOperation/definitions/pushChangeType" }, "recordRef": { "$ref": "#/components/schemas/PushOperation/definitions/pushOperationRef" }, "attachmentId": { "type": "string", "description": "Unique identifier for the attachment created otherwise null.", "nullable": true } } } } }, "PushOperations": { "title": "Push operations", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/PushOperation" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "PushOption": { "title": "Push option", "x-internal": true, "required": [ "displayName", "required", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionType" }, "displayName": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName" }, "description": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description" }, "required": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty" }, "nullable": true }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionChoice" }, "nullable": true }, "validation": { "$ref": "#/components/schemas/PushOption/definitions/pushValidationInfo", "nullable": true } }, "definitions": { "pushOptionProperty": { "title": "Push Option Property", "required": [ "description", "displayName", "required", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionType" }, "displayName": { "minLength": 1, "type": "string", "description": "The property's display name." }, "description": { "type": "string", "description": "A description of the property." }, "required": { "type": "boolean", "description": "The property is required if `True`." }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty" }, "nullable": true }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionChoice" }, "nullable": true }, "validation": { "$ref": "#/components/schemas/PushOption/definitions/pushValidationInfo" } } }, "pushValidationInfo": { "title": "Push validation info", "type": "object", "properties": { "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/PushOption/definitions/pushFieldValidation" }, "nullable": true }, "information": { "type": "array", "items": { "$ref": "#/components/schemas/PushOption/definitions/pushFieldValidation" }, "nullable": true } }, "additionalProperties": false }, "pushFieldValidation": { "title": "Push field validation", "required": [ "details" ], "type": "object", "properties": { "field": { "type": "string", "description": "Field name that resulted in the validation issue." }, "details": { "minLength": 1, "type": "string", "description": "Details on the validation issue." }, "ref": { "type": "string", "format": "uri", "nullable": true, "description": "Unique reference identifier for the validation issue." } }, "additionalProperties": false }, "pushOptionType": { "title": "Option Type", "description": "The option type.", "enum": [ "Array", "Object", "String", "Number", "Boolean", "DateTime", "File", "MultiPart" ], "type": "string" }, "pushOptionChoice": { "title": "Push Option Choice", "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "description": "Allowed value for field." }, "type": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionType" }, "displayName": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName" }, "description": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description" }, "required": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required" } } } } }, "SupplementalData": { "title": "Supplemental data", "type": "object", "x-internal": true, "description": "Supplemental data is additional data you can include in our standard data types. \n\nIt is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data.", "properties": { "content": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true }, "nullable": true } } }, "TrackingCategories": { "title": "Accounting: Tracking categories", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "TrackingCategory": { "title": "Accounting: Tracking category", "description": "Details of a category used for tracking transactions.\n\n> Language tip\n>\n> Parameters used to track types of spend in various parts of an organization can be called **dimensions**, **projects**, **classes**, or **locations** in different accounting software. In Codat, we refer to these as tracking categories.\n\nView the coverage for tracking categories in the Data coverage explorer.\n\n## Overview\n\nTracking categories are used to monitor cost centres and control budgets that sit outside the standard chart of accounts. Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers.\n\nFrom their accounting system, customers can: \n\n- Create and maintain tracking categories and tracking category types.\n- View all tracking categories that are available for use.\n- View the relationships between the categories.\n- Assign invoices, bills, credit notes, or bill credit notes to one or more categories.\n- View the categories that a transaction belongs to.\n- View all transactions in a tracking category.\n\n### Tracking categories per platform\n\nReview the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform. \n\n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
PlatformTracking categoryTracking level
Dynamics 365DimensionsLine item
FreshbooksExpense categoriesLine item
MYOBCategoriesTransaction
NetsuiteClassesLine item
LocationsLine item
DepartmentsLine item
Custom segmentsLine item
QuickBooks DesktopClassesLine item or transaction level
LocationsTransaction
QuickBooks OnlineClassesLine item or transaction level
LocationsTransaction
Sage 200Cost centersLine item
DepartmentsLine item
Analysis codesTransaction
Sage 50DepartmentsLine item
CostcodesLine item
ProjectsLine item
Sage IntacctDimensionsLine item
XeroTracking categoriesLine item
\n\n> **Example use case**\n>\n> Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**.\n\nIf a tracking category has a parent category, the ID of that parent category is displayed. There is also a `hasChildren` field that shows whether there are child subcategories nested beneath. ", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the item, unique per tracking category.", "nullable": true }, "name": { "type": "string", "description": "The name of the tracking category.", "nullable": true }, "status": { "$ref": "#/components/schemas/TrackingCategory/definitions/status" }, "parentId": { "type": "string", "description": "The identifier for this item's immediate parent.", "nullable": true }, "hasChildren": { "type": "boolean", "description": "Boolean value indicating whether this category has SubCategories." }, "metadata": { "$ref": "#/components/schemas/Account/allOf/2/properties/metadata" } } }, { "$ref": "#/components/schemas/Account/allOf/3" } ], "definitions": { "trackingCategoryRef": { "required": [ "id" ], "type": "object", "description": "References a category against which the item is tracked.", "deprecated": true, "properties": { "id": { "minLength": 1, "type": "string", "description": "Unique identifier to the tracking category." }, "name": { "type": "string", "nullable": true, "description": "Name of tracking category." } } }, "status": { "title": "Tracking category status", "type": "string", "description": "Current state of the tracking category.", "enum": [ "Unknown", "Active", "Archived" ] } }, "examples": [ { "id": "string", "name": "string", "status": "Unknown", "parentId": "string", "hasChildren": true, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z" } ] }, "TrackingCategoryTree": { "title": "Accounting: Tracking category tree", "description": "The full structure of a specific tracking category including any child or subcategories.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the item, unique per tracking category", "nullable": true }, "name": { "type": "string", "description": "The name of the tracking category", "nullable": true }, "status": { "$ref": "#/components/schemas/TrackingCategory/definitions/status" }, "parentId": { "type": "string", "description": "The identifier for this item's immediate parent", "nullable": true }, "hasChildren": { "type": "boolean", "description": "Boolean value indicating whether this category has SubCategories" }, "subCategories": { "type": "array", "nullable": true, "description": "A collection of subcategories that are nested beneath this category.", "items": { "$ref": "#/components/schemas/TrackingCategoryTree" } }, "metadata": { "$ref": "#/components/schemas/Account/allOf/2/properties/metadata" } } }, { "$ref": "#/components/schemas/Account/allOf/3" } ] }, "WebLink": { "title": "Weblink", "description": "Weblink associated with the company.", "type": "object", "properties": { "type": { "description": "The type of the weblink.", "type": "string", "enum": [ "Website", "Social", "Unknown" ] }, "url": { "description": "The full URL for the weblink.", "type": "string", "format": "url" } }, "example": { "type": "Website", "url": "https://codat.io" } } }, "parameters": { "page": { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 1, "example": 1, "default": 1 }, "description": "Page number. [Read more](https://docs.codat.io/using-the-api/paging)." }, "pageSize": { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100, "example": 100, "minimum": 1, "maximum": 5000 }, "description": "Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)." }, "query": { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "example": "id=e3334455-1aed-4e71-ab43-6bccf12092ee", "description": "Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)." }, "orderBy": { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "example": "-modifiedDate" }, "description": "Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)." }, "companyId": { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "8a210b68-6988-11ed-a1eb-0242ac120002", "description": "Unique identifier for your SMB in Codat." }, "description": "Unique identifier for a company." }, "connectionId": { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "description": "Unique identifier for a company's data connection." }, "description": "Unique identifier for a connection." }, "journalId": { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for a journal." }, "journalEntryId": { "name": "journalEntryId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/accountId/schema/examples" } }, "description": "Unique identifier for a journal entry." }, "trackingCategoryId": { "name": "trackingCategoryId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for a tracking category." }, "dataType": { "name": "dataType", "description": "The key of a Codat data type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/DataType" } }, "datasetId": { "name": "datasetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Unique identifier for the dataset that completed its sync." }, "description": "Unique identifier for the dataset that completed its sync." }, "accountId": { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "examples": [ "13d946f0-c5d5-42bc-b092-97ece17923ab", "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2", 7110701885, "EILBDVJVNUAGVKRQ" ] }, "description": "Unique identifier for an account." }, "timeoutInMinutes": { "name": "timeoutInMinutes", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Time limit for the push operation to complete before it is timed out." }, "allowSyncOnPushComplete": { "name": "allowSyncOnPushComplete", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Allow a sync upon push completion." }, "forceUpdate": { "name": "forceUpdate", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting software, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check." } }, "responses": { "BadRequest": { "description": "The request made is not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Malformed query": { "value": { "statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Unauthorized": { "description": "Your API request was not properly authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Unauthorized": { "value": { "statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Payment-Required": { "description": "An account limit has been exceeded. The type of limit is described in the error property:\n\n- You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request.\n- The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan.\n- Your Free account is older than 365 days and has expired. Contact support@codat.io.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 429, "service": "PublicApi", "error": "You have exceeded the 50-company limit that applies to a Free plan. We recommend that you delete any companies you no longer need and retry the request.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Forbidden": { "description": "You are using an outdated API key or a key not associated with that resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 403, "service": "PublicApi", "error": "You are using an outdated API key or a key not associated with that resource.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Not-Found": { "description": "One or more of the resources you referenced could not be found.\nThis might be because your company or data connection id is wrong, or was already deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Data connection not found": { "value": { "statusCode": 404, "service": "PublicApi", "error": "Data connection a22dd66b-564a-4832-9b37-7b3ce4aeb7de not found", "correlationId": "8fa2b5f4794970a4ee73758f612e8df0", "canBeRetried": "Unknown", "detailedErrorCode": 0 } }, "Company not found": { "value": { "statusCode": 404, "service": "ClientsApi", "error": "No company was found with ID 846ed55c-974b-4392-a1f1-87b6fdbf3c5e", "correlationId": "0a40c2f31fc8f992fb88b0853e4166f3", "canBeRetried": "Unknown", "detailedErrorCode": 0 } }, "No data available": { "value": { "statusCode": 404, "service": "PublicApi", "error": "No data available for accounts for ID e5889b459f544926ac5b8e6756df2s", "correlationId": "0a40c2f31fc8f992fb88b0853e4166f3", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Too-Many-Requests": { "description": "Too many requests were made in a given amount of time. Wait a short period and then try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 429, "service": "PublicApi", "error": "You have made too many requests in a given amount of time; please retry later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Malformed-Query": { "description": "Your `query` parameter was not correctly formed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Malformed query": { "value": { "statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } }, "Unresolved property": { "value": { "statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Conflict": { "description": "The data type's dataset has not been requested or is still syncing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 409, "service": "PublicApi", "error": "The data set has not been requested.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Internal-Server-Error": { "description": "There is a problem with our server. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 500, "service": "PublicApi", "error": "There is a problem with our server. Please try again later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Service-Unavailable": { "description": "The Codat API is temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 500, "service": "PublicApi", "error": "The Codat API is temporarily offline for maintenance. Please try again later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } } }, "securitySchemes": { "auth_header": { "name": "Authorization", "description": "The word \"Basic\" followed by a space and your API key. [API keys](https://docs.codat.io/sync-for-payroll-api#/schemas/apiKeys) are tokens used to control access to the API. You can get an API key via [the Codat Portal](https://app.codat.io/developers/api-keys), via [the API](https://docs.codat.io/codat-api#/api-keys/api-keys-list), or [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat.", "type": "apiKey", "in": "header", "x-speakeasy-example": "Basic BASE_64_ENCODED(API_KEY)" } } } }