POST api/Invoices
Request Information
URI Parameters
None.
Body Parameters
ARInvoice| Name | Description | Type | Additional information |
|---|---|---|---|
| DocEntry | integer |
None. |
|
| DocNum | integer |
None. |
|
| CardCode | string |
None. |
|
| CardName | string |
None. |
|
| DocDate | date |
None. |
|
| Comments | string |
None. |
|
| SalesPersonCode | integer |
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. |
|
| Udfs | Collection of Udf |
None. |
|
| InvoiceNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"DocEntry": 1,
"DocNum": 2,
"CardCode": "sample string 3",
"CardName": "sample string 4",
"DocDate": "2025-12-07T07:59:10.901823-06:00",
"Comments": "sample string 6",
"SalesPersonCode": 7,
"DocTotal": 8.0,
"PaymentGroupCode": 9,
"PriceList": 10,
"Series": 11,
"DocCurrency": "sample string 12",
"DocRate": 13.0,
"ReserveInvoice": "sample string 14",
"IdTranRedimir": "sample string 15",
"IdTranAcumular": "sample string 16",
"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,
"BaseEntry": 1,
"BaseLine": 1,
"WarehouseCode": "sample string 10",
"DiscountPercent": 11.0,
"CostingCode": "sample string 12",
"UoMEntry": 13,
"ManBtchNum": "sample string 14",
"ManSerNum": "sample string 15",
"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"
}
]
},
{
"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,
"BaseEntry": 1,
"BaseLine": 1,
"WarehouseCode": "sample string 10",
"DiscountPercent": 11.0,
"CostingCode": "sample string 12",
"UoMEntry": 13,
"ManBtchNum": "sample string 14",
"ManSerNum": "sample string 15",
"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"
}
]
}
],
"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 17"
}
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>
<Comments>sample string 6</Comments>
<DocCurrency>sample string 12</DocCurrency>
<DocDate>2025-12-07T07:59:10.901823-06:00</DocDate>
<DocEntry>1</DocEntry>
<DocNum>2</DocNum>
<DocRate>13</DocRate>
<DocTotal>8</DocTotal>
<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 12</CostingCode>
<DiscountPercent>11</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>
<ItemCode>sample string 2</ItemCode>
<ItemDescription>sample string 3</ItemDescription>
<LineNum>1</LineNum>
<ManBtchNum>sample string 14</ManBtchNum>
<ManSerNum>sample string 15</ManSerNum>
<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>
<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>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 10</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 12</CostingCode>
<DiscountPercent>11</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>
<ItemCode>sample string 2</ItemCode>
<ItemDescription>sample string 3</ItemDescription>
<LineNum>1</LineNum>
<ManBtchNum>sample string 14</ManBtchNum>
<ManSerNum>sample string 15</ManSerNum>
<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>
<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>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 10</WarehouseCode>
</ARInvoiceRows>
</DocumentLines>
<IdTranAcumular>sample string 16</IdTranAcumular>
<IdTranRedimir>sample string 15</IdTranRedimir>
<InvoiceNumber>sample string 17</InvoiceNumber>
<PaymentGroupCode>9</PaymentGroupCode>
<PriceList>10</PriceList>
<ReserveInvoice>sample string 14</ReserveInvoice>
<SalesPersonCode>7</SalesPersonCode>
<Series>11</Series>
<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>
</ARInvoice>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |