Dynamics 365 Business Central API v2.0

https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0
Admin
This documentation describes the v2.0 REST API for Dynamics 365 Business Central, enabling...
Tokens:174,256
Snippets:933
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example GET Request

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_employee_get

A concrete example of the GET request URL for an employee.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/employees({id})
```

--------------------------------

### Get vendor example request

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendor_get

A concrete example of the GET request URL for a vendor.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/vendors({id})
```

--------------------------------

### Example GET Request

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_contact_get

A concrete example of the GET request URL for a specific contact.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/contacts({id})
```

--------------------------------

### Example GET request for an account

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_account_get

A concrete example of the HTTP GET request URL used to fetch account data.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/accounts({id})
```

--------------------------------

### Example GET Request

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_shipmentmethod_get

A concrete example of the GET request URL used to fetch a shipment method.

```json
GET https://{businesscentralPrefix}/api/v1.0/companies({id})/shipmentMethods({id})
```

--------------------------------

### Example Request for purchaseCreditMemoLines

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchasecreditmemoline_get

A concrete example of the GET request URL.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseCreditMemoLines({id})
```

--------------------------------

### Example Request and Response

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_generalproductpostinggroup_get

An example of a GET request and the corresponding JSON response for a general product posting group.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/generalProductPostingGroups({id})
```

```json
{
"@odata.etag": "W/\"JzQ0O1RkZjFGSzJKcXR3VU5QTmNyMUNuUjltT2Z5b1FtWjV5eGdndHNKcXN5bFE9MTswMDsn\"",
"id": "50bd9bdb-51ff-eb11-bb76-000d3a220646",
"code": "MISC",
"description": "Miscellaneous with VAT",
"defaultVATProductPostingGroup": "VAT25",
"autoInsertDefault": true
}
```

--------------------------------

### Get subscriptions example request

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_subscriptions_get

An example of the URL used to request subscription data.

```json
https://{businesscentralPrefix}/api/v1.0/subscriptions
```

--------------------------------

### Example Request for vendorPaymentJournals

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendorpaymentjournal_get

A concrete example of the GET request URL.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/vendorPaymentJournals({id})
```

--------------------------------

### Example Request for inventoryPostingGroups

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_inventorypostinggroup_get

A concrete example of the GET request URL.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/inventoryPostingGroups({id})
```

--------------------------------

### Example Request and Response

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_project_get

A concrete example of the GET request and the corresponding JSON response body containing project details.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/projects({id})
```

```json
{
    "id": "22d7a1c5-bde4-ea11-bbf2-00155df3a615",
    "number": "DEERFIELD, 8 WP",
    "displayName": "Setting up Eight Work Areas"
}
```

--------------------------------

### Example Request and Response for Items

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_item_get

A concrete example of a GET request and the corresponding JSON response object for an item.

```http
GET https://graph.microsoft.com/v2.0businesscentralPrefix/companies({id})/items({id})
```

```json
{
    "id": "fca5738a-44e3-ea11-bb43-000d3a2feca1",
    "number": "1896-S",
    "displayName": "ATHENS Desk",
    "type": "Inventory",
    "itemCategoryId": "e21a6a90-44e3-ea11-bb43-000d3a2feca1",
    "itemCategoryCode": "TABLE",
    "blocked": false,
    "gtin": "",
    "inventory": 4,
    "unitPrice": 1000.8,
    "priceIncludesTax": false,
    "unitCost": 780.7,
    "taxGroupId": "9f196a90-44e3-ea11-bb43-000d3a2feca1",
    "taxGroupCode": "FURNITURE",
    "baseUnitOfMeasureId": "5ca6738a-44e3-ea11-bb43-000d3a2feca1",
    "baseUnitOfMeasureCode": "PCS",
    "lastModifiedDateTime": "2020-08-21T00:24:19.347Z"
}
```

--------------------------------

### Example Request for generalLedgerEntries

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_generalledgerentry_get

A concrete example of the GET request URL.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/generalLedgerEntries({id})
```

--------------------------------

### Example Request for purchaseReceipts

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchasereceipt_get

