Table of Contents

Payments (Make Payment)

Overview

Reckon One API v2 is now available.
Payments API v2 endpoints provides you with more information about your Payments (Make payment).

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

Methods supported:   GET, PUT, POST

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

Core

Payments

 

GET

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

Retrieve a list of payments (Make Payment)

Portal

AU/NZ/UK

Core

Payments

/paymentId

GET

https://api.reckon.com/R1/{BOOKID}/payments/ {paymentId}

Retrieve the details of a Payment by its Id

AU/NZ/UK

Core

Payments

 

PUT

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

Replace an existing payment (Make Payment)

Portal

AU/NZ/UK

Core

Payments

 

POST

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

Create a payment (Make Payment)

Portal

AU/NZ/UK

Core

Payments

/paymentId

DELETE

https://api.reckon.com/R1/{BOOKID}/payments/ {paymentId}

Delete a Payment (Make Payment)

Portal

AU/NZ/UK

Sample

Sample GET Response

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

Method: GET

[ 
 {
        "Id": "0146c059-1f0f-403a-965a-4d6b41971d48",
        "CashbookId": "624fee50-ba4c-4d5b-a5af-d6d6f995b1d6",
        "BankAccountId": "4cd7c12f-1931-4938-a739-1fe758fbd633",
        "Amount": 35.6000,
        "ContactName": "Woolworths",
        "Details": "WOOLWORTHS Groceries",
        "PaymentMethodType": 0,
        "PaymentMethodName": null,
        "IsReconciled": false,
        "ReconciliationStatus": 1,
        "Reference": "",
        "TransDate": "2015-08-03T00:00:00+00:00"   
 },
    {
        "Id": "016258e9-16a2-4dc7-92d2-6a9db782f1c8",
        "CashbookId": "624fee50-ba4c-4d5b-a5af-d6d6f995b1d6",
        "BankAccountId": "4cd7c12f-1931-4938-a739-1fe758fbd633",
        "Amount": 10.0000,
        "ContactName": "Woolworths",
        "Details": null,
        "PaymentMethodType": 0,
        "PaymentMethodName": null,
        "IsReconciled": false,
        "ReconciliationStatus": 1,
        "Reference": null,
        "TransDate": "2014-09-01T00:00:00+00:00"
    }
]

Sample GET by paymentID

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

Method: GET

{
    "Id": "11fbf3eb-8711-4bdd-9fd6-4ea42668ab86",
    "CashbookId": "8cb6404b-8789-434b-a6a0-dc09f3aae188",
    "CashbookUserId": "00000000-0000-0000-0000-000000000000",
    "TransDate": "2020-03-20T00:00:00",
    "BankAccountId": "1a0b1ccc-960c-450d-a009-12b50197d745",
    "ContactId": "855c43d4-18ab-4257-98c9-8296cf87cea3",
    "Amount": 5.5000,
    "AllocateFullAmount": true,
    "PaymentMethodId": null,
    "Details": "API payment details",
    "Reference": "API payment reference",
    "IsReconciled": false,
    "ReconciliationStatus": 0,
    "Narration": "API payment notes",
    "ContactName": "ba494511-b167-4c58-b8f4-f60006d4cbf3",
    "Allocations": [
        {
            "AllocationAmount": 5.5000,
            "AllocationType": "Bill",
            "AllocationTypeId": 2,
            "RefId": "9cdda15d-e458-495e-bf98-c7ab1e781048"
        }
    ],
    "AllocationSplit": [],
    "AccountsPayableCategoryId": "5f91ba80-1746-43ff-9a38-1740799ede10",
    "AccountsReceivableCategoryId": null,
    "ClassificationId": "8080558a-cf9b-4ea0-b809-e764a492c791",
    "TimeCreated": "2020-05-04T12:11:49.6546204+10:00",
    "TimeLastModified": "2020-05-04T12:11:49.6546204+10:00",
    "RecurringTransId": null,
    "RecurringTransName": null
}
Sample POST 

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

Method: POST

