Main Web API Documentation Information
|
|
Actual Page/Function Name:
|
addInvoiceDeliveryDetails |
Human Readable Name or Caption:
|
Add Invoice Delivery Details |
Page/Function Description:
|
This method will add a new delivery. |
Page/Function Output Type:
|
API - JSON or WDDX |
Categories:
|
invoice,customer |
Extra Page/Function Notes:
|
This method will add delivery information to an existing invoice. Delivery information can only be added to an invoice with the sub invoice type id = 2 (Delivery). If you have Metrc enabled, this will automatically push the delivery sale to Metrc. |
Parameters
|
|||||||
Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
Arguments | CORP_ID | Numeric | 0 | Pass in the corp id number. This is your corporation ID or your business world number. This is required and will be validated. The default is 0, but will be checked for a real number. | Yes | ||
Arguments | DRIVER_ID | Numeric | All | This is the driver identification number. This will be checked for a real number. | Yes | ||
Arguments | INVOICE_NUMBER | Numeric | 0 | Pass in the invoice number. This will be checked for a real number. | Yes | ||
Arguments | VEHICLE_ID | Numeric | All | Pass in the vehicle id. This will be checked for a real number. | Yes | ||
Arguments | ROUTE | String | Pass in route description. This is a text value and can be up to 65,0000 characters long. | Yes | |||
Arguments | DEPARTURE | Date/Time | Pass in departure datetime. If this is left empty, the departure datetime will default to now. Example: 5/19/21 15:05:05. | No | |||
Arguments | ARRIVAL | Date/Time | Pass in arrival date time. If this is left empty, the arrival datetime with default to now. Example: 5/19/21 15:05:05. | No |
Results
|
||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
Samples
|
|
Caption | Text |
JSON |
{"API_CALL_FUNCTION_NAME":"addInvoiceDeliveryDetails","DEPARTURE":"","ARRIVAL":"", "CORP_ID":53,"DRIVER_ID":2,"INVOICE_NUMBER":145,"VEHICLE_ID":1,"ROUTE":"Test run to Walmart in Logan","API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}
|