Skip to content
Hydda One API
Esc
↑↓navigate↵open⌘Jpreview

List approved invoices ready to send

Poll this to find approved invoices whose requested invoice date has come, oldest approval first. Each item holds everything needed to issue the invoice in your ERP. An invoice stays on the queue until you report it sent or failed, so a retry after a crash returns it again. Refused with 400 when the organization has no invoicing integration that handles sending.

GET/v1/billing/send-queue
Authorization
AuthorizationOAuth2 access token · headerrequired

An access token for an Application, from the client_credentials grant. An installed connector gets its token from the installation-token grant instead. Send it as Authorization: Bearer <token>.

Query parameters
limitinteger

The most items to return, from 1 to 200. Defaults to 50.

max 200
Responses
200

The invoices ready to send.

itemsobject[]required

Up to limit invoices, oldest approval first. Empty when there is nothing to send.

Show properties
Array of object
invoiceobjectrequired

An approved invoice, with the company it belongs to.

Show properties
idstring<uuid>required

The invoice id. Report outcomes against it.

invoiceRunIdstring<uuid>required

The invoice run that created the invoice.

organizationIdstring<uuid>required

The organization the invoice belongs to.

operationalContextIdstring<uuid>required

The operational context the invoice was created in.

contractIdstring<uuid>required

The contract the invoice bills.

recipientAgentIdstring<uuid>required

The customer the invoice bills.

recipientAgentNamestringrequired

The customer's name as written on the invoice.

billingAccountIdstring<uuid>required

The billing account the invoice is sent to.

documentKindstringrequired

Whether the document is an invoice or a credit note. A credit note names the invoice it credits.

Allowed:invoicecredit-note
creditedInvoiceIdstring<uuid>

On a credit note, the invoice it credits. Absent on an invoice.

billingStreamstringrequired

Where the charges come from: contractual for the contract's own products, running for purchases beside it, such as bookings.

Allowed:contractualrunning
requestedInvoiceDatestring<date>required

The invoice date to issue with, as an ISO date (YYYY-MM-DD).

requestedDueDatestring<date>

The due date to issue with, as an ISO date. Absent on a credit note.

paymentTermsDaysinteger

The payment terms in days that give the requested due date. Absent on a credit note.

min 0 · max 9007199254740991
invoiceNumberintegerrequired

Everest's own number for the invoice. The legal number is issuedInvoiceNumber.

max 9007199254740991
statusstringrequired

Where the invoice is in its life. failed is reached only by a failure report, and written-off is settled like paid with at least one write-off.

Allowed:createdapprovedsentpaidwritten-offfailed
currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP
totalNetMinorUnitsintegerrequired

The total excluding VAT, in minor units. Negative on a credit note.

min -9007199254740991 · max 9007199254740991
totalVatMinorUnitsintegerrequired

The total VAT, in minor units.

min -9007199254740991 · max 9007199254740991
totalGrossMinorUnitsintegerrequired

The total including VAT as Everest computed it, in minor units.

min -9007199254740991 · max 9007199254740991
externalReferencestring

Your own id for the invoice. Absent until you attach one, by passing its proposal or reporting it sent.

issuedInvoiceNumberstring

The legal invoice number your ERP issued. Absent until the invoice is reported sent.

issuedInvoiceDatestring<date>

The date your ERP issued the invoice, as an ISO date. Absent until reported sent.

dueDatestring<date>

The due date the invoice was issued with, as an ISO date. Absent until reported sent.

issuedTotalGrossMinorUnitsinteger

The total including VAT your ERP issued, in minor units. Payments are measured against it. Absent until reported sent.

min -9007199254740991 · max 9007199254740991
paymentReferencestring

The reference the payer quotes, as reported with the send.

paymentReferenceTypestring

The system the payment reference belongs to: ocr for a Swedish OCR number, kid for a Norwegian KID number, reference for a free reference.

Allowed:ocrkidreference
documentUrlstring

The link to the issued document, as reported with the send.

balanceMinorUnitsinteger

What is left to pay, in minor units: the issued total less payments and write-offs. Below zero after an overpayment. Absent until reported sent.

min -9007199254740991 · max 9007199254740991
overduebooleanrequired

True when the invoice is sent and its due date has passed.

approvedAtstring<date-time>

When the invoice was approved, as an ISO 8601 timestamp in UTC.

sentAtstring<date-time>

When the invoice was reported sent, as an ISO 8601 timestamp in UTC.

paidAtstring<date-time>

When the invoice was settled as paid, as an ISO 8601 timestamp in UTC.

writtenOffAtstring<date-time>

When the invoice was settled as written off, as an ISO 8601 timestamp in UTC.

failedAtstring<date-time>

When the invoice was reported failed, as an ISO 8601 timestamp in UTC.

failureReasonstring

Why sending failed, as it was reported.

createdAtstring<date-time>required

When the invoice was created, as an ISO 8601 timestamp in UTC.

updatedAtstring<date-time>required

When the invoice last changed, as an ISO 8601 timestamp in UTC.

businessContextIdstring<uuid> | nullrequired

The company the document belongs to. Choose the ERP account by it. Null when unknown: refuse the document rather than guess a company.

linesobject[]required

The invoice lines, in position order.

Show properties
Array of object
idstring<uuid>required

The line id.

positionintegerrequired

The line's place on its document, starting at 1. It never changes once written.

max 9007199254740991
chargeLineIdstring<uuid>

The charge this line bills. A correction line names it in correctsChargeLineId.

correctsChargeLineIdstring<uuid>

On a correction line, the charge it corrects. Match it to the other line's chargeLineId.

correctsPositioninteger

On a correction line, the position of the line it corrects: on this document, or on the credited invoice for a credit note. Absent when that line is on an earlier invoice.

max 9007199254740991
labelstringrequired

The line text, at most 128 characters.

quantitystringrequired

The quantity as a decimal string, such as 1 or 2.5, so a fraction stays exact.

unitPriceMinorUnitsintegerrequired

The agreed price per unit, in minor units, before any discount.

min -9007199254740991 · max 9007199254740991
amountMinorUnitsintegerrequired

The line total excluding VAT and after any discount, in minor units.

min -9007199254740991 · max 9007199254740991
currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP
vatRateBasisPointsintegerrequired

The VAT rate in basis points: 2500 is 25%.

min 0 · max 9007199254740991
vatTreatmentstring

Why a line is taxed at 0%: exempt when the supply is exempt from VAT, reverseCharge when the buyer accounts for the VAT.

Allowed:exemptreverseCharge
discountobject

What was taken off a line. The line's amount is already net of it, so the amount before discount is the line amount plus this amount.

Show properties
One of:
object
kindstringrequired

A fixed amount off.

Allowed:fixed
amountMinorUnitsintegerrequired

The amount taken off, in minor units of the line's currency. Can be negative on a correction or credit note line.

min -9007199254740991 · max 9007199254740991
labelstring

Why the discount was given, 1 to 128 characters.

min length 1 · max length 128
object
kindstringrequired

A percentage off.

Allowed:percent
basisPointsintegerrequired

The discount rate in basis points, from 1 to 10000: 1000 is 10%.

min 1 · max 10000
amountMinorUnitsintegerrequired

The amount taken off, in minor units of the line's currency. Can be negative on a correction or credit note line. Not recomputed from the rate, since a partial period changes it.

min -9007199254740991 · max 9007199254740991
labelstring

Why the discount was given, 1 to 128 characters.

min length 1 · max length 128
postingobject

Where a line is booked in the operator's ledger. Every code is optional, and none is checked against a chart of accounts.

Show properties
salesAccountstring

The revenue account the line is booked on, 1 to 32 characters.

min length 1 · max length 32
costCentrestring

The cost centre the line is attributed to, 1 to 32 characters.

min length 1 · max length 32
discountAccountstring

The account the line's discount is booked on, apart from its sales. When set, book the discount as its own row.

min length 1 · max length 32
quantityUnitstring

What one unit of the quantity is, such as an hour or a month.

Allowed:piecehourdaynightmonthsession
periodStartstring<date>required

The first day of service the line covers, as an ISO date (YYYY-MM-DD).

periodEndstring<date>required

The last day of service the line covers, inclusive, as an ISO date.

cycleStartstring<date>

On a recurring charge, the first day of the billing cycle it pays for. Absent otherwise.

cycleEndstring<date>

On a recurring charge, the last day of the billing cycle it pays for. Absent otherwise.

skustringrequired

The product code of what the line bills.

producingDomainstringrequired

The Everest module that raised the charge.

originatingEntityTypestringrequired

The kind of record that raised the charge.

originatingEntityIdstring<uuid>required

The id of the record that raised the charge.

accountingobjectrequired

The operator's own accounting values, keyed by the field keys the operator defined. Empty when there are none.

vatSubtotalsobject[]required

The VAT totals, one per VAT rate and VAT treatment.

