action codat_get_all_bank_account {
label: "Get bank account"
description: "Gets the bank account for given account ID."
provider: codat
method: GET
path: "/companies/{companyId}/data/bankAccounts/{accountId}"
encoding: json
input: {
type: "object"
properties: {
query: {
type: "string"
}
}
additionalProperties: false
}
output: {
type: "object"
properties: {
accountName: {
type: ["string", "null"]
}
accountNumber: {
type: ["string", "null"]
}
availableBalance: {
type: ["number", "null"]
}
balance: {
type: ["number", "null"]
}
currency: {
type: ["string", "null"]
}
fromDate: {
type: "string"
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."
}
iban: {
type: ["string", "null"]
}
id: {
type: "string"
}
institution: {
type: ["string", "null"]
}
modifiedDate: {
type: "object"
properties: {
modifiedDate: {
type: "string"
description: "The date on which this record was last modified in Codat."
}
}
}
nominalCode: {
type: ["string", "null"]
}
overdraftLimit: {
type: ["number", "null"]
}
sortCode: {
type: ["string", "null"]
}
sourceModifiedDate: {
type: "object"
properties: {
sourceModifiedDate: {
type: "string"
description: "The date on which this record was last modified in the originating system"
}
}
}
toDate: {
type: "string"
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."
}
}
}
}