title | description | author | ms.topic | ms.devlang | ms.date | ms.author | ms.reviewer |
---|---|---|---|---|---|---|---|
Get salesInvoices |
Gets a sales invoice object in Dynamics 365 Business Central. |
SusanneWindfeldPedersen |
reference |
al |
05/31/2024 |
solsen |
solsen |
[!INCLUDEapi_v2_note]
Retrieve the properties and relationships of a sales object for [!INCLUDEprod_short].
Replace the URL prefix for [!INCLUDEprod_short] depending on environment following the guideline.
GET businesscentralPrefix/companies({id})/salesInvoices({id})
Header | Value |
---|---|
Authorization | Bearer {token}. Required. |
Do not supply a request body for this method.
If successful, this method returns a 200 OK
response code and a salesInvoices object in the response body.
Request
Here is an example of the request.
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesInvoices({id})
To get more data for a salesInvoice, use expand:
.../salesInvoices({id})?$expand=salesInvoiceLines,customer
Response
Here is an example of the response.
Note
The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
{
"id": "9e0f5c9c-44e3-ea11-bb43-000d3a2feca1",
"number": "PS-INV103001",
"externalDocumentNumber": "",
"invoiceDate": "2019-01-15",
"postingDate": "2019-01-15",
"dueDate": "2019-01-15",
"customerPurchaseOrderReference": "",
"customerId": "f3a5738a-44e3-ea11-bb43-000d3a2feca1",
"customerNumber": "20000",
"customerName": "Trey Research",
"billToName": "Trey Research",
"billToCustomerId": "f3a5738a-44e3-ea11-bb43-000d3a2feca1",
"billToCustomerNumber": "20000",
"shipToName": "Trey Research",
"shipToContact": "Helen Ray",
"sellToAddressLine1": "153 Thomas Drive",
"sellToAddressLine2": "",
"sellToCity": "Chicago",
"sellToCountry": "US",
"sellToState": "IL",
"sellToPostCode": "61236",
"billToAddressLine1": "153 Thomas Drive",
"billToAddressLine2": "",
"billToCity": "Chicago",
"billToCountry": "US",
"billToState": "IL",
"billToPostCode": "61236",
"shipToAddressLine1": "153 Thomas Drive",
"shipToAddressLine2": "",
"shipToCity": "Chicago",
"shipToCountry": "US",
"shipToState": "IL",
"shipToPostCode": "61236",
"currencyId": "00000000-0000-0000-0000-000000000000",
"currencyCode": "USD",
"orderId": "00000000-0000-0000-0000-000000000000",
"orderNumber": "",
"paymentTermsId": "0ba5738a-44e3-ea11-bb43-000d3a2feca1",
"shipmentMethodId": "00000000-0000-0000-0000-000000000000",
"salesperson": "PS",
"pricesIncludeTax": false,
"remainingAmount": 0,
"discountAmount": 0,
"discountAppliedBeforeTax": true,
"totalAmountExcludingTax": 164.7,
"totalTaxAmount": 8.24,
"totalAmountIncludingTax": 172.94,
"status": "Paid",
"lastModifiedDateTime": "2020-08-21T00:25:58.337Z",
"phoneNumber": "",
"email": "helen.ray@contoso.com"
}
Tips for working with the APIs
salesinvoice
Delete salesinvoice
Create salesinvoice
Update salesinvoice