Show properties
Array of object
vatRateBasisPointsintegerrequired

The VAT rate in basis points: 2500 is 25%.

min 0 · max 9007199254740991
vatTreatmentstring

Why a line is taxed at 0%: exempt when the supply is exempt from VAT, reverseCharge when the buyer accounts for the VAT.

Allowed:exemptreverseCharge
netMinorUnitsintegerrequired

The sum of the line amounts at this rate, excluding VAT, in minor units.

min -9007199254740991 · max 9007199254740991
vatMinorUnitsintegerrequired

The VAT at this rate, in minor units.

min -9007199254740991 · max 9007199254740991
recipientobjectrequired

The customer the document bills and how to deliver it. It is fixed when the document is written, so later account changes do not reach it.

Show properties
agentNamestringrequired

The customer's name as written on the document.

agentTypestringrequired

Whether the customer is a company or a private household of one or more people.

Allowed:companyprivate
identifiersobject[]required

What the invoiced party is identified by: a company account's own identifiers, else its company's, or a household's primary person's. Keep personal identity numbers out of logs.

Show properties
Array of object
schemestringrequired

The identifier system: se-orgnr a Swedish organisation number, se-personnummer a Swedish personal identity number, se-samordningsnummer a Swedish coordination number, eu-vat an EU VAT number.

Allowed:se-orgnrse-personnummerse-samordningsnummereu-vat
valuestringrequired

The number, in the canonical form of its scheme.

contactNamestring

The contact person at the customer. Always present for a company.

defaultInvoiceReferencestring

The customer's own reference to print on the invoice, such as a purchase order number or a cost centre.

invoiceAddressobjectrequired

The postal address an invoice is issued to.

Show properties
careOfstring

A c/o line.

min length 1 · max length 200
streetstringrequired

The street address.

min length 1 · max length 200
street2string

A second street line.

min length 1 · max length 200
postalCodestringrequired

The postal code.

min length 1 · max length 20
citystringrequired

The city.

min length 1 · max length 100
countrystringrequired

An ISO 3166-1 alpha-2 country code, for example SE.

Allowed:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
deliveryMethodstringrequired

How the customer receives invoices: as an e-invoice, by email or by post.

Allowed:e-invoiceemailpost
billingEmailstring

The email address to send the invoice to. Present exactly when deliveryMethod is email.

eInvoiceAddressobject

Where an e-invoice is addressed.

Show properties
schemestringrequired

The identifier system of an e-invoice address: gln a GS1 location number, peppol a Peppol participant id, ovt a Finnish OVT number, vat a VAT number.

Allowed:glnpeppolovtvat
valuestringrequired

The identifier in that system. A gln is 13 digits. A peppol id is four digits, a colon, then the identifier.

min length 1 · max length 100
billingAccountIdstring<uuid>required

The billing account the recipient details were taken from.

agentIdstring<uuid>required

The customer's id.

customerNumberstring

The customer number people quote. Unique in the organization and never changes. Absent for some older customers.

400

The request is not valid, or a business rule refused it. code names the rule.

typestringrequired

Always about:blank.

titlestringrequired

The HTTP status phrase, for example Not Found.

statusintegerrequired

The HTTP status code.

min -9007199254740991 · max 9007199254740991
detailstring

What went wrong, for a person to read. Do not parse it.

codestring

Names the rule that refused the request. Match on this, not on detail.

