Get a merchant's brand
BuildingIn development for the v1 API. The contract is set; the route is not served yet.
Returns the brand heru applies to the merchant's invoicing page and emails: each field is the merchant's own value or, when it set none, its company's, then its organization's. sources says where each field comes from; default means heru's own (the field is null).
Needs the branding:read scope.
oauth2 branding:readAuthorizationBearer <token>OAuth 2.0 client credentials. Exchange your client_id and client_secret at /oauth/token of the environment for a bearer token valid for one hour. The playground of every operation asks for your own client and keeps it in your browser tab only.
Scope: branding:read
id*stringThe merchant id.
^mer_[0-7][0-9a-hjkmnp-tv-z]{25}$OK
application/json- response
merchant_id*string^mer_[0-7][0-9a-hjkmnp-tv-z]{25}$display_name*|Name on the invoicing page and in the emails. Null: the merchant's trade name, or its legal name.
logo*|Null: heru's logo.
primary_color*|Accent colour. Null: heru's. Text on it is white or dark, whichever reads, so any colour is safe.
^#[0-9A-F]{6}$support_email*|Help line of the page and the emails. Null: heru's support mailbox.
emailfooter_text*|Footer of the page and the emails. Null: none.
sources*Which level decided each field: the merchant itself, its company, its organization, or heru's default.
curl -X GET 'https://api.dev.b2b.heru.app/v1/branding/merchants/mer_01m4xnvf23ecb963n48h2j9vxz'{ "merchant_id": "mer_01m4xnvf23ecb963n48h2j9vxz", "display_name": "Clínica Dental Roma", "logo": { "url": "https://invoice.heru.app/assets/logo/3f5c0a9d7e2b4c6a8f1e0d3b5a7c9e2f4b6d8a0c1e3f5a7b9d0c2e4f6a8b0c1d.png", "content_type": "image/png", "width": 480, "height": 160 }, "primary_color": "#0E7C86", "support_email": "contacto@clinica-dental-roma.example", "footer_text": null, "sources": { "display_name": "merchant", "logo": "merchant", "primary_color": "merchant", "support_email": "merchant", "footer_text": "default" }}Remove a merchant's logoDEL
Removes the merchant's own logo; its page and emails show its company's again (or none). Removing a logo that is not there is a `204` too. Emails already sent keep showing the old logo. Needs the `branding:write` scope.
Monthly retentions reportGET
Per worker and month: gross amounts, VAT and ISR withheld and the certificates that back them. The basis for your monthly informative return (DIAT). Needs the `reports:read` scope.