Table of Contents
Bills
Supported Endpoints and Methods
The endpoint can be found at: https://api.reckon.com/R1/{BOOKID}/bills
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 |
Invoices | Bills | /billId | GET | Allows you to retrieve a single bill by its unique ID | AU/NZ/UK | ||
Invoices | Bills | /billId /approve | POST | Approve a bill by its unique ID | AU/NZ/UK | ||
Invoices |
| GET | Retrieve the list of the [supplier] bills | AU/NZ/UK | |||
Invoices |
| POST | Create a [supplier] bill | AU/NZ/UK | |||
Invoices |
| PUT | Replace a [supplier] bill | AU/NZ/UK |
Sample
GET list of Bills
Endpoint: https://api.reckon.com/R1/{BOOKID}/bills
Method: GET
[
{
"BillID":"019a76a4-af90-47ea-beaf-760e91a53aa5",
"AccountsPayableCategoryID":"4ba37c05-eca4-4c02-a4d7-e72b3e9d4247",
"ClassificationID": "569a76a4-af90-47ea-bfiaf-7623e91a53yt5",
"Balance":0.0,
"BillAmount":0.0000,
"BillDate":"2016-03-13T00:00:00+00:00",
"BillNumber":"BIL0112",
"CustomerID":"00bb3e7f-bf7d-4533-bb1c-57cfd3917817",
"CustomerName":"AAMI",
"Notes":null,
"Reference":null,
"Status":1,
"IsOverdue":false
}
]
Details of each object
Data Field | Description | Data Type |
BillID | The unique GUID of the bill | GUID |
AccountsPayableCategoryId | The Accounts Payable account the bill is linked to | GUID |
Balance | The outstanding amount of the bill | Number |
BillDate | The date of the bill | DateTime |
BillNumber | The number of the bill | Text |
CustomerID | The ID of the customer/supplier the bill is assigned to | GUID |
CustomerName | The name of the customer for the bill | Text |
Notes | The notes for the bill | Text |
Reference | The reference for the bill | Text |
Status | The status of the bill | 1 – Draft 2 – Approved 3 – Paid |
IsOverdue | Whether the bills is overdue or not | Boolean – True/false |
ClassificationID | The classification if any has been used on the transaction | GUID |
POST a Bill
Endpoint: https://api.reckon.com/R1/{BOOKID}/bills
Method: POST
{
'SupplierId':'00bb3e7f-bf7d-4533-bb1c-57cfd3917817',
'CashbookId':'e17417ac-fc79-4d4d-9ee8-1780b3bc326f',
'AmountTaxStatus':3,
'AccountsPayableAccountingCategoryId':'744d3fe1-fa28-4dab-8ad7-8577af04ed6f',
'Status':1,
'BillAmount':0.0,
'BillDiscount':null,
'BillDiscountAmount':null,
'BillDiscountPercentage':null,
'BillTax':0.0,
'Notes':null,
'Reference':null,
'TemplateId':'8d1717e4-cf39-46e3-b631-8edfeaf8da78',
'BillDate':'2016-03-13T00:00:00',
'SendDate':null,
'DueDate':null,
'ClassificationID': '135185b5-33ba-4003-8501-92e3dca29dd9',
'BillSourceId':'00000000-0000-0000-0000-000000000000',
'LineItems':[{'BillId':'00000000-0000-0000-0000-000000000000',
'AccountingCategoryId':'744d3fe1-fa28-4dab-8ad7-8577af04ed6f',
'ProjectId':'e52687e1-d598-4a32-b9ba-0f0370f5e94e',
'ChargeableItemId':'026cedf5-7f0e-4cf2-889b-dd51bf760b78',
'LineNo':1,
'Description':null,
'Quantity':null,
'UnitPriceExTax':0.0,
'UnitPriceTax':0.0,
'UnitPricePrecision':2.0,
'DiscountAmountExTax':null,
'DiscountAmountTax':null,
'DiscountAccuracyDiscountPercent':null,
'TaxGroupId':null,
'TaxIsModified':false,
'AmountExTax':0.0,
'Amount':0.0,
'TaxAmount':null,
'AmountAccuracy':null,
'InvoiceDiscountedAmountExTax':0.0,
'InvoiceDiscountedTaxAmount':null,
'HasDataForPosting':true,
'IsSubTotal':false,
'IsParent':false,
'IsHidden':false,
'AccountId':null,
'PrintGroupAsSingleLine':false
}
],
'Address':null
}PUT a Bill
Endpoint: https://api.reckon.com/R1/{BOOKID}/bills
Method: PUT
{
"BillId": "097b9cb6-06ae-40c6-9aad-e4eb5f5e81f4",
"BillNumber": "BIL0079",
"SupplierId": "a8aabfa5-082d-4a67-9c59-4cf902ef0273",
"SupplierName": "Aoi ",
"AccountsPayableAccountingCategoryId": "d2a0564a-5dd6-44ea-a23b-c410e0dc5a3f",
"Balance": 0,
"BillAmount": 20,
"BillDiscount": null,
"BillDiscountAmount": null,
"BillDiscountPercentage": null,
"BillTax": null,
"Notes": "",
"Reference": "A-soup",
"BillDate": "2018-08-01T00:00:00",
"SendDate": null,
"DueDate": null,
"Status": 2,
"AmountTaxStatus": 1,
"IsOverdue": false,
"TemplateId": "b07520e9-b0bf-4f3d-aa41-2fb386655bc4",
"Address": {
"AddressID": "00000000-0000-0000-0000-000000000000",
"EntryNo": 0,
"Address1": null,
"Address2": null,
"Address3": null,
"Suburb": null,
"State": null,
"Postcode": null,
"Country": null,
"IsInternational": false,
"Town": null
},
"LineItems": [
{
"AccountingCategoryId": "00000000-0000-0000-0000-000000000000",
"DiscountAmountExTax": null,
"DiscountAmountTax": null,
"DiscountAccuracy": null,
"DiscountPercent": null,
"Amount": 20,
"AmountAccuracy": null,
"InvoiceDiscountedAmountExTax": 20,
"InvoiceDiscountedTaxAmount": null,
"HasDataForPosting": true,
"IsSubTotal": false,
"IsParent": false,
"IsHidden": false,
"AccountId": "2e61e0ea-757c-418f-be21-e7c119737b4c",
"PrintGroupAsSingleLine": false,
"ChargeableItemId": "00000000-0000-0000-0000-000000000000",
"LineNo": 38,
"Description": "Miso Soup",
"Quantity": 1,
"ProjectId": "00000000-0000-0000-0000-000000000000",
"UnitPriceExTax": 20,
"UnitPriceTax": 0,
"UnitPricePrecision": 0,
"UnitPriceIsTaxInclusive": false,
"TaxGroupId": "00000000-0000-0000-0000-000000000000",
"TaxIsModified": true,
"TaxAmount": null,
"AmountExTax": 20,
"AutoCalcTax": false
}
],
"PaymentAllocations": [],
"LegalName": null,
"ClassificationId": "00000000-0000-0000-0000-000000000000"
}
Details of each object
Data Field | Description | Data Type |
SupplierID | The GUID of the supplier for the Bill | GUID |
AmountTaxStatus | The tax status of the bill | 0 – Unknown 1 – Non Taxed 2 – Inclusive 3 – Exclusive |
AccountsPayableCategoryID | The GUID of the accounts payable account the bill should be linked to | GUID |
Status | The status of the bill | 1 – Draft 2 – Approved 3 – Paid |
BillAmount | The total of the bill | Number |
BillDiscountAmount | Amount of the discount applied to the bill | Number |
BillDiscountPercentage | Amount of percentage discount applied to the bill | Number |
BillTax | The tax amount for the bill | Number |
Notes | The notes for the bill | Text |
Reference | The reference for the bill | Text |
TemplateID | The templateID for the bill | GUID – obtainable via the templates endpoint |
BillDate | The date of the bill | DateTime |
SendDate | The send date of the bill | DateTime |
DueDate | The DueDate of the Bill | DateTime |
LineItems |
| Array |
AccountingCategoryID | The GUID of the account for the line | GUID |
ProjectID | The GUID for the project to associate with the line | GUID – Customer must have projects module |
ChargeableItemId | The GUID for the item being applied to the line | GUID |
LineNo | The number of the line of the bill **Each new line must be a new number and an individual array. | Number |
Description | The description for the bill | Text |
Quantity | The quantity for the line | Number |
UnitPriceExTax | The amount of the unit price for the line extax | Number |
UnitPriceTax | The tax amount for the unit price of the line | Number |
DiscountAmountExTax | The amount of a discount without the tax component | Number |
DiscountAmountTax | The amount of the tax component for the discount | Number |
DiscountPercent | The amount of the discount in percent | Number |
TaxGroupID | The tax group to be applied 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 |
AutoCalcTax | Allows Reckon to calculate the tax. You send the net amounts to us including "AutoCalcTax": true and a TaxGroupId in the payload, and our tax engine figures out what the tax should be. It also means that by using that you are always complying with and using the R1 tax engine. ** Was not available in early API versions. | Boolean: true/false |
AmountExTax | The amount of the line minus tax | Number |
HasDataForPosting | If not set to true this will post as a non-posting transaction which cannot be currently changed in the UI. ** POST AS TRUE. | Boolean - True/false |
Amount | The amount of the line total | Number |
TaxAmount | The amount of the tax of the line | Number |
InvoiceDiscountedAmountExTax | The amount of the line with discounts applied extax | Number |
InvoiceDiscountedTax Amount | The amount of tax discounted on that line | Number |
IsHidden | Whether the line is hidden on the bill | Boolean – True/false |
AccountID | If a account not a item is being used for the line, set that here with the Account GUID | GUID |
ClassificationID | The classification to apply to transaction | GUID |
