Bills

Get bill attachment

Changed on Feb 13, 2024

The Get bill attachment endpoint returns a specific attachment for a given billId and attachmentId.

Bills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.

get/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}

Request

Base URL
https://api.codat.io
Auth
API key in header Authorization

Path parameters

attachmentIdstring uuid required

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for an attachment.

Response

Success

Integration	File size	File extension
Xero	4 MB	7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP
QuickBooks Online	100 MB	AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML
NetSuite	100 MB	BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP
Dynamics 365 Business Central	350 MB	Dynamics do not explicitly outline which file types are supported but they do state <a className="external" href="https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice" target="_blank">here</a> that "You can attach any type of file, such as text, image, or video files".

idstring

Identifier for the attachment, unique for the company in the accounting software.

namestring nullable

Name of the attachment file.

contentTypestring nullable

File type of the attachment. This is represented by appending the file type to the IETF standard file naming requirements. For example, for a jpeg file the output is image/jpeg.

Supported file types vary per platform.

dateCreatedstring

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:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
Unqualified local time: 2021-11-15T01:00:00
UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

fileSizeinteger nullable

File size in bytes. For example, if this reads 46153, then the file size is 46kb.

includeWhenSentboolean

If true, then the attachment is included with the associated invoice, bill or direct costs when it is printed, emailed, or sent to a customer, if the underlying accounting software allows this.

modifiedDatestring

The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.

Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.

This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).

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>.

sourceModifiedDatestring

The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.

It is not populated (read more) when:

Pulling attachments
The accounting software does not provide modification dates for a data type
A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records

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>.

Example response

{
  "dateCreated": "2022-10-23T00:00:00Z",
  "modifiedDate": "2022-10-23T00:00:00Z",
  "sourceModifiedDate": "2022-10-23T00:00:00Z"
}

Changes

Feb 13, 20244bfab0afa6ca Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Oct 23, 2023948b47a54450 Revision changes
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history