POST api/CollectiveCorrections

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
id	integer	None.
fullNumber	string	None.
correctionTitle	string	String length: inclusive between 0 and 1024
type	integer	Required Range: inclusive between 302 and 302
kind	integer	Required Range: inclusive between 302010 and 302010
paymentMethod	string	Required String length: inclusive between 0 and 20
sourceWarehouseId	integer	Required
status	integer	Required Range: inclusive between 0 and 1
documentIssueDate	date	None.
documentCorrectionDate	date	None.
calculatedOn	integer	Required Range: inclusive between 1 and 2
payer	Customer	None.
recipient	Customer	None.
documentIds	Collection of integer	Required
symbol	string	String length: inclusive between 0 and 5
series	string	String length: inclusive between 0 and 5
number	integer	None.
discountAmount	decimal number	Required
transactionType	integer	Range: inclusive between -1 and 10
activeVatVies	integer	Range: inclusive between -1 and 1
companyData	CompanyData	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "fullNumber": "sample string 2",
  "correctionTitle": "sample string 3",
  "type": 4,
  "kind": 5,
  "paymentMethod": "sample string 6",
  "sourceWarehouseId": 7,
  "status": 8,
  "documentIssueDate": "2025-11-08T13:36:19.0111809+01:00",
  "documentCorrectionDate": "2025-11-08T13:36:19.0111809+01:00",
  "calculatedOn": 11,
  "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",
    "phoneDocument": "sample string 17",
    "phone1": "sample string 18",
    "phone2": "sample string 19",
    "inactive": 20,
    "defaultPrice": 21,
    "final": 1,
    "bankAccountNumber": "sample string 22",
    "regon": "sample string 23",
    "email": "sample string 24",
    "paymentMethod": "sample string 25",
    "dateOfPayment": 26,
    "maxPaymentDelay": 27,
    "created": "2025-11-08T13:36:19.0111809+01:00",
    "updated": "2025-11-08T13:36:19.0111809+01:00",
    "description": "sample string 30",
    "countryCode": "sample string 31",
    "type": 1,
    "companyData": {
      "companyName": "sample string 1",
      "databaseName": "sample string 2"
    },
    "countryIso": "sample string 32",
    "group": "sample string 33",
    "type_supplier": 1,
    "type_receiver": 1,
    "type_competitor": 1,
    "type_partner": 1,
    "type_potential": 1,
    "split_payment": 1,
    "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"
        }
      }
    ],
    "purchaseCategory": "sample string 34",
    "representativeId": 35,
    "representativeType": 36
  },
  "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",
    "phoneDocument": "sample string 17",
    "phone1": "sample string 18",
    "phone2": "sample string 19",
    "inactive": 20,
    "defaultPrice": 21,
    "final": 1,
    "bankAccountNumber": "sample string 22",
    "regon": "sample string 23",
    "email": "sample string 24",
    "paymentMethod": "sample string 25",
    "dateOfPayment": 26,
    "maxPaymentDelay": 27,
    "created": "2025-11-08T13:36:19.0111809+01:00",
    "updated": "2025-11-08T13:36:19.0111809+01:00",
    "description": "sample string 30",
    "countryCode": "sample string 31",
    "type": 1,
    "companyData": {
      "companyName": "sample string 1",
      "databaseName": "sample string 2"
    },
    "countryIso": "sample string 32",
    "group": "sample string 33",
    "type_supplier": 1,
    "type_receiver": 1,
    "type_competitor": 1,
    "type_partner": 1,
    "type_potential": 1,
    "split_payment": 1,
    "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"
        }
      }
    ],
    "purchaseCategory": "sample string 34",
    "representativeId": 35,
    "representativeType": 36
  },
  "documentIds": [
    1,
    2
  ],
  "symbol": "sample string 12",
  "series": "sample string 13",
  "number": 14,
  "discountAmount": 15.0,
  "transactionType": 16,
  "activeVatVies": 17,
  "companyData": {
    "companyName": "sample string 1",
    "databaseName": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<CollectiveCorrection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApiOptima_v._2._0.Models">
  <activeVatVies>17</activeVatVies>
  <calculatedOn>11</calculatedOn>
  <companyData>
    <companyName>sample string 1</companyName>
    <databaseName>sample string 2</databaseName>
  </companyData>
  <correctionTitle>sample string 3</correctionTitle>
  <discountAmount>15</discountAmount>
  <documentCorrectionDate>2025-11-08T13:36:19.0111809+01:00</documentCorrectionDate>
  <documentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </documentIds>
  <documentIssueDate>2025-11-08T13:36:19.0111809+01:00</documentIssueDate>
  <fullNumber>sample string 2</fullNumber>
  <id>1</id>
  <kind>5</kind>
  <number>14</number>
  <payer>
    <additionalAdress>sample string 12</additionalAdress>
    <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>
    <bankAccountNumber>sample string 22</bankAccountNumber>
    <city>sample string 10</city>
    <code>sample string 2</code>
    <companyData>
      <companyName>sample string 1</companyName>
      <databaseName>sample string 2</databaseName>
    </companyData>
    <country>sample string 8</country>
    <countryCode>sample string 31</countryCode>
    <countryIso>sample string 32</countryIso>
    <created>2025-11-08T13:36:19.0111809+01:00</created>
    <dateOfPayment>26</dateOfPayment>
    <defaultPrice>21</defaultPrice>
    <description>sample string 30</description>
    <email>sample string 24</email>
    <final>1</final>
    <flatNumber>sample string 16</flatNumber>
    <group>sample string 33</group>
    <houseNumber>sample string 15</houseNumber>
    <id>1</id>
    <inactive>20</inactive>
    <maxPaymentDelay>27</maxPaymentDelay>
    <name1>sample string 3</name1>
    <name2>sample string 4</name2>
    <name3>sample string 5</name3>
    <paymentMethod>sample string 25</paymentMethod>
    <peselNumber>sample string 6</peselNumber>
    <phone1>sample string 18</phone1>
    <phone2>sample string 19</phone2>
    <phoneDocument>sample string 17</phoneDocument>
    <post>sample string 14</post>
    <postCode>sample string 13</postCode>
    <purchaseCategory>sample string 34</purchaseCategory>
    <regon>sample string 23</regon>
    <representativeId>35</representativeId>
    <representativeType>36</representativeType>
    <split_payment>1</split_payment>
    <street>sample string 11</street>
    <type>1</type>
    <type_competitor>1</type_competitor>
    <type_partner>1</type_partner>
    <type_potential>1</type_potential>
    <type_receiver>1</type_receiver>
    <type_supplier>1</type_supplier>
    <updated>2025-11-08T13:36:19.0111809+01:00</updated>
    <vatNumber>sample string 7</vatNumber>
    <voivodeship>sample string 9</voivodeship>
  </payer>
  <paymentMethod>sample string 6</paymentMethod>
  <recipient>
    <additionalAdress>sample string 12</additionalAdress>
    <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>
    <bankAccountNumber>sample string 22</bankAccountNumber>
    <city>sample string 10</city>
    <code>sample string 2</code>
    <companyData>
      <companyName>sample string 1</companyName>
      <databaseName>sample string 2</databaseName>
    </companyData>
    <country>sample string 8</country>
    <countryCode>sample string 31</countryCode>
    <countryIso>sample string 32</countryIso>
    <created>2025-11-08T13:36:19.0111809+01:00</created>
    <dateOfPayment>26</dateOfPayment>
    <defaultPrice>21</defaultPrice>
    <description>sample string 30</description>
    <email>sample string 24</email>
    <final>1</final>
    <flatNumber>sample string 16</flatNumber>
    <group>sample string 33</group>
    <houseNumber>sample string 15</houseNumber>
    <id>1</id>
    <inactive>20</inactive>
    <maxPaymentDelay>27</maxPaymentDelay>
    <name1>sample string 3</name1>
    <name2>sample string 4</name2>
    <name3>sample string 5</name3>
    <paymentMethod>sample string 25</paymentMethod>
    <peselNumber>sample string 6</peselNumber>
    <phone1>sample string 18</phone1>
    <phone2>sample string 19</phone2>
    <phoneDocument>sample string 17</phoneDocument>
    <post>sample string 14</post>
    <postCode>sample string 13</postCode>
    <purchaseCategory>sample string 34</purchaseCategory>
    <regon>sample string 23</regon>
    <representativeId>35</representativeId>
    <representativeType>36</representativeType>
    <split_payment>1</split_payment>
    <street>sample string 11</street>
    <type>1</type>
    <type_competitor>1</type_competitor>
    <type_partner>1</type_partner>
    <type_potential>1</type_potential>
    <type_receiver>1</type_receiver>
    <type_supplier>1</type_supplier>
    <updated>2025-11-08T13:36:19.0111809+01:00</updated>
    <vatNumber>sample string 7</vatNumber>
    <voivodeship>sample string 9</voivodeship>
  </recipient>
  <series>sample string 13</series>
  <sourceWarehouseId>7</sourceWarehouseId>
  <status>8</status>
  <symbol>sample string 12</symbol>
  <transactionType>16</transactionType>
  <type>4</type>
</CollectiveCorrection>

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 'CollectiveCorrection'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.