201Successful Response
Schema: SuccessEnvelope_ReceivablesPushResponse_
successbooleanmessagestringcodestringdataReceivablesPushResponse
/api/v1/credit/receivablesName 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 invoices by invoice_id (customer, amount, issued, due and paid dates). revenue_concentration_top_customer reads them when the merchant has no DayZero invoices (evidence.source: partner_receivables): the top customer's share of the last 365 days' invoiced total, void invoices left out.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Schema: ReceivablesPushRequest
program_idstringYour program the merchant is applying under. Required without credit_line_id; with it, must be the line's program if sent.
external_merchant_idstringYour id for the merchant, as on POST /credit/bank-feeds and POST /credit/lines. Required without credit_line_id.
credit_line_idstringThe merchant's open line, when there is one.
merchant_legal_namestringNames the merchant's DayZero business when this call creates it. Ignored when the business exists.
merchant_business_idstringThe 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.
invoicesarray · ReceivableItemrequiredReceivableItemInvoices to add or update. Invoices not sent are kept; send one with status: void to take it out.
invoice_idstringrequiredYour stable id for the invoice; sending it again updates it.
customer_idstringrequiredYour stable id for the customer billed.
customer_namestringThe customer's name.
amount_centsintegerrequiredThe invoice total, in cents.
currencystringrequiredISO 4217 currency.
issued_onstring · daterequiredWhen it was issued.
due_onstring · dateWhen it falls due.
paid_onstring · dateWhen it was paid in full, if it has been.
statusstringvoid leaves it out of revenue. Defaults to paid with paid_on, else open.
Schema: SuccessEnvelope_ReceivablesPushResponse_
successbooleanmessagestringcodestringdataReceivablesPushResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.