GET api/v1/Invoice/GetPaymentsByType?from={from}&to={to}&companyid={companyid}&paymethod={paymethod}

Home / API / ASP.NET Web API Details

GET api/v1/Invoice/GetPaymentsByType?from={from}&to={to}&companyid={companyid}&paymethod={paymethod}

Description

Get payments by date range

Request Information

Parameters

Name	Description	Additional information
from		Define this parameter in the request URI.
to		Define this parameter in the request URI.
companyid		Define this parameter in the request URI.
paymethod	** 2=credit (by default), Others values: 0=payment,1=discount,2=credit, 3=transfer to an existing account,4=tranfer to a new account	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "paymentid": 1,
    "type": "sample string 2",
    "accountid": 3,
    "accountnum": "sample string 4",
    "customer": "sample string 5",
    "invoiceid": 6,
    "invoicenum": "sample string 7",
    "batchid": 8,
    "datereceived": "sample string 9",
    "memo": "sample string 10",
    "lastchanged": "sample string 11",
    "amount": 12.0,
    "tax": 13.0
  },
  {
    "paymentid": 1,
    "type": "sample string 2",
    "accountid": 3,
    "accountnum": "sample string 4",
    "customer": "sample string 5",
    "invoiceid": 6,
    "invoicenum": "sample string 7",
    "batchid": 8,
    "datereceived": "sample string 9",
    "memo": "sample string 10",
    "lastchanged": "sample string 11",
    "amount": 12.0,
    "tax": 13.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfpaymentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <paymentsModel>
    <accountid>3</accountid>
    <accountnum>sample string 4</accountnum>
    <amount>12</amount>
    <batchid>8</batchid>
    <customer>sample string 5</customer>
    <datereceived>sample string 9</datereceived>
    <invoiceid>6</invoiceid>
    <invoicenum>sample string 7</invoicenum>
    <lastchanged>sample string 11</lastchanged>
    <memo>sample string 10</memo>
    <paymentid>1</paymentid>
    <tax>13</tax>
    <type>sample string 2</type>
  </paymentsModel>
  <paymentsModel>
    <accountid>3</accountid>
    <accountnum>sample string 4</accountnum>
    <amount>12</amount>
    <batchid>8</batchid>
    <customer>sample string 5</customer>
    <datereceived>sample string 9</datereceived>
    <invoiceid>6</invoiceid>
    <invoicenum>sample string 7</invoicenum>
    <lastchanged>sample string 11</lastchanged>
    <memo>sample string 10</memo>
    <paymentid>1</paymentid>
    <tax>13</tax>
    <type>sample string 2</type>
  </paymentsModel>
</ArrayOfpaymentsModel>