Change the Schedule, Pickup, or Requested Date

Tags:
Categories:

POST /invoicing/invoice/edit

This endpoint can change an invoice’s Schedule, Pickup, or Requested date. You can also use this endpoint to set any date to a null value.

Invoice Conditions

An invoice must meet this list of conditions to change dates.

Condition Value
Invoice Status Invoice must be Open or Commited

Changing the Schedule or Pickup Date

Payload

Required Fields

The following are the minimum fields required to change the Schedule/Pickup Date of an invoice.

Field Type Description
InvoiceCode string Must be a valid Invoice Code.
ScheduleDate -or- PickupDate string Format: YYYY-MM-DDThh:hh:ss.sssZ
The scheduled delivery/pickup date.

Optional Fields

These fields are needed to handle the user interaction that is often required in EPASS to successfully change a date (for example, click ‘OK or ‘Yes’ to a confirmation prompt or granting permission by entering login credentials).

Field Sub-Field Type Description
OverridesPickupDate LoginOverride boolean If true, then override any ‘user login’ request during Pickup date update.
TerminalTaxChange boolean If true, then override any request to replace the invoice Tax2 code with the Terminal tax code.
DeleteExistingPrimaryCall boolean If true, existing primary Dispatch call is deleted.
DeleteExistingOtherCalls boolean If true, any existing Dispatch calls that are NOT primary are deleted. This is only required when the primary Dispatch call has been deleted.
OverridesScheduleDate LoginOverride boolean If true, then override any ‘user login’ request during Schedule date update.
DeleteExistingPrimaryCall boolean If true, existing primary Dispatch call is deleted.
DeleteExistingOtherCalls boolean If true, any existing Dispatch calls that are NOT primary are deleted. This is only required when the primary Dispatch call has been deleted.
UpdateExistingOtherCalls boolean If true, update all existing dispatch calls that are NOT primary when the schedule date is changed to a valid date.
CityTaxChange boolean If true, city tax change override is allowed.
AllowPastDate boolean If true, past date change override is allowed.

Sample: Changing the Schedule or Pickup Date

POST /invoicing/invoice/edit
{
    "userModified": null,
    "invoiceCode": "1234567",
    "pickupDate": "2026-10-18",  
    
​    "overridespickupdate":{
​        "LoginOverride": true, // To Override any 'user login' request
		"TerminalTaxChange": true, // To override any request to replace the invoice Tax2 code with the Terminal tax code.
​        "DeleteExistingPrimaryCall": true, // To delete any existing primary dispatch call.
​        "DeleteExistingOtherCalls": true, // To delete any existing dispatch calls that are NOT primary. 
​        "CityTaxChange": true, // To allow city tax change override.
​    },
}
POST /invoicing/invoice/edit
{
    "userModified": null,
    "invoiceCode": "1234567",
    "scheduleDate": "2026-10-18",  
    
​    "overridesscheduledate":{
​        "LoginOverride": true, // To Override any 'user login' request
​        "DeleteExistingPrimaryCall": true, // To delete any existing primary dispatch call.
​        "DeleteExistingOtherCalls": true, // To delete any existing dispatch calls that are NOT primary. 
		"UpdateExistingOtherCalls": true, // Update all existing dispatch calls that are NOT primary.
​        "CityTaxChange": true, // To allow city tax change override.
​        "AllowPastDate": true, // To allow past date override.
​    },
}
{
​    "success": true,
​    "warning": false,
​    "httpStatusCode": 201,
​    "generalMessage": null,
​    "exceptionMessage": null,
​    "keys": [
​        {
​            "table": "Invoice",
​            "keys": [
​                {
​                    "key": "ID",
​                    "fields": [
​                        {
​                            "fieldName": "ID",
​                            "fieldValue": 12345
​                        }
​                    ]
​                }
​            ]
​        },
​        {
​            "table": "InvoiceNote",
​            "keys": [
​                {
​                    "key": "ID",
​                    "fields": [
​                        {
​                            "fieldName": "ID",
​                            "fieldValue": 123456
​                        }
​                    ]
​                }
​            ]
​        }
​    ],
​    "messages": [],
​    "warnings": []
}
  