A concrete example of the GET request URL for a purchase receipt.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseReceipts({id})
```

--------------------------------

### Example Request and Response for applyVendorEntries

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_applyvendorentry_get

A concrete example of a GET request and the corresponding JSON response object.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/applyVendorEntries({id})
```

```json
{
    "id" : "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
    "applied" : true,
    "appliesToId" : "1e8cb9c0-44e3-ea11-bb43-000d3a2feca1",
    "postingDate" : "2020-10-05",
    "documentType" : "Invoice",
    "documentNumber" : "2001",
    "externalDocumentNumber" : "2001",
    "vendorNumber" : "10000",
    "vendorName" : "First Up Consultants",
    "description" : "",
    "remainingAmount" : 0
}
```

--------------------------------

### Get paymentMethod Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_paymentmethod_get

A concrete example of the GET request URL used to fetch a payment method.

```http
GET https://{businesscentralPrefix}/api/v1.0/companies({id})/paymentMethods({id})
```

--------------------------------

### Example Request

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_incomestatement_get

A sample GET request including query parameters for ordering and date filtering.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/incomeStatements?$orderby=lineNumber&$filter=dateFilter ge 2019-01-01 and dateFilter le 2020-12-31
```

--------------------------------

### GET Request Example for salesInvoiceLines

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesinvoiceline_get

An example of a full GET request URL for a specific sales invoice line.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesInvoices({id})/salesInvoiceLines({salesInvoiceLineId})
```

--------------------------------

### Example Request and Response

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_balancesheet_get

Demonstrates a concrete GET request with query parameters and the corresponding JSON response object.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/balanceSheet?$orderby=lineNumber&$filter=dateFilter eq 2020-12-30
```

```json
{
    "id": "a0fbf171-44e3-ea11-bb43-000d3a2feca1",
    "lineNumber": 10000,
    "display": "Assets",
    "balance": 0,
    "lineType": "header",
    "indentation": 0,
    "dateFilter": "2020-08-21"
}
```

--------------------------------

### Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesorderline_get

An example of a GET request to retrieve a specific sales order line.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesOrders({id})/salesOrderLines({salesOrderLineId})
```

--------------------------------

### Example Request and Response for customerContacts

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customercontact_get

A concrete example of a GET request URL and the corresponding JSON response object.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/customerContacts({id})
```

```JSON
{
    "id": "CONT00123",
    "email": "john.smith@contoso.com",
    "firstName": "John",
    "lastName": "Smith",
    "professionalTitle": "Purchasing Manager",
    "customerId": "CUST1042",
    "customerName": "Contoso Ltd.",
    "primaryPhoneNumber": "+1 425-555-0174"
}
```

--------------------------------

### HTTP GET Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customerpaymentjournal_get

An example of a fully qualified GET request URL for a customer payment journal.

```JSON
GET https://{businesscentralPrefix}/api/v1.0/companies({id})/customerPaymentJournals({id})
```

--------------------------------

### Example Request and Response

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_journal_get

A concrete example of a GET request and the corresponding JSON response object for a journal.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/journals({id})
```

```json
{
  "id": "id-value",
  "code": "DEFAULT",
  "displayName": "Default Journal Batch",
  "lastModifiedDateTime": "2017-05-17T11:30:01.313Z"
}
```

--------------------------------

### Example Request for salesInvoices

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesinvoice_get

A concrete example of the GET request URL used to retrieve a sales invoice.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesInvoices({id})
```

--------------------------------

### Get purchaseReceiptLine Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchasereceiptline_get

An example of a GET request to retrieve a specific purchase receipt line.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseReceipts({id})/purchaseReceiptLines({purchaseReceiptLineId})
```

--------------------------------

### Example Request

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_countryregion_get

A concrete example of the GET request URL using the Business Central API v2.0 endpoint.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/countriesRegions({id})
```

--------------------------------

### Example Request for salesQuotes

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesquote_get

A concrete example of the GET request URL used to fetch a sales quote.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesQuotes({id})
```

--------------------------------

