Spend User Retrieval v4.1

Spend User Retrieval allows callers to retrieve users in the SAP Concur spend domain.

Limitations

Access to this documentation does not provide access to the API. 

Prior Versions

Spend User Retrieval v4 documentation is available here.

Retrieving all Spend Users in a Company

Retrieves all the spend users for a given company. The result is paginated and can be filtered using the parameters listed below.

Scopes

spend.user.general.read - Refer to Scope Usage for full details.

URI

GET https://us2.api.concursolutions.com/profile/spend/v4.1/Users
Parameters
Name Type Format Description
startIndex integer startIndex >= 1 The starting index of the paginated result.
itemsPerPage integer 100 >= itemsPerPage >= 1 The number of user resources to return on a single page.
filter string ABNF compliant The SCIM-compliant filter string to be used when retrieving user resources.

NOTE: Not all aspects of SCIM filtering are supported. The following fields are implemented with the corresponding set of operators:

  • cashAdvanceAccountCode { eq, ne }
  • country { eq, ne }
  • customData { complexValue that contains and, eq }
  • ledgerCode { eq, ne }
  • locale { eq, ne }
  • nonEmployee { eq, ne }
  • reimbursementCurrency { eq, ne }
  • reimbursementType { eq, ne }
  • stateProvince { eq, ne }
  • testEmployee { eq, ne }

Payloads

Examples

Request

GET https://us2.api.concursolutions.com/profile/spend/v4.1/Users?startIndex=1&itemsPerPage=4&filter=urn:ietf:params:scim:schemas:extension:spend:2.0:User:country eq "US"

Response

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 10294,
    "Resources": [
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:ScimResource",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:User",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:Approver",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:Delegate",
                "urn:ietf:params:scim:schemas:extension:enterprise:2.0:Payroll",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:InvoicePreference",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:UserPreference",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:WorkflowPreference",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:Role"
            ],
            "id": "aaaaaaaa-xxxx-zzzz-xxxx-xxxxxxxxxxxx",
            "meta": {
                "resourceType": "User",
                "created": null,
                "lastModified": "2022-03-18T01:22:37.327Z",
                "location": "https://us2.api.concursolutions.com/profile/spend/v4/Users/aaaaaaaa-xxxx-zzzz-xxxx-xxxxxxxxxxxx",
                "version": null
            },
            "urn:ietf:params:scim:schemas:extension:spend:2.0:User": {
                "reimbursementCurrency": "USD",
                "reimbursementType": "CONCUR_PAY",
                "ledgerCode": "DEFAULT",
                "country": "US",
                "budgetCountryCode": null,
                "stateProvince": "WA",
                "locale": "en-US",
                "cashAdvanceAccountCode": null,
                "testEmployee": false,
                "nonEmployee": false,
                "biManager": null,
                "customData": []
            },
            "urn:ietf:params:scim:schemas:extension:spend:2.0:Approver": {},
            "urn:ietf:params:scim:schemas:extension:spend:2.0:Delegate": {},
            "urn:ietf:params:scim:schemas:extension:spend:2.0:Role": {
                "roles": [
                    {
                        "roleName": "SHD_BUDGET_APPROVER"
                    },
                    {
                        "roleName": "EXP_REIMBURSEMENT_APPROVER",
                        "roleGroups": [
                            ""
                        ]
                    }
                ]
            },
            "urn:ietf:params:scim:schemas:extension:spend:2.0:UserPreference": {
                "showImagingIntro": true,
                "expenseAuditRequired": "REQUIRED",
                "allowCreditCardTransArrivalEmails": true,
                "allowReceiptImageAvailEmails": true,
                "promptForCardTransactionsOnReport": true,
                "autoAddTripCardTransOnReport": false,
                "promptForReportPrintFormat": true,
                "defaultReportPrintFormat": "DETAILED",
                "showTotalOnReport": true,
                "showExpenseOnReport": "ALL",
                "showInstructHelpPanel": true,
                "useQuickItinAsDefault": false,
                "enableOcrForUi": true,
                "enableOcrForEmail": true,
                "enableTripBasedAssistant": false
            },
            "urn:ietf:params:scim:schemas:extension:spend:2.0:InvoicePreference": {},
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:Payroll": {},
            "urn:ietf:params:scim:schemas:extension:spend:2.0:WorkflowPreference": {
                "emailStatusChangeOnCashAdvance": false,
                "emailAwaitApprovalOnCashAdvance": false,
                "emailStatusChangeOnReport": false,
                "emailAwaitApprovalOnReport": false,
                "promptForApproverOnReportSubmit": false,
                "emailStatusChangeOnTravelRequest": false,
                "emailAwaitApprovalOnTravelRequest": false,
                "promptForApproverOnTravelRequestSubmit": false,
                "emailStatusChangeOnPayment": false,
                "emailAwaitApprovalOnPayment": false,
                "promptForApproverOnPaymentSubmit": false,
                "emailOnPurchaseRequestStatusChange": false,
                "emailOnPurchaseRequestAwaitApproval": false,
                "promptForPurchaseRequestApproverOnSubmit": false
            }
        },
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:ScimResource",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:User",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:Approver",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:Delegate",
                "urn:ietf:params:scim:schemas:extension:enterprise:2.0:Payroll",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:InvoicePreference",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:UserPreference",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:WorkflowPreference",
                "urn:ietf:params:scim:schemas:extension:spend:2.0:Role"
            ],
            "id": "aaaaabbb-xxxx-zzzz-xxxx-xxxxxxxxxxxx",
            "meta": {
                "resourceType": "User",
                "created": null,
                "lastModified": "2022-03-17T19:18:04.123Z",
                "location": "https://us2.api.concursolutions.com/profile/spend/v4/Users/aaaaabbb-xxxx-zzzz-xxxx-xxxxxxxxxxxx",
                "version": null
            },
            "urn:ietf:params:scim:schemas:extension:spend:2.0:User": {
                "reimbursementCurrency": "USD",
                "reimbursementType": "CONCUR_PAY",
                "ledgerCode": "DEFAULT",
                "country": "US",
                "budgetCountryCode": null,
                "stateProvince": "WA",
                "locale": "en-US",
                "cashAdvanceAccountCode": null,
                "testEmployee": false,
                "nonEmployee": false,
                "biManager": null,
                "customData": []
            },
            "urn:ietf:params:scim:schemas:extension:spend:2.0:Approver": {},
            "urn:ietf:params:scim:schemas:extension:spend:2.0:Delegate": {},
            "urn:ietf:params:scim:schemas:extension:spend:2.0:Role": {
                "roles": []
            },
            "urn:ietf:params:scim:schemas:extension:spend:2.0:UserPreference": {
                "showImagingIntro": true,
                "expenseAuditRequired": "REQUIRED",
                "allowCreditCardTransArrivalEmails": true,
                "allowReceiptImageAvailEmails": true,
                "promptForCardTransactionsOnReport": true,
                "autoAddTripCardTransOnReport": false,
                "promptForReportPrintFormat": true,
                "defaultReportPrintFormat": "DETAILED",
                "showTotalOnReport": true,
                "showExpenseOnReport": "ALL",
                "showInstructHelpPanel": true,
                "useQuickItinAsDefault": false,
                "enableOcrForUi": true,
                "enableOcrForEmail": true,
                "enableTripBasedAssistant": false
            },
            "urn:ietf:params:scim:schemas:extension:spend:2.0:InvoicePreference": {},
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:Payroll": {},
            "urn:ietf:params:scim:schemas:extension:spend:2.0:WorkflowPreference": {
                "emailStatusChangeOnCashAdvance": false,
                "emailAwaitApprovalOnCashAdvance": false,
                "emailStatusChangeOnReport": false,
                "emailAwaitApprovalOnReport": false,
                "promptForApproverOnReportSubmit": false,
                "emailStatusChangeOnTravelRequest": false,
                "emailAwaitApprovalOnTravelRequest": false,
                "promptForApproverOnTravelRequestSubmit": false,
                "emailStatusChangeOnPayment": false,
                "emailAwaitApprovalOnPayment": false,
                "promptForApproverOnPaymentSubmit": false,
                "emailOnPurchaseRequestStatusChange": false,
                "emailOnPurchaseRequestAwaitApproval": false,
                "promptForPurchaseRequestApproverOnSubmit": false
            }
        }
    ],
    "startIndex": 1,
    "itemsPerPage": 2
}

