Finance approval setup APIs

To update finance approval setup, including document types, such as purchase requisitions, payment requests, expense claims, purchase orders, purchase invoices, and purchase credit memos, use the following APIs.

List of finance approval setup and document types

To get finance approval setup properties and a list of all approval document types, issue a GET financeApprovalSetup request.

The following JSON code snippet is an example of a GET financeApprovalSetup request.

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/sparkrock/srf/v2.0/companies({companyId})/financeApprovalSetup?$Expand=financeApprovalSetupDocumentTypes
Authorization: Bearer {token}

Copy

Get finance approval setup properties

To get finance approval setup properties, issue a GET request.

The following JSON code snippet is an example of a GET request.

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/sparkrock/srf/v2.0/companies({companyId})/financeApprovalSetup
Authorization: Bearer {token}

Copy

Modify finance approval setup properties

To modify the approval group, issue a PATCH approval group request.

The following JSON code snippet is an example of a PATCH approval group request.

PATCH https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/sparkrock/srf/v2.0/companies({companyId})/financeApprovalSetup('')
Authorization: Bearer {token}
Content-type: application/json
If-Match: *
{
    "enableApproverSelection": true
}

Copy

List of finance approval setup document types

To get the properties of all finance approval setup document types, issue a GET financeApprovalSetupDocumentTypes request.

The following JSON code snippet is an example of a GET financeApprovalSetupDocumentTypes request.

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/sparkrock/srf/v2.0/companies({companyId})/financeApprovalSetupDocumentTypes
Authorization: Bearer {token}

Copy

Get the properties of a specific finance approval setup document type

To get the properties of a specific finance approval setup document type, issue a GET request.

The following JSON code snippet is an example of a GET request.

GET https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/sparkrock/srf/v2.0/companies({companyId})/financeApprovalSetupDocumentTypes({documentType})
Authorization: Bearer {token}

Copy

Modify finance approval setup document type properties

To modify the finance approval setup document type properties, issue a PATCH finance approval setup documents type request.

The following JSON code snippet is an example of a PATCH finance approval setup documents type request.

PATCH https://sparkrock365.api.bc.dynamics.com/v2.0/{tenantId}/{environmentName}/api/sparkrock/srf/v2.0/companies({companyId})/financeApprovalSetupDocumentTypes({documentType})
Authorization: Bearer {token}
Content-type: application/json
If-Match: *
{
    "enabled": true,
    "selfApproval": "Never",
    "skipRequisitionLines": true,
    "skipPaymentRequestLines": true,
    "skipExpenseClaimLines": true,
    "approvalLevel": "Last Level Approve"
}

Copy

Related information

User provisioning APIs

Feedback

To send feedback about this page, select the following link:

feedback-product-docs@sparkrock.com