POST api/Documents/CreateInvoice
Request Information
URI Parameters
None.
Body Parameters
CreateSlInvoiceName | Description | Type | Additional information |
---|---|---|---|
Invoice | IInvoiceDocument |
None. |
|
Payment | BasePayment |
None. |
|
PPTransaction | PPTransaction |
None. |
|
isItsCashCustomer | boolean |
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", "DocEntry": 6, "DocNum": 7, "BaseEntry": 1, "CardCode": "sample string 8", "CardName": "sample string 9", "DocType": "sample string 10", "DocDate": "2025-04-04T00:09:14.7979641-06:00", "DocDueDate": "sample string 12", "DocCurrency": "sample string 13", "NumAtCard": "sample string 14", "PaymentGroupCode": "sample string 15", "Comments": "sample string 16", "SalesPersonCode": 17, "U_TipoDocE": "sample string 18", "U_TipoIdentificacion": "sample string 19", "U_NumIdentFE": "sample string 20", "U_CorreoFE": "sample string 21", "U_ObservacionFE": "sample string 22", "U_Online": "sample string 23", "Series": 24, "U_CLVS_POS_UniqueInvId": "sample string 25", "DocumentLines": [ { "ItemName": "sample string 1", "WhsName": "sample string 2", "LastPurchasePrice": 3.1, "LineStatus": "sample string 4", "OnHand": 5.1, "InvntItem": "sample string 6", "UoM": [ { "UoMEntry": 1, "UomCode": "sample string 2", "UomName": "sample string 3", "Price": 4.0, "Currency": "sample string 5" }, { "UoMEntry": 1, "UomCode": "sample string 2", "UomName": "sample string 3", "Price": 4.0, "Currency": "sample string 5" } ], "LineNum": 1, "ItemCode": "sample string 7", "UnitPrice": 8.1, "Quantity": 9.1, "TaxCode": "sample string 10", "TaxRate": 11.1, "WarehouseCode": "sample string 12", "DiscountPercent": 13.1, "Serie": "sample string 14", "TaxOnly": "sample string 15", "BaseType": 1, "BaseEntry": 1, "BaseLine": 1, "CostingCode": "sample string 16", "UoMEntry": 17, "UdfLinesTarget": [ { "Name": "sample string 1", "FieldType": "sample string 2", "Value": "sample string 3" }, { "Name": "sample string 1", "FieldType": "sample string 2", "Value": "sample string 3" } ] }, { "ItemName": "sample string 1", "WhsName": "sample string 2", "LastPurchasePrice": 3.1, "LineStatus": "sample string 4", "OnHand": 5.1, "InvntItem": "sample string 6", "UoM": [ { "UoMEntry": 1, "UomCode": "sample string 2", "UomName": "sample string 3", "Price": 4.0, "Currency": "sample string 5" }, { "UoMEntry": 1, "UomCode": "sample string 2", "UomName": "sample string 3", "Price": 4.0, "Currency": "sample string 5" } ], "LineNum": 1, "ItemCode": "sample string 7", "UnitPrice": 8.1, "Quantity": 9.1, "TaxCode": "sample string 10", "TaxRate": 11.1, "WarehouseCode": "sample string 12", "DiscountPercent": 13.1, "Serie": "sample string 14", "TaxOnly": "sample string 15", "BaseType": 1, "BaseEntry": 1, "BaseLine": 1, "CostingCode": "sample string 16", "UoMEntry": 17, "UdfLinesTarget": [ { "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_Provincia": "sample string 26", "U_Canton": "sample string 27", "U_Distrito": "sample string 28", "U_Barrio": "sample string 29", "U_Direccion": "sample string 30", "U_ClaveFE": "sample string 31", "U_NumFE": "sample string 32", "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": 33 }, "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 } ], "PaymentChecks": [ { "AcctNum": "sample string 1", "BankCode": "sample string 2", "CheckAccount": "sample string 3", "CheckNumber": "sample string 4", "CheckSum": 5.0, "CountryCode": "sample string 6", "Curr": "sample string 7", "DueDate": "sample string 8" }, { "AcctNum": "sample string 1", "BankCode": "sample string 2", "CheckAccount": "sample string 3", "CheckNumber": "sample string 4", "CheckSum": 5.0, "CountryCode": "sample string 6", "Curr": "sample string 7", "DueDate": "sample string 8" } ], "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", "CreditAcct": "sample string 10" }, { "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", "CreditAcct": "sample string 10" } ], "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", "AccountPayment": true }, "PPTransaction": { "Id": 1, "DocEntry": 2, "DocNum": 3, "CardName": "sample string 4", "CardNumber": "sample string 5", "AuthorizationNumber": "sample string 6", "EntryMode": "sample string 7", "ExpirationDate": "sample string 8", "ReferenceNumber": "sample string 9", "TerminalId": 10, "ResponseCode": "sample string 11", "InvoiceNumber": "sample string 12", "InvoiceDocument": "sample string 13", "SystemTrace": "sample string 14", "TransactionId": "sample string 15", "CharchedStatus": "sample string 16", "ChargedResponse": "sample string 17", "CanceledStatus": "sample string 18", "CanceledResponse": "sample string 19", "ReversedStatus": "sample string 20", "ReversedResponse": "sample string 21", "Currency": "sample string 22", "BacId": "sample string 23", "UserPrefix": "sample string 24", "Amount": 25.1, "IsOnBalance": true, "CreationDate": "2025-04-04T00:09:14.7979641-06:00", "LastUpDate": "2025-04-04T00:09:14.7979641-06:00", "QuickPayAmount": 28.1, "AcqPrebalance": 29, "AcqBalance": 30, "ppDocument": { "Id": 1, "DocEntry": 2, "DocNum": 3, "UniqueInvoCode": "sample string 4", "BacId": "sample string 5", "Status": "sample string 6", "Document": "sample string 7", "DocumentType": "sample string 8", "CreationDocTime": "2025-04-04T00:09:14.7979641-06:00" }, "SaleAmount": 31.1, "UpdatesCounter": 32 }, "isItsCashCustomer": true }
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 8</CardCode> <CardName>sample string 9</CardName> <Comments>sample string 16</Comments> <DocCurrency>sample string 13</DocCurrency> <DocDate>2025-04-04T00:09:14.7979641-06:00</DocDate> <DocDueDate>sample string 12</DocDueDate> <DocEntry>6</DocEntry> <DocNum>7</DocNum> <DocType>sample string 10</DocType> <DocumentLines> <DocumentLines> <BaseEntry>1</BaseEntry> <BaseLine>1</BaseLine> <BaseType>1</BaseType> <CostingCode>sample string 16</CostingCode> <DiscountPercent>13.1</DiscountPercent> <ItemCode>sample string 7</ItemCode> <LineNum>1</LineNum> <Quantity>9.1</Quantity> <Serie>sample string 14</Serie> <TaxCode>sample string 10</TaxCode> <TaxOnly>sample string 15</TaxOnly> <TaxRate>11.1</TaxRate> <UdfLinesTarget xmlns:d5p1="http://schemas.datacontract.org/2004/07/CLVSSUPER.MODELS"> <d5p1:UdfTarget> <d5p1:FieldType>sample string 2</d5p1:FieldType> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:UdfTarget> <d5p1:UdfTarget> <d5p1:FieldType>sample string 2</d5p1:FieldType> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:UdfTarget> </UdfLinesTarget> <UnitPrice>8.1</UnitPrice> <UoMEntry>17</UoMEntry> <WarehouseCode>sample string 12</WarehouseCode> <InvntItem>sample string 6</InvntItem> <ItemName>sample string 1</ItemName> <LastPurchasePrice>3.1</LastPurchasePrice> <LineStatus>sample string 4</LineStatus> <OnHand>5.1</OnHand> <UoM> <UoM> <Currency>sample string 5</Currency> <Price>4</Price> <UoMEntry>1</UoMEntry> <UomCode>sample string 2</UomCode> <UomName>sample string 3</UomName> </UoM> <UoM> <Currency>sample string 5</Currency> <Price>4</Price> <UoMEntry>1</UoMEntry> <UomCode>sample string 2</UomCode> <UomName>sample string 3</UomName> </UoM> </UoM> <WhsName>sample string 2</WhsName> </DocumentLines> <DocumentLines> <BaseEntry>1</BaseEntry> <BaseLine>1</BaseLine> <BaseType>1</BaseType> <CostingCode>sample string 16</CostingCode> <DiscountPercent>13.1</DiscountPercent> <ItemCode>sample string 7</ItemCode> <LineNum>1</LineNum> <Quantity>9.1</Quantity> <Serie>sample string 14</Serie> <TaxCode>sample string 10</TaxCode> <TaxOnly>sample string 15</TaxOnly> <TaxRate>11.1</TaxRate> <UdfLinesTarget xmlns:d5p1="http://schemas.datacontract.org/2004/07/CLVSSUPER.MODELS"> <d5p1:UdfTarget> <d5p1:FieldType>sample string 2</d5p1:FieldType> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:UdfTarget> <d5p1:UdfTarget> <d5p1:FieldType>sample string 2</d5p1:FieldType> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:UdfTarget> </UdfLinesTarget> <UnitPrice>8.1</UnitPrice> <UoMEntry>17</UoMEntry> <WarehouseCode>sample string 12</WarehouseCode> <InvntItem>sample string 6</InvntItem> <ItemName>sample string 1</ItemName> <LastPurchasePrice>3.1</LastPurchasePrice> <LineStatus>sample string 4</LineStatus> <OnHand>5.1</OnHand> <UoM> <UoM> <Currency>sample string 5</Currency> <Price>4</Price> <UoMEntry>1</UoMEntry> <UomCode>sample string 2</UomCode> <UomName>sample string 3</UomName> </UoM> <UoM> <Currency>sample string 5</Currency> <Price>4</Price> <UoMEntry>1</UoMEntry> <UomCode>sample string 2</UomCode> <UomName>sample string 3</UomName> </UoM> </UoM> <WhsName>sample string 2</WhsName> </DocumentLines> </DocumentLines> <NumAtCard>sample string 14</NumAtCard> <PaymentGroupCode>sample string 15</PaymentGroupCode> <SalesPersonCode>17</SalesPersonCode> <Series>24</Series> <U_Barrio>sample string 29</U_Barrio> <U_CLVS_POS_UniqueInvId>sample string 25</U_CLVS_POS_UniqueInvId> <U_Canton>sample string 27</U_Canton> <U_ClaveFE>sample string 31</U_ClaveFE> <U_CorreoFE>sample string 21</U_CorreoFE> <U_Direccion>sample string 30</U_Direccion> <U_Distrito>sample string 28</U_Distrito> <U_ListNum>33</U_ListNum> <U_NumFE>sample string 32</U_NumFE> <U_NumIdentFE>sample string 20</U_NumIdentFE> <U_ObservacionFE>sample string 22</U_ObservacionFE> <U_Online>sample string 23</U_Online> <U_Provincia>sample string 26</U_Provincia> <U_TipoDocE>sample string 18</U_TipoDocE> <U_TipoIdentificacion>sample string 19</U_TipoIdentificacion> <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> </Invoice> <PPTransaction xmlns:d2p1="http://schemas.datacontract.org/2004/07/CLVSSUPER.MODELS"> <d2p1:AcqBalance>30</d2p1:AcqBalance> <d2p1:AcqPrebalance>29</d2p1:AcqPrebalance> <d2p1:Amount>25.1</d2p1:Amount> <d2p1:AuthorizationNumber>sample string 6</d2p1:AuthorizationNumber> <d2p1:BacId>sample string 23</d2p1:BacId> <d2p1:CanceledResponse>sample string 19</d2p1:CanceledResponse> <d2p1:CanceledStatus>sample string 18</d2p1:CanceledStatus> <d2p1:CardName>sample string 4</d2p1:CardName> <d2p1:CardNumber>sample string 5</d2p1:CardNumber> <d2p1:CharchedStatus>sample string 16</d2p1:CharchedStatus> <d2p1:ChargedResponse>sample string 17</d2p1:ChargedResponse> <d2p1:CreationDate>2025-04-04T00:09:14.7979641-06:00</d2p1:CreationDate> <d2p1:Currency>sample string 22</d2p1:Currency> <d2p1:DocEntry>2</d2p1:DocEntry> <d2p1:DocNum>3</d2p1:DocNum> <d2p1:EntryMode>sample string 7</d2p1:EntryMode> <d2p1:ExpirationDate>sample string 8</d2p1:ExpirationDate> <d2p1:Id>1</d2p1:Id> <d2p1:InvoiceDocument>sample string 13</d2p1:InvoiceDocument> <d2p1:InvoiceNumber>sample string 12</d2p1:InvoiceNumber> <d2p1:IsOnBalance>true</d2p1:IsOnBalance> <d2p1:LastUpDate>2025-04-04T00:09:14.7979641-06:00</d2p1:LastUpDate> <d2p1:QuickPayAmount>28.1</d2p1:QuickPayAmount> <d2p1:ReferenceNumber>sample string 9</d2p1:ReferenceNumber> <d2p1:ResponseCode>sample string 11</d2p1:ResponseCode> <d2p1:ReversedResponse>sample string 21</d2p1:ReversedResponse> <d2p1:ReversedStatus>sample string 20</d2p1:ReversedStatus> <d2p1:SaleAmount>31.1</d2p1:SaleAmount> <d2p1:SystemTrace>sample string 14</d2p1:SystemTrace> <d2p1:TerminalId>10</d2p1:TerminalId> <d2p1:TransactionId>sample string 15</d2p1:TransactionId> <d2p1:UpdatesCounter>32</d2p1:UpdatesCounter> <d2p1:UserPrefix>sample string 24</d2p1:UserPrefix> <d2p1:ppDocument> <BacId>sample string 5</BacId> <CreationDocTime>2025-04-04T00:09:14.7979641-06:00</CreationDocTime> <DocEntry>2</DocEntry> <DocNum>3</DocNum> <Document>sample string 7</Document> <DocumentType>sample string 8</DocumentType> <Id>1</Id> <Status>sample string 6</Status> <UniqueInvoCode>sample string 4</UniqueInvoCode> </d2p1:ppDocument> </PPTransaction> <Payment> <AccountPayment>true</AccountPayment> <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> <PaymentChecks> <Checks> <AcctNum>sample string 1</AcctNum> <BankCode>sample string 2</BankCode> <CheckAccount>sample string 3</CheckAccount> <CheckNumber>sample string 4</CheckNumber> <CheckSum>5</CheckSum> <CountryCode>sample string 6</CountryCode> <Curr>sample string 7</Curr> <DueDate>sample string 8</DueDate> </Checks> <Checks> <AcctNum>sample string 1</AcctNum> <BankCode>sample string 2</BankCode> <CheckAccount>sample string 3</CheckAccount> <CheckNumber>sample string 4</CheckNumber> <CheckSum>5</CheckSum> <CountryCode>sample string 6</CountryCode> <Curr>sample string 7</Curr> <DueDate>sample string 8</DueDate> </Checks> </PaymentChecks> <PaymentCreditCards> <CreditCards> <CardValid>sample string 1</CardValid> <CardValidUntil>sample string 3</CardValidUntil> <CreditAcct>sample string 10</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> <VoucherNum>sample string 8</VoucherNum> </CreditCards> <CreditCards> <CardValid>sample string 1</CardValid> <CardValidUntil>sample string 3</CardValidUntil> <CreditAcct>sample string 10</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> <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_MontoRecibido>19</U_MontoRecibido> </Payment> <isItsCashCustomer>true</isItsCashCustomer> </CreateSlInvoice>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | 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. |