Sign in
Sales Invoices API

Get sales invoice

Retrieve a single sales invoice by its ID.

get/v2/sales-invoices/{salesInvoiceId}

Query parameters

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The Sales Invoice object.

Changes

Changed in 5 of the 92 revisions of this API.288

  • 7eb5bf6b29dd73See the full diff
    • ●

      added the new cancelled enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new expired enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new failed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new issuing enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new overdue enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new payment_reversed enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new pending-payment enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      removed the draft enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the issued enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the paid enum value from the //// response property for the response status

      response-property-enum-value-removed

  • 753dfc0237131See the full diff
    • ○

      removed subschema #2 from the response body allOf list for the response status

      response-body-all-of-removed

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7cdd0d92da9a211See the full diff
    • ▲

      the / response's property type changed from object to array for status

      response-property-type-changed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

Of the 92 revisions, 9 have no diff computed.