InvoiceNote

The InvoiceNote object represents a note that can be added to an invoice. Notes are added to an Invoice’s “Notepad” section and are intended for internal use only.
Tags:
Categories:

Add a Note to an Invoice

POST /invoicing/invoice/note/add

This endpoint adds a note to an invoice Notepad. Notes added to the invoice Notepad are internal and not viewed by customers.

Payload

Required Fields

The following fields are the absolute minimum fields that should be required to add a note to an invoice.

Field Type Value
Code string Must be a valid Invoice code.
Note string This field must contain a text string. It can not be left blank.

Sample: Adding a Note to an Invoice

POST /invoicing/invoice/note/add

{
    "systemGenerated": null,
    "scheduleDate": null,
    "sentToSvcReqProvider": null,
    "code": 12345,
    "note": "Call customer before arranging delivery",
    "userName": null
}

  
 {
    "success": true,
    "warning": false,
    "httpStatusCode": 201,
    "generalMessage": null,
    "exceptionMessage": null,
    "keys": [
        {
            "table": "InvoiceNote",
            "keys": [
                {
                    "key": "ID",
                    "fields": [
                        {
                            "fieldName": "ID",
                            "fieldValue": 4988226
                        }
                    ]
                }
            ]
        }
    ],
    "messages": [],
    "warnings": []
}
  
 {
    "success": false,
    "message": "One or more of the fields has an invalid or missing value.",
    "lastException": null,
    "recordId": 0,
    "code": null,
    "httpStatusCode": 422,
    "messageDetails": [
        "Note cannot be blank."
    ]
}