Allowed:TWIN_NODE_NOT_FOUNDTWIN_OPERATIONAL_CONTEXT_NOT_DELETABLETWIN_NODE_SUBTREE_IN_USETWIN_OPENING_HOURS_SCHEDULE_LIMIT_REACHEDTWIN_OPENING_HOURS_SCHEDULE_NAME_ALREADY_EXISTSTWIN_OPENING_HOURS_SCHEDULE_NOT_FOUNDOPERATIONS_ISSUE_TRANSITION_INVALIDOPERATIONS_ISSUE_CLOSE_REASON_REQUIREDOPERATIONS_ISSUE_CONCURRENT_MODIFICATIONOPERATIONS_ISSUE_KEY_ALREADY_USEDOPERATIONS_PRIORITY_ARCHIVEDOPERATIONS_PRIORITY_KEY_ALREADY_EXISTSOPERATIONS_ISSUE_STATUS_ARCHIVEDOPERATIONS_ISSUE_STATUS_CATEGORY_WOULD_BE_EMPTYOPERATIONS_ISSUE_STATUS_REORDER_INCOMPLETEOPERATIONS_VOCABULARY_OWNER_INVALIDOPERATIONS_ISSUE_RULE_KIND_CONFLICTOPERATIONS_ISSUE_RULE_STATUS_NOT_IN_SETOPERATIONS_COMMENT_NOT_AUTHOROPERATIONS_COMMENT_NEEDS_CONTENTOPERATIONS_ATTACHMENT_REJECTEDOPERATIONS_ATTACHMENT_NOT_UPLOADEROPERATIONS_WORK_ORDER_DELEGATION_ACTIVEOPERATIONS_WORK_ORDER_NOT_DELETABLEOPERATIONS_WORK_ORDER_DEPENDENCY_CYCLEOPERATIONS_DELEGATION_STATUS_INVALIDOPERATIONS_DELEGATION_NOT_ENGAGED_PARTYOPERATIONS_DELEGATION_ROLE_CANNOT_ACTOPERATIONS_DISCIPLINE_LABEL_ALREADY_EXISTSOPERATIONS_DISCIPLINE_UNKNOWNOPERATIONS_DISCIPLINE_ARCHIVEDOPERATIONS_SUPPLIER_ROSTER_EMAIL_EXISTSTENANT_BILLING_ACCOUNT_PRIVATE_AGENT_HAS_ONETENANT_BILLING_ACCOUNT_DEFAULT_NOT_REMOVABLETENANT_BILLING_ACCOUNT_INCOMPLETETENANT_CONTRACT_BILLING_ACCOUNT_REQUIREDTENANT_UNIT_ALREADY_LEASEDTENANT_CONTRACT_TERMINATION_RETROACTIVETENANT_CONTRACT_TERMINATION_NOT_EARLIERTENANT_CONTRACT_TERMINATION_LOCKEDTENANT_CONTRACT_BILLING_TERMS_LOCKEDTENANT_CONTRACT_OWNER_NOT_BUSINESSTENANT_CONTRACT_LINE_OUTSIDE_OWNER_CONETENANT_CONTRACT_LINE_IN_USETENANT_CONTRACT_LINE_TERMINATEDTENANT_CONTRACT_LINE_NOT_SEATABLETENANT_CONTRACT_LINE_NO_ENABLEMENTTENANT_CONTRACT_LINE_SEAT_LIMIT_REACHEDTENANT_CONTRACT_LINE_AT_MINIMUM_SEATSTENANT_CONTRACT_SEAT_EMPTYTENANT_LEASABLE_UNIT_ALREADY_EXISTSTENANT_LEASABLE_UNIT_CONTEXT_INVALIDTENANT_PRODUCT_SKU_ALREADY_EXISTSTENANT_PRODUCT_RETIREDTENANT_PRODUCT_CONTEXT_INVALIDTENANT_PRODUCT_GRANT_DUPLICATETENANT_PRODUCT_GRANT_ENABLEMENT_MISMATCHTENANT_PRODUCT_GRANT_IS_HOMETENANT_PRODUCT_GRANT_SHADOWEDTENANT_PRODUCT_CATEGORY_NAME_ALREADY_EXISTSTENANT_PRODUCT_CATEGORY_RETIREDTENANT_PRODUCT_CATEGORY_VALUE_LOCKEDTENANT_AGENT_NOT_READYTENANT_USER_ALREADY_ON_ROSTERTENANT_AGENT_IDENTIFIER_ALREADY_USEDTENANT_AGENT_TYPE_MISMATCHTENANT_CUSTOMER_NUMBER_TAKENTENANT_CUSTOMER_NUMBER_INVALIDTENANT_SCHEME_DEFAULT_TIER_REQUIREDTENANT_SCHEME_TIER_ROLE_INVALIDTENANT_SCHEME_CONTEXT_TYPE_MISMATCHTENANT_SCHEME_NOT_ENABLED_HERETENANT_SCHEME_DEFAULT_TIER_NOT_PLACEABLETENANT_COMPANY_REGISTRY_NOT_SUPPORTEDTENANT_COMPANY_REGISTRY_UNAVAILABLEBILLING_INTEGRATION_NOT_CONFIGUREDBILLING_INTEGRATION_GATE_NOT_DECLAREDBILLING_EXTERNAL_REFERENCE_ALREADY_USEDBILLING_INVOICE_STATUS_INVALIDBILLING_PAYMENT_REPLAY_MISMATCHBILLING_PAYMENT_REVERSEDBILLING_PAYMENT_NOT_FOUNDBILLING_PAYMENT_AMOUNT_INVALIDBILLING_WRITE_OFF_REPLAY_MISMATCHBILLING_WRITE_OFF_AMOUNT_INVALIDBILLING_PROPOSAL_STATUS_INVALIDBILLING_PROPOSAL_MATERIAL_ALREADY_INVOICEDBILLING_CREDIT_NOTE_INVOICE_NOT_CREDITABLEBILLING_CREDIT_NOTE_NO_PENDING_CORRECTIONSBILLING_INVOICE_RUN_NOT_CONTINUABLEBILLING_CREDIT_EXCEEDS_LINEBILLING_CREDIT_EXCEEDS_INVOICEBILLING_CREDIT_WITHHELDBILLING_CREDIT_ACT_REPLAY_MISMATCHBILLING_MANUAL_CREDIT_VAT_RATE_UNKNOWNBILLING_CORRECTION_NOT_WITHDRAWABLECOMMUNITY_POST_COVER_REJECTEDCOMMUNITY_POST_ATTACHMENT_REJECTEDCOMMUNITY_POST_COVER_LIMIT_REACHEDCOMMUNITY_POST_ATTACHMENT_LIMIT_REACHEDCOMMUNITY_PROMOTION_IMAGE_LIMIT_REACHEDCOMMUNITY_VOUCHER_CODE_TAKENCOMMUNITY_PUBLISH_AT_NOT_FUTURECOMMUNITY_PINNED_UNTIL_NOT_FUTURECOMMUNITY_POST_NOT_SCHEDULEDCOMMUNITY_POST_NOT_PUBLISHEDCOMMUNITY_POST_NOT_UNPUBLISHEDCOMMUNITY_DRAFT_INCOMPLETECOMMUNITY_PROMOTION_INCOMPLETECOMMUNITY_PROMOTION_NOT_DRAFTCOMMUNITY_PROMOTION_NOT_SCHEDULEDCOMMUNITY_PROMOTION_NOT_ACTIVECOMMUNITY_PROMOTION_NOT_INACTIVECOMMUNICATIONS_ATTACHMENT_PENDING_LIMIT_EXCEEDEDCOMMUNICATIONS_ATTACHMENT_REJECTEDCOMMUNICATIONS_ATTACHMENT_NOT_CLAIMABLECOMMUNICATIONS_BROADCAST_SCHEDULED_AT_NOT_FUTURECOMMUNICATIONS_BROADCAST_NOT_SCHEDULEDCOMMUNITY_EVENT_FULLCOMMUNITY_EVENT_ATTENDEE_EXISTSCOMMUNITY_EVENT_CAPACITY_BELOW_ATTENDEESCOMMUNITY_POLL_CLOSEDCOMMUNITY_POLL_ALREADY_ANSWEREDBOOKING_SLOT_TAKENBOOKING_NO_COVERING_CONTRACTBOOKING_CONTRACT_ATTRIBUTION_AMBIGUOUSBOOKING_CONTRACT_NOT_A_CANDIDATEBOOKING_NO_SHARED_CONTRACTBOOKING_EXTERNAL_CONTRACT_NOT_BILLABLEBOOKING_EXTERNAL_CUSTOMER_NOT_FOUNDBOOKING_EXTERNAL_CUSTOMER_BILLING_ACCOUNT_REQUIREDBOOKING_EXTERNAL_BILLING_ACCOUNT_INCOMPLETEBOOKING_EXTERNAL_INVOICING_DETAILS_REQUIREDBOOKING_EXTERNAL_REQUIRES_APPROVALBOOKING_REQUEST_ID_ALREADY_USEDBOOKING_GUEST_LINK_INVALIDBOOKING_GUEST_LINK_NOT_RESENDABLEBOOKING_NOT_EXTERNALBOOKING_PRICE_RULE_AMBIGUOUSBOOKING_PRICE_RULE_NOT_APPLICABLEBOOKING_NOT_PENDING_APPROVALBOOKING_APPROVAL_WINDOW_PASSEDBOOKING_RESOURCE_IMAGE_REJECTEDBOOKING_RESOURCE_PURCHASE_TERMS_REJECTEDBOOKING_OUTSIDE_OPEN_HOURSBOOKING_DURATION_TOO_SHORTBOOKING_DURATION_TOO_LONGBOOKING_DURATION_NOT_ON_INCREMENTBOOKING_START_NOT_ON_INCREMENTBOOKING_WEEKLY_QUOTA_EXCEEDEDBOOKING_BUFFER_CONFLICTBOOKING_NOTICE_TOO_SHORTBOOKING_CANCELLATION_NOTICE_EXPIREDBOOKING_ALREADY_DELIVEREDBOOKING_NOT_CHARGEDBOOKING_ALREADY_STARTEDBOOKING_ACCESS_ALREADY_OPENBOOKING_NOT_RESCHEDULABLEBOOKING_TIME_SPEC_MODEL_MISMATCHBOOKING_SLOT_NOT_IN_SCHEDULEBOOKING_DATE_INTERVAL_EMPTYBOOKING_DATE_SPAN_EMPTYBOOKING_DATE_SPAN_REQUIRES_SESSION_PRICINGBOOKING_DATE_INTERVAL_REQUIRES_NIGHT_PRICINGBOOKING_NIGHT_PRICING_REQUIRES_DATE_INTERVALBOOKING_RESOURCE_BUFFER_NOT_ON_INCREMENTBOOKING_STAY_TOO_SHORTBOOKING_STAY_TOO_LONGBOOKING_UPLOAD_PENDING_LIMIT_EXCEEDEDBOOKING_IN_THE_PASTBOOKING_HORIZON_EXCEEDEDBOOKING_DURATION_CEILING_EXCEEDEDBOOKING_PARTICIPANTS_NOT_SUPPORTEDBOOKING_PARTICIPANT_NOT_SEATEDBOOKING_RESOURCE_PARTICIPANTS_GROUP_CONFLICTBOOKING_RESOURCE_CURRENCY_MISMATCHBOOKING_OPENING_HOURS_SCHEDULE_NOT_FOUNDBOOKING_RESOURCE_GROUP_OUTSIDE_CONTEXTBOOKING_ADD_ON_PRODUCT_IMAGE_REJECTEDBOOKING_ADD_ON_PRODUCT_RETIREDBOOKING_ADD_ON_PRODUCT_RESOURCE_OUTSIDE_CONTEXTBOOKING_ADD_ON_NOT_OFFEREDBOOKING_ADD_ON_DELIVERY_OUTSIDE_BOOKINGBOOKING_ADD_ON_DELIVERY_OUTSIDE_AVAILABILITYBOOKING_ADD_ON_ORDER_LEAD_TOO_SHORTBOOKING_ADD_ON_CUTOFF_PASSEDBOOKING_ADD_ON_SPECIAL_PORTIONS_INVALIDBOOKING_ADD_ON_LINE_LIMIT_EXCEEDEDBOOKING_ADD_ON_ON_INTERNAL_BOOKINGBOOKING_ADD_ON_LINE_NOT_FOUNDBOOKING_ADD_ON_LINE_DELIVEREDBOOKING_ADD_ON_LINE_NO_LONGER_FITSBOOKING_ROOM_LAYOUT_NOT_OFFEREDBOOKING_ROOM_LAYOUT_CUTOFF_PASSEDBOOKING_ROOM_LAYOUT_NOT_CHANGEABLEBOOKING_ROOM_SETUP_NOT_FOUNDACCESS_ACCESSY_CREDENTIALS_REJECTEDACCESS_ACCESSY_API_CLIENT_ALREADY_REGISTEREDACCESS_ACCESSY_API_CLIENT_MISSINGACCESS_GROUP_UNKNOWNACCESS_ACCESSY_UNAVAILABLEACCESS_SUBSCRIPTION_ALREADY_REGISTEREDACCESS_PHONE_MISSINGACCESS_ENROLLMENT_NOT_BEGUNACCESS_ENROLLMENT_EXPIREDACCESS_ENROLLMENT_REFUSEDACCESS_RECOVERY_KEY_REQUIREDACCESS_RECOVERY_KEY_INVALIDACCESS_ENROLLMENT_REQUIREDORGANIZATION_NOT_ENTEREDAUTH_PHONE_VERIFICATION_REQUIREDAUTH_PHONE_VERIFICATION_INVALIDAUTH_PHONE_VERIFICATION_THROTTLEDACCESS_GROUP_ALREADY_CONFIGUREDACCESS_GROUP_NOT_READYACCESS_DOOR_ALREADY_LINKEDACCESS_ASSET_NOT_PUBLISHEDACCESS_ACCESSY_REQUEST_REFUSEDCRM_CONTRACT_TEMPLATE_RETIREDCRM_PACKAGE_RETIREDCRM_PRODUCT_RETIREDCRM_PRODUCT_UNKNOWNCRM_AGENT_UNKNOWNCRM_CUSTOMER_CHOICE_INVALIDCRM_PROSPECT_MATCHES_AGENTCRM_CUSTOMER_IS_AGENTCRM_AGREEMENT_BILLING_DETAILS_REQUIREDCRM_AGREEMENT_BILLING_ACCOUNT_EXISTSCRM_AGREEMENT_BILLING_DETAILS_TYPE_MISMATCHCRM_AGREEMENT_BILLING_DETAILS_INCOMPLETECRM_ROW_ACCESS_TERMS_INVALIDCRM_DEAL_LOSTCRM_DEAL_ACCEPTEDCRM_DEAL_TRANSITION_INVALIDCRM_DEAL_BUSINESS_CONTEXT_INVALIDCRM_PACKAGE_BUSINESS_CONTEXT_INVALIDCRM_PACKAGE_BUSINESS_CONTEXT_MISMATCHCRM_PACKAGE_PRODUCT_DUPLICATECRM_PRODUCT_OUTSIDE_BUSINESS_CONTEXTCRM_ROWS_EMPTYCRM_ROWS_LIMITCRM_ROW_QUANTITY_INVALIDCRM_CURRENCY_MISMATCHCRM_OFFER_TOKEN_INVALIDCRM_OFFER_EXPIREDCRM_OFFER_ALREADY_ANSWEREDCRM_OFFER_INVALIDATEDCRM_AGREEMENT_TRANSITION_INVALIDCRM_AGREEMENT_LOCKEDCRM_AGREEMENT_CANCELLEDCRM_AGREEMENT_START_DATE_MISSINGCRM_LEASABLE_UNIT_OCCUPIEDCRM_SIGNED_DOCUMENT_REJECTEDCRM_SIGNING_NOT_AVAILABLECRM_CONTRACT_BODY_MISSINGCRM_CONTRACT_VALUES_MISSINGCRM_CONTRACT_VARIABLE_UNKNOWNCRM_CONTRACT_PLACEHOLDERS_OPENCRM_CONTRACT_RENDER_FAILEDCRM_SIGNING_ATTEMPT_LIVECRM_SIGNING_ATTEMPT_ENDEDCRM_SIGNER_BUSINESS_CONTEXT_INVALIDCRM_SIGNER_NOT_ELIGIBLECRM_SIGNER_ALREADY_ADDEDCRM_SIGNER_UNAVAILABLECRM_SIGNING_PARTY_REPEATEDAPPLICATION_SECRET_LIMIT_REACHEDAPPLICATION_SECRET_NOT_FOUNDVALIDATION_FAILEDINTEGRATIONS_APP_INVALIDINTEGRATIONS_APP_ALREADY_EXISTSINTEGRATIONS_APP_INSTALLEDINTEGRATIONS_APP_ALREADY_INSTALLEDINTEGRATIONS_CONSENT_MISMATCHINTEGRATIONS_ROLE_NOT_GRANTABLEINTEGRATIONS_CONTEXT_LEVEL_MISMATCHINTEGRATIONS_CONFIGURATION_INVALIDINTEGRATIONS_POINT_ALREADY_FILLEDINTEGRATIONS_CONFIGURATION_NOT_FOUNDINTEGRATIONS_CONNECTION_NOT_SUPPORTEDINTEGRATIONS_CONNECTION_REFERENCE_INVALIDASSISTANT_CONVERSATION_NOT_FOUNDASSISTANT_CONFIRMATION_NOT_PENDINGASSISTANT_TURN_LIMIT_REACHEDASSISTANT_RATE_LIMITEDASSISTANT_MODEL_FAILEDASSISTANT_TURN_INTERRUPTED
issuesobject[]

