GET Invoice/{id}
Retrieve a single Invoice based on its InvoiceNum
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
InvoiceSummaryDto| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceNum | integer |
None. |
|
| InvoiceDate | date |
None. |
|
| AmountPaid | decimal number |
None. |
|
| ProfileId | integer |
None. |
|
| BillToName | string |
None. |
|
| BillToAddress1 | string |
None. |
|
| BillToAddress2 | string |
None. |
|
| BillToCity | string |
None. |
|
| BillToState | string |
None. |
|
| BillToZip | string |
None. |
|
| BillToZipExt | string |
None. |
|
| ShipToName | string |
None. |
|
| ShipToAddress1 | string |
None. |
|
| ShipToAddress2 | string |
None. |
|
| ShipToCity | string |
None. |
|
| ShipToState | string |
None. |
|
| ShipToZip | string |
None. |
|
| ShipToZipExt | string |
None. |
|
| Attention | string |
None. |
|
| DateDue | date |
None. |
|
| Terms | string |
None. |
|
| Po | string |
None. |
|
| Rep | string |
None. |
|
| ShipVia | string |
None. |
|
| DiscountType | string |
None. |
|
| DiscountAmount | decimal number |
None. |
|
| TaxType | string |
None. |
|
| TaxAmount | decimal number |
None. |
|
| ShippingCost | decimal number |
None. |
|
| TotalCost | decimal number |
None. |
|
| ReferenceNum | string |
None. |
|
| Memo | string |
None. |
|
| CustComments | string |
None. |
|
| DateCreated | date |
None. |
|
| DateChanged | date |
None. |
|
| ChangedBy | string |
None. |
|
| Posted | boolean |
None. |
|
| DatePosted | date |
None. |
|
| Batch_Creation | string |
None. |
|
| Batch_Posting | string |
None. |
|
| InvoiceSent | boolean |
None. |
|
| DateSent | date |
None. |
|
| SentBy | string |
None. |
|
| CollectionRep | integer |
None. |
|
| PostedBy | string |
None. |
|
| CommunicateWithProfileId | integer |
None. |
|
| AdjustedAmountDue | decimal number |
None. |
|
| InvoiceLineItems | Collection of InvoiceLineItemDto |
None. |
|
| InvoiceLineItemSummary | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ObjectState": 0 },
{"Adjustments": [
{"ObjectState": 0 }],"InvoiceLineItemSummary": "sample string 9 - $10.10, sample string 9 - $10.10" }
- "InvoiceNum": 1,
- "InvoiceDate": "2024-05-12T10:26:53.0038993Z",
- "AmountPaid": 3.1,
- "ProfileId": 4,
- "BillToName": "sample string 5",
- "BillToAddress1": "sample string 6",
- "BillToAddress2": "sample string 7",
- "BillToCity": "sample string 8",
- "BillToState": "sample string 9",
- "BillToZip": "sample string 10",
- "BillToZipExt": "sample string 11",
- "ShipToName": "sample string 12",
- "ShipToAddress1": "sample string 13",
- "ShipToAddress2": "sample string 14",
- "ShipToCity": "sample string 15",
- "ShipToState": "sample string 16",
- "ShipToZip": "sample string 17",
- "ShipToZipExt": "sample string 18",
- "Attention": "sample string 19",
- "DateDue": "2024-05-12T10:26:53.0038993Z",
- "Terms": "sample string 21",
- "Po": "sample string 22",
- "Rep": "sample string 23",
- "ShipVia": "sample string 24",
- "DiscountType": "sample string 25",
- "DiscountAmount": 26.1,
- "TaxType": "sample string 27",
- "TaxAmount": 28.1,
- "ShippingCost": 29.1,
- "TotalCost": 30.1,
- "ReferenceNum": "sample string 31",
- "Memo": "sample string 32",
- "CustComments": "sample string 33",
- "DateCreated": "2024-05-12T10:26:53.0038993Z",
- "DateChanged": "2024-05-12T10:26:53.0038993Z",
- "ChangedBy": "sample string 36",
- "Posted": true,
- "DatePosted": "2024-05-12T10:26:53.0038993Z",
- "Batch_Creation": "sample string 39",
- "Batch_Posting": "sample string 40",
- "InvoiceSent": true,
- "DateSent": "2024-05-12T10:26:53.0038993Z",
- "SentBy": "sample string 43",
- "CollectionRep": 44,
- "PostedBy": "sample string 45",
- "CommunicateWithProfileId": 46,
- "AdjustedAmountDue": 47.1,
- "InvoiceLineItems": [
- {
- "LineItemId": 1,
- "InvoiceNum": 2,
- "Item": "sample string 3",
- "ItemNum": 4,
- "UnitPrice": 5.1,
- "Quantity": 6.1,
- "BasePrice": 7.1,
- "FlatFee": 8.1,
- "Descr": "sample string 9",
- "Amount": 10.1,
- "Taxable": true,
- "Options": "sample string 12",
- "DateCreated": "2024-05-12T10:26:53.0038993Z",
- "DateChanged": "2024-05-12T10:26:53.0038993Z",
- "ChangedBy": "sample string 15",
- "SoldBy": 16,
- "ApplyDate": "2024-05-12T10:26:53.0038993Z",
- "ServicePeriod_StartPeriod": "2024-05-12T10:26:53.0038993Z",
- "ServicePeriod_EndPeriod": "2024-05-12T10:26:53.0038993Z",
- "CommissionPercent": 20.1,
- "CommissionAmount": 21.1,
- "EventSignUpId": 22,
- "BillingId": 23,
- "PledgeId": 24,
- "ProjectId": 25,
- "eCommerceItemId": 26,
- "Posted": true,
- "DatePosted": "2024-05-12T10:26:53.0038993Z",
- "Batch_Creation": "sample string 29",
- "Batch_Posting": "sample string 30",
- "PostedBy": "sample string 31",
- "SalesId": 32,
- "TaxAppliedToLineItemId": 33,
- "OrderDetailId": 34,
- "HasTaxLineItem": true,
- "AdjustedAmountDue": 36.1,
- "EventCustomRegFieldResponseId": 37,
- "InvoiceLineItemOptionalRevenueItems": [
- {
- "InvoiceLineItemOptionalRevenueItemId": 1,
- "LineItemId": 2,
- "RevenueItemsOptionalId": 3
- "InvoiceLineItemOptionalRevenueItemId": 1,
- "LineItemId": 2,
- "RevenueItemsOptionalId": 3
{ - "Adjustments": [
- {
- "AdjustmentId": 1,
- "AdjustmentAmount": 1.1,
- "AdjustmentDate": "2024-05-12T10:26:53.0038993Z",
- "ApplyDate": "2024-05-12T10:26:53.0038993Z",
- "Descr": "sample string 2",
- "ProfileId": 1,
- "ReferenceNum": "sample string 3",
- "InvoiceNum": 1,
- "InvoiceLineItemId": 1,
- "PaymentId": 1,
- "UnappliedPaymentId": 1,
- "AdjustmentTypeId": 1,
- "AdjustmentType": "sample string 4",
- "DateCreated": "2024-05-12T10:26:53.0038993Z",
- "DateChanged": "2024-05-12T10:26:53.0038993Z",
- "ChangedBy": "sample string 5",
- "GlAccount": "sample string 6",
- "Posted": true,
- "DatePosted": "2024-05-12T10:26:53.0038993Z",
- "Batch_Creation": "sample string 7",
- "Batch_Posting": "sample string 8",
- "PostedBy": "sample string 9"
- "AdjustmentId": 1,
- "AdjustmentAmount": 1.1,
- "AdjustmentDate": "2024-05-12T10:26:53.0038993Z",
- "ApplyDate": "2024-05-12T10:26:53.0038993Z",
- "Descr": "sample string 2",
- "ProfileId": 1,
- "ReferenceNum": "sample string 3",
- "InvoiceNum": 1,
- "InvoiceLineItemId": 1,
- "PaymentId": 1,
- "UnappliedPaymentId": 1,
- "AdjustmentTypeId": 1,
- "AdjustmentType": "sample string 4",
- "DateCreated": "2024-05-12T10:26:53.0038993Z",
- "DateChanged": "2024-05-12T10:26:53.0038993Z",
- "ChangedBy": "sample string 5",
- "GlAccount": "sample string 6",
- "Posted": true,
- "DatePosted": "2024-05-12T10:26:53.0038993Z",
- "Batch_Creation": "sample string 7",
- "Batch_Posting": "sample string 8",
- "PostedBy": "sample string 9"
{
{
- "LineItemId": 1,
- "InvoiceNum": 2,
- "Item": "sample string 3",
- "ItemNum": 4,
- "UnitPrice": 5.1,
- "Quantity": 6.1,
- "BasePrice": 7.1,
- "FlatFee": 8.1,
- "Descr": "sample string 9",
- "Amount": 10.1,
- "Taxable": true,
- "Options": "sample string 12",
- "DateCreated": "2024-05-12T10:26:53.0038993Z",
- "DateChanged": "2024-05-12T10:26:53.0038993Z",
- "ChangedBy": "sample string 15",
- "SoldBy": 16,
- "ApplyDate": "2024-05-12T10:26:53.0038993Z",
- "ServicePeriod_StartPeriod": "2024-05-12T10:26:53.0038993Z",
- "ServicePeriod_EndPeriod": "2024-05-12T10:26:53.0038993Z",
- "CommissionPercent": 20.1,
- "CommissionAmount": 21.1,
- "EventSignUpId": 22,
- "BillingId": 23,
- "PledgeId": 24,
- "ProjectId": 25,
- "eCommerceItemId": 26,
- "Posted": true,
- "DatePosted": "2024-05-12T10:26:53.0038993Z",
- "Batch_Creation": "sample string 29",
- "Batch_Posting": "sample string 30",
- "PostedBy": "sample string 31",
- "SalesId": 32,
- "TaxAppliedToLineItemId": 33,
- "OrderDetailId": 34,
- "HasTaxLineItem": true,
- "AdjustedAmountDue": 36.1,
- "EventCustomRegFieldResponseId": 37,
- "InvoiceLineItemOptionalRevenueItems": [
- {
- "InvoiceLineItemOptionalRevenueItemId": 1,
- "LineItemId": 2,
- "RevenueItemsOptionalId": 3
- "InvoiceLineItemOptionalRevenueItemId": 1,
- "LineItemId": 2,
- "RevenueItemsOptionalId": 3
{
- {
- "AdjustmentId": 1,
- "AdjustmentAmount": 1.1,
- "AdjustmentDate": "2024-05-12T10:26:53.0038993Z",
- "ApplyDate": "2024-05-12T10:26:53.0038993Z",
- "Descr": "sample string 2",
- "ProfileId": 1,
- "ReferenceNum": "sample string 3",
- "InvoiceNum": 1,
- "InvoiceLineItemId": 1,
- "PaymentId": 1,
- "UnappliedPaymentId": 1,
- "AdjustmentTypeId": 1,
- "AdjustmentType": "sample string 4",
- "DateCreated": "2024-05-12T10:26:53.0038993Z",
- "DateChanged": "2024-05-12T10:26:53.0038993Z",
- "ChangedBy": "sample string 5",
- "GlAccount": "sample string 6",
- "Posted": true,
- "DatePosted": "2024-05-12T10:26:53.0038993Z",
- "Batch_Creation": "sample string 7",
- "Batch_Posting": "sample string 8",
- "PostedBy": "sample string 9"
{
- "AdjustmentId": 1,
- "AdjustmentAmount": 1.1,
- "AdjustmentDate": "2024-05-12T10:26:53.0038993Z",
- "ApplyDate": "2024-05-12T10:26:53.0038993Z",
- "Descr": "sample string 2",
- "ProfileId": 1,
- "ReferenceNum": "sample string 3",
- "InvoiceNum": 1,
- "InvoiceLineItemId": 1,
- "PaymentId": 1,
- "UnappliedPaymentId": 1,
- "AdjustmentTypeId": 1,
- "AdjustmentType": "sample string 4",
- "DateCreated": "2024-05-12T10:26:53.0038993Z",
- "DateChanged": "2024-05-12T10:26:53.0038993Z",
- "ChangedBy": "sample string 5",
- "GlAccount": "sample string 6",
- "Posted": true,
- "DatePosted": "2024-05-12T10:26:53.0038993Z",
- "Batch_Creation": "sample string 7",
- "Batch_Posting": "sample string 8",
- "PostedBy": "sample string 9"