POST api/EInvoice/Return

Request Information

URI Parameters

None.

Body Parameters

UUID
NameDescriptionTypeAdditional information
submissionId

string

None.

acceptedDocuments

Collection of acceptedDocuments

None.

rejectedDocuments

Collection of RejectedDocuments

None.

Request Formats

application/json, text/json

Sample:
{
  "submissionId": "sample string 1",
  "acceptedDocuments": [
    {
      "uuid": "sample string 1",
      "longId": "sample string 2",
      "internalId": "sample string 3",
      "hashKey": "sample string 4"
    },
    {
      "uuid": "sample string 1",
      "longId": "sample string 2",
      "internalId": "sample string 3",
      "hashKey": "sample string 4"
    }
  ],
  "rejectedDocuments": [
    {
      "internalId": "sample string 1",
      "error": {
        "code": "sample string 1",
        "message": "sample string 2",
        "target": "sample string 3",
        "propertyPath": "sample string 4",
        "details": [
          {
            "code": "sample string 1",
            "message": "sample string 2",
            "target": "sample string 3",
            "propertyPath": "sample string 4",
            "details": "sample string 5"
          },
          {
            "code": "sample string 1",
            "message": "sample string 2",
            "target": "sample string 3",
            "propertyPath": "sample string 4",
            "details": "sample string 5"
          }
        ]
      }
    },
    {
      "internalId": "sample string 1",
      "error": {
        "code": "sample string 1",
        "message": "sample string 2",
        "target": "sample string 3",
        "propertyPath": "sample string 4",
        "details": [
          {
            "code": "sample string 1",
            "message": "sample string 2",
            "target": "sample string 3",
            "propertyPath": "sample string 4",
            "details": "sample string 5"
          },
          {
            "code": "sample string 1",
            "message": "sample string 2",
            "target": "sample string 3",
            "propertyPath": "sample string 4",
            "details": "sample string 5"
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:
<UUID xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZamzamAPI.Models">
  <acceptedDocuments>
    <acceptedDocuments>
      <hashKey>sample string 4</hashKey>
      <internalId>sample string 3</internalId>
      <longId>sample string 2</longId>
      <uuid>sample string 1</uuid>
    </acceptedDocuments>
    <acceptedDocuments>
      <hashKey>sample string 4</hashKey>
      <internalId>sample string 3</internalId>
      <longId>sample string 2</longId>
      <uuid>sample string 1</uuid>
    </acceptedDocuments>
  </acceptedDocuments>
  <rejectedDocuments>
    <RejectedDocuments>
      <error>
        <code>sample string 1</code>
        <details>
          <Details>
            <code>sample string 1</code>
            <details>sample string 5</details>
            <message>sample string 2</message>
            <propertyPath>sample string 4</propertyPath>
            <target>sample string 3</target>
          </Details>
          <Details>
            <code>sample string 1</code>
            <details>sample string 5</details>
            <message>sample string 2</message>
            <propertyPath>sample string 4</propertyPath>
            <target>sample string 3</target>
          </Details>
        </details>
        <message>sample string 2</message>
        <propertyPath>sample string 4</propertyPath>
        <target>sample string 3</target>
      </error>
      <internalId>sample string 1</internalId>
    </RejectedDocuments>
    <RejectedDocuments>
      <error>
        <code>sample string 1</code>
        <details>
          <Details>
            <code>sample string 1</code>
            <details>sample string 5</details>
            <message>sample string 2</message>
            <propertyPath>sample string 4</propertyPath>
            <target>sample string 3</target>
          </Details>
          <Details>
            <code>sample string 1</code>
            <details>sample string 5</details>
            <message>sample string 2</message>
            <propertyPath>sample string 4</propertyPath>
            <target>sample string 3</target>
          </Details>
        </details>
        <message>sample string 2</message>
        <propertyPath>sample string 4</propertyPath>
        <target>sample string 3</target>
      </error>
      <internalId>sample string 1</internalId>
    </RejectedDocuments>
  </rejectedDocuments>
  <submissionId>sample string 1</submissionId>
</UUID>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.