With VALIDATION_FAILED: one entry per field that failed validation, each with its path and message.

401

The access token is missing, expired or not valid.

typestringrequired

Always about:blank.

titlestringrequired

The HTTP status phrase, for example Not Found.

statusintegerrequired

The HTTP status code.

min -9007199254740991 · max 9007199254740991
detailstring

What went wrong, for a person to read. Do not parse it.

codestring

Names the rule that refused the request. Match on this, not on detail.

Allowed:TWIN_NODE_NOT_FOUNDTWIN_OPERATIONAL_CONTEXT_NOT_DELETABLETWIN_NODE_SUBTREE_IN_USETWIN_OPENING_HOURS_SCHEDULE_LIMIT_REACHEDTWIN_OPENING_HOURS_SCHEDULE_NAME_ALREADY_EXISTSTWIN_OPENING_HOURS_SCHEDULE_NOT_FOUNDOPERATIONS_ISSUE_TRANSITION_INVALIDOPERATIONS_ISSUE_CLOSE_REASON_REQUIREDOPERATIONS_ISSUE_CONCURRENT_MODIFICATIONOPERATIONS_ISSUE_KEY_ALREADY_USEDOPERATIONS_PRIORITY_ARCHIVEDOPERATIONS_PRIORITY_KEY_ALREADY_EXISTSOPERATIONS_ISSUE_STATUS_ARCHIVEDOPERATIONS_ISSUE_STATUS_CATEGORY_WOULD_BE_EMPTYOPERATIONS_ISSUE_STATUS_REORDER_INCOMPLETEOPERATIONS_VOCABULARY_OWNER_INVALIDOPERATIONS_ISSUE_RULE_KIND_CONFLICTOPERATIONS_ISSUE_RULE_STATUS_NOT_IN_SETOPERATIONS_COMMENT_NOT_AUTHOROPERATIONS_COMMENT_NEEDS_CONTENTOPERATIONS_ATTACHMENT_REJECTEDOPERATIONS_ATTACHMENT_NOT_UPLOADEROPERATIONS_WORK_ORDER_DELEGATION_ACTIVEOPERATIONS_WORK_ORDER_NOT_DELETABLEOPERATIONS_WORK_ORDER_DEPENDENCY_CYCLEOPERATIONS_DELEGATION_STATUS_INVALIDOPERATIONS_DELEGATION_NOT_ENGAGED_PARTYOPERATIONS_DELEGATION_ROLE_CANNOT_ACTOPERATIONS_DISCIPLINE_LABEL_ALREADY_EXISTSOPERATIONS_DISCIPLINE_UNKNOWNOPERATIONS_DISCIPLINE_ARCHIVEDOPERATIONS_SUPPLIER_ROSTER_EMAIL_EXISTSTENANT_BILLING_ACCOUNT_PRIVATE_AGENT_HAS_ONETENANT_BILLING_ACCOUNT_DEFAULT_NOT_REMOVABLETENANT_BILLING_ACCOUNT_INCOMPLETETENANT_CONTRACT_BILLING_ACCOUNT_REQUIREDTENANT_UNIT_ALREADY_LEASEDTENANT_CONTRACT_TERMINATION_RETROACTIVETENANT_CONTRACT_TERMINATION_NOT_EARLIERTENANT_CONTRACT_TERMINATION_LOCKEDTENANT_CONTRACT_BILLING_TERMS_LOCKEDTENANT_CONTRACT_OWNER_NOT_BUSINESSTENANT_CONTRACT_LINE_OUTSIDE_OWNER_CONETENANT_CONTRACT_LINE_IN_USETENANT_CONTRACT_LINE_TERMINATEDTENANT_CONTRACT_LINE_NOT_SEATABLETENANT_CONTRACT_LINE_NO_ENABLEMENTTENANT_CONTRACT_LINE_SEAT_LIMIT_REACHEDTENANT_CONTRACT_LINE_AT_MINIMUM_SEATSTENANT_CONTRACT_SEAT_EMPTYTENANT_LEASABLE_UNIT_ALREADY_EXISTSTENANT_LEASABLE_UNIT_CONTEXT_INVALIDTENANT_PRODUCT_SKU_ALREADY_EXISTSTENANT_PRODUCT_RETIREDTENANT_PRODUCT_CONTEXT_INVALIDTENANT_PRODUCT_GRANT_DUPLICATETENANT_PRODUCT_GRANT_ENABLEMENT_MISMATCHTENANT_PRODUCT_GRANT_IS_HOMETENANT_PRODUCT_GRANT_SHADOWEDTENANT_PRODUCT_CATEGORY_NAME_ALREADY_EXISTSTENANT_PRODUCT_CATEGORY_RETIREDTENANT_PRODUCT_CATEGORY_VALUE_LOCKEDTENANT_AGENT_NOT_READYTENANT_USER_ALREADY_ON_ROSTERTENANT_AGENT_IDENTIFIER_ALREADY_USEDTENANT_AGENT_TYPE_MISMATCHTENANT_CUSTOMER_NUMBER_TAKENTENANT_CUSTOMER_NUMBER_INVALIDTENANT_SCHEME_DEFAULT_TIER_REQUIREDTENANT_SCHEME_TIER_ROLE_INVALIDTENANT_SCHEME_CONTEXT_TYPE_MISMATCHTENANT_SCHEME_NOT_ENABLED_HERETENANT_SCHEME_DEFAULT_TIER_NOT_PLACEABLETENANT_COMPANY_REGISTRY_NOT_SUPPORTEDTENANT_COMPANY_REGISTRY_UNAVAILABLEBILLING_INTEGRATION_NOT_CONFIGUREDBILLING_INTEGRATION_GATE_NOT_DECLAREDBILLING_EXTERNAL_REFERENCE_ALREADY_USEDBILLING_INVOICE_STATUS_INVALIDBILLING_PAYMENT_REPLAY_MISMATCHBILLING_PAYMENT_REVERSEDBILLING_PAYMENT_NOT_FOUNDBILLING_PAYMENT_AMOUNT_INVALIDBILLING_WRITE_OFF_REPLAY_MISMATCHBILLING_WRITE_OFF_AMOUNT_INVALIDBILLING_PROPOSAL_STATUS_INVALIDBILLING_PROPOSAL_MATERIAL_ALREADY_INVOICEDBILLING_CREDIT_NOTE_INVOICE_NOT_CREDITABLEBILLING_CREDIT_NOTE_NO_PENDING_CORRECTIONSBILLING_INVOICE_RUN_NOT_CONTINUABLEBILLING_CREDIT_EXCEEDS_LINEBILLING_CREDIT_EXCEEDS_INVOICEBILLING_CREDIT_WITHHELDBILLING_CREDIT_ACT_REPLAY_MISMATCHBILLING_MANUAL_CREDIT_VAT_RATE_UNKNOWNBILLING_CORRECTION_NOT_WITHDRAWABLECOMMUNITY_POST_COVER_REJECTEDCOMMUNITY_POST_ATTACHMENT_REJECTEDCOMMUNITY_POST_COVER_LIMIT_REACHEDCOMMUNITY_POST_ATTACHMENT_LIMIT_REACHEDCOMMUNITY_PROMOTION_IMAGE_LIMIT_REACHEDCOMMUNITY_VOUCHER_CODE_TAKENCOMMUNITY_PUBLISH_AT_NOT_FUTURECOMMUNITY_PINNED_UNTIL_NOT_FUTURECOMMUNITY_POST_NOT_SCHEDULEDCOMMUNITY_POST_NOT_PUBLISHEDCOMMUNITY_POST_NOT_UNPUBLISHEDCOMMUNITY_DRAFT_INCOMPLETECOMMUNITY_PROMOTION_INCOMPLETECOMMUNITY_PROMOTION_NOT_DRAFTCOMMUNITY_PROMOTION_NOT_SCHEDULEDCOMMUNITY_PROMOTION_NOT_ACTIVECOMMUNITY_PROMOTION_NOT_INACTIVECOMMUNICATIONS_ATTACHMENT_PENDING_LIMIT_EXCEEDEDCOMMUNICATIONS_ATTACHMENT_REJECTEDCOMMUNICATIONS_ATTACHMENT_NOT_CLAIMABLECOMMUNICATIONS_BROADCAST_SCHEDULED_AT_NOT_FUTURECOMMUNICATIONS_BROADCAST_NOT_SCHEDULEDCOMMUNITY_EVENT_FULLCOMMUNITY_EVENT_ATTENDEE_EXISTSCOMMUNITY_EVENT_CAPACITY_BELOW_ATTENDEESCOMMUNITY_POLL_CLOSEDCOMMUNITY_POLL_ALREADY_ANSWEREDBOOKING_SLOT_TAKENBOOKING_NO_COVERING_CONTRACTBOOKING_CONTRACT_ATTRIBUTION_AMBIGUOUSBOOKING_CONTRACT_NOT_A_CANDIDATEBOOKING_NO_SHARED_CONTRACTBOOKING_EXTERNAL_CONTRACT_NOT_BILLABLEBOOKING_EXTERNAL_CUSTOMER_NOT_FOUNDBOOKING_EXTERNAL_CUSTOMER_BILLING_ACCOUNT_REQUIREDBOOKING_EXTERNAL_BILLING_ACCOUNT_INCOMPLETEBOOKING_EXTERNAL_INVOICING_DETAILS_REQUIREDBOOKING_EXTERNAL_REQUIRES_APPROVALBOOKING_REQUEST_ID_ALREADY_USEDBOOKING_GUEST_LINK_INVALIDBOOKING_GUEST_LINK_NOT_RESENDABLEBOOKING_NOT_EXTERNALBOOKING_PRICE_RULE_AMBIGUOUSBOOKING_PRICE_RULE_NOT_APPLICABLEBOOKING_NOT_PENDING_APPROVALBOOKING_APPROVAL_WINDOW_PASSEDBOOKING_RESOURCE_IMAGE_REJECTEDBOOKING_RESOURCE_PURCHASE_TERMS_REJECTEDBOOKING_OUTSIDE_OPEN_HOURSBOOKING_DURATION_TOO_SHORTBOOKING_DURATION_TOO_LONGBOOKING_DURATION_NOT_ON_INCREMENTBOOKING_START_NOT_ON_INCREMENTBOOKING_WEEKLY_QUOTA_EXCEEDEDBOOKING_BUFFER_CONFLICTBOOKING_NOTICE_TOO_SHORTBOOKING_CANCELLATION_NOTICE_EXPIREDBOOKING_ALREADY_DELIVEREDBOOKING_NOT_CHARGEDBOOKING_ALREADY_STARTEDBOOKING_ACCESS_ALREADY_OPENBOOKING_NOT_RESCHEDULABLEBOOKING_TIME_SPEC_MODEL_MISMATCHBOOKING_SLOT_NOT_IN_SCHEDULEBOOKING_DATE_INTERVAL_EMPTYBOOKING_DATE_SPAN_EMPTYBOOKING_DATE_SPAN_REQUIRES_SESSION_PRICINGBOOKING_DATE_INTERVAL_REQUIRES_NIGHT_PRICINGBOOKING_NIGHT_PRICING_REQUIRES_DATE_INTERVALBOOKING_RESOURCE_BUFFER_NOT_ON_INCREMENTBOOKING_STAY_TOO_SHORTBOOKING_STAY_TOO_LONGBOOKING_UPLOAD_PENDING_LIMIT_EXCEEDEDBOOKING_IN_THE_PASTBOOKING_HORIZON_EXCEEDEDBOOKING_DURATION_CEILING_EXCEEDEDBOOKING_PARTICIPANTS_NOT_SUPPORTEDBOOKING_PARTICIPANT_NOT_SEATEDBOOKING_RESOURCE_PARTICIPANTS_GROUP_CONFLICTBOOKING_RESOURCE_CURRENCY_MISMATCHBOOKING_OPENING_HOURS_SCHEDULE_NOT_FOUNDBOOKING_RESOURCE_GROUP_OUTSIDE_CONTEXTBOOKING_ADD_ON_PRODUCT_IMAGE_REJECTEDBOOKING_ADD_ON_PRODUCT_RETIREDBOOKING_ADD_ON_PRODUCT_RESOURCE_OUTSIDE_CONTEXTBOOKING_ADD_ON_NOT_OFFEREDBOOKING_ADD_ON_DELIVERY_OUTSIDE_BOOKINGBOOKING_ADD_ON_DELIVERY_OUTSIDE_AVAILABILITYBOOKING_ADD_ON_ORDER_LEAD_TOO_SHORTBOOKING_ADD_ON_CUTOFF_PASSEDBOOKING_ADD_ON_SPECIAL_PORTIONS_INVALIDBOOKING_ADD_ON_LINE_LIMIT_EXCEEDEDBOOKING_ADD_ON_ON_INTERNAL_BOOKINGBOOKING_ADD_ON_LINE_NOT_FOUNDBOOKING_ADD_ON_LINE_DELIVEREDBOOKING_ADD_ON_LINE_NO_LONGER_FITSBOOKING_ROOM_LAYOUT_NOT_OFFEREDBOOKING_ROOM_LAYOUT_CUTOFF_PASSEDBOOKING_ROOM_LAYOUT_NOT_CHANGEABLEBOOKING_ROOM_SETUP_NOT_FOUNDACCESS_ACCESSY_CREDENTIALS_REJECTEDACCESS_ACCESSY_API_CLIENT_ALREADY_REGISTEREDACCESS_ACCESSY_API_CLIENT_MISSINGACCESS_GROUP_UNKNOWNACCESS_ACCESSY_UNAVAILABLEACCESS_SUBSCRIPTION_ALREADY_REGISTEREDACCESS_PHONE_MISSINGACCESS_ENROLLMENT_NOT_BEGUNACCESS_ENROLLMENT_EXPIREDACCESS_ENROLLMENT_REFUSEDACCESS_RECOVERY_KEY_REQUIREDACCESS_RECOVERY_KEY_INVALIDACCESS_ENROLLMENT_REQUIREDORGANIZATION_NOT_ENTEREDAUTH_PHONE_VERIFICATION_REQUIREDAUTH_PHONE_VERIFICATION_INVALIDAUTH_PHONE_VERIFICATION_THROTTLEDACCESS_GROUP_ALREADY_CONFIGUREDACCESS_GROUP_NOT_READYACCESS_DOOR_ALREADY_LINKEDACCESS_ASSET_NOT_PUBLISHEDACCESS_ACCESSY_REQUEST_REFUSEDCRM_CONTRACT_TEMPLATE_RETIREDCRM_PACKAGE_RETIREDCRM_PRODUCT_RETIREDCRM_PRODUCT_UNKNOWNCRM_AGENT_UNKNOWNCRM_CUSTOMER_CHOICE_INVALIDCRM_PROSPECT_MATCHES_AGENTCRM_CUSTOMER_IS_AGENTCRM_AGREEMENT_BILLING_DETAILS_REQUIREDCRM_AGREEMENT_BILLING_ACCOUNT_EXISTSCRM_AGREEMENT_BILLING_DETAILS_TYPE_MISMATCHCRM_AGREEMENT_BILLING_DETAILS_INCOMPLETECRM_ROW_ACCESS_TERMS_INVALIDCRM_DEAL_LOSTCRM_DEAL_ACCEPTEDCRM_DEAL_TRANSITION_INVALIDCRM_DEAL_BUSINESS_CONTEXT_INVALIDCRM_PACKAGE_BUSINESS_CONTEXT_INVALIDCRM_PACKAGE_BUSINESS_CONTEXT_MISMATCHCRM_PACKAGE_PRODUCT_DUPLICATECRM_PRODUCT_OUTSIDE_BUSINESS_CONTEXTCRM_ROWS_EMPTYCRM_ROWS_LIMITCRM_ROW_QUANTITY_INVALIDCRM_CURRENCY_MISMATCHCRM_OFFER_TOKEN_INVALIDCRM_OFFER_EXPIREDCRM_OFFER_ALREADY_ANSWEREDCRM_OFFER_INVALIDATEDCRM_AGREEMENT_TRANSITION_INVALIDCRM_AGREEMENT_LOCKEDCRM_AGREEMENT_CANCELLEDCRM_AGREEMENT_START_DATE_MISSINGCRM_LEASABLE_UNIT_OCCUPIEDCRM_SIGNED_DOCUMENT_REJECTEDCRM_SIGNING_NOT_AVAILABLECRM_CONTRACT_BODY_MISSINGCRM_CONTRACT_VALUES_MISSINGCRM_CONTRACT_VARIABLE_UNKNOWNCRM_CONTRACT_PLACEHOLDERS_OPENCRM_CONTRACT_RENDER_FAILEDCRM_SIGNING_ATTEMPT_LIVECRM_SIGNING_ATTEMPT_ENDEDCRM_SIGNER_BUSINESS_CONTEXT_INVALIDCRM_SIGNER_NOT_ELIGIBLECRM_SIGNER_ALREADY_ADDEDCRM_SIGNER_UNAVAILABLECRM_SIGNING_PARTY_REPEATEDAPPLICATION_SECRET_LIMIT_REACHEDAPPLICATION_SECRET_NOT_FOUNDVALIDATION_FAILEDINTEGRATIONS_APP_INVALIDINTEGRATIONS_APP_ALREADY_EXISTSINTEGRATIONS_APP_INSTALLEDINTEGRATIONS_APP_ALREADY_INSTALLEDINTEGRATIONS_CONSENT_MISMATCHINTEGRATIONS_ROLE_NOT_GRANTABLEINTEGRATIONS_CONTEXT_LEVEL_MISMATCHINTEGRATIONS_CONFIGURATION_INVALIDINTEGRATIONS_POINT_ALREADY_FILLEDINTEGRATIONS_CONFIGURATION_NOT_FOUNDINTEGRATIONS_CONNECTION_NOT_SUPPORTEDINTEGRATIONS_CONNECTION_REFERENCE_INVALIDASSISTANT_CONVERSATION_NOT_FOUNDASSISTANT_CONFIRMATION_NOT_PENDINGASSISTANT_TURN_LIMIT_REACHEDASSISTANT_RATE_LIMITEDASSISTANT_MODEL_FAILEDASSISTANT_TURN_INTERRUPTED
issuesobject[]

