API reference · QuickBooks v1
POST/api/v1/integrations/quickbooks/payments/sync

Sync payments

Synchronizes payment records between Alga and QuickBooks. Both /api/v1/integrations/quickbooks/* and /api/v1/quickbooks/* map to the same ApiQuickBooksController method (syncPayments). This family uses route handlers that instantiate ApiQuickBooksController and usually wrap calls in explicit try/catch handleApiError blocks.

RBAC · quickbooks

Request body

Content type: application/json · schema QuickBooksV1PaymentSyncBody

payment_idstring <uuid>
invoice_idstring <uuid>
date_rangeobject
start_datestringRequired
end_datestringRequired
sync_typestring
Enum: createupdatebidirectional
include_unappliedboolean

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.