{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/ad-spend","version":"1.0.0","description":"Push a merchant's daily ad spend"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/ad-spend":{"post":{"tags":["credit"],"summary":"Push a merchant's daily ad spend","description":"Name the merchant as on `POST /credit/bank-feeds` (`program_id` and `external_merchant_id`, or `credit_line_id`); DayZero uses its business, creating it the first time, and gives your token read access to it. Upserts one row per `platform` (`meta`, `google`, `tiktok`, `other`), ad account and day; sending a day again replaces it. `covered_from`..`covered_through` is the window your figures are complete for (a day in it without a row is no spend), explicitly attested across all platforms and accounts. Only overlapping or adjacent complete windows merge; gaps remain unknown. Row-only pushes never extend completeness. `trailing_12m_ad_spend`, the ad-spend ratios and `marketing_efficiency_ratio_90d` read this spend before the ledger (`evidence.source: partner_ad_spend`) while the window covers 90% of their actual days and the latest complete day is no more than 3 days old. Spend in another currency than the books' is kept, not counted. Changing an existing account/day currency or source operator returns 409.","operationId":"push_credit_ad_spend","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdSpendPushRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_AdSpendPushResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict - Resource already exists or is in an incompatible state","content":{"application/json":{"example":{"error":"conflict","message":"Resource already exists","code":"CONFLICT_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"push_credit_ad_spend_api_v1_credit_ad_spend_post"}}},"components":{"schemas":{"AdSpendDayItem":{"properties":{"platform":{"type":"string","enum":["meta","google","tiktok","other"],"title":"Platform","description":"Where the ads were bought."},"spent_on":{"type":"string","format":"date","title":"Spent On","description":"The day the spend is for."},"spend_cents":{"type":"integer","minimum":0.0,"title":"Spend Cents","description":"What was spent that day, in cents."},"currency":{"type":"string","pattern":"^[A-Za-z]{3}$","title":"Currency","description":"ISO 4217 currency. Spend in another currency than the merchant's books is kept but not counted (never converted)."},"account_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Account Id","description":"Your id for the ad account, when the platform has several. Leave it out for one figure per platform and day."}},"additionalProperties":false,"type":"object","required":["platform","spent_on","spend_cents","currency"],"title":"AdSpendDayItem","description":"One day's spend on one ad platform (or one of its ad accounts)."},"AdSpendPushRequest":{"properties":{"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id","description":"Your program the merchant is applying under. Required without `credit_line_id`; with it, must be the line's program if sent."},"external_merchant_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"External Merchant Id","description":"Your id for the merchant, as on `POST /credit/bank-feeds` and `POST /credit/lines`. Required without `credit_line_id`."},"credit_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line Id","description":"The merchant's open line, when there is one."},"merchant_legal_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Merchant Legal Name","description":"Names the merchant's DayZero business when this call creates it. Ignored when the business exists."},"merchant_business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Business Id","description":"The merchant's existing DayZero business, when your token can reach it. Leave it out and DayZero uses the business the merchant was linked to before, or creates one."},"days":{"items":{"$ref":"#/components/schemas/AdSpendDayItem"},"type":"array","maxItems":5000,"title":"Days","description":"Daily spend rows. Sending a day again replaces it. A day with no spend can be left out when the coverage window covers it."},"covered_from":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Covered From","description":"First day of an explicit complete window across all platforms and accounts. Supply both bounds to attest omitted days as zero. Row-only pushes do not establish completeness."},"covered_through":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Covered Through","description":"Last day of the explicit complete window. Disjoint windows retain their gaps. Completeness must reach within 3 days of measurement."}},"additionalProperties":false,"type":"object","title":"AdSpendPushRequest","description":"Daily ad spend, upserted by platform, account and day."},"AdSpendPushResponse":{"properties":{"merchant_business_id":{"type":"string","title":"Merchant Business Id","description":"The merchant's DayZero business."},"merchant_business_created":{"type":"boolean","title":"Merchant Business Created","description":"Whether this call created the business.","default":false},"days_written":{"type":"integer","title":"Days Written","description":"Rows inserted or replaced by this push."},"covered_from":{"type":"string","format":"date","title":"Covered From","description":"Earliest observed or attested date; not proof of continuous coverage."},"covered_through":{"type":"string","format":"date","title":"Covered Through","description":"Latest observed or attested date; not proof of continuous coverage."},"other_currency_days":{"type":"integer","title":"Other Currency Days","description":"Rows in this push not in the books' currency (not counted).","default":0},"declared_at":{"type":"string","format":"date-time","title":"Declared At","description":"When this push landed, UTC."}},"type":"object","required":["merchant_business_id","days_written","covered_from","covered_through","declared_at"],"title":"AdSpendPushResponse","description":"What DayZero now holds of the merchant's ad spend."},"SuccessEnvelope_AdSpendPushResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/AdSpendPushResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[AdSpendPushResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}