POST api/IncomingPayments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DocEntry	integer	None.
DocNum	integer	None.
CardCode	string	None.
CardName	string	None.
DocType	string	None.
Series	integer	None.
Remarks	string	None.
DocDate	date	None.
DocCurrency	string	None.
DocRate	decimal number	None.
CashAccount	string	None.
CashSum	decimal number	None.
TransferAccount	string	None.
TransferSum	decimal number	None.
TransferDate	date	None.
TransferReference	string	None.
PaymentInvoices	Collection of PaymentInvoices	None.
PaymentCreditCards	Collection of PaymentCreditCards	None.
PPTransactions	Collection of PPTransaction	None.
Udfs	Collection of Udf	None.

Request Formats

application/json, text/json

Sample:

{
  "DocEntry": 1,
  "DocNum": 2,
  "CardCode": "sample string 3",
  "CardName": "sample string 4",
  "DocType": "sample string 5",
  "Series": 6,
  "Remarks": "sample string 7",
  "DocDate": "2025-04-03T20:38:32.6388114-06:00",
  "DocCurrency": "sample string 9",
  "DocRate": 10.0,
  "CashAccount": "sample string 11",
  "CashSum": 12.0,
  "TransferAccount": "sample string 13",
  "TransferSum": 14.0,
  "TransferDate": "2025-04-03T20:38:32.6388114-06:00",
  "TransferReference": "sample string 15",
  "PaymentInvoices": [
    {
      "DocEntry": 1,
      "SumApplied": 2.0,
      "AppliedFC": 3.0,
      "InvoiceType": "sample string 4"
    },
    {
      "DocEntry": 1,
      "SumApplied": 2.0,
      "AppliedFC": 3.0,
      "InvoiceType": "sample string 4"
    }
  ],
  "PaymentCreditCards": [
    {
      "CreditCard": 1,
      "CreditAcct": "sample string 2",
      "CreditCardNumber": "sample string 3",
      "CardValidUntil": "2025-04-03T20:38:32.6388114-06:00",
      "VoucherNum": "sample string 5",
      "CreditSum": 6.0,
      "U_ManualEntry": "sample string 7"
    },
    {
      "CreditCard": 1,
      "CreditAcct": "sample string 2",
      "CreditCardNumber": "sample string 3",
      "CardValidUntil": "2025-04-03T20:38:32.6388114-06:00",
      "VoucherNum": "sample string 5",
      "CreditSum": 6.0,
      "U_ManualEntry": "sample string 7"
    }
  ],
  "PPTransactions": [
    {
      "DocEntry": 1,
      "InvoiceNumber": "sample string 2",
      "DocumentKey": "sample string 3",
      "TerminalId": "sample string 4",
      "SerializedTransaction": "sample string 5",
      "TransactionId": "sample string 6",
      "CompanyId": 7,
      "Company": {
        "ConnectionId": 1,
        "Connection": {
          "Name": "sample string 1",
          "Odbctype": "sample string 2",
          "Server": "sample string 3",
          "User": "sample string 4",
          "Pass": "sample string 5",
          "ServerType": "sample string 6",
          "SLUrl": "sample string 7",
          "Id": 8,
          "CreatedDate": "2025-04-03T20:38:32.6388114-06:00",
          "CreatedBy": "sample string 10",
          "UpdateDate": "2025-04-03T20:38:32.6388114-06:00",
          "UpdatedBy": "sample string 11",
          "IsActive": true
        },
        "Name": "sample string 2",
        "DatabaseCode": "sample string 3",
        "Id": 4,
        "CreatedDate": "2025-04-03T20:38:32.6388114-06:00",
        "CreatedBy": "sample string 6",
        "UpdateDate": "2025-04-03T20:38:32.6388114-06:00",
        "UpdatedBy": "sample string 7",
        "IsActive": true
      },
      "Id": 8,
      "CreatedDate": "2025-04-03T20:38:32.6388114-06:00",
      "CreatedBy": "sample string 10",
      "UpdateDate": "2025-04-03T20:38:32.6388114-06:00",
      "UpdatedBy": "sample string 11",
      "IsActive": true
    },
    {
      "DocEntry": 1,
      "InvoiceNumber": "sample string 2",
      "DocumentKey": "sample string 3",
      "TerminalId": "sample string 4",
      "SerializedTransaction": "sample string 5",
      "TransactionId": "sample string 6",
      "CompanyId": 7,
      "Company": {
        "ConnectionId": 1,
        "Connection": {
          "Name": "sample string 1",
          "Odbctype": "sample string 2",
          "Server": "sample string 3",
          "User": "sample string 4",
          "Pass": "sample string 5",
          "ServerType": "sample string 6",
          "SLUrl": "sample string 7",
          "Id": 8,
          "CreatedDate": "2025-04-03T20:38:32.6388114-06:00",
          "CreatedBy": "sample string 10",
          "UpdateDate": "2025-04-03T20:38:32.6388114-06:00",
          "UpdatedBy": "sample string 11",
          "IsActive": true
        },
        "Name": "sample string 2",
        "DatabaseCode": "sample string 3",
        "Id": 4,
        "CreatedDate": "2025-04-03T20:38:32.6388114-06:00",
        "CreatedBy": "sample string 6",
        "UpdateDate": "2025-04-03T20:38:32.6388114-06:00",
        "UpdatedBy": "sample string 7",
        "IsActive": true
      },
      "Id": 8,
      "CreatedDate": "2025-04-03T20:38:32.6388114-06:00",
      "CreatedBy": "sample string 10",
      "UpdateDate": "2025-04-03T20:38:32.6388114-06:00",
      "UpdatedBy": "sample string 11",
      "IsActive": true
    }
  ],
  "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"
    }
  ]
}

