POST api/Invoices

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DocEntry	integer	None.
DocNum	integer	None.
CardCode	string	None.
CardName	string	None.
DocDate	date	None.
DocDueDate	date	None.
TaxDate	date	None.
Comments	string	None.
SalesPersonCode	integer	None.
SalesPersonName	string	None.
DocTotal	decimal number	None.
PaymentGroupCode	integer	None.
PriceList	integer	None.
Series	integer	None.
DocCurrency	string	None.
DocRate	decimal number	None.
ReserveInvoice	string	None.
IdTranRedimir	string	None.
IdTranAcumular	string	None.
DocumentLines	Collection of ARInvoiceRows	None.
DocStatus	string	None.
Udfs	Collection of Udf	None.
InvoiceNumber	string	None.
NumFE	string	None.
ClaveFE	string	None.
DownPaymentsToDraw	Collection of DownPaymentsToDraw	None.
TipoDocE	string	None.
IdType	string	None.
Identification	string	None.
Email	string	None.
DocumentKey	string	None.
WithTransactionTapp	boolean	None.
DocTotalFC	decimal number	None.
ConfirmationEntry	integer	None.
DocObjectCode	string	None.
DocumentReferences	Collection of DocumentReferences	None.

Request Formats

application/json, text/json

Sample:

{
  "DocEntry": 1,
  "DocNum": 2,
  "CardCode": "sample string 3",
  "CardName": "sample string 4",
  "DocDate": "2025-10-27T08:32:36.6727272-06:00",
  "DocDueDate": "2025-10-27T08:32:36.6727272-06:00",
  "TaxDate": "2025-10-27T08:32:36.6727272-06:00",
  "Comments": "sample string 8",
  "SalesPersonCode": 9,
  "SalesPersonName": "sample string 10",
  "DocTotal": 11.0,
  "PaymentGroupCode": 12,
  "PriceList": 13,
  "Series": 14,
  "DocCurrency": "sample string 15",
  "DocRate": 16.0,
  "ReserveInvoice": "sample string 17",
  "IdTranRedimir": "sample string 18",
  "IdTranAcumular": "sample string 19",
  "DocumentLines": [
    {
      "LineNum": 1,
      "ItemCode": "sample string 2",
      "ItemDescription": "sample string 3",
      "UnitPrice": 4.0,
      "Quantity": 5.0,
      "TaxCode": "sample string 6",
      "TaxRate": "sample string 7",
      "TaxOnly": "sample string 8",
      "BaseType": 9,
      "Currency": "sample string 10",
      "BaseEntry": 1,
      "BaseLine": 1,
      "WarehouseCode": "sample string 11",
      "DiscountPercent": 12.0,
      "CostingCode": "sample string 13",
      "CostingCode2": "sample string 14",
      "UoMEntry": 15,
      "ManBtchNum": "sample string 16",
      "ManSerNum": "sample string 17",
      "TreeType": "sample string 18",
      "FatherCode": "sample string 19",
      "DocumentLinesBinAllocations": [
        {
          "SerialAndBatchNumbersBaseLine": 1,
          "BinAbsEntry": 2,
          "Quantity": 3.0
        },
        {
          "SerialAndBatchNumbersBaseLine": 1,
          "BinAbsEntry": 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
        }
      ],
      "BatchNumbers": [
        {
          "BatchNumber": "sample string 1",
          "SystemSerialNumber": 2,
          "Quantity": 3.0
        },
        {
          "BatchNumber": "sample string 1",
          "SystemSerialNumber": 2,
          "Quantity": 3.0
        }
      ],
      "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"
        }
      ],
      "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
        }
      ],
      "OnHand": 20.1,
      "LineTotal": 21.0,
      "InventoryItem": "sample string 22"
    },
    {
      "LineNum": 1,
      "ItemCode": "sample string 2",
      "ItemDescription": "sample string 3",
      "UnitPrice": 4.0,
      "Quantity": 5.0,
      "TaxCode": "sample string 6",
      "TaxRate": "sample string 7",
      "TaxOnly": "sample string 8",
      "BaseType": 9,
      "Currency": "sample string 10",
      "BaseEntry": 1,
      "BaseLine": 1,
      "WarehouseCode": "sample string 11",
      "DiscountPercent": 12.0,
      "CostingCode": "sample string 13",
      "CostingCode2": "sample string 14",
      "UoMEntry": 15,
      "ManBtchNum": "sample string 16",
      "ManSerNum": "sample string 17",
      "TreeType": "sample string 18",
      "FatherCode": "sample string 19",
      "DocumentLinesBinAllocations": [
        {
          "SerialAndBatchNumbersBaseLine": 1,
          "BinAbsEntry": 2,
          "Quantity": 3.0
        },
        {
          "SerialAndBatchNumbersBaseLine": 1,
          "BinAbsEntry": 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
        }
      ],
      "BatchNumbers": [
        {
          "BatchNumber": "sample string 1",
          "SystemSerialNumber": 2,
          "Quantity": 3.0
        },
        {
          "BatchNumber": "sample string 1",
          "SystemSerialNumber": 2,
          "Quantity": 3.0
        }
      ],
      "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"
        }
      ],
      "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
        }
      ],
      "OnHand": 20.1,
      "LineTotal": 21.0,
      "InventoryItem": "sample string 22"
    }
  ],
  "DocStatus": "sample string 20",
  "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"
    }
  ],
  "InvoiceNumber": "sample string 21",
  "NumFE": "sample string 22",
  "ClaveFE": "sample string 23",
  "DownPaymentsToDraw": [
    {
      "AmountToDrawFC": 1.0,
      "AmountToDraw": 2.0,
      "DocEntry": 3,
      "DownPaymentType": "sample string 4"
    },
    {
      "AmountToDrawFC": 1.0,
      "AmountToDraw": 2.0,
      "DocEntry": 3,
      "DownPaymentType": "sample string 4"
    }
  ],
  "TipoDocE": "sample string 24",
  "IdType": "sample string 25",
  "Identification": "sample string 26",
  "Email": "sample string 27",
  "DocumentKey": "sample string 28",
  "WithTransactionTapp": true,
  "DocTotalFC": 30.0,
  "ConfirmationEntry": 31,
  "DocObjectCode": "sample string 32",
  "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"
    }
  ]
}

