documentv2

saveDocument

Internal documentv2/saveDocument operation. Authentication requirements are derived from the active route allowlist.

post/documentv2/saveDocument

Request body

authorization_device_idinteger

client_idinteger

currency_idinteger

discount_idinteger

document_datestring

due_datestring

idstring

include_detailsboolean

new_document_createdstring

payment_datestring

requested_previewboolean

statusstring

tax_idstring

business_idinteger

template_idinteger

document_typestring

document_nostring

progress_statusstring

additional_infostring

{"stackTrail":"paths:/documentv2/saveDocument:post:requestBody:content:application/json:schema:properties:currency","oasType":"schema","type":"unknown","nullable":true}

collection_modestring

generate_stripe_linkstring

notesstring

document_langstring

is_rendered_jpgstring

is_rendered_sharingstring

deleted_idsstring

Example request

{
  "authorization_device_id": 1,
  "client_id": 10026,
  "currency_id": 15,
  "discount_id": 2,
  "document_date": "2026-01-30T14:00:00.000Z",
  "id": "13215",
  "include_details": true,
  "new_document_created": "example_new_document_created",
  "payment_date": "2026-01-27T09:22:18.000Z",
  "requested_preview": true,
  "status": "paid",
  "business_id": 10038,
  "template_id": 10006,
  "document_type": "estimate",
  "document_no": "INV06978",
  "progress_status": "paid",
  "additional_info": "Cash on delivery \n  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
  "collection_mode": "other",
  "generate_stripe_link": "0",
  "notes": "A deposit of Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
  "document_lang": "en",
  "is_rendered_jpg": "0",
  "is_rendered_sharing": "0",
  "deleted_ids": "2053",
  "client_mutation": {
    "name": "Ali Traders office",
    "email": "ali@example.com",
    "mutation_id": "100198378913",
    "phone": "0500 0000000",
    "is_phone_formatted": "1",
    "address": "address",
    "additional_info": "address info"
  },
  "tax_mutation": {
    "name": "VAT",
    "amount": 15,
    "mutation_id": "tax_local_001"
  },
  "discount_mutation": {
    "name": "New Customer",
    "amount": 10,
    "type": "percentage",
    "mutation_id": "discount_local_001"
  },
  "business_goods": [
    {
      "user_id": 548,
      "mutation_id": "123456789012345657",
      "name": "testing item only",
      "description": "testing",
      "price": 150,
      "quantity": 1
    }
  ]
}

Response

Standard successful response envelope.

status'success' required

statusCodeinteger required

messagestring required

dataobject required

{"stackTrail":"components:schemas:SuccessEnvelope:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}

Example response

{
  "statusCode": 200,
  "message": "OK"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.