{
     'TransDate': '10/10/2018',
     'BankAccountId': '5b3a4f48-beb0-4e23-bf2f-2d7127239a00',
     'Amount': 100,
     'ContactId': '519403ea-bd33-4b7c-b71a-cd32b8fbe2c8',
     'AllocateFullAmount': false,
     'PaymentMethodId': '057ecf9c-b966-4fe5-93e5-edc8812344b3',
     'Details': 'Pay my bill',
     'Reference': '123456DEF',
     'IsReconciled': false,
     'Narration': 'This is my narration',
     'Allocations': [],
     'AllocationSplit':
      [
         {
          'ProjectId': '24879c21-8e1f-4f50-b1a0-bb01d3447b7b',
          'ChargeableItemId': 'af848ea8-cfdb-4768-a6f9-c916a873985f',
          'LineNo': 1,
          'Description': null,
          'Quantity': 0,
          'UnitPriceExTax': 10,
          'UnitPriceTax': 1,
          'UnitPricePrecision': 2,
          'DiscountAmountExTax': null,
          'DiscountAmountTax': null,
          'DiscountAccuracy': null,
          'DiscountPercent': null,
          'TaxGroupId': 'fae4ba18-20db-4b35-a944-711f7c3273bb',
          'TaxIsModified': false,
          'AmountExTax': 10,
          'Amount': 0,
          'TaxAmount': 1,
          'AmountAccuracy': null,
          'InvoiceDiscountedAmountExTax': null,
          'InvoiceDiscountedTaxAmount': null,
          'HasDataForPosting': true,
          'IsSubTotal': false,
          'IsParent': false,
          'AccountId': '00000000-0000-0000-0000-000000000000'
         }
    ]
}

Sample minimum post

The below example will create a new Make Payment transaction with an item called Chocolate Nutella, including 1 quantity and use tax code GST:

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

Method: POST

 {
   "TransDate": "12/17/2018",
   "BankAccountId": "4cd7c12f-1931-4938-a739-1fe758fbd633",
   "Amount": 11,
   "ContactId": "4a614080-a0e9-4ee3-a7d7-11671d3142cf",
   "AllocateFullAmount": true,
   "AllocationSplit": 
   [
    {
     "ChargeableItemId": "3fee7750-9cf3-4739-856d-d67503e7823b",
     "LineNo": 1,
     "Quantity": 1,
     "TaxGroupId": "0933b89e-0a9a-4d41-8c5b-1ec21509bfb5",
     "AmountExTax": 10,
     "TaxAmount": 1,
     "HasDataForPosting": true
    }
   ]
 }
Sample PUT

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

Method: PUT

{
     'TransDate': '10/10/2018',
     'BankAccountId': '5b3a4f48-beb0-4e23-bf2f-2d7127239a00',
     'Amount': 100,
     'ContactId': '519403ea-bd33-4b7c-b71a-cd32b8fbe2c8',
     'AllocateFullAmount': false,
     'PaymentMethodId': '057ecf9c-b966-4fe5-93e5-edc8812344b3',
     'Details': 'Pay my bill',
     'Reference': '123456DEF',
     'IsReconciled': false,
     'Narration': 'This is my narration',
     'Allocations': [],
     'AllocationSplit':
        [
         {
          'ProjectId': '24879c21-8e1f-4f50-b1a0-bb01d3447b7b',
          'ChargeableItemId': 'af848ea8-cfdb-4768-a6f9-c916a873985f',
          'LineNo': 1,
          'Description': null,
          'Quantity': 0,
          'UnitPriceExTax': 10,
          'UnitPriceTax': 1,
          'UnitPricePrecision': 2,
          'DiscountAmountExTax': null,
          'DiscountAmountTax': null,
          'DiscountAccuracy': null,
          'DiscountPercent': null,
          'TaxGroupId': 'fae4ba18-20db-4b35-a944-711f7c3273bb',
          'TaxIsModified': false,
          'AmountExTax': 10,
          'Amount': 0,
          'TaxAmount': 1,
          'AmountAccuracy': null,
          'InvoiceDiscountedAmountExTax': null,
          'InvoiceDiscountedTaxAmount': null,
          'HasDataForPosting': true,
          'IsSubTotal': false,
          'IsParent': false,
          'AccountId': '00000000-0000-0000-0000-000000000000'
         }
       ]
 }

 

 Details of each object

