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.
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 |
| POST/PUT | Examples:
|
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 |
| POST/PUT | Example:
|
Payments
View the endpoint details.
Function | Supported Field(s) | HTTP Method | Comments |
Create/Update Payment |
| POST/PUT | Example:
|
Receipts
View the endpoint details.
Function | Supported Field(s) | HTTP Method | Comments |
Create/Update Receipts |
| POST/PUT | Example:
|
Items
View the endpoint details.
Function | Supported Field(s) | HTTP Method | Comments |
Create/Update Items |
| POST/PUT | Example:
|