application/xml, text/xml

Sample:

<IncomingPayment 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>
  <CashAccount>sample string 11</CashAccount>
  <CashSum>12</CashSum>
  <DocCurrency>sample string 9</DocCurrency>
  <DocDate>2025-04-03T20:38:32.6388114-06:00</DocDate>
  <DocEntry>1</DocEntry>
  <DocNum>2</DocNum>
  <DocRate>10</DocRate>
  <DocType>sample string 5</DocType>
  <PPTransactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/CLMLTEMA.MODELS">
    <d2p1:PPTransaction>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 10</CreatedBy>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">8</Id>
      <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
      <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</UpdateDate>
      <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 11</UpdatedBy>
      <d2p1:Company>
        <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 6</CreatedBy>
        <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</CreatedDate>
        <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">4</Id>
        <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
        <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</UpdateDate>
        <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 7</UpdatedBy>
        <DatabaseCode xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</DatabaseCode>
        <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Name>
        <d2p1:Connection>
          <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 10</CreatedBy>
          <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</CreatedDate>
          <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">8</Id>
          <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
          <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</UpdateDate>
          <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 11</UpdatedBy>
          <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 1</Name>
          <Odbctype xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Odbctype>
          <Pass xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 5</Pass>
          <SLUrl xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 7</SLUrl>
          <Server xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</Server>
          <ServerType xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 6</ServerType>
          <User xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 4</User>
        </d2p1:Connection>
        <d2p1:ConnectionId>1</d2p1:ConnectionId>
      </d2p1:Company>
      <d2p1:CompanyId>7</d2p1:CompanyId>
      <d2p1:DocEntry>1</d2p1:DocEntry>
      <d2p1:DocumentKey>sample string 3</d2p1:DocumentKey>
      <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
      <d2p1:SerializedTransaction>sample string 5</d2p1:SerializedTransaction>
      <d2p1:TerminalId>sample string 4</d2p1:TerminalId>
      <d2p1:TransactionId>sample string 6</d2p1:TransactionId>
    </d2p1:PPTransaction>
    <d2p1:PPTransaction>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 10</CreatedBy>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">8</Id>
      <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
      <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</UpdateDate>
      <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 11</UpdatedBy>
      <d2p1:Company>
        <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 6</CreatedBy>
        <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</CreatedDate>
        <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">4</Id>
        <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
        <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</UpdateDate>
        <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 7</UpdatedBy>
        <DatabaseCode xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</DatabaseCode>
        <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Name>
        <d2p1:Connection>
          <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 10</CreatedBy>
          <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</CreatedDate>
          <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">8</Id>
          <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
          <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:38:32.6388114-06:00</UpdateDate>
          <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 11</UpdatedBy>
          <Name xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 1</Name>
          <Odbctype xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 2</Odbctype>
          <Pass xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 5</Pass>
          <SLUrl xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 7</SLUrl>
          <Server xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 3</Server>
          <ServerType xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 6</ServerType>
          <User xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.LocalEntities">sample string 4</User>
        </d2p1:Connection>
        <d2p1:ConnectionId>1</d2p1:ConnectionId>
      </d2p1:Company>
      <d2p1:CompanyId>7</d2p1:CompanyId>
      <d2p1:DocEntry>1</d2p1:DocEntry>
      <d2p1:DocumentKey>sample string 3</d2p1:DocumentKey>
      <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
      <d2p1:SerializedTransaction>sample string 5</d2p1:SerializedTransaction>
      <d2p1:TerminalId>sample string 4</d2p1:TerminalId>
      <d2p1:TransactionId>sample string 6</d2p1:TransactionId>
    </d2p1:PPTransaction>
  </PPTransactions>
  <PaymentCreditCards>
    <PaymentCreditCards>
      <CardValidUntil>2025-04-03T20:38:32.6388114-06:00</CardValidUntil>
      <CreditAcct>sample string 2</CreditAcct>
      <CreditCard>1</CreditCard>
      <CreditCardNumber>sample string 3</CreditCardNumber>
      <CreditSum>6</CreditSum>
      <U_ManualEntry>sample string 7</U_ManualEntry>
      <VoucherNum>sample string 5</VoucherNum>
    </PaymentCreditCards>
    <PaymentCreditCards>
      <CardValidUntil>2025-04-03T20:38:32.6388114-06:00</CardValidUntil>
      <CreditAcct>sample string 2</CreditAcct>
      <CreditCard>1</CreditCard>
      <CreditCardNumber>sample string 3</CreditCardNumber>
      <CreditSum>6</CreditSum>
      <U_ManualEntry>sample string 7</U_ManualEntry>
      <VoucherNum>sample string 5</VoucherNum>
    </PaymentCreditCards>
  </PaymentCreditCards>
  <PaymentInvoices>
    <PaymentInvoices>
      <AppliedFC>3</AppliedFC>
      <DocEntry>1</DocEntry>
      <InvoiceType>sample string 4</InvoiceType>
      <SumApplied>2</SumApplied>
    </PaymentInvoices>
    <PaymentInvoices>
      <AppliedFC>3</AppliedFC>
      <DocEntry>1</DocEntry>
      <InvoiceType>sample string 4</InvoiceType>
      <SumApplied>2</SumApplied>
    </PaymentInvoices>
  </PaymentInvoices>
  <Remarks>sample string 7</Remarks>
  <Series>6</Series>
  <TransferAccount>sample string 13</TransferAccount>
  <TransferDate>2025-04-03T20:38:32.6388114-06:00</TransferDate>
  <TransferReference>sample string 15</TransferReference>
  <TransferSum>14</TransferSum>
  <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>
</IncomingPayment>

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.