Initiates the process of synchronising basic info for a company
643 matches
100 actions
Accounting
100 actions
- Aged creditors reportGETv1.0.0
- Aged debtors reportGETv1.0.0
- Create accountPOSTv1.0.0
- Create bank accountPOSTv1.0.0
- Create billPOSTv1.0.0
- Create bill credit notePOSTv1.0.0
- Create bill paymentsPOSTv1.0.0
- Create credit notePOSTv1.0.0
- Create customerPOSTv1.0.0
- Create direct costPOSTv1.0.0
- Create direct incomePOSTv1.0.0
- Create invoicePOSTv1.0.0
- Create itemPOSTv1.0.0
- Create journalPOSTv1.0.0
- Create journal entryPOSTv1.0.0
- Create paymentPOSTv1.0.0
- Create purchase orderPOSTv1.0.0
- Create suppliersPOSTv1.0.0
- Create transferPOSTv1.0.0
- Delete billDELETEv1.0.0
- Get accountGETv1.0.0
- Get account transactionGETv1.0.0
- Get balance sheetGETv1.0.0
- Get bank accountGETv1.0.0
- Get bank accountGETv1.0.0
- Get billGETv1.0.0
- Get bill attachmentGETv1.0.0
- Get bill credit noteGETv1.0.0
- Get bill paymentGETv1.0.0
- Get cash flow statementGETv1.0.0
- Get company infoGETv1.0.0
- Get create account modelGETv1.0.0
- Get create bill payment modelGETv1.0.0
- Get create direct cost modelGETv1.0.0
- Get create direct income modelGETv1.0.0
- Get create item modelGETv1.0.0
- Get create journal entry modelGETv1.0.0
- Get create journal modelGETv1.0.0
- Get create payment modelGETv1.0.0
- Get create transfer modelGETv1.0.0
- Get create/update bank account modelGETv1.0.0
- Get create/update bill credit note modelGETv1.0.0
- Get create/update bill modelGETv1.0.0
- Get create/update credit note modelGETv1.0.0
- Get create/update customer modelGETv1.0.0
- Get create/update invoice modelGETv1.0.0
- Get create/update purchase order modelGETv1.0.0
- Get create/update supplier modelGETv1.0.0
- Get credit noteGETv1.0.0
- Get customerGETv1.0.0
- Get customer attachmentGETv1.0.0
- Get direct costGETv1.0.0
- Get direct cost attachmentGETv1.0.0
- Get direct incomeGETv1.0.0
- Get direct income attachmentGETv1.0.0
- Get direct incomesGETv1.0.0
- Get invoiceGETv1.0.0
- Get invoice attachmentGETv1.0.0
- Get invoice attachmentsGETv1.0.0
- Get itemGETv1.0.0
- Get journalGETv1.0.0
- Get journal entryGETv1.0.0
- Get paymentGETv1.0.0
- Get payment methodGETv1.0.0
- Get profit and lossGETv1.0.0
- Get purchase orderGETv1.0.0
- Get sales orderGETv1.0.0
- Get supplierGETv1.0.0
- Get supplier attachmentGETv1.0.0
- Get tax rateGETv1.0.0
- Get tracking categoriesGETv1.0.0
- Get transferGETv1.0.0
- List accountsGETv1.0.0
- List all bank transactionsGETv1.0.0
- List all payment methodsGETv1.0.0
- List all tax ratesGETv1.0.0
- List bank accountsGETv1.0.0
- List bill attachmentsGETv1.0.0
- List bill credit notesGETv1.0.0
- List bill paymentsGETv1.0.0
- List billsGETv1.0.0
- List credit notesGETv1.0.0
- List customer attachmentsGETv1.0.0
- List customersGETv1.0.0
- List direct cost attachmentsGETv1.0.0
- List direct costsGETv1.0.0
- List direct income attachmentsGETv1.0.0
- List invoicesGETv1.0.0
- List itemsGETv1.0.0
- List journal entriesGETv1.0.0
- List journalsGETv1.0.0
- List paymentsGETv1.0.0
- List purchase ordersGETv1.0.0
- List push options for bank account bank transactionsGETv1.0.0
- List sales ordersGETv1.0.0
- List supplier attachmentsGETv1.0.0
- List suppliersGETv1.0.0
- List tracking categoriesGETv1.0.0
- List transfersGETv1.0.0
- Refresh company infoPOSTv1.0.0
Finance/Accounting
Refresh company info
v1.0.0Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
{
"type": "object",
"required": [
"companyId",
"connectionId",
"id",
"isCompleted",
"isErrored",
"progress",
"requested",
"status"
],
"properties": {
"companyId": {
"type": "string",
"format": "uuid"
},
"completed": {
"type": "string",
"description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. 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."
},
"connectionId": {
"type": "string",
"format": "uuid"
},
"dataType": {
"type": [
"string",
"null"
]
},
"datasetLogsUrl": {
"type": [
"string",
"null"
]
},
"errorMessage": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"isCompleted": {
"type": "boolean"
},
"isErrored": {
"type": "boolean"
},
"progress": {
"type": "integer",
"format": "int32"
},
"requested": {
"type": "string",
"description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. 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."
},
"status": {
"type": "string",
"enum": [
"Initial",
"Queued",
"Fetching",
"MapQueued",
"Mapping",
"Complete",
"FetchError",
"MapError",
"InternalError",
"ProcessingQueued",
"Processing",
"ProcessingError",
"ValidationQueued",
"Validating",
"ValidationError",
"AuthError",
"Cancelled",
"NotSupported",
"RateLimitError",
"PermissionsError",
"PrerequisiteNotMet"
]
},
"validationInformationUrl": {
"type": [
"string",
"null"
]
}
}
}