GET api/invoices/entity/{entityId}/payments?bankCodeId={bankCodeId}&checkDate={checkDate}

load the avaliable invoices for payments

Request Information

URI Parameters

Name	Type	Additional information
entityId	integer	Required
bankCodeId	integer	Required
checkDate	date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of InvoicePaymentViewModel

Name	Type	Additional information
PayeeId	integer	None.
InvoiceNumber	string	None.
InvoiceType	string	None.
InvoiceAmount	decimal number	None.
Description	string	None.
DueDate	date	None.
PaymentStatus	string	None.
PayeeNameLineOne	string	None.
PayeeNameLineTwo	string	None.
IsPendingPayment	boolean	None.
InvoiceId	integer	Required Range: inclusive between 1 and 1.79769313486232E+308
IsSeparateCheck	boolean	None.
PaymentType	integer	Required Range: inclusive between 6 and 10
PaymentAmount	decimal number	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "payeeId": 1,
    "invoiceNumber": "sample string 2",
    "invoiceType": "sample string 3",
    "invoiceAmount": 4.0,
    "description": "sample string 5",
    "dueDate": "2024-10-14T08:21:09.7267501-04:00",
    "paymentStatus": "sample string 6",
    "payeeNameLineOne": "sample string 7",
    "payeeNameLineTwo": "sample string 8",
    "isPendingPayment": true,
    "invoiceId": 10,
    "isSeparateCheck": true,
    "paymentType": 12,
    "paymentAmount": 13.0
  },
  {
    "payeeId": 1,
    "invoiceNumber": "sample string 2",
    "invoiceType": "sample string 3",
    "invoiceAmount": 4.0,
    "description": "sample string 5",
    "dueDate": "2024-10-14T08:21:09.7267501-04:00",
    "paymentStatus": "sample string 6",
    "payeeNameLineOne": "sample string 7",
    "payeeNameLineTwo": "sample string 8",
    "isPendingPayment": true,
    "invoiceId": 10,
    "isSeparateCheck": true,
    "paymentType": 12,
    "paymentAmount": 13.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfInvoicePaymentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Invoices">
  <InvoicePaymentViewModel>
    <InvoiceId>10</InvoiceId>
    <IsSeparateCheck>true</IsSeparateCheck>
    <PaymentAmount>13</PaymentAmount>
    <PaymentType>12</PaymentType>
    <Description>sample string 5</Description>
    <DueDate>2024-10-14T08:21:09.7267501-04:00</DueDate>
    <InvoiceAmount>4</InvoiceAmount>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <InvoiceType>sample string 3</InvoiceType>
    <IsPendingPayment>true</IsPendingPayment>
    <PayeeId>1</PayeeId>
    <PayeeNameLineOne>sample string 7</PayeeNameLineOne>
    <PayeeNameLineTwo>sample string 8</PayeeNameLineTwo>
    <PaymentStatus>sample string 6</PaymentStatus>
  </InvoicePaymentViewModel>
  <InvoicePaymentViewModel>
    <InvoiceId>10</InvoiceId>
    <IsSeparateCheck>true</IsSeparateCheck>
    <PaymentAmount>13</PaymentAmount>
    <PaymentType>12</PaymentType>
    <Description>sample string 5</Description>
    <DueDate>2024-10-14T08:21:09.7267501-04:00</DueDate>
    <InvoiceAmount>4</InvoiceAmount>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <InvoiceType>sample string 3</InvoiceType>
    <IsPendingPayment>true</IsPendingPayment>
    <PayeeId>1</PayeeId>
    <PayeeNameLineOne>sample string 7</PayeeNameLineOne>
    <PayeeNameLineTwo>sample string 8</PayeeNameLineTwo>
    <PaymentStatus>sample string 6</PaymentStatus>
  </InvoicePaymentViewModel>
</ArrayOfInvoicePaymentViewModel>