List deleted invoices you may still hold

Poll this to learn about invoices an operator deleted after you attached your reference to them. Discard your own copy of each, such as a draft in your ERP, then report it discarded. An item stays on the queue until you do. Refused with 400 when the organization has no invoicing integration that handles sending.

GET/v1/billing/withdrawal-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 deleted invoices to discard.

itemsobject[]required

Up to limit deleted invoices, oldest first. Empty when there is nothing to discard.

Show properties

Array of object

invoiceIdstring<uuid>required

The id of the deleted invoice. Report the discard by it.

invoiceNumberintegerrequired

Everest's own number for the deleted invoice.

max 9007199254740991

documentKindstringrequired

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

Allowed:invoicecredit-note

businessContextIdstring<uuid> | nullrequired

The company the invoice belonged to. Null when unknown.

externalReferencestringrequired

Your own id for the invoice in your system, 1 to 200 characters and unique in the organization. Payments can be reported by it in place of Everest's id.

min length 1 · max length 200

withdrawnAtstring<date-time>required

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

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.

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.

issuesobject[]

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

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

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

Request

curl -X GET 'https://api.hydda.one/v1/billing/withdrawal-queue' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const response = await fetch("https://api.hydda.one/v1/billing/withdrawal-queue", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.hydda.one/v1/billing/withdrawal-queue",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "items": [
    {
      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
      "invoiceNumber": 1,
      "documentKind": "invoice",
      "businessContextId": "58db1938-ac0d-4a94-a386-d1ba9846f5b8",
      "externalReference": "string",
      "withdrawnAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "TWIN_NODE_NOT_FOUND",
  "issues": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "TWIN_NODE_NOT_FOUND",
  "issues": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "TWIN_NODE_NOT_FOUND",
  "issues": [
    {
      "property1": null,
      "property2": null
    }
  ]
}