Hydda One API

The HTTP API an Application or an integration connector uses to work with an organization on Hydda One. Every request carries an access token from the token endpoint on the identity host.

Operational contexts

The parts of the organization a token can act in. Start here.

• GET
  List the operational contexts the token can act in/v1/operational-contexts

Booking

Sell bookable resources on your own website: list them, read their free time and request bookings an operator approves.

• GET
  List the resources the Application may sell/v1/booking/resources
• GET
  Get one resource the Application may sell/v1/booking/resources/{resourceId}
• GET
  Read a resource's free time/v1/booking/resources/{resourceId}/availability
• GET
  List the extras a resource sells/v1/booking/resources/{resourceId}/add-on-products
• POST
  Look up a company by organisation number/v1/booking/company-lookups
• POST
  Price a booking before requesting it/v1/booking/booking-requests/preview
• POST
  Request a booking for a guest/v1/booking/booking-requests
• GET
  Get a booking request/v1/booking/booking-requests/{bookingId}

Billing

Connect an ERP or invoicing service: send approved invoices and report what happened to them.

• GET
  List approved invoices ready to send/v1/billing/send-queue
• GET
  List invoice proposals awaiting verification/v1/billing/verification-queue
• POST
  Pass an invoice proposal/v1/billing/invoice-proposals/{proposalId}/pass
• POST
  Reject an invoice proposal/v1/billing/invoice-proposals/{proposalId}/reject
• POST
  Report an invoice sent/v1/billing/invoices/{invoiceId}/report-sent
• POST
  Report an invoice that could not be sent/v1/billing/invoices/{invoiceId}/report-failed
• POST
  Report a payment on an invoice/v1/billing/invoices/{invoiceId}/report-payment
• POST
  Report a payment taken back/v1/billing/invoices/{invoiceId}/report-payment-reversed
• POST
  Report a write-off on an invoice/v1/billing/invoices/{invoiceId}/report-write-off
• GET
  List deleted invoices you may still hold/v1/billing/withdrawal-queue
• POST
  Report a deleted invoice discarded/v1/billing/invoice-withdrawals/{invoiceId}/report-discarded
• POST
  Report a payment by your own invoice id/v1/billing/invoices/by-external-reference/{externalReference}/report-payment
• POST
  Report a payment reversal by your own invoice id/v1/billing/invoices/by-external-reference/{externalReference}/report-payment-reversed

Signing

Connect an e-signing service: send contracts out for signature and report the outcome.

• GET
  List contracts waiting to be sent for signature/v1/crm/signing-queue
• GET
  List signing attempts the operator wants withdrawn/v1/crm/withdrawal-queue
• POST
  Report that the document is out for signature/v1/crm/signing-attempts/{attemptId}/started
• POST
  Get an upload address for the signed PDF/v1/crm/signing-attempts/{attemptId}/signed-document-upload
• POST
  Report that every party signed/v1/crm/signing-attempts/{attemptId}/signed
• POST
  Report that a party declined to sign/v1/crm/signing-attempts/{attemptId}/declined
• POST
  Report that the document expired unsigned/v1/crm/signing-attempts/{attemptId}/expired
• POST
  Report that the document was cancelled/v1/crm/signing-attempts/{attemptId}/withdrawn
• POST
  Report that the document could not be created/v1/crm/signing-attempts/{attemptId}/failed

Integrations

Read your own configuration as an installed integration and report when it is ready.

• GET
  List your installation's configurations/v1/integrations/configurations
• POST
  Redeem a connection reference from your setup address/v1/integrations/connection-references/redeem
• POST
  Report a configuration as ready/v1/integrations/configurations/{configurationId}/ready
• POST
  Report a configuration as failed/v1/integrations/configurations/{configurationId}/failed