POST api/Documents/CreateInvoice

Request Information

URI Parameters

None.

Body Parameters

CreateSlInvoice
NameDescriptionTypeAdditional information
Invoice

IInvoiceDocument

None.

Payment

BasePayment

None.

Transactions

Collection of PPTransaction

None.

Request Formats

application/json, text/json

Sample:
{
  "Invoice": {
    "DocStatus": "sample string 1",
    "UserId": "sample string 2",
    "DocTotal": 3.0,
    "DocTotalFC": 4.0,
    "SalesMan": "sample string 5",
    "withTransactionTapp": true,
    "DocEntry": 7,
    "DocNum": 8,
    "BaseEntry": 1,
    "CardCode": "sample string 9",
    "CardName": "sample string 10",
    "DocType": "sample string 11",
    "DocDate": "2026-04-03T19:05:04.8498838-06:00",
    "DocDueDate": "2026-04-03T19:05:04.8498838-06:00",
    "DocCurrency": "sample string 14",
    "NumAtCard": "sample string 15",
    "PaymentGroupCode": "sample string 16",
    "Comments": "sample string 17",
    "SalesPersonCode": 18,
    "U_TipoDocE": "sample string 19",
    "U_TipoIdentificacion": "sample string 20",
    "U_NumIdentFE": "sample string 21",
    "U_CorreoFE": "sample string 22",
    "U_ObservacionFE": "sample string 23",
    "U_Online": "sample string 24",
    "Series": 25,
    "U_CLVS_POS_UniqueInvId": "sample string 26",
    "U_withTransactionTapp": 27,
    "DocumentLines": [
      {
        "ItemName": "sample string 1",
        "WhsName": "sample string 2",
        "LastPurchasePrice": 3.1,
        "LineStatus": "sample string 4",
        "OnHand": 5.1,
        "InvntItem": "sample string 6",
        "Supplier": "sample string 7",
        "Requestable": true,
        "LineTotal": 9.0,
        "U_TipoDescuento": "sample string 10",
        "U_TipoTransaccion": "sample string 11",
        "U_DescuentoOtros": "sample string 12",
        "LineNum": 1,
        "ItemCode": "sample string 13",
        "UnitPrice": 14.1,
        "Quantity": 15.1,
        "TaxCode": "sample string 16",
        "TaxRate": 17.1,
        "WarehouseCode": "sample string 18",
        "DiscountPercent": 19.1,
        "Serie": "sample string 20",
        "TaxOnly": "sample string 21",
        "BaseType": 1,
        "BaseEntry": 1,
        "BaseLine": 1,
        "U_Doctor": "sample string 22"
      },
      {
        "ItemName": "sample string 1",
        "WhsName": "sample string 2",
        "LastPurchasePrice": 3.1,
        "LineStatus": "sample string 4",
        "OnHand": 5.1,
        "InvntItem": "sample string 6",
        "Supplier": "sample string 7",
        "Requestable": true,
        "LineTotal": 9.0,
        "U_TipoDescuento": "sample string 10",
        "U_TipoTransaccion": "sample string 11",
        "U_DescuentoOtros": "sample string 12",
        "LineNum": 1,
        "ItemCode": "sample string 13",
        "UnitPrice": 14.1,
        "Quantity": 15.1,
        "TaxCode": "sample string 16",
        "TaxRate": 17.1,
        "WarehouseCode": "sample string 18",
        "DiscountPercent": 19.1,
        "Serie": "sample string 20",
        "TaxOnly": "sample string 21",
        "BaseType": 1,
        "BaseEntry": 1,
        "BaseLine": 1,
        "U_Doctor": "sample string 22"
      }
    ],
    "U_Provincia": "sample string 28",
    "U_Canton": "sample string 29",
    "U_Distrito": "sample string 30",
    "U_Barrio": "sample string 31",
    "U_Direccion": "sample string 32",
    "U_ClaveFE": "sample string 33",
    "U_NumFE": "sample string 34",
    "UdfTarget": [
      {
        "Name": "sample string 1",
        "FieldType": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "Name": "sample string 1",
        "FieldType": "sample string 2",
        "Value": "sample string 3"
      }
    ],
    "U_ListNum": 35,
    "U_Nombre_Caja": "sample string 36",
    "U_EMA_TAPP_IDENTIFICATION": "sample string 37"
  },
  "Payment": {
    "DocEntry": 1,
    "DocNum": 2,
    "CardCode": "sample string 3",
    "DocDate": "sample string 4",
    "CashAccount": "sample string 5",
    "CheckAccount": "sample string 6",
    "CashSum": 7.1,
    "Remarks": "sample string 8",
    "DocCurrency": "sample string 9",
    "DocRate": 10.0,
    "CounterReference": "sample string 11",
    "TransferSum": 12.0,
    "TransferAccount": "sample string 13",
    "TransferDate": "sample string 14",
    "TransferReference": "sample string 15",
    "DocType": "sample string 16",
    "Series": 17,
    "DueDate": "sample string 18",
    "U_MontoRecibido": 19.0,
    "PaymentInvoices": [
      {
        "DocEntry": 1,
        "InvoiceType": "sample string 2",
        "AppliedFC": 3.1,
        "SumApplied": 4.1,
        "Currency": "sample string 5",
        "PayTotal": "sample string 6",
        "Change": 7.0
      },
      {
        "DocEntry": 1,
        "InvoiceType": "sample string 2",
        "AppliedFC": 3.1,
        "SumApplied": 4.1,
        "Currency": "sample string 5",
        "PayTotal": "sample string 6",
        "Change": 7.0
      }
    ],
    "PaymentCreditCards": [
      {
        "CardValid": "sample string 1",
        "CreditCardNumber": "sample string 2",
        "CardValidUntil": "sample string 3",
        "CreditCard": "sample string 4",
        "CreditSum": 5.0,
        "FormatCode": "sample string 6",
        "OwnerIdNum": "sample string 7",
        "VoucherNum": "sample string 8",
        "U_ManualEntry": "sample string 9",
        "U_NumTarjeta": "sample string 10",
        "CreditAcct": "sample string 11"
      },
      {
        "CardValid": "sample string 1",
        "CreditCardNumber": "sample string 2",
        "CardValidUntil": "sample string 3",
        "CreditCard": "sample string 4",
        "CreditSum": 5.0,
        "FormatCode": "sample string 6",
        "OwnerIdNum": "sample string 7",
        "VoucherNum": "sample string 8",
        "U_ManualEntry": "sample string 9",
        "U_NumTarjeta": "sample string 10",
        "CreditAcct": "sample string 11"
      }
    ],
    "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"
      }
    ],
    "U_CLVS_POS_UniqueInvId": "sample string 20",
    "U_Nombre_Caja": "sample string 21",
    "U_MedioPago": "sample string 22"
  },
  "Transactions": [
    {
      "Id": 1,
      "DocEntry": 2,
      "InvoiceNumber": "sample string 3",
      "DocumentKey": "sample string 4",
      "User": "sample string 5",
      "TerminalId": "sample string 6",
      "CreationDate": "2026-04-03T19:05:04.8498838-06:00",
      "SerializedTransaction": "sample string 8",
      "TransactionId": "sample string 9"
    },
    {
      "Id": 1,
      "DocEntry": 2,
      "InvoiceNumber": "sample string 3",
      "DocumentKey": "sample string 4",
      "User": "sample string 5",
      "TerminalId": "sample string 6",
      "CreationDate": "2026-04-03T19:05:04.8498838-06:00",
      "SerializedTransaction": "sample string 8",
      "TransactionId": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:
<CreateSlInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLVSPOS.MODELS">
  <Invoice>
    <BaseEntry>1</BaseEntry>
    <CardCode>sample string 9</CardCode>
    <CardName>sample string 10</CardName>
    <Comments>sample string 17</Comments>
    <DocCurrency>sample string 14</DocCurrency>
    <DocDate>2026-04-03T19:05:04.8498838-06:00</DocDate>
    <DocDueDate>2026-04-03T19:05:04.8498838-06:00</DocDueDate>
    <DocEntry>7</DocEntry>
    <DocNum>8</DocNum>
    <DocType>sample string 11</DocType>
    <DocumentLines>
      <DocumentLines>
        <BaseEntry>1</BaseEntry>
        <BaseLine>1</BaseLine>
        <BaseType>1</BaseType>
        <DiscountPercent>19.1</DiscountPercent>
        <ItemCode>sample string 13</ItemCode>
        <LineNum>1</LineNum>
        <Quantity>15.1</Quantity>
        <Serie>sample string 20</Serie>
        <TaxCode>sample string 16</TaxCode>
        <TaxOnly>sample string 21</TaxOnly>
        <TaxRate>17.1</TaxRate>
        <U_Doctor>sample string 22</U_Doctor>
        <UnitPrice>14.1</UnitPrice>
        <WarehouseCode>sample string 18</WarehouseCode>
        <InvntItem>sample string 6</InvntItem>
        <ItemName>sample string 1</ItemName>
        <LastPurchasePrice>3.1</LastPurchasePrice>
        <LineStatus>sample string 4</LineStatus>
        <LineTotal>9</LineTotal>
        <OnHand>5.1</OnHand>
        <Requestable>true</Requestable>
        <Supplier>sample string 7</Supplier>
        <U_DescuentoOtros>sample string 12</U_DescuentoOtros>
        <U_TipoDescuento>sample string 10</U_TipoDescuento>
        <U_TipoTransaccion>sample string 11</U_TipoTransaccion>
        <WhsName>sample string 2</WhsName>
      </DocumentLines>
      <DocumentLines>
        <BaseEntry>1</BaseEntry>
        <BaseLine>1</BaseLine>
        <BaseType>1</BaseType>
        <DiscountPercent>19.1</DiscountPercent>
        <ItemCode>sample string 13</ItemCode>
        <LineNum>1</LineNum>
        <Quantity>15.1</Quantity>
        <Serie>sample string 20</Serie>
        <TaxCode>sample string 16</TaxCode>
        <TaxOnly>sample string 21</TaxOnly>
        <TaxRate>17.1</TaxRate>
        <U_Doctor>sample string 22</U_Doctor>
        <UnitPrice>14.1</UnitPrice>
        <WarehouseCode>sample string 18</WarehouseCode>
        <InvntItem>sample string 6</InvntItem>
        <ItemName>sample string 1</ItemName>
        <LastPurchasePrice>3.1</LastPurchasePrice>
        <LineStatus>sample string 4</LineStatus>
        <LineTotal>9</LineTotal>
        <OnHand>5.1</OnHand>
        <Requestable>true</Requestable>
        <Supplier>sample string 7</Supplier>
        <U_DescuentoOtros>sample string 12</U_DescuentoOtros>
        <U_TipoDescuento>sample string 10</U_TipoDescuento>
        <U_TipoTransaccion>sample string 11</U_TipoTransaccion>
        <WhsName>sample string 2</WhsName>
      </DocumentLines>
    </DocumentLines>
    <NumAtCard>sample string 15</NumAtCard>
    <PaymentGroupCode>sample string 16</PaymentGroupCode>
    <SalesPersonCode>18</SalesPersonCode>
    <Series>25</Series>
    <U_Barrio>sample string 31</U_Barrio>
    <U_CLVS_POS_UniqueInvId>sample string 26</U_CLVS_POS_UniqueInvId>
    <U_Canton>sample string 29</U_Canton>
    <U_ClaveFE>sample string 33</U_ClaveFE>
    <U_CorreoFE>sample string 22</U_CorreoFE>
    <U_Direccion>sample string 32</U_Direccion>
    <U_Distrito>sample string 30</U_Distrito>
    <U_EMA_TAPP_IDENTIFICATION>sample string 37</U_EMA_TAPP_IDENTIFICATION>
    <U_ListNum>35</U_ListNum>
    <U_Nombre_Caja>sample string 36</U_Nombre_Caja>
    <U_NumFE>sample string 34</U_NumFE>
    <U_NumIdentFE>sample string 21</U_NumIdentFE>
    <U_ObservacionFE>sample string 23</U_ObservacionFE>
    <U_Online>sample string 24</U_Online>
    <U_Provincia>sample string 28</U_Provincia>
    <U_TipoDocE>sample string 19</U_TipoDocE>
    <U_TipoIdentificacion>sample string 20</U_TipoIdentificacion>
    <U_withTransactionTapp>27</U_withTransactionTapp>
    <UdfTarget xmlns:d3p1="http://schemas.datacontract.org/2004/07/CLVSSUPER.MODELS">
      <d3p1:UdfTarget>
        <d3p1:FieldType>sample string 2</d3p1:FieldType>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:UdfTarget>
      <d3p1:UdfTarget>
        <d3p1:FieldType>sample string 2</d3p1:FieldType>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:UdfTarget>
    </UdfTarget>
    <DocStatus>sample string 1</DocStatus>
    <DocTotal>3</DocTotal>
    <DocTotalFC>4</DocTotalFC>
    <SalesMan>sample string 5</SalesMan>
    <UserId>sample string 2</UserId>
    <withTransactionTapp>true</withTransactionTapp>
  </Invoice>
  <Payment>
    <CardCode>sample string 3</CardCode>
    <CashAccount>sample string 5</CashAccount>
    <CashSum>7.1</CashSum>
    <CheckAccount>sample string 6</CheckAccount>
    <CounterReference>sample string 11</CounterReference>
    <DocCurrency>sample string 9</DocCurrency>
    <DocDate>sample string 4</DocDate>
    <DocEntry>1</DocEntry>
    <DocNum>2</DocNum>
    <DocRate>10</DocRate>
    <DocType>sample string 16</DocType>
    <DueDate>sample string 18</DueDate>
    <PaymentCreditCards>
      <CreditCards>
        <CardValid>sample string 1</CardValid>
        <CardValidUntil>sample string 3</CardValidUntil>
        <CreditAcct>sample string 11</CreditAcct>
        <CreditCard>sample string 4</CreditCard>
        <CreditCardNumber>sample string 2</CreditCardNumber>
        <CreditSum>5</CreditSum>
        <FormatCode>sample string 6</FormatCode>
        <OwnerIdNum>sample string 7</OwnerIdNum>
        <U_ManualEntry>sample string 9</U_ManualEntry>
        <U_NumTarjeta>sample string 10</U_NumTarjeta>
        <VoucherNum>sample string 8</VoucherNum>
      </CreditCards>
      <CreditCards>
        <CardValid>sample string 1</CardValid>
        <CardValidUntil>sample string 3</CardValidUntil>
        <CreditAcct>sample string 11</CreditAcct>
        <CreditCard>sample string 4</CreditCard>
        <CreditCardNumber>sample string 2</CreditCardNumber>
        <CreditSum>5</CreditSum>
        <FormatCode>sample string 6</FormatCode>
        <OwnerIdNum>sample string 7</OwnerIdNum>
        <U_ManualEntry>sample string 9</U_ManualEntry>
        <U_NumTarjeta>sample string 10</U_NumTarjeta>
        <VoucherNum>sample string 8</VoucherNum>
      </CreditCards>
    </PaymentCreditCards>
    <PaymentInvoices>
      <PaymentLines>
        <AppliedFC>3.1</AppliedFC>
        <Change>7</Change>
        <Currency>sample string 5</Currency>
        <DocEntry>1</DocEntry>
        <InvoiceType>sample string 2</InvoiceType>
        <PayTotal>sample string 6</PayTotal>
        <SumApplied>4.1</SumApplied>
      </PaymentLines>
      <PaymentLines>
        <AppliedFC>3.1</AppliedFC>
        <Change>7</Change>
        <Currency>sample string 5</Currency>
        <DocEntry>1</DocEntry>
        <InvoiceType>sample string 2</InvoiceType>
        <PayTotal>sample string 6</PayTotal>
        <SumApplied>4.1</SumApplied>
      </PaymentLines>
    </PaymentInvoices>
    <Remarks>sample string 8</Remarks>
    <Series>17</Series>
    <TransferAccount>sample string 13</TransferAccount>
    <TransferDate>sample string 14</TransferDate>
    <TransferReference>sample string 15</TransferReference>
    <TransferSum>12</TransferSum>
    <UDFs xmlns:d3p1="http://schemas.datacontract.org/2004/07/CLVSSUPER.MODELS">
      <d3p1:UdfTarget>
        <d3p1:FieldType>sample string 2</d3p1:FieldType>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:UdfTarget>
      <d3p1:UdfTarget>
        <d3p1:FieldType>sample string 2</d3p1:FieldType>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:UdfTarget>
    </UDFs>
    <U_CLVS_POS_UniqueInvId>sample string 20</U_CLVS_POS_UniqueInvId>
    <U_MedioPago>sample string 22</U_MedioPago>
    <U_MontoRecibido>19</U_MontoRecibido>
    <U_Nombre_Caja>sample string 21</U_Nombre_Caja>
  </Payment>
  <Transactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/CLVSSUPER.MODELS">
    <d2p1:PPTransaction>
      <d2p1:CreationDate>2026-04-03T19:05:04.8498838-06:00</d2p1:CreationDate>
      <d2p1:DocEntry>2</d2p1:DocEntry>
      <d2p1:DocumentKey>sample string 4</d2p1:DocumentKey>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InvoiceNumber>sample string 3</d2p1:InvoiceNumber>
      <d2p1:SerializedTransaction>sample string 8</d2p1:SerializedTransaction>
      <d2p1:TerminalId>sample string 6</d2p1:TerminalId>
      <d2p1:TransactionId>sample string 9</d2p1:TransactionId>
      <d2p1:User>sample string 5</d2p1:User>
    </d2p1:PPTransaction>
    <d2p1:PPTransaction>
      <d2p1:CreationDate>2026-04-03T19:05:04.8498838-06:00</d2p1:CreationDate>
      <d2p1:DocEntry>2</d2p1:DocEntry>
      <d2p1:DocumentKey>sample string 4</d2p1:DocumentKey>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InvoiceNumber>sample string 3</d2p1:InvoiceNumber>
      <d2p1:SerializedTransaction>sample string 8</d2p1:SerializedTransaction>
      <d2p1:TerminalId>sample string 6</d2p1:TerminalId>
      <d2p1:TransactionId>sample string 9</d2p1:TransactionId>
      <d2p1:User>sample string 5</d2p1:User>
    </d2p1:PPTransaction>
  </Transactions>
</CreateSlInvoice>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

None.