Pular para o conteúdo principal

ReadMe_CreateCollectionByStrategyResponse

Resposta para criação assíncrona de cobrança por estratégia

externalContractIdstring

ID externo do contrato de cobrança

Exemplo contract-123
collectionIdstring<uuid>

Identificador do contrato de cobrança criado para acompanhar o processamento.

Exemplo fe2cc560-036c-44cd-90e8-294d5a74cebc
links object[]

Links de navegação da API

  • Lista [
    • relstring

    Relação do link com o recurso atual

    Exemplo self
    methodstring

    Método HTTP do link

    Exemplo GET
    hrefstring

    Caminho relativo do recurso

    Exemplo /api/v2/companies
    descriptionstring

    Explicação em português do que este link permite fazer

    Exemplo Cadastre a empresa para o cliente
  • ]
    • ReadMe_CreateCollectionByStrategyResponse
    {
      "externalContractId": "contract-123",
      "collectionId": "fe2cc560-036c-44cd-90e8-294d5a74cebc",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "/api/v2/companies",
          "description": "Cadastre a empresa para o cliente"
        }
      ]
    }