### Example Request for purchaseInvoices

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchaseinvoice_get

A concrete example of the GET request URL used to retrieve a specific purchase invoice.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseInvoices({id})
```

--------------------------------

### Example Request and Response

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_itemvariant_get

Example of a GET request to retrieve an itemVariant and the corresponding JSON response.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/itemVariants({id})
```

```json
{
    "id": "c12af665-c1e3-ea11-aa60-000d3ad7cacb",
    "itemId": "fca5738a-44e3-ea11-bb43-000d3a2feca1",
    "itemNumber": "1896-S",
    "code": "TESTCRUD",
    "description": "test crud"
}
```

--------------------------------

### Example Request for purchaseCreditMemos

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchasecreditmemo_get

A concrete example of the GET request URL using the API v2.0 endpoint.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseCreditMemos({id})
```

--------------------------------

### Example Request and Response for salesOrders

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesorder_get

A concrete example of a GET request and the corresponding JSON response object for a sales order.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesOrders({id})
```

```JSON
{
  "id": "b6f4017a-b749-ee11-ad0b-a1422c0f7f1f",
  "number": "101005",
  "externalDocumentNumber": "",
  "orderDate": "2015-12-31",
  "postingDate": "2023-09-02",
  "customerId": "c04c550b-593f-ee11-be74-6045bdc8c285",
  "customerNumber": "10000",
  "customerName": "Adatum Corporation",
  "billToName": "Adatum Corporation",
  "billToCustomerId": "c04c550b-593f-ee11-be74-6045bdc8c285",
  "billToCustomerNumber": "10000",
  "shipToName": "Adatum Corporation",
  "shipToContact": "Robert Townes",
  "sellToAddressLine1": "Station Road, 21",
  "sellToCity": "Cambridge",
  "sellToCountry": "GB",
  "billToAddressLine1": "Station Road, 21",
  "billToAddressLine2": "",
  "billToCity": "Cambridge",
  "billToCountry": "GB",
  "shipToAddressLine1": "Station Road, 21",
  "shipToCity": "Cambridge",
  "shipToCountry": "GB",
  "shortcutDimension1Code": "",
  "shortcutDimension2Code": "MEDIUM",
  "currencyId": "00000000-0000-0000-0000-000000000000",
  "currencyCode": "GBP",
  "paymentTermsId": "0e8b5305-593f-ee11-be74-6045bdc8c285",
  "shipmentMethodId": "774c550b-593f-ee11-be74-6045bdc8c285",
  "salesperson": "JO",
  "lastModifiedDateTime": "2023-09-02T17:49:38.5Z",
  "phoneNumber": "",
  "email": "robert.townes@contoso.com"
}
```

--------------------------------

### Example Request for agedAccountsPayable

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_agedaccountspayable_get

A concrete example of the GET request URL.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/agedAccountsPayables({vendorId})
```

--------------------------------

### Example Request for salesQuoteLines

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesquoteline_get

A concrete example of the GET request structure for a sales quote line.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesQuotes({id})/salesQuoteLines({salesQuoteLineId})
```

--------------------------------

### Get purchaseReceiptLine Response Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchasereceiptline_get

An example of the JSON response body returned upon a successful request.

```json
{
   "id": "dd8db9c0-44e3-ea11-bb43-000d3a2feca1",
   "documentId": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
   "sequence": "10000",
   "lineType": "Item",
   "lineObjectNumber": "1896-S",
   "description": "ATHENS Desk",
   "unitOfMeasureCode": "PCS",
   "unitCost": 780.7,
   "quantity": 4,
   "discountPercent": 5,
   "taxPercent": 10,
   "expectedReceiptDate": "2021-01-01"
}
```

--------------------------------

### Example Request for Currencies

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_currency_get

A concrete example of the GET request URL using the Business Central API endpoint.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/currencies({id})
```

--------------------------------

### Example Request and Response for trialBalance

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_trialbalance_get

Example of a filtered GET request and the corresponding JSON response object.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/trialBalances?$orderby number&$filter=dateFilter ge 2019-01-01 and dateFilter le 2019-12-31
```

