JDBC Driver for FreshBooks

Build 23.0.8839

CreateInvoiceWithAttachment

To let end users upload attachment to an invoice.

Execute

Create an invoice with attachment:

INSERT INTO InvoiceLineItems#TEMP (Name, Amount) Values ('E', 200 )

EXECUTE CreateInvoiceWithAttachment Atatchment = 'C:\files\log.txt', CustomerId = '33578', CreateDate = '2023-11-06', LinesAggregate= InvoiceLineItems#TEMP 

Input

Name Type Required Accepts Input Streams Description
Attachment String False False The full path of the attachment to upload.
CustomerId Integer True False Client Id unique to this system.
CreateDate Date True False Date invoice was created. (YYYY-MM-DD)
LinesAggregate String False False An aggregate of lines associated with an invoice. See the help for the Invoices table for more information on inserting and updating to this field.
FileName String False False Name of the file. If content is not empty.
Content String False True The content as InputStream to be uploaded when Attachment is not specified.
OwnerId Integer False False Id of the invoice's creator. (writable on create only)
EstimateId Integer False False Id of associated estimate, 0 if none.(writable on create only)
BasecampId Integer False False Id of connected basecamp account, 0 if none.(writable on create only)
SentId Integer False False User Id of user who sent the invoice.(writable on create only)
Status String False False Invoice status.(writable on create only)
Parent Integer False False Id of object this invoice was generated from, 0 if none.(writable on create only)
CreatedAt Datetime False False Time the invoice was created. (YYYY-MM-DD, writable on create only)
Updated Datetime False False Time the invoice was last updated. (YYYY-MM-DD, writable on create only)
DisplayStatus String False False Description of status shown in Freshbooks UI.(writable on create only)
AutobillStatus String False False Description of autobill status.(writable on create only)
PaymentStatus String False False Description of payment status.(writable on create only)
LastOrderStatus String False False Describes the status of the last attempted payment.(writable on create only)
DisputeStatus String False False Description of whether invoice has been disputed.(writable on create only)
DepositStatus String False False Description of deposits applied to invoice.(writable on create only)
AutoBill String False False Whether this invoice has a credit card saved.(writable on create only)
V3Status String False False Description of Invoice status.(writable on create only)
InvoiceNumber String False False User-specified and visible Invoice Id.
GenerationDate Date False False Date invoice was generated from object.(YYYY-MM-DD, or null if not)
DiscountValue Decimal False False Decimal-string amount of discount.
DiscountDescription String False False Public note about discount.
PONumber String False False Reference number for address on invoice.
Template String False False Choice of rendering style. (internal, deprecated)
CurrencyCode String False False Three-letter currency code for invoice.
Language String False False Two-letter language code.
Terms String False False Terms listed on invoice.
Notes String False False Notes listed on invoice.
Address String False False First line of address on invoice.
ReturnUri String False False (deprecated)
DepositAmount Decimal False False Amount required as deposit, null if none.
DepositPercentage Decimal False False Percentage of the invoice's value required as a deposit.
Gmail String False False Whether to send via ground mail.
ShowAttachments String False False Whether attachments on invoice are rendered.
VisState Integer False False Whether active (0) or deleted (1).
Street String False False Street for address on invoice.
Street2 String False False Second line of street for address on invoice.
City String False False City for address on invoice.
Province String False False Province for address on invoice.
Code String False False Zip code for address on invoice.
Country String False False Country for address on invoice.
Organization String False False Name of organization being invoiced.
FirstName String False False First name of client on invoice.
LastName String False False Last name of client on invoice.
VatName String False False Value added tax name, if provided.
VatNumber String False False Value added tax number, if provided.
DueOffsetDays Integer False False Number of days from creation that invoice is due.

Result Set Columns

Name Type Description
Success String True if the image is uploaded successfully.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839