Marmin Oman Documentation

Generate credit note XML

Downloads the OMN e-invoicing XML for the credit note. Default type=document returns UBL 2.1 (generated, or archived after Peppol transmission). type=tdd and type=mls return Peppol archive files when they exist. See the right panel for request examples.

GET /api/sales-credit-notes/{id}/xml

Path parameters

Parameter	Type	Required	Description
`id`	string	Required	The ID of the credit note.

Query parameters

Parameter	Type	Required	Description
`type`	string	Optional	XML variant. Allowed values: `document` (default, UBL), `tdd`, `mls`.
`mls_for`	string	Conditional	Required when `type=mls`. Allowed values: `document` (C3 MLS) or `tdd` (C5 MLS).

Examples:

GET /api/sales-credit-notes/{id}/xml
GET /api/sales-credit-notes/{id}/xml?type=document
GET /api/sales-credit-notes/{id}/xml?type=tdd
GET /api/sales-credit-notes/{id}/xml?type=mls&mls_for=document
GET /api/sales-credit-notes/{id}/xml?type=mls&mls_for=tdd

Response

Status code: 200 OK

Response headers:

Header	Description
`Content-Type`	`application/xml`
`Content-Disposition`	`attachment; filename="<name>"` where `<name>` follows the convention below.
`x-suggested-filename`	Same filename, readable by browser clients.

Filename convention: <kind>-<document uuid>.xml, where <kind> depends on the requested variant.

Request	Filename
`type=document` (default)	`credit-note-<uuid>.xml`
`type=tdd`	`tdd-<uuid>.xml`
`type=mls&mls_for=document`	`document-mls-<uuid>.xml`
`type=mls&mls_for=tdd`	`tdd-mls-<uuid>.xml`

Response body: XML content. For type=document, UBL 2.1 credit note XML. For tdd / mls, the corresponding Peppol archive XML.

Error responses

Status	Description
400 Bad Request	Invalid `type` or missing/invalid `mls_for` when `type=mls`.
401 Unauthorized	Authentication required or invalid token.
403 Forbidden	User not authorized to access this credit note.
404 Not Found	Credit note not found, or TDD/MLS XML is not available yet.
500 Internal Server Error	An error occurred while processing the request.