Generate pro-forma sales invoice from sub-order

POST /api-v1/sub-orders/{subOrderId}/generate-pro-forma

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Path parameters

subOrderId integer Required

subOrderId

Query parameters

invoicingDate string Required

invoicingDate

Responses

200 */*

OK
Hide response attributes Show response attributes object
- bvrGenerationAvailability boolean
- client string
- clientAdvancedInvoicingNote string
- clientBillingEmail string
- clientECorrespondence boolean
- clientEmail string
- clientId integer
- comments string
- creatorContactId integer
- currency string
- date string(date-time)
- description string
- flagsAmount integer(int32)
- hasComments boolean
- hasShipments boolean
- hasWarnings boolean
- id integer
- inWorkflow boolean
- isInWorkflow boolean
- netAmount number
- number string
- organizationId integer
- ourContactName string
- qrGenerationAvailability boolean
- receivable number
- reference string
- referenceAndDescriptionJoined string
- status string
  
  Values are OPEN, UNPAID, PAID, PARTIALLY_PAID, OVERDUE, NOT_SENT, or PRO_FORMA.
- systemValidated boolean
- totalAmount number
- validated boolean
- warnings string
- workflowPermissions string
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

POST /api-v1/sub-orders/{subOrderId}/generate-pro-forma

curl \
 --request POST 'https://wyzio.app/api-v1/sub-orders/{subOrderId}/generate-pro-forma?invoicingDate=string' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "bvrGenerationAvailability": true,
    "client": "string",
    "clientAdvancedInvoicingNote": "string",
    "clientBillingEmail": "string",
    "clientECorrespondence": true,
    "clientEmail": "string",
    "clientId": 42,
    "comments": "string",
    "creatorContactId": 42,
    "currency": "string",
    "date": "2025-05-04T09:42:00Z",
    "description": "string",
    "flagsAmount": 42,
    "hasComments": true,
    "hasShipments": true,
    "hasWarnings": true,
    "id": 42,
    "inWorkflow": true,
    "isInWorkflow": true,
    "netAmount": 42.0,
    "number": "string",
    "organizationId": 42,
    "ourContactName": "string",
    "qrGenerationAvailability": true,
    "receivable": 42.0,
    "reference": "string",
    "referenceAndDescriptionJoined": "string",
    "status": "OPEN",
    "systemValidated": true,
    "totalAmount": 42.0,
    "validated": true,
    "warnings": "string",
    "workflowPermissions": "string"
  }
]