Accounting Data API

Description

These APIs are used to verify the party's accounting platform and thereafter fetch the financial statements for accounting purposes.

Definition

POST {{Org_URL}}/services/apexrest/intframework/v2/invokeIntegrationService

Authentication Type

Basic Salesforce Auth 2.0

See this link for SFDC Documentation: https://help.salesforce.com/articleView?id=remoteaccess_oauth_web_server_flow.htm&type=5

Parameters

Request Header Parameters

The following table provides the details of the request header parameters used by this web service:

Key	Value
Content-Type	application/JSON
charset	UTF-8
Accept	application/JSON

Request Body Parameters

The following table provides the details of the request body parameters used by this web service:

Field Name	Type	Description
integrationFamily	String	This field represent the integration family of the API.
apiType	String	This field represents the API type.
executionPriority	String	This field represents the execution priority of the API.
idsForFiltersMap	Object	This field represents the map of input parameters required for the API.
optionalRequestParamsMap	Object	This field represents the map of optional input parameters required for the API.

Error Messages

When you use this web service you can receive the following possible error messages:

Status Code	Error Message
500	Internal Server Error.

The following block displays a sample request:

Sample Request

Codat Fetch All Integration: 

{
	"integrationFamily": "Accounting Data",
	"apiType": "Fetch All Integration",
	"executionPriority": "1",
	"idsForFiltersMap": {
	}
}   


Codat Initiate Company:

{
	"integrationFamily": "Accounting Data",
	"apiType": "Initiate Connection",
	"executionPriority": "1",
	"idsForFiltersMap": {
		"accountId": "{{Account_Id}}"	},
	"optionalRequestParamsMap": {
		"platformType": "{{Key}}"	}
}


Codat Remove Connection:
 
{
	"integrationFamily": "Accounting Data",
	"apiType": "Remove Connection",
	"executionPriority": "1",
	"idsForFiltersMap": {
		"accountId": "{{Account_Id}}"  	}
}  


Codat Fetch All Categories:

 {
	"integrationFamily": "Accounting Data",
    "apiType": "Fetch All Categories",
	"executionPriority": "1",
	"idsForFiltersMap": {

	}
}

Codat Fetch Confirmed Categories: 

 {
	"integrationFamily": "Accounting Data",
	"apiType": "Fetch Confirmed Categories",
	"executionPriority": "1",
	"idsForFiltersMap": {
		"accountId": "{{Account_Id}}"	}
}

Codat Update Account Categories:

{
    "integrationFamily": "Accounting Data",
    "apiType": "Update Categories",
    "executionPriority": "1",
    "idsForFiltersMap": {
        "accountId": "{{Account_Id}}"    },
    "optionalRequestParamsMap": {
        "requestPayload": "{{requestPayload}}"    }
}  

Codat Get Enhanced Income Statement:

{
	"integrationFamily": "Accounting Data",
	"apiType": "Get Enhanced Income Statement",
	"executionPriority": "1",
	"idsForFiltersMap": {
		"accountId": "{{Account_Id}}"    },
	"optionalRequestParamsMap": {
		"reportDate": "yyyy-MM-dd"    }
}

Codat Get Enhanced Balance Sheet Statement:

{
	"integrationFamily": "Accounting Data",
	"apiType": "Get Enhanced Balance Sheet Statement",
	"executionPriority": "1",
	"idsForFiltersMap": {
		"accountId": "{{Account_Id}}"    },
	"optionalRequestParamsMap": {
		"reportDate": "yyyy-MM-dd"    }
}