POST api/invoices/nonRecurring

Post Non Recurring Invoice with Itemized Line Items and journal entries. Send request as form data with 2 keys: file (file to upload) and viewModelJsonFormControlName (json body).

Request Information

URI Parameters

Name	Type	Additional information
VendorInvoiceNumber	string	Required
Description	string	None.
Balance	decimal number	None.
GLDate	date	Required
VendorId	integer	None.
ResidentId	integer	None.
VendorInvoiceDate	date	None.
InvoiceAmount	decimal number	Required
Hold	boolean	None.
SeparateCheck	boolean	None.
DueDate	date	None.
BankCodeId	integer	Required Range: inclusive between 1 and 2147483647
SuperEntityId	integer	Required Range: inclusive between 1 and 2147483647
Status	InvoiceStatus	Required Range: inclusive between 0 and 2
InvoiceType	InvoiceType	Required Range: inclusive between 1 and 5
PaidDate	date	None.
HoldNote	string	None.
GeneralNote	string	None.
BoardApprovalStatus	integer	Required Range: inclusive between 0 and 4
DocumentIdentifier	string	None.
FileName	string	None.
TrackingGroup	string	None.
ACHPrintStatus	AchPrintStatusEnum	Required Range: inclusive between 6 and 10
AvidBatchId	integer	None.
AvidImageUrl	string	None.
PONumber	string	None.
PaymentMatchId	string	None.
SpecialHandlingId	InvoiceSpecialHandling	None.
ConfirmationNumber	string	Max length: 50
IsAvidImport	boolean	None.
LineItems	Collection of PostInvoiceItemizedLineViewModel	Required

Body Parameters

None.

Response Information

Resource Description

CreatedPayeeInvoiceResultViewModel

Name	Type	Additional information
InvoiceId	integer	None.
AutomaticCheck	CheckViewModel	None.
VendorInvoiceNumber	string	Required
Description	string	None.
Balance	decimal number	None.
GLDate	date	Required
VendorId	integer	None.
ResidentId	integer	None.
VendorInvoiceDate	date	None.
InvoiceAmount	decimal number	Required
Hold	boolean	None.
SeparateCheck	boolean	None.
DueDate	date	None.
BankCodeId	integer	Required Range: inclusive between 1 and 2147483647
SuperEntityId	integer	Required Range: inclusive between 1 and 2147483647
Status	InvoiceStatus	Required Range: inclusive between 0 and 2
InvoiceType	InvoiceType	Required Range: inclusive between 1 and 5
PaidDate	date	None.
HoldNote	string	None.
GeneralNote	string	None.
BoardApprovalStatus	integer	Required Range: inclusive between 0 and 4
DocumentIdentifier	string	None.
FileName	string	None.
TrackingGroup	string	None.
ACHPrintStatus	AchPrintStatusEnum	Required Range: inclusive between 6 and 10
AvidBatchId	integer	None.
AvidImageUrl	string	None.
PONumber	string	None.
PaymentMatchId	string	None.
SpecialHandlingId	InvoiceSpecialHandling	None.
ConfirmationNumber	string	Max length: 50
IsAvidImport	boolean	None.
LineItems	Collection of PostInvoiceItemizedLineViewModel	Required

Response Formats

application/json, text/json

Sample:

{
  "invoiceId": 1,
  "automaticCheck": {
    "id": 1,
    "vendor_VendorName": "sample string 2",
    "invoice_ACHPrintStatus": "sample string 3",
    "checkDate": "sample string 4",
    "amount": 5.0,
    "checkNumber": 6,
    "invoice_InvoiceType": "sample string 7",
    "status": 1,
    "statusName": "sample string 8",
    "voidDate": "sample string 9"
  },
  "vendorInvoiceNumber": "sample string 2",
  "description": "sample string 3",
  "balance": 4.0,
  "glDate": "2024-10-14T08:18:55.4086898-04:00",
  "vendorId": 1,
  "residentId": 1,
  "vendorInvoiceDate": "2024-10-14T08:18:55.4086898-04:00",
  "invoiceAmount": 6.0,
  "hold": true,
  "separateCheck": true,
  "dueDate": "2024-10-14T08:18:55.4086898-04:00",
  "bankCodeId": 9,
  "superEntityId": 10,
  "status": 0,
  "invoiceType": 1,
  "paidDate": "2024-10-14T08:18:55.4086898-04:00",
  "holdNote": "sample string 11",
  "generalNote": "sample string 12",
  "boardApprovalStatus": 13,
  "documentIdentifier": "sample string 14",
  "fileName": "sample string 15",
  "trackingGroup": "sample string 16",
  "achPrintStatus": 6,
  "avidBatchId": 1,
  "avidImageUrl": "sample string 17",
  "poNumber": "sample string 18",
  "paymentMatchId": "sample string 19",
  "specialHandlingId": 1,
  "confirmationNumber": "sample string 20",
  "isAvidImport": true,
  "lineItems": [
    {
      "itemDescription": "sample string 1",
      "itemAmount": 2.0,
      "glSubAccountId": 1,
      "is1099": true,
      "irs1099AmountClassId": 1,
      "chartOfAccountsId": 4,
      "glEntityId": 5,
      "utilityMeterId": 6,
      "utilityConsumption": 7.0,
      "utilityRate": 8.0,
      "fundId": 1
    },
    {
      "itemDescription": "sample string 1",
      "itemAmount": 2.0,
      "glSubAccountId": 1,
      "is1099": true,
      "irs1099AmountClassId": 1,
      "chartOfAccountsId": 4,
      "glEntityId": 5,
      "utilityMeterId": 6,
      "utilityConsumption": 7.0,
      "utilityRate": 8.0,
      "fundId": 1
    }
  ]
}

