Table of Contents

Customer Adjustment Notes API v1

Overview

Reckon One API v2 is now available.
Credit Notes API v2 endpoints provides you with more information about your Credit Notes.

The endpoint can be found at:  https://api.reckon.com/R1/{BOOKID}/creditnotes

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

Credit Notes

/creditNoteId

GET

https://api.reckon.com/R1/{BOOKID}/creditnotes/{CreditNoteId}

Retrieve credit notes (invoice adjustments) by their unique ID

Portal

AU/NZ/UK

Invoices

Credit Notes

 

GET

https://api.reckon.com/R1/{BOOKID}/creditnotes/{CreditNoteId}

Retrieve the credit notes (invoice adjustments) listing

Portal

AU/NZ/UK

Invoices

Credit Notes

 

POST

https://api.reckon.com/R1/{BOOKID}/creditnotes

Create credit notes (invoice adjustments)

Portal

AU/NZ/UK

Invoices

Credit Notes

/allocations

/applyCredit

POST

https://api.reckon.com/R1/{BOOKID}/creditnotes/{CreditNoteId}

Apply a credit note to a customer invoice

Portal

AU/NZ/UK

 

Sample

GET by ID

Endpoint: https://api.reckon.com/R1/{BOOKID}/creditnotes/{CreditNoteId}

Method: GET

{
	"AccountsReceivableAccountingCategoryID": "5db31ca3-f3fd-41e4-9293-fd745a99c6a5",
	"Address": {
		"AddressId": "849ccbb3-261d-415c-a197-f11808c6ac39",
		"Line1": "101 Queen Street",
		"Line2": null,
		"Line3": "",
		"Town": null,
		"Suburb": " Albany",
		"State": null,
		"Postcode": "2600",
		"Country": null,
		"AddressType": null,
		"IsInternational": null
	},
	"AmountTaxStatus": 2,
	"CashbookID": "35ab8405-cf6f-4dc4-b703-1ccf40c5c234",
	"CreditNoteAmount": 99.0000,
	"CreditNoteDate": "2013-06-12T00:00:00",
	"CreditNoteDiscount": null,
	"CreditNoteID": "16ddf586-6206-4ad3-86b1-4d5962958e19",
	"CreditNoteNumber": "CAN0003",
	"CreditNoteTax": 9.0000,
	"CustomerID": "3de468aa-becf-47e0-a769-d4300b74d93f",
	"CustomerName": "Cust Bus 1 ",
	"ContactName": "Cust Bus 1",
	"Discount": null,
	"LineItems": [{
		"CreditNoteId": "16ddf586-6206-4ad3-86b1-4d5962958e19",
		"DiscountAmountExTax": null,
		"DiscountAmountTax": null,
		"DiscountAccuracy": null,
		"DiscountPercent": null,
		"Amount": 99.00,
		"AmountAccuracy": null,
		"InvoiceDiscountedAmountExTax": 90.0000,
		"InvoiceDiscountedTaxAmount": 9.0000,
		"HasDataForPosting": true,
		"IsSubTotal": false,
		"IsParent": false,
		"IsHidden": false,
		"AccountId": "00000000-0000-0000-0000-000000000000",
		"PrintGroupAsSingleLine": false,
		"Id": "d1b85e15-4b04-4298-be15-bef0fae8414c",
		"ChargeableItemId": "2b6ee44c-f2da-4830-90a6-c7b0fb0f08a0",
		"LineNo": 1,
		"Description": null,
		"Quantity": 3.0000,
		"ProjectId": "00000000-0000-0000-0000-000000000000",
		"UnitPriceExTax": 30.00000000,
		"UnitPriceTax": 3.0000000000,
		"UnitPricePrecision": 2.0,
		"UnitPriceIsTaxInclusive": false,
		"TaxGroupId": "cbf0eb23-0d68-425d-9fc2-12569a8c5a36",
		"TaxIsModified": false,
		"TaxAmount": 9.0000,
		"AmountExTax": 90.0000
	}],
	"Notes": null,
	"Reference": null,
	"Status": 2,
	"TaxSummaryText": null,
	"TemplateID": "6e8025ce-f822-4fd1-9e3b-3adbca571488",
	"UserName": null,
	"CreditNoteSourceId": "00000000-0000-0000-0000-000000000000",
	"Allocations": [{
			"Id": "00000000-0000-0000-0000-000000000000",
			"AllocationAmount": 99.0000,
			"TransactionAmount": 0.0,
			"Balance": 0.0,
			"AllocationType": 7,
			"RefId": "724015a0-96c9-48a2-accb-52c2310fb397",
			"TransactionDate": "2015-03-26T00:00:00+13:00",
			"ReferenceNumber": ""
		},
		{
			"Id": "00000000-0000-0000-0000-000000000000",
			"AllocationAmount": 99.0000,
			"TransactionAmount": 0.0,
			"Balance": 0.0,
			"AllocationType": 7,
			"RefId": "724015a0-96c9-48a2-accb-52c2310fb397",
			"TransactionDate": "2015-03-26T00:00:00+13:00",
			"ReferenceNumber": ""
		}
	],
	"LegalName": "ABC Company",
	"CompanyName": "ABC Company"
}


