Skip to content

Credits

Endpoints for querying credit statements and movements for clients and suppliers.

Statements

Client credit summary

GET /credits/client/:businessPartnerId/summary

Supplier credit summary

GET /credits/supplier/:businessPartnerId/summary

Detailed client statement

GET /credits/client/:businessPartnerId/statement
ParameterTypeDescription
startDatestringStart date (YYYY-MM-DD)
endDatestringEnd date (YYYY-MM-DD)

Detailed supplier statement

GET /credits/supplier/:businessPartnerId/statement

Movements

Client movements

GET /credits/client/:businessPartnerId/movements

Supplier movements

GET /credits/supplier/:businessPartnerId/movements

Credit limits

Credit limits are configured per business partner via credit_limit. When a client exceeds their limit, the system can warn or block new sales depending on company settings.