Data Field

Description

Data Type

Mandatory?

TransDate

The transaction date for the receipt

Date/Time

Yes

BankAccountID

The GUID of the bank account to be associated with the receipt

GUID

Yes

Amount

The amount of the receipt to be posted

Numeric

Yes

ContactID

The id of the contact to be associated with the receipt

GUID

Yes

AllocateFullAmount

Whether the full amount is to be allocated to another transaction

Boolean  - true false

Yes

PaymentMethodID

The GUID of the payment method to be used with the transaction

GUID

No

Details

The description for the receipt

Alphanumeric

No

Reference

The reference for the transaction

Alphanumeric

No

Narration

The narration for the transaction

Alphanumeric

No

Allocations Array

Where the transaction should be allocated if it is to be associated with a transaction

Array

Depends if you're allocating to an invoice or just creating a new transaction

AllocationAmount

The amount you want to allocate

AllocationType

The transaction type you want to allocate

Alphanumeric

  1. Invoice
  2. Bill
  3. BillCredit
  4. CreditNote
  5. JournalEntryPayable
  6. JournalEntryReceivable
  7. Payment
  8. Receipt
  9. Expense

No

AllocationTypeId

The transaction type's Id you want to allocate the Payment to

Numeric:

  1. Invoice
  2. Bill
  3. BillCredit
  4. CreditNote
  5. JournalEntryPayable
  6. JournalEntryReceivable
  7. Payment
  8. Receipt
  9. Expense

Mandatory

RefId

The ID of the Bill that you want to allocate this Payment to

Mandatory

AllocationSplit Array

If the transaction is not to be associated with a previous transaction, how the amount should be allocated in the book

Array

Depends if you're allocating to an invoice or just creating a new transaction

ProjectID

If the transaction should be allocated to a project, the GUID of the project.

GUID

No

ChargeableItemId

If the transaction should be allocated to an item, the GUID of the item

GUID

Either ChargeableItemId or AccountId is required

AccountId

If the transaction should be allocated to a Chart of Account, the GUID of the account

GUID

Either ChargeableItemId or AccountId is required

LineNo

The line number in the transaction. Each line requires a separate entry in the AllocationSplit array

Numeric

No

Description

The description for the line in the transaction

Alphanumeric

No

Quantity

The quantity to be associated with the line

Numeric

No

UnitPriceExTax

The unit price to be allocated to the line without tax included

Numeric

No

UnitPriceTax

The tax amount to be allocated to the line

Numeric

No

UnitPricePrecision

The number of decimal places the tax should be calculated on up to 8.  is important for tax calcs by default will set to 2.0

Numeric

No

DiscountAmountExTax

The amount of the line with a discount applied minus tax

Numeric

No

DiscountAmountTax

The amount of tax for the line with a discount applied

Numeric

No

DiscountPercent

If a discount is to be applied via percentage, the percentage the discount should be

Numeric

No

TaxGroupId

The GUID of the tax code to be applied to the line in the transaction

GUID

No

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

No

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

No

AmountExTax

The amount of the line without tax

Numeric

Yes

Amount

The amount of the line including tax

Numeric

No

TaxAmount

The amount of tax for the line

Numeric

Yes

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

No

InvoiceDiscountedAmountExTax

Always null

 

No

InvoiceDiscountedTaxAmount

Always null

 

No

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

No

IsSubtotal

Whether this line is a subtotal

Boolean - True/False

No

IsParent

Whether this line is the parent of a group of other lines

Boolean - True/False

No

AccountsPayableCategoryId

Accounts Payable account's ID. You can get it either via GET Chart of Accounts or by going to Chart of Accounts within Reckon One webapp

GUID

No

 

How did we do?

Journals

Receipts (Receive Money) API v1

Related Articles

Money out Settings
Make Payments
Payments API v2
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)