POST v1/estimates
Create a new estimate
Request Information
URI Parameters
None.
Body Parameters
Estimate object
InvoiceName | Description | Type | Additional information |
---|---|---|---|
ReferenceNumber | string |
String length: inclusive between 0 and 20 |
|
Discount | decimal number |
None. |
|
Shipping | decimal number |
None. |
|
Due | byte |
None. |
|
ClientNotes | string |
None. |
|
InternalNotes | string |
None. |
|
DocItems | Collection of DocItem |
None. |
|
BankAccountId | integer |
None. |
|
EarlyPaymentDiscount | SlidingDiscount |
None. |
|
Client | CompactClient |
None. |
|
Key | string |
None. |
|
ClientId | string |
None. |
|
Id | string |
String length: inclusive between 0 and 20 |
|
CurrencyId | integer |
None. |
|
LanguageId | byte |
None. |
|
IssueDate | date |
None. |
|
CompanyId | integer |
None. |
|
AcceptCreditCard | boolean |
None. |
|
AcceptPayPal | boolean |
None. |
|
Uri | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ReferenceNumber": null, "Discount": 5.0, "Shipping": 150.0, "Due": 1, "ClientNotes": "Thank you for your payment", "InternalNotes": "Some internal notes..", "DocItems": [ { "ItemId": "XBR-65X950B", "ItemDescription": "Flagship 4K Ultra HD TV", "ItemPrice": 6999.0, "ItemQuantity": 1.0, "TaxId1": 1, "TaxId2": null, "DiscountType": 0, "DiscountValue": 10.0 } ], "BankAccountId": 1, "EarlyPaymentDiscount": { "DiscountValue": 2.0, "DueDate": "2018-04-23T00:00:00+00:00" }, "Client": { "OrganizationName": "My Company", "Email": "your@email.com", "SendEmail": true }, "Key": null, "ClientId": "1", "Id": "1", "CurrencyId": 140, "LanguageId": null, "IssueDate": "2018-04-21T20:26:07.2508384+00:00", "CompanyId": 1, "AcceptCreditCard": false, "AcceptPayPal": false, "Uri": null }
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "ReferenceNumber": null, "Discount": 5.0, "Shipping": 150.0, "Due": 1, "ClientNotes": "Thank you for your payment", "InternalNotes": "Some internal notes..", "DocItems": [ { "ItemId": "XBR-65X950B", "ItemDescription": "Flagship 4K Ultra HD TV", "ItemPrice": 6999.0, "ItemQuantity": 1.0, "TaxId1": 1, "TaxId2": null, "DiscountType": 0, "DiscountValue": 10.0 } ], "BankAccountId": 1, "EarlyPaymentDiscount": { "DiscountValue": 2.0, "DueDate": "2018-04-23T00:00:00+00:00" }, "Client": { "OrganizationName": "My Company", "Email": "your@email.com", "SendEmail": true }, "Key": null, "ClientId": "1", "Id": "1", "CurrencyId": 140, "LanguageId": null, "IssueDate": "2018-04-21T20:26:07.2508384+00:00", "CompanyId": 1, "AcceptCreditCard": false, "AcceptPayPal": false, "Uri": null }