Table of Contents

Text to GUID

What is Text to GUID?

When you send a call to the Reckon One API, in the JSON body you can pass the "Name" (ie text) of the supported fields, instead of sending the GUID (usually for data that exists in another resource, or if you like, database table). This means you will no longer need to GET the GUIDs to then POST the data. 

In other words, if you know the customer name is Michael Jones, you can now send this in the JSON rather than GET CONTACTS > look for name = Michael Jones > return the GUID for this name > send that GUID in your POST. 

You can still send the GUID if you prefer

 

Which fields support Text to GUID?

Invoices

​​​View the endpoint details​.

Function

Supported Field(s)

HTTP Method

Comments

Get Invoice By Id

InvoiceID

GET

Only possible if user hasn't changed the Invoice Prefix (example: INV) to include characters such as a colon that are considered for URLs

Delete Invoice

InvoiceID

POST

Only possible if user hasn't changed the Invoice Prefix (example: INV) to include characters such as a colon that are considered for URLs

Approve Invoice

InvoiceID

POST

Only possible if user hasn't changed the Invoice Prefix (example: INV) to include characters such as a colon that are considered for URLs

Create Invoice

  • AccountsReceivableCategoryId
  • ClassificationId
  • TermID
  • TemplateID
  • CustomerID
  • ProjectId
  • TaxGroupId
  • ChargeableItemId
  • AccountId

POST/PUT

Examples:

  • "CustomerId":"Michael Jones",
  • "TemplateId":"Professional Invoice",
  • "TermID": "Net 15",
  • "ClassificationId": "North Sydney",
  • "ChargeableItemId":"Callout charge",
  • "TaxGroupId":"GST",
  • "AccountId":Sales Income",

Credit Notes (Customer Adjustment Notes)

View the endpoint details.

Function

Supported Field(s)

HTTP Method

Comments

Get Credit Note By Id

CreditNoteID

GET

Only possible if user hasn't changed the Credit Note Prefix (example: INV) to include characters such as a colon that are considered for URLs

Delete Credit Note

CreditNoteID

POST

Only possible if user hasn't changed the Credit Note Prefix (example: INV) to include characters such as a colon that are considered for URLs

Approve Credit Note

CreditNoteID

POST

Only possible if user hasn't changed the Credit Note Prefix (example: INV) to include characters such as a colon that are considered for URLs

Create/Update Create Note

  • ClassificationId
  • TemplateID
  • CustomerID
  • ProjectId
  • TaxGroupId
  • ChargeableItemId
  • AccountId

POST/PUT

Example:

  • "CustomerId":"Peter Smith",
  • "TemplateId":"Professional Invoice",
  • "ClassificationId": "North Sydney",
  • "ChargeableItemId":"Service call",
  • "TaxGroupId":"GST",
  • "AccountId":"Sales Income",

Payments

View the endpoint details.

Function

Supported Field(s)

HTTP Method

Comments

Create/Update Payment

  • ContactID
  • BankAccountID
  • PaymentMethodID
  • AccountsPayableCategoryId
  • ClassificationId
  • ChargeableItemId
  • ProjectId
  • AccountId
  • TaxGroupId
  • RefID (Allocations array)

POST/PUT

Example:

  • "ContactId":"Sarah Hall",
  • "TemplateId":"Professional Invoice",
  • "AccountsPayableCategoryId":"Accounts Payable",
  • "ClassificationId": "North Sydney",
  • "ChargeableItemId":"Labour",
  • "TaxGroupId":"GST",
  • "AccountId":Income",

Receipts

View the endpoint details.

Function

Supported Field(s)

HTTP Method

Comments

Create/Update Receipts

  • ContactID
  • BankAccountID
  • PaymentMethodID
  • AccountsReceivableCategoryId
  • ClassificationId
  • ChargeableItemId
  • ProjectId
  • AccountId
  • TaxGroupId
  • RefID (Allocations array)

POST/PUT

Example:

  • "ContactId":"Jenny Black",
  • "TemplateId":"Professional Invoice",
  • "AccountsReceivableCategoryId":"Accounts Receivable",
  • "ClassificationId": "North Sydney",
  • "ChargeableItemId":"Travel",
  • "TaxGroupId":"GST",
  • "AccountId":"Sales Income",

Items

View the endpoint details.

Function

Supported Field(s)

HTTP Method

Comments

Create/Update Items

  • Id
  • ParentChargeableItemID
  • PurchaseCategoryId
  • PurchaseTaxId
  • SaleCategoryId
  • SaleTaxId

POST/PUT

Example:

  • "Id":"Cola 600ml",
  • "ParentChargeableItemID":"Softdrinks",
  • "PurchaseCategoryId":"Cost of goods sold",
  • "PurchaseTaxId":"NCG",
  • "SaleCategoryId":"Sales Income",
  • "SaleTaxId":"GST",

How did we do?

Pagination

FAQ - Reckon One API

Related Articles

Invoices API v1
Leave Items
Payroll Items Super
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)