Details of each object 

Data Field

Description

Data Type

AccountsReceivableCategoryId

The GUID of the Accounts Receivable account that the Credit note has been applied to

GUID

Address

The address that appears on the Credit Note

 

AddressId

The GUID of the address

GUID

AddressType

 

 

Whether it is a Business or Personal Address

Set Data Types

1 – Business

2 – Personal

Country

The country that the address has

Text

IsInternational

Whether the address is international or not

Boolean (True/False)

Line1

Line 1 of the Address

Text

Line 2

Line 2 of the Address

Text

Line3

Line 3 of the Address

Text

PostCode

The Postcode of the address

Text

State

The State of the Address

Text

Suburb

The suburb of the address

Text

Town

The town of the address

Text

Allocations Array

If this transaction has been allocated to another transaction the information will appear here

 

AllocationAmount

The Amount of the allocation

Numeric

AllocationType

 

 

The type of transaction the transaction was allocated to

Set Data Types

1-      Invoice

2-      Bill

3-      Bill Credit

4-      Credit Note

5-      Journal Payable

6-      Journal Receivable

7-      Payment

8-      Receipt

9-      Expense

Balance

The Balance of the transaction which this transaction was allocated to

Numeric

RefId

The GUID of the transaction this transaction was applied to

GUID

Reference Number

The reference number that was applied during the transaction being applied

Text

TransactionAmount

The Amount of the transaction for which this transaction was applied to

Numeric

TransactionDate

The date that the allocation was applied to the other transaction

Date/Time

AmountTaxStatus

Whether the amounts on the Credit Note include tax or not

Set data types:

0 -   Unknown

1 -   Non Taxed

2 -   Inclusive

3 -   Exclusive

CashBookId

The GUID of the Cashbook that the transaction comes from

GUID

CompanyName

The Company Name the credit note is applied to

Text

ContactName

The Contact Name for the company the Credit Note is applied to

Text

CreditNoteAmount

The total amount for the credit note

Numeric

CreditNoteDate

The date of the credit note

Date/Time

CreditNoteDiscount

Whether a discount was applied to the Credit note and the amount

Numeric

CreditNoteId

The GUID of the credit note

GUID

CreditNoteNumber

The number of the Credit Note

Numeric

CreditNoteTax

The total amount of tax applied on the credit note

Numeric

CustomerID

The GUID of the contact that the credit note is applied to

GUID

CustomerName

The name of the Contact that the credit note is assigned to

Text

Discount

Any discount amount applied to the credit note

Numeric

LegalName

The legal name of the contact the credit note is applied to

Text

Line Items Array

The lines of the Credit note

 

AccountId

The GUID of the account that was applied to the line of the Creidt Note

GUID

Amount

The amount of the line on the credit note

Numeric

AmountExTax

The amount of the line without tax

Numeric

ChargeableItemId

The GUID of the item being applied to the line on the credit note

GUID

Description

The description to be applied to line on the credit note

Text

DiscountAccuracy

Whether any direct rounding was applied on the line due to a discount. Can be Null.

Number

DiscountAmountExTax

The Amount of the Credit Note minus any discounts. Null indicates no discount

Number

DiscountPercent

