Show Menu

Update Company Program

Update Company Program

This allows you to update your company payment programs or projects.

post/API/v4/Programs/UpdateProgram

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

ProgramIDint

Int length: inclusive between 1 and 25

Descriptionstring

String length: inclusive between 1 and 100

TransactionCategoryIDint

Int length: inclusive between 1 and 5

TransactionSubCategoryIDstring

Int length: inclusive between 1 and 5

Amountdecimal

Decimal length: inclusive between 1 and 25

CurrencyCodestring

String length: inclusive between 1 and 25

IsClaimstring

String length: inclusive between 1 and 25

Paginationint

Specifies pagination information to limit the number of records to return. Allowed parameters are: RecordsToSkip—Number of records to skip. RecordsToTake—Number of records to return.

Response Parameters

ProgramDetailsstring

List of Program details found. For each Program details the following parameters are allowed: ProgramID—Program ID

PaginationTotalstring

Returned if successful Returned pagination result including total number of records available. Allowed parameters are: RecordsToSkip—Number of records skipped
RecordsToTake—Number of records returned
RecordsTotal—Total number of records in the underlying data set

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Programs/UpdateProgram

{
    "UpdateProgram": {
        "request": {
            "IssuerAccountNumber": "SPN Account Number",
            "ProgramID":"Program ID",
            "Description":"Program Name",
            "TransactionCategoryID":"Use 'ProgramCategory' to get Program Category ID",
            "TransactionSubCategoryID":"Use 'ProgramType' to get Program Sub Category ID",
            "IsClaim":boolean
            "ClaimAmount":"Claim Amount",
            "CurrencyCode":"Currency Code",
        }
    }
}

						

Sample Response:


{
	"UpdateProgramsResponse": {
		"UpdateProgramsResult": {
			"ProgramID": "2316",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}