POST api/CreditNotes

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DocEntry	integer	None.
DocNum	integer	None.
CardCode	string	None.
CardName	string	None.
DocCurrency	string	None.
Series	integer	None.
DocDate	date	None.
DocDueDate	date	None.
TaxDate	date	None.
SalesPersonCode	integer	None.
NumAtCard	string	None.
Comments	string	None.
PaymentGroupCode	integer	None.
IdTranRedimir	string	None.
IdTranAcumular	string	None.
DocumentKey	string	None.
WithTransactionTapp	boolean	None.
DocTotalFC	decimal number	None.
DocTotal	decimal number	None.
Udfs	Collection of Udf	None.
DocumentLines	Collection of ARCreditMemoRows	None.
DocumentReferences	Collection of DocumentReferences	None.
PriceList	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "DocEntry": 1,
  "DocNum": 2,
  "CardCode": "sample string 3",
  "CardName": "sample string 4",
  "DocCurrency": "sample string 5",
  "Series": 6,
  "DocDate": "2025-09-14T15:45:29.1660343-06:00",
  "DocDueDate": "2025-09-14T15:45:29.1660343-06:00",
  "TaxDate": "2025-09-14T15:45:29.1660343-06:00",
  "SalesPersonCode": 10,
  "NumAtCard": "sample string 11",
  "Comments": "sample string 12",
  "PaymentGroupCode": 13,
  "IdTranRedimir": "sample string 14",
  "IdTranAcumular": "sample string 15",
  "DocumentKey": "sample string 16",
  "WithTransactionTapp": true,
  "DocTotalFC": 18.0,
  "DocTotal": 19.0,
  "Udfs": [
    {
      "Name": "sample string 1",
      "FieldType": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "FieldType": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "DocumentLines": [
    {
      "ItemCode": "sample string 1",
      "ItemDescription": "sample string 2",
      "UnitPrice": 3.0,
      "Quantity": 4.0,
      "DiscountPercent": 5.0,
      "Currency": "sample string 6",
      "TaxCode": "sample string 7",
      "TaxOnly": "sample string 8",
      "WarehouseCode": "sample string 9",
      "BaseType": 10,
      "TreeType": "sample string 11",
      "LineTotal": 12.0,
      "BaseEntry": 1,
      "BaseLine": 1,
      "UoMEntry": 13,
      "SerialNumbers": [
        {
          "SystemSerialNumber": 1,
          "Quantity": 2.0,
          "DistNumber": "sample string 3"
        },
        {
          "SystemSerialNumber": 1,
          "Quantity": 2.0,
          "DistNumber": "sample string 3"
        }
      ],
      "Udfs": [
        {
          "Name": "sample string 1",
          "FieldType": "sample string 2",
          "Value": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "FieldType": "sample string 2",
          "Value": "sample string 3"
        }
      ],
      "BatchNumbers": [
        {
          "BatchNumber": "sample string 1",
          "SystemSerialNumber": 2,
          "Quantity": 3.0
        },
        {
          "BatchNumber": "sample string 1",
          "SystemSerialNumber": 2,
          "Quantity": 3.0
        }
      ],
      "UoMMasterData": [
        {
          "UoMEntry": 1,
          "UomCode": "sample string 2",
          "UomName": "sample string 3",
          "UnitPrice": 4.0,
          "UnitPriceFC": 5.0
        },
        {
          "UoMEntry": 1,
          "UomCode": "sample string 2",
          "UomName": "sample string 3",
          "UnitPrice": 4.0,
          "UnitPriceFC": 5.0
        }
      ],
      "LinesCurrenciesList": [
        {
          "Id": "sample string 1",
          "DocCurrency": "sample string 2",
          "Description": "sample string 3",
          "Price": 4.0
        },
        {
          "Id": "sample string 1",
          "DocCurrency": "sample string 2",
          "Description": "sample string 3",
          "Price": 4.0
        }
      ],
      "WhsName": "sample string 14",
      "TaxRate": "sample string 15",
      "ManBtchNum": "sample string 16",
      "ManSerNum": "sample string 17",
      "CostingCode": "sample string 18",
      "CostingCode2": "sample string 19"
    },
    {
      "ItemCode": "sample string 1",
      "ItemDescription": "sample string 2",
      "UnitPrice": 3.0,
      "Quantity": 4.0,
      "DiscountPercent": 5.0,
      "Currency": "sample string 6",
      "TaxCode": "sample string 7",
      "TaxOnly": "sample string 8",
      "WarehouseCode": "sample string 9",
      "BaseType": 10,
      "TreeType": "sample string 11",
      "LineTotal": 12.0,
      "BaseEntry": 1,
      "BaseLine": 1,
      "UoMEntry": 13,
      "SerialNumbers": [
        {
          "SystemSerialNumber": 1,
          "Quantity": 2.0,
          "DistNumber": "sample string 3"
        },
        {
          "SystemSerialNumber": 1,
          "Quantity": 2.0,
          "DistNumber": "sample string 3"
        }
      ],
      "Udfs": [
        {
          "Name": "sample string 1",
          "FieldType": "sample string 2",
          "Value": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "FieldType": "sample string 2",
          "Value": "sample string 3"
        }
      ],
      "BatchNumbers": [
        {
          "BatchNumber": "sample string 1",
          "SystemSerialNumber": 2,
          "Quantity": 3.0
        },
        {
          "BatchNumber": "sample string 1",
          "SystemSerialNumber": 2,
          "Quantity": 3.0
        }
      ],
      "UoMMasterData": [
        {
          "UoMEntry": 1,
          "UomCode": "sample string 2",
          "UomName": "sample string 3",
          "UnitPrice": 4.0,
          "UnitPriceFC": 5.0
        },
        {
          "UoMEntry": 1,
          "UomCode": "sample string 2",
          "UomName": "sample string 3",
          "UnitPrice": 4.0,
          "UnitPriceFC": 5.0
        }
      ],
      "LinesCurrenciesList": [
        {
          "Id": "sample string 1",
          "DocCurrency": "sample string 2",
          "Description": "sample string 3",
          "Price": 4.0
        },
        {
          "Id": "sample string 1",
          "DocCurrency": "sample string 2",
          "Description": "sample string 3",
          "Price": 4.0
        }
      ],
      "WhsName": "sample string 14",
      "TaxRate": "sample string 15",
      "ManBtchNum": "sample string 16",
      "ManSerNum": "sample string 17",
      "CostingCode": "sample string 18",
      "CostingCode2": "sample string 19"
    }
  ],
  "DocumentReferences": [
    {
      "RefDocEntr": 1,
      "RefDocNum": 2,
      "RefObjType": "sample string 3",
      "Remark": "sample string 4"
    },
    {
      "RefDocEntr": 1,
      "RefDocNum": 2,
      "RefObjType": "sample string 3",
      "Remark": "sample string 4"
    }
  ],
  "PriceList": 20
}

application/xml, text/xml

Sample:

<ARCreditMemo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLMLTEMA.MODELS.SAP">
  <CardCode>sample string 3</CardCode>
  <CardName>sample string 4</CardName>
  <Comments>sample string 12</Comments>
  <DocCurrency>sample string 5</DocCurrency>
  <DocDate>2025-09-14T15:45:29.1660343-06:00</DocDate>
  <DocDueDate>2025-09-14T15:45:29.1660343-06:00</DocDueDate>
  <DocEntry>1</DocEntry>
  <DocNum>2</DocNum>
  <DocTotal>19</DocTotal>
  <DocTotalFC>18</DocTotalFC>
  <DocumentKey>sample string 16</DocumentKey>
  <DocumentLines>
    <ARCreditMemoRows>
      <BaseEntry>1</BaseEntry>
      <BaseLine>1</BaseLine>
      <BaseType>10</BaseType>
      <BatchNumbers>
        <BatchNumbers>
          <BatchNumber>sample string 1</BatchNumber>
          <Quantity>3</Quantity>
          <SystemSerialNumber>2</SystemSerialNumber>
        </BatchNumbers>
        <BatchNumbers>
          <BatchNumber>sample string 1</BatchNumber>
          <Quantity>3</Quantity>
          <SystemSerialNumber>2</SystemSerialNumber>
        </BatchNumbers>
      </BatchNumbers>
      <CostingCode>sample string 18</CostingCode>
      <CostingCode2>sample string 19</CostingCode2>
      <Currency>sample string 6</Currency>
      <DiscountPercent>5</DiscountPercent>
      <ItemCode>sample string 1</ItemCode>
      <ItemDescription>sample string 2</ItemDescription>
      <LineTotal>12</LineTotal>
      <LinesCurrenciesList>
        <LinesCurrencies>
          <Description>sample string 3</Description>
          <DocCurrency>sample string 2</DocCurrency>
          <Id>sample string 1</Id>
          <Price>4</Price>
        </LinesCurrencies>
        <LinesCurrencies>
          <Description>sample string 3</Description>
          <DocCurrency>sample string 2</DocCurrency>
          <Id>sample string 1</Id>
          <Price>4</Price>
        </LinesCurrencies>
      </LinesCurrenciesList>
      <ManBtchNum>sample string 16</ManBtchNum>
      <ManSerNum>sample string 17</ManSerNum>
      <Quantity>4</Quantity>
      <SerialNumbers>
        <SerialNumbers>
          <DistNumber>sample string 3</DistNumber>
          <Quantity>2</Quantity>
          <SystemSerialNumber>1</SystemSerialNumber>
        </SerialNumbers>
        <SerialNumbers>
          <DistNumber>sample string 3</DistNumber>
          <Quantity>2</Quantity>
          <SystemSerialNumber>1</SystemSerialNumber>
        </SerialNumbers>
      </SerialNumbers>
      <TaxCode>sample string 7</TaxCode>
      <TaxOnly>sample string 8</TaxOnly>
      <TaxRate>sample string 15</TaxRate>
      <TreeType>sample string 11</TreeType>
      <Udfs xmlns:d4p1="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.Udf">
        <d4p1:Udf>
          <d4p1:FieldType>sample string 2</d4p1:FieldType>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:Udf>
        <d4p1:Udf>
          <d4p1:FieldType>sample string 2</d4p1:FieldType>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:Udf>
      </Udfs>
      <UnitPrice>3</UnitPrice>
      <UoMEntry>13</UoMEntry>
      <UoMMasterData>
        <UoMMasterData>
          <UnitPrice>4</UnitPrice>
          <UnitPriceFC>5</UnitPriceFC>
          <UoMEntry>1</UoMEntry>
          <UomCode>sample string 2</UomCode>
          <UomName>sample string 3</UomName>
        </UoMMasterData>
        <UoMMasterData>
          <UnitPrice>4</UnitPrice>
          <UnitPriceFC>5</UnitPriceFC>
          <UoMEntry>1</UoMEntry>
          <UomCode>sample string 2</UomCode>
          <UomName>sample string 3</UomName>
        </UoMMasterData>
      </UoMMasterData>
      <WarehouseCode>sample string 9</WarehouseCode>
      <WhsName>sample string 14</WhsName>
    </ARCreditMemoRows>
    <ARCreditMemoRows>
      <BaseEntry>1</BaseEntry>
      <BaseLine>1</BaseLine>
      <BaseType>10</BaseType>
      <BatchNumbers>
        <BatchNumbers>
          <BatchNumber>sample string 1</BatchNumber>
          <Quantity>3</Quantity>
          <SystemSerialNumber>2</SystemSerialNumber>
        </BatchNumbers>
        <BatchNumbers>
          <BatchNumber>sample string 1</BatchNumber>
          <Quantity>3</Quantity>
          <SystemSerialNumber>2</SystemSerialNumber>
        </BatchNumbers>
      </BatchNumbers>
      <CostingCode>sample string 18</CostingCode>
      <CostingCode2>sample string 19</CostingCode2>
      <Currency>sample string 6</Currency>
      <DiscountPercent>5</DiscountPercent>
      <ItemCode>sample string 1</ItemCode>
      <ItemDescription>sample string 2</ItemDescription>
      <LineTotal>12</LineTotal>
      <LinesCurrenciesList>
        <LinesCurrencies>
          <Description>sample string 3</Description>
          <DocCurrency>sample string 2</DocCurrency>
          <Id>sample string 1</Id>
          <Price>4</Price>
        </LinesCurrencies>
        <LinesCurrencies>
          <Description>sample string 3</Description>
          <DocCurrency>sample string 2</DocCurrency>
          <Id>sample string 1</Id>
          <Price>4</Price>
        </LinesCurrencies>
      </LinesCurrenciesList>
      <ManBtchNum>sample string 16</ManBtchNum>
      <ManSerNum>sample string 17</ManSerNum>
      <Quantity>4</Quantity>
      <SerialNumbers>
        <SerialNumbers>
          <DistNumber>sample string 3</DistNumber>
          <Quantity>2</Quantity>
          <SystemSerialNumber>1</SystemSerialNumber>
        </SerialNumbers>
        <SerialNumbers>
          <DistNumber>sample string 3</DistNumber>
          <Quantity>2</Quantity>
          <SystemSerialNumber>1</SystemSerialNumber>
        </SerialNumbers>
      </SerialNumbers>
      <TaxCode>sample string 7</TaxCode>
      <TaxOnly>sample string 8</TaxOnly>
      <TaxRate>sample string 15</TaxRate>
      <TreeType>sample string 11</TreeType>
      <Udfs xmlns:d4p1="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.Udf">
        <d4p1:Udf>
          <d4p1:FieldType>sample string 2</d4p1:FieldType>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:Udf>
        <d4p1:Udf>
          <d4p1:FieldType>sample string 2</d4p1:FieldType>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:Udf>
      </Udfs>
      <UnitPrice>3</UnitPrice>
      <UoMEntry>13</UoMEntry>
      <UoMMasterData>
        <UoMMasterData>
          <UnitPrice>4</UnitPrice>
          <UnitPriceFC>5</UnitPriceFC>
          <UoMEntry>1</UoMEntry>
          <UomCode>sample string 2</UomCode>
          <UomName>sample string 3</UomName>
        </UoMMasterData>
        <UoMMasterData>
          <UnitPrice>4</UnitPrice>
          <UnitPriceFC>5</UnitPriceFC>
          <UoMEntry>1</UoMEntry>
          <UomCode>sample string 2</UomCode>
          <UomName>sample string 3</UomName>
        </UoMMasterData>
      </UoMMasterData>
      <WarehouseCode>sample string 9</WarehouseCode>
      <WhsName>sample string 14</WhsName>
    </ARCreditMemoRows>
  </DocumentLines>
  <DocumentReferences>
    <DocumentReferences>
      <RefDocEntr>1</RefDocEntr>
      <RefDocNum>2</RefDocNum>
      <RefObjType>sample string 3</RefObjType>
      <Remark>sample string 4</Remark>
    </DocumentReferences>
    <DocumentReferences>
      <RefDocEntr>1</RefDocEntr>
      <RefDocNum>2</RefDocNum>
      <RefObjType>sample string 3</RefObjType>
      <Remark>sample string 4</Remark>
    </DocumentReferences>
  </DocumentReferences>
  <IdTranAcumular>sample string 15</IdTranAcumular>
  <IdTranRedimir>sample string 14</IdTranRedimir>
  <NumAtCard>sample string 11</NumAtCard>
  <PaymentGroupCode>13</PaymentGroupCode>
  <PriceList>20</PriceList>
  <SalesPersonCode>10</SalesPersonCode>
  <Series>6</Series>
  <TaxDate>2025-09-14T15:45:29.1660343-06:00</TaxDate>
  <Udfs xmlns:d2p1="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.Udf">
    <d2p1:Udf>
      <d2p1:FieldType>sample string 2</d2p1:FieldType>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:Udf>
    <d2p1:Udf>
      <d2p1:FieldType>sample string 2</d2p1:FieldType>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:Udf>
  </Udfs>
  <WithTransactionTapp>true</WithTransactionTapp>
</ARCreditMemo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.