Mustangserver

Mustangproject e-invoice REST server API

Contacts:

Jochen Stärk: General inquiries - jstaerk@usegroup.de
Martin Wachtveitl: Technical support - martin.wachtveitl@itewa.com

More information: http://mustangproject.org/

Contact Info: jstaerk@usegroup.de

Version: 1.7.1

BasePath:/mustang/1.7.1

proprietary

http://mustangproject.org/server

Access

APIKey KeyParamName:apikey KeyInQuery:false KeyInHeader:true
HTTP Basic Authentication
OAuth AuthorizationUrl:https://gw.usegroup.de:8243/authorizeTokenUrl:

Methods

[ Jump to Models ]

ValidationController

post /mustang/phive
post /mustang/validate

MustangController

post /mustang/cii2ubl

Converts a UN/CEFACT CII XML file to UBL (cii2ubl)

Consumes

This API call consumes the following media types via the request header:

application/xml

Request body

body string (required)

Body Parameter —

Request headers

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/xml

Responses

200

Converts a UN/CEFACT CII XML file to UBL String

400

Bad Request ApiErrorResponse

post /mustang/ciitoubl

(ciitoubl)

Consumes

This API call consumes the following media types via the request header:

application/xml

Request body

body string (required)

Body Parameter —

Request headers

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/xml

Responses

200

OK String

post /mustang/combine

Combine PDF/A file and JSON invoice object. Output PDF will be a ZUGFeRD/Factur-X PDF/A-3 file called invoice.pdf. (combine)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Query parameters

format (required)

Query Parameter —

profile (required)

Query Parameter —

version (required)

Query Parameter — format: int32

Form parameters

file (optional)

Form Parameter — format: binary

json (optional)

Form Parameter —

Return type

array[byte[]]

Example data

Content-Type: application/json

