JDBC Driver for Sage Business Cloud Accounting

Build 22.0.8462

Attachments

Query Attachments in Sage Business Cloud Accounting.

Table Specific Information

Query the available Attachments

Select

The driver uses the Sage Accounting API to process search criteria that refer to AttachmentContextTypeId,AttachmentContextId,LegacyAttachmentContextType,LegacyAttachmentContextId,UpdatedOrCreatedSince,DeletedSince columns. The driver processes other filters client-side within the driver.

  • AttachmentContextTypeId supports the '=' operator.
  • AttachmentContextId supports the '=' operator.
  • LegacyAttachmentContextType supports the '=' operator.
  • LegacyAttachmentContextId supports the '=' operator.
  • UpdatedOrCreatedSince supports the '=' operator.
  • DeletedSince supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Attachments WHERE AttachmentContextTypeId='PURCHASE_CREDIT_NOTE'
SELECT * FROM Attachments WHERE AttachmentContextId='abc'
SELECT * FROM Attachments WHERE LegacyAttachmentContextType='abc'
SELECT * FROM Attachments WHERE LegacyAttachmentContextId='abc'
SELECT * FROM Attachments WHERE UpdatedOrCreatedSince='2018-12-15'
SELECT * FROM Attachments WHERE DeletedSince='2018-12-15'

Update

Updates are performed based on Id.

UPDATE Attachments SET FileExtension='abc' WHERE Id='123'

Delete

You must specify the Id of the Attachments to delete it.

DELETE FROM Attachments WHERE id ='123' 

Columns

Name Type ReadOnly References Description
Id [KEY] String False

The unique identifier for the item

CreatedAt Datetime True

The datetime when the attachment was created

DisplayedAs String False

The name of the resource

FileExtension String False

The file extension of the attachment

TransactionId String False

Transactions.Id

The unique identifier for the item

File String False

The base64 encoded representation of the file

AttachmentContextTypeId String False

The unique identifier for the item

The allowed values are BANK_TRANSFER, CONTACT, JOURNAL, OTHER_PAYMENT, PURCHASE_CORRECTIVE_INVOICE, PURCHASE_CREDIT_NOTE, PURCHASE_INVOICE, SALES_CORRECTIVE_INVOICE, SALES_CREDIT_NOTE, SALES_ESTIMATE, SALES_INVOICE, SALES_QUOTE, BUSINESS.

_filePath String False

The file path of the attachment

FileSize Int False

The file size of the attachment in Bytes

DeletedAt Datetime True

The datetime when the item was deleted

FileName String False

The file name of the attachment

UpdatedAt Datetime True

The datetime when the attachment was last updated

MimeType String False

The mime type of the attachment

Description String False

The description of the attachment

AttachmentContextDisplayedAs String False

The name of the resource

AttachmentContextLegacyId Int False

The legacy ID for the item

AttachmentContextId String False

The unique identifier for the item

LegacyAttachmentContextType String True

LegacyAttachmentContextId String False

DeletedSince Datetime True

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462