```json
{
  "number": "1110",
  "display": "Accounts Receivable",
  "totalDebit": "0.00",
  "totalCredit": "0.00",
  "balanceAtDateDebit": "72,893.84",
  "balanceAtDateCredit": "0.00",
  "dateFilter": "2019-12-31"    
}
```

--------------------------------

### Example Request for purchaseOrders

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchaseorder_get

A concrete example of the GET request URL using the Business Central API v2.0 endpoint.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseOrders({id})
```

--------------------------------

### Example Request for timeRegistrationEntries

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_timeregistrationentry_get

An example of a GET request using a filter to retrieve entries for a specific employee.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})timeRegistrationEntries?$filter=employeeId eq {employeeId}
```

--------------------------------

### Example Request and Response for salesShipments

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesshipment_get

An example of a full GET request URL and the corresponding JSON response body for a salesShipment.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesShipments({id})
```

```JSON
{
   "id": "55c99ea7-bde4-ea11-bbf2-00155df3a61",
   "number": "108001",
   "externalDocumentNumber": "",
   "invoiceDate": "2019-01-01",
   "postingDate": "2019-01-01",
   "dueDate": "2019-10-05",
   "customerPurchaseOrderReference": "",
   "customerNumber": "20000",
   "customerName": "First Up Consultants",
   "billToName": "First Up Consultants",
   "billToCustomerNumber": "20000",
   "shipToName": "First Up Consultants",
   "shipToContact": "Evan McIntosh",
   "sellToAddressLine1": "100 Day Drive",
   "sellToAddressLine2": "",
   "sellToCity": "Chicago",
   "sellToCountry": "US",
   "sellToState": "IL",
   "sellToPostCode": "61236",
   "billToAddressLine1": "100 Day Drive",
   "billToAddressLine2": "",
   "billToCity": "Chicago",
   "billToCountry": "US",
   "billToState": "IL",
   "billToPostCode": "61236",
   "shipToAddressLine1": "100 Day Drive",
   "shipToAddressLine2": "",
   "shipToCity": "Chicago",
   "shipToCountry": "US",
   "shipToState": "IL",
   "shipToPostCode": "61236",
   "currencyCode": "USD",
   "orderNumber": "34",
   "paymentTermsCode": "",
   "shipmentMethodCode": "",
   "salesperson": "PS",
   "pricesIncludeTax": false,
   "lastModifiedDateTime": "2019-01-01",
   "phoneNumber": "",
   "email": "evan.mcintosh@contoso.com"
}
```

--------------------------------

### Example GET Requests

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customer_get

Common request patterns including optional $expand parameters for retrieving related entities.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/customers({id})
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/customers({id})?$expand=customerFinancialDetails, picture, defaultDimensions, currency, paymentTerm, shipmentMethod, paymentMethod
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/customers({id})?$expand=picture, currency, paymentMethod
```

--------------------------------

### Get customerPayment Response Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customerpayment_get

Example of a successful JSON response containing customer payment details.

```json
{
    "id": "17cce948-c6a5-4861-8ff5-30428ed83207",
    "lineNumber": 10000,
    "customerId": "customerId-value",
    "customerNumber": "10400",
    "contactId": "string",
    "postingDate": "2015-12-31",
    "documentNumber": "1234",
    "externalDocumentNumber": "",
    "amount": 1500,
    "appliesToInvoiceId": "appliesToInvoiceId-value",
    "appliesToInvoiceNumber": "100000",
    "description": "",
    "comment": "",
    "lastModifiedDateTime": "2017-03-17T19:02:22.043Z"
}
```

--------------------------------

### Example Request for cashFlowStatements

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_cashflowstatement_get

A sample GET request including query parameters for ordering and filtering by date.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/cashFlowStatements?$orderby=lineNumber&$filter=dateFilter ge 2019-01-01 and dateFilter le 2020-12-31
```

--------------------------------

### Example Request for purchaseOrderLines

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchaseorderline_get

A sample GET request targeting a specific purchase order line resource.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseOrderLines({purchaseOrderLineId})
```

--------------------------------

### Get unitsOfMeasure Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_unitofmeasure_get

An example of the HTTP GET request URL.

```json
GET https://{businesscentralPrefix}/api/v1.0/companies({id})/unitsOfMeasure({id})
```

--------------------------------

### Example Request for salesCreditMemoLines

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salescreditmemoline_get

A sample GET request targeting a specific sales credit memo line.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesCreditMemos({id})/salesCreditMemoLines({salesCreditMemoLineId})
```

--------------------------------

### Get vendor example response

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendor_get

A sample JSON response object containing vendor properties.

```JSON
{
    "id": "f7a5738a-44e3-ea11-bb43-000d3a2feca1",
    "number": "10000",
    "displayName": "Fabrikam, Inc.",
    "addressLine1": "10 North Lake Avenue",
    "addressLine2": "",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "4255550101",
    "email": "krystal.york@contoso.com",
    "website": "www.royalmail.co.uk",
    "taxRegistrationNumber": "",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "irs1099Code": "",
    "paymentTermsId": "0aa5738a-44e3-ea11-bb43-000d3a2feca1",
    "paymentMethodId": "3b196a90-44e3-ea11-bb43-000d3a2feca1",
    "taxLiable": true,
    "blocked": " ",
    "balance": 2071.13,
    "lastModifiedDateTime": "2020-08-21T07:38:46.53Z"
}
```

--------------------------------

### Get taxGroup Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_taxgroup_get

A concrete example of the GET request URL.

```json
GET https://{businesscentralPrefix}/api/v1.0/companies({id})/taxGroups({id})
```

--------------------------------

### customerSales Response Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customersale_get

A sample JSON response body returned upon a successful GET request.

```json
{
  "customerId": "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
  "customerNumber": "50000",
  "name": "Relecloud",
  "totalSalesAmount": 83956.45,
  "dateFilter_FilterOnly": null  
}
```

--------------------------------

### Get dimensions example request

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_dimension_get

A concrete example of the GET request URL for a dimension.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/dimensions({id})
```

--------------------------------

### Create customerReturnReason Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customerreturnreason_create

Example request and response for creating a customer return reason.

```json
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/customerReturnReasons
Content-type: application/json
{
  "code": "VARIANT",
  "description": "Incorrect item variant"
}
```

```json
HTTP/1.1 201 Created
Content-type: application/json
{
    "id": "6ea22bf6-a449-ee11-ad0b-a1422c0f7f1f",
    "code": "VARIANT",
    "description": "Incorrect item variant"
}
```

--------------------------------

### Get customerPayment Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customerpayment_get

Example of a GET request to retrieve a specific customer payment.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/customerPaymentsJournals({id})/customerPayments({id})
```

--------------------------------

### Example Request and Response for Project Creation

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_project_create

Example of a JSON request body to create a project and the corresponding 201 Created response.

```json
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/projects
Content-type: application/json

{
    "number": "DEERFIELD, 8 WP",
    "displayName": "Setting up Eight Work Areas"
}
```

```json
HTTP/1.1 201 Created
Content-type: application/json

{
    "id": "22d7a1c5-bde4-ea11-bbf2-00155df3a615",
    "number": "DEERFIELD, 8 WP",
    "displayName": "Setting up Eight Work Areas"
}
```

--------------------------------

### Get picture metadata request example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_picture_get

Example of a GET request to retrieve the picture metadata for a specific item.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies(companyId)/items(itemId)/picture
```

--------------------------------

### Create salesCreditMemos Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salescreditmemo_create

Example request and response for creating a sales credit memo.

```http
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/salesCreditMemos
Content-type: application/json

{
  "creditMemoDate": "2022-12-27",
  "customerNumber": "10000",
  "currencyCode": "GBP",
  "paymentTermsId": "a0a51911-e48a-ed11-af3b-cf75db0ab305"
}
```

