API reference · QuickBooks v1
PUT/api/v1/quickbooks/mappings/{mapping_id}

Update data mapping

Updates one data mapping configuration by mapping_id. Both /api/v1/integrations/quickbooks/* and /api/v1/quickbooks/* map to the same ApiQuickBooksController method (updateDataMapping). This family is a path alias that binds controller methods directly (for example `export const GET = controller.getAccounts()`) and relies on controller-level error handling.

RBAC · quickbooks

Path parameters

mapping_idstringRequired
Mapping identifier extracted from path segment mapping_id.

Request body

Content type: application/json · schema QuickBooksV1DataMappingBody

entity_typestringRequired
Enum: customerinvoicepaymentitemtax_code
mapping_namestringRequired
field_mappingsarray of objectRequired
min items 1
itemsobject
alga_fieldstringRequired
qbo_fieldstringRequired
transform_functionstring
is_requiredboolean
default_valueany
validation_rulestring
is_defaultboolean
descriptionstring

Response body

Success response 200 · schema QuickBooksV1ApiSuccess

dataanyOfRequired
anyOf (option 1)object
anyOf (option 2)array of object
itemsobject
metaobject

Response codes

200
QuickBooks operation succeeded.
400
Validation or request parsing failure.
401
API key missing/invalid or associated user missing.
403
QuickBooks RBAC permission denied.
500
Unexpected QuickBooks endpoint failure.