invoice
Trigger Invoice Workflow
Trigger a specific workflow event for a given invoice
post/v2/invoices/{invoiceId}/workflow/{workflowEventId}
Request
- Base URLhttps://scx-sbx.api.jtl-software.com
- Auth
- OAuth 2Authorization codehttps://auth.jtl-cloud.com/oauth2/authToken URLhttps://auth.jtl-cloud.com/oauth2/tokenScopesinvoices.write
- or OAuth 2Client credentialsToken URLhttps://auth.jtl-cloud.com/oauth2/tokenScopesinvoices.write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
workflowEventId1 | 3 | 6 required
1 = Created, 3 = CompletePaid, 6 = Canceled
The id of the Event for that the manual workflow event should be started.
invoiceIdstring uuid required
Example:b45f6432-2462-4c6f-b00f-1d9d01000000
The ID of the invoice for which the manual workflow event should be started.
Headers
x-tenant-idstring uuid required
The tenant ID for the target ERP instance.
x-runasstring
The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.
x-companyidstring
The Company-Id (int or uuid) of the company on whose behalf the request is executed.
Changes
No recorded changes to this operation across all 1 revision of this API.