- 03 May 2023
- 2 Minutes To Read
- Print
- DarkLight
- PDF
End of Day Processing Configuration
- Updated On 03 May 2023
- 2 Minutes To Read
- Print
- DarkLight
- PDF
End of Day (EOD) processing refers to the daily and hourly jobs that are executed usually at the end of each day in order to manage the data in your system properly. For more information about this topic, see End of Day Processing and Cron Jobs.
With Configuration as Code (CasC), you may batch configure your End of Day Processing configuration via the API using YAML. For general information on CasC, see Configuration as Code Overview.
API Operations
CasC for end of day processing supports two operations.
Action | Endpoint | Description |
---|---|---|
GET | /configuration/endofdayprocessing.yaml | Get current end of day processing configuration. |
PUT | /configuration/endofdayprocessing.yaml | Write a new end of day processing configuration to Mambu. |
If you PUT
a configuration to Mambu, any optional configuration settings not included in the new YAML configuration will be deleted. PATCH
requests are not currently supported.
Requests
For general information on CasC requests such as authentication and required headers, see Configuration as Code Overview.
The following section shows sample requests using curl and basic authentication. For all examples, replace TENANT_NAME
with your actual tenant name.
GET configuration
curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/endofdayprocessing.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'
{auth} is the base-64-encoded value of username:password
. For more information, see Authentication in our API reference.
If your endOfDayProcessingMethod
is set to MANUAL
then the configuration you will retrieve will not have the accountingCutOffTime
specified.
PUT configuration
curl -X PUT 'https://TENANT_NAME.mambu.com/api/configuration/endofdayprocessing.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Content-Type: application/yaml' \
-H 'Authorization: Basic {auth}' \
--data-binary @endofdayprocessing.yaml
{auth} is the base-64-encoded value of username:password
. For more information, see Authentication in our API reference.
@endofdayprocessing.yaml
represents the absolute path of the file on your device.
(Use “--data-raw” if you want to specify the YAML body inline).
Configuration examples
---
endOfDayProcessingMethod: "AUTOMATIC"
accountingCutOffTime: "10:00:00"
The Accounting Cut-Off feature is an Early Access feature. If this feature is not enabled you will only be able to specify the accounting cut-off time via the API and not in the UI. For more information, see Scheduling Accounting Cut-Off and EOD processing time.
Attributes
Name | Type | Description | Required |
---|---|---|---|
endOfDayProcessingMethod | String | The end of the day processing method. The options are AUTOMATIC or MANUAL . | ✔ |
accountingCutOffTime | String | The accounting cut-off time. The format is hh:mm:ss . | Required if endOfDay ProcessingMethod is AUTOMATIC , otherwise it is optional. |
Replies
If you do not receive a 200 OK
status code then fix any validation errors and make another PUT
request until you receive a 200 OK
status code.
If you PUT
a valid YAML configuration to the API and you do not receive a 200 OK
status code within 60 seconds, you may receive a 504 Gateway Timeout
status code. We expect all responses to be below 60 seconds.
If you encounter this issue, please contact us through Mambu Support so we can investigate it.