With VALIDATION_FAILED: one entry per field that failed validation, each with its path and message.

403

The token does not allow this request.

typestringrequired

Always about:blank.

titlestringrequired

The HTTP status phrase, for example Not Found.

statusintegerrequired

The HTTP status code.

min -9007199254740991 · max 9007199254740991
detailstring

What went wrong, for a person to read. Do not parse it.

codestring

Names the rule that refused the request. Match on this, not on detail.

Allowed:TWIN_NODE_NOT_FOUNDTWIN_OPERATIONAL_CONTEXT_NOT_DELETABLETWIN_NODE_SUBTREE_IN_USETWIN_OPENING_HOURS_SCHEDULE_LIMIT_REACHEDTWIN_OPENING_HOURS_SCHEDULE_NAME_ALREADY_EXISTSTWIN_OPENING_HOURS_SCHEDULE_NOT_FOUNDOPERATIONS_ISSUE_TRANSITION_INVALIDOPERATIONS_ISSUE_CLOSE_REASON_REQUIREDOPERATIONS_ISSUE_CONCURRENT_MODIFICATIONOPERATIONS_ISSUE_KEY_ALREADY_USEDOPERATIONS_PRIORITY_ARCHIVEDOPERATIONS_PRIORITY_KEY_ALREADY_EXISTSOPERATIONS_ISSUE_STATUS_ARCHIVEDOPERATIONS_ISSUE_STATUS_CATEGORY_WOULD_BE_EMPTYOPERATIONS_ISSUE_STATUS_REORDER_INCOMPLETEOPERATIONS_VOCABULARY_OWNER_INVALIDOPERATIONS_ISSUE_RULE_KIND_CONFLICTOPERATIONS_ISSUE_RULE_STATUS_NOT_IN_SETOPERATIONS_COMMENT_NOT_AUTHOROPERATIONS_COMMENT_NEEDS_CONTENTOPERATIONS_ATTACHMENT_REJECTEDOPERATIONS_ATTACHMENT_NOT_UPLOADEROPERATIONS_WORK_ORDER_DELEGATION_ACTIVEOPERATIONS_WORK_ORDER_NOT_DELETABLEOPERATIONS_WORK_ORDER_DEPENDENCY_CYCLEOPERATIONS_DELEGATION_STATUS_INVALIDOPERATIONS_DELEGATION_NOT_ENGAGED_PARTYOPERATIONS_DELEGATION_ROLE_CANNOT_ACTOPERATIONS_DISCIPLINE_LABEL_ALREADY_EXISTSOPERATIONS_DISCIPLINE_UNKNOWNOPERATIONS_DISCIPLINE_ARCHIVEDOPERATIONS_SUPPLIER_ROSTER_EMAIL_EXISTSTENANT_BILLING_ACCOUNT_PRIVATE_AGENT_HAS_ONETENANT_BILLING_ACCOUNT_DEFAULT_NOT_REMOVABLETENANT_BILLING_ACCOUNT_INCOMPLETETENANT_CONTRACT_BILLING_ACCOUNT_REQUIREDTENANT_UNIT_ALREADY_LEASEDTENANT_CONTRACT_TERMINATION_RETROACTIVETENANT_CONTRACT_TERMINATION_NOT_EARLIERTENANT_CONTRACT_TERMINATION_LOCKEDTENANT_CONTRACT_BILLING_TERMS_LOCKEDTENANT_CONTRACT_OWNER_NOT_BUSINESSTENANT_CONTRACT_LINE_OUTSIDE_OWNER_CONETENANT_CONTRACT_LINE_IN_USETENANT_CONTRACT_LINE_TERMINATEDTENANT_CONTRACT_LINE_NOT_SEATABLETENANT_CONTRACT_LINE_NO_ENABLEMENTTENANT_CONTRACT_LINE_SEAT_LIMIT_REACHEDTENANT_CONTRACT_LINE_AT_MINIMUM_SEATSTENANT_CONTRACT_SEAT_EMPTYTENANT_LEASABLE_UNIT_ALREADY_EXISTSTENANT_LEASABLE_UNIT_CONTEXT_INVALIDTENANT_PRODUCT_SKU_ALREADY_EXISTSTENANT_PRODUCT_RETIREDTENANT_PRODUCT_CONTEXT_INVALIDTENANT_PRODUCT_GRANT_DUPLICATETENANT_PRODUCT_GRANT_ENABLEMENT_MISMATCHTENANT_PRODUCT_GRANT_IS_HOMETENANT_PRODUCT_GRANT_SHADOWEDTENANT_PRODUCT_CATEGORY_NAME_ALREADY_EXISTSTENANT_PRODUCT_CATEGORY_RETIREDTENANT_PRODUCT_CATEGORY_VALUE_LOCKEDTENANT_AGENT_NOT_READYTENANT_USER_ALREADY_ON_ROSTERTENANT_AGENT_IDENTIFIER_ALREADY_USEDTENANT_AGENT_TYPE_MISMATCHTENANT_CUSTOMER_NUMBER_TAKENTENANT_CUSTOMER_NUMBER_INVALIDTENANT_SCHEME_DEFAULT_TIER_REQUIREDTENANT_SCHEME_TIER_ROLE_INVALIDTENANT_SCHEME_CONTEXT_TYPE_MISMATCHTENANT_SCHEME_NOT_ENABLED_HERETENANT_SCHEME_DEFAULT_TIER_NOT_PLACEABLETENANT_COMPANY_REGISTRY_NOT_SUPPORTEDTENANT_COMPANY_REGISTRY_UNAVAILABLEBILLING_INTEGRATION_NOT_CONFIGUREDBILLING_INTEGRATION_GATE_NOT_DECLAREDBILLING_EXTERNAL_REFERENCE_ALREADY_USEDBILLING_INVOICE_STATUS_INVALIDBILLING_PAYMENT_REPLAY_MISMATCHBILLING_PAYMENT_REVERSEDBILLING_PAYMENT_NOT_FOUNDBILLING_PAYMENT_AMOUNT_INVALIDBILLING_WRITE_OFF_REPLAY_MISMATCHBILLING_WRITE_OFF_AMOUNT_INVALIDBILLING_PROPOSAL_STATUS_INVALIDBILLING_PROPOSAL_MATERIAL_ALREADY_INVOICEDBILLING_CREDIT_NOTE_INVOICE_NOT_CREDITABLEBILLING_CREDIT_NOTE_NO_PENDING_CORRECTIONSBILLING_INVOICE_RUN_NOT_CONTINUABLEBILLING_CREDIT_EXCEEDS_LINEBILLING_CREDIT_EXCEEDS_INVOICEBILLING_CREDIT_WITHHELDBILLING_CREDIT_ACT_REPLAY_MISMATCHBILLING_MANUAL_CREDIT_VAT_RATE_UNKNOWNBILLING_CORRECTION_NOT_WITHDRAWABLECOMMUNITY_POST_COVER_REJECTEDCOMMUNITY_POST_ATTACHMENT_REJECTEDCOMMUNITY_POST_COVER_LIMIT_REACHEDCOMMUNITY_POST_ATTACHMENT_LIMIT_REACHEDCOMMUNITY_PROMOTION_IMAGE_LIMIT_REACHEDCOMMUNITY_VOUCHER_CODE_TAKENCOMMUNITY_PUBLISH_AT_NOT_FUTURECOMMUNITY_PINNED_UNTIL_NOT_FUTURECOMMUNITY_POST_NOT_SCHEDULEDCOMMUNITY_POST_NOT_PUBLISHEDCOMMUNITY_POST_NOT_UNPUBLISHEDCOMMUNITY_DRAFT_INCOMPLETECOMMUNITY_PROMOTION_INCOMPLETECOMMUNITY_PROMOTION_NOT_DRAFTCOMMUNITY_PROMOTION_NOT_SCHEDULEDCOMMUNITY_PROMOTION_NOT_ACTIVECOMMUNITY_PROMOTION_NOT_INACTIVECOMMUNICATIONS_ATTACHMENT_PENDING_LIMIT_EXCEEDEDCOMMUNICATIONS_ATTACHMENT_REJECTEDCOMMUNICATIONS_ATTACHMENT_NOT_CLAIMABLECOMMUNICATIONS_BROADCAST_SCHEDULED_AT_NOT_FUTURECOMMUNICATIONS_BROADCAST_NOT_SCHEDULEDCOMMUNITY_EVENT_FULLCOMMUNITY_EVENT_ATTENDEE_EXISTSCOMMUNITY_EVENT_CAPACITY_BELOW_ATTENDEESCOMMUNITY_POLL_CLOSEDCOMMUNITY_POLL_ALREADY_ANSWEREDBOOKING_SLOT_TAKENBOOKING_NO_COVERING_CONTRACTBOOKING_CONTRACT_ATTRIBUTION_AMBIGUOUSBOOKING_CONTRACT_NOT_A_CANDIDATEBOOKING_NO_SHARED_CONTRACTBOOKING_EXTERNAL_CONTRACT_NOT_BILLABLEBOOKING_EXTERNAL_CUSTOMER_NOT_FOUNDBOOKING_EXTERNAL_CUSTOMER_BILLING_ACCOUNT_REQUIREDBOOKING_EXTERNAL_BILLING_ACCOUNT_INCOMPLETEBOOKING_EXTERNAL_INVOICING_DETAILS_REQUIREDBOOKING_EXTERNAL_REQUIRES_APPROVALBOOKING_REQUEST_ID_ALREADY_USEDBOOKING_GUEST_LINK_INVALIDBOOKING_GUEST_LINK_NOT_RESENDABLEBOOKING_NOT_EXTERNALBOOKING_PRICE_RULE_AMBIGUOUSBOOKING_PRICE_RULE_NOT_APPLICABLEBOOKING_NOT_PENDING_APPROVALBOOKING_APPROVAL_WINDOW_PASSEDBOOKING_RESOURCE_IMAGE_REJECTEDBOOKING_RESOURCE_PURCHASE_TERMS_REJECTEDBOOKING_OUTSIDE_OPEN_HOURSBOOKING_DURATION_TOO_SHORTBOOKING_DURATION_TOO_LONGBOOKING_DURATION_NOT_ON_INCREMENTBOOKING_START_NOT_ON_INCREMENTBOOKING_WEEKLY_QUOTA_EXCEEDEDBOOKING_BUFFER_CONFLICTBOOKING_NOTICE_TOO_SHORTBOOKING_CANCELLATION_NOTICE_EXPIREDBOOKING_ALREADY_DELIVEREDBOOKING_NOT_CHARGEDBOOKING_ALREADY_STARTEDBOOKING_ACCESS_ALREADY_OPENBOOKING_NOT_RESCHEDULABLEBOOKING_TIME_SPEC_MODEL_MISMATCHBOOKING_SLOT_NOT_IN_SCHEDULEBOOKING_DATE_INTERVAL_EMPTYBOOKING_DATE_SPAN_EMPTYBOOKING_DATE_SPAN_REQUIRES_SESSION_PRICINGBOOKING_DATE_INTERVAL_REQUIRES_NIGHT_PRICINGBOOKING_NIGHT_PRICING_REQUIRES_DATE_INTERVALBOOKING_RESOURCE_BUFFER_NOT_ON_INCREMENTBOOKING_STAY_TOO_SHORTBOOKING_STAY_TOO_LONGBOOKING_UPLOAD_PENDING_LIMIT_EXCEEDEDBOOKING_IN_THE_PASTBOOKING_HORIZON_EXCEEDEDBOOKING_DURATION_CEILING_EXCEEDEDBOOKING_PARTICIPANTS_NOT_SUPPORTEDBOOKING_PARTICIPANT_NOT_SEATEDBOOKING_RESOURCE_PARTICIPANTS_GROUP_CONFLICTBOOKING_RESOURCE_CURRENCY_MISMATCHBOOKING_OPENING_HOURS_SCHEDULE_NOT_FOUNDBOOKING_RESOURCE_GROUP_OUTSIDE_CONTEXTBOOKING_ADD_ON_PRODUCT_IMAGE_REJECTEDBOOKING_ADD_ON_PRODUCT_RETIREDBOOKING_ADD_ON_PRODUCT_RESOURCE_OUTSIDE_CONTEXTBOOKING_ADD_ON_NOT_OFFEREDBOOKING_ADD_ON_DELIVERY_OUTSIDE_BOOKINGBOOKING_ADD_ON_DELIVERY_OUTSIDE_AVAILABILITYBOOKING_ADD_ON_ORDER_LEAD_TOO_SHORTBOOKING_ADD_ON_CUTOFF_PASSEDBOOKING_ADD_ON_SPECIAL_PORTIONS_INVALIDBOOKING_ADD_ON_LINE_LIMIT_EXCEEDEDBOOKING_ADD_ON_ON_INTERNAL_BOOKINGBOOKING_ADD_ON_LINE_NOT_FOUNDBOOKING_ADD_ON_LINE_DELIVEREDBOOKING_ADD_ON_LINE_NO_LONGER_FITSBOOKING_ROOM_LAYOUT_NOT_OFFEREDBOOKING_ROOM_LAYOUT_CUTOFF_PASSEDBOOKING_ROOM_LAYOUT_NOT_CHANGEABLEBOOKING_ROOM_SETUP_NOT_FOUNDACCESS_ACCESSY_CREDENTIALS_REJECTEDACCESS_ACCESSY_API_CLIENT_ALREADY_REGISTEREDACCESS_ACCESSY_API_CLIENT_MISSINGACCESS_GROUP_UNKNOWNACCESS_ACCESSY_UNAVAILABLEACCESS_SUBSCRIPTION_ALREADY_REGISTEREDACCESS_PHONE_MISSINGACCESS_ENROLLMENT_NOT_BEGUNACCESS_ENROLLMENT_EXPIREDACCESS_ENROLLMENT_REFUSEDACCESS_RECOVERY_KEY_REQUIREDACCESS_RECOVERY_KEY_INVALIDACCESS_ENROLLMENT_REQUIREDORGANIZATION_NOT_ENTEREDAUTH_PHONE_VERIFICATION_REQUIREDAUTH_PHONE_VERIFICATION_INVALIDAUTH_PHONE_VERIFICATION_THROTTLEDACCESS_GROUP_ALREADY_CONFIGUREDACCESS_GROUP_NOT_READYACCESS_DOOR_ALREADY_LINKEDACCESS_ASSET_NOT_PUBLISHEDACCESS_ACCESSY_REQUEST_REFUSEDCRM_CONTRACT_TEMPLATE_RETIREDCRM_PACKAGE_RETIREDCRM_PRODUCT_RETIREDCRM_PRODUCT_UNKNOWNCRM_AGENT_UNKNOWNCRM_CUSTOMER_CHOICE_INVALIDCRM_PROSPECT_MATCHES_AGENTCRM_CUSTOMER_IS_AGENTCRM_AGREEMENT_BILLING_DETAILS_REQUIREDCRM_AGREEMENT_BILLING_ACCOUNT_EXISTSCRM_AGREEMENT_BILLING_DETAILS_TYPE_MISMATCHCRM_AGREEMENT_BILLING_DETAILS_INCOMPLETECRM_ROW_ACCESS_TERMS_INVALIDCRM_DEAL_LOSTCRM_DEAL_ACCEPTEDCRM_DEAL_TRANSITION_INVALIDCRM_DEAL_BUSINESS_CONTEXT_INVALIDCRM_PACKAGE_BUSINESS_CONTEXT_INVALIDCRM_PACKAGE_BUSINESS_CONTEXT_MISMATCHCRM_PACKAGE_PRODUCT_DUPLICATECRM_PRODUCT_OUTSIDE_BUSINESS_CONTEXTCRM_ROWS_EMPTYCRM_ROWS_LIMITCRM_ROW_QUANTITY_INVALIDCRM_CURRENCY_MISMATCHCRM_OFFER_TOKEN_INVALIDCRM_OFFER_EXPIREDCRM_OFFER_ALREADY_ANSWEREDCRM_OFFER_INVALIDATEDCRM_AGREEMENT_TRANSITION_INVALIDCRM_AGREEMENT_LOCKEDCRM_AGREEMENT_CANCELLEDCRM_AGREEMENT_START_DATE_MISSINGCRM_LEASABLE_UNIT_OCCUPIEDCRM_SIGNED_DOCUMENT_REJECTEDCRM_SIGNING_NOT_AVAILABLECRM_CONTRACT_BODY_MISSINGCRM_CONTRACT_VALUES_MISSINGCRM_CONTRACT_VARIABLE_UNKNOWNCRM_CONTRACT_PLACEHOLDERS_OPENCRM_CONTRACT_RENDER_FAILEDCRM_SIGNING_ATTEMPT_LIVECRM_SIGNING_ATTEMPT_ENDEDCRM_SIGNER_BUSINESS_CONTEXT_INVALIDCRM_SIGNER_NOT_ELIGIBLECRM_SIGNER_ALREADY_ADDEDCRM_SIGNER_UNAVAILABLECRM_SIGNING_PARTY_REPEATEDAPPLICATION_SECRET_LIMIT_REACHEDAPPLICATION_SECRET_NOT_FOUNDVALIDATION_FAILEDINTEGRATIONS_APP_INVALIDINTEGRATIONS_APP_ALREADY_EXISTSINTEGRATIONS_APP_INSTALLEDINTEGRATIONS_APP_ALREADY_INSTALLEDINTEGRATIONS_CONSENT_MISMATCHINTEGRATIONS_ROLE_NOT_GRANTABLEINTEGRATIONS_CONTEXT_LEVEL_MISMATCHINTEGRATIONS_CONFIGURATION_INVALIDINTEGRATIONS_POINT_ALREADY_FILLEDINTEGRATIONS_CONFIGURATION_NOT_FOUNDINTEGRATIONS_CONNECTION_NOT_SUPPORTEDINTEGRATIONS_CONNECTION_REFERENCE_INVALIDASSISTANT_CONVERSATION_NOT_FOUNDASSISTANT_CONFIRMATION_NOT_PENDINGASSISTANT_TURN_LIMIT_REACHEDASSISTANT_RATE_LIMITEDASSISTANT_MODEL_FAILEDASSISTANT_TURN_INTERRUPTED
issuesobject[]