```http
HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "1e8cb9c0-44e3-ea11-bb43-000d3a2feca1",
  "number": "1009",
  "creditMemoDate": "2022-12-27",
  "dueDate": "2023-01-27",
  "customerId": "customerId-value",
  "contactId": "",
  "customerNumber": "10000",
  "customerName": "Adatum Corporation",
  "billingPostalAddress": {
    "street": "",
    "city": "",
    "state": "",
    "countryLetterCode": "",
    "postalCode": ""
  }
}
```

--------------------------------

### Get default dimensions request example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_defaultdimension_get

Example of a GET request to retrieve default dimensions for a specific item.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({companyId})/items({itemId})/defaultDimensions
```

--------------------------------

### Get customerReturnReason Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customerreturnreason_get

An example of the GET request using the Business Central API v2.0 endpoint.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/customerReturnReasons({id})
```

--------------------------------

### Example Request and Response

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendorpayment_create

Example of the POST request and the corresponding 201 Created response for a vendorPayment.

```http
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/vendorPayments
Content-type: application/json

{
PLACE CODE HERE.
}
```

```http
HTTP/1.1 201 Created
Content-type: application/json

{
PLACE CODE HERE.
}
```

--------------------------------

### Example Request for journalLines

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_journalline_get

A concrete example of a GET request to the journalLines endpoint.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/journals({id})/journalLines({id})
```

--------------------------------

### Run the Node.js application

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/dynamics-open-api

Execute the server script from the command line to start the local SwaggerUI instance.

```bash
node BC_OAS.js
```

--------------------------------

### Example Request for documentAttachments

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_documentattachment_get

A concrete example of a GET request to retrieve a specific document attachment.

```JSON
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/documentAttachments({id})
```

--------------------------------

### Create Purchase Credit Memo Line Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchasecreditmemoline_create

An example of the POST request and the corresponding 201 Created response.

```json
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseCreditMemoLines({id})
Content-type: application/json
{
    "documentId": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
    "lineType": "Item",
    "lineObjectNumber": "1896-S",
    "description": "Athens Desk",
    "unitOfMeasureCode": "PCS",
    "unitCost": 250.00,
    "quantity": 2,
    "discountPercent": 5,
    "discountAppliedBeforeTax": true
}
```

```json
HTTP/1.1 201 Created
Content-type: application/json
{
    "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "documentId": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
    "sequence": 10000,
    "itemId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
    "accountId": "",
    "lineType": "Item",
    "lineObjectNumber": "1896-S",
    "description": "Athens Desk",
    "unitOfMeasureId": "cccccccc-2222-3333-4444-dddddddddddd",
    "unitOfMeasureCode": "PCS",
    "unitCost": 250.00,
    "quantity": 2,
    "discountAmount": 25.00,
    "discountPercent": 5,
    "discountAppliedBeforeTax": true,
    "amountExcludingTax": 475.00,
    "taxCode": "VAT10",
    "taxPercent": 10,
    "totalTaxAmount": 47.50,
    "amountIncludingTax": 522.50,
    "invoiceDiscountAllocation": 0.00,
    "netAmount": 475.00,
    "netTaxAmount": 47.50,
    "netAmountIncludingTax": 522.50,
    "itemVariantId": "",
    "locationId": "aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb"
}
```

--------------------------------

### Example Request and Response for countriesRegions

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_countryregion_create

A complete example showing the JSON request body and the corresponding 201 Created response.

```json
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/countriesRegions
Content-type: application/json

{
  "code": "AE",
  "displayName": "United Arab Emirates",
  "addressFormat": "City+ZIP Code"
}
```

```json
HTTP/1.1 201 Created
Content-type: application/json

{
    "id": "44a5738a-44e3-ea11-bb43-000d3a2feca1",
    "code": "AE",
    "displayName": "United Arab Emirates",
    "addressFormat": "City+ZIP Code",
    "lastModifiedDateTime": "2020-08-21T00:24:13.54Z"
}
```

--------------------------------

### Create Currency Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_currency_create

Example of a POST request body containing the necessary currency fields.

```json
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/currencies
Content-type: application/json

