action codat_delete_bill {
label: "Delete bill"
description: "Deletes a bill from the accounting package for a given company.\n\n> **Supported Integrations**\n> \n> This functionality is currently only supported for our Oracle NetSuite and QuickBooks Online integrations. Check out our [public roadmap](https://portal.productboard.com/codat/7-public-product-roadmap/tabs/46-accounting-api) to see what we're building next, and to submit ideas for new features."
provider: codat
method: DELETE
path: "/companies/{companyId}/connections/{connectionId}/push/bills/{billId}"
encoding: json
output: {
type: "object"
required: ["companyId", "dataConnectionKey", "pushOperationKey", "requestedOnUtc", "status", "statusCode"]
properties: {
changes: {
type: ["array", "null"]
items: {
type: "object"
properties: {
attachmentId: {
type: "string"
}
recordRef: {
type: "object"
properties: {
dataType: {
type: "string"
description: "Available Data types"
enum: ["accountTransactions", "balanceSheet", "bankAccounts", "bankTransactions", "billCreditNotes", "billPayments", "bills", "cashFlowStatement", "chartOfAccounts", "company", "creditNotes", "customers", "directCosts", "directIncomes", "invoices", "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"]
}
id: {
type: "string"
}
}
additionalProperties: false
}
type: {
type: "string"
enum: ["Unknown", "Created", "Modified", "Deleted", "AttachmentUploaded"]
}
}
}
}
companyId: {
type: "string"
format: "uuid"
description: "Unique identifier for your SMB in Codat."
}
completedOnUtc: {
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."
}
dataConnectionKey: {
type: "string"
format: "uuid"
description: "Unique identifier for a company's data connection."
}
dataType: {
type: "string"
description: "The type of data being pushed, eg invoices, customers."
enum: ["accountTransactions", "balanceSheet", "bankAccounts", "bankTransactions", "billCreditNotes", "billPayments", "bills", "cashFlowStatement", "chartOfAccounts", "company", "creditNotes", "customers", "directCosts", "directIncomes", "invoices", "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"]
}
errorMessage: {
type: ["string", "null"]
}
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."
}
requestedOnUtc: {
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."
}
status: {
type: "string"
description: "The status of the push operation."
enum: ["Pending", "Failed", "Success", "TimedOut"]
}
statusCode: {
type: "integer"
}
timeoutInMinutes: {
type: ["integer", "null"]
format: "int32"
}
timeoutInSeconds: {
type: ["integer", "null"]
format: "int32"
}
validation: {
type: "object"
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"
items: {
type: "object"
properties: {
itemId: {
type: "string"
}
message: {
type: "string"
}
validatorName: {
type: "string"
}
}
additionalProperties: false
}
}
warnings: {
type: "array"
items: {
type: "object"
properties: {
itemId: {
type: "string"
}
message: {
type: "string"
}
validatorName: {
type: "string"
}
}
additionalProperties: false
}
}
}
}
}
}
}