The percentage of any discount that was applied to the Credit Note line

Number

Id

The id of the line on the credit note

GUID

InvoiceDiscountedAmount

The amount of the credit note with discounts applied

Number

InvoiceDiscountedTaxAmount

The amount of the credit note tax with discounts applied

Number

IsHidden

Whether the line appears on the credit note

Boolean (True/False)

IsParent

Whether the line is the parent of a group of lines on the credit note

Boolean (True/False)

IsSubTotal

Whether the line is a subtotal on the credit note

Boolean (True/False)

LineNo

The line number on the credit note

Numeric

PrintGroupAsSingleLine

Whether the line is grouped with other lines on the credit note when displayed in the UI

Boolean (True/False)

ProjectId

Any project that has been associated with this line of the credit note

GUID

Quantity

The quantity applied to this line on the credit note

Numeric

TaxAmount

The tax amount applied to this line on the credit note

Numeric

TaxGroupId

The tax code associated with this line on the credit note

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

UnitPriceExTax

The amount minus tax of the item applied to the line on the credit note

Numeric

UnitPriceIsTaxInclusive

Whether the item price includes tax or not

Numeric

UnitPricePrecision

Amount of decimal places to apply to the item price

Numeric up to 8

UnitPriceTax

Amount of tax applied to each item on the credit note line

Numeric

Notes

Any notes applied to the credit note

Text

Reference

Any reference applied to the credit note

Text

Status

The status of the credit note

1 – Draft

2 – Unused/Approved

3 – Closed

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)

TaxSummaryText

If any tax summary text has been applied to the credit note

Text

TemplateId

The GUID of the template that the credit note has been applied to

GUID

UserName

The user who entered the name into the book

Text

 

GET list of Credit Notes

Endpoint: https://api.reckon.com/R1/{BOOKID}/creditnotes

Method: GET 

[
    {
        "Id":"015cc8f0-fafe-4b27-9fb1-521898debeed",
        "CashbookId":"35ab8405-cf6f-4dc4-b703-1ccf40c5c234",
        "AccountsReceivableCategoryId":"5db31ca3-f3fd-41e4-9293-fd745a99c6a5",
        "Balance":130.8800,
        "CreditNoteAmount":130.8800,
        "CreditNoteDate":"2016-07-28T00:00:00+12:00",
        "CreditNoteNumber":"CAN0053",
        "CustomerId":"c41b819e-ac67-46eb-abe6-bba8559f2fe7",
        "CustomerName":"Credit100",
        "Notes":"Note 123345434543",
        "Reference":"1234WEDWQEQWEQW",
        "Status":2
    }
]
 Details of each object 

Data Field

Description

Data Type

Id

The id of the transaction

GUID

CashBookId

The id of the Cashbook the transaction comes from

GUID

AccountsReceivableCategoryId

The GUID of the Accounts Receivable account that the Credit Note has been assigned to.

GUID

Balance

The current balance of the Credit Note

Numeric

CreditNoteAmount

The original amount of the Credit Note

Numeric

CreditNoteDate

The date the credit note was generated

Date/Time

CreditNoteNumber

The number of the credit note

Alphanumeric

CustomerId

The GUID of the Customer that the credit note is assigned to

GUID

CustomerName

The name of the Customer that the credit not is assigned to

Text

Notes

The notes assigned to the credit note

Text

Reference

The reference of the credit note

Text

Status

 

 

The status of the credit note

0 – Draft

1 – Approved

2 -Closed

 

Post a Credit Note

Endpoint: https://api.reckon.com/R1/{BOOKID}/creditnotes

Method: POST