Retrieving a Spend User

Retrieves a specific user’s spend data.

Scopes

spend.user.general.read - Refer to Scope Usage for full details.

URI

GET https://us2.api.concursolutions.com/profile/spend/v4.1/Users/{UserId}
Parameters
Name Type Format Description
UserId string RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace The unique identifier for the user that should be retrieved.

Payload

Examples

Request

GET https://us2.api.concursolutions.com/profile/spend/v4.1/Users/aaaaaeee-xxxx-zzzz-xxxx-xxxxxxxxxxxx

Response

{
    "schemas": [

        "urn:ietf:params:scim:schemas:ScimResource",
        "urn:ietf:params:scim:schemas:extension:spend:2.0:User",
        "urn:ietf:params:scim:schemas:extension:spend:2.0:Approver",
        "urn:ietf:params:scim:schemas:extension:spend:2.0:Delegate",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:Payroll",
        "urn:ietf:params:scim:schemas:extension:spend:2.0:InvoicePreference",
        "urn:ietf:params:scim:schemas:extension:spend:2.0:UserPreference",
        "urn:ietf:params:scim:schemas:extension:spend:2.0:WorkflowPreference",
        "urn:ietf:params:scim:schemas:extension:spend:2.0:Role"
    ],
    "id": "94bf66c2-272c-4760-91f5-4d5290a033a8",
    "meta": {
        "resourceType": "User",
        "created": null,
        "lastModified": "2024-01-19T20:10:34.377Z",
        "location": "https://us2.api.concursolutions.com/profile/spend/v4/Users/aaaaaeee-xxxx-zzzz-xxxx-xxxxxxxxxxxx",
        "version": null
    },
    "urn:ietf:params:scim:schemas:extension:spend:2.0:User": {
        "reimbursementCurrency": "USD",
        "reimbursementType": null,
        "ledgerCode": "DEFAULT",
        "country": "US",
        "budgetCountryCode": null,
        "stateProvince": null,
        "locale": "en-US",
        "cashAdvanceAccountCode": "",
        "testEmployee": false,
        "nonEmployee": false,
        "biManager": null,
        "customData": [
            {
                "id": "orgUnit4",
                "value": ""
            },
            {
                "id": "custom17",
                "value": ""
            },
            {
                "id": "custom16",
                "value": "ag1"
            },
            {
                "id": "orgUnit2",
                "value": ""
            },
            {
                "id": "custom19",
                "value": ""
            },
            {
                "id": "custom4",
                "value": ""
            },
            {
                "id": "custom18",
                "value": ""
            },
            {
                "id": "custom20",
                "value": ""
            },
            {
                "id": "custom5",
                "value": ""
            }
        ]
    },
    "urn:ietf:params:scim:schemas:extension:spend:2.0:Approver": {},
    "urn:ietf:params:scim:schemas:extension:spend:2.0:Delegate": {},
    "urn:ietf:params:scim:schemas:extension:spend:2.0:Role": {
        "roles": [
            {
                "roleName": "EXP_USER"
            }
        ]
    },
    "urn:ietf:params:scim:schemas:extension:spend:2.0:UserPreference": {
        "showImagingIntro": false,
        "expenseAuditRequired": "ALWAYS",
        "allowCreditCardTransArrivalEmails": false,
        "allowReceiptImageAvailEmails": false,
        "promptForCardTransactionsOnReport": false,
        "autoAddTripCardTransOnReport": false,
        "promptForReportPrintFormat": false,
        "defaultReportPrintFormat": "FAX",
        "showTotalOnReport": false,
        "showExpenseOnReport": "ALL",
        "showInstructHelpPanel": false,
        "useQuickItinAsDefault": false,
        "enableOcrForUi": false,
        "enableOcrForEmail": true,
        "enableTripBasedAssistant": false
    },
    "urn:ietf:params:scim:schemas:extension:spend:2.0:InvoicePreference": {
        "emailOnPurchasingAssigned": true,
        "emailOnPurchasingSendBack": true,
        "emailOnFaxImageAvailablePaymentRequest": true,
        "promptNewLineItemsPaymentRequest": true,
        "displayInlineImage": false,
        "autoOpenImage": false
    },
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:Payroll": {},
    "urn:ietf:params:scim:schemas:extension:spend:2.0:WorkflowPreference": {
        "emailStatusChangeOnCashAdvance": true,
        "emailAwaitApprovalOnCashAdvance": true,
        "emailStatusChangeOnReport": true,
        "emailAwaitApprovalOnReport": true,
        "promptForApproverOnReportSubmit": false,
        "emailStatusChangeOnTravelRequest": true,
        "emailAwaitApprovalOnTravelRequest": true,
        "promptForApproverOnTravelRequestSubmit": false,
        "emailStatusChangeOnPayment": true,
        "emailAwaitApprovalOnPayment": true,
        "promptForApproverOnPaymentSubmit": false,
        "emailOnPurchaseRequestStatusChange": false,
        "emailOnPurchaseRequestAwaitApproval": false,
        "promptForPurchaseRequestApproverOnSubmit": false
    }
}

