Table of Contents
Estimates
Supported Endpoints and Methods
The Estimates endpoint can be found at: https://api.reckon.com/R1/{BOOKID}/estimates
Methods supported: GET, POST, DELETE
The Book ID represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401
Reckon One Module | Endpoint | Additional Parameter(s) | HTTP Method | Request URL | Description | API Portal | Countries |
Estimates | /estimates | GET | Allows you to retrieve a list of estimates from the Reckon One Book | AU/NZ/UK | |||
Estimates | /estimates | POST | Allows you to post a estimate to the Reckon One book | AU/NZ/UK | |||
Estimates | Estimates | /estimates/{estimateId} | GET | Allows you to retrieve a single estimate via the unique GUID of the transaction | AU/NZ/UK | ||
Estimates | /estimates/{estimateId} | DELETE | Allows you to delete a single estimate via the unique GUID of the transaction | AU/NZ/UK |
Sample
Sample GET Response
Endpoint: https://api.reckon.com/R1/{BOOKID}/estimates
Method: GET
{
"Id":"ea3435fd-841e-4f0a-8555-a5dc79bde281",
"CashbookId":"0da93f9e-acb7-4bb0-b66d-a124e02dbe39",
"CustomerId":"fec28ebc-f916-4544-8257-017649d45211",
"CustomerName":"Aportis",
"Amount":220.0000,
"Date":"2016-06-15T00:00:00+00:00",
"ExpiryDate":"2016-06-30T00:00:00+00:00",
"Number":"EST0002",
"Reference":"1234",
"Status":3
}
Sample POST
Endpoint: https://api.reckon.com/R1/{BOOKID}/estimates
Method: POST
{
'CustomerId':'3ceba0fa-6063-4972-aeef-453303e612d4',
'EstimateDate':'2016-09-06T00:00:00',
'EstimateAmount':91.0,
'AmountTaxStatus':2,
'Notes':'asdfg',
'Reference':null,
'TemplateId':'d10a7d19-fe53-4e16-853e-a05a8edb5b75',
'ExpiryDate':'2016-12-15T00:00:00',
'SendDate':null,
'EstimateTax':0.0,
'LineItems':
[
{'MarkupPercentage':null,
'MarkupAmountExTax':null,
'MarkupAmountTax':null,
'DiscountAmountExTax':null,
'DiscountAmountTax':null,
'DiscountAccuracy':null,
'DiscountPercent':null,
'Amount':91.0,
'AmountAccuracy':null,
'InvoiceDiscountedAmountExTax':null,
'InvoiceDiscountedTaxAmount':null,
'IsSubTotal':false,
'IsParent':false,
'IsHidden':false,
'AccountId':null,
'PrintGroupAsSingleLine':false,
'ChargeableItemId':'fc342bc0-3fc0-49b5-8e94-04c6b43861f6',
'LineNo':1,
'Description':null,
'Quantity':null,
'ProjectId':'e3dbab49-50f2-4c12-8a30-d30227165d04',
'UnitPriceExTax':91.0,
'UnitPriceTax':0.0,
'UnitPricePrecision':2.0,
'UnitPriceIsTaxInclusive':false,
'TaxGroupId':null,
'TaxIsModified':false,
'TaxAmount':null,
'AmountExTax':91.0}
]
}Sample PUT
Endpoint: https://api.reckon.com/R1/{BOOKID}/estimates/{id}
Method: PUT
{
'CustomerId':'3ceba0fa-6063-4972-aeef-453303e612d4',
'EstimateDate':'2016-09-06T00:00:00',
'EstimateAmount':91.0,
'AmountTaxStatus':2,
'Notes':'asdfg',
'Reference':null,
'TemplateId':'d10a7d19-fe53-4e16-853e-a05a8edb5b75',
'ExpiryDate':'2016-12-15T00:00:00',
'SendDate':null,
'EstimateTax':0.0,
'LineItems':
[
{'MarkupPercentage':null,
'MarkupAmountExTax':null,
'MarkupAmountTax':null,
'DiscountAmountExTax':null,
'DiscountAmountTax':null,
'DiscountAccuracy':null,
'DiscountPercent':null,
'Amount':91.0,
'AmountAccuracy':null,
'InvoiceDiscountedAmountExTax':null,
'InvoiceDiscountedTaxAmount':null,
'IsSubTotal':false,
'IsParent':false,
'IsHidden':false,
'AccountId':null,
'PrintGroupAsSingleLine':false,
'ChargeableItemId':'fc342bc0-3fc0-49b5-8e94-04c6b43861f6',
'LineNo':1,
'Description':null,
'Quantity':null,
'ProjectId':'e3dbab49-50f2-4c12-8a30-d30227165d04',
'UnitPriceExTax':91.0,
'UnitPriceTax':0.0,
'UnitPricePrecision':2.0,
'UnitPriceIsTaxInclusive':false,
'TaxGroupId':null,
'TaxIsModified':false,
'TaxAmount':null,
'AmountExTax':91.0}
]
}Sample DELETE
Endpoint: https://api.reckon.com/R1/{BOOKID}/estimates/{estimateId}
Method: DELETE
Details of each object
Data Field | Description | Data Type |
EstimateId | The unique GUID of the Estimate that you want to update (used for PUT) | GUID |
CustomerID | The unique GUID of the customer that the estimate is to be associated with | GUID |
EstimateDate | The date the estimate is for | Date/Time |
EstimateAmount | The amount as a total of the estimate | Alphanumeric |
AmountTaxStatus | Whether the transaction is tax inclusive or not | Set data types: 0 - Unknown 1 - Non Taxed 2 - Inclusive 3 - Exclusive |
Notes | Any notes to be added to the estimate | Alphanumeric |
Reference | Any reference to be added to the estimate | Alphanumeric |
TemplateID | The unique GUID of the Template to apply to the transaction. | GUID |
ExpiryDate | The date the estimate should expire | Date/Time |
SendDate | The date the estimate was sent to the customer | Date/Time |
EstimateTax | The amount of tax included on the Estimate as a whole | Numeric |
LineItems | The array of Line Items for the Estimate. **Each new line must be a new number and an individual array. | Array |
AccountID | If an account to be used on this line instead of a item, this is the unique GUID of the account to be included on the line | GUID |
Amount | The total amount for the line | Numeric |
AmountAccuracy | How many decimal points are associated with the amount for the total transaction up to 8. Is 2 by default and can be posted as null. | Numeric |
AmountExTax | The amount of the line without tax | Numeric |
ChargeableItemID | If a item is to be included on this line instead of a account, this is the unique GUID of the item to be included | GUID |
Description | The description for the line | Alphanumeric |
DiscountAccuracy | The number of decimal places for any discount applied to the line. Can be Null. | Numeric |
DiscountAmountExTax | The amount of any discount for the line minus tax | Numeric |
DiscountAmountTax | The tax amount to be applied to any discount on the line | Numeric |
DiscountPercent | Any discount percent to be applied to the line | Numeric |
InvoiceDiscountedAmountExTax | The discounted amount of the line without tax | Numeric |
InvoiceDiscountedTaxAmount | The tax amount of any discount applied to the line | Numeric |
IsHidden | This sets whether the line should appear on the estimate or not | Boolean true/false |
IsParent | Whether this line is the parent of any other lines | Boolean truefalse |
IsSubTotal | Whether the line is a subtotal | Boolean true/false |
LineNo | The line number on the estimate. **Each new line must be a new number and an individual array. | Numeric |
MarkupAmountExTax | The amount of the markup minus any tax amount | Numeric |
MarkupAmountTax | Any tax amount being applied to the markup | Numeric |
MarkupPercentage | The percentage of any markup applied to the line. This can be used instead of the amounts | Numeric |
PrintGroupAsSingleLine | If you want to print multiple lines as a single line set this to true | boolean true/false |
ProjectID | The unique GUID of any project to be applied to the line | GUID |
Quantity | The quantity to be applied to the line | Numeric |
TaxAmount | The amount of tax applied to the line | Numeric |
TaxGroupID | The unique GUID of the tax code to apply to the line | GUID |
TaxIsModified | If its false, your tax calculations will be compared against the Reckon One tax engine and if it does not match the transaction is blocked. If set to true, the engine is not checked and you can post any tax you desire. The UI also controls this function via SETTINGS for the same purpose. | Boolean true/false |
UnitPriceExTax | The amount to be applied to individual units on the line without tax | Numeric |
UnitPriceisTaxInclusive | Whether the unit prices is gross or net | Boolean true/false |
UnitPricePrecision | The amount of decimal points to apply to the unit price. Up to 8.0 | Numeric |
UnitPriceTax | The amount of tax to apply to the unit price | Numeric |
|
|
|
