Assign Work Order to Invoice

Production

https://{{subdomain}}.daftra.com/api2

POST

/invoices/assign_work_order/{id}{format}

Assigns a work order to an existing invoice (or clears the assignment).

Send the target work order ID nested under the Invoice object as work_order_id. The invoice is identified by the id path parameter. To remove an existing assignment, send work_order_id as 0 or empty.

The Invoice object is required: if it is omitted the request is rejected with 403 and the message Please send valid work order id.

Requires permission to edit the invoice. If the Accounting module is enabled, the invoice's date must not fall within a closed financial period, otherwise the request is rejected with 400.

Work orders are part of the Work Orders feature; assigning an ID is only meaningful when that feature is enabled for your account.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The work order was assigned to the invoice.

Bodyapplication/json

🟠400Bad Request

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/api2/invoices/assign_work_order/2415.json' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "type": "object",
    "properties": {
        "Invoice": {
            "type": "object",
            "description": "Wrapper object carrying the work order assignment.",
            "properties": {
                "work_order_id": {
                    "type": "integer",
                    "description": "The ID of the work order to assign to the invoice. Send `0` (or an empty value) to clear the current assignment. The value is stored as-is, so it should reference an existing work order in your account.",
                    "examples": [
                        17
                    ]
                }
            },
            "required": [
                "work_order_id"
            ],
            "x-apidog-orders": [
                "work_order_id"
            ]
        }
    },
    "required": [
        "Invoice"
    ],
    "x-apidog-orders": [
        "Invoice"
    ]
}'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "message": ""
}

Update Invoice Draft Status

Add Shipping to Invoice