Billings

List billing documents

Changed on
get/v2/billings

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/v2/billings
  • Auth: HTTP bearer

Query parameters

pagenumber required
limitnumber required
searchstring
stateBillingState[]
lateboolean
typeBillingType[]
tiersPrestationIsActivatedForThisBillingboolean
customerIdstring
organizationIdstring
opportunityIdstring
countWithoutFiltersboolean
testboolean required
archivedboolean
rangestring[]

Inclusive date window [from, to] applied to the field named by rangeType; use the calendar-day form YYYY-MM-DD, each bound being interpreted as a whole day in the API timezone (Europe/Paris). A full ISO instant is also accepted transitionally, for older clients, and is snapped to the Paris day it falls on, which can widen the window (a UTC end-of-day instant lands on the next Paris day).

rangeType'emittedAt' | 'paidAt' | 'signedAt' | 'expiredAt' | 'dueAt' | 'refusedAt'
onlyReminderActiveboolean
onlyOnlineSignatureboolean
onlyOnlinePaymentboolean

Response

The billings records

countWithoutFiltersnumber required
totalDocsnumber required
limitnumber required
totalPagesnumber required
hasNextPageboolean required
hasPrevPageboolean required
nextPagenumber required
pagenumber required
prevPagenumber required

Example response

{
  "docs": [
    {
      "customer": {
        "deliveryAddressIsSame": true
      },
      "opportunity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Big Sale Opportunity"
      },
      "electronicSignature": {
        "id": "12345678901234567890",
        "canceledAt": 1617619200,
        "procedureId": "12345678901234567890",
        "signedAt": 1617619200,
        "refusedAt": 1617619200
      },
      "electronicSignatureRequirements": [
        {
          "name": "hasNonEmptyCustomerContact",
          "message": "Vous devez sélectionner un contact à votre organisation cliente pour pouvoir activer la signature en ligne."
        }
      ],
      "paymentRequest": {
        "idDemandePaiement": "123e4567-e89b-12d3-a456-426614174000",
        "dateDebutEmploi": 1736408178,
        "dateFinEmploi": 1736408178,
        "dateVirement": 1736408178,
        "advancePaymentDate": 1736408178
      },
      "finalizeRequirements": [
        {
          "message": "Le montant de la somme des avoirs ne peut pas être supérieur au montant total de la facture.",
          "metadata": {
            "lines": [
              {
                "lineId": "66e7fb6afcc1f7272c627fcd",
                "driftHtCents": 3,
                "driftTtcCents": 7,
                "suggestedUnitAmountCents": 209479
              }
            ],
            "totalDriftHtCents": 3,
            "totalDriftTtcCents": 7
          }
        }
      ],
      "warnings": [
        {
          "title": "Titre du warning.",
          "message": "Message de warning en français."
        }
      ]
    }
  ]
}

Changes

    • breaking

      removed the enum value date from the query request parameter rangeType

    • breaking

      removed the enum value dueDate from the query request parameter rangeType

    • breaking

      removed the enum value validityDate from the query request parameter rangeType

    • breaking

      removed the enum value 1.00 from the property items/ of the query request parameter state

    • breaking

      removed the enum value 1.00 from the property items/ of the query request parameter type

    • breaking

      removed the enum value 2.00 from the property items/ of the query request parameter state

    • breaking

      removed the enum value 2.00 from the property items/ of the query request parameter type

    • breaking

      removed the enum value 3.00 from the property items/ of the query request parameter state

    • breaking

      removed the enum value 3.00 from the property items/ of the query request parameter type

    • breaking

      removed the enum value 4.00 from the property items/ of the query request parameter state

    • breaking

      removed the enum value 4.00 from the property items/ of the query request parameter type

    • breaking

      removed the enum value 5.00 from the property items/ of the query request parameter state

    • breaking

      removed the enum value 5.00 from the property items/ of the query request parameter type

    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the /////// response's property type changed from number to string for status

    • breaking

      the ////// response's property type changed from number to string for status

    • warning

      for the query request parameter type, the type of property items/ changed from number to string

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    This list may be incomplete.