{
​    "success": false,
​    "warning": false,
​    "httpStatusCode": 422,
​    "generalMessage": "One or more of the fields has an invalid or missing value.",
​    "exceptionMessage": null,
​    "keys": [],
​    "messages": [
​        {
​            "code": "INV-010073",
​            "message": "You cannot select a Schedule Date that is in the past."
​        }
​    ],
​    "warnings": []
}

Changing the Requested Date

Payload

Required Fields

The following are the absolute minimum fields required to change the requested date on an invoice.

Field Type Description
InvoiceCode string Must be a valid Invoice Code.
RequestedDate string Format: YYYY-MM-DDThh:hh:ss.sssZ
The requested delivery date.

Sample: Changing the Requested Date

POST /invoicing/invoice/edit
{
    "userModified": null,
    "invoiceCode": "5797",
    "RequestedDate": "2022-10-19",
}
{
​    "Success": true,
​    "Warning": false,
​    "HttpStatusCode": 201,
​    "GeneralMessage": null,
​    "ExceptionMessage": null,
​    "Keys": [
​        {
​            "Table": "Invoice",
​            "Keys": [
​                {
​                    "Key": "ID",
​                    "Fields": [
​                        {
​                            "FieldName": "ID",
​                            "FieldValue": 3643
​                        }
​                    ]
​                }
​            ]
​        }
​    ],
​    "Messages": [],
​    "Warnings": []
}
{
​    "Success": false,
​    "Warning": false,
​    "HttpStatusCode": 422,
​    "GeneralMessage": "One or more of the fields has an invalid or missing value.",
​    "ExceptionMessage": null,
​    "Keys": [],
​    "Messages": [
​        {
​            "Code": "INV-010104",
​            "Message": "cannot edit a Finished Invoice."
​        }
​    ],
​    "Warnings": []
}

Resetting the Schedule or Pickup Date to a Null Value

Sending a request to the endpoint with this payload will reset an invoice’s current Schedule or Pickup date to a null value.

Payload

Required Fields

The following are the absolute minimum fields required to reset the requested date to a null value.

Field Type Description
InvoiceCode string Must be a valid Invoice Code.
ScheduleDate -or- PickupDate string Format: YYYY-MM-DDThh:hh:ss.sssZ
The requested delivery date.
isScheduleDateSet -or- isPickupDateSet boolean This boolean field needs to be true.

Optional Fields

These fields are needed to handle the user interaction that is often required in EPASS to successfully change a date (for example, click ‘OK or ‘Yes’ to a confirmation prompt or granting permission by entering login credentials).

Field Sub-Field Type Description
OverridesPickupDate LoginOverride boolean If true, then override any ‘user login’ request during Pickup date update.
TerminalTaxChange boolean If true, then override any request to replace the invoice Tax2 code with the Terminal tax code.
DeleteExistingPrimaryCall boolean If true, existing primary Dispatch call is deleted.
DeleteExistingOtherCalls boolean If true, any existing Dispatch calls that are NOT primary are deleted. This is only required when the primary Dispatch call has been deleted.
OverridesScheduleDate LoginOverride boolean If true, then override any ‘user login’ request during Schedule date update.
DeleteExistingPrimaryCall boolean If true, existing primary Dispatch call is deleted.
DeleteExistingOtherCalls boolean If true, any existing Dispatch calls that are NOT primary are deleted. This is only required when the primary Dispatch call has been deleted.
UpdateExistingOtherCalls boolean If true, update all existing dispatch calls that are NOT primary when the schedule date is changed to a valid date.
CityTaxChange boolean If true, city tax change override is allowed.
AllowPastDate boolean If true, past date change override is allowed.

Sample: Resetting the Schedule or Pickup Date

