GET Companies({CompanyId})/Sales({SalesOrderId})

Returns Details for the Sales Order Id provided

Information:

Base URL:

https://api.covasoft.net/pointofsale

Example of a call would be:

https://api.covasoft.net/pointofsale/Companies({CompanyId})/Sales({SalesOrderId})

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	The unique Company Id that was provided in your onboarding pacakage.	integer	Required
SalesOrderId	This is Sales Order Id Guid that you want details for	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Details for the Sales Order Id provided

GetSalesOrderByIdReturn

Name	Type	Additional information
Id	globally unique identifier	None.
Location	Location	None.
Status	string	None.
Details	Object	None.
CreatedTime	date	None.
TenderedByUserId	integer	None.
TenderedBy	string	None.
Customer	Customer	None.
ReceiptNumber	string	None.
InStock	Collection of InStock	None.
Dropships	Collection of Object	None.
TaxCalculation	TaxCalculation	None.
Payments	Payments	None.
Discounts	Object	None.
Invoice	Object	None.
Total	Total	None.
SaleOverrides	SaleOverrides	None.
OrderFulfillment	OrderFulfillment	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "3c3ed81c-8f0b-4efa-ba8d-1b698ac18c25",
  "Location": {
    "Id": 1,
    "Name": "sample string 2"
  },
  "Status": "sample string 2",
  "Details": {},
  "CreatedTime": "2024-11-25T11:17:46.7080246+00:00",
  "TenderedByUserId": 5,
  "TenderedBy": "sample string 6",
  "Customer": {
    "Id": "436e12d4-0065-434b-a470-bc9a44b6e1dd",
    "Number": "sample string 2",
    "FullName": "sample string 3",
    "ShippingAddressId": {},
    "ShippingAddress": {},
    "BillingAddress": {},
    "BillingAddressId": {},
    "AddressId": {},
    "MedicalInformation": {}
  },
  "ReceiptNumber": "sample string 7",
  "InStock": [
    {
      "No": 1,
      "CatalogId": "4feda776-cd5d-43a3-8b49-9a70765b000a",
      "Name": "sample string 3",
      "SKU": "sample string 4",
      "SoldAtPrice": 5,
      "ListPrice": 6,
      "SalePrice": {},
      "Quantity": 8,
      "UnitId": 9,
      "UnitAbbreviation": {},
      "MeasurementType": {},
      "PackageNumber": "sample string 12",
      "Batch": "sample string 13",
      "SerialNumbers": [
        {},
        {}
      ],
      "Attributes": {
        "equivalent To": "sample string 1",
        "net Weight": "sample string 2",
        "retail Marijuana Product Type": "sample string 3"
      }
    },
    {
      "No": 1,
      "CatalogId": "4feda776-cd5d-43a3-8b49-9a70765b000a",
      "Name": "sample string 3",
      "SKU": "sample string 4",
      "SoldAtPrice": 5,
      "ListPrice": 6,
      "SalePrice": {},
      "Quantity": 8,
      "UnitId": 9,
      "UnitAbbreviation": {},
      "MeasurementType": {},
      "PackageNumber": "sample string 12",
      "Batch": "sample string 13",
      "SerialNumbers": [
        {},
        {}
      ],
      "Attributes": {
        "equivalent To": "sample string 1",
        "net Weight": "sample string 2",
        "retail Marijuana Product Type": "sample string 3"
      }
    }
  ],
  "Dropships": [
    {},
    {}
  ],
  "TaxCalculation": {
    "TaxCalculcationId": {},
    "Lines": [
      {
        "Tax": 1.1,
        "ExemptAmount": 2.1,
        "LineNumber": "sample string 3",
        "TaxDetails": [
          {
            "TaxId": "75827709-2e6e-4d62-8433-141b9d9b05b9",
            "Rate": 2.1,
            "TaxName": "sample string 3",
            "Tax": 4.1,
            "Exemptions": {
              "Total": 1.1,
              "Details": [
                {
                  "ExemptAmount": 1.1
                },
                {
                  "ExemptAmount": 1.1
                }
              ]
            },
            "TaxAuthorityType": {},
            "TaxType": "sample string 6",
            "Layer": 7
          },
          {
            "TaxId": "75827709-2e6e-4d62-8433-141b9d9b05b9",
            "Rate": 2.1,
            "TaxName": "sample string 3",
            "Tax": 4.1,
            "Exemptions": {
              "Total": 1.1,
              "Details": [
                {
                  "ExemptAmount": 1.1
                },
                {
                  "ExemptAmount": 1.1
                }
              ]
            },
            "TaxAuthorityType": {},
            "TaxType": "sample string 6",
            "Layer": 7
          }
        ]
      },
      {
        "Tax": 1.1,
        "ExemptAmount": 2.1,
        "LineNumber": "sample string 3",
        "TaxDetails": [
          {
            "TaxId": "75827709-2e6e-4d62-8433-141b9d9b05b9",
            "Rate": 2.1,
            "TaxName": "sample string 3",
            "Tax": 4.1,
            "Exemptions": {
              "Total": 1.1,
              "Details": [
                {
                  "ExemptAmount": 1.1
                },
                {
                  "ExemptAmount": 1.1
                }
              ]
            },
            "TaxAuthorityType": {},
            "TaxType": "sample string 6",
            "Layer": 7
          },
          {
            "TaxId": "75827709-2e6e-4d62-8433-141b9d9b05b9",
            "Rate": 2.1,
            "TaxName": "sample string 3",
            "Tax": 4.1,
            "Exemptions": {
              "Total": 1.1,
              "Details": [
                {
                  "ExemptAmount": 1.1
                },
                {
                  "ExemptAmount": 1.1
                }
              ]
            },
            "TaxAuthorityType": {},
            "TaxType": "sample string 6",
            "Layer": 7
          }
        ]
      }
    ]
  },
  "Payments": {
    "Items": [
      {},
      {}
    ],
    "ChangeDue": 1,
    "CashBack": 2
  },
  "Discounts": {},
  "Invoice": {},
  "Total": {
    "Products": 1,
    "Taxes": 2.1
  },
  "SaleOverrides": {
    "UserId": 1,
    "Authorizations": {
      "Discount": {
        "invoiceLevel": [
          {
            "name": "sample string 1",
            "value": 2.1,
            "valueType": "sample string 3"
          },
          {
            "name": "sample string 1",
            "value": 2.1,
            "valueType": "sample string 3"
          }
        ],
        "Granted": true,
        "Tag": "sample string 2",
        "Percentage": 1.1,
        "Dollar": 1.1
      }
    }
  },
  "OrderFulfillment": {
    "Source": "sample string 1",
    "Method": "sample string 2",
    "Reference": "sample string 3",
    "OrderNumber": {},
    "Status": "sample string 5",
    "TrackingNumber": {}
  }
}