[ "", "" ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Combine PDF/A file and JSON to zf/fx PDF. Input PDF must be PDF/A-1 or PDF/A-3, output PDF will be a ZUGFeRD/Factur-X PDF/A-3 file called invoice.pdf.

400

Bad Request ApiErrorResponse

post /mustang/combineXML

Combine PDF/A file and custom XML to zf/fx PDF. Input PDF must be PDF/A-1 or A-3, output PDF will be a ZUGFeRD/Factur-X PDF/A-3 file called invoice.pdf. (combineXML)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Query parameters

format (required)

Query Parameter —

version (required)

Query Parameter — format: int32

profile (required)

Query Parameter —

Form parameters

file (optional)

Form Parameter — format: binary

XML (optional)

Form Parameter —

Return type

array[byte[]]

Example data

Content-Type: application/json

[ "", "" ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Combine PDF/A file and custom XML to zf/fx PDF. Input PDF must be PDF/A-1 or PDF/A-3, output PDF will be a ZUGFeRD/Factur-X PDF/A-3 file called invoice.pdf.

400

Bad Request ApiErrorResponse

post /mustang/detach

Extract invoice file attachments from XML and PDF files (detach)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Form parameters

file (optional)

Form Parameter — format: binary

Return type

map[String, Object]

Example data

Content-Type: application/json

{
  "key" : { }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

400

Bad Request ApiErrorResponse

post /mustang/extract

Extracts XML from a zf/fx PDF or XML. Input PDF must be ZUGFeRD or Factur-X, XML must be xr,zf,fx or ox (extractFile)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Form parameters

file (optional)

Form Parameter — format: binary

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Extracts XML from a PDF or XML String

400

Bad Request ApiErrorResponse

post /mustang/invoice2XML

Invoice class to XML. Input must be JSON. (invoice2xml)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body CalculatedInvoice (required)

Body Parameter —

Request headers

Query parameters

format (required)

Query Parameter —

profile (required)

Query Parameter —

version (required)

Query Parameter — format: int32

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/xml

Responses

200

Invoice class to XML. Input must be JSON, output will be XML (CII). String

400

Bad Request ApiErrorResponse

post /mustang/parse

Reads a Factur-X file into an invoice object. Requires a PDF or CII or UBL XML file. (parse)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Form parameters

file (optional)

Form Parameter — format: binary

Return type

CalculatedInvoice

Example data

Content-Type: application/json

{
  "documentCode" : "documentCode",
  "calculation" : {
    "duePayable" : 6.84685269835264,
    "taxDetails" : [ {
      "documentCode" : "documentCode",
      "vatExemptionReasonText" : "vatExemptionReasonText",
      "categoryCode" : "categoryCode",
      "basis" : 3.616076749251911,
      "dueDateTypeCode" : "dueDateTypeCode",
      "calculated" : 2.027123023002322,
      "applicablePercent" : 4.145608029883936
    }, {
      "documentCode" : "documentCode",
      "vatExemptionReasonText" : "vatExemptionReasonText",
      "categoryCode" : "categoryCode",
      "basis" : 3.616076749251911,
      "dueDateTypeCode" : "dueDateTypeCode",
      "calculated" : 2.027123023002322,
      "applicablePercent" : 4.145608029883936
    } ],
    "grandTotal" : 1.4894159098541704,
    "allowanceTotal" : 1.2315135367772556,
    "taxBasis" : 7.457744773683766,
    "chargeTotal" : 7.386281948385884,
    "value" : 1.0246457001441578
  },
  "tradeSettlement" : [ { }, { } ],
  "notesWithSubjectCode" : [ null, null ],
  "notes" : [ "notes", "notes" ],
  "zflogisticsServiceCharges" : [ null, null ],
  "ownLocation" : "ownLocation",
  "dueDate" : "2000-01-23T04:56:07.000+00:00",
  "additionalReferencedDocuments" : [ {
    "filename" : "filename",
    "data" : [ "", "" ],
    "description" : "description",
    "mimetype" : "mimetype",
    "relation" : "relation"
  }, {
    "filename" : "filename",
    "data" : [ "", "" ],
    "description" : "description",
    "mimetype" : "mimetype",
    "relation" : "relation"
  } ],
  "ownCountry" : "ownCountry",
  "taxBasis" : 9.301444243932576,
  "extendedPaymentTerms" : [ null, null ],
  "despatchAdviceReferencedDocumentID" : "despatchAdviceReferencedDocumentID",
  "ownTaxID" : "ownTaxID",
  "shipToStreet" : "shipToStreet",
  "specifiedProcuringProjectName" : "specifiedProcuringProjectName",
  "number" : "number",
  "ownZIP" : "ownZIP",
  "totalPrepaidAmount" : 0.8008281904610115,
  "referenceNumber" : "referenceNumber",
  "shipToLocation" : "shipToLocation",
  "cashDiscounts" : [ {
    "asXRechnung" : "asXRechnung",
    "asCII" : "asCII"
  }, {
    "asXRechnung" : "asXRechnung",
    "asCII" : "asCII"
  } ],
  "ownForeignOrganisationID" : "ownForeignOrganisationID",
  "paymentTerms" : {
    "discountTerms" : {
      "baseDate" : "2000-01-23T04:56:07.000+00:00",
      "basePeriodMeasure" : 1,
      "basePeriodUnitCode" : "basePeriodUnitCode",
      "calculationPercentage" : 6.027456183070403
    },
    "dueDate" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description"
  },
  "shipToOrganisationName" : "shipToOrganisationName",
  "invoiceReferencedIssueDate" : "2000-01-23T04:56:07.000+00:00",
  "grandTotal" : 7.061401241503109,
  "buyerOrderReferencedDocumentID" : "buyerOrderReferencedDocumentID",
  "ownVATID" : "ownVATID",
  "detailedDeliveryPeriodFrom" : "2000-01-23T04:56:07.000+00:00",
  "tradeSettlementPayment" : [ null, null ],
  "specifiedProcuringProjectID" : "specifiedProcuringProjectID",
  "paymentTermDescription" : "paymentTermDescription",
  "sender" : {
    "zip" : "zip",
    "country" : "country",
    "vatID" : "vatID",
    "vatid" : "vatid",
    "globalID" : "globalID",
    "description" : "description",
    "globalIDScheme" : "globalIDScheme",
    "bankDetails" : [ {
      "paymentMeansCode" : "paymentMeansCode",
      "paymentMeansInformation" : "paymentMeansInformation",
      "accountName" : "accountName",
      "iban" : "iban",
      "bic" : "bic"
    }, {
      "paymentMeansCode" : "paymentMeansCode",
      "paymentMeansInformation" : "paymentMeansInformation",
      "accountName" : "accountName",
      "iban" : "iban",
      "bic" : "bic"
    } ],
    "debitDetails" : [ {
      "mandate" : "mandate",
      "paymentMeansCode" : "paymentMeansCode",
      "paymentMeansInformation" : "paymentMeansInformation",
      "iban" : "iban"
    }, {
      "mandate" : "mandate",
      "paymentMeansCode" : "paymentMeansCode",
      "paymentMeansInformation" : "paymentMeansInformation",
      "iban" : "iban"
    } ],
    "street" : "street",
    "taxID" : "taxID",
    "contact" : {
      "zip" : "zip",
      "country" : "country",
      "phone" : "phone",
      "street" : "street",
      "name" : "name",
      "vatid" : "vatid",
      "location" : "location",
      "additionalAddress" : "additionalAddress",
      "id" : "id",
      "fax" : "fax",
      "email" : "email"
    },
    "name" : "name",
    "additionalAddressExtension" : "additionalAddressExtension",
    "location" : "location",
    "additionalAddress" : "additionalAddress",
    "id" : "id",
    "email" : "email",
    "legalOrganisation" : {
      "tradingBusinessName" : "tradingBusinessName",
      "schemedID" : {
        "scheme" : "scheme",
        "id" : "id"
      }
    }
  },
  "subjectNote" : "subjectNote",
  "correction" : {
    "documentCode" : "documentCode",
    "tradeSettlement" : [ null, null ],
    "notesWithSubjectCode" : [ null, null ],
    "notes" : [ "notes", "notes" ],
    "zflogisticsServiceCharges" : [ null, null ],
    "ownLocation" : "ownLocation",
    "dueDate" : "2000-01-23T04:56:07.000+00:00",
    "additionalReferencedDocuments" : [ null, null ],
    "ownCountry" : "ownCountry",
    "extendedPaymentTerms" : [ null, null ],
    "despatchAdviceReferencedDocumentID" : "despatchAdviceReferencedDocumentID",
    "ownTaxID" : "ownTaxID",
    "shipToStreet" : "shipToStreet",
    "specifiedProcuringProjectName" : "specifiedProcuringProjectName",
    "number" : "number",
    "ownZIP" : "ownZIP",
    "totalPrepaidAmount" : 6.438423552598547,
    "referenceNumber" : "referenceNumber",
    "shipToLocation" : "shipToLocation",
    "cashDiscounts" : [ null, null ],
    "ownForeignOrganisationID" : "ownForeignOrganisationID",
    "shipToOrganisationName" : "shipToOrganisationName",
    "invoiceReferencedIssueDate" : "2000-01-23T04:56:07.000+00:00",
    "buyerOrderReferencedDocumentID" : "buyerOrderReferencedDocumentID",
    "ownVATID" : "ownVATID",
    "detailedDeliveryPeriodFrom" : "2000-01-23T04:56:07.000+00:00",
    "tradeSettlementPayment" : [ {
      "paymentMeansCode" : "paymentMeansCode",
      "paymentMeansInformation" : "paymentMeansInformation",
      "accountName" : "accountName",
      "ownIBAN" : "ownIBAN",
      "ownBIC" : "ownBIC"
    }, {
      "paymentMeansCode" : "paymentMeansCode",
      "paymentMeansInformation" : "paymentMeansInformation",
      "accountName" : "accountName",
      "ownIBAN" : "ownIBAN",
      "ownBIC" : "ownBIC"
    } ],
    "specifiedProcuringProjectID" : "specifiedProcuringProjectID",
    "paymentTermDescription" : "paymentTermDescription",
    "subjectNote" : "subjectNote",
    "ownOrganisationFullPlaintextInfo" : "ownOrganisationFullPlaintextInfo",
    "ownOrganisationName" : "ownOrganisationName",
    "roundingAmount" : 3.5571952270680973,
    "shipToOrganisationID" : "shipToOrganisationID",
    "invoiceReferencedDocumentID" : "invoiceReferencedDocumentID",
    "valid" : true,
    "zfitems" : [ null, null ],
    "shipToZIP" : "shipToZIP",
    "ownStreet" : "ownStreet",
    "currency" : "currency",
    "issueDate" : "2000-01-23T04:56:07.000+00:00",
    "deliveryDate" : "2000-01-23T04:56:07.000+00:00",
    "creditorReferenceID" : "creditorReferenceID",
    "shipToCountry" : "shipToCountry",
    "buyerOrderReferencedDocumentIssueDateTime" : "buyerOrderReferencedDocumentIssueDateTime",
    "contractReferencedDocument" : "contractReferencedDocument",
    "detailedDeliveryPeriodTo" : "2000-01-23T04:56:07.000+00:00",
    "paymentReference" : "paymentReference",
    "documentName" : "documentName",
    "zfallowances" : [ null, null ],
    "invoiceReferencedDocuments" : [ null, null ],
    "zfcharges" : [ null, null ],
    "sellerOrderReferencedDocumentID" : "sellerOrderReferencedDocumentID",
    "vatdueDateTypeCode" : "vatdueDateTypeCode"
  },
  "ownOrganisationFullPlaintextInfo" : "ownOrganisationFullPlaintextInfo",
  "ownOrganisationName" : "ownOrganisationName",
  "roundingAmount" : 5.962133916683182,
  "shipToOrganisationID" : "shipToOrganisationID",
  "invoiceReferencedDocumentID" : "invoiceReferencedDocumentID",
  "lineTotalAmount" : 5.637376656633329,
  "valid" : true,
  "zfitems" : [ {
    "product" : {
      "vatpercent" : 9.018348186070783,
      "globalID" : "globalID",
      "description" : "description",
      "taxExemptionReason" : "taxExemptionReason",
      "buyerAssignedID" : "buyerAssignedID",
      "globalIDScheme" : "globalIDScheme",
      "classifications" : [ {
        "classCode" : {
          "listID" : "listID",
          "code" : "code",
          "listVersionID" : "listVersionID"
        },
        "className" : "className"
      }, {
        "classCode" : {
          "listID" : "listID",
          "code" : "code",
          "listVersionID" : "listVersionID"
        },
        "className" : "className"
      } ],
      "charges" : [ null, null ],
      "unit" : "unit",
      "reverseCharge" : true,
      "name" : "name",
      "taxCategoryCode" : "taxCategoryCode",
      "attributes" : {
        "key" : "attributes"
      },
      "allowances" : [ null, null ],
      "countryOfOrigin" : "countryOfOrigin",
      "intraCommunitySupply" : true,
      "sellerAssignedID" : "sellerAssignedID"
    },
    "notesWithSubjectCode" : [ {
      "subjectCode" : "AAI",
      "content" : "content"
    }, {
      "subjectCode" : "AAI",
      "content" : "content"
    } ],
    "quantity" : 6.683562403749608,
    "notes" : [ "notes", "notes" ],
    "detailedDeliveryPeriodTo" : "2000-01-23T04:56:07.000+00:00",
    "referencedDocuments" : [ {
      "formattedIssueDateTime" : "2000-01-23T04:56:07.000+00:00",
      "referenceTypeCode" : "referenceTypeCode",
      "issuerAssignedID" : "issuerAssignedID",
      "typeCode" : "typeCode"
    }, {
      "formattedIssueDateTime" : "2000-01-23T04:56:07.000+00:00",
      "referenceTypeCode" : "referenceTypeCode",
      "issuerAssignedID" : "issuerAssignedID",
      "typeCode" : "typeCode"
    } ],
    "buyerOrderReferencedDocumentID" : "buyerOrderReferencedDocumentID",
    "additionalReferencedDocumentID" : "additionalReferencedDocumentID",
    "itemTotalAllowances" : [ null, null ],
    "accountingReference" : "accountingReference",
    "additionalReferences" : [ null, null ],
    "itemAllowances" : [ null, null ],
    "charges" : [ null, null ],
    "detailedDeliveryPeriodFrom" : "2000-01-23T04:56:07.000+00:00",
    "buyerOrderReferencedDocumentLineID" : "buyerOrderReferencedDocumentLineID",
    "price" : 9.965781217890562,
    "itemCharges" : [ null, null ],
    "allowances" : [ null, null ],
    "id" : "id",
    "basisQuantity" : 9.369310271410669,
    "value" : 8.762042012749001
  }, {
    "product" : {
      "vatpercent" : 9.018348186070783,
      "globalID" : "globalID",
      "description" : "description",
      "taxExemptionReason" : "taxExemptionReason",
      "buyerAssignedID" : "buyerAssignedID",
      "globalIDScheme" : "globalIDScheme",
      "classifications" : [ {
        "classCode" : {
          "listID" : "listID",
          "code" : "code",
          "listVersionID" : "listVersionID"
        },
        "className" : "className"
      }, {
        "classCode" : {
          "listID" : "listID",
          "code" : "code",
          "listVersionID" : "listVersionID"
        },
        "className" : "className"
      } ],
      "charges" : [ null, null ],
      "unit" : "unit",
      "reverseCharge" : true,
      "name" : "name",
      "taxCategoryCode" : "taxCategoryCode",
      "attributes" : {
        "key" : "attributes"
      },
      "allowances" : [ null, null ],
      "countryOfOrigin" : "countryOfOrigin",
      "intraCommunitySupply" : true,
      "sellerAssignedID" : "sellerAssignedID"
    },
    "notesWithSubjectCode" : [ {
      "subjectCode" : "AAI",
      "content" : "content"
    }, {
      "subjectCode" : "AAI",
      "content" : "content"
    } ],
    "quantity" : 6.683562403749608,
    "notes" : [ "notes", "notes" ],
    "detailedDeliveryPeriodTo" : "2000-01-23T04:56:07.000+00:00",
    "referencedDocuments" : [ {
      "formattedIssueDateTime" : "2000-01-23T04:56:07.000+00:00",
      "referenceTypeCode" : "referenceTypeCode",
      "issuerAssignedID" : "issuerAssignedID",
      "typeCode" : "typeCode"
    }, {
      "formattedIssueDateTime" : "2000-01-23T04:56:07.000+00:00",
      "referenceTypeCode" : "referenceTypeCode",
      "issuerAssignedID" : "issuerAssignedID",
      "typeCode" : "typeCode"
    } ],
    "buyerOrderReferencedDocumentID" : "buyerOrderReferencedDocumentID",
    "additionalReferencedDocumentID" : "additionalReferencedDocumentID",
    "itemTotalAllowances" : [ null, null ],
    "accountingReference" : "accountingReference",
    "additionalReferences" : [ null, null ],
    "itemAllowances" : [ null, null ],
    "charges" : [ null, null ],
    "detailedDeliveryPeriodFrom" : "2000-01-23T04:56:07.000+00:00",
    "buyerOrderReferencedDocumentLineID" : "buyerOrderReferencedDocumentLineID",
    "price" : 9.965781217890562,
    "itemCharges" : [ null, null ],
    "allowances" : [ null, null ],
    "id" : "id",
    "basisQuantity" : 9.369310271410669,
    "value" : 8.762042012749001
  } ],
  "shipToZIP" : "shipToZIP",
  "ownStreet" : "ownStreet",
  "currency" : "currency",
  "issueDate" : "2000-01-23T04:56:07.000+00:00",
  "deliveryDate" : "2000-01-23T04:56:07.000+00:00",
  "creditorReferenceID" : "creditorReferenceID",
  "shipToCountry" : "shipToCountry",
  "buyerOrderReferencedDocumentIssueDateTime" : "buyerOrderReferencedDocumentIssueDateTime",
  "contractReferencedDocument" : "contractReferencedDocument",
  "detailedDeliveryPeriodTo" : "2000-01-23T04:56:07.000+00:00",
  "paymentReference" : "paymentReference",
  "documentName" : "documentName",
  "zfallowances" : [ {
    "reason" : "reason",
    "basisAmount" : 4.965218492984954,
    "charge" : true,
    "taxPercent" : 1.1730742509559433,
    "reasonCode" : "reasonCode",
    "categoryCode" : "categoryCode",
    "percent" : 5.025004791520295
  }, {
    "reason" : "reason",
    "basisAmount" : 4.965218492984954,
    "charge" : true,
    "taxPercent" : 1.1730742509559433,
    "reasonCode" : "reasonCode",
    "categoryCode" : "categoryCode",
    "percent" : 5.025004791520295
  } ],
  "invoiceReferencedDocuments" : [ {
    "formattedIssueDateTime" : "2000-01-23T04:56:07.000+00:00",
    "referenceTypeCode" : "referenceTypeCode",
    "issuerAssignedID" : "issuerAssignedID",
    "typeCode" : "typeCode"
  }, {
    "formattedIssueDateTime" : "2000-01-23T04:56:07.000+00:00",
    "referenceTypeCode" : "referenceTypeCode",
    "issuerAssignedID" : "issuerAssignedID",
    "typeCode" : "typeCode"
  } ],
  "duePayable" : 2.3021358869347655,
  "zfcharges" : [ null, null ],
  "sellerOrderReferencedDocumentID" : "sellerOrderReferencedDocumentID",
  "vatdueDateTypeCode" : "vatdueDateTypeCode"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Reads a Factur-X file into an invoice object CalculatedInvoice

400

Bad Request ApiErrorResponse

get /mustang/ping

Healthcheck. Just request a ping, will respond with a 'pong' (ping)

Request headers

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Healthcheck. Just request a ping, will respond with a 'pong' String

400

Bad Request ApiErrorResponse

post /mustang/xmltohtml

Visualisation from XML to HTML. (xmltohtml)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Query parameters

language (required)

Query Parameter —

Form parameters

file (optional)

Form Parameter — format: binary

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/octet-stream

Responses

200

Visualisation from XML to HTML. String

400

Bad Request ApiErrorResponse

post /mustang/xmltopdf

Returns a PDF/A-3 visualisation from a XML string. (xmltopdf)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Query parameters

returnJSON (optional)

Query Parameter — default: false

Form parameters

file (optional)

Form Parameter — format: binary

Return type

array[byte[]]

Example data

Content-Type: application/json

[ "", "" ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Returns a PDF/A-3 visualisation from a XML string.

400

Bad Request ApiErrorResponse

PreErrorController

get /error

(error)

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK String

ValidationController

post /mustang/phive

Validates a XML file (phive)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Query parameters

VESID (optional)

Query Parameter —

Form parameters

inputFile (optional)

Form Parameter — format: binary

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Returns a JSON validation result String

400

Bad Request ApiErrorResponse

post /mustang/validate

Checks a PDF or XML file for syntactical and mathematical correctness. Input file must be a PDF/A file (Factur-X, ZUGFeRD, Order-X) or a XML file (Factur-X, Order-X, ZUGFeRD, XRechnung(CII)), output will be a XML report (validateFile)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

Query parameters

ignoreNotices (optional)

Query Parameter — default: false

Form parameters

file (optional)

Form Parameter — format: binary

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Checks a PDF or XML file for syntactical and mathematical correctness. Input file must be a PDF/A file (Factur-X, Order-X, ZUGFeRD) or a XML file (Factur-X, Order-X, ZUGFeRD, XRechnung(CII)), output will be a XML report String

400

Bad Request ApiErrorResponse

VersionController

get /mustang/notice

Returns legal related information (notice)

Request headers

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Returns legal related information String

400

Bad Request ApiErrorResponse

Models

[ Jump to Methods ]

ApiErrorResponse
BankDetails
CalculatedInvoice
ClassCode
DirectDebit
FileAttachment
IDesignatedProductClassification
IReferencedDocument
IZUGFeRDAllowanceCharge
IZUGFeRDCashDiscount
IZUGFeRDExportableContact
IZUGFeRDExportableItem
IZUGFeRDExportableProduct
IZUGFeRDLegalOrganisation
IZUGFeRDPaymentDiscountTerms
IZUGFeRDPaymentTerms
IZUGFeRDTradeSettlement
IZUGFeRDTradeSettlementPayment
IncludedNote
Invoice
ReferencedDocument
SchemedID
TradeParty
TransactionCalculator
VATAmount
mustang_combineXML_body
mustang_combine_body
mustang_detach_body
mustang_extract_body
mustang_parse_body
mustang_phive_body
mustang_validate_body
mustang_xmltohtml_body
mustang_xmltopdf_body

`ApiErrorResponse` Up

Response holding information for client errors.

requestUrl

String URL

httpCode

Integer HTTP code format: int32

errorCode

String Internal error code

message (optional)

String Message

details (optional)

map[String, String] Detail description

`BankDetails` Up

accountName (optional)

Mustangserver

Access

Table of Contents

Consumes

Request body

Request headers

Return type

Example data

Produces

Responses

200

400

Consumes

Request body

Request headers

Return type

Example data

Produces

Responses

200

Consumes

Request headers

Query parameters

Form parameters

Return type

Example data

Produces

Responses

200

400

Consumes

Request headers

Query parameters

Form parameters

Return type

Example data

Produces

Responses

200

400

Consumes

Request headers

Form parameters

Return type

Example data

Produces

Responses

200

400

Consumes

Request headers

Form parameters

Return type

Example data

Produces

Responses

200

400

Consumes

Request body

Request headers

Query parameters

Return type

Example data

Produces

Responses

200

400

Consumes

Request headers

Form parameters

Return type

Example data

Produces

Responses

200

400

Request headers

Return type

Example data