Table of Contents
Supplier Credit Notes API v1
Supported Endpoints and Methods
The endpoint can be found at: https://api.reckon.com/R1/{BOOKID}/suppliercreditnotes
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 |
| GET | Retrieve the list of supplier credit notes | AU/NZ/UK | |||
Invoices |
| POST | Post a supplier credit note | AU/NZ/UK | |||
Invoices | /suppliercreditnoteid | DELETE | Delete a supplier credit note | AU/NZ/UK |
Sample
Get list of Supplier Credit Note
Endpoint: https://api.reckon.com/R1/{BOOKID}/suppliercreditnotes
Method: GET
{
"Id":"11daf446-250e-4b16-ad4d-c2ee2db80693",
"AccountsPayableCategoryID":"4ba37c05-eca4-4c02-a4d7-e72b3e9d4247",
"Balance":10.0000,
"BillAmount":10.0000,
"BillDate":"2015-06-03T00:00:00+00:00",
"BillNumber":"SAN0005",
"Notes":null,
"Reference":null,
"Status":2,
"SupplierID":"b09da867-1e2c-48e3-a9db-dd21b427a6bb",
"SupplierName":"City Rail"
}Details of each object
Data Field | Description | Data Type |
ID | The unique ID of the Supplier Credit Note in the Reckon One book (file) | GUID |
AccountsPayableCategoryID | The unique ID of the Accounts Payable account the transaction has been assigned to in the Reckon One book (file) | GUID |
Balance | The Balance of the Supplier Credit Note | Numeric |
BillAmount | The original amount of the Supplier Credit Note | Numeric |
BillDate | The original date of the Supplier Credit Note | Date/Time |
BillNumber | The number of the Supplier Credit Note | Numeric |
Notes | Any notes entered against the Supplier Credit Note | Alphanumeric |
Reference | Reference notes from the Supplier Credit Note | Alphanumeric |
Status | The status of the Supplier Credit Note | Set data types: 1 - Draft 2 - Approved 3 - Closed (Used) |
SupplierID | The unique ID of the Supplier in the Reckon One book (file) | GUID |
SupplierName | The name of the supplier | Alphanumeric |
POST/PUT SUPPLIER CREDIT NOTE
Endpoint: https://api.reckon.com/R1/{BOOKID}/suppliercreditnotes
Method: POST, PUT
{
'SupplierCreditNoteNumber':null,
'SupplierId':'e38db1f9-cbe6-4b4a-a1b6-fc4c7f1ac41c',
'AmountTaxStatus':2,
'Amount':1.0,
'DiscountAmount':null,
'DiscountPercentage':null,
'Tax':0.09,
'Notes':'azp_test',
'Reference':'110',
'TemplateId':'a70ea585-8288-47ea-b813-d105d201caeb',
'SupplierCreditNoteDate':'2016-08-22T00:00:00',
'LineItems':
[
{
'AccountingCategoryId':'0d995c57-3d53-40c5-a6a5-79c213af087a',
'DiscountAmountExTax':null,
'DiscountAmountTax':null,
'DiscountAccuracy':null,
'DiscountPercent':null,
'Amount':1.0,
'AmountAccuracy':null,
'InvoiceDiscountedAmountExTax':0.91,
'InvoiceDiscountedTaxAmount':0.09,
'HasDataForPosting':true,
'IsSubTotal':false,
'IsParent':false,
'IsHidden':false,
'AccountId':null,
'PrintGroupAsSingleLine':false,
'ChargeableItemId':'fa2137a5-0860-4fdb-97e7-95d0a26368d2',
'LineNo':1,
'Description':null,
'Quantity':null,
'ProjectId':'3f638981-e363-4c1c-be28-3850f4f643da',
'UnitPriceExTax':0.9090909091,
'UnitPriceTax':0.0909090909,
'UnitPricePrecision':2.0,
'UnitPriceIsTaxInclusive':false,
'TaxGroupId':'a23b1b14-40e1-4cd2-a60a-0d6fa995c1e1',
'TaxIsModified':false,
'TaxAmount':0.09,
'AmountExTax':0.9091
}
],
'SupplierCreditNoteSourceId':'00000000-0000-0000-0000-000000000000'
}Details of each object
Data Field | Reckon One Data Location | Data Type |
SupplierCreditNoteNumber | The number to be assigned to the Supplier Credit Note | Alphanumeric |
SupplierID | The GUID of the supplier the Supplier Credit Note should be assigned to | GUID |
AmountTaxStatus | Whether the Supplier Credit Note is tax inclusive or not | Set data types: 0 - Unknown 1 - Non Taxed 2 - Inclusive 3 - Exclusive |
Amount | The total amount of the Supplier Credit Note without discounts | Number |
DiscountAmount | Any discounts to be applied to the Supplier Credit Note | Number |
DiscountPercentage | Any discounts to be applied to the Supplier Credit Note as a percentage | Number |
Line Items | Array that contains all the individual lines of the Supplier Credit Note | Array |
AccountingCategoryID | The ID of the account the line should be associated with (Only mandatory if not sending a Chargeable Item for the line) | GUID |
Amount | The amount for the line | Number |
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. | Number |
AmountExTax | The amount of the line minus any tax amount | Number |
ChargeableItemID | The GUID of the item to be applied to the line. Should not be used if AccountingCategoryID has been set. | GUID |
Description | The description for the line on the Supplier Credit Note | Alphanumeric |
LineItems |
| Array |
DiscountAmountExTax | Amount of a discount excluding the tax component of the discount for that line of the invoice | Number |
DiscountPercent | Amount of a discount for the line as a percentage | Number |
InvoiceDiscountedAmountExTax | The amount of the line without tax after any discounts applied | Number |
InvoiceDiscountedTaxAmount | The amount of tax for the line with any discounts applied | Number |
IsHidden | Whether the line should appear on the supplier credit note when viewed | Boolean - True/False |
IsSubTotal | Whether the line is a subtotal line. | Boolean - True/False |
LineNo | The number of the line | Numeric |
ProjectId | The GUID of the project the line should be assigned to | GUID |
Quantity | The quanity that should be applied to the line | Numeric |
TaxAmount | The tax amount for the line | Numeric |
TaxGroupID | The tax code as a GUID 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 |
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 |
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 |
UnitPriceExTax | The sale amount minus tax of the units (when chargeable Items are included) | Number |
UnitPriceisTaxInclusive | Whether the unit price includes tax or not | Boolean - True/False |
UnitPricePrecision | How many decimal places to apply to the unit price. This can be up to 8 | Number |
UnitPriceTax | The tax amount of the units (when chargeable items are included | Number |
Notes | Any notes to apply to the Supplier Credit Note | Alphanumeric |
Reference | Any reference to apply to the Supplier Credit Note | Alphanumeric |
SupplierCreditNoteDate | The date the Supplier Credit Note is for | Date/Time |
SupplierCreditNoteNumber | The number to be applied to the Supplier Credit Note | Alphanumeric |
SupplierId | The GUID of the supplier to assign the Supplier Credit Note to. | GUID |
Tax | The total tax of the Supplier Credit Note. | Number |
TemplateId | The GUID of the Template for the Supplier Credit Note | GUID |
DELETE a Supplier Credit Note
Endpoint: https://api.reckon.com/R1/{BOOKID}/suppliercreditnotes
Method: DELETE
{"3f638981-e363-4c1c-be28-3850f4f643da"}