With VALIDATION_FAILED: one entry per field that failed validation, each with its path and message.

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.hydda.one/v1/billing/send-queue' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Response
{
  "items": [
    {
      "invoice": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "invoiceRunId": "d023feec-6ce3-4d83-8326-53006f2d50e7",
        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
        "operationalContextId": "a3f64ce2-1602-4028-b89f-abb2bb8c71bc",
        "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
        "recipientAgentId": "9857c18a-555f-4729-b9ab-629537b29cdc",
        "recipientAgentName": "string",
        "billingAccountId": "56a302e4-9416-417d-adcf-22ac99649ba3",
        "documentKind": "invoice",
        "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
        "billingStream": "contractual",
        "requestedInvoiceDate": "2019-08-24",
        "requestedDueDate": "2019-08-24",
        "paymentTermsDays": 0,
        "invoiceNumber": 1,
        "status": "created",
        "currency": "SEK",
        "totalNetMinorUnits": -9007199254740991,
        "totalVatMinorUnits": -9007199254740991,
        "totalGrossMinorUnits": -9007199254740991,
        "externalReference": "string",
        "issuedInvoiceNumber": "string",
        "issuedInvoiceDate": "2019-08-24",
        "dueDate": "2019-08-24",
        "issuedTotalGrossMinorUnits": -9007199254740991,
        "paymentReference": "string",
        "paymentReferenceType": "ocr",
        "documentUrl": "string",
        "balanceMinorUnits": -9007199254740991,
        "overdue": true,
        "approvedAt": "2019-08-24T14:15:22Z",
        "sentAt": "2019-08-24T14:15:22Z",
        "paidAt": "2019-08-24T14:15:22Z",
        "writtenOffAt": "2019-08-24T14:15:22Z",
        "failedAt": "2019-08-24T14:15:22Z",
        "failureReason": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "businessContextId": "58db1938-ac0d-4a94-a386-d1ba9846f5b8"
      },
      "lines": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "position": 1,
          "chargeLineId": "d2cecd33-05db-459a-b8eb-290496785f98",
          "correctsChargeLineId": "682ed46d-104c-4914-8239-5059185f9d71",
          "correctsPosition": 1,
          "label": "string",
          "quantity": "string",
          "unitPriceMinorUnits": -9007199254740991,
          "amountMinorUnits": -9007199254740991,
          "currency": "SEK",
          "vatRateBasisPoints": 0,
          "vatTreatment": "exempt",
          "discount": {
            "kind": "fixed",
            "amountMinorUnits": -9007199254740991,
            "label": "string"
          },
          "posting": {
            "salesAccount": "string",
            "costCentre": "string",
            "discountAccount": "string"
          },
          "quantityUnit": "piece",
          "periodStart": "2019-08-24",
          "periodEnd": "2019-08-24",
          "cycleStart": "2019-08-24",
          "cycleEnd": "2019-08-24",
          "sku": "string",
          "producingDomain": "string",
          "originatingEntityType": "string",
          "originatingEntityId": "c8df0151-8233-4fcb-b275-1078dc7c9755",
          "accounting": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "vatSubtotals": [
        {
          "vatRateBasisPoints": 0,
          "vatTreatment": "exempt",
          "netMinorUnits": -9007199254740991,
          "vatMinorUnits": -9007199254740991
        }
      ],
      "recipient": {
        "agentName": "string",
        "agentType": "company",
        "identifiers": [
          {
            "scheme": "se-orgnr",
            "value": "string"
          }
        ],
        "contactName": "string",
        "defaultInvoiceReference": "string",
        "invoiceAddress": {
          "careOf": "string",
          "street": "string",
          "street2": "string",
          "postalCode": "string",
          "city": "string",
          "country": "AD"
        },
        "deliveryMethod": "e-invoice",
        "billingEmail": "string",
        "eInvoiceAddress": {
          "scheme": "gln",
          "value": "string"
        },
        "billingAccountId": "56a302e4-9416-417d-adcf-22ac99649ba3",
        "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",
        "customerNumber": "string"
      }
    }
  ]
}