Change the Job Status

Tags:
Categories:

POST /invoicing/invoice/edit

The invoice/edit endpoint can be used to change the Job Status of an Invoice. In EPASS, the Job Status is used to indicate the current state of the Invoice in relation to the sales or service process. As the Invoice moves through the sales or service process, the Job Status is updated.

For example, an Invoice that goes from a quote to a scheduled delivery would have their Job Status changed from ‘ESTIMATE’ to ‘DELIVERY SCHEDULED’.

Invoice Conditions

To change the Job Status, the invoice must meet this list of conditions as well as the rule conditions that are set for each Job Status in EPASS.

Condition Value
Invoice Status Invoice must be Open or Commited

Changing the Job Status

Payload

Required Fields

The following are the minimum fields required to change the Job Status.

Field Type Description
InvoiceCode string Must be a valid Invoice Code.
JobStatusCode string Must be a valid Job Status Code

Sample: Changing the Job Status


POST /invoicing/invoice/edit
{
  "invoiceCode": "RS00000117",
  "JobStatusCode": "FIRM"
}


{
    "Success": true,
    "Warning": false,
    "HttpStatusCode": 201,
    "GeneralMessage": null,
    "ExceptionMessage": null,
    "Keys": [
        {
            "Table": "Invoice",
            "Keys": [
                {
                    "Key": "ID",
                    "Fields": [
                        {
                            "FieldName": "ID",
                            "FieldValue": 2179386
                        }
                    ]
                }
            ]
        },
        {
            "Table": "InvoiceNote",
            "Keys": [
                {
                    "Key": "ID",
                    "Fields": [
                        {
                            "FieldName": "ID",
                            "FieldValue": 20115388
                        }
                    ]
                }
            ]
        }
    ],
    "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-0100111",
            "Message": "You cannot select this Job Status. The Minimum Deposit has not been reached!"
        }
    ],
    "Warnings": []
}