POST /invoicing/invoice/edit
{
    "userModified": null,
    "invoiceCode": "5501",
    "PickupDate": null,
    "isPickUpDateSet": true,
    
     "overridespickupdate":{
​        "LoginOverride": true, // To override any 'user login' request
​		"TerminalTaxChange": true, // To override any request to replace the invoice Tax2 code with the Terminal tax code.
​        "DeleteExistingPrimaryCall": true, // To delete any existing primary dispatch call.
​        "DeleteExistingOtherCalls": true, // To delete any existing dispatch calls that are NOT primary. 
​    },

}
POST /invoicing/invoice/edit
{
    "userModified": null,
    "invoiceCode": "5501",
    "ScheduleDate": null,
    "isScheduleDateSet": true,
    
     "overridesscheduledate":{
​        "LoginOverride": true, // To Override any 'user login' request
​        "DeleteExistingPrimaryCall": true, // To delete any existing primary dispatch call.
​        "DeleteExistingOtherCalls": true, // To delete any existing dispatch calls that are NOT primary. 
​		"UpdateExistingOtherCalls": true, // Update all existing dispatch calls that are NOT primary.
​        "CityTaxChange": true, // To allow city tax change override.
​        "AllowPastDate": true, // To allow past date override.
​    },

}
{
    "Success": true,
    "Warning": false,
    "HttpStatusCode": 201,
    "GeneralMessage": null,
    "ExceptionMessage": null,
    "Keys": [
        {
            "Table": "Invoice",
            "Keys": [
                {
                    "Key": "ID",
                    "Fields": [
                        {
                            "FieldName": "ID",
                            "FieldValue": 3643
                        }
                    ]
                }
            ]
        },
        {
            "Table": "InvoiceNote",
            "Keys": [
                {
                    "Key": "ID",
                    "Fields": [
                        {
                            "FieldName": "ID",
                            "FieldValue": 3418
                        }
                    ]
                }
            ]
        }
    ],
    "Messages": [],
    "Warnings": []
}
{
    "Success": false,
    "Warning": false,
    "HttpStatusCode": 422,
    "GeneralMessage": "One or more of the fields has an invalid or missing value.",
    "ExceptionMessage": null,
    "Keys": [],
    "Messages": [
        {
            "Code": "INV-010104",
            "Message": "cannot edit a Finished Invoice."
        }
    ],
    "Warnings": []
}

Resetting the Requested Date to a Null Value

Sending a request to the endpoint with this payload will reset an invoice’s current Requested date to a null value.

Payload

Required Fields

The following are the absolute minimum fields required to reset the Requested date to a null value.

Field Type Description
InvoiceCode string Must be a valid Invoice Code.
RequestedDate string Format: YYYY-MM-DDThh:hh:ss.sssZ
The requested delivery date.
isRequestedDateSet boolean This boolean field needs to be true.

Sample: Resetting the Requested Date to a Null Value

POST /invoicing/invoice/edit
{
    "userModified": null,
    "invoiceCode": "5501",
    "RequestedDate": null,
    "isRequestedDateSet": true
}
{
    "Success": true,
    "Warning": false,
    "HttpStatusCode": 201,
    "GeneralMessage": null,
    "ExceptionMessage": null,
    "Keys": [
        {
            "Table": "Invoice",
            "Keys": [
                {
                    "Key": "ID",
                    "Fields": [
                        {
                            "FieldName": "ID",
                            "FieldValue": 3643
                        }
                    ]
                }
            ]
        },
        {
            "Table": "InvoiceNote",
            "Keys": [
                {
                    "Key": "ID",
                    "Fields": [
                        {
                            "FieldName": "ID",
                            "FieldValue": 3418
                        }
                    ]
                }
            ]
        }
    ],
    "Messages": [],
    "Warnings": []
}
{
    "Success": false,
    "Warning": false,
    "HttpStatusCode": 422,
    "GeneralMessage": "One or more of the fields has an invalid or missing value.",
    "ExceptionMessage": null,
    "Keys": [],
    "Messages": [
        {
            "Code": "INV-010104",
            "Message": "cannot edit a Finished Invoice."
        }
    ],
    "Warnings": []
}