POST api/Documents/CreateapInvoice?_isCredit={_isCredit}

Request Information

URI Parameters

Name	Description	Type	Additional information
_isCredit		boolean	Required

Body Parameters

CreateAPInvoiceSL

Name	Description	Type	Additional information
Invoice		SLInvoiceSuppliers	None.
Payment		CreatePaymentModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Invoice": {
    "DocEntry": 1,
    "DocNum": 2,
    "Series": 3,
    "PaymentGroupCode": "sample string 4",
    "CardCode": "sample string 5",
    "CardName": "sample string 6",
    "DocDate": "2025-04-07T06:28:06.6750127-06:00",
    "Comments": "sample string 8",
    "DocType": "sample string 9",
    "DocCurrency": "sample string 10",
    "SalesPersonCode": 11,
    "U_NumFE": "sample string 12",
    "U_ClaveFE": "sample string 13",
    "U_CLVS_POS_UniqueInvId": "sample string 14",
    "U_ListNum": 15,
    "DocumentLines": [
      {
        "ItemCode": "sample string 1",
        "Quantity": 2.1,
        "UnitPrice": 3.1,
        "DiscountPercent": 4.1,
        "TaxCode": "sample string 5",
        "WarehouseCode": "sample string 6",
        "UoMEntry": 7,
        "UomCode": "sample string 8",
        "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"
          }
        ]
      },
      {
        "ItemCode": "sample string 1",
        "Quantity": 2.1,
        "UnitPrice": 3.1,
        "DiscountPercent": 4.1,
        "TaxCode": "sample string 5",
        "WarehouseCode": "sample string 6",
        "UoMEntry": 7,
        "UomCode": "sample string 8",
        "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_TipoDocE": "sample string 16",
    "U_TipoIdentificacion": "sample string 17",
    "U_NumIdentFE": "sample string 18",
    "U_CorreoFE": "sample string 19",
    "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"
      }
    ]
  },
  "Payment": {
    "V_Checks": [
      {
        "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"
      }
    ],
    "V_CreditCards": [
      {
        "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"
      }
    ],
    "V_PaymentLines": [
      {
        "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
      }
    ],
    "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"
      }
    ],
    "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
  }
}

application/xml, text/xml

Sample:

<CreateAPInvoiceSL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLVSPOS.MODELS">
  <Invoice>
    <CardCode>sample string 5</CardCode>
    <CardName>sample string 6</CardName>
    <Comments>sample string 8</Comments>
    <DocCurrency>sample string 10</DocCurrency>
    <DocDate>2025-04-07T06:28:06.6750127-06:00</DocDate>
    <DocEntry>1</DocEntry>
    <DocNum>2</DocNum>
    <DocType>sample string 9</DocType>
    <DocumentLines>
      <SLInvoiceLinesSuppliers>
        <DiscountPercent>4.1</DiscountPercent>
        <ItemCode>sample string 1</ItemCode>
        <Quantity>2.1</Quantity>
        <TaxCode>sample string 5</TaxCode>
        <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>3.1</UnitPrice>
        <UoMEntry>7</UoMEntry>
        <UomCode>sample string 8</UomCode>
        <WarehouseCode>sample string 6</WarehouseCode>
      </SLInvoiceLinesSuppliers>
      <SLInvoiceLinesSuppliers>
        <DiscountPercent>4.1</DiscountPercent>
        <ItemCode>sample string 1</ItemCode>
        <Quantity>2.1</Quantity>
        <TaxCode>sample string 5</TaxCode>
        <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>3.1</UnitPrice>
        <UoMEntry>7</UoMEntry>
        <UomCode>sample string 8</UomCode>
        <WarehouseCode>sample string 6</WarehouseCode>
      </SLInvoiceLinesSuppliers>
    </DocumentLines>
    <PaymentGroupCode>sample string 4</PaymentGroupCode>
    <SalesPersonCode>11</SalesPersonCode>
    <Series>3</Series>
    <U_CLVS_POS_UniqueInvId>sample string 14</U_CLVS_POS_UniqueInvId>
    <U_ClaveFE>sample string 13</U_ClaveFE>
    <U_CorreoFE>sample string 19</U_CorreoFE>
    <U_ListNum>15</U_ListNum>
    <U_NumFE>sample string 12</U_NumFE>
    <U_NumIdentFE>sample string 18</U_NumIdentFE>
    <U_TipoDocE>sample string 16</U_TipoDocE>
    <U_TipoIdentificacion>sample string 17</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>
  </Invoice>
  <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>
    <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>
    <V_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>
      <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>
    </V_Checks>
    <V_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>
      <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>
    </V_CreditCards>
    <V_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>
      <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>
    </V_PaymentLines>
  </Payment>
</CreateAPInvoiceSL>

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.