application/xml, text/xml

Sample:

<CreatedPayeeInvoiceResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Invoices">
  <ACHPrintStatus>AchPrint</ACHPrintStatus>
  <AvidBatchId>1</AvidBatchId>
  <AvidImageUrl>sample string 17</AvidImageUrl>
  <Balance>4</Balance>
  <BankCodeId>9</BankCodeId>
  <BoardApprovalStatus>13</BoardApprovalStatus>
  <ConfirmationNumber>sample string 20</ConfirmationNumber>
  <Description>sample string 3</Description>
  <DocumentIdentifier>sample string 14</DocumentIdentifier>
  <DueDate>2024-10-14T08:18:55.4086898-04:00</DueDate>
  <FileName>sample string 15</FileName>
  <GLDate>2024-10-14T08:18:55.4086898-04:00</GLDate>
  <GeneralNote>sample string 12</GeneralNote>
  <Hold>true</Hold>
  <HoldNote>sample string 11</HoldNote>
  <InvoiceAmount>6</InvoiceAmount>
  <InvoiceType>Regular</InvoiceType>
  <IsAvidImport>true</IsAvidImport>
  <LineItems>
    <PostInvoiceItemizedLineViewModel>
      <ChartOfAccountsId>4</ChartOfAccountsId>
      <FundId>1</FundId>
      <GlEntityId>5</GlEntityId>
      <GlSubAccountId>1</GlSubAccountId>
      <Irs1099AmountClassId>1</Irs1099AmountClassId>
      <Is1099>true</Is1099>
      <ItemAmount>2</ItemAmount>
      <ItemDescription>sample string 1</ItemDescription>
      <UtilityConsumption>7</UtilityConsumption>
      <UtilityMeterId>6</UtilityMeterId>
      <UtilityRate>8</UtilityRate>
    </PostInvoiceItemizedLineViewModel>
    <PostInvoiceItemizedLineViewModel>
      <ChartOfAccountsId>4</ChartOfAccountsId>
      <FundId>1</FundId>
      <GlEntityId>5</GlEntityId>
      <GlSubAccountId>1</GlSubAccountId>
      <Irs1099AmountClassId>1</Irs1099AmountClassId>
      <Is1099>true</Is1099>
      <ItemAmount>2</ItemAmount>
      <ItemDescription>sample string 1</ItemDescription>
      <UtilityConsumption>7</UtilityConsumption>
      <UtilityMeterId>6</UtilityMeterId>
      <UtilityRate>8</UtilityRate>
    </PostInvoiceItemizedLineViewModel>
  </LineItems>
  <PONumber>sample string 18</PONumber>
  <PaidDate>2024-10-14T08:18:55.4086898-04:00</PaidDate>
  <PaymentMatchId>sample string 19</PaymentMatchId>
  <ResidentId>1</ResidentId>
  <SeparateCheck>true</SeparateCheck>
  <SpecialHandlingId>APPAY</SpecialHandlingId>
  <Status>Open</Status>
  <SuperEntityId>10</SuperEntityId>
  <TrackingGroup>sample string 16</TrackingGroup>
  <VendorId>1</VendorId>
  <VendorInvoiceDate>2024-10-14T08:18:55.4086898-04:00</VendorInvoiceDate>
  <VendorInvoiceNumber>sample string 2</VendorInvoiceNumber>
  <AutomaticCheck xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
    <d2p1:Amount>5</d2p1:Amount>
    <d2p1:CheckDate>sample string 4</d2p1:CheckDate>
    <d2p1:CheckNumber>6</d2p1:CheckNumber>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Invoice_ACHPrintStatus>sample string 3</d2p1:Invoice_ACHPrintStatus>
    <d2p1:Invoice_InvoiceType>sample string 7</d2p1:Invoice_InvoiceType>
    <d2p1:Status>Created</d2p1:Status>
    <d2p1:StatusName>sample string 8</d2p1:StatusName>
    <d2p1:Vendor_VendorName>sample string 2</d2p1:Vendor_VendorName>
    <d2p1:VoidDate>sample string 9</d2p1:VoidDate>
  </AutomaticCheck>
  <InvoiceId>1</InvoiceId>
</CreatedPayeeInvoiceResultViewModel>