|
Invoice
An object representing a project invoice.
Supported API Calls: Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID for the invoice. When adding a new invoice the value must be 0. |
|
ParentId |
integer |
ID of the parent project. |
|
ParentObject |
string (100) |
ParentObject identifies what kind of object the share object is a child of. Value is project. |
|
InvoiceNumber |
string (100) |
The invoice's number. |
|
InvoiceDate |
DateTime |
The date the invoice is created. |
|
Description |
string (100) |
The invoice's comment box text. |
|
SubTotal |
float |
Invoice total before taxes. |
|
TaxTotal |
float |
Invoice's tax total. |
|
PaymentDueAmount |
float |
Total amount due. |
|
CurrencyIsoCode |
string (100) |
Currency symbol used for the value on display. |
|
PaymentDueDate |
DateTime |
Date the payment is due. |
|
RenewalDate |
DateTime |
If this is a recurring invoice, the date the invoice should be re-created. |
|
InvoiceSendDate |
DateTime |
Date the invoice is sent. |
|
IsScheduled |
boolean |
Flag to indicated the sending of the invoice is scheduled. |
|
OwnerId |
integer |
ID of the internal user who owns the invoice. |
|
IsLocked |
boolean |
Flag to indicate the invoice can't be edited. This property is read only |
|
LineItemList |
List<InvoiceLineItem> |
List of product objects. |
|
PaymentList |
List<InvoicePayment> |
List of payment objects. |
|
ReminderList |
List<InvoiceReminder> |
List of reminder objects. |
|
AttachmentList |
List<AttachmentAssociate> |
List of attachment objects. |
|
PaymentAmount |
float |
Amount that has been paid to the invoice. |
|
PaymentDate |
DateTime |
Date the payment was made. |
Get
Description
Returns the details of a specified Invoice.
URL
https://{company}.bluecamroo.com/api/Invoice/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns an Invoice object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds an Invoice object.
URL
https://{company}.bluecamroo.com/api/Invoice/add
HTTP Method
POST
Parameters
An Invoice object
Data Return
Returns the Invoice object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates the specified Invoice.
URL
https://{company}.bluecamroo.com/api/Invoice/update
HTTP Method
PUT
Parameters
An Invoice object
Data Return
Returns the Invoice object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified Invoice.
URL
https://{company}.bluecamroo.com/api/Invoice/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|