POST api/v2/invoice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceID	integer	None.
ClientID	integer	None.
InvoiceNumber	string	None.
APBasis	AccountingBasis	None.
ActualNumberOfApprovals	integer	None.
Amount	decimal number	None.
PONumber	string	None.
AcctTermID	integer	None.
AcctTerm	string	None.
PaymentTypeID	PaymentTypes	None.
ManualCheckNumber	integer	None.
ManualPaymentDate	date	None.
CombinePayments	boolean	None.
PaymentGLAccountID	integer	None.
VendorNotes	string	None.
InvoiceDate	date	None.
DueDate	date	None.
Received	boolean	None.
ReceivedDate	date	None.
Validated	boolean	None.
ValidatedDate	date	None.
OnHold	boolean	None.
OnHoldDate	date	None.
APApproved	boolean	None.
APApprovedDate	date	None.
MgrApproved	boolean	None.
MgrApprovedDate	date	None.
BoardApproved	boolean	None.
BoardApprovedDate	date	None.
ReadyToPay	boolean	None.
ReadyToPayDate	date	None.
Rejected	boolean	None.
RejectedDate	date	None.
RejectedBy	integer	None.
RejectedByName	string	None.
RejectedReason	string	None.
APPosted	boolean	None.
PostingDate	date	None.
Voided	boolean	None.
VoidDate	date	None.
VoidGLTransactionID	integer	None.
ChangeInvoiceID	integer	None.
Refund	boolean	None.
Recurring	boolean	None.
UsePrevAmounts	boolean	None.
RecInvCategoryID	integer	None.
SchFrequency	integer	None.
SchStartDate	date	None.
SchEndDate	date	None.
RecurringDescription	string	None.
PaymentCCID	integer	None.
InvoiceStatus	integer	None.
AmountPaid	decimal number	None.
RemainingBalance	decimal number	None.
RequiredNumberOfApprovers	integer	None.
IsDeleted	boolean	None.
DateCreated	date	None.
LastModified	date	None.
APAccountID	integer	None.
PayeeID	integer	None.
PayeeType	PayeeTypes	None.
PayeeName	string	None.
Note	string	None.
LineItems	Collection of InvoiceLineItem	None.
Links	Collection of Link	None.

Request Formats

application/json, text/json

Sample:

