POST api/DocumentsCorrection

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
id	integer	None.
fullNumber	string	None.
foreignNumber	string	None.
type	integer	Required
kind	integer	Required
payer	CustomerCorrection	None.
recipient	CustomerCorrection	None.
documentIssueDate	date	None.
documentCorrectionDate	date	None.
documentReceptionDate	date	None.
documentPaymentDate	date	None.
paymentMethod	string	None.
status	integer	Required
sourceDocumentId	integer	Required
elements	Collection of DocumentElement	Required
symbol	string	String length: inclusive between 0 and 5
series	string	String length: inclusive between 0 and 5
number	integer	None.
attributes	Collection of Attribute	None.
companyData	CompanyData	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "fullNumber": "sample string 2",
  "foreignNumber": "sample string 3",
  "type": 4,
  "kind": 5,
  "payer": {
    "id": 1,
    "code": "sample string 2",
    "name1": "sample string 3",
    "name2": "sample string 4",
    "name3": "sample string 5",
    "peselNumber": "sample string 6",
    "vatNumber": "sample string 7",
    "country": "sample string 8",
    "voivodeship": "sample string 9",
    "city": "sample string 10",
    "street": "sample string 11",
    "additionalAdress": "sample string 12",
    "postCode": "sample string 13",
    "post": "sample string 14",
    "houseNumber": "sample string 15",
    "flatNumber": "sample string 16",
    "phone1": "sample string 17",
    "email": "sample string 18",
    "countryCode": "sample string 19"
  },
  "recipient": {
    "id": 1,
    "code": "sample string 2",
    "name1": "sample string 3",
    "name2": "sample string 4",
    "name3": "sample string 5",
    "peselNumber": "sample string 6",
    "vatNumber": "sample string 7",
    "country": "sample string 8",
    "voivodeship": "sample string 9",
    "city": "sample string 10",
    "street": "sample string 11",
    "additionalAdress": "sample string 12",
    "postCode": "sample string 13",
    "post": "sample string 14",
    "houseNumber": "sample string 15",
    "flatNumber": "sample string 16",
    "phone1": "sample string 17",
    "email": "sample string 18",
    "countryCode": "sample string 19"
  },
  "documentIssueDate": "2025-11-08T13:30:53.9789618+01:00",
  "documentCorrectionDate": "2025-11-08T13:30:53.9789618+01:00",
  "documentReceptionDate": "2025-11-08T13:30:53.9789618+01:00",
  "documentPaymentDate": "2025-11-08T13:30:53.9789618+01:00",
  "paymentMethod": "sample string 10",
  "status": 11,
  "sourceDocumentId": 12,
  "elements": [
    {
      "id": 1,
      "itemId": 2,
      "code": "sample string 3",
      "name": "sample string 4",
      "manufacturerCode": "sample string 5",
      "warehouseId": 6,
      "unitNetPrice": 7.0,
      "priceNumber": 8,
      "priceType": 9,
      "priceZero": 10.0,
      "unitGrossPrice": 11.0,
      "totalNetValue": 12.0,
      "totalGrossValue": 13.0,
      "quantity": 14.0,
      "vatRate": 15.0,
      "vatRateFlag": 16,
      "setCustomValue": true,
      "currentQuantity": 18.0,
      "unit": "sample string 19",
      "category": "sample string 20",
      "purchaseAmount": 21.0,
      "deliveryLots": [
        {
          "deliveryId": 1,
          "quantity": 2.0,
          "features": [
            {
              "featureCode": "sample string 1",
              "featureValue": "sample string 2"
            },
            {
              "featureCode": "sample string 1",
              "featureValue": "sample string 2"
            }
          ]
        },
        {
          "deliveryId": 1,
          "quantity": 2.0,
          "features": [
            {
              "featureCode": "sample string 1",
              "featureValue": "sample string 2"
            },
            {
              "featureCode": "sample string 1",
              "featureValue": "sample string 2"
            }
          ]
        }
      ],
      "attributes": [
        {
          "id": 1,
          "attributeId": 2,
          "objectId": 3,
          "code": "sample string 4",
          "value": "sample string 5",
          "copyToTransaction": 6,
          "copyToDelivery": 7,
          "companyData": {
            "companyName": "sample string 1",
            "databaseName": "sample string 2"
          }
        },
        {
          "id": 1,
          "attributeId": 2,
          "objectId": 3,
          "code": "sample string 4",
          "value": "sample string 5",
          "copyToTransaction": 6,
          "copyToDelivery": 7,
          "companyData": {
            "companyName": "sample string 1",
            "databaseName": "sample string 2"
          }
        }
      ],
      "recipeID": 22
    },
    {
      "id": 1,
      "itemId": 2,
      "code": "sample string 3",
      "name": "sample string 4",
      "manufacturerCode": "sample string 5",
      "warehouseId": 6,
      "unitNetPrice": 7.0,
      "priceNumber": 8,
      "priceType": 9,
      "priceZero": 10.0,
      "unitGrossPrice": 11.0,
      "totalNetValue": 12.0,
      "totalGrossValue": 13.0,
      "quantity": 14.0,
      "vatRate": 15.0,
      "vatRateFlag": 16,
      "setCustomValue": true,
      "currentQuantity": 18.0,
      "unit": "sample string 19",
      "category": "sample string 20",
      "purchaseAmount": 21.0,
      "deliveryLots": [
        {
          "deliveryId": 1,
          "quantity": 2.0,
          "features": [
            {
              "featureCode": "sample string 1",
              "featureValue": "sample string 2"
            },
            {
              "featureCode": "sample string 1",
              "featureValue": "sample string 2"
            }
          ]
        },
        {
          "deliveryId": 1,
          "quantity": 2.0,
          "features": [
            {
              "featureCode": "sample string 1",
              "featureValue": "sample string 2"
            },
            {
              "featureCode": "sample string 1",
              "featureValue": "sample string 2"
            }
          ]
        }
      ],
      "attributes": [
        {
          "id": 1,
          "attributeId": 2,
          "objectId": 3,
          "code": "sample string 4",
          "value": "sample string 5",
          "copyToTransaction": 6,
          "copyToDelivery": 7,
          "companyData": {
            "companyName": "sample string 1",
            "databaseName": "sample string 2"
          }
        },
        {
          "id": 1,
          "attributeId": 2,
          "objectId": 3,
          "code": "sample string 4",
          "value": "sample string 5",
          "copyToTransaction": 6,
          "copyToDelivery": 7,
          "companyData": {
            "companyName": "sample string 1",
            "databaseName": "sample string 2"
          }
        }
      ],
      "recipeID": 22
    }
  ],
  "symbol": "sample string 13",
  "series": "sample string 14",
  "number": 15,
  "attributes": [
    {
      "id": 1,
      "attributeId": 2,
      "objectId": 3,
      "code": "sample string 4",
      "value": "sample string 5",
      "copyToTransaction": 6,
      "copyToDelivery": 7,
      "companyData": {
        "companyName": "sample string 1",
        "databaseName": "sample string 2"
      }
    },
    {
      "id": 1,
      "attributeId": 2,
      "objectId": 3,
      "code": "sample string 4",
      "value": "sample string 5",
      "copyToTransaction": 6,
      "copyToDelivery": 7,
      "companyData": {
        "companyName": "sample string 1",
        "databaseName": "sample string 2"
      }
    }
  ],
  "companyData": {
    "companyName": "sample string 1",
    "databaseName": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<DocumentCorrection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApiOptima_v._2._0.Models">
  <attributes>
    <Attribute>
      <attributeId>2</attributeId>
      <code>sample string 4</code>
      <companyData>
        <companyName>sample string 1</companyName>
        <databaseName>sample string 2</databaseName>
      </companyData>
      <copyToDelivery>7</copyToDelivery>
      <copyToTransaction>6</copyToTransaction>
      <id>1</id>
      <objectId>3</objectId>
      <value>sample string 5</value>
    </Attribute>
    <Attribute>
      <attributeId>2</attributeId>
      <code>sample string 4</code>
      <companyData>
        <companyName>sample string 1</companyName>
        <databaseName>sample string 2</databaseName>
      </companyData>
      <copyToDelivery>7</copyToDelivery>
      <copyToTransaction>6</copyToTransaction>
      <id>1</id>
      <objectId>3</objectId>
      <value>sample string 5</value>
    </Attribute>
  </attributes>
  <companyData>
    <companyName>sample string 1</companyName>
    <databaseName>sample string 2</databaseName>
  </companyData>
  <documentCorrectionDate>2025-11-08T13:30:53.9789618+01:00</documentCorrectionDate>
  <documentIssueDate>2025-11-08T13:30:53.9789618+01:00</documentIssueDate>
  <documentPaymentDate>2025-11-08T13:30:53.9789618+01:00</documentPaymentDate>
  <documentReceptionDate>2025-11-08T13:30:53.9789618+01:00</documentReceptionDate>
  <elements>
    <DocumentElement>
      <attributes>
        <Attribute>
          <attributeId>2</attributeId>
          <code>sample string 4</code>
          <companyData>
            <companyName>sample string 1</companyName>
            <databaseName>sample string 2</databaseName>
          </companyData>
          <copyToDelivery>7</copyToDelivery>
          <copyToTransaction>6</copyToTransaction>
          <id>1</id>
          <objectId>3</objectId>
          <value>sample string 5</value>
        </Attribute>
        <Attribute>
          <attributeId>2</attributeId>
          <code>sample string 4</code>
          <companyData>
            <companyName>sample string 1</companyName>
            <databaseName>sample string 2</databaseName>
          </companyData>
          <copyToDelivery>7</copyToDelivery>
          <copyToTransaction>6</copyToTransaction>
          <id>1</id>
          <objectId>3</objectId>
          <value>sample string 5</value>
        </Attribute>
      </attributes>
      <category>sample string 20</category>
      <code>sample string 3</code>
      <currentQuantity>18</currentQuantity>
      <deliveryLots>
        <DeliveryLot>
          <deliveryId>1</deliveryId>
          <features>
            <ItemFeatures>
              <featureCode>sample string 1</featureCode>
              <featureValue>sample string 2</featureValue>
            </ItemFeatures>
            <ItemFeatures>
              <featureCode>sample string 1</featureCode>
              <featureValue>sample string 2</featureValue>
            </ItemFeatures>
          </features>
          <quantity>2</quantity>
        </DeliveryLot>
        <DeliveryLot>
          <deliveryId>1</deliveryId>
          <features>
            <ItemFeatures>
              <featureCode>sample string 1</featureCode>
              <featureValue>sample string 2</featureValue>
            </ItemFeatures>
            <ItemFeatures>
              <featureCode>sample string 1</featureCode>
              <featureValue>sample string 2</featureValue>
            </ItemFeatures>
          </features>
          <quantity>2</quantity>
        </DeliveryLot>
      </deliveryLots>
      <id>1</id>
      <itemId>2</itemId>
      <manufacturerCode>sample string 5</manufacturerCode>
      <name>sample string 4</name>
      <priceNumber>8</priceNumber>
      <priceType>9</priceType>
      <priceZero>10</priceZero>
      <purchaseAmount>21</purchaseAmount>
      <quantity>14</quantity>
      <recipeID>22</recipeID>
      <setCustomValue>true</setCustomValue>
      <totalGrossValue>13</totalGrossValue>
      <totalNetValue>12</totalNetValue>
      <unit>sample string 19</unit>
      <unitGrossPrice>11</unitGrossPrice>
      <unitNetPrice>7</unitNetPrice>
      <vatRate>15</vatRate>
      <vatRateFlag>16</vatRateFlag>
      <warehouseId>6</warehouseId>
    </DocumentElement>
    <DocumentElement>
      <attributes>
        <Attribute>
          <attributeId>2</attributeId>
          <code>sample string 4</code>
          <companyData>
            <companyName>sample string 1</companyName>
            <databaseName>sample string 2</databaseName>
          </companyData>
          <copyToDelivery>7</copyToDelivery>
          <copyToTransaction>6</copyToTransaction>
          <id>1</id>
          <objectId>3</objectId>
          <value>sample string 5</value>
        </Attribute>
        <Attribute>
          <attributeId>2</attributeId>
          <code>sample string 4</code>
          <companyData>
            <companyName>sample string 1</companyName>
            <databaseName>sample string 2</databaseName>
          </companyData>
          <copyToDelivery>7</copyToDelivery>
          <copyToTransaction>6</copyToTransaction>
          <id>1</id>
          <objectId>3</objectId>
          <value>sample string 5</value>
        </Attribute>
      </attributes>
      <category>sample string 20</category>
      <code>sample string 3</code>
      <currentQuantity>18</currentQuantity>
      <deliveryLots>
        <DeliveryLot>
          <deliveryId>1</deliveryId>
          <features>
            <ItemFeatures>
              <featureCode>sample string 1</featureCode>
              <featureValue>sample string 2</featureValue>
            </ItemFeatures>
            <ItemFeatures>
              <featureCode>sample string 1</featureCode>
              <featureValue>sample string 2</featureValue>
            </ItemFeatures>
          </features>
          <quantity>2</quantity>
        </DeliveryLot>
        <DeliveryLot>
          <deliveryId>1</deliveryId>
          <features>
            <ItemFeatures>
              <featureCode>sample string 1</featureCode>
              <featureValue>sample string 2</featureValue>
            </ItemFeatures>
            <ItemFeatures>
              <featureCode>sample string 1</featureCode>
              <featureValue>sample string 2</featureValue>
            </ItemFeatures>
          </features>
          <quantity>2</quantity>
        </DeliveryLot>
      </deliveryLots>
      <id>1</id>
      <itemId>2</itemId>
      <manufacturerCode>sample string 5</manufacturerCode>
      <name>sample string 4</name>
      <priceNumber>8</priceNumber>
      <priceType>9</priceType>
      <priceZero>10</priceZero>
      <purchaseAmount>21</purchaseAmount>
      <quantity>14</quantity>
      <recipeID>22</recipeID>
      <setCustomValue>true</setCustomValue>
      <totalGrossValue>13</totalGrossValue>
      <totalNetValue>12</totalNetValue>
      <unit>sample string 19</unit>
      <unitGrossPrice>11</unitGrossPrice>
      <unitNetPrice>7</unitNetPrice>
      <vatRate>15</vatRate>
      <vatRateFlag>16</vatRateFlag>
      <warehouseId>6</warehouseId>
    </DocumentElement>
  </elements>
  <foreignNumber>sample string 3</foreignNumber>
  <fullNumber>sample string 2</fullNumber>
  <id>1</id>
  <kind>5</kind>
  <number>15</number>
  <payer>
    <additionalAdress>sample string 12</additionalAdress>
    <city>sample string 10</city>
    <code>sample string 2</code>
    <country>sample string 8</country>
    <countryCode>sample string 19</countryCode>
    <email>sample string 18</email>
    <flatNumber>sample string 16</flatNumber>
    <houseNumber>sample string 15</houseNumber>
    <id>1</id>
    <name1>sample string 3</name1>
    <name2>sample string 4</name2>
    <name3>sample string 5</name3>
    <peselNumber>sample string 6</peselNumber>
    <phone1>sample string 17</phone1>
    <post>sample string 14</post>
    <postCode>sample string 13</postCode>
    <street>sample string 11</street>
    <vatNumber>sample string 7</vatNumber>
    <voivodeship>sample string 9</voivodeship>
  </payer>
  <paymentMethod>sample string 10</paymentMethod>
  <recipient>
    <additionalAdress>sample string 12</additionalAdress>
    <city>sample string 10</city>
    <code>sample string 2</code>
    <country>sample string 8</country>
    <countryCode>sample string 19</countryCode>
    <email>sample string 18</email>
    <flatNumber>sample string 16</flatNumber>
    <houseNumber>sample string 15</houseNumber>
    <id>1</id>
    <name1>sample string 3</name1>
    <name2>sample string 4</name2>
    <name3>sample string 5</name3>
    <peselNumber>sample string 6</peselNumber>
    <phone1>sample string 17</phone1>
    <post>sample string 14</post>
    <postCode>sample string 13</postCode>
    <street>sample string 11</street>
    <vatNumber>sample string 7</vatNumber>
    <voivodeship>sample string 9</voivodeship>
  </recipient>
  <series>sample string 14</series>
  <sourceDocumentId>12</sourceDocumentId>
  <status>11</status>
  <symbol>sample string 13</symbol>
  <type>4</type>
</DocumentCorrection>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentCorrection'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.