POST api/Documents/CreatePaymentRecived

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PPTransaction	PPTransaction	None.
isPayAccount	boolean	None.
DocEntry	integer	None.
DocNum	integer	None.
CardCode	string	None.
DocDate	string	None.
CashAccount	string	None.
CheckAccount	string	None.
CashSum	decimal number	None.
Remarks	string	None.
DocCurrency	string	None.
DocRate	decimal number	None.
CounterReference	string	None.
TransferSum	decimal number	None.
TransferAccount	string	None.
TransferDate	string	None.
TransferReference	string	None.
DocType	string	None.
Series	integer	None.
DueDate	string	None.
U_MontoRecibido	decimal number	None.
PaymentInvoices	Collection of PaymentLines	None.
PaymentChecks	Collection of Checks	None.
PaymentCreditCards	Collection of CreditCards	None.
UDFs	Collection of UdfTarget	None.
U_CLVS_POS_UniqueInvId	string	None.
AccountPayment	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "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-12-05T21:38:46.5289623-06:00",
    "LastUpDate": "2025-12-05T21:38:46.5289623-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-12-05T21:38:46.5289623-06:00"
    },
    "SaleAmount": 31.1,
    "UpdatesCounter": 32
  },
  "isPayAccount": true,
  "DocEntry": 2,
  "DocNum": 3,
  "CardCode": "sample string 4",
  "DocDate": "sample string 5",
  "CashAccount": "sample string 6",
  "CheckAccount": "sample string 7",
  "CashSum": 8.1,
  "Remarks": "sample string 9",
  "DocCurrency": "sample string 10",
  "DocRate": 11.0,
  "CounterReference": "sample string 12",
  "TransferSum": 13.0,
  "TransferAccount": "sample string 14",
  "TransferDate": "sample string 15",
  "TransferReference": "sample string 16",
  "DocType": "sample string 17",
  "Series": 18,
  "DueDate": "sample string 19",
  "U_MontoRecibido": 20.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 21",
  "AccountPayment": true
}

application/xml, text/xml

Sample:

<CreateSLRecivedPaymentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLVSPOS.MODELS">
  <AccountPayment>true</AccountPayment>
  <CardCode>sample string 4</CardCode>
  <CashAccount>sample string 6</CashAccount>
  <CashSum>8.1</CashSum>
  <CheckAccount>sample string 7</CheckAccount>
  <CounterReference>sample string 12</CounterReference>
  <DocCurrency>sample string 10</DocCurrency>
  <DocDate>sample string 5</DocDate>
  <DocEntry>2</DocEntry>
  <DocNum>3</DocNum>
  <DocRate>11</DocRate>
  <DocType>sample string 17</DocType>
  <DueDate>sample string 19</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 9</Remarks>
  <Series>18</Series>
  <TransferAccount>sample string 14</TransferAccount>
  <TransferDate>sample string 15</TransferDate>
  <TransferReference>sample string 16</TransferReference>
  <TransferSum>13</TransferSum>
  <UDFs xmlns:d2p1="http://schemas.datacontract.org/2004/07/CLVSSUPER.MODELS">
    <d2p1:UdfTarget>
      <d2p1:FieldType>sample string 2</d2p1:FieldType>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:UdfTarget>
    <d2p1:UdfTarget>
      <d2p1:FieldType>sample string 2</d2p1:FieldType>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:UdfTarget>
  </UDFs>
  <U_CLVS_POS_UniqueInvId>sample string 21</U_CLVS_POS_UniqueInvId>
  <U_MontoRecibido>20</U_MontoRecibido>
  <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-12-05T21:38:46.5289623-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-12-05T21:38:46.5289623-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-12-05T21:38:46.5289623-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>
  <isPayAccount>true</isPayAccount>
</CreateSLRecivedPaymentModel>

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.