GET v1/Companies({CompanyId})/Invoices({InvoiceId})

This call returns a finalized sale invoice by ID

Information:

Base URL:

https://api.covasoft.net/invoice

Example of a call would be:

https://api.covasoft.net/invoice/v1/Companies({CompanyId})/Invoices({InvoiceId})

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyId

Company Id from your onboarding package

integer

Required

InvoiceId

Sales Invoice Guid Id that you want to get the Sales Order Id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Get Sales Order Id from Sales Invoice

GetSalesOrderIdFromInvoiceIdReturn
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

OriginalInvoiceId

globally unique identifier

None.

LocationId

integer

None.

UserId

integer

None.

PrintableId

string

None.

OriginalPrintableId

string

None.

ReceiptNumber

string

None.

OriginalReceiptNumber

string

None.

Notes

string

None.

Annotation

string

None.

InvoiceType

string

None.

Customer

Customer

None.

Orders

Collection of InvoiceOrder

None.

DropshipOrders

Collection of Object

None.

Payments

Collection of InvoicePayment

None.

Discounts

decimal number

None.

ChangeDue

decimal number

None.

CashBack

decimal number

None.

TaxCalculationResult

TaxCalculationResult

None.

SaleOverrides

Object

None.

CreatedByUser

string

None.

CreatedDateUtc

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "1e7975d9-c2cd-44bb-a316-c428c8c1d547",
  "OriginalInvoiceId": "9f0389d3-a3bf-43b9-a7f1-8a126f4f4d80",
  "LocationId": 2,
  "UserId": 3,
  "PrintableId": "sample string 4",
  "OriginalPrintableId": "sample string 5",
  "ReceiptNumber": "sample string 6",
  "OriginalReceiptNumber": "sample string 7",
  "Notes": "sample string 8",
  "Annotation": "sample string 9",
  "InvoiceType": "sample string 10",
  "Customer": {
    "Id": "f955b64c-2320-4eb4-bfd6-33fa37757490",
    "Number": "sample string 2",
    "FullName": "sample string 3",
    "ShippingAddressId": {},
    "ShippingAddress": {},
    "BillingAddress": {},
    "BillingAddressId": {},
    "AddressId": {},
    "MedicalInformation": {}
  },
  "Orders": [
    {
      "Id": "2d56d100-2309-4bd1-87f1-4c23f99a70a5",
      "PrintableId": {},
      "ReferenceId": {},
      "Items": [
        {
          "LineNumber": 1,
          "ProductId": "b8cf5405-5369-4c4d-9607-81c4ce3a5ad2",
          "Quantity": 3,
          "UnitId": 4,
          "UnitAbbreviation": "sample string 5",
          "Lot": "sample string 6",
          "SoldAtPrice": 7,
          "SalePrice": {},
          "ListPrice": 9,
          "Description": "sample string 10",
          "Sku": "sample string 11",
          "SerialNumber": "sample string 12",
          "Total": 13,
          "Attributes": {
            "equivalent To": "sample string 1",
            "net Weight": "sample string 2",
            "retail Marijuana Product Type": "sample string 3"
          }
        },
        {
          "LineNumber": 1,
          "ProductId": "b8cf5405-5369-4c4d-9607-81c4ce3a5ad2",
          "Quantity": 3,
          "UnitId": 4,
          "UnitAbbreviation": "sample string 5",
          "Lot": "sample string 6",
          "SoldAtPrice": 7,
          "SalePrice": {},
          "ListPrice": 9,
          "Description": "sample string 10",
          "Sku": "sample string 11",
          "SerialNumber": "sample string 12",
          "Total": 13,
          "Attributes": {
            "equivalent To": "sample string 1",
            "net Weight": "sample string 2",
            "retail Marijuana Product Type": "sample string 3"
          }
        }
      ]
    },
    {
      "Id": "2d56d100-2309-4bd1-87f1-4c23f99a70a5",
      "PrintableId": {},
      "ReferenceId": {},
      "Items": [
        {
          "LineNumber": 1,
          "ProductId": "b8cf5405-5369-4c4d-9607-81c4ce3a5ad2",
          "Quantity": 3,
          "UnitId": 4,
          "UnitAbbreviation": "sample string 5",
          "Lot": "sample string 6",
          "SoldAtPrice": 7,
          "SalePrice": {},
          "ListPrice": 9,
          "Description": "sample string 10",
          "Sku": "sample string 11",
          "SerialNumber": "sample string 12",
          "Total": 13,
          "Attributes": {
            "equivalent To": "sample string 1",
            "net Weight": "sample string 2",
            "retail Marijuana Product Type": "sample string 3"
          }
        },
        {
          "LineNumber": 1,
          "ProductId": "b8cf5405-5369-4c4d-9607-81c4ce3a5ad2",
          "Quantity": 3,
          "UnitId": 4,
          "UnitAbbreviation": "sample string 5",
          "Lot": "sample string 6",
          "SoldAtPrice": 7,
          "SalePrice": {},
          "ListPrice": 9,
          "Description": "sample string 10",
          "Sku": "sample string 11",
          "SerialNumber": "sample string 12",
          "Total": 13,
          "Attributes": {
            "equivalent To": "sample string 1",
            "net Weight": "sample string 2",
            "retail Marijuana Product Type": "sample string 3"
          }
        }
      ]
    }
  ],
  "DropshipOrders": [
    {},
    {}
  ],
  "Payments": [
    {
      "Id": "cca2c648-92de-4e76-b5fd-ebe5c57077a5",
      "OriginalPaymentId": {},
      "DrawerId": "14285661-345b-4654-a9e8-32646a3eaf7e",
      "Last4Digits": {},
      "CustomerAccountId": {},
      "PaymentMethodId": 6,
      "PaymentMethodName": "sample string 7",
      "Amount": 8.1,
      "TransactionDateUtc": "2024-11-24T12:46:55.8063298+00:00"
    },
    {
      "Id": "cca2c648-92de-4e76-b5fd-ebe5c57077a5",
      "OriginalPaymentId": {},
      "DrawerId": "14285661-345b-4654-a9e8-32646a3eaf7e",
      "Last4Digits": {},
      "CustomerAccountId": {},
      "PaymentMethodId": 6,
      "PaymentMethodName": "sample string 7",
      "Amount": 8.1,
      "TransactionDateUtc": "2024-11-24T12:46:55.8063298+00:00"
    }
  ],
  "Discounts": 1.1,
  "ChangeDue": 11.1,
  "CashBack": 12.1,
  "TaxCalculationResult": {
    "Id": "a28c8605-6452-4ca8-8288-5cb4c6c31b86",
    "Lines": [
      {
        "LineNumber": "sample string 1",
        "Taxable": 2,
        "Rate": 3,
        "Tax": 4.1,
        "ExemptAmount": 5,
        "Discount": 6.1,
        "TaxDetails": [
          {
            "TaxId": "ac9a9827-63e2-438c-837f-b555a2b0ff60",
            "CountryCode": {},
            "RegionCode": {},
            "TaxType": "sample string 4",
            "TaxAuthority": {},
            "TaxAuthorityType": "sample string 6",
            "Rate": 7.1,
            "Tax": 8.1,
            "Exemptions": {},
            "Taxable": 10,
            "TaxName": "sample string 11",
            "Layer": 12
          },
          {
            "TaxId": "ac9a9827-63e2-438c-837f-b555a2b0ff60",
            "CountryCode": {},
            "RegionCode": {},
            "TaxType": "sample string 4",
            "TaxAuthority": {},
            "TaxAuthorityType": "sample string 6",
            "Rate": 7.1,
            "Tax": 8.1,
            "Exemptions": {},
            "Taxable": 10,
            "TaxName": "sample string 11",
            "Layer": 12
          }
        ]
      },
      {
        "LineNumber": "sample string 1",
        "Taxable": 2,
        "Rate": 3,
        "Tax": 4.1,
        "ExemptAmount": 5,
        "Discount": 6.1,
        "TaxDetails": [
          {
            "TaxId": "ac9a9827-63e2-438c-837f-b555a2b0ff60",
            "CountryCode": {},
            "RegionCode": {},
            "TaxType": "sample string 4",
            "TaxAuthority": {},
            "TaxAuthorityType": "sample string 6",
            "Rate": 7.1,
            "Tax": 8.1,
            "Exemptions": {},
            "Taxable": 10,
            "TaxName": "sample string 11",
            "Layer": 12
          },
          {
            "TaxId": "ac9a9827-63e2-438c-837f-b555a2b0ff60",
            "CountryCode": {},
            "RegionCode": {},
            "TaxType": "sample string 4",
            "TaxAuthority": {},
            "TaxAuthorityType": "sample string 6",
            "Rate": 7.1,
            "Tax": 8.1,
            "Exemptions": {},
            "Taxable": 10,
            "TaxName": "sample string 11",
            "Layer": 12
          }
        ]
      }
    ]
  },
  "SaleOverrides": {},
  "CreatedByUser": "sample string 14",
  "CreatedDateUtc": "2024-11-24T12:46:55.8063298+00:00"
}