Skip to content
Invoro Docs

Create Despatch Advice

POST
/despatch-advices

Create a new despatch advice from structured JSON data. Requires the despatch_advice:create scope. The document is created in draft state.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
type
required
string
Allowed values: order order_response despatch_advice invoice_response
business_entity_id
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Despatch advice created successfully.

object
data
required
PeppolDocumentResource
object
id
required
string
peppol_document_type
required
PeppolDocumentType
string
Allowed values: invoice credit_note invoice_response mlr mls order order_response order_agreement despatch_advice catalogue catalogue_response punch_out unknown
name
required
string
document_type_id
required
string
process_id
required
string | null
direction
required
InvoiceDirection
string
Allowed values: incoming outgoing
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

422

Section titled “422 ”

Validation error or API key not associated with a company.

object
message
required
string
Allowed value: User must belong to a company to create despatch advices.

500

Section titled “500 ”

Server error during creation.

object
success
required
boolean
message
required
string
data
required
null
errors
required
null