Account Operations
Below section describes error response codes from Client-API for different account services like ledger, restructure etc.
- Error Response: POST/v1/{clientId}/match_account_payment
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. currency 2. totalAmount 3. matchStrategy 4. accountReference | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 400 Bad Request | Wrong values in JSON payload | Check enumerated value for -matchStrategy → * ORDERED_LEDGER_ENTRIES * ORDERED_INVOICES_WITH_FEES_THEN_ACCOUNT_ENTRIES * ACCOUNT_ENTRIES_THEN_ORDERED_INVOICES_WITH_FEES * CUSTOM_ORDERED_FEES | |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference |
- Error Response: POST/v1/{clientId}/restructure_account_overdue_invoices
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. amounts 2. frequency → days + weeks + months 3. intialDueDate 4. accountReference | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference |
- Error Response: POST/v1/{clientId}/discard_restructure_account_overdue_invoices
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. accountReference | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference |
- Error Response: POST/v1/{clientId}/resolve_restructure_account_overdue_invoices
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check mandatory fields are part of payload -Mandatory values are 1. accountReference | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference |
- Error Response: POST/v1/{clientId}/request_account_discount
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check header fields are part of payload Mandatory values are 1. accountReference -Check JSON fields are part of payload Mandatory values are 1. discounts → type 2. discounts → current 3. discounts → discount 4. discounts → discountApplied 5. discounts → ledgerEntryReference | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference |
- Error Response: GET/v1/{clientId}/get_account_discount_requests
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check header fields are part of payload Mandatory values are 1. accountReference | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference |
- Error Response: POST/v1/{clientId}/discard_account_discount
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check fields are part of payload Mandatory values are 1. accountReference 2. discountIds | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is invalid. Check the field mentioned for invalid resource 1. accountReference 2. discountIds |
- Error Response: POST/v1/{clientId}/resolve_account_discount
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check fields are part of payload Mandatory values are 1. accountReference 2. discountId | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is invalid. Check the field mentioned for invalid resource 1. accountReference 2. discountId |
- Error Response: POST/v1/{clientId}/prolong_account_outstanding_invoices
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check fields are part of payload Mandatory values are 1. accountReference 2. days | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is invalid. Check the field mentioned for invalid resource 1. accountReference |
- Error Response: POST/v1/{clientId}/discard_prolong_account_outstanding_invoices
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check fields are part of payload Mandatory values are 1. accountReference 2. prolongationClaimReferences | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is invalid. Check the field mentioned for invalid resource 1. accountReference 2. prolongationClaimReferences |
- Error Response: POST/v1/{clientId}/resolve_prolong_account_outstanding_invoices
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check fields are part of payload Mandatory values are 1. accountReference 2. prolongationClaimRef | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
| 200 OK Transaction status: failed | Invalid ID/s | -Entity is invalid. Check the field mentioned for invalid resource 1. accountReference 2. prolongationClaimRef |
- Error Response: GET/v1/{clientId}/get_account_mandates
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check url params fields are part of payload Mandatory values are 1. accountReference | {"message": "Missing required request parameters: [accountReference]"} |
| 200 OK Empty response payload | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference | Empty response [] |
- Error Response: POST/v1/{clientId}/set_account_prolongation _fee_strategy
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check fields are part of payload Mandatory values are 1. prolongationFeeStrategyConditions → amount/lessOrEqualToDays | {"messages":["body/['<entityId>'] should have required property '<field>'"],"messageIds":[],"success":false} |
- Error Response: GET/v1/{clientId}/get_account_prolongation_requests
| HTTP Status Code | Meaning | Resolution Tip | Error Response |
| 400 Bad Request | Missing values in JSON payload | -Check url params fields are part of payload Mandatory values are 1. accountReference | {"message": "Missing required request parameters: [accountReference]"} |
| 200 OK Empty response payload | Invalid ID/s | -Entity is wrong. Check the field mentioned for invalid resource 1. accountReference | Empty response [] |