Gets all the invoices based on the Document Type that you're trying to access. This type is based on the endpoint you're requesting on.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Number | Fill if you want to GET all the sales by the number you want. NULL if you want all numbers | integer | No additional information available. |
| SerieID | Fill if you want to GET all the sales by the ID of the serie that you want. NULL if you want all series | integer | No additional information available. |
| SerieCode | Fill if you want to GET all the sales by the Code of the serie. NULL if you want all series | string | No additional information available. |
| EntityID | Search sale by entityID | integer | No additional information available. |
| MinSaleDate | Minimum date where the sale was made | date | No additional information available. |
| MaxSaleDate | Maximum date where the sale was made | date | No additional information available. |
| MinDueDate | Minimum date of expiration of the sale | date | No additional information available. |
| MaxDueDate | Maximum date of expiration of the sale | date | No additional information available. |
| Status | Status of the sale | No additional information available. |
No information available
| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 | SaleStatus | No additional information available. |
| DocumentType | Document type information | DocumentTypeInfo | No additional information available. |
| Observations | Observations regarding the invoice | string | No additional information available. |
| Currency | Invoice currency information | InvoiceCurrency | No additional information available. |
| Payments | Multibanco references for this invoice | Array of MbReferenceInfo | No additional information available. |
[
{
"saleID": 1,
"displayName": "sample string 2",
"number": 1,
"reference": "sample string 3",
"creationDate": "2022-08-15T08:06:17.0790801+01:00",
"dueDate": "2022-08-15T08:06:17.0790801+01:00",
"saleDate": "2022-08-15T08:06:17.0790801+01:00",
"entityID": 7,
"vatNumber": "sample string 8",
"discountAmount": 9.0,
"grossAmount": 10.0,
"taxAmount": 11.0,
"totalDue": 12.0,
"retentionIRC": true,
"retentionRate": 14.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 15",
"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
}
]
},
{
"saleID": 1,
"displayName": "sample string 2",
"number": 1,
"reference": "sample string 3",
"creationDate": "2022-08-15T08:06:17.0790801+01:00",
"dueDate": "2022-08-15T08:06:17.0790801+01:00",
"saleDate": "2022-08-15T08:06:17.0790801+01:00",
"entityID": 7,
"vatNumber": "sample string 8",
"discountAmount": 9.0,
"grossAmount": 10.0,
"taxAmount": 11.0,
"totalDue": 12.0,
"retentionIRC": true,
"retentionRate": 14.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 15",
"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
}
]
}
]