GET api/v1/invoices/{id}

Gets a single invoice. If its not found it returns a HttpStatusCode.NotFound

Request Information

URI Parameters

Name Description Type Additional information
id Sale Document ID integer Required

Response Information

Resource Description

No information available

Name Description Type Additional information
Products Sale product list Array of SaleProductInfo No additional information available.
Hash Invoice hash string No additional information available.
HashControl Invoice hash control byte No additional information available.
Delivery Invoice delivery information DeliveryInfo No additional information available.
SaleID ID of the sale integer No additional information available.
DisplayName Display name of the document string No additional information available.
Number Number of the document. If the value is NULL the document is a draft integer No additional information available.
Reference Document reference string No additional information available.
CreationDate Document creation date date No additional information available.
DueDate Document expiration date date No additional information available.
SaleDate Date of the sale that this document refers to date No additional information available.
EntityID Entity ID that is attatched to this Sale integer No additional information available.
VatNumber Entity VAT number string No additional information available.
DiscountAmount Discount amount of the sale decimal number No additional information available.
GrossAmount Sale Gross amount decimal number No additional information available.
TaxAmount Sale Tax amount decimal number No additional information available.
TotalDue Sale total amount decimal number No additional information available.
RetentionIRC Portuguese Tax type (IRC) https://pt.wikipedia.org/wiki/Imposto_sobre_o_Rendimento_de_Pessoas_Coletivas boolean No additional information available.
RetentionRate Retencion rate of the sale decimal number No additional information available.
Serie ID of the Serie you chose for this document SerieSimpleInfo No additional information available.
Entity Information of the Entity EntitySimpleInfo No additional information available.
Status Status of the invoice No additional information available.

Response Formats

application/json, text/json

Sample:
                    
{
  "products": [
    {
      "productID": 1,
      "productReference": "sample string 1",
      "description": "sample string 2",
      "productDetail": "sample string 3",
      "quantity": 4.0,
      "unitID": 1,
      "unitPrice": 5.0,
      "discountRate": 6.0,
      "taxes": {
        "incidence": 1.0,
        "taxAmount": 2.0,
        "taxID": 3,
        "name": "sample string 4",
        "taxRate": 5.0
      },
      "measurement": {
        "unitID": 1,
        "name": "sample string 2",
        "abbreviation": "sample string 3",
        "isActive": true
      },
      "lineTotal": 7.0,
      "isComment": true,
      "isAdjust": true,
      "order": 10,
      "applyRetention": true
    },
    {
      "productID": 1,
      "productReference": "sample string 1",
      "description": "sample string 2",
      "productDetail": "sample string 3",
      "quantity": 4.0,
      "unitID": 1,
      "unitPrice": 5.0,
      "discountRate": 6.0,
      "taxes": {
        "incidence": 1.0,
        "taxAmount": 2.0,
        "taxID": 3,
        "name": "sample string 4",
        "taxRate": 5.0
      },
      "measurement": {
        "unitID": 1,
        "name": "sample string 2",
        "abbreviation": "sample string 3",
        "isActive": true
      },
      "lineTotal": 7.0,
      "isComment": true,
      "isAdjust": true,
      "order": 10,
      "applyRetention": true
    }
  ],
  "hash": "sample string 1",
  "hashControl": 64,
  "delivery": {
    "licensePlate": "sample string 1",
    "sourceDate": "2021-07-29T11:22:57.6790768+01:00",
    "targetDate": "2021-07-29T11:22:57.6790768+01:00",
    "sourceAddress": {
      "street": "sample string 1",
      "city": "sample string 2",
      "code": "sample string 3",
      "region": "sample string 4",
      "country": {
        "countryID": 64,
        "name": "sample string 2",
        "isoCode": "sample string 3"
      }
    },
    "targetAddress": {
      "street": "sample string 1",
      "city": "sample string 2",
      "code": "sample string 3",
      "region": "sample string 4",
      "country": {
        "countryID": 64,
        "name": "sample string 2",
        "isoCode": "sample string 3"
      }
    }
  },
  "saleID": 3,
  "displayName": "sample string 4",
  "number": 1,
  "reference": "sample string 5",
  "creationDate": "2021-07-29T11:22:57.6790768+01:00",
  "dueDate": "2021-07-29T11:22:57.6790768+01:00",
  "saleDate": "2021-07-29T11:22:57.6790768+01:00",
  "entityID": 9,
  "vatNumber": "sample string 10",
  "discountAmount": 11.0,
  "grossAmount": 12.0,
  "taxAmount": 13.0,
  "totalDue": 14.0,
  "retentionIRC": true,
  "retentionRate": 16.0,
  "serie": {
    "serieID": 1,
    "name": "sample string 2",
    "code": "sample string 3"
  },
  "entity": {
    "entityID": 1,
    "name": "sample string 2",
    "address": {
      "street": "sample string 1",
      "city": "sample string 2",
      "code": "sample string 3",
      "region": "sample string 4",
      "country": {
        "countryID": 64,
        "name": "sample string 2",
        "isoCode": "sample string 3"
      }
    }
  },
  "status": 0,
  "documentType": {
    "docTypeID": 1,
    "name": "sample string 1",
    "saftCode": "sample string 2",
    "saftInvoiceType": "sample string 3"
  },
  "observations": "sample string 17",
  "currency": {
    "exchangeRate": 1.0,
    "totalDue": 2.0,
    "currencyID": 64,
    "name": "sample string 4",
    "isoCode": "sample string 5"
  },
  "payments": [
    {
      "entity": "sample string 1",
      "reference": "sample string 2",
      "totalDue": 3.0
    },
    {
      "entity": "sample string 1",
      "reference": "sample string 2",
      "totalDue": 3.0
    }
  ]
}