{
  "InvoiceID": 1,
  "ClientID": 1,
  "InvoiceNumber": "sample string 2",
  "APBasis": 0,
  "ActualNumberOfApprovals": 3,
  "Amount": 4.0,
  "PONumber": "sample string 5",
  "AcctTermID": 1,
  "AcctTerm": "sample string 6",
  "PaymentTypeID": 0,
  "ManualCheckNumber": 1,
  "ManualPaymentDate": "2025-05-20T00:00:00-07:00",
  "CombinePayments": true,
  "PaymentGLAccountID": 7,
  "VendorNotes": "sample string 8",
  "InvoiceDate": "2025-05-20T00:00:00-07:00",
  "DueDate": "2025-05-20T10:07:09.4044268-07:00",
  "Received": true,
  "ReceivedDate": "2025-05-20T10:07:09.4044268-07:00",
  "Validated": true,
  "ValidatedDate": "2025-05-20T10:07:09.4044268-07:00",
  "OnHold": true,
  "OnHoldDate": "2025-05-20T10:07:09.4044268-07:00",
  "APApproved": true,
  "APApprovedDate": "2025-05-20T10:07:09.4044268-07:00",
  "MgrApproved": true,
  "MgrApprovedDate": "2025-05-20T10:07:09.4044268-07:00",
  "BoardApproved": true,
  "BoardApprovedDate": "2025-05-20T10:07:09.4044268-07:00",
  "ReadyToPay": true,
  "ReadyToPayDate": "2025-05-20T10:07:09.4044268-07:00",
  "Rejected": true,
  "RejectedDate": "2025-05-20T10:07:09.4044268-07:00",
  "RejectedBy": 1,
  "RejectedByName": "sample string 10",
  "RejectedReason": "sample string 11",
  "APPosted": true,
  "PostingDate": "2025-05-20T00:00:00-07:00",
  "Voided": true,
  "VoidDate": "2025-05-20T10:07:09.4044268-07:00",
  "VoidGLTransactionID": 1,
  "ChangeInvoiceID": 1,
  "Refund": true,
  "Recurring": true,
  "UsePrevAmounts": true,
  "RecInvCategoryID": 1,
  "SchFrequency": 1,
  "SchStartDate": "2025-05-20T10:07:09.4044268-07:00",
  "SchEndDate": "2025-05-20T10:07:09.4044268-07:00",
  "RecurringDescription": "sample string 12",
  "PaymentCCID": 1,
  "InvoiceStatus": 1,
  "AmountPaid": 1.0,
  "RemainingBalance": 1.0,
  "RequiredNumberOfApprovers": 13,
  "IsDeleted": true,
  "DateCreated": "2025-05-20T10:07:09.4044268-07:00",
  "LastModified": "2025-05-20T10:07:09.4044268-07:00",
  "APAccountID": 1,
  "PayeeID": 14,
  "PayeeType": 10,
  "PayeeName": "sample string 15",
  "Note": "sample string 16",
  "LineItems": [
    {
      "LineItemID": 1,
      "InvoiceID": 1,
      "VendorCode": 1,
      "CostCenterID": 1,
      "ExpenseGLAccountID": 1,
      "Amount": 2.0,
      "Description": "sample string 3",
      "Quantity": 1.0,
      "UnitOfMeasure": "sample string 4",
      "UnitPrice": 1.0,
      "Is1099Item": true,
      "Adjustment": 1.0,
      "PostingDate": "2025-05-20T10:07:09.4044268-07:00",
      "GLTransactionID": 1,
      "WorkOrderNumber": "sample string 6",
      "VendorCredit": true,
      "RecNextAmount": 1.0,
      "ManualVendorCredit": true,
      "LongDescription": "sample string 7",
      "AmountApplied": 1.0,
      "PaymentAmount": 1.0,
      "RemainingBalance": 1.0
    },
    {
      "LineItemID": 1,
      "InvoiceID": 1,
      "VendorCode": 1,
      "CostCenterID": 1,
      "ExpenseGLAccountID": 1,
      "Amount": 2.0,
      "Description": "sample string 3",
      "Quantity": 1.0,
      "UnitOfMeasure": "sample string 4",
      "UnitPrice": 1.0,
      "Is1099Item": true,
      "Adjustment": 1.0,
      "PostingDate": "2025-05-20T10:07:09.4044268-07:00",
      "GLTransactionID": 1,
      "WorkOrderNumber": "sample string 6",
      "VendorCredit": true,
      "RecNextAmount": 1.0,
      "ManualVendorCredit": true,
      "LongDescription": "sample string 7",
      "AmountApplied": 1.0,
      "PaymentAmount": 1.0,
      "RemainingBalance": 1.0
    }
  ],
  "Links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<Invoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaliberAPI">
  <APAccountID>1</APAccountID>
  <APApproved>true</APApproved>
  <APApprovedDate>2025-05-20T10:07:09.4044268-07:00</APApprovedDate>
  <APBasis>Cash</APBasis>
  <APPosted>true</APPosted>
  <AcctTerm>sample string 6</AcctTerm>
  <AcctTermID>1</AcctTermID>
  <ActualNumberOfApprovals>3</ActualNumberOfApprovals>
  <Amount>4</Amount>
  <AmountPaid>1</AmountPaid>
  <BoardApproved>true</BoardApproved>
  <BoardApprovedDate>2025-05-20T10:07:09.4044268-07:00</BoardApprovedDate>
  <ChangeInvoiceID>1</ChangeInvoiceID>
  <ClientID>1</ClientID>
  <CombinePayments>true</CombinePayments>
  <DateCreated>2025-05-20T10:07:09.4044268-07:00</DateCreated>
  <DueDate>2025-05-20T10:07:09.4044268-07:00</DueDate>
  <InvoiceDate>2025-05-20T00:00:00-07:00</InvoiceDate>
  <InvoiceID>1</InvoiceID>
  <InvoiceNumber>sample string 2</InvoiceNumber>
  <InvoiceStatus>1</InvoiceStatus>
  <IsDeleted>true</IsDeleted>
  <LastModified>2025-05-20T10:07:09.4044268-07:00</LastModified>
  <LineItems>
    <InvoiceLineItem>
      <Adjustment>1</Adjustment>
      <Amount>2</Amount>
      <AmountApplied>1</AmountApplied>
      <CostCenterID>1</CostCenterID>
      <Description>sample string 3</Description>
      <ExpenseGLAccountID>1</ExpenseGLAccountID>
      <GLTransactionID>1</GLTransactionID>
      <InvoiceID>1</InvoiceID>
      <Is1099Item>true</Is1099Item>
      <LineItemID>1</LineItemID>
      <LongDescription>sample string 7</LongDescription>
      <ManualVendorCredit>true</ManualVendorCredit>
      <PaymentAmount>1</PaymentAmount>
      <PostingDate>2025-05-20T10:07:09.4044268-07:00</PostingDate>
      <Quantity>1</Quantity>
      <RecNextAmount>1</RecNextAmount>
      <RemainingBalance>1</RemainingBalance>
      <UnitOfMeasure>sample string 4</UnitOfMeasure>
      <UnitPrice>1</UnitPrice>
      <VendorCode>1</VendorCode>
      <VendorCredit>true</VendorCredit>
      <WorkOrderNumber>sample string 6</WorkOrderNumber>
    </InvoiceLineItem>
    <InvoiceLineItem>
      <Adjustment>1</Adjustment>
      <Amount>2</Amount>
      <AmountApplied>1</AmountApplied>
      <CostCenterID>1</CostCenterID>
      <Description>sample string 3</Description>
      <ExpenseGLAccountID>1</ExpenseGLAccountID>
      <GLTransactionID>1</GLTransactionID>
      <InvoiceID>1</InvoiceID>
      <Is1099Item>true</Is1099Item>
      <LineItemID>1</LineItemID>
      <LongDescription>sample string 7</LongDescription>
      <ManualVendorCredit>true</ManualVendorCredit>
      <PaymentAmount>1</PaymentAmount>
      <PostingDate>2025-05-20T10:07:09.4044268-07:00</PostingDate>
      <Quantity>1</Quantity>
      <RecNextAmount>1</RecNextAmount>
      <RemainingBalance>1</RemainingBalance>
      <UnitOfMeasure>sample string 4</UnitOfMeasure>
      <UnitPrice>1</UnitPrice>
      <VendorCode>1</VendorCode>
      <VendorCredit>true</VendorCredit>
      <WorkOrderNumber>sample string 6</WorkOrderNumber>
    </InvoiceLineItem>
  </LineItems>
  <Links>
    <Link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </Link>
    <Link>
      <href>sample string 2</href>
      <rel>sample string 1</rel>
    </Link>
  </Links>
  <ManualCheckNumber>1</ManualCheckNumber>
  <ManualPaymentDate>2025-05-20T00:00:00-07:00</ManualPaymentDate>
  <MgrApproved>true</MgrApproved>
  <MgrApprovedDate>2025-05-20T10:07:09.4044268-07:00</MgrApprovedDate>
  <Note>sample string 16</Note>
  <OnHold>true</OnHold>
  <OnHoldDate>2025-05-20T10:07:09.4044268-07:00</OnHoldDate>
  <PONumber>sample string 5</PONumber>
  <PayeeID>14</PayeeID>
  <PayeeName>sample string 15</PayeeName>
  <PayeeType>User</PayeeType>
  <PaymentCCID>1</PaymentCCID>
  <PaymentGLAccountID>7</PaymentGLAccountID>
  <PaymentTypeID>Cash</PaymentTypeID>
  <PostingDate>2025-05-20T00:00:00-07:00</PostingDate>
  <ReadyToPay>true</ReadyToPay>
  <ReadyToPayDate>2025-05-20T10:07:09.4044268-07:00</ReadyToPayDate>
  <RecInvCategoryID>1</RecInvCategoryID>
  <Received>true</Received>
  <ReceivedDate>2025-05-20T10:07:09.4044268-07:00</ReceivedDate>
  <Recurring>true</Recurring>
  <RecurringDescription>sample string 12</RecurringDescription>
  <Refund>true</Refund>
  <Rejected>true</Rejected>
  <RejectedBy>1</RejectedBy>
  <RejectedByName>sample string 10</RejectedByName>
  <RejectedDate>2025-05-20T10:07:09.4044268-07:00</RejectedDate>
  <RejectedReason>sample string 11</RejectedReason>
  <RemainingBalance>1</RemainingBalance>
  <RequiredNumberOfApprovers>13</RequiredNumberOfApprovers>
  <SchEndDate>2025-05-20T10:07:09.4044268-07:00</SchEndDate>
  <SchFrequency>1</SchFrequency>
  <SchStartDate>2025-05-20T10:07:09.4044268-07:00</SchStartDate>
  <UsePrevAmounts>true</UsePrevAmounts>
  <Validated>true</Validated>
  <ValidatedDate>2025-05-20T10:07:09.4044268-07:00</ValidatedDate>
  <VendorNotes>sample string 8</VendorNotes>
  <VoidDate>2025-05-20T10:07:09.4044268-07:00</VoidDate>
  <VoidGLTransactionID>1</VoidGLTransactionID>
  <Voided>true</Voided>
</Invoice>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Invoice'.

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.