application/xml, text/xml

Sample:

<ARInvoice 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>
  <ClaveFE>sample string 23</ClaveFE>
  <Comments>sample string 8</Comments>
  <ConfirmationEntry>31</ConfirmationEntry>
  <DocCurrency>sample string 15</DocCurrency>
  <DocDate>2025-10-27T08:32:36.6727272-06:00</DocDate>
  <DocDueDate>2025-10-27T08:32:36.6727272-06:00</DocDueDate>
  <DocEntry>1</DocEntry>
  <DocNum>2</DocNum>
  <DocObjectCode>sample string 32</DocObjectCode>
  <DocRate>16</DocRate>
  <DocStatus>sample string 20</DocStatus>
  <DocTotal>11</DocTotal>
  <DocTotalFC>30</DocTotalFC>
  <DocumentKey>sample string 28</DocumentKey>
  <DocumentLines>
    <ARInvoiceRows>
      <BaseEntry>1</BaseEntry>
      <BaseLine>1</BaseLine>
      <BaseType>9</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 13</CostingCode>
      <CostingCode2>sample string 14</CostingCode2>
      <Currency>sample string 10</Currency>
      <DiscountPercent>12</DiscountPercent>
      <DocumentLinesBinAllocations>
        <DocumentLinesBinAllocations>
          <BinAbsEntry>2</BinAbsEntry>
          <Quantity>3</Quantity>
          <SerialAndBatchNumbersBaseLine>1</SerialAndBatchNumbersBaseLine>
        </DocumentLinesBinAllocations>
        <DocumentLinesBinAllocations>
          <BinAbsEntry>2</BinAbsEntry>
          <Quantity>3</Quantity>
          <SerialAndBatchNumbersBaseLine>1</SerialAndBatchNumbersBaseLine>
        </DocumentLinesBinAllocations>
      </DocumentLinesBinAllocations>
      <FatherCode>sample string 19</FatherCode>
      <InventoryItem>sample string 22</InventoryItem>
      <ItemCode>sample string 2</ItemCode>
      <ItemDescription>sample string 3</ItemDescription>
      <LineNum>1</LineNum>
      <LineTotal>21</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>
      <OnHand>20.1</OnHand>
      <Quantity>5</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 6</TaxCode>
      <TaxOnly>sample string 8</TaxOnly>
      <TaxRate>sample string 7</TaxRate>
      <TreeType>sample string 18</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>4</UnitPrice>
      <UoMEntry>15</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 11</WarehouseCode>
    </ARInvoiceRows>
    <ARInvoiceRows>
      <BaseEntry>1</BaseEntry>
      <BaseLine>1</BaseLine>
      <BaseType>9</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 13</CostingCode>
      <CostingCode2>sample string 14</CostingCode2>
      <Currency>sample string 10</Currency>
      <DiscountPercent>12</DiscountPercent>
      <DocumentLinesBinAllocations>
        <DocumentLinesBinAllocations>
          <BinAbsEntry>2</BinAbsEntry>
          <Quantity>3</Quantity>
          <SerialAndBatchNumbersBaseLine>1</SerialAndBatchNumbersBaseLine>
        </DocumentLinesBinAllocations>
        <DocumentLinesBinAllocations>
          <BinAbsEntry>2</BinAbsEntry>
          <Quantity>3</Quantity>
          <SerialAndBatchNumbersBaseLine>1</SerialAndBatchNumbersBaseLine>
        </DocumentLinesBinAllocations>
      </DocumentLinesBinAllocations>
      <FatherCode>sample string 19</FatherCode>
      <InventoryItem>sample string 22</InventoryItem>
      <ItemCode>sample string 2</ItemCode>
      <ItemDescription>sample string 3</ItemDescription>
      <LineNum>1</LineNum>
      <LineTotal>21</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>
      <OnHand>20.1</OnHand>
      <Quantity>5</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 6</TaxCode>
      <TaxOnly>sample string 8</TaxOnly>
      <TaxRate>sample string 7</TaxRate>
      <TreeType>sample string 18</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>4</UnitPrice>
      <UoMEntry>15</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 11</WarehouseCode>
    </ARInvoiceRows>
  </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>
  <DownPaymentsToDraw>
    <DownPaymentsToDraw>
      <AmountToDraw>2</AmountToDraw>
      <AmountToDrawFC>1</AmountToDrawFC>
      <DocEntry>3</DocEntry>
      <DownPaymentType>sample string 4</DownPaymentType>
    </DownPaymentsToDraw>
    <DownPaymentsToDraw>
      <AmountToDraw>2</AmountToDraw>
      <AmountToDrawFC>1</AmountToDrawFC>
      <DocEntry>3</DocEntry>
      <DownPaymentType>sample string 4</DownPaymentType>
    </DownPaymentsToDraw>
  </DownPaymentsToDraw>
  <Email>sample string 27</Email>
  <IdTranAcumular>sample string 19</IdTranAcumular>
  <IdTranRedimir>sample string 18</IdTranRedimir>
  <IdType>sample string 25</IdType>
  <Identification>sample string 26</Identification>
  <InvoiceNumber>sample string 21</InvoiceNumber>
  <NumFE>sample string 22</NumFE>
  <PaymentGroupCode>12</PaymentGroupCode>
  <PriceList>13</PriceList>
  <ReserveInvoice>sample string 17</ReserveInvoice>
  <SalesPersonCode>9</SalesPersonCode>
  <SalesPersonName>sample string 10</SalesPersonName>
  <Series>14</Series>
  <TaxDate>2025-10-27T08:32:36.6727272-06:00</TaxDate>
  <TipoDocE>sample string 24</TipoDocE>
  <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>
</ARInvoice>

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.