Schema

List Response

Name Type Format Description
schemas string - The schemas present in the resource.
totalResults integer int32 Required The total number of results returned by the list or query operation.
Resources FullSpendUser - A multi-valued list of complex objects containing the requested resources.
startIndex integer int32 The 1-based index of the first result in the current set of list results.
itemsPerPage integer int32 The number of resources returned in a list response page.

Full Spend User

Name Type Format Description
schemas string - The schemas present in the resource.
urn:ietf:params:scim:schemas:extension:spend:2.0:User SpendUser - The user’s base spend data.
urn:ietf:params:scim:schemas:extension:spend:2.0:Approver ApproverExtension - The user’s spend approver data.
urn:ietf:params:scim:schemas:extension:spend:2.0:Delegate DelegateExtension - The user’s spend delegate data.
urn:ietf:params:scim:schemas:extension:spend:2.0:Role SpendRole - The user’s spend role data.
urn:ietf:params:scim:schemas:extension:spend:2.0:UserPreference UserPreferenceExtension - The user’s user preference settings.
urn:ietf:params:scim:schemas:extension:spend:2.0:InvoicePreference InvoicePreferenceExtension - The user’s invoice preference settings.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:Payroll ADPExtension - The user’s ADP data.
urn:ietf:params:scim:schemas:extension:spend:2.0:WorkflowPreference WorkflowPreferenceExtension - The user’s workflow preference settings.

Error Message Response

Name Type Format Description
schemas string - The schemas present in this resource.
scimType string - A SCIM detailed error keyword.
detail string - A detailed, human readable message.
status integer int32 The HTTP status code.

On this page