Antecipa

Number of APIs: 88

Antecipa is the first working capital platform in Brazil and this is our first API. We are working together to improve our system.

This API is built on top of a mock server, this means the data is static and can"t be edited.

Getting Started

Before you start make sure you have selected the correct environment.

Authorization

The Antecipa API uses Bearer Access Token to authenticate requests. This sample call, which shows a users list, includes a bearer token in the Authorization request header. This type of token lets you complete an action on behalf of a resource owner.

  $ curl -v -X GET {{url}}/v1/user \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token"

Reponses

HTTP status codes

For successful requests, Antecipa returns HTTP 2XX status codes. For failed requests, Antecipa returns HTTP 4XX or 5XX status codes. Antecipa returns these HTTP status codes:

For all errors except Identity errors, Antecipa returns an error response body that includes additional error details in this format.

  {
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "|4ac0c1b-4f369645927980db.",
    "errors": {
      "Email": [
        "E-mail is required."
      ],
      "LastName": [
        "Lastname is required."
      ],
      "FirstName": [
        "Firstname is required."
      ]
    }
  }

Antecipa error codes

Erverything here

Global Types

Application Code

| Code | Name | |-|-| | 1 | Supplier | | 2 | Buyer | | 3 | Capital Source | | 4 | Administrative | | 5 | BI |

Roles

| Code | Name | |-|-| | 1 | Admin | | 2 | User | | 3 | Financial |

Documents

| Code | Name | |-|-| | 1 | CNPJ Raiz | | 2 | CNPJ | | 3 | CPF |

Contact

| Code | Name | |-|-| | 1 | Email | | 2 | Mobile | | 3 | Phone |

Currency

| Code | Symbol | Name | |-|-|-| | BRL | R$ | Real | | USD | $ | Dólar | | EUR | € | Euro |

Payment

| Code | Name | |-|-| | 1 | Boleto Bancário | | 2 | Transferência | | 3 | Depósito Bancário | | 4 | Cheque | | 5 | Outros |

Payment Order Status

| Code | Name | |-|-| | 1 | Não Antecipável | | 2 | Antecipável | | 3 | Antecipado | | 4 | Pago | | 5 | Cancelado | | 6 | A Vencer |

Supplier Registration Status

Supplier Registration Status Reason

| Code | Description | ForRegistrationStatusId |-|-|- | 1 | Outros | | 2 | A documentação anexada é insuficiente | 4 | 3 | O representante legal informado não consta no documento da empresa | 4 | 4 | O formato do documento anexado é inválido | 4 | 5 | É necessário cadastrar mais representantes legais | 4 | 6 | A documentação anexada não é referente à empresa | 4

Supplier Registration Document

| Code | Name | IsCompanyRegistration | IsPartnerRegistration |-|-|-|- | 1 | Outros | x | x | 2 | Contrato Social | x | | 3 | Requerimento de Empresário | x | | 4 | Procuração | x | | 5 | Acordo de Acionistas | x | | 6 | Comprovante de MEI | x | | 7 | Registro em Junta Comercial | x | | 8 | Documento Identidade (equivalente) | | x

Contact Support: Name: Development support Email: desenvolvimento@antecipa.com

buyers-{buyer Id} - /buyers/:buyerId OPTIONS {{baseUrl}}/buyers/:buyerId
buyers-groups - /buyers/groups OPTIONS {{baseUrl}}/buyers/groups
auth-roles - Get policy's roles GET {{baseUrl}}/auth/roles
auth-signin - Authenticate user POST {{baseUrl}}/auth/signin
suppliers-{supplier Id}-contacts - /suppliers/:supplierId/contacts OPTIONS {{baseUrl}}/suppliers/:supplierId/contacts
suppliers-{supplier Id}-registrations-{supplier Registration Id}-partners - /suppliers/:supplierId/registrations/:supplierRegistrationId/partners OPTIONS {{baseUrl}}/suppliers/:supplierId/registrations/:supplierRegistrationId/partners
suppliers-{supplier Id}-registrations-{supplier Registration Id}-documents-{document Id}-files - /suppliers/:supplierId/registrations/:supplierRegistrationId/documents/:documentId/files POST {{baseUrl}}/suppliers/:supplierId/registrations/:supplierRegistrationId/documents/:documentId/files
suppliers-{supplier Id}-registrations-{supplier Registration Id}-documents - /suppliers/:supplierId/registrations/:supplierRegistrationId/documents POST {{baseUrl}}/suppliers/:supplierId/registrations/:supplierRegistrationId/documents
suppliers-{supplier Id}-registrations-{supplier Registration Id}-partners - Get supplier's registration parter GET {{baseUrl}}/suppliers/:supplierId/registrations/:supplierRegistrationId/partners?page=97910643&pageSize=97910643
suppliers-{supplier Id}-registrations-{supplier Registration Id}-partners - /suppliers/:supplierId/registrations/:supplierRegistrationId/partners/documents GET {{baseUrl}}/suppliers/:supplierId/registrations/:supplierRegistrationId/partners/documents?page=&pageSize=10