{
	"CreditNoteNumber": null,
	"CustomerId": "c41b819e-ac67-46eb-abe6-bba8559f2fe7",
	"CashbookId": "35ab8405-cf6f-4dc4-b703-1ccf40c5c234",
	"AmountTaxStatus": 2,
	"Amount": 130.88,
	"Tax": 30.88,
	"Notes": "Note 123345434543",
	"Reference": "1234WEDWQEQWEQW",
	"TemplateId": "6e8025ce-f822-4fd1-9e3b-3adbca571488",
	"CreditNoteDate": "2016-07-28T00:00:00",
	"LineItems": [{
		"Amount": 130.88,
		"AmountAccuracy": null,
		"InvoiceDiscountedAmountExTax": 100.0,
		"InvoiceDiscountedTaxAmount": 30.88,
		"HasDataForPosting": true,
		"IsSubTotal": false,
		"IsParent": false,
		"IsHidden": false,
		"AccountId": null,
		"PrintGroupAsSingleLine": false,
		"ChargeableItemId": "fc342bc0-3fc0-49b5-8e94-04c6b43861f6",
		"LineNo": 1,
		"Description": null,
		"Quantity": null,
		"ProjectId": "14945bb1-bbaa-4495-9634-20da9de6a890",
		"UnitPriceExTax": 100.001,
		"UnitPriceTax": 30.87478874,
		"UnitPricePrecision": 3.0,
		"UnitPriceIsTaxInclusive": false,
		"TaxGroupId": "52b79b23-b498-4758-83cd-a29715c0bb7e",
		"TaxIsModified": false,
		"TaxAmount": 30.88,
		"AmountExTax": 100.001
	}],
	"Address": null
}

 

Details of each object 

Data Field

Description

Data Type

CreditNoteNumber

The number that should be assigned to the credit note

Alphanumeric

CustomerID

The contact the credit note should be assigned to

GUID

CashBookId

The ID of the cashbook this data is being posted to

GUID

AmountTaxStatus

 

 

Whether the amounts on the credit include tax or not

Set data types:

0 -   Unknown

1 -   Non Taxed

2 -   Inclusive

3 -   Exclusive

Amount

The total amount of the credit note to be posted

Numeric

Tax

The total amount of tax to be applied for the transaction

Numeric

Notes

Any notes to be applied to the transaction

Text

Reference

The reference of the credit note

Text

TemplateId

The GUID of the template to be applied to the Credit note

GUID

CreditNoteDate

The date of the credit note

Date/Time

Line Items

An array of the individual lines for the Credit Note. At least one must be present.

 

Amount

The amount for that line of the Credit note

Numeric

ChargeableItemId

The GUID of the item to be applied to the line of the credit note

GUID

LineNo

The order that this line should appear on the Credit Note

Numeric

Description

The description that should appear on the line of the Credit Note

Text

Quantity

The Amount of the item that should be applied to the line

Numeric

Project ID

The GUID of the project that the transaction should be applied to

GUID

UnitPriceExTax

The amount the item costs without tax

Numeric

UnitPriceTax

The amount of tax to apply to the item

Numeric

UnitPriceTaxInclusive

Determine whether the UnitPrice is Gross not

Boolean (True/False)

TaxGroupId

The GUID of the tax code to apply to the line on the credit note

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)

TaxAmount

The Amount of Tax to apply to that line

Amount

AmountExTax

The amount of the line without tax

Amount

Address

The Address to be applied to the invoice for example 123 Smith Street

Text

 

 

 

 

Apply a Credit Note

Endpoint: https://api.reckon.com/R1/{BOOKID}/creditnotes/{CreditNoteId}

Method: POST 

{
    "Amount":10.0,
    "SourceType":1,
    "TargetType":4,
    "SourceRefId":"60c1192c-21ea-4481-a1eb-6dd7794a8584",
    "TargetRefId":"00cec5ee-849c-4bc5-a452-fcb45802b8a2"
}  

Details of each object 

Data Field

Description

Data Type

Amount

The amount to apply from the Credit Note to the invoice

GUID

SourceType

Always 1

Numerical

TargetType

Always 4

Numerical

SourceRefId

The GUID of the invoice that the credit should be applied to

GUID

TargetRefId

The GUID of the Credit Note that should be applied to the invoice

GUID

 

The credit endpoint for bills and invoices is one and the same, you just need to update the target and source id numbers as per below:
  • Invoice = 1,
  • Bill = 2, 
  • BillCredit = 3, 
  • CreditNote = 4, 
  • JournalEntryPayable = 5, 
  • JournalEntryReceivable = 6,
  • Payment = 7,
  • Receipt = 8,
  • Expense = 9

 

How did we do?

Invoices API v1

Bills

Related Articles

Customer Adjustment Notes
Credit Notes API v2
Supplier Credit Notes API v1
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)