{
    "id": "0ca5738a-44e3-ea11-bb43-000d3a2feca1",
    "code": "CAD",
    "displayName": "Canadian dollar",
    "symbol": "$",
    "amountDecimalPlaces": "2:2",
    "amountRoundingPrecision": 0.01,
    "lastModifiedDateTime": "2020-08-21T00:24:12.793Z"
}
```

--------------------------------

### Example Request for pdfDocument

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_pdfdocument_get

A concrete example of a GET request targeting a sales invoice PDF document.

```http
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesInvoices({id})/pdfDocument
```

--------------------------------

### Example Request for salesCreditMemos

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salescreditmemo_get

An example of the full request URL for a sales credit memo.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/salesCreditMemos({id})
```

--------------------------------

### Create Vendor Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendor_create

A sample JSON payload for creating a vendor, including address, contact, and financial configuration details.

```JSON
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/vendors
Content-type: application/json

{
    "id": "f7a5738a-44e3-ea11-bb43-000d3a2feca1",
    "number": "10000",
    "displayName": "Fabrikam, Inc.",
    "addressLine1": "10 North Lake Avenue",
    "addressLine2": "",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "4255550101",
    "email": "krystal.york@contoso.com",
    "website": "www.royalmail.co.uk",
    "taxRegistrationNumber": "",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "irs1099Code": "",
    "paymentTermsId": "0aa5738a-44e3-ea11-bb43-000d3a2feca1",
    "paymentMethodId": "3b196a90-44e3-ea11-bb43-000d3a2feca1",
    "taxLiable": true,
    "blocked": " "
}
```

--------------------------------

### Example Request for agedAccountsReceivable

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_agedaccountsreceivable_get

A concrete example of the GET request using the Business Central API endpoint.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/agedAccountsReceivables({customerId})
```

--------------------------------

### Create Contact Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_contact_create

An example of the JSON request body and the corresponding HTTP response for creating a contact.

```json
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/contacts({id})
Content-type: application/json
{
    "number" : "108001",
    "type" : "Company",
    "displayName": "CRONUS USA, Inc.",
    "companyNumber" : "17806",
    "companyName" : "CRONUS US",
    "addressLine1": "7122 South Ashford Street",
    "addressLine2": "Westminster",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "+1 425 555 0100",
    "mobilePhoneNumber" : "",
    "email" : "ah@contoso.com",
    "website" : "",
    "searchName" : "",
    "privacyBlocked" : true,
    "lastInteractionDate" : "2021-06-01",
    "lastModifiedDateTime" : "2021-06-01"
}
```

```json
HTTP/1.1 201 Created
Content-type: application/json
{
    "id" : "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
    "number" : "108001",
    "type" : "Company",
    "displayName": "CRONUS USA, Inc.",
    "companyNumber" : "17806",
    "companyName" : "CRONUS US",
    "addressLine1": "7122 South Ashford Street",
    "addressLine2": "Westminster",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "+1 425 555 0100",
    "mobilePhoneNumber" : "",
    "email" : "ah@contoso.com",
    "website" : "",
    "searchName" : "",
    "privacyBlocked" : true,
    "lastInteractionDate" : "2021-06-01",
    "lastModifiedDateTime" : "2021-06-01"
}
```

--------------------------------

### Create Customer Response Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customer_create

The expected response upon successful creation of a customer record.

```json
HTTP/1.1 201 Created
Content-type: application/json

{
    "number": "10000",
    "displayName": "Adatum Corporation",
    "type": "Company",
    "addressLine1": "192 Market Square",
    "addressLine2": "",
    "city": "Atlanta",
    "state": "GA",
    "country": "US",
    "postalCode": "31772",
    "phoneNumber": "",
    "email": "robert.townes@contoso.com",
    "website": "",
    "taxLiable": true,
    "taxAreaId": "90196a90-44e3-ea11-bb43-000d3a2feca1",
    "taxRegistrationNumber": "",
    "currencyId": "00000000-0000-0000-0000-000000000000",
    "currencyCode": "USD",
    "paymentTermsId": "04a5738a-44e3-ea11-bb43-000d3a2feca1",
    "shipmentMethodId": "00000000-0000-0000-0000-000000000000",
    "paymentMethodId": "3b196a90-44e3-ea11-bb43-000d3a2feca1",
    "blocked": " "
}
```

--------------------------------

### Purchase Invoice Line Request Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchaseinvoiceline_get

An example of the HTTP GET request to retrieve a specific purchase invoice line.

```json
GET https://{businesscentralPrefix}/api/v2.0/companies({id})/purchaseInvoices({id})/purchaseInvoiceLines({purchaseInvoiceLineId})
```

--------------------------------

### Create Currency Response Example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_currency_create

The expected 201 Created response containing the created currency object.

```json
HTTP/1.1 201 Created
Content-type: application/json

