Update Draft Despatch Advice
PUT /despatch-advices/{id}
PUT
/despatch-advices/{id}
Update an existing despatch advice. Requires the despatch_advice:create scope. Only documents in draft state can be updated.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
uuid
required
string format: uuid
The UUID of the draft despatch advice to update.
Request Body required
Section titled “Request Body required ” StorePeppolDocumentRequest
object
type
required
string
Responses
Section titled “ Responses ”Despatch advice updated successfully.
object
data
required
PeppolDocumentResource
object
id
required
string
peppol_document_type
required
PeppolDocumentType
string
name
required
string
document_type_id
required
string
process_id
required
string | null
direction
required
InvoiceDirection
string
document_number
required
string | null
referenced_document_number
required
string | null
referenced_invoice_id
required
string | null
referenced_peppol_document_id
required
string | null
response_code
required
string | null
sender_peppol_id
required
string | null
recipient_peppol_id
required
string | null
as4_message_id
required
string | null
ubl_json
required
array | null
status
required
string
user_id
required
string | null
amount
required
integer | null
currency
required
string | null
delivery_network_id
required
string | null
business_entity_id
required
string | null
is_test
required
boolean
ubl_version
required
string | null
raw_xml_url
required
object
metadata_json
required
string
created_at
required
string | null format: date-time
updated_at
required
string | null format: date-time
Despatch advice not found or does not belong to your company.
object
message
required
string
Despatch advice is not in draft state, validation error, or API key not associated with a company.
Server error during update.
object
success
required
boolean
message
required
string
data
required
null
errors
required
null