> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one Proposal

> Retrieve a single Proposal record by its Id.

A **Proposal** bundles one or more contracts (`ProposalContract` records) that are presented to a customer for review and acceptance. Each `ProposalContract` carries the same properties as a `CoworkerContract` and becomes one when the proposal is accepted.

When a Proposal is created, a `ProposalContract` is automatically created and associated with it. From that point on, the contract-related fields on the Proposal (`TariffId`, `Desks`, `Variants`, `Price`, `StartDate`, `CancellationLimitDays`, `ContractTerm`, `CancellationDate`, `ExpirationDate`, `BillingDay`, `Quantity`) become read-only — they are all `createOnly`. Subsequent edits to those values must be made via the associated `ProposalContract`. Additional `ProposalContract` records can also be added.

Proposals support three optional attachments:

* **DocumentToSendId** — a `DocumentTemplate` entity presented to the customer instead of the standard price-schedule table before the proposal is accepted.
* **DocumentToSignId** — a `DocumentTemplate` entity used to generate a document for e-signature.
* **ProposalFile** — a file shown as a downloadable link before the proposal is accepted.

Set `DoNotIssueInvoice` to control whether the first invoice is issued automatically when the proposal is accepted.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
  The authenticated user must be a full unrestricted administrator or have the **`Proposal-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the Proposal record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/proposals/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/proposals/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/proposals/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="IssuedById" type="integer">
  Issued By Id.
</ResponseField>

<ResponseField name="IssuedByName" type="string">
  Issuing business name.
</ResponseField>

<ResponseField name="IssuedByCurrencyCode" type="string">
  Issuing business currency code.
</ResponseField>

<ResponseField name="ResponsibleId" type="integer">
  Responsible Id.
</ResponseField>

<ResponseField name="ResponsibleFullName" type="string">
  Responsible person full name.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  Coworker Id.
</ResponseField>

<ResponseField name="CoworkerCoworkerType" type="string">
  Coworker type.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Coworker full name.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Coworker company name.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Coworker billing name.
</ResponseField>

<ResponseField name="Reference" type="string">
  Proposal reference.
</ResponseField>

<ResponseField name="Notes" type="string">
  Notes.
</ResponseField>

<ResponseField name="ProposalStatus" type="integer">
  Proposal status. See `eProposalStatus` enum values: `1` = Draft, `2` = Sent, `3` = Accepted, `4` = Rejected.
</ResponseField>

<ResponseField name="DocumentToSendId" type="integer">
  Document To Send Id.
</ResponseField>

<ResponseField name="DocumentToSignId" type="integer">
  Document To Sign Id.
</ResponseField>

<ResponseField name="DocumentToSignHtml" type="string">
  Document To Sign Html.
</ResponseField>

<ResponseField name="DocumentToSignBinaryDocumentFileName" type="string">
  Document To Sign Binary Document File Name.
</ResponseField>

<ResponseField name="NewDocumentToSignBinaryDocumentUrl" type="string">
  New Document To Sign Binary Document Url.
</ResponseField>

<ResponseField name="ClearDocumentToSignBinaryDocumentFile" type="boolean">
  Clear Document To Sign Binary Document File.
</ResponseField>

<ResponseField name="DocumentToSendHtml" type="string">
  Document To Send Html.
</ResponseField>

<ResponseField name="DocumentToSendBinaryDocumentFileName" type="string">
  Document To Send Binary Document File Name.
</ResponseField>

<ResponseField name="NewDocumentToSendBinaryDocumentUrl" type="string">
  New Document To Send Binary Document Url.
</ResponseField>

<ResponseField name="ClearDocumentToSendBinaryDocumentFile" type="boolean">
  Clear Document To Send Binary Document File.
</ResponseField>

<ResponseField name="ProposalFileFileName" type="string">
  Proposal File File Name.
</ResponseField>

<ResponseField name="NewProposalFileUrl" type="string">
  New Proposal File Url.
</ResponseField>

<ResponseField name="ClearProposalFileFile" type="boolean">
  Clear Proposal File File.
</ResponseField>

<ResponseField name="TariffId" type="integer">
  Tariff Id.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Tariff name.
</ResponseField>

<ResponseField name="TariffInvoiceEvery" type="string">
  Tariff invoice frequency.
</ResponseField>

<ResponseField name="TariffInvoiceEveryWeeks" type="string">
  Tariff invoice frequency in weeks.
</ResponseField>

<ResponseField name="TariffPrice" type="number">
  Tariff price.
</ResponseField>

<ResponseField name="TariffBusinessCurrencyCode" type="string">
  Tariff business currency code.
</ResponseField>

<ResponseField name="Desks" type="integer[]">
  Desks.
</ResponseField>

<ResponseField name="Variants" type="integer[]">
  Variants.
</ResponseField>

<ResponseField name="Price" type="number">
  Price override for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="StartDate" type="string">
  Start date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="CancellationLimitDays" type="integer">
  Cancellation limit in days for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="ContractTerm" type="string">
  Contract term end date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="CancellationDate" type="string">
  Cancellation date for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="ExpirationDate" type="string">
  Proposal expiration date. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="BillingDay" type="integer">
  Billing day of month for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Quantity for the initial contract. Becomes read-only after creation; edit via ProposalContract.
</ResponseField>

<ResponseField name="DiscountCodeId" type="integer">
  Discount Code Id.
</ResponseField>

<ResponseField name="StartDateLocal" type="string">
  Start Date Local.
</ResponseField>

<ResponseField name="SentOn" type="string">
  Date the proposal was sent.
</ResponseField>

<ResponseField name="SentOnLocal" type="string">
  Sent On Local.
</ResponseField>

<ResponseField name="CustomerLastOpenedDate" type="string">
  Date the customer last opened the proposal.
</ResponseField>

<ResponseField name="DoNotIssueInvoice" type="boolean">
  If true, the first invoice is not issued automatically when the proposal is accepted.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "IssuedById": 0,
  "IssuedByName": null,
  "IssuedByCurrencyCode": null,
  "ResponsibleId": 0,
  "ResponsibleFullName": null,
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "Reference": "",
  "Notes": null,
  "ProposalStatus": 0,
  "DocumentToSendId": null,
  "DocumentToSignId": null,
  "DocumentToSignHtml": null,
  "DocumentToSignBinaryDocumentFileName": null,
  "NewDocumentToSignBinaryDocumentUrl": null,
  "ClearDocumentToSignBinaryDocumentFile": null,
  "DocumentToSendHtml": null,
  "DocumentToSendBinaryDocumentFileName": null,
  "NewDocumentToSendBinaryDocumentUrl": null,
  "ClearDocumentToSendBinaryDocumentFile": null,
  "ProposalFileFileName": null,
  "NewProposalFileUrl": null,
  "ClearProposalFileFile": null,
  "TariffId": 0,
  "TariffName": null,
  "TariffInvoiceEvery": null,
  "TariffInvoiceEveryWeeks": null,
  "TariffPrice": 0,
  "TariffBusinessCurrencyCode": null,
  "Desks": [],
  "Variants": [],
  "Price": null,
  "StartDate": null,
  "CancellationLimitDays": null,
  "ContractTerm": null,
  "CancellationDate": null,
  "ExpirationDate": null,
  "BillingDay": 0,
  "Quantity": 0,
  "DiscountCodeId": null,
  "StartDateLocal": null,
  "SentOn": null,
  "SentOnLocal": null,
  "CustomerLastOpenedDate": null,
  "DoNotIssueInvoice": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "Proposal Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```