PurchaseRegister

Create a purchase register entry

Changed on

Creates a purchase register entry (livre des achats) for a supplier expense.

thirdPartyId must be the ID of a provider (supplier), NOT an organization or contact (those are customers used by invoicing). Create or list providers via POST /provider, GET /providers, etc.

amount is in cents and represents the total tax-inclusive amount of the expense. Use a negative amount for a refund.

entries must split amount line by line. Each entry exposes:

  • amount (cents, required) — tax-inclusive amount allocated to this line. The sum of entries[].amount must equal the parent amount.
  • isPersonal (boolean, required) — true to flag the line as a personal expense (excluded from VAT and accounting books).
  • vatId (number, optional) — French VAT rate identifier. Allowed values:
    • 1 = 20.00 %
    • 2 = 10.00 %
    • 3 = 5.50 %
    • 4 = 2.10 %
    • 5 = Hors Taxe (no VAT)
    • 6 = 8.50 % (DOM-TOM)
    • 7 = Union Européenne (intra-EU acquisition, reverse-charged)
    • 8 = Hors UE (extra-EU acquisition)
  • accountingAccountNumber (number, optional) — French chart-of-accounts number forced for this line (e.g. 606300, 622600, 445660). When omitted, Abby applies a default account based on the entry type.

paymentMethodUsed uses the legacy PaymentMethod enum (e.g. CASH, BANK_CARD, BANK_TRANSFER, CHECK, OTHER). Pass otherPaymentMethodUsed only when paymentMethodUsed = OTHER.

post/v3/purchaseRegister

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/v3/purchaseRegister
  • Auth: HTTP bearer

Request body

valueDatestring date-time required
paymentMethodUsed1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 required
otherPaymentMethodUsedstring
amountnumber required
thirdPartyIdstring required
labelstring required
referencestring

Response

Purchase register entry created successfully

idstring required

The id of the purchase register entry

labelstring required

The label of the purchase register entry

referencestring required

The reference of the purchase register entry

amountnumber required

The amount of the purchase register entry

vatAmountnumber required

The vat amount of the purchase register entry

paymentMethod'transfer' | 'direct_debit' | 'credit_card' | 'cheque' | 'universal_employment_service_cheque' | 'cash' | 'paypal' | 'stripe' | 'other' required
otherMethodstring

The other method of the purchase register entry

emittedAtstring required

The emitted at of the purchase register entry

hasTransactionboolean required

The has transaction of the purchase register entry

fileCountnumber required

The file count of the purchase register entry

createdAtnumber required

The created at of the purchase register entry

updatedAtnumber required

The updated at of the purchase register entry

Changes

  • b4afe424b86dRevision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the /// response's property type changed from object to string, and format from no format to date-time for status

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added to the /// response property allOf list for the response status

    • info

      added to the /// response property allOf list for the response status

    • info

      the response property /// became required for the status