{
    "id": "0ca5738a-44e3-ea11-bb43-000d3a2feca1",
    "code": "CAD",
    "displayName": "Canadian dollar",
    "symbol": "$",
    "amountDecimalPlaces": "2:2",
    "amountRoundingPrecision": 0.01,
    "lastModifiedDateTime": "2020-08-21T00:24:12.793Z"
}
```

--------------------------------

### Example Request and Response for vendorPaymentJournals

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendorpaymentjournal_create

Example of a POST request to create a journal and the corresponding 201 Created response.

```json
POST https://{businesscentralPrefix}/api/v2.0/companies({id})/vendorPaymentJournals
Content-type: application/json

{
  "code": "OTTER",
  "displayName": "Otter cash receipts and payments",
  "balancingAccountId": "021c2ed0-021d-ed11-9db9-000d3aa935da"
}
```

```json
HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "1377cc08-eb23-ed11-88e7-f2834877f72d",
  "code": "OTTER",
  "displayName": "Otter cash receipts and payments",
  "balancingAccountId": "021c2ed0-021d-ed11-9db9-000d3aa935da",
  "balancingAccountNumber": "10700",
  "lastModifiedDateTime": "2022-08-24T20:26:30.03Z"
}
```

--------------------------------

### Get default dimensions response example

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_defaultdimension_get

Example of the JSON response body returned when successfully querying default dimensions.

```json
{
    "id": "5b049aad-bde4-ea11-bbf2-00155df3a615",
    "parentId": "53049aad-bde4-ea11-bbf2-00155df3a615",
    "dimensionId": "47c99ea7-bde4-ea11-bbf2-00155df3a615",
    "dimensionCode": "DEPARTMENT",
    "dimensionValueId": "49c99ea7-bde4-ea11-bbf2-00155df3a615",
    "dimensionValueCode": "SALES",
    "postingValidation": " "
}
```

--------------------------------

### GET generalLedgerSetup

Source: https://learn.microsoft.com/es-es/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_generalledgersetup

Retrieves a general ledger setup object.

```APIDOC
## GET generalLedgerSetup

### Description
Gets a general ledger setup object.

### Method
GET

### Endpoint
generalLedgerSetup

### Response
#### Success Response (200)
- **id** (GUID) - The unique ID of the general ledger setup.
- **allowPostingFrom** (date) - The start date for posting.
- **allowPostingTo** (date) - The end date for posting.
- **additionalReportingCurrency** (string) - The additional reporting currency.
- **localCurrencyCode** (string) - The local currency code.
- **localCurrencySymbol** (string) - The local currency symbol.
- **lastModifiedDateTime** (datetime) - The last datetime the general ledger setup was modified.
- **allowQueryFromConsolidation** (boolean) - Indicates if query from consolidation is allowed.
- **shortcutDimension1Code** (string) - Shortcut dimension 1 code.
- **shortcutDimension2Code** (string) - Shortcut dimension 2 code.
- **shortcutDimension3Code** (string) - Shortcut dimension 3 code.
- **shortcutDimension4Code** (string) - Shortcut dimension 4 code.
- **shortcutDimension5Code** (string) - Shortcut dimension 5 code.
- **shortcutDimension6Code** (string) - Shortcut dimension 6 code.
- **shortcutDimension7Code** (string) - Shortcut dimension 7 code.
- **shortcutDimension8Code** (string) - Shortcut dimension 8 code.
```
Tokens:
Raw